2015-05-05 Yvan Roux <yvan.roux@linaro.org>
[official-gcc.git] / gcc / ada / gnatlink.adb
blob190aadfb20698c810014ce4d2a021b20b804be7a
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- G N A T L I N K --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1996-2014, Free Software Foundation, Inc. --
10 -- --
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. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 -- Gnatlink usage: please consult the gnat documentation
28 with ALI; use ALI;
29 with Csets;
30 with Gnatvsn; use Gnatvsn;
31 with Indepsw; use Indepsw;
32 with Namet; use Namet;
33 with Opt;
34 with Osint; use Osint;
35 with Output; use Output;
36 with Snames;
37 with Switch; use Switch;
38 with System; use System;
39 with Table;
40 with Targparm; use Targparm;
41 with Types;
43 with Ada.Command_Line; use Ada.Command_Line;
44 with Ada.Exceptions; use Ada.Exceptions;
46 with System.OS_Lib; use System.OS_Lib;
47 with System.CRTL;
49 with Interfaces.C_Streams; use Interfaces.C_Streams;
50 with Interfaces.C.Strings; use Interfaces.C.Strings;
52 procedure Gnatlink is
53 pragma Ident (Gnatvsn.Gnat_Static_Version_String);
55 Shared_Libgcc_String : constant String := "-shared-libgcc";
56 Shared_Libgcc : constant String_Access :=
57 new String'(Shared_Libgcc_String);
58 -- Used to invoke gcc when the binder is invoked with -shared
60 Static_Libgcc_String : constant String := "-static-libgcc";
61 Static_Libgcc : constant String_Access :=
62 new String'(Static_Libgcc_String);
63 -- Used to invoke gcc when shared libs are not used
65 package Gcc_Linker_Options is new Table.Table (
66 Table_Component_Type => String_Access,
67 Table_Index_Type => Integer,
68 Table_Low_Bound => 1,
69 Table_Initial => 20,
70 Table_Increment => 100,
71 Table_Name => "Gnatlink.Gcc_Linker_Options");
72 -- Comments needed ???
74 package Libpath is new Table.Table (
75 Table_Component_Type => Character,
76 Table_Index_Type => Integer,
77 Table_Low_Bound => 1,
78 Table_Initial => 4096,
79 Table_Increment => 100,
80 Table_Name => "Gnatlink.Libpath");
81 -- Comments needed ???
83 package Linker_Options is new Table.Table (
84 Table_Component_Type => String_Access,
85 Table_Index_Type => Integer,
86 Table_Low_Bound => 1,
87 Table_Initial => 20,
88 Table_Increment => 100,
89 Table_Name => "Gnatlink.Linker_Options");
90 -- Comments needed ???
92 package Linker_Objects is new Table.Table (
93 Table_Component_Type => String_Access,
94 Table_Index_Type => Integer,
95 Table_Low_Bound => 1,
96 Table_Initial => 20,
97 Table_Increment => 100,
98 Table_Name => "Gnatlink.Linker_Objects");
99 -- This table collects the objects file to be passed to the linker. In the
100 -- case where the linker command line is too long then programs objects
101 -- are put on the Response_File_Objects table. Note that the binder object
102 -- file and the user's objects remain in this table. This is very
103 -- important because on the GNU linker command line the -L switch is not
104 -- used to look for objects files but -L switch is used to look for
105 -- objects listed in the response file. This is not a problem with the
106 -- applications objects as they are specified with a full name.
108 package Response_File_Objects is new Table.Table (
109 Table_Component_Type => String_Access,
110 Table_Index_Type => Integer,
111 Table_Low_Bound => 1,
112 Table_Initial => 20,
113 Table_Increment => 100,
114 Table_Name => "Gnatlink.Response_File_Objects");
115 -- This table collects the objects file that are to be put in the response
116 -- file. Only application objects are collected there (see details in
117 -- Linker_Objects table comments)
119 package Binder_Options_From_ALI is new Table.Table (
120 Table_Component_Type => String_Access,
121 Table_Index_Type => Integer,
122 Table_Low_Bound => 1, -- equals low bound of Argument_List for Spawn
123 Table_Initial => 20,
124 Table_Increment => 100,
125 Table_Name => "Gnatlink.Binder_Options_From_ALI");
126 -- This table collects the switches from the ALI file of the main
127 -- subprogram.
129 package Binder_Options is new Table.Table (
130 Table_Component_Type => String_Access,
131 Table_Index_Type => Integer,
132 Table_Low_Bound => 1, -- equals low bound of Argument_List for Spawn
133 Table_Initial => 20,
134 Table_Increment => 100,
135 Table_Name => "Gnatlink.Binder_Options");
136 -- This table collects the arguments to be passed to compile the binder
137 -- generated file.
139 Gcc : String_Access := Program_Name ("gcc", "gnatlink");
141 Read_Mode : constant String := "r" & ASCII.NUL;
143 Begin_Info : constant String := "-- BEGIN Object file/option list";
144 End_Info : constant String := "-- END Object file/option list ";
146 Gcc_Path : String_Access;
147 Linker_Path : String_Access;
148 Output_File_Name : String_Access;
149 Ali_File_Name : String_Access;
150 Binder_Spec_Src_File : String_Access;
151 Binder_Body_Src_File : String_Access;
152 Binder_Ali_File : String_Access;
153 Binder_Obj_File : String_Access;
155 Base_Command_Name : String_Access;
157 Tname : Temp_File_Name;
158 Tname_FD : File_Descriptor := Invalid_FD;
159 -- Temporary file used by linker to pass list of object files on
160 -- certain systems with limitations on size of arguments.
162 Debug_Flag_Present : Boolean := False;
163 Verbose_Mode : Boolean := False;
164 Very_Verbose_Mode : Boolean := False;
166 Standard_Gcc : Boolean := True;
168 Compile_Bind_File : Boolean := True;
169 -- Set to False if bind file is not to be compiled
171 Create_Map_File : Boolean := False;
172 -- Set to True by switch -M. The map file name is derived from
173 -- the ALI file name (mainprog.ali => mainprog.map).
175 Object_List_File_Supported : Boolean;
176 for Object_List_File_Supported'Size use Character'Size;
177 pragma Import
178 (C, Object_List_File_Supported, "__gnat_objlist_file_supported");
179 -- Predicate indicating whether the linker has an option whereby the
180 -- names of object files can be passed to the linker in a file.
182 Object_File_Option_Ptr : Interfaces.C.Strings.chars_ptr;
183 pragma Import (C, Object_File_Option_Ptr, "__gnat_object_file_option");
184 -- Pointer to a string representing the linker option which specifies
185 -- the response file.
187 Object_File_Option : constant String := Value (Object_File_Option_Ptr);
188 -- The linker option which specifies the response file as a string
190 Using_GNU_response_file : constant Boolean :=
191 Object_File_Option'Length > 0
192 and then Object_File_Option (Object_File_Option'Last) = '@';
193 -- Whether a GNU response file is used
195 Object_List_File_Required : Boolean := False;
196 -- Set to True to force generation of a response file
198 Shared_Libgcc_Default : Character;
199 for Shared_Libgcc_Default'Size use Character'Size;
200 pragma Import
201 (C, Shared_Libgcc_Default, "__gnat_shared_libgcc_default");
202 -- Indicates wether libgcc should be statically linked (use 'T') or
203 -- dynamically linked (use 'H') by default.
205 function Base_Name (File_Name : String) return String;
206 -- Return just the file name part without the extension (if present)
208 procedure Check_Existing_Executable (File_Name : String);
209 -- Delete any existing executable to avoid accidentally updating the target
210 -- of a symbolic link, but produce a Fatail_Error if File_Name matches any
211 -- of the source file names. This avoids overwriting of extensionless
212 -- source files by accident on systems where executables do not have
213 -- extensions.
215 procedure Delete (Name : String);
216 -- Wrapper to unlink as status is ignored by this application
218 procedure Error_Msg (Message : String);
219 -- Output the error or warning Message
221 procedure Exit_With_Error (Error : String);
222 -- Output Error and exit program with a fatal condition
224 procedure Process_Args;
225 -- Go through all the arguments and build option tables
227 procedure Process_Binder_File (Name : String);
228 -- Reads the binder file and extracts linker arguments
230 procedure Usage;
231 -- Display usage
233 procedure Write_Header;
234 -- Show user the program name, version and copyright
236 procedure Write_Usage;
237 -- Show user the program options
239 ---------------
240 -- Base_Name --
241 ---------------
243 function Base_Name (File_Name : String) return String is
244 Findex1 : Natural;
245 Findex2 : Natural;
247 begin
248 Findex1 := File_Name'First;
250 -- The file might be specified by a full path name. However,
251 -- we want the path to be stripped away.
253 for J in reverse File_Name'Range loop
254 if Is_Directory_Separator (File_Name (J)) then
255 Findex1 := J + 1;
256 exit;
257 end if;
258 end loop;
260 Findex2 := File_Name'Last;
261 while Findex2 > Findex1 and then File_Name (Findex2) /= '.' loop
262 Findex2 := Findex2 - 1;
263 end loop;
265 if Findex2 = Findex1 then
266 Findex2 := File_Name'Last + 1;
267 end if;
269 return File_Name (Findex1 .. Findex2 - 1);
270 end Base_Name;
272 -------------------------------
273 -- Check_Existing_Executable --
274 -------------------------------
276 procedure Check_Existing_Executable (File_Name : String) is
277 Ename : String := File_Name;
278 Efile : File_Name_Type;
279 Sfile : File_Name_Type;
281 begin
282 Canonical_Case_File_Name (Ename);
283 Name_Len := 0;
284 Add_Str_To_Name_Buffer (Ename);
285 Efile := Name_Find;
287 for J in Units.Table'First .. Units.Last loop
288 Sfile := Units.Table (J).Sfile;
289 if Sfile = Efile then
290 Exit_With_Error
291 ("executable name """ & File_Name & """ matches "
292 & "source file name """ & Get_Name_String (Sfile) & """");
293 end if;
294 end loop;
296 Delete (File_Name);
297 end Check_Existing_Executable;
299 ------------
300 -- Delete --
301 ------------
303 procedure Delete (Name : String) is
304 Status : int;
305 pragma Unreferenced (Status);
306 begin
307 Status := unlink (Name'Address);
308 -- Is it really right to ignore an error here ???
309 end Delete;
311 ---------------
312 -- Error_Msg --
313 ---------------
315 procedure Error_Msg (Message : String) is
316 begin
317 Write_Str (Base_Command_Name.all);
318 Write_Str (": ");
319 Write_Str (Message);
320 Write_Eol;
321 end Error_Msg;
323 ---------------------
324 -- Exit_With_Error --
325 ---------------------
327 procedure Exit_With_Error (Error : String) is
328 begin
329 Error_Msg (Error);
330 Exit_Program (E_Fatal);
331 end Exit_With_Error;
333 ------------------
334 -- Process_Args --
335 ------------------
337 procedure Process_Args is
338 Next_Arg : Integer;
340 Skip_Next : Boolean := False;
341 -- Set to true if the next argument is to be added into the list of
342 -- linker's argument without parsing it.
344 procedure Check_Version_And_Help is new Check_Version_And_Help_G (Usage);
346 -- Start of processing for Process_Args
348 begin
349 -- First, check for --version and --help
351 Check_Version_And_Help ("GNATLINK", "1996");
353 -- Loop through arguments of gnatlink command
355 Next_Arg := 1;
356 loop
357 exit when Next_Arg > Argument_Count;
359 Process_One_Arg : declare
360 Arg : constant String := Argument (Next_Arg);
362 begin
363 -- Case of argument which is a switch
365 -- We definitely need section by section comments here ???
367 if Skip_Next then
369 -- This argument must not be parsed, just add it to the
370 -- list of linker's options.
372 Skip_Next := False;
374 Linker_Options.Increment_Last;
375 Linker_Options.Table (Linker_Options.Last) :=
376 new String'(Arg);
378 elsif Arg'Length /= 0 and then Arg (1) = '-' then
379 if Arg'Length > 4 and then Arg (2 .. 5) = "gnat" then
380 Exit_With_Error
381 ("invalid switch: """ & Arg & """ (gnat not needed here)");
382 end if;
384 if Arg = "-Xlinker" then
386 -- Next argument should be sent directly to the linker.
387 -- We do not want to parse it here.
389 Skip_Next := True;
391 Linker_Options.Increment_Last;
392 Linker_Options.Table (Linker_Options.Last) :=
393 new String'(Arg);
395 elsif Arg (2) = 'g'
396 and then (Arg'Length < 5 or else Arg (2 .. 5) /= "gnat")
397 then
398 Debug_Flag_Present := True;
400 Linker_Options.Increment_Last;
401 Linker_Options.Table (Linker_Options.Last) :=
402 new String'(Arg);
404 Binder_Options.Increment_Last;
405 Binder_Options.Table (Binder_Options.Last) :=
406 Linker_Options.Table (Linker_Options.Last);
408 elsif Arg'Length >= 3 and then Arg (2) = 'M' then
409 declare
410 Switches : String_List_Access;
412 begin
413 Convert (Map_File, Arg (3 .. Arg'Last), Switches);
415 if Switches /= null then
416 for J in Switches'Range loop
417 Linker_Options.Increment_Last;
418 Linker_Options.Table (Linker_Options.Last) :=
419 Switches (J);
420 end loop;
421 end if;
422 end;
424 elsif Arg'Length = 2 then
425 case Arg (2) is
426 when 'b' =>
427 Linker_Options.Increment_Last;
428 Linker_Options.Table (Linker_Options.Last) :=
429 new String'(Arg);
431 Binder_Options.Increment_Last;
432 Binder_Options.Table (Binder_Options.Last) :=
433 Linker_Options.Table (Linker_Options.Last);
435 Next_Arg := Next_Arg + 1;
437 if Next_Arg > Argument_Count then
438 Exit_With_Error ("Missing argument for -b");
439 end if;
441 Get_Machine_Name : declare
442 Name_Arg : constant String_Access :=
443 new String'(Argument (Next_Arg));
445 begin
446 Linker_Options.Increment_Last;
447 Linker_Options.Table (Linker_Options.Last) :=
448 Name_Arg;
450 Binder_Options.Increment_Last;
451 Binder_Options.Table (Binder_Options.Last) :=
452 Name_Arg;
454 end Get_Machine_Name;
456 when 'f' =>
457 if Object_List_File_Supported then
458 Object_List_File_Required := True;
459 else
460 Exit_With_Error
461 ("Object list file not supported on this target");
462 end if;
464 when 'M' =>
465 Create_Map_File := True;
467 when 'n' =>
468 Compile_Bind_File := False;
470 when 'o' =>
471 Next_Arg := Next_Arg + 1;
473 if Next_Arg > Argument_Count then
474 Exit_With_Error ("Missing argument for -o");
475 end if;
477 Output_File_Name :=
478 new String'(Executable_Name
479 (Argument (Next_Arg),
480 Only_If_No_Suffix => True));
482 when 'P' =>
483 Opt.CodePeer_Mode := True;
485 when 'R' =>
486 Opt.Run_Path_Option := False;
488 when 'v' =>
490 -- Support "double" verbose mode. Second -v
491 -- gets sent to the linker and binder phases.
493 if Verbose_Mode then
494 Very_Verbose_Mode := True;
496 Linker_Options.Increment_Last;
497 Linker_Options.Table (Linker_Options.Last) :=
498 new String'(Arg);
500 Binder_Options.Increment_Last;
501 Binder_Options.Table (Binder_Options.Last) :=
502 Linker_Options.Table (Linker_Options.Last);
504 else
505 Verbose_Mode := True;
507 end if;
509 when others =>
510 Linker_Options.Increment_Last;
511 Linker_Options.Table (Linker_Options.Last) :=
512 new String'(Arg);
514 end case;
516 elsif Arg (2) = 'B' then
517 Linker_Options.Increment_Last;
518 Linker_Options.Table (Linker_Options.Last) :=
519 new String'(Arg);
521 Binder_Options.Increment_Last;
522 Binder_Options.Table (Binder_Options.Last) :=
523 Linker_Options.Table (Linker_Options.Last);
525 elsif Arg'Length >= 7 and then Arg (1 .. 7) = "--LINK=" then
526 if Arg'Length = 7 then
527 Exit_With_Error ("Missing argument for --LINK=");
528 end if;
530 Linker_Path :=
531 System.OS_Lib.Locate_Exec_On_Path (Arg (8 .. Arg'Last));
533 if Linker_Path = null then
534 Exit_With_Error
535 ("Could not locate linker: " & Arg (8 .. Arg'Last));
536 end if;
538 elsif Arg'Length > 6 and then Arg (1 .. 6) = "--GCC=" then
539 declare
540 Program_Args : constant Argument_List_Access :=
541 Argument_String_To_List
542 (Arg (7 .. Arg'Last));
544 begin
545 if Program_Args.all (1).all /= Gcc.all then
546 Gcc := new String'(Program_Args.all (1).all);
547 Standard_Gcc := False;
548 end if;
550 -- Set appropriate flags for switches passed
552 for J in 2 .. Program_Args.all'Last loop
553 declare
554 Arg : constant String := Program_Args.all (J).all;
555 AF : constant Integer := Arg'First;
557 begin
558 if Arg'Length /= 0 and then Arg (AF) = '-' then
559 if Arg (AF + 1) = 'g'
560 and then (Arg'Length = 2
561 or else Arg (AF + 2) in '0' .. '3'
562 or else Arg (AF + 2 .. Arg'Last) = "coff")
563 then
564 Debug_Flag_Present := True;
565 end if;
566 end if;
568 -- Add directory to source search dirs so that
569 -- Get_Target_Parameters can find system.ads
571 if Arg (AF .. AF + 1) = "-I"
572 and then Arg'Length > 2
573 then
574 Add_Src_Search_Dir (Arg (AF + 2 .. Arg'Last));
575 end if;
577 -- Pass to gcc for compiling binder generated file
578 -- No use passing libraries, it will just generate
579 -- a warning
581 if not (Arg (AF .. AF + 1) = "-l"
582 or else Arg (AF .. AF + 1) = "-L")
583 then
584 Binder_Options.Increment_Last;
585 Binder_Options.Table (Binder_Options.Last) :=
586 new String'(Arg);
587 end if;
589 -- Pass to gcc for linking program
591 Gcc_Linker_Options.Increment_Last;
592 Gcc_Linker_Options.Table
593 (Gcc_Linker_Options.Last) := new String'(Arg);
594 end;
595 end loop;
596 end;
598 -- Send all multi-character switches not recognized as
599 -- a special case by gnatlink to the linker/loader stage.
601 else
602 Linker_Options.Increment_Last;
603 Linker_Options.Table (Linker_Options.Last) :=
604 new String'(Arg);
605 end if;
607 -- Here if argument is a file name rather than a switch
609 else
610 -- If explicit ali file, capture it
612 if Arg'Length > 4
613 and then Arg (Arg'Last - 3 .. Arg'Last) = ".ali"
614 then
615 if Ali_File_Name = null then
616 Ali_File_Name := new String'(Arg);
617 else
618 Exit_With_Error ("cannot handle more than one ALI file");
619 end if;
621 -- If target object file, record object file
623 elsif Arg'Length > Get_Target_Object_Suffix.all'Length
624 and then Arg
625 (Arg'Last -
626 Get_Target_Object_Suffix.all'Length + 1 .. Arg'Last)
627 = Get_Target_Object_Suffix.all
628 then
629 Linker_Objects.Increment_Last;
630 Linker_Objects.Table (Linker_Objects.Last) :=
631 new String'(Arg);
633 -- If host object file, record object file
635 elsif Arg'Length > Get_Object_Suffix.all'Length
636 and then Arg
637 (Arg'Last - Get_Object_Suffix.all'Length + 1 .. Arg'Last)
638 = Get_Object_Suffix.all
639 then
640 Linker_Objects.Increment_Last;
641 Linker_Objects.Table (Linker_Objects.Last) :=
642 new String'(Arg);
644 -- If corresponding ali file exists, capture it
646 elsif Ali_File_Name = null
647 and then Is_Regular_File (Arg & ".ali")
648 then
649 Ali_File_Name := new String'(Arg & ".ali");
651 -- Otherwise assume this is a linker options entry, but
652 -- see below for interesting adjustment to this assumption.
654 else
655 Linker_Options.Increment_Last;
656 Linker_Options.Table (Linker_Options.Last) :=
657 new String'(Arg);
658 end if;
659 end if;
660 end Process_One_Arg;
662 Next_Arg := Next_Arg + 1;
663 end loop;
665 -- Compile the bind file with warnings suppressed, because
666 -- otherwise the with of the main program may cause junk warnings.
668 Binder_Options.Increment_Last;
669 Binder_Options.Table (Binder_Options.Last) := new String'("-gnatws");
671 -- If we did not get an ali file at all, and we had at least one
672 -- linker option, then assume that was the intended ali file after
673 -- all, so that we get a nicer message later on.
675 if Ali_File_Name = null
676 and then Linker_Options.Last >= Linker_Options.First
677 then
678 Ali_File_Name :=
679 new String'(Linker_Options.Table (Linker_Options.First).all
680 & ".ali");
681 end if;
682 end Process_Args;
684 -------------------------
685 -- Process_Binder_File --
686 -------------------------
688 procedure Process_Binder_File (Name : String) is
689 Fd : FILEs;
690 -- Binder file's descriptor
692 Link_Bytes : Integer := 0;
693 -- Projected number of bytes for the linker command line
695 Link_Max : Integer;
696 pragma Import (C, Link_Max, "__gnat_link_max");
697 -- Maximum number of bytes on the command line supported by the OS
698 -- linker. Passed this limit the response file mechanism must be used
699 -- if supported.
701 Next_Line : String (1 .. 1000);
702 -- Current line value
704 Nlast : Integer;
705 Nfirst : Integer;
706 -- Current line slice (the slice does not contain line terminator)
708 Last : Integer;
709 -- Current line last character for shared libraries (without version)
711 Objs_Begin : Integer := 0;
712 -- First object file index in Linker_Objects table
714 Objs_End : Integer := 0;
715 -- Last object file index in Linker_Objects table
717 Status : int;
718 pragma Warnings (Off, Status);
719 -- Used for various Interfaces.C_Streams calls
721 Closing_Status : Boolean;
722 pragma Warnings (Off, Closing_Status);
723 -- For call to Close
725 GNAT_Static : Boolean := False;
726 -- Save state of -static option
728 GNAT_Shared : Boolean := False;
729 -- Save state of -shared option
731 Xlinker_Was_Previous : Boolean := False;
732 -- Indicate that "-Xlinker" was the option preceding the current option.
733 -- If True, then the current option is never suppressed.
735 -- Rollback data
737 -- These data items are used to store current binder file context. The
738 -- context is composed of the file descriptor position and the current
739 -- line together with the slice indexes (first and last position) for
740 -- this line. The rollback data are used by the Store_File_Context and
741 -- Rollback_File_Context routines below. The file context mechanism
742 -- interact only with the Get_Next_Line call. For example:
744 -- Store_File_Context;
745 -- Get_Next_Line;
746 -- Rollback_File_Context;
747 -- Get_Next_Line;
749 -- Both Get_Next_Line calls above will read the exact same data from
750 -- the file. In other words, Next_Line, Nfirst and Nlast variables
751 -- will be set with the exact same values.
753 RB_File_Pos : long; -- File position
754 RB_Next_Line : String (1 .. 1000); -- Current line content
755 RB_Nlast : Integer; -- Slice last index
756 RB_Nfirst : Integer; -- Slice first index
758 Run_Path_Option_Ptr : Interfaces.C.Strings.chars_ptr;
759 pragma Import (C, Run_Path_Option_Ptr, "__gnat_run_path_option");
760 -- Pointer to string representing the native linker option which
761 -- specifies the path where the dynamic loader should find shared
762 -- libraries. Equal to null string if this system doesn't support it.
764 Libgcc_Subdir_Ptr : Interfaces.C.Strings.chars_ptr;
765 pragma Import (C, Libgcc_Subdir_Ptr, "__gnat_default_libgcc_subdir");
766 -- Pointer to string indicating the installation subdirectory where
767 -- a default shared libgcc might be found.
769 Object_Library_Ext_Ptr : Interfaces.C.Strings.chars_ptr;
770 pragma Import
771 (C, Object_Library_Ext_Ptr, "__gnat_object_library_extension");
772 -- Pointer to string specifying the default extension for
773 -- object libraries, e.g. Unix uses ".a".
775 Separate_Run_Path_Options : Boolean;
776 for Separate_Run_Path_Options'Size use Character'Size;
777 pragma Import
778 (C, Separate_Run_Path_Options, "__gnat_separate_run_path_options");
779 -- Whether separate rpath options should be emitted for each directory
781 procedure Get_Next_Line;
782 -- Read the next line from the binder file without the line
783 -- terminator.
785 function Index (S, Pattern : String) return Natural;
786 -- Return the last occurrence of Pattern in S, or 0 if none
788 procedure Store_File_Context;
789 -- Store current file context, Fd position and current line data.
790 -- The file context is stored into the rollback data above (RB_*).
791 -- Store_File_Context can be called at any time, only the last call
792 -- will be used (i.e. this routine overwrites the file context).
794 procedure Rollback_File_Context;
795 -- Restore file context from rollback data. This routine must be called
796 -- after Store_File_Context. The binder file context will be restored
797 -- with the data stored by the last Store_File_Context call.
799 procedure Write_RF (S : String);
800 -- Write a string to the response file and check if it was successful.
801 -- Fail the program if it was not successful (disk full).
803 -------------------
804 -- Get_Next_Line --
805 -------------------
807 procedure Get_Next_Line is
808 Fchars : chars;
810 begin
811 Fchars := fgets (Next_Line'Address, Next_Line'Length, Fd);
813 if Fchars = System.Null_Address then
814 Exit_With_Error ("Error reading binder output");
815 end if;
817 Nfirst := Next_Line'First;
818 Nlast := Nfirst;
819 while Nlast <= Next_Line'Last
820 and then Next_Line (Nlast) /= ASCII.LF
821 and then Next_Line (Nlast) /= ASCII.CR
822 loop
823 Nlast := Nlast + 1;
824 end loop;
826 Nlast := Nlast - 1;
827 end Get_Next_Line;
829 -----------
830 -- Index --
831 -----------
833 function Index (S, Pattern : String) return Natural is
834 Len : constant Natural := Pattern'Length;
836 begin
837 for J in reverse S'First .. S'Last - Len + 1 loop
838 if Pattern = S (J .. J + Len - 1) then
839 return J;
840 end if;
841 end loop;
843 return 0;
844 end Index;
846 ---------------------------
847 -- Rollback_File_Context --
848 ---------------------------
850 procedure Rollback_File_Context is
851 begin
852 Next_Line := RB_Next_Line;
853 Nfirst := RB_Nfirst;
854 Nlast := RB_Nlast;
855 Status := fseek (Fd, RB_File_Pos, Interfaces.C_Streams.SEEK_SET);
857 if Status = -1 then
858 Exit_With_Error ("Error setting file position");
859 end if;
860 end Rollback_File_Context;
862 ------------------------
863 -- Store_File_Context --
864 ------------------------
866 procedure Store_File_Context is
867 use type System.CRTL.long;
869 begin
870 RB_Next_Line := Next_Line;
871 RB_Nfirst := Nfirst;
872 RB_Nlast := Nlast;
873 RB_File_Pos := ftell (Fd);
875 if RB_File_Pos = -1 then
876 Exit_With_Error ("Error getting file position");
877 end if;
878 end Store_File_Context;
880 --------------
881 -- Write_RF --
882 --------------
884 procedure Write_RF (S : String) is
885 Success : Boolean := True;
886 Back_Slash : constant Character := '\';
888 begin
889 -- If a GNU response file is used, space and backslash need to be
890 -- escaped because they are interpreted as a string separator and
891 -- an escape character respectively by the underlying mechanism.
892 -- On the other hand, quote and double-quote are not escaped since
893 -- they are interpreted as string delimiters on both sides.
895 if Using_GNU_response_file then
896 for J in S'Range loop
897 if S (J) = ' ' or else S (J) = '\' then
898 if Write (Tname_FD, Back_Slash'Address, 1) /= 1 then
899 Success := False;
900 end if;
901 end if;
903 if Write (Tname_FD, S (J)'Address, 1) /= 1 then
904 Success := False;
905 end if;
906 end loop;
908 else
909 if Write (Tname_FD, S'Address, S'Length) /= S'Length then
910 Success := False;
911 end if;
912 end if;
914 if Write (Tname_FD, ASCII.LF'Address, 1) /= 1 then
915 Success := False;
916 end if;
918 if not Success then
919 Exit_With_Error ("Error generating response file: disk full");
920 end if;
921 end Write_RF;
923 -- Start of processing for Process_Binder_File
925 begin
926 Fd := fopen (Name'Address, Read_Mode'Address);
928 if Fd = NULL_Stream then
929 Exit_With_Error ("Failed to open binder output");
930 end if;
932 -- Skip up to the Begin Info line
934 loop
935 Get_Next_Line;
936 exit when Next_Line (Nfirst .. Nlast) = Begin_Info;
937 end loop;
939 loop
940 Get_Next_Line;
942 -- Go to end when end line is reached (this will happen in
943 -- High_Integrity_Mode where no -L switches are generated)
945 exit when Next_Line (Nfirst .. Nlast) = End_Info;
947 Next_Line (Nfirst .. Nlast - 8) := Next_Line (Nfirst + 8 .. Nlast);
948 Nlast := Nlast - 8;
950 -- Go to next section when switches are reached
952 exit when Next_Line (1) = '-';
954 -- Otherwise we have another object file to collect
956 Linker_Objects.Increment_Last;
958 -- Mark the positions of first and last object files in case they
959 -- need to be placed with a named file on systems having linker
960 -- line limitations.
962 if Objs_Begin = 0 then
963 Objs_Begin := Linker_Objects.Last;
964 end if;
966 Linker_Objects.Table (Linker_Objects.Last) :=
967 new String'(Next_Line (Nfirst .. Nlast));
969 -- Nlast - Nfirst + 1, for the size, plus one for the space between
970 -- each arguments.
972 Link_Bytes := Link_Bytes + Nlast - Nfirst + 2;
973 end loop;
975 Objs_End := Linker_Objects.Last;
977 -- Continue to compute the Link_Bytes, the linker options are part of
978 -- command line length.
980 Store_File_Context;
982 while Next_Line (Nfirst .. Nlast) /= End_Info loop
983 Link_Bytes := Link_Bytes + Nlast - Nfirst + 2;
984 Get_Next_Line;
985 end loop;
987 Rollback_File_Context;
989 -- On systems that have limitations on handling very long linker lines
990 -- we make use of the system linker option which takes a list of object
991 -- file names from a file instead of the command line itself. What we do
992 -- is to replace the list of object files by the special linker option
993 -- which then reads the object file list from a file instead. The option
994 -- to read from a file instead of the command line is only triggered if
995 -- a conservative threshold is passed.
997 if Object_List_File_Required
998 or else (Object_List_File_Supported
999 and then Link_Bytes > Link_Max)
1000 then
1001 -- Create a temporary file containing the Ada user object files
1002 -- needed by the link. This list is taken from the bind file and is
1003 -- output one object per line for maximal compatibility with linkers
1004 -- supporting this option.
1006 Create_Temp_File (Tname_FD, Tname);
1008 -- ??? File descriptor should be checked to not be Invalid_FD.
1009 -- ??? Status of Write and Close operations should be checked, and
1010 -- failure should occur if a status is wrong.
1012 for J in Objs_Begin .. Objs_End loop
1013 Write_RF (Linker_Objects.Table (J).all);
1015 Response_File_Objects.Increment_Last;
1016 Response_File_Objects.Table (Response_File_Objects.Last) :=
1017 Linker_Objects.Table (J);
1018 end loop;
1020 Close (Tname_FD, Closing_Status);
1022 -- Add the special objects list file option together with the name
1023 -- of the temporary file (removing the null character) to the objects
1024 -- file table.
1026 Linker_Objects.Table (Objs_Begin) :=
1027 new String'(Object_File_Option &
1028 Tname (Tname'First .. Tname'Last - 1));
1030 -- The slots containing these object file names are then removed
1031 -- from the objects table so they do not appear in the link. They are
1032 -- removed by moving up the linker options and non-Ada object files
1033 -- appearing after the Ada object list in the table.
1035 declare
1036 N : Integer;
1038 begin
1039 N := Objs_End - Objs_Begin + 1;
1041 for J in Objs_End + 1 .. Linker_Objects.Last loop
1042 Linker_Objects.Table (J - N + 1) := Linker_Objects.Table (J);
1043 end loop;
1045 Linker_Objects.Set_Last (Linker_Objects.Last - N + 1);
1046 end;
1047 end if;
1049 -- Process switches and options
1051 if Next_Line (Nfirst .. Nlast) /= End_Info then
1052 Xlinker_Was_Previous := False;
1054 loop
1055 if Xlinker_Was_Previous
1056 or else Next_Line (Nfirst .. Nlast) = "-Xlinker"
1057 then
1058 Linker_Options.Increment_Last;
1059 Linker_Options.Table (Linker_Options.Last) :=
1060 new String'(Next_Line (Nfirst .. Nlast));
1062 elsif Next_Line (Nfirst .. Nlast) = "-static" then
1063 GNAT_Static := True;
1065 elsif Next_Line (Nfirst .. Nlast) = "-shared" then
1066 GNAT_Shared := True;
1068 -- Add binder options only if not already set on the command line.
1069 -- This rule is a way to control the linker options order.
1071 else
1072 if Nlast > Nfirst + 2 and then
1073 Next_Line (Nfirst .. Nfirst + 1) = "-L"
1074 then
1075 -- Construct a library search path for use later to locate
1076 -- static gnatlib libraries.
1078 if Libpath.Last > 1 then
1079 Libpath.Increment_Last;
1080 Libpath.Table (Libpath.Last) := Path_Separator;
1081 end if;
1083 for I in Nfirst + 2 .. Nlast loop
1084 Libpath.Increment_Last;
1085 Libpath.Table (Libpath.Last) := Next_Line (I);
1086 end loop;
1088 Linker_Options.Increment_Last;
1090 Linker_Options.Table (Linker_Options.Last) :=
1091 new String'(Next_Line (Nfirst .. Nlast));
1093 elsif Next_Line (Nfirst .. Nlast) = "-lgnarl"
1094 or else Next_Line (Nfirst .. Nlast) = "-lgnat"
1095 or else
1096 Next_Line
1097 (1 .. Natural'Min (Nlast, 8 + Library_Version'Length)) =
1098 Shared_Lib ("gnarl")
1099 or else
1100 Next_Line
1101 (1 .. Natural'Min (Nlast, 7 + Library_Version'Length)) =
1102 Shared_Lib ("gnat")
1103 then
1104 -- If it is a shared library, remove the library version.
1105 -- We will be looking for the static version of the library
1106 -- as it is in the same directory as the shared version.
1108 if Next_Line (Nlast - Library_Version'Length + 1 .. Nlast) =
1109 Library_Version
1110 then
1111 -- Set Last to point to last character before the
1112 -- library version.
1114 Last := Nlast - Library_Version'Length - 1;
1115 else
1116 Last := Nlast;
1117 end if;
1119 -- Given a Gnat standard library, search the library path to
1120 -- find the library location.
1122 -- Shouldn't we abstract a proc here, we are getting awfully
1123 -- heavily nested ???
1125 declare
1126 File_Path : String_Access;
1128 Object_Lib_Extension : constant String :=
1129 Value (Object_Library_Ext_Ptr);
1131 File_Name : constant String := "lib" &
1132 Next_Line (Nfirst + 2 .. Last) & Object_Lib_Extension;
1134 Run_Path_Opt : constant String :=
1135 Value (Run_Path_Option_Ptr);
1137 GCC_Index : Natural;
1138 Run_Path_Opt_Index : Natural := 0;
1140 begin
1141 File_Path :=
1142 Locate_Regular_File (File_Name,
1143 String (Libpath.Table (1 .. Libpath.Last)));
1145 if File_Path /= null then
1146 if GNAT_Static then
1148 -- If static gnatlib found, explicitly specify to
1149 -- overcome possible linker default usage of shared
1150 -- version.
1152 Linker_Options.Increment_Last;
1154 Linker_Options.Table (Linker_Options.Last) :=
1155 new String'(File_Path.all);
1157 elsif GNAT_Shared then
1158 if Opt.Run_Path_Option then
1160 -- If shared gnatlib desired, add appropriate
1161 -- system specific switch so that it can be
1162 -- located at runtime.
1164 if Run_Path_Opt'Length /= 0 then
1166 -- Output the system specific linker command
1167 -- that allows the image activator to find
1168 -- the shared library at runtime. Also add
1169 -- path to find libgcc_s.so, if relevant.
1171 declare
1172 Path : String (1 .. File_Path'Length + 15);
1174 Path_Last : constant Natural :=
1175 File_Path'Length;
1177 begin
1178 Path (1 .. File_Path'Length) :=
1179 File_Path.all;
1181 -- To find the location of the shared version
1182 -- of libgcc, we look for "gcc-lib" in the
1183 -- path of the library. However, this
1184 -- subdirectory is no longer present in
1185 -- recent versions of GCC. So, we look for
1186 -- the last subdirectory "lib" in the path.
1188 GCC_Index :=
1189 Index (Path (1 .. Path_Last), "gcc-lib");
1191 if GCC_Index /= 0 then
1193 -- The shared version of libgcc is
1194 -- located in the parent directory.
1196 GCC_Index := GCC_Index - 1;
1198 else
1199 GCC_Index :=
1200 Index
1201 (Path (1 .. Path_Last),
1202 "/lib/");
1204 if GCC_Index = 0 then
1205 GCC_Index :=
1206 Index (Path (1 .. Path_Last),
1207 Directory_Separator & "lib"
1208 & Directory_Separator);
1209 end if;
1211 -- If we have found a "lib" subdir in
1212 -- the path to libgnat, the possible
1213 -- shared libgcc of interest by default
1214 -- is in libgcc_subdir at the same
1215 -- level.
1217 if GCC_Index /= 0 then
1218 declare
1219 Subdir : constant String :=
1220 Value (Libgcc_Subdir_Ptr);
1221 begin
1222 Path
1223 (GCC_Index + 1 ..
1224 GCC_Index + Subdir'Length) :=
1225 Subdir;
1226 GCC_Index :=
1227 GCC_Index + Subdir'Length;
1228 end;
1229 end if;
1230 end if;
1232 -- Look for an eventual run_path_option in
1233 -- the linker switches.
1235 if Separate_Run_Path_Options then
1236 Linker_Options.Increment_Last;
1237 Linker_Options.Table
1238 (Linker_Options.Last) :=
1239 new String'
1240 (Run_Path_Opt
1241 & File_Path
1242 (1 .. File_Path'Length
1243 - File_Name'Length));
1245 if GCC_Index /= 0 then
1246 Linker_Options.Increment_Last;
1247 Linker_Options.Table
1248 (Linker_Options.Last) :=
1249 new String'
1250 (Run_Path_Opt
1251 & Path (1 .. GCC_Index));
1252 end if;
1254 else
1255 for J in reverse
1256 1 .. Linker_Options.Last
1257 loop
1258 if Linker_Options.Table (J) /= null
1259 and then
1260 Linker_Options.Table (J)'Length
1261 > Run_Path_Opt'Length
1262 and then
1263 Linker_Options.Table (J)
1264 (1 .. Run_Path_Opt'Length) =
1265 Run_Path_Opt
1266 then
1267 -- We have found an already
1268 -- specified run_path_option:
1269 -- we will add to this
1270 -- switch, because only one
1271 -- run_path_option should be
1272 -- specified.
1274 Run_Path_Opt_Index := J;
1275 exit;
1276 end if;
1277 end loop;
1279 -- If there is no run_path_option, we
1280 -- need to add one.
1282 if Run_Path_Opt_Index = 0 then
1283 Linker_Options.Increment_Last;
1284 end if;
1286 if GCC_Index = 0 then
1287 if Run_Path_Opt_Index = 0 then
1288 Linker_Options.Table
1289 (Linker_Options.Last) :=
1290 new String'
1291 (Run_Path_Opt
1292 & File_Path
1293 (1 .. File_Path'Length
1294 - File_Name'Length));
1296 else
1297 Linker_Options.Table
1298 (Run_Path_Opt_Index) :=
1299 new String'
1300 (Linker_Options.Table
1301 (Run_Path_Opt_Index).all
1302 & Path_Separator
1303 & File_Path
1304 (1 .. File_Path'Length
1305 - File_Name'Length));
1306 end if;
1308 else
1309 if Run_Path_Opt_Index = 0 then
1310 Linker_Options.Table
1311 (Linker_Options.Last) :=
1312 new String'
1313 (Run_Path_Opt
1314 & File_Path
1315 (1 .. File_Path'Length
1316 - File_Name'Length)
1317 & Path_Separator
1318 & Path (1 .. GCC_Index));
1320 else
1321 Linker_Options.Table
1322 (Run_Path_Opt_Index) :=
1323 new String'
1324 (Linker_Options.Table
1325 (Run_Path_Opt_Index).all
1326 & Path_Separator
1327 & File_Path
1328 (1 .. File_Path'Length
1329 - File_Name'Length)
1330 & Path_Separator
1331 & Path (1 .. GCC_Index));
1332 end if;
1333 end if;
1334 end if;
1335 end;
1336 end if;
1337 end if;
1339 -- Then we add the appropriate -l switch
1341 Linker_Options.Increment_Last;
1342 Linker_Options.Table (Linker_Options.Last) :=
1343 new String'(Next_Line (Nfirst .. Nlast));
1344 end if;
1346 else
1347 -- If gnatlib library not found, then add it anyway in
1348 -- case some other mechanism may find it.
1350 Linker_Options.Increment_Last;
1351 Linker_Options.Table (Linker_Options.Last) :=
1352 new String'(Next_Line (Nfirst .. Nlast));
1353 end if;
1354 end;
1355 else
1356 Linker_Options.Increment_Last;
1357 Linker_Options.Table (Linker_Options.Last) :=
1358 new String'(Next_Line (Nfirst .. Nlast));
1359 end if;
1360 end if;
1362 Xlinker_Was_Previous := Next_Line (Nfirst .. Nlast) = "-Xlinker";
1364 Get_Next_Line;
1365 exit when Next_Line (Nfirst .. Nlast) = End_Info;
1367 Next_Line (Nfirst .. Nlast - 8) := Next_Line (Nfirst + 8 .. Nlast);
1368 Nlast := Nlast - 8;
1369 end loop;
1370 end if;
1372 -- If -shared was specified, invoke gcc with -shared-libgcc
1374 if GNAT_Shared then
1375 Linker_Options.Increment_Last;
1376 Linker_Options.Table (Linker_Options.Last) := Shared_Libgcc;
1377 end if;
1379 Status := fclose (Fd);
1380 end Process_Binder_File;
1382 -----------
1383 -- Usage --
1384 -----------
1386 procedure Usage is
1387 begin
1388 Write_Str ("Usage: ");
1389 Write_Str (Base_Command_Name.all);
1390 Write_Str (" switches mainprog.ali [non-Ada-objects] [linker-options]");
1391 Write_Eol;
1392 Write_Eol;
1393 Write_Line (" mainprog.ali the ALI file of the main program");
1394 Write_Eol;
1395 Write_Eol;
1396 Display_Usage_Version_And_Help;
1397 Write_Line (" -f Force object file list to be generated");
1398 Write_Line (" -g Compile binder source file with debug information");
1399 Write_Line (" -n Do not compile the binder source file");
1400 Write_Line (" -P Process files for use by CodePeer");
1401 Write_Line (" -R Do not use a run_path_option");
1402 Write_Line (" -v Verbose mode");
1403 Write_Line (" -v -v Very verbose mode");
1404 Write_Eol;
1405 Write_Line (" -o nam Use 'nam' as the name of the executable");
1406 Write_Line (" -b target Compile the binder source to run on target");
1407 Write_Line (" -Bdir Load compiler executables from dir");
1409 if Is_Supported (Map_File) then
1410 Write_Line (" -Mmap Create map file map");
1411 Write_Line (" -M Create map file mainprog.map");
1412 end if;
1414 Write_Line (" --GCC=comp Use comp as the compiler");
1415 Write_Line (" --LINK=nam Use 'nam' for the linking rather than 'gcc'");
1416 Write_Eol;
1417 Write_Line (" [non-Ada-objects] list of non Ada object files");
1418 Write_Line (" [linker-options] other options for the linker");
1419 end Usage;
1421 ------------------
1422 -- Write_Header --
1423 ------------------
1425 procedure Write_Header is
1426 begin
1427 if Verbose_Mode then
1428 Write_Eol;
1429 Display_Version ("GNATLINK", "1995");
1430 end if;
1431 end Write_Header;
1433 -----------------
1434 -- Write_Usage --
1435 -----------------
1437 procedure Write_Usage is
1438 begin
1439 Write_Header;
1440 Usage;
1441 end Write_Usage;
1443 -- Start of processing for Gnatlink
1445 begin
1446 -- Add the directory where gnatlink is invoked in front of the path, if
1447 -- gnatlink is invoked with directory information.
1449 declare
1450 Command : constant String := Command_Name;
1451 begin
1452 for Index in reverse Command'Range loop
1453 if Command (Index) = Directory_Separator then
1454 declare
1455 Absolute_Dir : constant String :=
1456 Normalize_Pathname
1457 (Command (Command'First .. Index));
1459 PATH : constant String :=
1460 Absolute_Dir &
1461 Path_Separator &
1462 Getenv ("PATH").all;
1464 begin
1465 Setenv ("PATH", PATH);
1466 end;
1468 exit;
1469 end if;
1470 end loop;
1471 end;
1473 Base_Command_Name := new String'(Base_Name (Command_Name));
1474 Process_Args;
1476 if Argument_Count = 0
1477 or else (Verbose_Mode and then Argument_Count = 1)
1478 then
1479 Write_Usage;
1480 Exit_Program (E_Fatal);
1481 end if;
1483 -- Initialize packages to be used
1485 Csets.Initialize;
1486 Snames.Initialize;
1488 -- We always compile with -c
1490 Binder_Options_From_ALI.Increment_Last;
1491 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1492 new String'("-c");
1494 if Ali_File_Name = null then
1495 Exit_With_Error ("no ali file given for link");
1496 end if;
1498 if not Is_Regular_File (Ali_File_Name.all) then
1499 Exit_With_Error (Ali_File_Name.all & " not found");
1500 end if;
1502 -- Read the ALI file of the main subprogram if the binder generated file
1503 -- needs to be compiled and no --GCC= switch has been specified. Fetch the
1504 -- back end switches from this ALI file and use these switches to compile
1505 -- the binder generated file
1507 if Compile_Bind_File and then Standard_Gcc then
1508 Initialize_ALI;
1509 Name_Len := Ali_File_Name'Length;
1510 Name_Buffer (1 .. Name_Len) := Ali_File_Name.all;
1512 declare
1513 use Types;
1514 F : constant File_Name_Type := Name_Find;
1515 T : Text_Buffer_Ptr;
1516 A : ALI_Id;
1518 begin
1519 -- Load the ALI file
1521 T := Read_Library_Info (F, True);
1523 -- Read it. Note that we ignore errors, since we only want very
1524 -- limited information from the ali file, and likely a slightly
1525 -- wrong version will be just fine, though in normal operation
1526 -- we don't expect this to happen.
1528 A := Scan_ALI
1531 Ignore_ED => False,
1532 Err => False,
1533 Ignore_Errors => True);
1535 if A /= No_ALI_Id then
1537 Index in Units.Table (ALIs.Table (A).First_Unit).First_Arg ..
1538 Units.Table (ALIs.Table (A).First_Unit).Last_Arg
1539 loop
1540 -- Do not compile with the front end switches. However, --RTS
1541 -- is to be dealt with specially because it needs to be passed
1542 -- if the binder-generated file is in Ada and may also be used
1543 -- to drive the linker.
1545 declare
1546 Arg : String_Ptr renames Args.Table (Index);
1547 begin
1548 if not Is_Front_End_Switch (Arg.all) then
1549 Binder_Options_From_ALI.Increment_Last;
1550 Binder_Options_From_ALI.Table
1551 (Binder_Options_From_ALI.Last) := String_Access (Arg);
1553 elsif Arg'Length > 5
1554 and then Arg (Arg'First + 2 .. Arg'First + 5) = "RTS="
1555 then
1556 Binder_Options_From_ALI.Increment_Last;
1557 Binder_Options_From_ALI.Table
1558 (Binder_Options_From_ALI.Last) := String_Access (Arg);
1560 -- Set the RTS_*_Path_Name variables, so that
1561 -- the correct directories will be set when
1562 -- Osint.Add_Default_Search_Dirs will be called later.
1564 Opt.RTS_Src_Path_Name :=
1565 Get_RTS_Search_Dir
1566 (Arg (Arg'First + 6 .. Arg'Last), Include);
1568 Opt.RTS_Lib_Path_Name :=
1569 Get_RTS_Search_Dir
1570 (Arg (Arg'First + 6 .. Arg'Last), Objects);
1572 -- GNAT doesn't support the GCC multilib mechanism.
1573 -- This means that, when a multilib switch is used
1574 -- to request a particular compilation mode, the
1575 -- corresponding runtime switch (--RTS) must also be
1576 -- specified. The long-term goal is to fully support the
1577 -- multilib mechanism; however, in the meantime, it is
1578 -- convenient to eliminate the redundancy by keying the
1579 -- compilation mode on a single switch, namely --RTS.
1581 -- Pass -mrtp to the linker if --RTS=rtp was passed
1583 if Arg'Length > 8
1584 and then
1585 (Arg (Arg'First + 6 .. Arg'First + 8) = "rtp"
1586 or else Arg (Arg'Last - 2 .. Arg'Last) = "rtp")
1587 then
1588 Linker_Options.Increment_Last;
1589 Linker_Options.Table (Linker_Options.Last) :=
1590 new String'("-mrtp");
1591 end if;
1592 end if;
1593 end;
1594 end loop;
1595 end if;
1596 end;
1597 end if;
1599 -- Get target parameters
1601 Osint.Add_Default_Search_Dirs;
1602 Targparm.Get_Target_Parameters;
1604 case VM_Target is
1605 when JVM_Target => Gcc := new String'("jvm-gnatcompile");
1606 when CLI_Target => Gcc := new String'("dotnet-gnatcompile");
1607 when No_VM => null;
1608 end case;
1610 -- Compile the bind file with the following switches:
1612 -- -gnatA stops reading gnat.adc, since we don't know what
1613 -- pragmas would work, and we do not need it anyway.
1615 -- -gnatWb allows brackets coding for wide characters
1617 -- -gnatiw allows wide characters in identifiers. This is needed
1618 -- because bindgen uses brackets encoding for all upper
1619 -- half and wide characters in identifier names.
1621 -- In addition, in CodePeer mode compile with -x adascil -gnatcC
1623 Binder_Options_From_ALI.Increment_Last;
1624 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1625 new String'("-gnatA");
1626 Binder_Options_From_ALI.Increment_Last;
1627 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1628 new String'("-gnatWb");
1629 Binder_Options_From_ALI.Increment_Last;
1630 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1631 new String'("-gnatiw");
1633 if Opt.CodePeer_Mode then
1634 Binder_Options_From_ALI.Increment_Last;
1635 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1636 new String'("-x");
1637 Binder_Options_From_ALI.Increment_Last;
1638 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1639 new String'("adascil");
1640 Binder_Options_From_ALI.Increment_Last;
1641 Binder_Options_From_ALI.Table (Binder_Options_From_ALI.Last) :=
1642 new String'("-gnatcC");
1643 end if;
1645 -- Locate all the necessary programs and verify required files are present
1647 Gcc_Path := System.OS_Lib.Locate_Exec_On_Path (Gcc.all);
1649 if Gcc_Path = null then
1650 Exit_With_Error ("Couldn't locate " & Gcc.all);
1651 end if;
1653 if Linker_Path = null then
1654 if VM_Target = CLI_Target then
1655 Linker_Path := System.OS_Lib.Locate_Exec_On_Path ("dotnet-ld");
1657 if Linker_Path = null then
1658 Exit_With_Error ("Couldn't locate dotnet-ld");
1659 end if;
1660 else
1661 Linker_Path := Gcc_Path;
1662 end if;
1663 end if;
1665 Write_Header;
1667 -- If no output name specified, then use the base name of .ali file name
1669 if Output_File_Name = null then
1670 Output_File_Name :=
1671 new String'(Base_Name (Ali_File_Name.all)
1672 & Get_Target_Debuggable_Suffix.all);
1673 end if;
1675 Linker_Options.Increment_Last;
1676 Linker_Options.Table (Linker_Options.Last) := new String'("-o");
1678 Linker_Options.Increment_Last;
1679 Linker_Options.Table (Linker_Options.Last) :=
1680 new String'(Output_File_Name.all);
1682 Check_Existing_Executable (Output_File_Name.all);
1684 -- Warn if main program is called "test", as that may be a built-in command
1685 -- on Unix. On non-Unix systems executables have a suffix, so the warning
1686 -- will not appear. However, do not warn in the case of a cross compiler.
1688 -- Assume this is a cross tool if the executable name is not gnatlink.
1689 -- Note that the executable name is also gnatlink on windows, but in that
1690 -- case the output file name will be test.exe rather than test.
1692 if Base_Command_Name.all = "gnatlink"
1693 and then Output_File_Name.all = "test"
1694 then
1695 Error_Msg ("warning: executable name """ & Output_File_Name.all
1696 & """ may conflict with shell command");
1697 end if;
1699 -- Special warnings for worrisome file names on windows
1701 -- Windows-7 will not allow an executable file whose name contains any
1702 -- of the substrings "install", "setup", or "update" to load without
1703 -- special administration privileges. This rather incredible behavior
1704 -- is Microsoft's idea of a useful security precaution.
1706 Bad_File_Names_On_Windows : declare
1707 FN : String := Output_File_Name.all;
1709 procedure Check_File_Name (S : String);
1710 -- Warn if file name has the substring S
1712 procedure Check_File_Name (S : String) is
1713 begin
1714 for J in 1 .. FN'Length - (S'Length - 1) loop
1715 if FN (J .. J + (S'Length - 1)) = S then
1716 Error_Msg
1717 ("warning: possible problem with executable name """
1718 & Output_File_Name.all & '"');
1719 Error_Msg
1720 ("file name contains substring """ & S & '"');
1721 Error_Msg
1722 ("admin privileges may be required on Windows 7 "
1723 & "to load this file");
1724 end if;
1725 end loop;
1726 end Check_File_Name;
1728 -- Start of processing for Bad_File_Names_On_Windows
1730 begin
1731 for J in FN'Range loop
1732 FN (J) := Csets.Fold_Lower (FN (J));
1733 end loop;
1735 -- For now we detect windows by an output executable name ending with
1736 -- the suffix .exe.
1738 if FN'Length > 5
1739 and then FN (FN'Last - 3 .. FN'Last) = ".exe"
1740 then
1741 Check_File_Name ("install");
1742 Check_File_Name ("setup");
1743 Check_File_Name ("update");
1744 end if;
1745 end Bad_File_Names_On_Windows;
1747 -- If -M switch was specified, add the switches to create the map file
1749 if Create_Map_File then
1750 declare
1751 Map_Name : constant String := Base_Name (Ali_File_Name.all) & ".map";
1752 Switches : String_List_Access;
1754 begin
1755 Convert (Map_File, Map_Name, Switches);
1757 if Switches /= null then
1758 for J in Switches'Range loop
1759 Linker_Options.Increment_Last;
1760 Linker_Options.Table (Linker_Options.Last) := Switches (J);
1761 end loop;
1762 end if;
1763 end;
1764 end if;
1766 -- Perform consistency checks
1768 -- Transform the .ali file name into the binder output file name
1770 Make_Binder_File_Names : declare
1771 Fname : constant String := Base_Name (Ali_File_Name.all);
1772 Fname_Len : Integer := Fname'Length;
1774 function Get_Maximum_File_Name_Length return Integer;
1775 pragma Import (C, Get_Maximum_File_Name_Length,
1776 "__gnat_get_maximum_file_name_length");
1778 Maximum_File_Name_Length : constant Integer :=
1779 Get_Maximum_File_Name_Length;
1781 Bind_File_Prefix : Types.String_Ptr;
1782 -- Contains prefix used for bind files
1784 begin
1785 -- Set prefix
1787 Bind_File_Prefix := new String'("b~");
1789 -- If the length of the binder file becomes too long due to
1790 -- the addition of the "b?" prefix, then truncate it.
1792 if Maximum_File_Name_Length > 0 then
1793 while Fname_Len >
1794 Maximum_File_Name_Length - Bind_File_Prefix.all'Length
1795 loop
1796 Fname_Len := Fname_Len - 1;
1797 end loop;
1798 end if;
1800 declare
1801 Fnam : constant String :=
1802 Bind_File_Prefix.all &
1803 Fname (Fname'First .. Fname'First + Fname_Len - 1);
1805 begin
1806 Binder_Spec_Src_File := new String'(Fnam & ".ads");
1807 Binder_Body_Src_File := new String'(Fnam & ".adb");
1808 Binder_Ali_File := new String'(Fnam & ".ali");
1810 Binder_Obj_File := new String'(Fnam & Get_Target_Object_Suffix.all);
1811 end;
1813 if Fname_Len /= Fname'Length then
1814 Binder_Options.Increment_Last;
1815 Binder_Options.Table (Binder_Options.Last) := new String'("-o");
1816 Binder_Options.Increment_Last;
1817 Binder_Options.Table (Binder_Options.Last) := Binder_Obj_File;
1818 end if;
1819 end Make_Binder_File_Names;
1821 Process_Binder_File (Binder_Body_Src_File.all & ASCII.NUL);
1823 -- Compile the binder file. This is fast, so we always do it, unless
1824 -- specifically told not to by the -n switch
1826 if Compile_Bind_File then
1827 Bind_Step : declare
1828 Success : Boolean;
1830 Args : Argument_List
1831 (1 .. Binder_Options_From_ALI.Last + Binder_Options.Last + 1);
1833 begin
1834 for J in 1 .. Binder_Options_From_ALI.Last loop
1835 Args (J) := Binder_Options_From_ALI.Table (J);
1836 end loop;
1838 for J in 1 .. Binder_Options.Last loop
1839 Args (Binder_Options_From_ALI.Last + J) :=
1840 Binder_Options.Table (J);
1841 end loop;
1843 -- Use the full path of the binder generated source, so that it is
1844 -- guaranteed that the debugger will find this source, even with
1845 -- STABS.
1847 Args (Args'Last) :=
1848 new String'(Normalize_Pathname (Binder_Body_Src_File.all));
1850 if Verbose_Mode then
1851 Write_Str (Base_Name (Gcc_Path.all));
1853 for J in Args'Range loop
1854 Write_Str (" ");
1855 Write_Str (Args (J).all);
1856 end loop;
1858 Write_Eol;
1859 end if;
1861 System.OS_Lib.Spawn (Gcc_Path.all, Args, Success);
1863 if not Success then
1864 Exit_Program (E_Fatal);
1865 end if;
1866 end Bind_Step;
1867 end if;
1869 -- In CodePeer mode, there's nothing left to do after the binder file has
1870 -- been compiled.
1872 if Opt.CodePeer_Mode then
1873 return;
1874 end if;
1876 -- Now, actually link the program
1878 -- Skip this step for now on JVM since the Java interpreter will do
1879 -- the actual link at run time. We might consider packing all class files
1880 -- in a .zip file during this step.
1882 Link_Step : declare
1883 Num_Args : Natural :=
1884 (Linker_Options.Last - Linker_Options.First + 1) +
1885 (Gcc_Linker_Options.Last - Gcc_Linker_Options.First + 1) +
1886 (Linker_Objects.Last - Linker_Objects.First + 1);
1887 Stack_Op : Boolean := False;
1889 begin
1890 if AAMP_On_Target then
1892 -- Remove extraneous flags not relevant for AAMP
1894 for J in reverse Linker_Options.First .. Linker_Options.Last loop
1895 if Linker_Options.Table (J)'Length = 0
1896 or else Linker_Options.Table (J) (1 .. 3) = "-Wl"
1897 or else Linker_Options.Table (J) (1 .. 3) = "-sh"
1898 or else Linker_Options.Table (J) (1 .. 2) = "-O"
1899 or else Linker_Options.Table (J) (1 .. 2) = "-g"
1900 then
1901 Linker_Options.Table (J .. Linker_Options.Last - 1) :=
1902 Linker_Options.Table (J + 1 .. Linker_Options.Last);
1903 Linker_Options.Decrement_Last;
1904 Num_Args := Num_Args - 1;
1905 end if;
1906 end loop;
1907 end if;
1909 -- Remove duplicate stack size setting from the Linker_Options table.
1910 -- The stack setting option "-Xlinker --stack=R,C" can be found
1911 -- in one line when set by a pragma Linker_Options or in two lines
1912 -- ("-Xlinker" then "--stack=R,C") when set on the command line. We
1913 -- also check for the "-Wl,--stack=R" style option.
1915 -- We must remove the second stack setting option instance because
1916 -- the one on the command line will always be the first one. And any
1917 -- subsequent stack setting option will overwrite the previous one.
1918 -- This is done especially for GNAT/NT where we set the stack size
1919 -- for tasking programs by a pragma in the NT specific tasking
1920 -- package System.Task_Primitives.Operations.
1922 -- Note: This is not a FOR loop that runs from Linker_Options.First
1923 -- to Linker_Options.Last, since operations within the loop can
1924 -- modify the length of the table.
1926 Clean_Link_Option_Set : declare
1927 J : Natural;
1928 Shared_Libgcc_Seen : Boolean := False;
1930 begin
1931 J := Linker_Options.First;
1932 while J <= Linker_Options.Last loop
1933 if Linker_Options.Table (J).all = "-Xlinker"
1934 and then J < Linker_Options.Last
1935 and then Linker_Options.Table (J + 1)'Length > 8
1936 and then Linker_Options.Table (J + 1) (1 .. 8) = "--stack="
1937 then
1938 if Stack_Op then
1939 Linker_Options.Table (J .. Linker_Options.Last - 2) :=
1940 Linker_Options.Table (J + 2 .. Linker_Options.Last);
1941 Linker_Options.Decrement_Last;
1942 Linker_Options.Decrement_Last;
1943 Num_Args := Num_Args - 2;
1945 else
1946 Stack_Op := True;
1947 end if;
1948 end if;
1950 -- Remove duplicate -shared-libgcc switch
1952 if Linker_Options.Table (J).all = Shared_Libgcc_String then
1953 if Shared_Libgcc_Seen then
1954 Linker_Options.Table (J .. Linker_Options.Last - 1) :=
1955 Linker_Options.Table (J + 1 .. Linker_Options.Last);
1956 Linker_Options.Decrement_Last;
1957 Num_Args := Num_Args - 1;
1959 else
1960 Shared_Libgcc_Seen := True;
1961 end if;
1962 end if;
1964 -- Here we just check for a canonical form that matches the
1965 -- pragma Linker_Options set in the NT runtime.
1967 if (Linker_Options.Table (J)'Length > 17
1968 and then Linker_Options.Table (J) (1 .. 17) =
1969 "-Xlinker --stack=")
1970 or else
1971 (Linker_Options.Table (J)'Length > 12
1972 and then Linker_Options.Table (J) (1 .. 12) =
1973 "-Wl,--stack=")
1974 then
1975 if Stack_Op then
1976 Linker_Options.Table (J .. Linker_Options.Last - 1) :=
1977 Linker_Options.Table (J + 1 .. Linker_Options.Last);
1978 Linker_Options.Decrement_Last;
1979 Num_Args := Num_Args - 1;
1981 else
1982 Stack_Op := True;
1983 end if;
1984 end if;
1986 J := J + 1;
1987 end loop;
1989 if Linker_Path = Gcc_Path and then VM_Target = No_VM then
1991 -- For systems where the default is to link statically with
1992 -- libgcc, if gcc is not called with -shared-libgcc, call it
1993 -- with -static-libgcc, as there are some platforms where one
1994 -- of these two switches is compulsory to link.
1996 if Shared_Libgcc_Default = 'T'
1997 and then not Shared_Libgcc_Seen
1998 then
1999 Linker_Options.Increment_Last;
2000 Linker_Options.Table (Linker_Options.Last) := Static_Libgcc;
2001 Num_Args := Num_Args + 1;
2002 end if;
2003 end if;
2004 end Clean_Link_Option_Set;
2006 -- Prepare arguments for call to linker
2008 Call_Linker : declare
2009 Success : Boolean;
2010 Args : Argument_List (1 .. Num_Args + 1);
2011 Index : Integer := Args'First;
2013 begin
2014 Args (Index) := Binder_Obj_File;
2016 -- Add the object files and any -largs libraries
2018 for J in Linker_Objects.First .. Linker_Objects.Last loop
2019 Index := Index + 1;
2020 Args (Index) := Linker_Objects.Table (J);
2021 end loop;
2023 -- Add the linker options from the binder file
2025 for J in Linker_Options.First .. Linker_Options.Last loop
2026 Index := Index + 1;
2027 Args (Index) := Linker_Options.Table (J);
2028 end loop;
2030 -- Finally add the libraries from the --GCC= switch
2032 for J in Gcc_Linker_Options.First .. Gcc_Linker_Options.Last loop
2033 Index := Index + 1;
2034 Args (Index) := Gcc_Linker_Options.Table (J);
2035 end loop;
2037 if Verbose_Mode then
2038 Write_Str (Linker_Path.all);
2040 for J in Args'Range loop
2041 Write_Str (" ");
2042 Write_Str (Args (J).all);
2043 end loop;
2045 Write_Eol;
2047 -- If we are on very verbose mode (-v -v) and a response file
2048 -- is used we display its content.
2050 if Very_Verbose_Mode and then Tname_FD /= Invalid_FD then
2051 Write_Eol;
2052 Write_Str ("Response file (" &
2053 Tname (Tname'First .. Tname'Last - 1) &
2054 ") content : ");
2055 Write_Eol;
2057 for J in
2058 Response_File_Objects.First .. Response_File_Objects.Last
2059 loop
2060 Write_Str (Response_File_Objects.Table (J).all);
2061 Write_Eol;
2062 end loop;
2064 Write_Eol;
2065 end if;
2066 end if;
2068 System.OS_Lib.Spawn (Linker_Path.all, Args, Success);
2070 if Success then
2072 -- Delete the temporary file used in conjunction with linking
2073 -- if one was created. See Process_Bind_File for details.
2075 if Tname_FD /= Invalid_FD then
2076 Delete (Tname);
2077 end if;
2079 else
2080 Error_Msg ("error when calling " & Linker_Path.all);
2081 Exit_Program (E_Fatal);
2082 end if;
2083 end Call_Linker;
2084 end Link_Step;
2086 -- Only keep the binder output file and it's associated object
2087 -- file if compiling with the -g option. These files are only
2088 -- useful if debugging.
2090 if not Debug_Flag_Present then
2091 Delete (Binder_Ali_File.all & ASCII.NUL);
2092 Delete (Binder_Spec_Src_File.all & ASCII.NUL);
2093 Delete (Binder_Body_Src_File.all & ASCII.NUL);
2095 if VM_Target = No_VM then
2096 Delete (Binder_Obj_File.all & ASCII.NUL);
2097 end if;
2098 end if;
2100 Exit_Program (E_Success);
2102 exception
2103 when X : others =>
2104 Write_Line (Exception_Information (X));
2105 Exit_With_Error ("INTERNAL ERROR. Please report");
2106 end Gnatlink;