1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2019, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Casing; use Casing;
28 with Csets; use Csets;
29 with Debug; use Debug;
30 with Einfo; use Einfo;
31 with Elists; use Elists;
32 with Errout; use Errout;
34 with Fname; use Fname;
35 with Fname.UF; use Fname.UF;
36 with Ghost; use Ghost;
38 with Lib.Load; use Lib.Load;
39 with Namet; use Namet;
40 with Nlists; use Nlists;
41 with Nmake; use Nmake;
42 with Output; use Output;
44 with Restrict; use Restrict;
46 with Sem_Aux; use Sem_Aux;
47 with Sem_Ch7; use Sem_Ch7;
48 with Sem_Dist; use Sem_Dist;
49 with Sem_Util; use Sem_Util;
50 with Sinfo; use Sinfo;
51 with Stand; use Stand;
52 with Snames; use Snames;
53 with Tbuild; use Tbuild;
54 with Uname; use Uname;
56 package body Rtsfind is
58 RTE_Available_Call : Boolean := False;
59 -- Set True during call to RTE from RTE_Available (or from call to
60 -- RTE_Record_Component from RTE_Record_Component_Available). Tells
61 -- the called subprogram to set RTE_Is_Available to False rather than
62 -- generating an error message.
64 RTE_Is_Available : Boolean;
65 -- Set True by RTE_Available on entry. When RTE_Available_Call is set
66 -- True, set False if RTE would otherwise generate an error message.
72 -- The unit table has one entry for each unit included in the definition
73 -- of the type RTU_Id in the spec. The table entries are initialized in
74 -- Initialize to set the Entity field to Empty, indicating that the
75 -- corresponding unit has not yet been loaded. The fields are set when
76 -- a unit is loaded to contain the defining entity for the unit, the
77 -- unit name, and the unit number.
79 -- Note that a unit can be loaded either by a call to find an entity
80 -- within the unit (e.g. RTE), or by an explicit with of the unit. In
81 -- the latter case it is critical to make a call to Set_RTU_Loaded to
82 -- ensure that the entry in this table reflects the load.
84 -- A unit retrieved through rtsfind may end up in the context of several
85 -- other units, in addition to the main unit. These additional with_clauses
86 -- are needed to generate a proper traversal order for CodePeer. To
87 -- minimize somewhat the redundancy created by numerous calls to rtsfind
88 -- from different units, we keep track of the list of implicit with_clauses
89 -- already created for the current loaded unit.
91 type RT_Unit_Table_Record is record
93 Uname : Unit_Name_Type;
94 First_Implicit_With : Node_Id;
95 Unum : Unit_Number_Type;
98 RT_Unit_Table : array (RTU_Id) of RT_Unit_Table_Record;
100 --------------------------
101 -- Runtime Entity Table --
102 --------------------------
104 -- There is one entry in the runtime entity table for each entity that is
105 -- included in the definition of the RE_Id type in the spec. The entries
106 -- are set by Initialize_Rtsfind to contain Empty, indicating that the
107 -- entity has not yet been located. Once the entity is located for the
108 -- first time, its ID is stored in this array, so that subsequent calls
109 -- for the same entity can be satisfied immediately.
111 -- NOTE: In order to avoid conflicts between record components and subprgs
112 -- that have the same name (i.e. subprogram External_Tag and
113 -- component External_Tag of package Ada.Tags) this table is not used
114 -- with Record_Components.
116 RE_Table : array (RE_Id) of Entity_Id;
118 --------------------------------
119 -- Generation of with_clauses --
120 --------------------------------
122 -- When a unit is implicitly loaded as a result of a call to RTE, it is
123 -- necessary to create one or two implicit with_clauses. We add such
124 -- with_clauses to the extended main unit if needed, and also to whatever
125 -- unit needs them, which is not necessarily the main unit. The former
126 -- ensures that the object is correctly loaded by the binder. The latter
127 -- is necessary for CodePeer.
129 -- The field First_Implicit_With in the unit table record are used to
130 -- avoid creating duplicate with_clauses.
132 ----------------------------------------------
133 -- Table of Predefined RE_Id Error Messages --
134 ----------------------------------------------
136 -- If an attempt is made to load an entity, given an RE_Id value, and the
137 -- entity is not available in the current configuration, an error message
138 -- is given (see Entity_Not_Defined below). The general form of such an
139 -- error message is for example:
141 -- entity "System.Pack_43.Bits_43" not defined
143 -- The following table defines a set of RE_Id image values for which this
144 -- error message is specialized and replaced by specific text indicating
145 -- the exact message to be output. For example, in the case above, for the
146 -- RE_Id value RE_Bits_43, we do indeed specialize the message, and the
147 -- above generic message is replaced by:
149 -- packed component size of 43 is not supported
151 type CString_Ptr is access constant String;
153 type PRE_Id_Entry is record
155 -- Pointer to string with the RE_Id image. The sequence ?? may appear
156 -- in which case it will match any characters in the RE_Id image value.
157 -- This is used to avoid the need for dozens of entries for RE_Bits_??.
160 -- Pointer to string with the corresponding error text. The sequence
161 -- ?? may appear, in which case, it is replaced by the corresponding
162 -- sequence ?? in the Str value (if the first ? is zero, then it is
163 -- omitted from the message).
166 Str1 : aliased constant String := "RE_BITS_??";
167 Str2 : aliased constant String := "RE_GET_??";
168 Str3 : aliased constant String := "RE_SET_??";
169 Str4 : aliased constant String := "RE_CALL_SIMPLE";
171 MsgPack : aliased constant String :=
172 "packed component size of ?? is not supported";
173 MsgRV : aliased constant String :=
174 "task rendezvous is not supported";
176 PRE_Id_Table : constant array (Natural range <>) of PRE_Id_Entry :=
177 (1 => (Str1'Access, MsgPack'Access),
178 2 => (Str2'Access, MsgPack'Access),
179 3 => (Str3'Access, MsgPack'Access),
180 4 => (Str4'Access, MsgRV'Access));
181 -- We will add entries to this table as we find cases where it is a good
182 -- idea to do so. By no means all the RE_Id values need entries, because
183 -- the expander often gives clear messages before it makes the Rtsfind
184 -- call expecting to find the entity.
186 -----------------------
187 -- Local Subprograms --
188 -----------------------
190 function Check_CRT (E : RE_Id; Eid : Entity_Id) return Entity_Id;
191 -- Check entity Eid to ensure that configurable run-time restrictions are
192 -- met. May generate an error message (if RTE_Available_Call is false) and
193 -- raise RE_Not_Available if entity E does not exist (e.g. Eid is Empty).
194 -- Also check that entity is not overloaded.
196 procedure Entity_Not_Defined (Id : RE_Id);
197 -- Outputs error messages for an entity that is not defined in the run-time
198 -- library (the form of the error message is tailored for no run time or
199 -- configurable run time mode as required). See also table of pre-defined
200 -- messages for entities above (RE_Id_Messages).
202 function Get_Unit_Name (U_Id : RTU_Id) return Unit_Name_Type;
203 -- Retrieves the Unit Name given a unit id represented by its enumeration
206 procedure Load_Fail (S : String; U_Id : RTU_Id; Id : RE_Id);
207 pragma No_Return (Load_Fail);
208 -- Internal procedure called if we can't successfully locate or process a
209 -- run-time unit. The parameters give information about the error message
210 -- to be given. S is a reason for failing to compile the file and U_Id is
211 -- the unit id. RE_Id is the RE_Id originally passed to RTE. The message in
212 -- S is one of the following:
215 -- "had parser errors"
216 -- "had semantic errors"
218 -- The "not found" case is treated specially in that it is considered
219 -- a normal situation in configurable run-time mode, and generates
220 -- a warning, but is otherwise ignored.
224 Id : RE_Id := RE_Null;
225 Use_Setting : Boolean := False);
226 -- Load the unit whose Id is given if not already loaded. The unit is
227 -- loaded and analyzed, and the entry in RT_Unit_Table is updated to
228 -- reflect the load. Use_Setting is used to indicate the initial setting
229 -- for the Is_Potentially_Use_Visible flag of the entity for the loaded
230 -- unit (if it is indeed loaded). A value of False means nothing special
231 -- need be done. A value of True indicates that this flag must be set to
232 -- True. It is needed only in the Check_Text_IO_Special_Unit procedure,
233 -- which may materialize an entity of Text_IO (or [Wide_]Wide_Text_IO) that
234 -- was previously unknown. Id is the RE_Id value of the entity which was
235 -- originally requested. Id is used only for error message detail, and if
236 -- it is RE_Null, then the attempt to output the entity name is ignored.
238 function Make_Unit_Name
239 (U : RT_Unit_Table_Record;
240 N : Node_Id) return Node_Id;
241 -- If the unit is a child unit, build fully qualified name for use in
244 procedure Maybe_Add_With (U : in out RT_Unit_Table_Record);
245 -- If necessary, add an implicit with_clause from the current unit to the
246 -- one represented by U.
248 procedure Output_Entity_Name (Id : RE_Id; Msg : String);
249 -- Output continuation error message giving qualified name of entity
250 -- corresponding to Id, appending the string given by Msg.
252 function RE_Chars (E : RE_Id) return Name_Id;
253 -- Given a RE_Id value returns the Chars of the corresponding entity
255 procedure RTE_Error_Msg (Msg : String);
256 -- Generates a message by calling Error_Msg_N specifying Current_Error_Node
257 -- as the node location using the given Msg text. Special processing in the
258 -- case where RTE_Available_Call is set. In this case, no message is output
259 -- and instead RTE_Is_Available is set to False. Note that this can only be
260 -- used if you are sure that the message comes directly or indirectly from
261 -- a call to the RTE function.
267 function Check_CRT (E : RE_Id; Eid : Entity_Id) return Entity_Id is
268 U_Id : constant RTU_Id := RE_Unit_Table (E);
272 if RTE_Available_Call then
273 RTE_Is_Available := False;
275 Entity_Not_Defined (E);
278 raise RE_Not_Available;
280 -- Entity is available
283 -- If in No_Run_Time mode and entity is neither in the current unit
284 -- nor in one of the specially permitted units, raise the exception.
287 and then not OK_No_Run_Time_Unit (U_Id)
289 -- If the entity being referenced is defined in the current scope,
290 -- using it is always fine as such usage can never introduce any
291 -- dependency on an additional unit. The presence of this test
292 -- helps generating meaningful error messages for CRT violations.
294 and then Scope (Eid) /= Current_Scope
296 Entity_Not_Defined (E);
297 raise RE_Not_Available;
300 -- Check entity is not overloaded, checking for special exceptions
303 and then E /= RE_Save_Occurrence
306 Write_Str ("Run-time configuration error (");
307 Write_Str ("rtsfind entity """);
308 Get_Decoded_Name_String (Chars (Eid));
309 Set_Casing (Mixed_Case);
310 Write_Str (Name_Buffer (1 .. Name_Len));
311 Write_Str (""" is overloaded)");
313 raise Unrecoverable_Error;
316 -- Otherwise entity is accessible
322 --------------------------------
323 -- Check_Text_IO_Special_Unit --
324 --------------------------------
326 procedure Check_Text_IO_Special_Unit (Nam : Node_Id) is
329 type Name_Map_Type is array (Text_IO_Package_Name) of RTU_Id;
331 Name_Map : constant Name_Map_Type := Name_Map_Type'(
332 Name_Decimal_IO => Ada_Text_IO_Decimal_IO,
333 Name_Enumeration_IO => Ada_Text_IO_Enumeration_IO,
334 Name_Fixed_IO => Ada_Text_IO_Fixed_IO,
335 Name_Float_IO => Ada_Text_IO_Float_IO,
336 Name_Integer_IO => Ada_Text_IO_Integer_IO,
337 Name_Modular_IO => Ada_Text_IO_Modular_IO);
339 Wide_Name_Map : constant Name_Map_Type := Name_Map_Type'(
340 Name_Decimal_IO => Ada_Wide_Text_IO_Decimal_IO,
341 Name_Enumeration_IO => Ada_Wide_Text_IO_Enumeration_IO,
342 Name_Fixed_IO => Ada_Wide_Text_IO_Fixed_IO,
343 Name_Float_IO => Ada_Wide_Text_IO_Float_IO,
344 Name_Integer_IO => Ada_Wide_Text_IO_Integer_IO,
345 Name_Modular_IO => Ada_Wide_Text_IO_Modular_IO);
347 Wide_Wide_Name_Map : constant Name_Map_Type := Name_Map_Type'(
348 Name_Decimal_IO => Ada_Wide_Wide_Text_IO_Decimal_IO,
349 Name_Enumeration_IO => Ada_Wide_Wide_Text_IO_Enumeration_IO,
350 Name_Fixed_IO => Ada_Wide_Wide_Text_IO_Fixed_IO,
351 Name_Float_IO => Ada_Wide_Wide_Text_IO_Float_IO,
352 Name_Integer_IO => Ada_Wide_Wide_Text_IO_Integer_IO,
353 Name_Modular_IO => Ada_Wide_Wide_Text_IO_Modular_IO);
356 -- Unit to be loaded, from one of the above maps
359 -- Nothing to do if name is not an identifier or a selected component
360 -- whose selector_name is an identifier.
362 if Nkind (Nam) = N_Identifier then
365 elsif Nkind (Nam) = N_Selected_Component
366 and then Nkind (Selector_Name (Nam)) = N_Identifier
368 Chrs := Chars (Selector_Name (Nam));
374 -- Nothing to do if name is not one of the Text_IO subpackages
375 -- Otherwise look through loaded units, and if we find Text_IO
376 -- or [Wide_]Wide_Text_IO already loaded, then load the proper child.
378 if Chrs in Text_IO_Package_Name then
379 for U in Main_Unit .. Last_Unit loop
380 Get_Name_String (Unit_File_Name (U));
382 if Name_Len = 12 then
384 -- Here is where we do the loads if we find one of the units
385 -- Ada.Text_IO or Ada.[Wide_]Wide_Text_IO. An interesting
386 -- detail is that these units may already be used (i.e. their
387 -- In_Use flags may be set). Normally when the In_Use flag is
388 -- set, the Is_Potentially_Use_Visible flag of all entities in
389 -- the package is set, but the new entity we are mysteriously
390 -- adding was not there to have its flag set at the time. So
391 -- that's why we pass the extra parameter to RTU_Find, to make
392 -- sure the flag does get set now. Given that those generic
393 -- packages are in fact child units, we must indicate that
396 if Name_Buffer (1 .. 12) = "a-textio.ads" then
397 To_Load := Name_Map (Chrs);
399 elsif Name_Buffer (1 .. 12) = "a-witeio.ads" then
400 To_Load := Wide_Name_Map (Chrs);
402 elsif Name_Buffer (1 .. 12) = "a-ztexio.ads" then
403 To_Load := Wide_Wide_Name_Map (Chrs);
409 Load_RTU (To_Load, Use_Setting => In_Use (Cunit_Entity (U)));
410 Set_Is_Visible_Lib_Unit (RT_Unit_Table (To_Load).Entity);
412 -- Prevent creation of an implicit 'with' from (for example)
413 -- Ada.Wide_Text_IO.Integer_IO to Ada.Text_IO.Integer_IO,
414 -- because these could create cycles. First check whether the
415 -- simple names match ("integer_io" = "integer_io"), and then
416 -- check whether the parent is indeed one of the
417 -- [[Wide_]Wide_]Text_IO packages.
419 if Chrs = Chars (Cunit_Entity (Current_Sem_Unit)) then
421 Parent_Name : constant Unit_Name_Type :=
423 (Unit_Name (Current_Sem_Unit));
426 if Parent_Name /= No_Unit_Name then
427 Get_Name_String (Parent_Name);
430 P : String renames Name_Buffer (1 .. Name_Len);
432 if P = "ada.text_io%s" or else
433 P = "ada.wide_text_io%s" or else
434 P = "ada.wide_wide_text_io%s"
443 -- Add an implicit with clause from the current unit to the
444 -- [[Wide_]Wide_]Text_IO child (if necessary).
446 Maybe_Add_With (RT_Unit_Table (To_Load));
454 -- Generate error message if run-time unit not available
456 when RE_Not_Available =>
457 Error_Msg_N ("& not available", Nam);
458 end Check_Text_IO_Special_Unit;
460 ------------------------
461 -- Entity_Not_Defined --
462 ------------------------
464 procedure Entity_Not_Defined (Id : RE_Id) is
466 if No_Run_Time_Mode then
468 -- If the error occurs when compiling the body of a predefined
469 -- unit for inlining purposes, the body must be illegal in this
470 -- mode, and there is no point in continuing.
472 if In_Predefined_Unit (Current_Error_Node) then
474 ("construct not allowed in no run time mode!",
476 raise Unrecoverable_Error;
479 RTE_Error_Msg ("|construct not allowed in no run time mode");
482 elsif Configurable_Run_Time_Mode then
483 RTE_Error_Msg ("|construct not allowed in this configuration>");
485 RTE_Error_Msg ("run-time configuration error");
488 -- See if this entry is to be found in the PRE_Id table that provides
489 -- specialized messages for some RE_Id values.
491 for J in PRE_Id_Table'Range loop
493 TStr : constant String := PRE_Id_Table (J).Str.all;
494 RStr : constant String := RE_Id'Image (Id);
495 TMsg : String := PRE_Id_Table (J).Msg.all;
496 LMsg : Natural := TMsg'Length;
499 if TStr'Length = RStr'Length then
500 for J in TStr'Range loop
501 if TStr (J) /= RStr (J) and then TStr (J) /= '?' then
506 for J in TMsg'First .. TMsg'Last - 1 loop
507 if TMsg (J) = '?' then
508 for K in 1 .. TStr'Last loop
509 if TStr (K) = '?' then
510 if RStr (K) = '0' then
511 TMsg (J) := RStr (K + 1);
512 TMsg (J + 1 .. LMsg - 1) := TMsg (J + 2 .. LMsg);
515 TMsg (J .. J + 1) := RStr (K .. K + 1);
524 RTE_Error_Msg (TMsg (1 .. LMsg));
532 -- We did not find an entry in the table, so output the generic entity
533 -- not found message, where the name of the entity corresponds to the
534 -- given RE_Id value.
536 Output_Entity_Name (Id, "not defined");
537 end Entity_Not_Defined;
543 function Get_Unit_Name (U_Id : RTU_Id) return Unit_Name_Type is
544 Uname_Chars : constant String := RTU_Id'Image (U_Id);
547 Name_Len := Uname_Chars'Length;
548 Name_Buffer (1 .. Name_Len) := Uname_Chars;
549 Set_Casing (All_Lower_Case);
551 if U_Id in Ada_Child then
552 Name_Buffer (4) := '.';
554 if U_Id in Ada_Calendar_Child then
555 Name_Buffer (13) := '.';
557 elsif U_Id in Ada_Dispatching_Child then
558 Name_Buffer (16) := '.';
560 elsif U_Id in Ada_Interrupts_Child then
561 Name_Buffer (15) := '.';
563 elsif U_Id in Ada_Numerics_Child then
564 Name_Buffer (13) := '.';
566 elsif U_Id in Ada_Real_Time_Child then
567 Name_Buffer (14) := '.';
569 elsif U_Id in Ada_Streams_Child then
570 Name_Buffer (12) := '.';
572 elsif U_Id in Ada_Strings_Child then
573 Name_Buffer (12) := '.';
575 elsif U_Id in Ada_Text_IO_Child then
576 Name_Buffer (12) := '.';
578 elsif U_Id in Ada_Wide_Text_IO_Child then
579 Name_Buffer (17) := '.';
581 elsif U_Id in Ada_Wide_Wide_Text_IO_Child then
582 Name_Buffer (22) := '.';
585 elsif U_Id in Interfaces_Child then
586 Name_Buffer (11) := '.';
588 elsif U_Id in System_Child then
589 Name_Buffer (7) := '.';
591 if U_Id in System_Dim_Child then
592 Name_Buffer (11) := '.';
595 if U_Id in System_Multiprocessors_Child then
596 Name_Buffer (23) := '.';
599 if U_Id in System_Storage_Pools_Child then
600 Name_Buffer (21) := '.';
603 if U_Id in System_Strings_Child then
604 Name_Buffer (15) := '.';
607 if U_Id in System_Tasking_Child then
608 Name_Buffer (15) := '.';
611 if U_Id in System_Tasking_Restricted_Child then
612 Name_Buffer (26) := '.';
615 if U_Id in System_Tasking_Protected_Objects_Child then
616 Name_Buffer (33) := '.';
619 if U_Id in System_Tasking_Async_Delays_Child then
620 Name_Buffer (28) := '.';
624 -- Add %s at end for spec
626 Name_Buffer (Name_Len + 1) := '%';
627 Name_Buffer (Name_Len + 2) := 's';
628 Name_Len := Name_Len + 2;
637 procedure Initialize is
639 -- Initialize the unit table
642 RT_Unit_Table (J).Entity := Empty;
643 RT_Unit_Table (J).First_Implicit_With := Empty;
647 RE_Table (J) := Empty;
650 RTE_Is_Available := False;
657 function Is_RTE (Ent : Entity_Id; E : RE_Id) return Boolean is
658 E_Unit_Name : Unit_Name_Type;
659 Ent_Unit_Name : Unit_Name_Type;
669 -- If E has already a corresponding entity, check it directly,
670 -- going to full views if they exist to deal with the incomplete
671 -- and private type cases properly.
673 elsif Present (RE_Table (E)) then
676 if Is_Type (E1) and then Present (Full_View (E1)) then
677 E1 := Full_View (E1);
682 if Is_Type (E2) and then Present (Full_View (E2)) then
683 E2 := Full_View (E2);
689 -- If the unit containing E is not loaded, we already know that the
690 -- entity we have cannot have come from this unit.
692 E_Unit_Name := Get_Unit_Name (RE_Unit_Table (E));
694 if not Is_Loaded (E_Unit_Name) then
698 -- Here the unit containing the entity is loaded. We have not made
699 -- an explicit call to RTE to get the entity in question, but we may
700 -- have obtained a reference to it indirectly from some other entity
701 -- in the same unit, or some other unit that references it.
703 -- Get the defining unit of the entity
707 if No (S) or else Ekind (S) /= E_Package then
711 Ent_Unit_Name := Get_Unit_Name (Unit_Declaration_Node (S));
713 -- If the defining unit of the entity we are testing is not the
714 -- unit containing E, then they cannot possibly match.
716 if Ent_Unit_Name /= E_Unit_Name then
720 -- If the units match, then compare the names (remember that no
721 -- overloading is permitted in entities fetched using Rtsfind).
723 if RE_Chars (E) = Chars (Ent) then
726 -- If front-end inlining is enabled, we may be within a body that
727 -- contains inlined functions, which has not been retrieved through
728 -- rtsfind, and therefore is not yet recorded in the RT_Unit_Table.
729 -- Add the unit information now, it must be fully available.
732 U : RT_Unit_Table_Record
733 renames RT_Unit_Table (RE_Unit_Table (E));
735 if No (U.Entity) then
737 U.Uname := E_Unit_Name;
738 U.Unum := Get_Source_Unit (S);
752 function Is_RTU (Ent : Entity_Id; U : RTU_Id) return Boolean is
753 E : constant Entity_Id := RT_Unit_Table (U).Entity;
755 return Present (E) and then E = Ent;
758 -----------------------------
759 -- Is_Text_IO_Special_Unit --
760 -----------------------------
762 function Is_Text_IO_Special_Unit (Nam : Node_Id) return Boolean is
767 if Nkind (Nam) /= N_Expanded_Name then
772 Sel := Selector_Name (Nam);
774 if Nkind (Sel) /= N_Expanded_Name
775 or else Nkind (Prf) /= N_Identifier
776 or else Chars (Prf) /= Name_Ada
782 Sel := Selector_Name (Sel);
785 Nkind (Prf) = N_Identifier
787 Nam_In (Chars (Prf), Name_Text_IO,
789 Name_Wide_Wide_Text_IO)
790 and then Nkind (Sel) = N_Identifier
791 and then Chars (Sel) in Text_IO_Package_Name;
792 end Is_Text_IO_Special_Unit;
798 procedure Load_Fail (S : String; U_Id : RTU_Id; Id : RE_Id) is
799 M : String (1 .. 100);
803 -- Output header message
805 if Configurable_Run_Time_Mode then
806 RTE_Error_Msg ("construct not allowed in configurable run-time mode");
808 RTE_Error_Msg ("run-time library configuration error");
811 -- Output file name and reason string
813 M (1 .. 6) := "\file ";
817 (Get_File_Name (RT_Unit_Table (U_Id).Uname, Subunit => False));
818 M (P + 1 .. P + Name_Len) := Name_Buffer (1 .. Name_Len);
824 M (P + 1 .. P + S'Length) := S;
827 RTE_Error_Msg (M (1 .. P));
829 -- Output entity name
831 Output_Entity_Name (Id, "not available");
833 -- In configurable run time mode, we raise RE_Not_Available, and the
834 -- caller is expected to deal gracefully with this. In the case of a
835 -- call to RTE_Available, this exception will be caught in Rtsfind,
836 -- and result in a returned value of False for the call.
838 if Configurable_Run_Time_Mode then
839 raise RE_Not_Available;
841 -- Here we have a load failure in normal full run time mode. See if we
842 -- are in the context of an RTE_Available call. If so, we just raise
843 -- RE_Not_Available. This can happen if a unit is unavailable, which
844 -- happens for example in the VM case, where the run-time is not
845 -- complete, but we do not regard it as a configurable run-time.
846 -- If the caller has done an explicit call to RTE_Available, then
847 -- clearly the caller is prepared to deal with a result of False.
849 elsif RTE_Available_Call then
850 RTE_Is_Available := False;
851 raise RE_Not_Available;
853 -- If we are not in the context of an RTE_Available call, we are really
854 -- trying to load an entity that is not there, and that should never
855 -- happen, so in this case we signal a fatal error.
858 raise Unrecoverable_Error;
866 -- WARNING: This routine manages Ghost and SPARK regions. Return statements
867 -- must be replaced by gotos which jump to the end of the routine in order
868 -- to restore the Ghost and SPARK modes.
872 Id : RE_Id := RE_Null;
873 Use_Setting : Boolean := False)
875 U : RT_Unit_Table_Record renames RT_Unit_Table (U_Id);
876 Priv_Par : constant Elist_Id := New_Elmt_List;
879 procedure Save_Private_Visibility;
880 -- If the current unit is the body of child unit or the spec of a
881 -- private child unit, the private declarations of the parent(s) are
882 -- visible. If the unit to be loaded is another public sibling, its
883 -- compilation will affect the visibility of the common ancestors.
884 -- Indicate those that must be restored.
886 procedure Restore_Private_Visibility;
887 -- Restore the visibility of ancestors after compiling RTU
889 --------------------------------
890 -- Restore_Private_Visibility --
891 --------------------------------
893 procedure Restore_Private_Visibility is
897 E_Par := First_Elmt (Priv_Par);
898 while Present (E_Par) loop
899 if not In_Private_Part (Node (E_Par)) then
900 Install_Private_Declarations (Node (E_Par));
905 end Restore_Private_Visibility;
907 -----------------------------
908 -- Save_Private_Visibility --
909 -----------------------------
911 procedure Save_Private_Visibility is
915 Par := Scope (Current_Scope);
917 and then Par /= Standard_Standard
919 if Ekind (Par) = E_Package
920 and then Is_Compilation_Unit (Par)
921 and then In_Private_Part (Par)
923 Append_Elmt (Par, Priv_Par);
928 end Save_Private_Visibility;
932 Saved_GM : constant Ghost_Mode_Type := Ghost_Mode;
933 Saved_IGR : constant Node_Id := Ignored_Ghost_Region;
934 Saved_SM : constant SPARK_Mode_Type := SPARK_Mode;
935 Saved_SMP : constant Node_Id := SPARK_Mode_Pragma;
936 -- Save Ghost and SPARK mode-related data to restore on exit
938 -- Start of processing for Load_RTU
941 -- Nothing to do if unit is already loaded
943 if Present (U.Entity) then
947 -- Provide a clean environment for the unit
949 Install_Ghost_Region (None, Empty);
950 Install_SPARK_Mode (None, Empty);
952 -- Otherwise we need to load the unit, First build unit name from the
953 -- enumeration literal name in type RTU_Id.
955 U.Uname := Get_Unit_Name (U_Id);
956 U.First_Implicit_With := Empty;
958 -- Now do the load call, note that setting Error_Node to Empty is a
959 -- signal to Load_Unit that we will regard a failure to find the file as
960 -- a fatal error, and that it should not output any kind of diagnostics,
961 -- since we will take care of it here.
963 -- We save style checking switches and turn off style checking for
964 -- loading the unit, since we don't want any style checking.
967 Save_Style_Check : constant Boolean := Style_Check;
969 Style_Check := False;
972 (Load_Name => U.Uname,
975 Error_Node => Empty);
976 Style_Check := Save_Style_Check;
979 -- Check for bad unit load
981 if U.Unum = No_Unit then
982 Load_Fail ("not found", U_Id, Id);
983 elsif Fatal_Error (U.Unum) = Error_Detected then
984 Load_Fail ("had parser errors", U_Id, Id);
987 -- Make sure that the unit is analyzed
990 Was_Analyzed : constant Boolean :=
991 Analyzed (Cunit (Current_Sem_Unit));
994 -- Pretend that the current unit is analyzed, in case it is System
995 -- or some such. This allows us to put some declarations, such as
996 -- exceptions and packed arrays of Boolean, into System even though
997 -- expanding them requires System...
999 -- This is a bit odd but works fine. If the RTS unit does not depend
1000 -- in any way on the current unit, then it never gets back into the
1001 -- current unit's tree, and the change we make to the current unit
1002 -- tree is never noticed by anyone (it is undone in a moment). That
1003 -- is the normal situation.
1005 -- If the RTS Unit *does* depend on the current unit, for instance,
1006 -- when you are compiling System, then you had better have finished
1007 -- analyzing the part of System that is depended on before you try to
1008 -- load the RTS Unit. This means having the code in System ordered in
1009 -- an appropriate manner.
1011 Set_Analyzed (Cunit (Current_Sem_Unit), True);
1013 if not Analyzed (Cunit (U.Unum)) then
1015 -- If the unit is already loaded through a limited_with_clause,
1016 -- the relevant entities must already be available. We do not
1017 -- want to load and analyze the unit because this would create
1018 -- a real semantic dependence when the purpose of the limited_with
1019 -- is precisely to avoid such.
1021 if From_Limited_With (Cunit_Entity (U.Unum)) then
1025 Save_Private_Visibility;
1026 Semantics (Cunit (U.Unum));
1027 Restore_Private_Visibility;
1029 if Fatal_Error (U.Unum) = Error_Detected then
1030 Load_Fail ("had semantic errors", U_Id, Id);
1035 -- Undo the pretence
1037 Set_Analyzed (Cunit (Current_Sem_Unit), Was_Analyzed);
1040 Lib_Unit := Unit (Cunit (U.Unum));
1041 U.Entity := Defining_Entity (Lib_Unit);
1044 Set_Is_Potentially_Use_Visible (U.Entity, True);
1047 Restore_Ghost_Region (Saved_GM, Saved_IGR);
1048 Restore_SPARK_Mode (Saved_SM, Saved_SMP);
1051 --------------------
1052 -- Make_Unit_Name --
1053 --------------------
1055 function Make_Unit_Name
1056 (U : RT_Unit_Table_Record;
1057 N : Node_Id) return Node_Id is
1063 Nam := New_Occurrence_Of (U.Entity, Standard_Location);
1064 Scop := Scope (U.Entity);
1066 if Nkind (N) = N_Defining_Program_Unit_Name then
1067 while Scop /= Standard_Standard loop
1069 Make_Expanded_Name (Standard_Location,
1070 Chars => Chars (U.Entity),
1071 Prefix => New_Occurrence_Of (Scop, Standard_Location),
1072 Selector_Name => Nam);
1073 Set_Entity (Nam, U.Entity);
1075 Scop := Scope (Scop);
1082 --------------------
1083 -- Maybe_Add_With --
1084 --------------------
1086 procedure Maybe_Add_With (U : in out RT_Unit_Table_Record) is
1088 -- We do not need to generate a with_clause for a call issued from
1089 -- RTE_Component_Available. However, for CodePeer, we need these
1090 -- additional with's, because for a sequence like "if RTE_Available (X)
1091 -- then ... RTE (X)" the RTE call fails to create some necessary with's.
1093 if RTE_Available_Call and not Generate_SCIL then
1097 -- Avoid creating directly self-referential with clauses
1099 if Current_Sem_Unit = U.Unum then
1103 -- Add the with_clause, if we have not already added an implicit with
1104 -- for this unit to the current compilation unit.
1107 LibUnit : constant Node_Id := Unit (Cunit (U.Unum));
1112 Clause := U.First_Implicit_With;
1113 while Present (Clause) loop
1114 if Parent (Clause) = Cunit (Current_Sem_Unit) then
1118 Clause := Next_Implicit_With (Clause);
1122 Make_With_Clause (Standard_Location,
1125 (U, Defining_Unit_Name (Specification (LibUnit))));
1127 Set_Corresponding_Spec (Withn, U.Entity);
1128 Set_First_Name (Withn);
1129 Set_Implicit_With (Withn);
1130 Set_Library_Unit (Withn, Cunit (U.Unum));
1131 Set_Next_Implicit_With (Withn, U.First_Implicit_With);
1133 U.First_Implicit_With := Withn;
1135 Mark_Rewrite_Insertion (Withn);
1136 Append (Withn, Context_Items (Cunit (Current_Sem_Unit)));
1137 Check_Restriction_No_Dependence (Name (Withn), Current_Error_Node);
1141 ------------------------
1142 -- Output_Entity_Name --
1143 ------------------------
1145 procedure Output_Entity_Name (Id : RE_Id; Msg : String) is
1146 M : String (1 .. 2048);
1148 -- M (1 .. P) is current message to be output
1150 RE_Image : constant String := RE_Id'Image (Id);
1152 -- RE_Image (S .. RE_Image'Last) is the name of the entity without the
1153 -- "RE_" or "RO_XX_" prefix.
1156 if Id = RE_Null then
1160 M (1 .. 9) := "\entity """;
1163 -- Add unit name to message, excluding %s or %b at end
1165 Get_Name_String (Get_Unit_Name (RE_Unit_Table (Id)));
1166 Name_Len := Name_Len - 2;
1167 Set_Casing (Mixed_Case);
1168 M (P + 1 .. P + Name_Len) := Name_Buffer (1 .. Name_Len);
1171 -- Add a qualifying period
1178 if RE_Image (2) = 'E' then
1187 -- Add entity name and closing quote to message
1189 Name_Len := RE_Image'Length - S + 1;
1190 Name_Buffer (1 .. Name_Len) := RE_Image (S .. RE_Image'Last);
1191 Set_Casing (Mixed_Case);
1192 M (P + 1 .. P + Name_Len) := Name_Buffer (1 .. Name_Len);
1201 M (P + 1 .. P + Msg'Length) := Msg;
1202 P := P + Msg'Length;
1204 -- Output message at current error node location
1206 RTE_Error_Msg (M (1 .. P));
1207 end Output_Entity_Name;
1213 function RE_Chars (E : RE_Id) return Name_Id is
1214 RE_Name_Chars : constant String := RE_Id'Image (E);
1217 -- Copy name skipping initial RE_ or RO_XX characters
1219 if RE_Name_Chars (1 .. 2) = "RE" then
1220 for J in 4 .. RE_Name_Chars'Last loop
1221 Name_Buffer (J - 3) := Fold_Lower (RE_Name_Chars (J));
1224 Name_Len := RE_Name_Chars'Length - 3;
1227 for J in 7 .. RE_Name_Chars'Last loop
1228 Name_Buffer (J - 6) := Fold_Lower (RE_Name_Chars (J));
1231 Name_Len := RE_Name_Chars'Length - 6;
1241 function RTE (E : RE_Id) return Entity_Id is
1242 procedure Check_RPC;
1243 -- Reject programs that make use of distribution features not supported
1244 -- on the current target. Also check that the PCS is compatible with the
1245 -- code generator version. On such targets (Vxworks, others?) we provide
1246 -- a minimal body for System.Rpc that only supplies an implementation of
1249 function Find_Local_Entity (E : RE_Id) return Entity_Id;
1250 -- This function is used when entity E is in this compilation's main
1251 -- unit. It gets the value from the already compiled declaration.
1257 procedure Check_RPC is
1259 -- Bypass this check if debug flag -gnatdR set
1261 if Debug_Flag_RR then
1265 -- Otherwise we need the check if we are going after one of the
1266 -- critical entities in System.RPC / System.Partition_Interface.
1272 E = RE_Params_Stream_Type
1274 E = RE_Request_Access
1276 -- If generating RCI stubs, check that we have a real PCS
1278 if (Distribution_Stub_Mode = Generate_Receiver_Stub_Body
1280 Distribution_Stub_Mode = Generate_Caller_Stub_Body)
1281 and then Get_PCS_Name = Name_No_DSA
1284 Write_Str ("distribution feature not supported");
1286 raise Unrecoverable_Error;
1288 -- In all cases, check Exp_Dist and System.Partition_Interface
1291 elsif Get_PCS_Version /=
1292 Exp_Dist.PCS_Version_Number (Get_PCS_Name)
1295 Write_Str ("PCS version mismatch: expander ");
1296 Write_Int (Exp_Dist.PCS_Version_Number (Get_PCS_Name));
1297 Write_Str (", PCS (");
1298 Write_Name (Get_PCS_Name);
1300 Write_Int (Get_PCS_Version);
1302 raise Unrecoverable_Error;
1307 -----------------------
1308 -- Find_Local_Entity --
1309 -----------------------
1311 function Find_Local_Entity (E : RE_Id) return Entity_Id is
1312 RE_Str : constant String := RE_Id'Image (E);
1316 Save_Nam : constant String := Name_Buffer (1 .. Name_Len);
1317 -- Save name buffer and length over call
1320 Name_Len := Natural'Max (0, RE_Str'Length - 3);
1321 Name_Buffer (1 .. Name_Len) :=
1322 RE_Str (RE_Str'First + 3 .. RE_Str'Last);
1325 Ent := Entity_Id (Get_Name_Table_Int (Nam));
1327 Name_Len := Save_Nam'Length;
1328 Name_Buffer (1 .. Name_Len) := Save_Nam;
1331 end Find_Local_Entity;
1335 U_Id : constant RTU_Id := RE_Unit_Table (E);
1336 U : RT_Unit_Table_Record renames RT_Unit_Table (U_Id);
1340 Pkg_Ent : Entity_Id;
1342 Save_Front_End_Inlining : constant Boolean := Front_End_Inlining;
1343 -- This flag is used to disable front-end inlining when RTE is invoked.
1344 -- This prevents the analysis of other runtime bodies when a particular
1345 -- spec is loaded through Rtsfind. This is both efficient, and prevents
1346 -- spurious visibility conflicts between use-visible user entities, and
1347 -- entities in run-time packages.
1349 -- Start of processing for RTE
1352 -- Doing a rtsfind in system.ads is special, as we cannot do this
1353 -- when compiling System itself. So if we are compiling system then
1354 -- we should already have acquired and processed the declaration
1355 -- of the entity. The test is to see if this compilation's main unit
1356 -- is System. If so, return the value from the already compiled
1357 -- declaration and otherwise do a regular find.
1359 -- Not pleasant, but these kinds of annoying recursion scenarios when
1360 -- writing an Ada compiler in Ada have to be broken somewhere.
1362 if Present (Main_Unit_Entity)
1363 and then Chars (Main_Unit_Entity) = Name_System
1364 and then Analyzed (Main_Unit_Entity)
1365 and then not Is_Child_Unit (Main_Unit_Entity)
1367 return Check_CRT (E, Find_Local_Entity (E));
1370 Front_End_Inlining := False;
1372 -- Load unit if unit not previously loaded
1374 if No (RE_Table (E)) then
1375 Load_RTU (U_Id, Id => E);
1376 Lib_Unit := Unit (Cunit (U.Unum));
1378 -- In the subprogram case, we are all done, the entity we want
1379 -- is the entity for the subprogram itself. Note that we do not
1380 -- bother to check that it is the entity that was requested.
1381 -- the only way that could fail to be the case is if runtime is
1382 -- hopelessly misconfigured, and it isn't worth testing for this.
1384 if Nkind (Lib_Unit) = N_Subprogram_Declaration then
1385 RE_Table (E) := U.Entity;
1387 -- Otherwise we must have the package case. First check package
1388 -- entity itself (e.g. RTE_Name for System.Interrupts.Name)
1391 pragma Assert (Nkind (Lib_Unit) = N_Package_Declaration);
1392 Ename := RE_Chars (E);
1394 -- First we search the package entity chain. If the package
1395 -- only has a limited view, scan the corresponding list of
1396 -- incomplete types.
1398 if From_Limited_With (U.Entity) then
1399 Pkg_Ent := First_Entity (Limited_View (U.Entity));
1401 Pkg_Ent := First_Entity (U.Entity);
1404 while Present (Pkg_Ent) loop
1405 if Ename = Chars (Pkg_Ent) then
1406 RE_Table (E) := Pkg_Ent;
1411 Next_Entity (Pkg_Ent);
1414 -- If we did not find the entity in the package entity chain,
1415 -- then check if the package entity itself matches. Note that
1416 -- we do this check after searching the entity chain, since
1417 -- the rule is that in case of ambiguity, we prefer the entity
1418 -- defined within the package, rather than the package itself.
1420 if Ename = Chars (U.Entity) then
1421 RE_Table (E) := U.Entity;
1424 -- If we didn't find the entity we want, something is wrong.
1425 -- We just leave RE_Table (E) set to Empty and the appropriate
1426 -- action will be taken by Check_CRT when we exit.
1433 -- Record whether the secondary stack is in use in order to generate
1434 -- the proper binder code. No action is taken when the secondary stack
1435 -- is pulled within an ignored Ghost context because all this code will
1438 if U_Id = System_Secondary_Stack and then Ghost_Mode /= Ignore then
1439 Sec_Stack_Used := True;
1443 Front_End_Inlining := Save_Front_End_Inlining;
1445 return Check_CRT (E, RE_Table (E));
1452 function RTE_Available (E : RE_Id) return Boolean is
1454 pragma Warnings (Off, Dummy);
1458 Save_RTE_Available_Call : constant Boolean := RTE_Available_Call;
1459 Save_RTE_Is_Available : constant Boolean := RTE_Is_Available;
1460 -- These are saved recursively because the call to load a unit
1461 -- caused by an upper level call may perform a recursive call
1462 -- to this routine during analysis of the corresponding unit.
1465 RTE_Available_Call := True;
1466 RTE_Is_Available := True;
1468 Result := RTE_Is_Available;
1469 RTE_Available_Call := Save_RTE_Available_Call;
1470 RTE_Is_Available := Save_RTE_Is_Available;
1474 when RE_Not_Available =>
1475 RTE_Available_Call := Save_RTE_Available_Call;
1476 RTE_Is_Available := Save_RTE_Is_Available;
1480 --------------------------
1481 -- RTE_Record_Component --
1482 --------------------------
1484 function RTE_Record_Component (E : RE_Id) return Entity_Id is
1485 U_Id : constant RTU_Id := RE_Unit_Table (E);
1486 U : RT_Unit_Table_Record renames RT_Unit_Table (U_Id);
1489 Found_E : Entity_Id;
1491 Pkg_Ent : Entity_Id;
1493 -- The following flag is used to disable front-end inlining when
1494 -- RTE_Record_Component is invoked. This prevents the analysis of other
1495 -- runtime bodies when a particular spec is loaded through Rtsfind. This
1496 -- is both efficient, and it prevents spurious visibility conflicts
1497 -- between use-visible user entities, and entities in run-time packages.
1499 Save_Front_End_Inlining : Boolean;
1502 -- Note: Contrary to subprogram RTE, there is no need to do any special
1503 -- management with package system.ads because it has no record type
1506 Save_Front_End_Inlining := Front_End_Inlining;
1507 Front_End_Inlining := False;
1509 -- Load unit if unit not previously loaded
1511 if not Present (U.Entity) then
1512 Load_RTU (U_Id, Id => E);
1515 Lib_Unit := Unit (Cunit (U.Unum));
1517 pragma Assert (Nkind (Lib_Unit) = N_Package_Declaration);
1518 Ename := RE_Chars (E);
1520 -- Search the entity in the components of record type declarations
1521 -- found in the package entity chain.
1524 Pkg_Ent := First_Entity (U.Entity);
1525 Search : while Present (Pkg_Ent) loop
1526 if Is_Record_Type (Pkg_Ent) then
1527 E1 := First_Entity (Pkg_Ent);
1528 while Present (E1) loop
1529 if Ename = Chars (E1) then
1530 pragma Assert (not Present (Found_E));
1538 Next_Entity (Pkg_Ent);
1541 -- If we didn't find the entity we want, something is wrong. The
1542 -- appropriate action will be taken by Check_CRT when we exit.
1546 Front_End_Inlining := Save_Front_End_Inlining;
1547 return Check_CRT (E, Found_E);
1548 end RTE_Record_Component;
1550 ------------------------------------
1551 -- RTE_Record_Component_Available --
1552 ------------------------------------
1554 function RTE_Record_Component_Available (E : RE_Id) return Boolean is
1556 pragma Warnings (Off, Dummy);
1560 Save_RTE_Available_Call : constant Boolean := RTE_Available_Call;
1561 Save_RTE_Is_Available : constant Boolean := RTE_Is_Available;
1562 -- These are saved recursively because the call to load a unit
1563 -- caused by an upper level call may perform a recursive call
1564 -- to this routine during analysis of the corresponding unit.
1567 RTE_Available_Call := True;
1568 RTE_Is_Available := True;
1569 Dummy := RTE_Record_Component (E);
1570 Result := RTE_Is_Available;
1571 RTE_Available_Call := Save_RTE_Available_Call;
1572 RTE_Is_Available := Save_RTE_Is_Available;
1576 when RE_Not_Available =>
1577 RTE_Available_Call := Save_RTE_Available_Call;
1578 RTE_Is_Available := Save_RTE_Is_Available;
1580 end RTE_Record_Component_Available;
1586 procedure RTE_Error_Msg (Msg : String) is
1588 if RTE_Available_Call then
1589 RTE_Is_Available := False;
1591 Error_Msg_N (Msg, Current_Error_Node);
1593 -- Bump count of violations if we are in configurable run-time
1594 -- mode and this is not a continuation message.
1596 if Configurable_Run_Time_Mode and then Msg (Msg'First) /= '\' then
1597 Configurable_Run_Time_Violations :=
1598 Configurable_Run_Time_Violations + 1;
1607 function RTU_Entity (U : RTU_Id) return Entity_Id is
1609 return RT_Unit_Table (U).Entity;
1616 function RTU_Loaded (U : RTU_Id) return Boolean is
1618 return Present (RT_Unit_Table (U).Entity);
1621 --------------------
1622 -- Set_RTU_Loaded --
1623 --------------------
1625 procedure Set_RTU_Loaded (N : Node_Id) is
1626 Loc : constant Source_Ptr := Sloc (N);
1627 Unum : constant Unit_Number_Type := Get_Source_Unit (Loc);
1628 Uname : constant Unit_Name_Type := Unit_Name (Unum);
1629 E : constant Entity_Id :=
1630 Defining_Entity (Unit (Cunit (Unum)));
1632 pragma Assert (Is_Predefined_Unit (Unum));
1634 -- Loop through entries in RTU table looking for matching entry
1636 for U_Id in RTU_Id'Range loop
1638 -- Here we have a match
1640 if Get_Unit_Name (U_Id) = Uname then
1642 U : RT_Unit_Table_Record renames RT_Unit_Table (U_Id);
1643 -- The RT_Unit_Table entry that may need updating
1646 -- If entry is not set, set it now, and indicate that it was
1647 -- loaded through an explicit context clause.
1649 if No (U.Entity) then
1651 Uname => Get_Unit_Name (U_Id),
1653 First_Implicit_With => Empty);
1662 -------------------------
1663 -- SPARK_Implicit_Load --
1664 -------------------------
1666 procedure SPARK_Implicit_Load (E : RE_Id) is
1670 pragma Assert (GNATprove_Mode);
1672 -- Force loading of a predefined unit
1675 end SPARK_Implicit_Load;