1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2010, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
27 with ALI.Util; use ALI.Util;
28 with Bcheck; use Bcheck;
29 with Binde; use Binde;
30 with Binderr; use Binderr;
31 with Bindgen; use Bindgen;
33 with Butil; use Butil;
34 with Casing; use Casing;
36 with Debug; use Debug;
38 with Fname; use Fname;
39 with Namet; use Namet;
41 with Osint; use Osint;
42 with Osint.B; use Osint.B;
43 with Output; use Output;
44 with Rident; use Rident;
46 with Switch; use Switch;
47 with Switch.B; use Switch.B;
49 with Targparm; use Targparm;
50 with Types; use Types;
52 with System.Case_Util; use System.Case_Util;
53 with System.OS_Lib; use System.OS_Lib;
55 with Ada.Command_Line.Response_File; use Ada.Command_Line;
59 Total_Errors : Nat := 0;
60 -- Counts total errors in all files
62 Total_Warnings : Nat := 0;
63 -- Total warnings in all files
65 Main_Lib_File : File_Name_Type;
66 -- Current main library file
68 First_Main_Lib_File : File_Name_Type := No_File;
69 -- The first library file, that should be a main subprogram if neither -n
72 Std_Lib_File : File_Name_Type;
75 Text : Text_Buffer_Ptr;
78 Output_File_Name_Seen : Boolean := False;
79 Output_File_Name : String_Ptr := new String'("");
81 L_Switch_Seen : Boolean := False;
83 Mapping_File : String_Ptr := null;
85 package Closure_Sources is new Table.Table
86 (Table_Component_Type => File_Name_Type,
87 Table_Index_Type => Natural,
90 Table_Increment => 100,
91 Table_Name => "Gnatbind.Closure_Sources");
92 -- Table to record the sources in the closure, to avoid duplications. Used
93 -- only with switch -R.
95 function Gnatbind_Supports_Auto_Init return Boolean;
96 -- Indicates if automatic initialization of elaboration procedure
97 -- through the constructor mechanism is possible on the platform.
99 procedure List_Applicable_Restrictions;
100 -- List restrictions that apply to this partition if option taken
102 procedure Scan_Bind_Arg (Argv : String);
103 -- Scan and process binder specific arguments. Argv is a single argument.
104 -- All the one character arguments are still handled by Switch. This
105 -- routine handles -aO -aI and -I-. The lower bound of Argv must be 1.
107 function Is_Cross_Compiler return Boolean;
108 -- Returns True iff this is a cross-compiler
110 ---------------------------------
111 -- Gnatbind_Supports_Auto_Init --
112 ---------------------------------
114 function Gnatbind_Supports_Auto_Init return Boolean is
115 function gnat_binder_supports_auto_init return Integer;
116 pragma Import (C, gnat_binder_supports_auto_init,
117 "__gnat_binder_supports_auto_init");
119 return gnat_binder_supports_auto_init /= 0;
120 end Gnatbind_Supports_Auto_Init;
122 -----------------------
123 -- Is_Cross_Compiler --
124 -----------------------
126 function Is_Cross_Compiler return Boolean is
127 Cross_Compiler : Integer;
128 pragma Import (C, Cross_Compiler, "__gnat_is_cross_compiler");
130 return Cross_Compiler = 1;
131 end Is_Cross_Compiler;
133 ----------------------------------
134 -- List_Applicable_Restrictions --
135 ----------------------------------
137 procedure List_Applicable_Restrictions is
139 -- Define those restrictions that should be output if the gnatbind
140 -- -r switch is used. Not all restrictions are output for the reasons
141 -- given below in the list, and this array is used to test whether
142 -- the corresponding pragma should be listed. True means that it
143 -- should not be listed.
145 No_Restriction_List : constant array (All_Restrictions) of Boolean :=
146 (No_Exception_Propagation => True,
147 -- Modifies code resulting in different exception semantics
149 No_Exceptions => True,
150 -- Has unexpected Suppress (All_Checks) effect
152 No_Implicit_Conditionals => True,
153 -- This could modify and pessimize generated code
155 No_Implicit_Dynamic_Code => True,
156 -- This could modify and pessimize generated code
158 No_Implicit_Loops => True,
159 -- This could modify and pessimize generated code
161 No_Recursion => True,
162 -- Not checkable at compile time
164 No_Reentrancy => True,
165 -- Not checkable at compile time
167 Max_Entry_Queue_Length => True,
168 -- Not checkable at compile time
170 Max_Storage_At_Blocking => True,
171 -- Not checkable at compile time
175 Additional_Restrictions_Listed : Boolean := False;
176 -- Set True if we have listed header for restrictions
178 function Restriction_Could_Be_Set (R : Restriction_Id) return Boolean;
179 -- Returns True if the given restriction can be listed as an additional
180 -- restriction that could be set.
182 ------------------------------
183 -- Restriction_Could_Be_Set --
184 ------------------------------
186 function Restriction_Could_Be_Set (R : Restriction_Id) return Boolean is
187 CR : Restrictions_Info renames Cumulative_Restrictions;
192 -- Boolean restriction
194 when All_Boolean_Restrictions =>
196 -- The condition for listing a boolean restriction as an
197 -- additional restriction that could be set is that it is
198 -- not violated by any unit, and not already set.
200 return CR.Violated (R) = False and then CR.Set (R) = False;
202 -- Parameter restriction
204 when All_Parameter_Restrictions =>
206 -- If the restriction is violated and the level of violation is
207 -- unknown, the restriction can definitely not be listed.
209 if CR.Violated (R) and then CR.Unknown (R) then
212 -- We can list the restriction if it is not set
214 elsif not CR.Set (R) then
217 -- We can list the restriction if is set to a greater value
218 -- than the maximum value known for the violation.
221 return CR.Value (R) > CR.Count (R);
224 -- No other values for R possible
230 end Restriction_Could_Be_Set;
232 -- Start of processing for List_Applicable_Restrictions
235 -- Loop through restrictions
237 for R in All_Restrictions loop
238 if not No_Restriction_List (R)
239 and then Restriction_Could_Be_Set (R)
241 if not Additional_Restrictions_Listed then
244 ("The following additional restrictions may be" &
245 " applied to this partition:");
246 Additional_Restrictions_Listed := True;
249 Write_Str ("pragma Restrictions (");
252 S : constant String := Restriction_Id'Image (R);
254 Name_Len := S'Length;
255 Name_Buffer (1 .. Name_Len) := S;
258 Set_Casing (Mixed_Case);
259 Write_Str (Name_Buffer (1 .. Name_Len));
261 if R in All_Parameter_Restrictions then
263 Write_Int (Int (Cumulative_Restrictions.Count (R)));
270 end List_Applicable_Restrictions;
276 procedure Scan_Bind_Arg (Argv : String) is
277 pragma Assert (Argv'First = 1);
280 -- Now scan arguments that are specific to the binder and are not
281 -- handled by the common circuitry in Switch.
283 if Opt.Output_File_Name_Present
284 and then not Output_File_Name_Seen
286 Output_File_Name_Seen := True;
289 or else (Argv'Length >= 1 and then Argv (1) = '-')
291 Fail ("output File_Name missing after -o");
294 Output_File_Name := new String'(Argv);
297 elsif Argv'Length >= 2 and then Argv (1) = '-' then
301 if Argv (2 .. Argv'Last) = "I-" then
302 Opt.Look_In_Primary_Dir := False;
306 elsif Argv (2) = 'I' then
307 Add_Src_Search_Dir (Argv (3 .. Argv'Last));
308 Add_Lib_Search_Dir (Argv (3 .. Argv'Last));
312 elsif Argv (2) = 'L' then
313 if Argv'Length >= 3 then
315 -- Remember that the -L switch was specified, so that if this
316 -- is on OpenVMS, the export names are put in uppercase.
317 -- This is not known before the target parameters are read.
319 L_Switch_Seen := True;
321 Opt.Bind_For_Library := True;
323 new String'(Argv (3 .. Argv'Last) & Opt.Ada_Init_Suffix);
324 Opt.Ada_Final_Name :=
325 new String'(Argv (3 .. Argv'Last) & Opt.Ada_Final_Suffix);
327 new String'(Argv (3 .. Argv'Last) & Opt.Ada_Main_Name_Suffix);
329 -- This option (-Lxxx) implies -n
331 Opt.Bind_Main_Program := False;
335 ("Prefix of initialization and finalization " &
336 "procedure names missing in -L");
339 -- -Sin -Slo -Shi -Sxx -Sev
341 elsif Argv'Length = 4
342 and then Argv (2) = 'S'
345 C1 : Character := Argv (3);
346 C2 : Character := Argv (4);
349 -- Fold to upper case
351 if C1 in 'a' .. 'z' then
352 C1 := Character'Val (Character'Pos (C1) - 32);
355 if C2 in 'a' .. 'z' then
356 C2 := Character'Val (Character'Pos (C2) - 32);
359 -- Test valid option and set mode accordingly
361 if C1 = 'E' and then C2 = 'V' then
364 elsif C1 = 'I' and then C2 = 'N' then
367 elsif C1 = 'L' and then C2 = 'O' then
370 elsif C1 = 'H' and then C2 = 'I' then
373 elsif (C1 in '0' .. '9' or else C1 in 'A' .. 'F')
375 (C2 in '0' .. '9' or else C2 in 'A' .. 'F')
379 -- Invalid -S switch, let Switch give error, set default of IN
382 Scan_Binder_Switches (Argv);
387 Initialize_Scalars_Mode1 := C1;
388 Initialize_Scalars_Mode2 := C2;
393 elsif Argv'Length >= 3
394 and then Argv (2 .. 3) = "aI"
396 Add_Src_Search_Dir (Argv (4 .. Argv'Last));
400 elsif Argv'Length >= 3
401 and then Argv (2 .. 3) = "aO"
403 Add_Lib_Search_Dir (Argv (4 .. Argv'Last));
407 elsif Argv (2 .. Argv'Last) = "nostdlib" then
408 Opt.No_Stdlib := True;
412 elsif Argv (2 .. Argv'Last) = "nostdinc" then
413 Opt.No_Stdinc := True;
417 elsif Argv (2 .. Argv'Last) = "static" then
418 Opt.Shared_Libgnat := False;
422 elsif Argv (2 .. Argv'Last) = "shared" then
423 Opt.Shared_Libgnat := True;
427 elsif Argv'Length >= 4 and then Argv (2 .. 3) = "F=" then
428 if Mapping_File /= null then
429 Fail ("cannot specify several mapping files");
432 Mapping_File := new String'(Argv (4 .. Argv'Last));
436 elsif Argv'Length >= 3 and then Argv (2) = 'M' then
437 if not Is_Cross_Compiler then
439 ("gnatbind: -M not expected to be used on native platforms");
442 Opt.Bind_Alternate_Main_Name := True;
443 Opt.Alternate_Main_Name := new String'(Argv (3 .. Argv'Last));
445 -- All other options are single character and are handled by
446 -- Scan_Binder_Switches.
449 Scan_Binder_Switches (Argv);
452 -- Not a switch, so must be a file name (if non-empty)
454 elsif Argv'Length /= 0 then
456 and then Argv (Argv'Last - 3 .. Argv'Last) = ".ali"
460 Add_File (Argv & ".ali");
465 procedure Check_Version_And_Help is
466 new Check_Version_And_Help_G (Bindusg.Display);
468 -- Start of processing for Gnatbind
472 -- Set default for Shared_Libgnat option
475 Shared_Libgnat_Default : Character;
477 (C, Shared_Libgnat_Default, "__gnat_shared_libgnat_default");
479 SHARED : constant Character := 'H';
480 STATIC : constant Character := 'T';
484 (Shared_Libgnat_Default = SHARED
486 Shared_Libgnat_Default = STATIC);
487 Shared_Libgnat := (Shared_Libgnat_Default = SHARED);
490 -- Scan the switches and arguments
492 -- First, scan to detect --version and/or --help
494 Check_Version_And_Help ("GNATBIND", "1995");
496 -- Use low level argument routines to avoid dragging in the secondary stack
499 Scan_Args : while Next_Arg < Arg_Count loop
501 Next_Argv : String (1 .. Len_Arg (Next_Arg));
503 Fill_Arg (Next_Argv'Address, Next_Arg);
505 if Next_Argv'Length > 0 then
506 if Next_Argv (1) = '@' then
507 if Next_Argv'Length > 1 then
509 Arguments : constant Argument_List :=
510 Response_File.Arguments_From
511 (Response_File_Name =>
512 Next_Argv (2 .. Next_Argv'Last),
514 Ignore_Non_Existing_Files => True);
516 for J in Arguments'Range loop
517 Scan_Bind_Arg (Arguments (J).all);
523 Scan_Bind_Arg (Next_Argv);
528 Next_Arg := Next_Arg + 1;
531 if Use_Pragma_Linker_Constructor then
532 if Bind_Main_Program then
533 Fail ("switch -a must be used in conjunction with -n or -Lxxx");
535 elsif not Gnatbind_Supports_Auto_Init then
536 Fail ("automatic initialisation of elaboration " &
537 "not supported on this platform");
541 -- Test for trailing -o switch
543 if Opt.Output_File_Name_Present
544 and then not Output_File_Name_Seen
546 Fail ("output file name missing after -o");
549 -- Output usage if requested
551 if Usage_Requested then
555 -- Check that the Ada binder file specified has extension .adb and that
556 -- the C binder file has extension .c
558 if Opt.Output_File_Name_Present
559 and then Output_File_Name_Seen
561 Check_Extensions : declare
562 Length : constant Natural := Output_File_Name'Length;
563 Last : constant Natural := Output_File_Name'Last;
566 if Ada_Bind_File then
568 or else Output_File_Name (Last - 3 .. Last) /= ".adb"
570 Fail ("output file name should have .adb extension");
575 or else Output_File_Name (Last - 1 .. Last) /= ".c"
577 Fail ("output file name should have .c extension");
580 end Check_Extensions;
583 Osint.Add_Default_Search_Dirs;
585 -- Carry out package initializations. These are initializations which
586 -- might logically be performed at elaboration time, but Namet at least
587 -- can't be done that way (because it is used in the Compiler), and we
588 -- decide to be consistent. Like elaboration, the order in which these
589 -- calls are made is in some cases important.
595 -- Acquire target parameters
597 Targparm.Get_Target_Parameters;
599 -- Initialize Cumulative_Restrictions with the restrictions on the target
600 -- scanned from the system.ads file. Then as we read ALI files, we will
601 -- accumulate additional restrictions specified in other files.
603 Cumulative_Restrictions := Targparm.Restrictions_On_Target;
605 -- On OpenVMS, when -L is used, all external names used in pragmas Export
606 -- are in upper case. The reason is that on OpenVMS, the macro-assembler
607 -- MACASM-32, used to build Stand-Alone Libraries, only understands
610 if L_Switch_Seen and then OpenVMS_On_Target then
611 To_Upper (Opt.Ada_Init_Name.all);
612 To_Upper (Opt.Ada_Final_Name.all);
613 To_Upper (Opt.Ada_Main_Name.all);
616 -- Acquire configurable run-time mode
618 if Configurable_Run_Time_On_Target then
619 Configurable_Run_Time_Mode := True;
622 -- Output copyright notice if in verbose mode
626 Display_Version ("GNATBIND", "1995");
629 -- Output usage information if no files
631 if not More_Lib_Files then
633 Exit_Program (E_Fatal);
636 -- If a mapping file was specified, initialize the file mapping
638 if Mapping_File /= null then
639 Fmap.Initialize (Mapping_File.all);
642 -- The block here is to catch the Unrecoverable_Error exception in the
643 -- case where we exceed the maximum number of permissible errors or some
644 -- other unrecoverable error occurs.
647 -- Initialize binder packages
651 Initialize_ALI_Source;
659 while More_Lib_Files loop
660 Main_Lib_File := Next_Main_Lib_File;
662 if First_Main_Lib_File = No_File then
663 First_Main_Lib_File := Main_Lib_File;
668 Write_Str ("Checking: ");
670 Write_Str ("Binding: ");
673 Write_Name (Main_Lib_File);
677 Text := Read_Library_Info (Main_Lib_File, True);
681 pragma Warnings (Off, Id);
689 Ignore_Errors => Debug_Flag_I,
690 Directly_Scanned => True);
698 if No_Run_Time_Mode then
700 -- Set standard configuration parameters
702 Suppress_Standard_Library_On_Target := True;
703 Configurable_Run_Time_Mode := True;
706 -- For main ALI files, even if they are interfaces, we get their
707 -- dependencies. To be sure, we reset the Interface flag for all main
710 for Index in ALIs.First .. ALIs.Last loop
711 ALIs.Table (Index).SAL_Interface := False;
714 -- Add System.Standard_Library to list to ensure that these files are
715 -- included in the bind, even if not directly referenced from Ada code
716 -- This is suppressed if the appropriate targparm switch is set.
718 if not Suppress_Standard_Library_On_Target then
719 Name_Buffer (1 .. 12) := "s-stalib.ali";
721 Std_Lib_File := Name_Find;
722 Text := Read_Library_Info (Std_Lib_File, True);
726 pragma Warnings (Off, Id);
735 Ignore_Errors => Debug_Flag_I);
741 -- Acquire all information in ALI files that have been read in
743 for Index in ALIs.First .. ALIs.Last loop
747 -- Quit if some file needs compiling
749 if No_Object_Specified then
750 raise Unrecoverable_Error;
753 -- Build source file table from the ALI files we have read in
757 -- If there is main program to bind, set Main_Lib_File to the first
758 -- library file, and the name from which to derive the binder generate
759 -- file to the first ALI file.
761 if Bind_Main_Program then
762 Main_Lib_File := First_Main_Lib_File;
763 Set_Current_File_Name_Index (To => 1);
766 -- Check that main library file is a suitable main program
769 and then ALIs.Table (ALIs.First).Main_Program = None
770 and then not No_Main_Subprogram
772 Error_Msg_File_1 := Main_Lib_File;
773 Error_Msg ("{ does not contain a unit that can be a main program");
776 -- Perform consistency and correctness checks
778 Check_Duplicated_Subunits;
781 Check_Configuration_Consistency;
783 -- List restrictions that could be applied to this partition
785 if List_Restrictions then
786 List_Applicable_Restrictions;
789 -- Complete bind if no errors
791 if Errors_Detected = 0 then
794 if Errors_Detected = 0 then
795 -- Display elaboration order if -l was specified
797 if Elab_Order_Output then
798 if not Zero_Formatting then
800 Write_Str ("ELABORATION ORDER");
804 for J in Elab_Order.First .. Elab_Order.Last loop
805 if not Units.Table (Elab_Order.Table (J)).SAL_Interface then
806 if not Zero_Formatting then
811 (Units.Table (Elab_Order.Table (J)).Uname);
816 if not Zero_Formatting then
821 if not Check_Only then
822 Gen_Output_File (Output_File_Name.all);
825 -- Display list of sources in the closure (except predefined
826 -- sources) if -R was used.
829 List_Closure_Display : declare
830 Source : File_Name_Type;
832 function Put_In_Sources (S : File_Name_Type) return Boolean;
833 -- Check if S is already in table Sources and put in Sources
834 -- if it is not. Return False if the source is already in
835 -- Sources, and True if it is added.
841 function Put_In_Sources (S : File_Name_Type)
845 for J in 1 .. Closure_Sources.Last loop
846 if Closure_Sources.Table (J) = S then
851 Closure_Sources.Append (S);
855 -- Start of processing for List_Closure_Display
858 Closure_Sources.Init;
860 if not Zero_Formatting then
862 Write_Str ("REFERENCED SOURCES");
866 for J in reverse Elab_Order.First .. Elab_Order.Last loop
867 Source := Units.Table (Elab_Order.Table (J)).Sfile;
869 -- Do not include the sources of the runtime and do not
870 -- include the same source several times.
872 if Put_In_Sources (Source)
873 and then not Is_Internal_File_Name (Source)
875 if not Zero_Formatting then
879 Write_Str (Get_Name_String (Source));
884 -- Subunits do not appear in the elaboration table because
885 -- they are subsumed by their parent units, but we need to
886 -- list them for other tools. For now they are listed after
887 -- other files, rather than right after their parent, since
888 -- there is no easy link between the elaboration table and
889 -- the ALIs table ??? As subunits may appear repeatedly in
890 -- the list, if the parent unit appears in the context of
891 -- several units in the closure, duplicates are suppressed.
893 for J in Sdep.First .. Sdep.Last loop
894 Source := Sdep.Table (J).Sfile;
896 if Sdep.Table (J).Subunit_Name /= No_Name
897 and then Put_In_Sources (Source)
898 and then not Is_Internal_File_Name (Source)
900 if not Zero_Formatting then
904 Write_Str (Get_Name_String (Source));
909 if not Zero_Formatting then
912 end List_Closure_Display;
917 Total_Errors := Total_Errors + Errors_Detected;
918 Total_Warnings := Total_Warnings + Warnings_Detected;
921 when Unrecoverable_Error =>
922 Total_Errors := Total_Errors + Errors_Detected;
923 Total_Warnings := Total_Warnings + Warnings_Detected;
926 -- All done. Set proper exit status
931 if Total_Errors > 0 then
932 Exit_Program (E_Errors);
934 elsif Total_Warnings > 0 then
935 Exit_Program (E_Warnings);
938 -- Do not call Exit_Program (E_Success), so that finalization occurs