ocarina-backends-po_hi_ada.adb 21.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--           O C A R I N A . B A C K E N D S . P O _ H I _ A D A            --
--                                                                          --
--                                 B o d y                                  --
--                                                                          --
--               Copyright (C) 2008-2010, GET-Telecom Paris.                --
--                                                                          --
-- Ocarina  is free software;  you  can  redistribute  it and/or  modify    --
-- it under terms of the GNU General Public License as published by the     --
-- Free Software Foundation; either version 2, or (at your option) any      --
-- later version. Ocarina is distributed  in  the  hope  that it will be    --
-- useful, but WITHOUT ANY WARRANTY;  without even the implied warranty of  --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General --
-- Public License for more details. You should have received  a copy of the --
-- GNU General Public License distributed with Ocarina; see file COPYING.   --
-- If not, write to the Free Software Foundation, 51 Franklin Street, Fifth --
-- Floor, Boston, MA 02111-1301, USA.                                       --
--                                                                          --
-- As a special exception,  if other files  instantiate  generics from this --
-- unit, or you link  this unit with other files  to produce an executable, --
-- this  unit  does not  by itself cause  the resulting  executable to be   --
-- covered  by the  GNU  General  Public  License. This exception does not  --
-- however invalidate  any other reasons why the executable file might be   --
-- covered by the GNU Public License.                                       --
--                                                                          --
--                 Ocarina is maintained by the Ocarina team                --
--                       (ocarina-users@listes.enst.fr)                     --
--                                                                          --
------------------------------------------------------------------------------

with GNAT.OS_Lib;
with Output;
with Utils;

with Ocarina.Instances;
with Ocarina.Backends.Ada_Tree.Generator;
with Ocarina.Backends.Expander;
with Ocarina.Backends.Messages;
with Ocarina.Backends.Properties;
with Ocarina.Backends.PO_HI_Ada.Runtime;
with Ocarina.Backends.PO_HI_Ada.Naming;
with Ocarina.Backends.PO_HI_Ada.Marshallers;
with Ocarina.Backends.PO_HI_Ada.Deployment;
with Ocarina.Backends.PO_HI_Ada.Activity;
with Ocarina.Backends.PO_HI_Ada.Subprograms;
with Ocarina.Backends.PO_HI_Ada.Transport;
with Ocarina.Backends.PO_HI_Ada.Types;
with Ocarina.Backends.PO_HI_Ada.Main;

with Ocarina.Backends.Utils;
with Ocarina.Backends.Build_Utils;
with Ocarina.Backends.Execution_Utils;
with Ocarina.Backends.Execution_Tests;

with GNAT.Command_Line; use GNAT.Command_Line;

with Namet; use Namet;

