1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
10 -- Copyright (C) 1992-2001 Free Software Foundation, Inc. --
12 -- GNAT is free software; you can redistribute it and/or modify it under --
13 -- terms of the GNU General Public License as published by the Free Soft- --
14 -- ware Foundation; either version 2, or (at your option) any later ver- --
15 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
16 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
17 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
18 -- for more details. You should have received a copy of the GNU General --
19 -- Public License distributed with GNAT; see file COPYING. If not, write --
20 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
21 -- MA 02111-1307, USA. --
23 -- GNAT was originally developed by the GNAT team at New York University. --
24 -- Extensive contributions were provided by Ada Core Technologies Inc. --
26 ------------------------------------------------------------------------------
28 with Atree
; use Atree
;
29 with Debug
; use Debug
;
30 with Errout
; use Errout
;
31 with Fname
; use Fname
;
32 with Fname
.UF
; use Fname
.UF
;
33 with Namet
; use Namet
;
34 with Nlists
; use Nlists
;
35 with Nmake
; use Nmake
;
37 with Osint
; use Osint
;
38 with Osint
.C
; use Osint
.C
;
39 with Output
; use Output
;
42 with Sinfo
; use Sinfo
;
43 with Sinput
; use Sinput
;
44 with Sinput
.L
; use Sinput
.L
;
45 with Targparm
; use Targparm
;
46 with Tbuild
; use Tbuild
;
47 with Uname
; use Uname
;
49 package body Lib
.Load
is
51 -----------------------
52 -- Local Subprograms --
53 -----------------------
55 function Spec_Is_Irrelevant
56 (Spec_Unit
: Unit_Number_Type
;
57 Body_Unit
: Unit_Number_Type
)
59 -- The Spec_Unit and Body_Unit parameters are the unit numbers of the
60 -- spec file that corresponds to the main unit which is a body. This
61 -- function determines if the spec file is irrelevant and will be
62 -- overridden by the body as described in RM 10.1.4(4). See description
63 -- in "Special Handling of Subprogram Bodies" for further details.
65 procedure Write_Dependency_Chain
;
66 -- This procedure is used to generate error message info lines that
67 -- trace the current dependency chain when a load error occurs.
69 -------------------------------
70 -- Create_Dummy_Package_Unit --
71 -------------------------------
73 function Create_Dummy_Package_Unit
75 Spec_Name
: Unit_Name_Type
)
76 return Unit_Number_Type
78 Unum
: Unit_Number_Type
;
79 Cunit_Entity
: Entity_Id
;
81 Du_Name
: Node_Or_Entity_Id
;
83 Save_CS
: constant Boolean := Get_Comes_From_Source_Default
;
86 -- The created dummy package unit does not come from source
88 Set_Comes_From_Source_Default
(False);
92 if Nkind
(Name
(With_Node
)) = N_Identifier
then
94 Make_Defining_Identifier
(No_Location
,
95 Chars
=> Chars
(Name
(With_Node
)));
96 Du_Name
:= Cunit_Entity
;
97 End_Lab
:= New_Occurrence_Of
(Cunit_Entity
, No_Location
);
101 else -- Nkind (Name (With_Node)) = N_Expanded_Name
103 Make_Defining_Identifier
(No_Location
,
104 Chars
=> Chars
(Selector_Name
(Name
(With_Node
))));
106 Make_Defining_Program_Unit_Name
(No_Location
,
107 Name
=> New_Copy_Tree
(Prefix
(Name
(With_Node
))),
108 Defining_Identifier
=> Cunit_Entity
);
110 Make_Designator
(No_Location
,
111 Name
=> New_Copy_Tree
(Prefix
(Name
(With_Node
))),
112 Identifier
=> New_Occurrence_Of
(Cunit_Entity
, No_Location
));
116 Make_Compilation_Unit
(No_Location
,
117 Context_Items
=> Empty_List
,
119 Make_Package_Declaration
(No_Location
,
121 Make_Package_Specification
(No_Location
,
122 Defining_Unit_Name
=> Du_Name
,
123 Visible_Declarations
=> Empty_List
,
124 End_Label
=> End_Lab
)),
126 Make_Compilation_Unit_Aux
(No_Location
));
128 Units
.Increment_Last
;
131 Units
.Table
(Unum
) := (
133 Cunit_Entity
=> Cunit_Entity
,
135 Dependent_Unit
=> False,
136 Dynamic_Elab
=> False,
137 Error_Location
=> Sloc
(With_Node
),
138 Expected_Unit
=> Spec_Name
,
140 Generate_Code
=> False,
142 Ident_String
=> Empty
,
144 Main_Priority
=> Default_Main_Priority
,
146 Source_Index
=> No_Source_File
,
147 Unit_File_Name
=> Get_File_Name
(Spec_Name
, Subunit
=> False),
148 Unit_Name
=> Spec_Name
,
151 Set_Comes_From_Source_Default
(Save_CS
);
152 Set_Error_Posted
(Cunit_Entity
);
153 Set_Error_Posted
(Cunit
);
155 end Create_Dummy_Package_Unit
;
161 procedure Initialize
is
162 Fname
: File_Name_Type
;
167 Load_Stack
.Increment_Last
;
168 Load_Stack
.Table
(Load_Stack
.Last
) := Main_Unit
;
170 -- Initialize unit table entry for Main_Unit. Note that we don't know
171 -- the unit name yet, that gets filled in when the parser parses the
172 -- main unit, at which time a check is made that it matches the main
173 -- file name, and then the Unit_Name field is set. The Cunit and
174 -- Cunit_Entity fields also get filled in later by the parser.
176 Units
.Increment_Last
;
177 Fname
:= Next_Main_Source
;
179 Units
.Table
(Main_Unit
).Unit_File_Name
:= Fname
;
181 if Fname
/= No_File
then
183 Main_Source_File
:= Load_Source_File
(Fname
);
184 Current_Error_Source_File
:= Main_Source_File
;
186 Units
.Table
(Main_Unit
) := (
188 Cunit_Entity
=> Empty
,
190 Dependent_Unit
=> True,
191 Dynamic_Elab
=> False,
192 Error_Location
=> No_Location
,
193 Expected_Unit
=> No_Name
,
194 Fatal_Error
=> False,
195 Generate_Code
=> False,
198 Ident_String
=> Empty
,
199 Main_Priority
=> Default_Main_Priority
,
201 Source_Index
=> Main_Source_File
,
202 Unit_File_Name
=> Fname
,
203 Unit_Name
=> No_Name
,
204 Version
=> Source_Checksum
(Main_Source_File
));
208 ------------------------
209 -- Initialize_Version --
210 ------------------------
212 procedure Initialize_Version
(U
: Unit_Number_Type
) is
214 Units
.Table
(U
).Version
:= Source_Checksum
(Source_Index
(U
));
215 end Initialize_Version
;
222 (Load_Name
: Unit_Name_Type
;
224 Error_Node
: Node_Id
;
226 Corr_Body
: Unit_Number_Type
:= No_Unit
;
227 Renamings
: Boolean := False)
228 return Unit_Number_Type
230 Calling_Unit
: Unit_Number_Type
;
231 Uname_Actual
: Unit_Name_Type
;
232 Unum
: Unit_Number_Type
;
233 Unump
: Unit_Number_Type
;
234 Fname
: File_Name_Type
;
235 Src_Ind
: Source_File_Index
;
238 procedure Set_Load_Unit_Dependency
(U
: Unit_Number_Type
);
239 -- Sets the Dependent_Unit flag unless we have a predefined unit
240 -- being loaded in No_Run_Time mode. In this case we do not want
241 -- to create a dependency, since we have loaded the unit only
242 -- to inline stuff from it. If this is not the case, an error
243 -- message will be issued in Rtsfind in any case.
245 ------------------------------
246 -- Set_Load_Unit_Dependency --
247 ------------------------------
249 procedure Set_Load_Unit_Dependency
(U
: Unit_Number_Type
) is
251 -- Differentiate between pragma No_Run_Time (that can be used
252 -- with a standard installation), and HI-E mode which comes
253 -- with a special installation.
255 -- For No_Run_Time mode, we do not want to create a dependency
256 -- since the binder would generate references to these units.
257 -- In the case of HI-E, a special run time is provided that do
258 -- not have any elaboration, so it is safe (and useful) to add
259 -- the dependency. In particular, this allows the user to
260 -- recompile run time units, e.g GNAT.IO.
263 and then not High_Integrity_Mode_On_Target
264 and then Is_Internal_File_Name
(Unit_File_Name
(U
))
268 Units
.Table
(U
).Dependent_Unit
:= True;
270 end Set_Load_Unit_Dependency
;
272 -- Start of processing for Load_Unit
275 -- If renamings are allowed and we have a child unit name, then we
276 -- must first load the parent to deal with finding the real name.
278 if Renamings
and then Is_Child_Name
(Load_Name
) then
281 (Load_Name
=> Get_Parent_Spec_Name
(Load_Name
),
282 Required
=> Required
,
285 Error_Node
=> Error_Node
);
287 if Unump
= No_Unit
then
291 -- If parent is a renaming, then we use the renamed package as
292 -- the actual parent for the subsequent load operation.
294 if Nkind
(Parent
(Cunit_Entity
(Unump
))) =
295 N_Package_Renaming_Declaration
300 Get_Unit_Name
(Name
(Parent
(Cunit_Entity
(Unump
)))));
302 -- Save the renaming entity, to establish its visibility when
303 -- installing the context. The implicit with is on this entity,
304 -- not on the package it renames.
306 if Nkind
(Error_Node
) = N_With_Clause
307 and then Nkind
(Name
(Error_Node
)) = N_Selected_Component
310 Par
: Node_Id
:= Name
(Error_Node
);
313 while Nkind
(Par
) = N_Selected_Component
314 and then Chars
(Selector_Name
(Par
)) /=
315 Chars
(Cunit_Entity
(Unump
))
320 if Nkind
(Par
) = N_Selected_Component
then
321 -- some intermediate parent is a renaming.
323 Set_Entity
(Selector_Name
(Par
), Cunit_Entity
(Unump
));
326 -- the ultimate parent is a renaming.
328 Set_Entity
(Par
, Cunit_Entity
(Unump
));
333 -- If the parent is not a renaming, then get its name (this may
334 -- be different from the parent spec name obtained above because
335 -- of renamings higher up in the hierarchy).
338 Uname_Actual
:= New_Child
(Load_Name
, Unit_Name
(Unump
));
341 -- Here if unit to be loaded is not a child unit
344 Uname_Actual
:= Load_Name
;
347 Fname
:= Get_File_Name
(Uname_Actual
, Subunit
);
351 Write_Str
("*** Load request for unit: ");
352 Write_Unit_Name
(Load_Name
);
355 Write_Str
(" (Required = True)");
357 Write_Str
(" (Required = False)");
362 if Uname_Actual
/= Load_Name
then
363 Write_Str
("*** Actual unit loaded: ");
364 Write_Unit_Name
(Uname_Actual
);
368 -- Capture error location if it is for the main unit. The idea is to
369 -- post errors on the main unit location, not the most recent unit.
371 if Present
(Error_Node
) then
373 -- It seems like In_Extended_Main_Source_Unit (Error_Node) would
374 -- do the trick here, but that's wrong, it is much too early to
375 -- call this routine. We are still in the parser, and the required
376 -- semantic information is not established yet. So we base the
377 -- judgment on unit names.
379 Get_External_Unit_Name_String
(Unit_Name
(Main_Unit
));
382 Main_Unit_Name
: constant String := Name_Buffer
(1 .. Name_Len
);
385 Get_External_Unit_Name_String
386 (Unit_Name
(Get_Source_Unit
(Error_Node
)));
388 -- If the two names are identical, then for sure we are part
389 -- of the extended main unit
391 if Main_Unit_Name
= Name_Buffer
(1 .. Name_Len
) then
392 Load_Msg_Sloc
:= Sloc
(Error_Node
);
394 -- If the load is called from a with_type clause, the error
397 elsif Nkind
(Parent
(Error_Node
)) = N_With_Type_Clause
then
398 Load_Msg_Sloc
:= Sloc
(Error_Node
);
400 -- Otherwise, check for the subunit case, and if so, consider
401 -- we have a match if one name is a prefix of the other name.
404 if Nkind
(Unit
(Cunit
(Main_Unit
))) = N_Subunit
406 Nkind
(Unit
(Cunit
(Get_Source_Unit
(Error_Node
)))) =
409 Name_Len
:= Integer'Min (Name_Len
, Main_Unit_Name
'Length);
411 if Name_Buffer
(1 .. Name_Len
)
413 Main_Unit_Name
(1 .. Name_Len
)
415 Load_Msg_Sloc
:= Sloc
(Error_Node
);
422 -- If we are generating error messages, then capture calling unit
424 if Present
(Error_Node
) then
425 Calling_Unit
:= Get_Source_Unit
(Error_Node
);
427 Calling_Unit
:= No_Unit
;
430 -- See if we already have an entry for this unit
434 while Unum
<= Units
.Last
loop
435 exit when Uname_Actual
= Units
.Table
(Unum
).Unit_Name
;
439 -- Whether or not the entry was found, Unum is now the right value,
440 -- since it is one more than Units.Last (i.e. the index of the new
441 -- entry we will create) in the not found case.
443 -- A special check is necessary in the unit not found case. If the unit
444 -- is not found, but the file in which it lives has already been loaded,
445 -- then we have the problem that the file does not contain the unit that
446 -- is needed. We simply treat this as a file not found condition.
448 if Unum
> Units
.Last
then
449 for J
in Units
.First
.. Units
.Last
loop
450 if Fname
= Units
.Table
(J
).Unit_File_Name
then
452 Write_Str
(" file does not contain unit, Unit_Number = ");
453 Write_Int
(Int
(Unum
));
458 if Present
(Error_Node
) then
460 if Is_Predefined_File_Name
(Fname
) then
461 Error_Msg_Name_1
:= Uname_Actual
;
463 ("% is not a language defined unit", Load_Msg_Sloc
);
465 Error_Msg_Name_1
:= Fname
;
466 Error_Msg_Unit_1
:= Uname_Actual
;
468 ("File{ does not contain unit$", Load_Msg_Sloc
);
471 Write_Dependency_Chain
;
481 -- If we are proceeding with load, then make load stack entry
483 Load_Stack
.Increment_Last
;
484 Load_Stack
.Table
(Load_Stack
.Last
) := Unum
;
486 -- Case of entry already in table
488 if Unum
<= Units
.Last
then
490 -- Here is where we check for a circular dependency, which is
491 -- an attempt to load a unit which is currently in the process
492 -- of being loaded. We do *not* care about a circular chain that
493 -- leads back to a body, because this kind of circular dependence
494 -- legitimately occurs (e.g. two package bodies that contain
495 -- inlined subprogram referenced by the other).
498 and then (Is_Spec_Name
(Units
.Table
(Unum
).Unit_Name
)
499 or else Acts_As_Spec
(Units
.Table
(Unum
).Cunit
))
502 Write_Str
(" circular dependency encountered");
506 if Present
(Error_Node
) then
507 Error_Msg
("circular unit dependency", Load_Msg_Sloc
);
508 Write_Dependency_Chain
;
510 Load_Stack
.Decrement_Last
;
517 Write_Str
(" unit already in file table, Unit_Number = ");
518 Write_Int
(Int
(Unum
));
522 Load_Stack
.Decrement_Last
;
523 Set_Load_Unit_Dependency
(Unum
);
526 -- File is not already in table, so try to open it
530 Write_Str
(" attempt unit load, Unit_Number = ");
531 Write_Int
(Int
(Unum
));
535 Src_Ind
:= Load_Source_File
(Fname
);
537 -- Make a partial entry in the file table, used even in the file not
538 -- found case to print the dependency chain including the last entry
540 Units
.Increment_Last
;
541 Units
.Table
(Unum
).Unit_Name
:= Uname_Actual
;
545 if Src_Ind
/= No_Source_File
then
546 Units
.Table
(Unum
) := (
548 Cunit_Entity
=> Empty
,
550 Dependent_Unit
=> False,
551 Dynamic_Elab
=> False,
552 Error_Location
=> Sloc
(Error_Node
),
553 Expected_Unit
=> Uname_Actual
,
554 Fatal_Error
=> False,
555 Generate_Code
=> False,
557 Ident_String
=> Empty
,
559 Main_Priority
=> Default_Main_Priority
,
561 Source_Index
=> Src_Ind
,
562 Unit_File_Name
=> Fname
,
563 Unit_Name
=> Uname_Actual
,
564 Version
=> Source_Checksum
(Src_Ind
));
566 -- Parse the new unit
568 Initialize_Scanner
(Unum
, Source_Index
(Unum
));
569 Discard
:= Par
(Configuration_Pragmas
=> False);
570 Set_Loading
(Unum
, False);
572 -- If spec is irrelevant, then post errors and quit
574 if Corr_Body
/= No_Unit
575 and then Spec_Is_Irrelevant
(Unum
, Corr_Body
)
577 Error_Msg_Name_1
:= Unit_File_Name
(Corr_Body
);
579 ("cannot compile subprogram in file {!",
581 Error_Msg_Name_1
:= Unit_File_Name
(Unum
);
583 ("incorrect spec in file { must be removed first!",
588 -- If loaded unit had a fatal error, then caller inherits it!
590 if Units
.Table
(Unum
).Fatal_Error
591 and then Present
(Error_Node
)
593 Units
.Table
(Calling_Unit
).Fatal_Error
:= True;
596 -- Remove load stack entry and return the entry in the file table
598 Load_Stack
.Decrement_Last
;
599 Set_Load_Unit_Dependency
(Unum
);
602 -- Case of file not found
606 Write_Str
(" file was not found, load failed");
610 -- Generate message if unit required
612 if Required
and then Present
(Error_Node
) then
614 if Is_Predefined_File_Name
(Fname
) then
615 Error_Msg_Name_1
:= Uname_Actual
;
617 ("% is not a predefined library unit", Load_Msg_Sloc
);
620 Error_Msg_Name_1
:= Fname
;
621 Error_Msg
("file{ not found", Load_Msg_Sloc
);
624 Write_Dependency_Chain
;
626 -- Remove unit from stack, to avoid cascaded errors on
627 -- subsequent missing files.
629 Load_Stack
.Decrement_Last
;
630 Units
.Decrement_Last
;
632 -- If unit not required, remove load stack entry and the junk
633 -- file table entry, and return No_Unit to indicate not found,
636 Load_Stack
.Decrement_Last
;
637 Units
.Decrement_Last
;
645 ------------------------
646 -- Make_Instance_Unit --
647 ------------------------
649 -- If the unit is an instance, it appears as a package declaration, but
650 -- contains both declaration and body of the instance. The body becomes
651 -- the main unit of the compilation, and the declaration is inserted
652 -- at the end of the unit table. The main unit now has the name of a
653 -- body, which is constructed from the name of the original spec,
654 -- and is attached to the compilation node of the original unit. The
655 -- declaration has been attached to a new compilation unit node, and
656 -- code will have to be generated for it.
658 procedure Make_Instance_Unit
(N
: Node_Id
) is
659 Sind
: constant Source_File_Index
:= Source_Index
(Main_Unit
);
662 Units
.Increment_Last
;
664 Units
.Table
(Units
.Last
) := Units
.Table
(Main_Unit
);
665 Units
.Table
(Units
.Last
).Cunit
:= Library_Unit
(N
);
666 Units
.Table
(Units
.Last
).Generate_Code
:= True;
668 Units
.Table
(Main_Unit
).Cunit
:= N
;
669 Units
.Table
(Main_Unit
).Unit_Name
:=
670 Get_Body_Name
(Unit_Name
(Get_Cunit_Unit_Number
(Library_Unit
(N
))));
671 Units
.Table
(Main_Unit
).Version
:= Source_Checksum
(Sind
);
672 end Make_Instance_Unit
;
674 ------------------------
675 -- Spec_Is_Irrelevant --
676 ------------------------
678 function Spec_Is_Irrelevant
679 (Spec_Unit
: Unit_Number_Type
;
680 Body_Unit
: Unit_Number_Type
)
683 Sunit
: constant Node_Id
:= Cunit
(Spec_Unit
);
684 Bunit
: constant Node_Id
:= Cunit
(Body_Unit
);
687 -- The spec is irrelevant if the body is a subprogram body, and the
688 -- spec is other than a subprogram spec or generic subprogram spec.
689 -- Note that the names must be the same, we don't need to check that,
690 -- because we already know that from the fact that the file names are
694 Nkind
(Unit
(Bunit
)) = N_Subprogram_Body
695 and then Nkind
(Unit
(Sunit
)) /= N_Subprogram_Declaration
696 and then Nkind
(Unit
(Sunit
)) /= N_Generic_Subprogram_Declaration
;
698 end Spec_Is_Irrelevant
;
704 procedure Version_Update
(U
: Node_Id
; From
: Node_Id
) is
705 Unum
: constant Unit_Number_Type
:= Get_Cunit_Unit_Number
(U
);
706 Fnum
: constant Unit_Number_Type
:= Get_Cunit_Unit_Number
(From
);
709 Units
.Table
(Unum
).Version
:=
710 Units
.Table
(Unum
).Version
712 Source_Checksum
(Source_Index
(Fnum
));
715 ----------------------------
716 -- Write_Dependency_Chain --
717 ----------------------------
719 procedure Write_Dependency_Chain
is
721 -- The dependency chain is only written if it is at least two entries
722 -- deep, otherwise it is trivial (the main unit depending on a unit
723 -- that it obviously directly depends on).
725 if Load_Stack
.Last
- 1 > Load_Stack
.First
then
726 for U
in Load_Stack
.First
.. Load_Stack
.Last
- 1 loop
727 Error_Msg_Unit_1
:= Unit_Name
(Load_Stack
.Table
(U
));
728 Error_Msg_Unit_2
:= Unit_Name
(Load_Stack
.Table
(U
+ 1));
729 Error_Msg
("$ depends on $!", Load_Msg_Sloc
);
732 end Write_Dependency_Chain
;