1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2007, 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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 with Atree; use Atree;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Errout; use Errout;
31 with Fname; use Fname;
32 with Fname.UF; use Fname.UF;
33 with Nlists; use Nlists;
34 with Nmake; use Nmake;
36 with Osint; use Osint;
37 with Osint.C; use Osint.C;
38 with Output; use Output;
40 with Restrict; use Restrict;
42 with Sinfo; use Sinfo;
43 with Sinput; use Sinput;
44 with Sinput.L; use Sinput.L;
45 with Stand; use Stand;
46 with Tbuild; use Tbuild;
47 with Uname; use Uname;
49 package body Lib.Load is
51 -----------------------
52 -- Local Subprograms --
53 -----------------------
55 function From_Limited_With_Chain (Lim : Boolean) return Boolean;
56 -- Check whether a possible circular dependence includes units that
57 -- have been loaded through limited_with clauses, in which case there
58 -- is no real circularity.
60 function Spec_Is_Irrelevant
61 (Spec_Unit : Unit_Number_Type;
62 Body_Unit : Unit_Number_Type) return Boolean;
63 -- The Spec_Unit and Body_Unit parameters are the unit numbers of the
64 -- spec file that corresponds to the main unit which is a body. This
65 -- function determines if the spec file is irrelevant and will be
66 -- overridden by the body as described in RM 10.1.4(4). See description
67 -- in "Special Handling of Subprogram Bodies" for further details.
69 procedure Write_Dependency_Chain;
70 -- This procedure is used to generate error message info lines that
71 -- trace the current dependency chain when a load error occurs.
73 ------------------------------
74 -- Change_Main_Unit_To_Spec --
75 ------------------------------
77 procedure Change_Main_Unit_To_Spec is
78 U : Unit_Record renames Units.Table (Main_Unit);
80 X : Source_File_Index;
83 -- Get name of unit body
85 Get_Name_String (U.Unit_File_Name);
87 -- Note: for the following we should really generalize and consult the
88 -- file name pattern data, but for now we just deal with the common
89 -- naming cases, which is probably good enough in practice ???
91 -- Change .adb to .ads
94 and then Name_Buffer (Name_Len - 3 .. Name_Len) = ".adb"
96 Name_Buffer (Name_Len) := 's';
98 -- Change .2.ada to .1.ada (Rational convention)
101 and then Name_Buffer (Name_Len - 5 .. Name_Len) = ".2.ada"
103 Name_Buffer (Name_Len - 4) := '1';
105 -- Change .ada to _.ada (DEC convention)
108 and then Name_Buffer (Name_Len - 3 .. Name_Len) = ".ada"
110 Name_Buffer (Name_Len - 3 .. Name_Len + 1) := "_.ada";
111 Name_Len := Name_Len + 1;
113 -- No match, don't make the change
119 -- Try loading the spec
122 X := Load_Source_File (N);
124 -- No change if we did not find the spec
126 if X = No_Source_File then
130 -- Otherwise modify Main_Unit entry to point to spec
132 U.Unit_File_Name := N;
134 end Change_Main_Unit_To_Spec;
136 -------------------------------
137 -- Create_Dummy_Package_Unit --
138 -------------------------------
140 function Create_Dummy_Package_Unit
141 (With_Node : Node_Id;
142 Spec_Name : Unit_Name_Type) return Unit_Number_Type
144 Unum : Unit_Number_Type;
145 Cunit_Entity : Entity_Id;
147 Du_Name : Node_Or_Entity_Id;
149 Save_CS : constant Boolean := Get_Comes_From_Source_Default;
152 -- The created dummy package unit does not come from source
154 Set_Comes_From_Source_Default (False);
158 if Nkind (Name (With_Node)) = N_Identifier then
160 Make_Defining_Identifier (No_Location,
161 Chars => Chars (Name (With_Node)));
162 Du_Name := Cunit_Entity;
163 End_Lab := New_Occurrence_Of (Cunit_Entity, No_Location);
169 Make_Defining_Identifier (No_Location,
170 Chars => Chars (Selector_Name (Name (With_Node))));
172 Make_Defining_Program_Unit_Name (No_Location,
173 Name => New_Copy_Tree (Prefix (Name (With_Node))),
174 Defining_Identifier => Cunit_Entity);
176 Set_Is_Child_Unit (Cunit_Entity);
179 Make_Designator (No_Location,
180 Name => New_Copy_Tree (Prefix (Name (With_Node))),
181 Identifier => New_Occurrence_Of (Cunit_Entity, No_Location));
184 Set_Scope (Cunit_Entity, Standard_Standard);
187 Make_Compilation_Unit (No_Location,
188 Context_Items => Empty_List,
190 Make_Package_Declaration (No_Location,
192 Make_Package_Specification (No_Location,
193 Defining_Unit_Name => Du_Name,
194 Visible_Declarations => Empty_List,
195 End_Label => End_Lab)),
197 Make_Compilation_Unit_Aux (No_Location));
199 -- Mark the dummy package as analyzed to prevent analysis of this
200 -- (non-existent) unit in -gnatQ mode because at the moment the
201 -- structure and attributes of this dummy package does not allow
202 -- a normal analysis of this unit
204 Set_Analyzed (Cunit);
206 Units.Increment_Last;
209 Units.Table (Unum) := (
211 Cunit_Entity => Cunit_Entity,
213 Dynamic_Elab => False,
214 Error_Location => Sloc (With_Node),
215 Expected_Unit => Spec_Name,
217 Generate_Code => False,
219 Ident_String => Empty,
221 Main_Priority => Default_Main_Priority,
224 Source_Index => No_Source_File,
225 Unit_File_Name => Get_File_Name (Spec_Name, Subunit => False),
226 Unit_Name => Spec_Name,
229 Set_Comes_From_Source_Default (Save_CS);
230 Set_Error_Posted (Cunit_Entity);
231 Set_Error_Posted (Cunit);
233 end Create_Dummy_Package_Unit;
235 -----------------------------
236 -- From_Limited_With_Chain --
237 -----------------------------
239 function From_Limited_With_Chain (Lim : Boolean) return Boolean is
241 -- True if the current load operation is through a limited_with clause
246 -- Examine the Load_Stack to locate any previous Limited_with clause
248 elsif Load_Stack.Last - 1 > Load_Stack.First then
249 for U in Load_Stack.First .. Load_Stack.Last - 1 loop
250 if Load_Stack.Table (U).From_Limited_With then
257 end From_Limited_With_Chain;
263 procedure Initialize is
269 ------------------------
270 -- Initialize_Version --
271 ------------------------
273 procedure Initialize_Version (U : Unit_Number_Type) is
275 Units.Table (U).Version := Source_Checksum (Source_Index (U));
276 end Initialize_Version;
278 ----------------------
279 -- Load_Main_Source --
280 ----------------------
282 procedure Load_Main_Source is
283 Fname : File_Name_Type;
287 Load_Stack.Increment_Last;
288 Load_Stack.Table (Load_Stack.Last) := (Main_Unit, False);
290 -- Initialize unit table entry for Main_Unit. Note that we don't know
291 -- the unit name yet, that gets filled in when the parser parses the
292 -- main unit, at which time a check is made that it matches the main
293 -- file name, and then the Unit_Name field is set. The Cunit and
294 -- Cunit_Entity fields also get filled in later by the parser.
296 Units.Increment_Last;
297 Fname := Next_Main_Source;
299 Units.Table (Main_Unit).Unit_File_Name := Fname;
301 if Fname /= No_File then
302 Main_Source_File := Load_Source_File (Fname);
303 Current_Error_Source_File := Main_Source_File;
305 if Main_Source_File /= No_Source_File then
306 Version := Source_Checksum (Main_Source_File);
309 Units.Table (Main_Unit) := (
311 Cunit_Entity => Empty,
313 Dynamic_Elab => False,
314 Error_Location => No_Location,
315 Expected_Unit => No_Unit_Name,
316 Fatal_Error => False,
317 Generate_Code => False,
319 Ident_String => Empty,
321 Main_Priority => Default_Main_Priority,
324 Source_Index => Main_Source_File,
325 Unit_File_Name => Fname,
326 Unit_Name => No_Unit_Name,
329 end Load_Main_Source;
336 (Load_Name : Unit_Name_Type;
338 Error_Node : Node_Id;
340 Corr_Body : Unit_Number_Type := No_Unit;
341 Renamings : Boolean := False;
342 From_Limited_With : Boolean := False) return Unit_Number_Type
344 Calling_Unit : Unit_Number_Type;
345 Uname_Actual : Unit_Name_Type;
346 Unum : Unit_Number_Type;
347 Unump : Unit_Number_Type;
348 Fname : File_Name_Type;
349 Src_Ind : Source_File_Index;
351 -- Start of processing for Load_Unit
354 -- If renamings are allowed and we have a child unit name, then we
355 -- must first load the parent to deal with finding the real name.
357 if Renamings and then Is_Child_Name (Load_Name) then
360 (Load_Name => Get_Parent_Spec_Name (Load_Name),
361 Required => Required,
364 Error_Node => Error_Node);
366 if Unump = No_Unit then
370 -- If parent is a renaming, then we use the renamed package as
371 -- the actual parent for the subsequent load operation.
373 if Nkind (Unit (Cunit (Unump))) = N_Package_Renaming_Declaration then
376 (Load_Name, Get_Unit_Name (Name (Unit (Cunit (Unump)))));
378 -- Save the renaming entity, to establish its visibility when
379 -- installing the context. The implicit with is on this entity,
380 -- not on the package it renames.
382 if Nkind (Error_Node) = N_With_Clause
383 and then Nkind (Name (Error_Node)) = N_Selected_Component
386 Par : Node_Id := Name (Error_Node);
389 while Nkind (Par) = N_Selected_Component
390 and then Chars (Selector_Name (Par)) /=
391 Chars (Cunit_Entity (Unump))
396 -- Case of some intermediate parent is a renaming
398 if Nkind (Par) = N_Selected_Component then
399 Set_Entity (Selector_Name (Par), Cunit_Entity (Unump));
401 -- Case where the ultimate parent is a renaming
404 Set_Entity (Par, Cunit_Entity (Unump));
409 -- If the parent is not a renaming, then get its name (this may
410 -- be different from the parent spec name obtained above because
411 -- of renamings higher up in the hierarchy).
414 Uname_Actual := New_Child (Load_Name, Unit_Name (Unump));
417 -- Here if unit to be loaded is not a child unit
420 Uname_Actual := Load_Name;
423 Fname := Get_File_Name (Uname_Actual, Subunit);
427 Write_Str ("*** Load request for unit: ");
428 Write_Unit_Name (Load_Name);
431 Write_Str (" (Required = True)");
433 Write_Str (" (Required = False)");
438 if Uname_Actual /= Load_Name then
439 Write_Str ("*** Actual unit loaded: ");
440 Write_Unit_Name (Uname_Actual);
444 -- Capture error location if it is for the main unit. The idea is to
445 -- post errors on the main unit location, not the most recent unit.
446 -- Note: Unit_Name (Main_Unit) is not set if we are parsing gnat.adc.
448 if Present (Error_Node)
449 and then Unit_Name (Main_Unit) /= No_Unit_Name
451 -- It seems like In_Extended_Main_Source_Unit (Error_Node) would
452 -- do the trick here, but that's wrong, it is much too early to
453 -- call this routine. We are still in the parser, and the required
454 -- semantic information is not established yet. So we base the
455 -- judgment on unit names.
457 Get_External_Unit_Name_String (Unit_Name (Main_Unit));
460 Main_Unit_Name : constant String := Name_Buffer (1 .. Name_Len);
463 Get_External_Unit_Name_String
464 (Unit_Name (Get_Source_Unit (Error_Node)));
466 -- If the two names are identical, then for sure we are part
467 -- of the extended main unit
469 if Main_Unit_Name = Name_Buffer (1 .. Name_Len) then
470 Load_Msg_Sloc := Sloc (Error_Node);
472 -- If the load is called from a with_type clause, the error
475 -- Otherwise, check for the subunit case, and if so, consider
476 -- we have a match if one name is a prefix of the other name.
479 if Nkind (Unit (Cunit (Main_Unit))) = N_Subunit
481 Nkind (Unit (Cunit (Get_Source_Unit (Error_Node)))) =
484 Name_Len := Integer'Min (Name_Len, Main_Unit_Name'Length);
486 if Name_Buffer (1 .. Name_Len)
488 Main_Unit_Name (1 .. Name_Len)
490 Load_Msg_Sloc := Sloc (Error_Node);
497 -- If we are generating error messages, then capture calling unit
499 if Present (Error_Node) then
500 Calling_Unit := Get_Source_Unit (Error_Node);
502 Calling_Unit := No_Unit;
505 -- See if we already have an entry for this unit
509 while Unum <= Units.Last loop
510 exit when Uname_Actual = Units.Table (Unum).Unit_Name;
514 -- Whether or not the entry was found, Unum is now the right value,
515 -- since it is one more than Units.Last (i.e. the index of the new
516 -- entry we will create) in the not found case.
518 -- A special check is necessary in the unit not found case. If the unit
519 -- is not found, but the file in which it lives has already been loaded,
520 -- then we have the problem that the file does not contain the unit that
521 -- is needed. We simply treat this as a file not found condition.
523 -- We skip this test in multiple unit per file mode since in this
524 -- case we can have multiple units from the same source file.
526 if Unum > Units.Last and then Get_Unit_Index (Uname_Actual) = 0 then
527 for J in Units.First .. Units.Last loop
528 if Fname = Units.Table (J).Unit_File_Name then
530 Write_Str (" file does not contain unit, Unit_Number = ");
531 Write_Int (Int (Unum));
536 if Present (Error_Node) then
537 if Is_Predefined_File_Name (Fname) then
538 Error_Msg_Unit_1 := Uname_Actual;
540 ("$$ is not a language defined unit", Load_Msg_Sloc);
542 Error_Msg_File_1 := Fname;
543 Error_Msg_Unit_1 := Uname_Actual;
544 Error_Msg ("File{ does not contain unit$", Load_Msg_Sloc);
547 Write_Dependency_Chain;
557 -- If we are proceeding with load, then make load stack entry,
558 -- and indicate the kind of with_clause responsible for the load.
560 Load_Stack.Increment_Last;
561 Load_Stack.Table (Load_Stack.Last) := (Unum, From_Limited_With);
563 -- Case of entry already in table
565 if Unum <= Units.Last then
567 -- Here is where we check for a circular dependency, which is
568 -- an attempt to load a unit which is currently in the process
569 -- of being loaded. We do *not* care about a circular chain that
570 -- leads back to a body, because this kind of circular dependence
571 -- legitimately occurs (e.g. two package bodies that contain
572 -- inlined subprogram referenced by the other).
574 -- Ada 2005 (AI-50217): We also ignore limited_with clauses, because
575 -- their purpose is precisely to create legal circular structures.
578 and then (Is_Spec_Name (Units.Table (Unum).Unit_Name)
579 or else Acts_As_Spec (Units.Table (Unum).Cunit))
580 and then (Nkind (Error_Node) /= N_With_Clause
581 or else not Limited_Present (Error_Node))
582 and then not From_Limited_With_Chain (From_Limited_With)
585 Write_Str (" circular dependency encountered");
589 if Present (Error_Node) then
590 Error_Msg ("circular unit dependency", Load_Msg_Sloc);
591 Write_Dependency_Chain;
593 Load_Stack.Decrement_Last;
600 Write_Str (" unit already in file table, Unit_Number = ");
601 Write_Int (Int (Unum));
605 Load_Stack.Decrement_Last;
608 -- Unit is not already in table, so try to open the file
612 Write_Str (" attempt unit load, Unit_Number = ");
613 Write_Int (Int (Unum));
617 Src_Ind := Load_Source_File (Fname);
619 -- Make a partial entry in the file table, used even in the file not
620 -- found case to print the dependency chain including the last entry
622 Units.Increment_Last;
623 Units.Table (Unum).Unit_Name := Uname_Actual;
627 if Src_Ind /= No_Source_File then
628 Units.Table (Unum) := (
630 Cunit_Entity => Empty,
632 Dynamic_Elab => False,
633 Error_Location => Sloc (Error_Node),
634 Expected_Unit => Uname_Actual,
635 Fatal_Error => False,
636 Generate_Code => False,
638 Ident_String => Empty,
640 Main_Priority => Default_Main_Priority,
643 Source_Index => Src_Ind,
644 Unit_File_Name => Fname,
645 Unit_Name => Uname_Actual,
646 Version => Source_Checksum (Src_Ind));
648 -- Parse the new unit
651 Save_Index : constant Nat := Multiple_Unit_Index;
653 Multiple_Unit_Index := Get_Unit_Index (Uname_Actual);
654 Units.Table (Unum).Munit_Index := Multiple_Unit_Index;
655 Initialize_Scanner (Unum, Source_Index (Unum));
656 Discard_List (Par (Configuration_Pragmas => False,
657 From_Limited_With => From_Limited_With));
658 Multiple_Unit_Index := Save_Index;
659 Set_Loading (Unum, False);
662 -- If spec is irrelevant, then post errors and quit
664 if Corr_Body /= No_Unit
665 and then Spec_Is_Irrelevant (Unum, Corr_Body)
667 Error_Msg_File_1 := Unit_File_Name (Corr_Body);
669 ("cannot compile subprogram in file {!", Load_Msg_Sloc);
670 Error_Msg_File_1 := Unit_File_Name (Unum);
672 ("\incorrect spec in file { must be removed first!",
677 -- If loaded unit had a fatal error, then caller inherits it!
679 if Units.Table (Unum).Fatal_Error
680 and then Present (Error_Node)
682 Units.Table (Calling_Unit).Fatal_Error := True;
685 -- Remove load stack entry and return the entry in the file table
687 Load_Stack.Decrement_Last;
690 -- Case of file not found
694 Write_Str (" file was not found, load failed");
698 -- Generate message if unit required
700 if Required and then Present (Error_Node) then
701 if Is_Predefined_File_Name (Fname) then
703 -- This is a predefined library unit which is not present
704 -- in the run time. If a predefined unit is not available
705 -- it may very likely be the case that there is also pragma
706 -- Restriction forbidding its usage. This is typically the
707 -- case when building a configurable run time, where the
708 -- usage of certain run-time units units is restricted by
709 -- means of both the corresponding pragma Restriction (such
710 -- as No_Calendar), and by not including the unit. Hence,
711 -- we check whether this predefined unit is forbidden, so
712 -- that the message about the restriction violation is
713 -- generated, if needed.
715 Check_Restricted_Unit (Load_Name, Error_Node);
717 Error_Msg_Unit_1 := Uname_Actual;
719 ("$$ is not a predefined library unit", Load_Msg_Sloc);
722 Error_Msg_File_1 := Fname;
723 Error_Msg ("file{ not found", Load_Msg_Sloc);
726 Write_Dependency_Chain;
728 -- Remove unit from stack, to avoid cascaded errors on
729 -- subsequent missing files.
731 Load_Stack.Decrement_Last;
732 Units.Decrement_Last;
734 -- If unit not required, remove load stack entry and the junk
735 -- file table entry, and return No_Unit to indicate not found,
738 Load_Stack.Decrement_Last;
739 Units.Decrement_Last;
747 ------------------------
748 -- Make_Instance_Unit --
749 ------------------------
751 -- If the unit is an instance, it appears as a package declaration, but
752 -- contains both declaration and body of the instance. The body becomes
753 -- the main unit of the compilation, and the declaration is inserted
754 -- at the end of the unit table. The main unit now has the name of a
755 -- body, which is constructed from the name of the original spec,
756 -- and is attached to the compilation node of the original unit. The
757 -- declaration has been attached to a new compilation unit node, and
758 -- code will have to be generated for it.
760 procedure Make_Instance_Unit (N : Node_Id) is
761 Sind : constant Source_File_Index := Source_Index (Main_Unit);
763 Units.Increment_Last;
764 Units.Table (Units.Last) := Units.Table (Main_Unit);
765 Units.Table (Units.Last).Cunit := Library_Unit (N);
766 Units.Table (Units.Last).Generate_Code := True;
767 Units.Table (Main_Unit).Cunit := N;
768 Units.Table (Main_Unit).Unit_Name :=
769 Get_Body_Name (Unit_Name (Get_Cunit_Unit_Number (Library_Unit (N))));
770 Units.Table (Main_Unit).Version := Source_Checksum (Sind);
771 end Make_Instance_Unit;
773 ------------------------
774 -- Spec_Is_Irrelevant --
775 ------------------------
777 function Spec_Is_Irrelevant
778 (Spec_Unit : Unit_Number_Type;
779 Body_Unit : Unit_Number_Type) return Boolean
781 Sunit : constant Node_Id := Cunit (Spec_Unit);
782 Bunit : constant Node_Id := Cunit (Body_Unit);
785 -- The spec is irrelevant if the body is a subprogram body, and the
786 -- spec is other than a subprogram spec or generic subprogram spec.
787 -- Note that the names must be the same, we don't need to check that,
788 -- because we already know that from the fact that the file names are
792 Nkind (Unit (Bunit)) = N_Subprogram_Body
793 and then Nkind (Unit (Sunit)) /= N_Subprogram_Declaration
794 and then Nkind (Unit (Sunit)) /= N_Generic_Subprogram_Declaration;
795 end Spec_Is_Irrelevant;
801 procedure Version_Update (U : Node_Id; From : Node_Id) is
802 Unum : constant Unit_Number_Type := Get_Cunit_Unit_Number (U);
803 Fnum : constant Unit_Number_Type := Get_Cunit_Unit_Number (From);
805 if Source_Index (Fnum) /= No_Source_File then
806 Units.Table (Unum).Version :=
807 Units.Table (Unum).Version
809 Source_Checksum (Source_Index (Fnum));
813 ----------------------------
814 -- Write_Dependency_Chain --
815 ----------------------------
817 procedure Write_Dependency_Chain is
819 -- The dependency chain is only written if it is at least two entries
820 -- deep, otherwise it is trivial (the main unit depending on a unit
821 -- that it obviously directly depends on).
823 if Load_Stack.Last - 1 > Load_Stack.First then
824 for U in Load_Stack.First .. Load_Stack.Last - 1 loop
826 Unit_Name (Load_Stack.Table (U).Unit_Number);
828 Unit_Name (Load_Stack.Table (U + 1).Unit_Number);
829 Error_Msg ("$ depends on $!", Load_Msg_Sloc);
832 end Write_Dependency_Chain;