package body Ocarina.Backends.PO_HI_Ada is

   use GNAT.OS_Lib;
   use Output;
   use Ocarina.Instances;
   use Ocarina.Backends.Ada_Tree.Generator;
   use Ocarina.Backends.Expander;
   use Ocarina.Backends.Messages;
   use Ocarina.Backends.PO_HI_Ada.Runtime;
   use Ocarina.Backends.Utils;
   use Ocarina.Backends.Properties;
   use Ocarina.Backends.Build_Utils;
   use Ocarina.Backends.Execution_Utils;
   use Ocarina.Backends.Execution_Tests;

   Compile_Generated_Sources   : Boolean := False;
   Remove_Generated_Sources    : Boolean := False;
   Do_Coverage_Test            : Boolean := False;
   Do_Regression_Test          : Boolean := False;
   Generated_Sources_Directory : Name_Id := No_Name;

   procedure Visit_Architecture_Instance (E : Node_Id);
   --  Most top level visitor routine. E is the root of the AADL
   --  instance tree. The procedure does a traversal for each
   --  compilation unit to be generated.

   procedure PolyORB_HI_Ada_Makefile
     (Appli_Name         : Name_Id;
      Node_Name          : Name_Id;
      Execution_Platform : Supported_Execution_Platform := Platform_None;
      Transport_API      : Supported_Transport_APIs;
      Ada_Sources        : Name_Tables.Instance;
94
      Asn_Sources        : Name_Tables.Instance;
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
      C_Sources          : Name_Tables.Instance;
      C_Libraries        : Name_Tables.Instance;
      User_Source_Dirs   : Name_Tables.Instance;
      Use_Transport      : Boolean;
      Use_Simulink       : Boolean;
      Simulink_Directory : Name_Id;
      Simulink_Node      : Name_Id;
      Use_Scade          : Boolean;
      Scade_Directory    : Name_Id);

   --  Generate the part of the Makefile that is specific to the
   --  corresponding code generator.

   procedure PolyORB_HI_Ada_Ada_Project_File
     (Appli_Name         : Name_Id;
      Node_Name          : Name_Id;
      Is_Server          : Boolean;
      Execution_Platform : Supported_Execution_Platform;
      Transport_API      : Supported_Transport_APIs;
      Spec_Names         : Name_Tables.Instance;
      Custom_Spec_Names  : Name_Tables.Instance;
      Body_Names         : Name_Tables.Instance;
      Custom_Body_Names  : Name_Tables.Instance;
      User_Source_Dirs   : Name_Tables.Instance);

   -----------------------------
   -- PolyORB_HI_Ada_Makefile --
   -----------------------------

   procedure PolyORB_HI_Ada_Makefile
     (Appli_Name         : Name_Id;
      Node_Name          : Name_Id;
      Execution_Platform : Supported_Execution_Platform := Platform_None;
      Transport_API      : Supported_Transport_APIs;
      Ada_Sources        : Name_Tables.Instance;
130
      Asn_Sources        : Name_Tables.Instance;
131 132 133 134 135 136 137 138 139 140 141 142 143
      C_Sources          : Name_Tables.Instance;
      C_Libraries        : Name_Tables.Instance;
      User_Source_Dirs   : Name_Tables.Instance;
      Use_Transport      : Boolean;
      Use_Simulink       : Boolean;
      Simulink_Directory : Name_Id;
      Simulink_Node      : Name_Id;
      Use_Scade          : Boolean;
      Scade_Directory    : Name_Id)
   is
      pragma Unreferenced (Appli_Name,
                           Transport_API,
                           Ada_Sources,
144
                           Asn_Sources,
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
                           C_Libraries,
                           User_Source_Dirs,
                           Use_Transport,
                           Use_Scade,
                           Scade_Directory,
                           Use_Simulink,
                           Simulink_Directory,
                           Simulink_Node);

      Target_Prefix : String_Access := Getenv ("TARGET_PREFIX");
      Target        : String_Access;

   begin
      --  Determine the compiler that will be used. If the
      --  user did specify the target prefix by mean of the
      --  environment variable "TARGET_PREFIX" then we use
      --  its value. Otherwise, we use the default compiler
      --  name.

      case Execution_Platform is
         when Platform_Native | Platform_None =>
            Change_If_Empty (String_Ptr (Target_Prefix), "");
            Target := new String'("NATIVE");

         when Platform_LEON_ORK =>
            Change_If_Empty (String_Ptr (Target_Prefix), "sparc-elf-");
            Target := new String'("LEON_ORK");

         when Platform_LEON_GNAT =>
            Change_If_Empty (String_Ptr (Target_Prefix), "leon-elf-");
            Target := new String'("LEON_GNAT");

         when Platform_ERC32_ORK =>
            Change_If_Empty (String_Ptr (Target_Prefix), "erc32-elf-");
            Target := new String'("ERC32");

         when Platform_MARTE_OS =>
            Change_If_Empty (String_Ptr (Target_Prefix), "m");
            Target := new String'("MARTEOS");

         when Platform_LEON_RTEMS =>
            null;

         when others =>
            raise Program_Error;
      end case;

      if Execution_Platform /= Platform_LEON_RTEMS then
         Write_Line ("GNATMAKE = " & Target_Prefix.all & "gnatmake");
         Write_Line ("GNAT = " & Target_Prefix.all & "gnat");
         Write_Line ("GCC = " & Target_Prefix.all & "gcc");
         Write_Line ("TARGET = " & Target.all);
         Write_Line ("BUILD = Debug");
         Write_Line ("CGCTRL = No");

         Free (Target_Prefix);
         Free (Target);

         --  Project file

         Write_Str ("PROJECT_FILE = ");
         Write_Name (Node_Name);
         Write_Line (".gpr");
         Write_Eol;

         --  The 'all' target

         Write_Str ("all:");

         --  If there are C files to be compiled, add a dependency on
         --  these files

         if Length (C_Sources) > 0 then
            Write_Str (" compile-c-files");
         end if;

         Write_Eol;

         Write_Char (ASCII.HT);
         Write_Line ("ADA_PROJECT_PATH="
                     & Standard.Utils.Quoted
                     (Get_Runtime_Path ("polyorb-hi-ada")
                      & Path_Separator & "$$ADA_PROJECT_PATH")
                     & " \");
         Write_Char (ASCII.HT);
         Write_Str ("  $(GNATMAKE) -x -P$(PROJECT_FILE) -XTARGET=$(TARGET)"
                    & " -XBUILD=$(BUILD) -XCGCTRL=$(CGCTRL)");

         --  If there are C source or C libraries, there will be more
         --  options.

         Write_Str (" -largs $(EXTERNAL_OBJECTS) ${C_OBJECTS}");
         Write_Eol;

         if Execution_Platform = Platform_LEON_GNAT then
            --  Determine which portion of code is unused and recompile the
            --  the application with Eliminate pragmas.

            Write_Char (ASCII.HT);
            Write_Str ("  $(GNAT) elim -P$(PROJECT_FILE) ");
            Write_Name (Node_Name);
            Write_Str (" > local.adc");
            Write_Eol;

            Write_Char (ASCII.HT);
            Write_Str ("  $(GNATMAKE) -f -P$(PROJECT_FILE) -XTARGET=$(TARGET)"
                         & " -XBUILD=$(BUILD) -XCGCTRL=$(CGCTRL)"
                         & " -cargs -gnatec=local.adc");

            --  If there are C source or C libraries, there will be more
            --  options.

            Write_Str (" -largs $(EXTERNAL_OBJECTS) ${C_OBJECTS}");
            Write_Eol;
         end if;
      else
         Write_Str ("PROGRAM = ");
         Write_Name (Node_Name);
         Write_Eol;
         Write_Eol;
         Write_Line ("include " & Get_Runtime_Path ("polyorb-hi-ada")
                     & "/make/Makefile.rtems_ada");
         Write_Eol;
         Write_Line
           ("rtems_init.o: " & Get_Runtime_Path ("polyorb-hi-ada")
            & "/make/rtems_init.c $(FILESYSTEM_SRCS) $(NETWORK_HFILE) ");
         Write_Char (ASCII.HT);
         Write_Str ("$(CC) $(CFLAGS) -I. $(CPU_CFLAGS) -c $<");
      end if;
   end PolyORB_HI_Ada_Makefile;

   -------------------------------------
   -- PolyORB_HI_Ada_Ada_Project_File --
   -------------------------------------

   procedure PolyORB_HI_Ada_Ada_Project_File
     (Appli_Name         : Name_Id;
      Node_Name          : Name_Id;
      Is_Server          : Boolean;
      Execution_Platform : Supported_Execution_Platform;
      Transport_API      : Supported_Transport_APIs;
      Spec_Names         : Name_Tables.Instance;
      Custom_Spec_Names  : Name_Tables.Instance;
      Body_Names         : Name_Tables.Instance;
      Custom_Body_Names  : Name_Tables.Instance;
      User_Source_Dirs   : Name_Tables.Instance)
   is
      pragma Unreferenced (Appli_Name, Is_Server);

   begin
      Write_Line ("with """ & Get_Runtime_Path ("polyorb-hi-ada")
                       & Directory_Separator & "polyorb_hi"";");

      Write_Eol;

      Write_Str ("project ");
      Write_Name (Node_Name);
      Write_Line (" is");
      Increment_Indentation;

      --  The source directory list

      Write_Indentation;
      Write_Line ("for Source_Dirs use");
      Increment_Indentation;

      Write_Indentation (-1);
      Write_Line ("(""."",");

      --  Get the PolyORB-HI/Ada runtime source directory

      Write_Indentation;
      Write_Str ("""" & Get_Runtime_Path ("polyorb-hi-ada") & """");

      --  The user provided source dirs

      if Length (User_Source_Dirs) > 0 then
         Write_Line (",");

         for J in
           Name_Tables.First .. Name_Tables.Last (User_Source_Dirs) loop
            Write_Indentation;
            Write_Char ('"');
            Write_Name (User_Source_Dirs.Table (J));
            Write_Char ('"');

            exit when J = Name_Tables.Last (User_Source_Dirs);

            Write_Line (",");
         end loop;
      end if;

      Write_Line (");");

      Decrement_Indentation;

      --  The main subprogram name

      Write_Eol;
      Write_Indentation;
      Write_Str ("for Main use (""");
      Write_Name (Node_Name);
      Write_Line (".adb"");");

      --  The custom file names

      Write_Eol;
      Write_Indentation;
      Write_Line ("package Naming is");
      Increment_Indentation;

      Write_Eol;
      Write_Indentation;
      Write_Line ("--  Custom middleware file names");
      Write_Eol;

      case Execution_Platform is
         when Platform_LEON_ORK
           | Platform_LEON_GNAT
           | Platform_ERC32_ORK =>
            Write_Indentation;
            Write_Line
              ("for Body (""PolyORB_HI.Output_Low_Level"")"
                 & " use ""polyorb_hi-output_low_level_leon.adb"";");

         when others =>
            Write_Indentation;
            Write_Line
              ("for Body (""PolyORB_HI.Output_Low_Level"")"
                 & " use ""polyorb_hi-output_low_level_native.adb"";");
      end case;

      case Transport_API is
         when Transport_BSD_Sockets =>
            Write_Indentation;
            Write_Line
              ("for Body (""PolyORB_HI.Transport_Low_Level"")"
                 & " use ""polyorb_hi-transport_low_level_sockets.adb"";");

         when Transport_SpaceWire =>
            raise Program_Error;

         when Transport_None =>
            --  This means the application is monolithic
            null;

         when Transport_User =>
            --  Code to be supplied by the user
            null;
      end case;

      if Length (Spec_Names) > 0 then
         Write_Eol;
         Write_Indentation;
         Write_Line ("--  Custom user spec names");
         Write_Eol;

         for J in Name_Tables.First .. Name_Tables.Last (Spec_Names) loop
            Write_Indentation;
            Write_Str ("for Specification (""");
            Write_Name (Spec_Names.Table (J));
            Write_Str (""") use """);
            Write_Name (Custom_Spec_Names.Table (J));
            Write_Line (""";");
         end loop;
      end if;

      if Length (Body_Names) > 0 then
         Write_Eol;
         Write_Indentation;
         Write_Line ("--  Custom user body names");
         Write_Eol;

         for J in Name_Tables.First .. Name_Tables.Last (Body_Names) loop
            Write_Indentation;
            Write_Str ("for Body (""");
            Write_Name (Body_Names.Table (J));
            Write_Str (""") use """);
            Write_Name (Custom_Body_Names.Table (J));
            Write_Line (""";");
         end loop;
      end if;

      Write_Eol;
      Decrement_Indentation;
      Write_Indentation;
      Write_Line ("end Naming;");
      Write_Eol;

      Write_Indentation;
      Write_Line ("package Compiler renames PolyORB_HI.Compiler;");
      Write_Indentation;
      Write_Line ("package Builder renames PolyORB_HI.Builder;");
      Write_Indentation;
      Write_Line ("package Binder renames PolyORB_HI.Binder;");
      Write_Indentation;
      Write_Line ("package Linker renames PolyORB_HI.Linker;");
      Write_Indentation;
      Write_Line ("package Check renames PolyORB_HI.Check;");
      Write_Eol;

      Decrement_Indentation;
      Write_Str ("end ");
      Write_Name (Node_Name);
      Write_Line (";");
   end PolyORB_HI_Ada_Ada_Project_File;

   --------------
   -- Generate --
   --------------

   procedure Generate (AADL_Root : Node_Id) is
      Instance_Root : Node_Id;
      Success       : Boolean := True;

      procedure Generate_PolyORB_HI_Ada_Makefile is new
        Build_Utils.Makefiles.Generate (PolyORB_HI_Ada_Makefile);

      procedure Generate_PolyORB_HI_Ada_Ada_Project_File is new
        Build_Utils.Ada_Project_Files.Generate
        (PolyORB_HI_Ada_Ada_Project_File);

   begin
      --  Instantiate the AADL tree

      Instance_Root := Instantiate_Model (AADL_Root);

      --  Expand the AADL instance

      Expand (Instance_Root);

      Visit_Architecture_Instance (Instance_Root);

      --  Abort if the construction of the Ada tree failed

      if No (Ada_Root) then
         Display_Error ("Code generation failed", Fatal => True);
      end if;

      --  At this point, we have a valid Ada tree, we can begin the
      --  Ada source file generation.

      --  Enter the output directory

      Enter_Directory (Generated_Sources_Directory);

      if not Remove_Generated_Sources then
         --  Create the source files

         Ada_Tree.Generator.Generate (Ada_Root);

         --  Generate the Makefiles

         Generate_PolyORB_HI_Ada_Makefile (Instance_Root);

         --  Generate the Ada project files

         Generate_PolyORB_HI_Ada_Ada_Project_File (Instance_Root);

         --  If the user requested to build the applications then we
         --  build it.

         if Compile_Generated_Sources then
            Build_Utils.Makefiles.Build (Instance_Root);
         end if;

      else
         Build_Utils.Makefiles.Clean (Instance_Root);
      end if;

      --  If the user requested to test the applications then we
      --  test it.

      if Do_Regression_Test or else Do_Coverage_Test then
         --  Execution_Utils package initialization

         Execution_Utils.Init;
         Execution_Utils.Visit (Instance_Root);

         Execution_Tests.Init;

         if Do_Regression_Test then
            Success := Execute_Regression_Test (Scenario_Dir.all,
                                                Ref_Map,
                                                Integer (Timeout))
              and then Success;

            if not Create_Referencial then
               Write_Eol;
               if Success then
                  Write_Line ("--- All regression tests PASSED ---");
               else
                  Write_Line ("--- Regression tests FAILED ---");
               end if;
            end if;
         end if;

         if Do_Coverage_Test then
            Success := Execute_Coverage_Test (Integer (Timeout))
              and then Success;

         end if;

         --  Free memory

         Execution_Utils.Reset;
         Execution_Tests.Reset;
         Free (Scenario_Dir);

         --  Exit if one of the tests failed

         if not Success then
            OS_Exit (1);
         end if;
      end if;

      --  Leave the output directory

      Leave_Directory;
   end Generate;

   ----------
   -- Init --
   ----------

   procedure Init is
   begin
      Generated_Sources_Directory := Get_String_Name (".");
      Initialize_Option_Scan;
      loop
         case Getopt ("* b z ec er o:") is
            when ASCII.NUL =>
               exit;

            when 'b' =>
               Compile_Generated_Sources := True;

            when 'z' =>
               Remove_Generated_Sources := True;

            when 'e' =>
               Compile_Generated_Sources := True;
               if Full_Switch = "ec" then
                  Do_Coverage_Test := True;
               elsif Full_Switch = "er" then
                  Do_Regression_Test := True;
               end if;

            when 'o' =>
               declare
                  D : constant String := Parameter;
               begin
                  if D'Length /= 0 then
                     Generated_Sources_Directory := Get_String_Name (D);
                  end if;
               end;

            when others =>
               null;
         end case;
      end loop;

      --  Registration of the generator

      Register_Backend ("polyorb_hi_ada", Generate'Access, PolyORB_HI_Ada);

      --  Initialize some units

      Ocarina.Backends.PO_HI_Ada.Runtime.Initialize;
   end Init;

   -----------
   -- Reset --
   -----------

   procedure Reset is
   begin
      Ocarina.Backends.PO_HI_Ada.Runtime.Reset;
   end Reset;

   ---------------------------------
   -- Visit_Architecture_Instance --
   ---------------------------------

   procedure Visit_Architecture_Instance (E : Node_Id) is
   begin
      --  Create the specs subtrees

      Deployment.Package_Spec.Visit (E);
      Naming.Package_Spec.Visit (E);
      Types.Package_Spec.Visit (E);
      Subprograms.Package_Spec.Visit (E);
      Activity.Package_Spec.Visit (E);
      Transport.Package_Spec.Visit (E);
      Marshallers.Package_Spec.Visit (E);

      --  Create the bodies subtrees

      Types.Package_Body.Visit (E);
      Subprograms.Package_Body.Visit (E);
      Activity.Package_Body.Visit (E);
      Transport.Package_Body.Visit (E);
      Marshallers.Package_Body.Visit (E);

      --  The main subprogram

      Main.Subprogram_Body.Visit (E);

      --  The makefiles

      Build_Utils.Makefiles.Visit (E);

      --  The Ada project files

      Build_Utils.Ada_Project_Files.Visit (E);
   end Visit_Architecture_Instance;

end Ocarina.Backends.PO_HI_Ada;