Merged trunk at revision 161680 into branch.
[official-gcc.git] / gcc / ada / binde.adb
blobf4681906df1cd61485b6640825ff92aa2a5372a0
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- B I N D E --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2010, 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 with Binderr; use Binderr;
27 with Butil; use Butil;
28 with Debug; use Debug;
29 with Fname; use Fname;
30 with Namet; use Namet;
31 with Opt; use Opt;
32 with Osint;
33 with Output; use Output;
34 with Targparm; use Targparm;
36 with System.Case_Util; use System.Case_Util;
38 package body Binde is
40 -- The following data structures are used to represent the graph that is
41 -- used to determine the elaboration order (using a topological sort).
43 -- The following structures are used to record successors. If A is a
44 -- successor of B in this table, it means that A must be elaborated
45 -- before B is elaborated.
47 type Successor_Id is new Nat;
48 -- Identification of single successor entry
50 No_Successor : constant Successor_Id := 0;
51 -- Used to indicate end of list of successors
53 type Elab_All_Id is new Nat;
54 -- Identification of Elab_All entry link
56 No_Elab_All_Link : constant Elab_All_Id := 0;
57 -- Used to indicate end of list
59 -- Succ_Reason indicates the reason for a particular elaboration link
61 type Succ_Reason is
62 (Withed,
63 -- After directly with's Before, so the spec of Before must be
64 -- elaborated before After is elaborated.
66 Elab,
67 -- After directly mentions Before in a pragma Elaborate, so the
68 -- body of Before must be elaborate before After is elaborated.
70 Elab_All,
71 -- After either mentions Before directly in a pragma Elaborate_All,
72 -- or mentions a third unit, X, which itself requires that Before be
73 -- elaborated before unit X is elaborated. The Elab_All_Link list
74 -- traces the dependencies in the latter case.
76 Elab_All_Desirable,
77 -- This is just like Elab_All, except that the elaborate all was not
78 -- explicitly present in the source, but rather was created by the
79 -- front end, which decided that it was "desirable".
81 Elab_Desirable,
82 -- This is just like Elab, except that the elaborate was not
83 -- explicitly present in the source, but rather was created by the
84 -- front end, which decided that it was "desirable".
86 Spec_First);
87 -- After is a body, and Before is the corresponding spec
89 -- Successor_Link contains the information for one link
91 type Successor_Link is record
92 Before : Unit_Id;
93 -- Predecessor unit
95 After : Unit_Id;
96 -- Successor unit
98 Next : Successor_Id;
99 -- Next successor on this list
101 Reason : Succ_Reason;
102 -- Reason for this link
104 Elab_Body : Boolean;
105 -- Set True if this link is needed for the special Elaborate_Body
106 -- processing described below.
108 Reason_Unit : Unit_Id;
109 -- For Reason = Elab, or Elab_All or Elab_Desirable, records the unit
110 -- containing the pragma leading to the link.
112 Elab_All_Link : Elab_All_Id;
113 -- If Reason = Elab_All or Elab_Desirable, then this points to the
114 -- first elment in a list of Elab_All entries that record the with
115 -- chain leading resulting in this particular dependency.
117 end record;
119 -- Note on handling of Elaborate_Body. Basically, if we have a pragma
120 -- Elaborate_Body in a unit, it means that the spec and body have to
121 -- be handled as a single entity from the point of view of determining
122 -- an elaboration order. What we do is to essentially remove the body
123 -- from consideration completely, and transfer all its links (other
124 -- than the spec link) to the spec. Then when then the spec gets chosen,
125 -- we choose the body right afterwards. We mark the links that get moved
126 -- from the body to the spec by setting their Elab_Body flag True, so
127 -- that we can understand what is going on!
129 Succ_First : constant := 1;
131 package Succ is new Table.Table (
132 Table_Component_Type => Successor_Link,
133 Table_Index_Type => Successor_Id,
134 Table_Low_Bound => Succ_First,
135 Table_Initial => 500,
136 Table_Increment => 200,
137 Table_Name => "Succ");
139 -- For the case of Elaborate_All, the following table is used to record
140 -- chains of with relationships that lead to the Elab_All link. These
141 -- are used solely for diagnostic purposes
143 type Elab_All_Entry is record
144 Needed_By : Unit_Name_Type;
145 -- Name of unit from which referencing unit was with'ed or otherwise
146 -- needed as a result of Elaborate_All or Elaborate_Desirable.
148 Next_Elab : Elab_All_Id;
149 -- Link to next entry on chain (No_Elab_All_Link marks end of list)
150 end record;
152 package Elab_All_Entries is new Table.Table (
153 Table_Component_Type => Elab_All_Entry,
154 Table_Index_Type => Elab_All_Id,
155 Table_Low_Bound => 1,
156 Table_Initial => 2000,
157 Table_Increment => 200,
158 Table_Name => "Elab_All_Entries");
160 -- A Unit_Node record is built for each active unit
162 type Unit_Node_Record is record
164 Successors : Successor_Id;
165 -- Pointer to list of links for successor nodes
167 Num_Pred : Int;
168 -- Number of predecessors for this unit. Normally non-negative, but
169 -- can go negative in the case of units chosen by the diagnose error
170 -- procedure (when cycles are being removed from the graph).
172 Nextnp : Unit_Id;
173 -- Forward pointer for list of units with no predecessors
175 Elab_Order : Nat;
176 -- Position in elaboration order (zero = not placed yet)
178 Visited : Boolean;
179 -- Used in computing transitive closure for elaborate all and
180 -- also in locating cycles and paths in the diagnose routines.
182 Elab_Position : Natural;
183 -- Initialized to zero. Set non-zero when a unit is chosen and
184 -- placed in the elaboration order. The value represents the
185 -- ordinal position in the elaboration order.
187 end record;
189 package UNR is new Table.Table (
190 Table_Component_Type => Unit_Node_Record,
191 Table_Index_Type => Unit_Id,
192 Table_Low_Bound => First_Unit_Entry,
193 Table_Initial => 500,
194 Table_Increment => 200,
195 Table_Name => "UNR");
197 No_Pred : Unit_Id;
198 -- Head of list of items with no predecessors
200 Num_Left : Int;
201 -- Number of entries not yet dealt with
203 Cur_Unit : Unit_Id;
204 -- Current unit, set by Gather_Dependencies, and picked up in Build_Link
205 -- to set the Reason_Unit field of the created dependency link.
207 Num_Chosen : Natural := 0;
208 -- Number of units chosen in the elaboration order so far
210 -----------------------
211 -- Local Subprograms --
212 -----------------------
214 function Better_Choice (U1, U2 : Unit_Id) return Boolean;
215 -- U1 and U2 are both permitted candidates for selection as the next unit
216 -- to be elaborated. This function determines whether U1 is a better choice
217 -- than U2, i.e. should be elaborated in preference to U2, based on a set
218 -- of heuristics that establish a friendly and predictable order (see body
219 -- for details). The result is True if U1 is a better choice than U2, and
220 -- False if it is a worse choice, or there is no preference between them.
222 procedure Build_Link
223 (Before : Unit_Id;
224 After : Unit_Id;
225 R : Succ_Reason;
226 Ea_Id : Elab_All_Id := No_Elab_All_Link);
227 -- Establish a successor link, Before must be elaborated before After, and
228 -- the reason for the link is R. Ea_Id is the contents to be placed in the
229 -- Elab_All_Link of the entry.
231 procedure Choose (Chosen : Unit_Id);
232 -- Chosen is the next entry chosen in the elaboration order. This procedure
233 -- updates all data structures appropriately.
235 function Corresponding_Body (U : Unit_Id) return Unit_Id;
236 pragma Inline (Corresponding_Body);
237 -- Given a unit which is a spec for which there is a separate body, return
238 -- the unit id of the body. It is an error to call this routine with a unit
239 -- that is not a spec, or which does not have a separate body.
241 function Corresponding_Spec (U : Unit_Id) return Unit_Id;
242 pragma Inline (Corresponding_Spec);
243 -- Given a unit which is a body for which there is a separate spec, return
244 -- the unit id of the spec. It is an error to call this routine with a unit
245 -- that is not a body, or which does not have a separate spec.
247 procedure Diagnose_Elaboration_Problem;
248 -- Called when no elaboration order can be found. Outputs an appropriate
249 -- diagnosis of the problem, and then abandons the bind.
251 procedure Elab_All_Links
252 (Before : Unit_Id;
253 After : Unit_Id;
254 Reason : Succ_Reason;
255 Link : Elab_All_Id);
256 -- Used to compute the transitive closure of elaboration links for an
257 -- Elaborate_All pragma (Reason = Elab_All) or for an indication of
258 -- Elaborate_All_Desirable (Reason = Elab_All_Desirable). Unit After has
259 -- a pragma Elaborate_All or the front end has determined that a reference
260 -- probably requires Elaborate_All is required, and unit Before must be
261 -- previously elaborated. First a link is built making sure that unit
262 -- Before is elaborated before After, then a recursive call ensures that
263 -- we also build links for any units needed by Before (i.e. these units
264 -- must/should also be elaborated before After). Link is used to build
265 -- a chain of Elab_All_Entries to explain the reason for a link. The
266 -- value passed is the chain so far.
268 procedure Elab_Error_Msg (S : Successor_Id);
269 -- Given a successor link, outputs an error message of the form
270 -- "$ must be elaborated before $ ..." where ... is the reason.
272 procedure Gather_Dependencies;
273 -- Compute dependencies, building the Succ and UNR tables
275 function Is_Body_Unit (U : Unit_Id) return Boolean;
276 pragma Inline (Is_Body_Unit);
277 -- Determines if given unit is a body
279 function Is_Pure_Or_Preelab_Unit (U : Unit_Id) return Boolean;
280 -- Returns True if corresponding unit is Pure or Preelaborate. Includes
281 -- dealing with testing flags on spec if it is given a body.
283 function Is_Waiting_Body (U : Unit_Id) return Boolean;
284 pragma Inline (Is_Waiting_Body);
285 -- Determines if U is a waiting body, defined as a body which has
286 -- not been elaborated, but whose spec has been elaborated.
288 function Make_Elab_Entry
289 (Unam : Unit_Name_Type;
290 Link : Elab_All_Id) return Elab_All_Id;
291 -- Make an Elab_All_Entries table entry with the given Unam and Link
293 function Pessimistic_Better_Choice (U1, U2 : Unit_Id) return Boolean;
294 -- This is like Better_Choice, and has the same interface, but returns
295 -- true if U1 is a worse choice than U2 in the sense of the -p (pessimistic
296 -- elaboration order) switch. We still have to obey Ada rules, so it is
297 -- not quite the direct inverse of Better_Choice.
299 function Unit_Id_Of (Uname : Unit_Name_Type) return Unit_Id;
300 -- This function uses the Info field set in the names table to obtain
301 -- the unit Id of a unit, given its name id value.
303 procedure Write_Dependencies;
304 -- Write out dependencies (called only if appropriate option is set)
306 procedure Write_Elab_All_Chain (S : Successor_Id);
307 -- If the reason for the link S is Elaborate_All or Elaborate_Desirable,
308 -- then this routine will output the "needed by" explanation chain.
310 -------------------
311 -- Better_Choice --
312 -------------------
314 function Better_Choice (U1, U2 : Unit_Id) return Boolean is
315 UT1 : Unit_Record renames Units.Table (U1);
316 UT2 : Unit_Record renames Units.Table (U2);
318 begin
319 if Debug_Flag_B then
320 Write_Str ("Better_Choice (");
321 Write_Unit_Name (UT1.Uname);
322 Write_Str (", ");
323 Write_Unit_Name (UT2.Uname);
324 Write_Line (")");
325 end if;
327 -- Note: the checks here are applied in sequence, and the ordering is
328 -- significant (i.e. the more important criteria are applied first).
330 -- Prefer a waiting body to one that is not a waiting body
332 if Is_Waiting_Body (U1) and then not Is_Waiting_Body (U2) then
333 if Debug_Flag_B then
334 Write_Line (" True: u1 is waiting body, u2 is not");
335 end if;
337 return True;
339 elsif Is_Waiting_Body (U2) and then not Is_Waiting_Body (U1) then
340 if Debug_Flag_B then
341 Write_Line (" False: u2 is waiting body, u1 is not");
342 end if;
344 return False;
346 -- Prefer a predefined unit to a non-predefined unit
348 elsif UT1.Predefined and then not UT2.Predefined then
349 if Debug_Flag_B then
350 Write_Line (" True: u1 is predefined, u2 is not");
351 end if;
353 return True;
355 elsif UT2.Predefined and then not UT1.Predefined then
356 if Debug_Flag_B then
357 Write_Line (" False: u2 is predefined, u1 is not");
358 end if;
360 return False;
362 -- Prefer an internal unit to a non-internal unit
364 elsif UT1.Internal and then not UT2.Internal then
365 if Debug_Flag_B then
366 Write_Line (" True: u1 is internal, u2 is not");
367 end if;
368 return True;
370 elsif UT2.Internal and then not UT1.Internal then
371 if Debug_Flag_B then
372 Write_Line (" False: u2 is internal, u1 is not");
373 end if;
375 return False;
377 -- Prefer a pure or preelaborable unit to one that is not
379 elsif Is_Pure_Or_Preelab_Unit (U1)
380 and then not
381 Is_Pure_Or_Preelab_Unit (U2)
382 then
383 if Debug_Flag_B then
384 Write_Line (" True: u1 is pure/preelab, u2 is not");
385 end if;
387 return True;
389 elsif Is_Pure_Or_Preelab_Unit (U2)
390 and then not
391 Is_Pure_Or_Preelab_Unit (U1)
392 then
393 if Debug_Flag_B then
394 Write_Line (" False: u2 is pure/preelab, u1 is not");
395 end if;
397 return False;
399 -- Prefer a body to a spec
401 elsif Is_Body_Unit (U1) and then not Is_Body_Unit (U2) then
402 if Debug_Flag_B then
403 Write_Line (" True: u1 is body, u2 is not");
404 end if;
406 return True;
408 elsif Is_Body_Unit (U2) and then not Is_Body_Unit (U1) then
409 if Debug_Flag_B then
410 Write_Line (" False: u2 is body, u1 is not");
411 end if;
413 return False;
415 -- If both are waiting bodies, then prefer the one whose spec is
416 -- more recently elaborated. Consider the following:
418 -- spec of A
419 -- spec of B
420 -- body of A or B?
422 -- The normal waiting body preference would have placed the body of
423 -- A before the spec of B if it could. Since it could not, there it
424 -- must be the case that A depends on B. It is therefore a good idea
425 -- to put the body of B first.
427 elsif Is_Waiting_Body (U1) and then Is_Waiting_Body (U2) then
428 declare
429 Result : constant Boolean :=
430 UNR.Table (Corresponding_Spec (U1)).Elab_Position >
431 UNR.Table (Corresponding_Spec (U2)).Elab_Position;
432 begin
433 if Debug_Flag_B then
434 if Result then
435 Write_Line (" True: based on waiting body elab positions");
436 else
437 Write_Line (" False: based on waiting body elab positions");
438 end if;
439 end if;
441 return Result;
442 end;
443 end if;
445 -- Remaining choice rules are disabled by Debug flag -do
447 if not Debug_Flag_O then
449 -- The following deal with the case of specs which have been marked
450 -- as Elaborate_Body_Desirable. We generally want to delay these
451 -- specs as long as possible, so that the bodies have a better chance
452 -- of being elaborated closer to the specs.
454 -- If we have two units, one of which is a spec for which this flag
455 -- is set, and the other is not, we prefer to delay the spec for
456 -- which the flag is set.
458 if not UT1.Elaborate_Body_Desirable
459 and then UT2.Elaborate_Body_Desirable
460 then
461 if Debug_Flag_B then
462 Write_Line (" True: u1 is elab body desirable, u2 is not");
463 end if;
465 return True;
467 elsif not UT2.Elaborate_Body_Desirable
468 and then UT1.Elaborate_Body_Desirable
469 then
470 if Debug_Flag_B then
471 Write_Line (" False: u1 is elab body desirable, u2 is not");
472 end if;
474 return False;
476 -- If we have two specs that are both marked as Elaborate_Body
477 -- desirable, we prefer the one whose body is nearer to being able
478 -- to be elaborated, based on the Num_Pred count. This helps to
479 -- ensure bodies are as close to specs as possible.
481 elsif UT1.Elaborate_Body_Desirable
482 and then UT2.Elaborate_Body_Desirable
483 then
484 declare
485 Result : constant Boolean :=
486 UNR.Table (Corresponding_Body (U1)).Num_Pred <
487 UNR.Table (Corresponding_Body (U2)).Num_Pred;
488 begin
489 if Debug_Flag_B then
490 if Result then
491 Write_Line (" True based on Num_Pred compare");
492 else
493 Write_Line (" False based on Num_Pred compare");
494 end if;
495 end if;
497 return Result;
498 end;
499 end if;
500 end if;
502 -- If we fall through, it means that no preference rule applies, so we
503 -- use alphabetical order to at least give a deterministic result.
505 if Debug_Flag_B then
506 Write_Line (" choose on alpha order");
507 end if;
509 return Uname_Less (UT1.Uname, UT2.Uname);
510 end Better_Choice;
512 ----------------
513 -- Build_Link --
514 ----------------
516 procedure Build_Link
517 (Before : Unit_Id;
518 After : Unit_Id;
519 R : Succ_Reason;
520 Ea_Id : Elab_All_Id := No_Elab_All_Link)
522 Cspec : Unit_Id;
524 begin
525 Succ.Increment_Last;
526 Succ.Table (Succ.Last).Before := Before;
527 Succ.Table (Succ.Last).Next := UNR.Table (Before).Successors;
528 UNR.Table (Before).Successors := Succ.Last;
529 Succ.Table (Succ.Last).Reason := R;
530 Succ.Table (Succ.Last).Reason_Unit := Cur_Unit;
531 Succ.Table (Succ.Last).Elab_All_Link := Ea_Id;
533 -- Deal with special Elab_Body case. If the After of this link is
534 -- a body whose spec has Elaborate_All set, and this is not the link
535 -- directly from the body to the spec, then we make the After of the
536 -- link reference its spec instead, marking the link appropriately.
538 if Units.Table (After).Utype = Is_Body then
539 Cspec := Corresponding_Spec (After);
541 if Units.Table (Cspec).Elaborate_Body
542 and then Cspec /= Before
543 then
544 Succ.Table (Succ.Last).After := Cspec;
545 Succ.Table (Succ.Last).Elab_Body := True;
546 UNR.Table (Cspec).Num_Pred := UNR.Table (Cspec).Num_Pred + 1;
547 return;
548 end if;
549 end if;
551 -- Fall through on normal case
553 Succ.Table (Succ.Last).After := After;
554 Succ.Table (Succ.Last).Elab_Body := False;
555 UNR.Table (After).Num_Pred := UNR.Table (After).Num_Pred + 1;
556 end Build_Link;
558 ------------
559 -- Choose --
560 ------------
562 procedure Choose (Chosen : Unit_Id) is
563 S : Successor_Id;
564 U : Unit_Id;
566 begin
567 if Debug_Flag_C then
568 Write_Str ("Choosing Unit ");
569 Write_Unit_Name (Units.Table (Chosen).Uname);
570 Write_Eol;
571 end if;
573 -- Add to elaboration order. Note that units having no elaboration
574 -- code are not treated specially yet. The special casing of this
575 -- is in Bindgen, where Gen_Elab_Calls skips over them. Meanwhile
576 -- we need them here, because the object file list is also driven
577 -- by the contents of the Elab_Order table.
579 Elab_Order.Increment_Last;
580 Elab_Order.Table (Elab_Order.Last) := Chosen;
582 -- Remove from No_Pred list. This is a little inefficient and may
583 -- be we should doubly link the list, but it will do for now!
585 if No_Pred = Chosen then
586 No_Pred := UNR.Table (Chosen).Nextnp;
588 else
589 -- Note that we just ignore the situation where it does not
590 -- appear in the No_Pred list, this happens in calls from the
591 -- Diagnose_Elaboration_Problem routine, where cycles are being
592 -- removed arbitrarily from the graph.
594 U := No_Pred;
595 while U /= No_Unit_Id loop
596 if UNR.Table (U).Nextnp = Chosen then
597 UNR.Table (U).Nextnp := UNR.Table (Chosen).Nextnp;
598 exit;
599 end if;
601 U := UNR.Table (U).Nextnp;
602 end loop;
603 end if;
605 -- For all successors, decrement the number of predecessors, and
606 -- if it becomes zero, then add to no predecessor list.
608 S := UNR.Table (Chosen).Successors;
609 while S /= No_Successor loop
610 U := Succ.Table (S).After;
611 UNR.Table (U).Num_Pred := UNR.Table (U).Num_Pred - 1;
613 if Debug_Flag_N then
614 Write_Str (" decrementing Num_Pred for unit ");
615 Write_Unit_Name (Units.Table (U).Uname);
616 Write_Str (" new value = ");
617 Write_Int (Int (UNR.Table (U).Num_Pred));
618 Write_Eol;
619 end if;
621 if UNR.Table (U).Num_Pred = 0 then
622 UNR.Table (U).Nextnp := No_Pred;
623 No_Pred := U;
624 end if;
626 S := Succ.Table (S).Next;
627 end loop;
629 -- All done, adjust number of units left count and set elaboration pos
631 Num_Left := Num_Left - 1;
632 Num_Chosen := Num_Chosen + 1;
633 UNR.Table (Chosen).Elab_Position := Num_Chosen;
634 Units.Table (Chosen).Elab_Position := Num_Chosen;
636 -- If we just chose a spec with Elaborate_Body set, then we
637 -- must immediately elaborate the body, before any other units.
639 if Units.Table (Chosen).Elaborate_Body then
641 -- If the unit is a spec only, then there is no body. This is a bit
642 -- odd given that Elaborate_Body is here, but it is valid in an
643 -- RCI unit, where we only have the interface in the stub bind.
645 if Units.Table (Chosen).Utype = Is_Spec_Only
646 and then Units.Table (Chosen).RCI
647 then
648 null;
649 else
650 Choose (Corresponding_Body (Chosen));
651 end if;
652 end if;
653 end Choose;
655 ------------------------
656 -- Corresponding_Body --
657 ------------------------
659 -- Currently if the body and spec are separate, then they appear as
660 -- two separate units in the same ALI file, with the body appearing
661 -- first and the spec appearing second.
663 function Corresponding_Body (U : Unit_Id) return Unit_Id is
664 begin
665 pragma Assert (Units.Table (U).Utype = Is_Spec);
666 return U - 1;
667 end Corresponding_Body;
669 ------------------------
670 -- Corresponding_Spec --
671 ------------------------
673 -- Currently if the body and spec are separate, then they appear as
674 -- two separate units in the same ALI file, with the body appearing
675 -- first and the spec appearing second.
677 function Corresponding_Spec (U : Unit_Id) return Unit_Id is
678 begin
679 pragma Assert (Units.Table (U).Utype = Is_Body);
680 return U + 1;
681 end Corresponding_Spec;
683 ----------------------------------
684 -- Diagnose_Elaboration_Problem --
685 ----------------------------------
687 procedure Diagnose_Elaboration_Problem is
689 function Find_Path (Ufrom, Uto : Unit_Id; ML : Nat) return Boolean;
690 -- Recursive routine used to find a path from node Ufrom to node Uto.
691 -- If a path exists, returns True and outputs an appropriate set of
692 -- error messages giving the path. Also calls Choose for each of the
693 -- nodes so that they get removed from the remaining set. There are
694 -- two cases of calls, either Ufrom = Uto for an attempt to find a
695 -- cycle, or Ufrom is a spec and Uto the corresponding body for the
696 -- case of an unsatisfiable Elaborate_Body pragma. ML is the minimum
697 -- acceptable length for a path.
699 ---------------
700 -- Find_Path --
701 ---------------
703 function Find_Path (Ufrom, Uto : Unit_Id; ML : Nat) return Boolean is
705 function Find_Link (U : Unit_Id; PL : Nat) return Boolean;
706 -- This is the inner recursive routine, it determines if a path
707 -- exists from U to Uto, and if so returns True and outputs the
708 -- appropriate set of error messages. PL is the path length
710 ---------------
711 -- Find_Link --
712 ---------------
714 function Find_Link (U : Unit_Id; PL : Nat) return Boolean is
715 S : Successor_Id;
717 begin
718 -- Recursion ends if we are at terminating node and the path
719 -- is sufficiently long, generate error message and return True.
721 if U = Uto and then PL >= ML then
722 Choose (U);
723 return True;
725 -- All done if already visited, otherwise mark as visited
727 elsif UNR.Table (U).Visited then
728 return False;
730 -- Otherwise mark as visited and look at all successors
732 else
733 UNR.Table (U).Visited := True;
735 S := UNR.Table (U).Successors;
736 while S /= No_Successor loop
737 if Find_Link (Succ.Table (S).After, PL + 1) then
738 Elab_Error_Msg (S);
739 Choose (U);
740 return True;
741 end if;
743 S := Succ.Table (S).Next;
744 end loop;
746 -- Falling through means this does not lead to a path
748 return False;
749 end if;
750 end Find_Link;
752 -- Start of processing for Find_Path
754 begin
755 -- Initialize all non-chosen nodes to not visisted yet
757 for U in Units.First .. Units.Last loop
758 UNR.Table (U).Visited := UNR.Table (U).Elab_Position /= 0;
759 end loop;
761 -- Now try to find the path
763 return Find_Link (Ufrom, 0);
764 end Find_Path;
766 -- Start of processing for Diagnose_Elaboration_Error
768 begin
769 Set_Standard_Error;
771 -- Output state of things if debug flag N set
773 if Debug_Flag_N then
774 declare
775 NP : Int;
777 begin
778 Write_Eol;
779 Write_Eol;
780 Write_Str ("Diagnose_Elaboration_Problem called");
781 Write_Eol;
782 Write_Str ("List of remaining unchosen units and predecessors");
783 Write_Eol;
785 for U in Units.First .. Units.Last loop
786 if UNR.Table (U).Elab_Position = 0 then
787 NP := UNR.Table (U).Num_Pred;
788 Write_Eol;
789 Write_Str (" Unchosen unit: #");
790 Write_Int (Int (U));
791 Write_Str (" ");
792 Write_Unit_Name (Units.Table (U).Uname);
793 Write_Str (" (Num_Pred = ");
794 Write_Int (NP);
795 Write_Char (')');
796 Write_Eol;
798 if NP = 0 then
799 if Units.Table (U).Elaborate_Body then
800 Write_Str
801 (" (not chosen because of Elaborate_Body)");
802 Write_Eol;
803 else
804 Write_Str (" ****************** why not chosen?");
805 Write_Eol;
806 end if;
807 end if;
809 -- Search links list to find unchosen predecessors
811 for S in Succ.First .. Succ.Last loop
812 declare
813 SL : Successor_Link renames Succ.Table (S);
815 begin
816 if SL.After = U
817 and then UNR.Table (SL.Before).Elab_Position = 0
818 then
819 Write_Str (" unchosen predecessor: #");
820 Write_Int (Int (SL.Before));
821 Write_Str (" ");
822 Write_Unit_Name (Units.Table (SL.Before).Uname);
823 Write_Eol;
824 NP := NP - 1;
825 end if;
826 end;
827 end loop;
829 if NP /= 0 then
830 Write_Str (" **************** Num_Pred value wrong!");
831 Write_Eol;
832 end if;
833 end if;
834 end loop;
835 end;
836 end if;
838 -- Output the header for the error, and manually increment the
839 -- error count. We are using Error_Msg_Output rather than Error_Msg
840 -- here for two reasons:
842 -- This is really only one error, not one for each line
843 -- We want this output on standard output since it is voluminous
845 -- But we do need to deal with the error count manually in this case
847 Errors_Detected := Errors_Detected + 1;
848 Error_Msg_Output ("elaboration circularity detected", Info => False);
850 -- Try to find cycles starting with any of the remaining nodes that have
851 -- not yet been chosen. There must be at least one (there is some reason
852 -- we are being called!)
854 for U in Units.First .. Units.Last loop
855 if UNR.Table (U).Elab_Position = 0 then
856 if Find_Path (U, U, 1) then
857 raise Unrecoverable_Error;
858 end if;
859 end if;
860 end loop;
862 -- We should never get here, since we were called for some reason,
863 -- and we should have found and eliminated at least one bad path.
865 raise Program_Error;
866 end Diagnose_Elaboration_Problem;
868 --------------------
869 -- Elab_All_Links --
870 --------------------
872 procedure Elab_All_Links
873 (Before : Unit_Id;
874 After : Unit_Id;
875 Reason : Succ_Reason;
876 Link : Elab_All_Id)
878 begin
879 if UNR.Table (Before).Visited then
880 return;
881 end if;
883 -- Build the direct link for Before
885 UNR.Table (Before).Visited := True;
886 Build_Link (Before, After, Reason, Link);
888 -- Process all units with'ed by Before recursively
890 for W in
891 Units.Table (Before).First_With .. Units.Table (Before).Last_With
892 loop
893 -- Skip if this with is an interface to a stand-alone library.
894 -- Skip also if no ALI file for this WITH, happens for language
895 -- defined generics while bootstrapping the compiler (see body of
896 -- Lib.Writ.Write_With_Lines). Finally, skip if it is a limited
897 -- with clause, which does not impose an elaboration link.
899 if not Withs.Table (W).SAL_Interface
900 and then Withs.Table (W).Afile /= No_File
901 and then not Withs.Table (W).Limited_With
902 then
903 declare
904 Info : constant Int :=
905 Get_Name_Table_Info
906 (Withs.Table (W).Uname);
908 begin
909 -- If the unit is unknown, for some unknown reason, fail
910 -- graciously explaining that the unit is unknown. Without
911 -- this check, gnatbind will crash in Unit_Id_Of.
913 if Info = 0 or else Unit_Id (Info) = No_Unit_Id then
914 declare
915 Withed : String :=
916 Get_Name_String (Withs.Table (W).Uname);
917 Last_Withed : Natural := Withed'Last;
918 Withing : String :=
919 Get_Name_String
920 (Units.Table (Before).Uname);
921 Last_Withing : Natural := Withing'Last;
922 Spec_Body : String := " (Spec)";
924 begin
925 To_Mixed (Withed);
926 To_Mixed (Withing);
928 if Last_Withed > 2 and then
929 Withed (Last_Withed - 1) = '%'
930 then
931 Last_Withed := Last_Withed - 2;
932 end if;
934 if Last_Withing > 2 and then
935 Withing (Last_Withing - 1) = '%'
936 then
937 Last_Withing := Last_Withing - 2;
938 end if;
940 if Units.Table (Before).Utype = Is_Body or else
941 Units.Table (Before).Utype = Is_Body_Only
942 then
943 Spec_Body := " (Body)";
944 end if;
946 Osint.Fail
947 ("could not find unit "
948 & Withed (Withed'First .. Last_Withed) & " needed by "
949 & Withing (Withing'First .. Last_Withing) & Spec_Body);
950 end;
951 end if;
953 Elab_All_Links
954 (Unit_Id_Of (Withs.Table (W).Uname),
955 After,
956 Reason,
957 Make_Elab_Entry (Withs.Table (W).Uname, Link));
958 end;
959 end if;
960 end loop;
962 -- Process corresponding body, if there is one
964 if Units.Table (Before).Utype = Is_Spec then
965 Elab_All_Links
966 (Corresponding_Body (Before),
967 After, Reason,
968 Make_Elab_Entry
969 (Units.Table (Corresponding_Body (Before)).Uname, Link));
970 end if;
971 end Elab_All_Links;
973 --------------------
974 -- Elab_Error_Msg --
975 --------------------
977 procedure Elab_Error_Msg (S : Successor_Id) is
978 SL : Successor_Link renames Succ.Table (S);
980 begin
981 -- Nothing to do if internal unit involved and no -da flag
983 if not Debug_Flag_A
984 and then
985 (Is_Internal_File_Name (Units.Table (SL.Before).Sfile)
986 or else
987 Is_Internal_File_Name (Units.Table (SL.After).Sfile))
988 then
989 return;
990 end if;
992 -- Here we want to generate output
994 Error_Msg_Unit_1 := Units.Table (SL.Before).Uname;
996 if SL.Elab_Body then
997 Error_Msg_Unit_2 := Units.Table (Corresponding_Body (SL.After)).Uname;
998 else
999 Error_Msg_Unit_2 := Units.Table (SL.After).Uname;
1000 end if;
1002 Error_Msg_Output (" $ must be elaborated before $", Info => True);
1004 Error_Msg_Unit_1 := Units.Table (SL.Reason_Unit).Uname;
1006 case SL.Reason is
1007 when Withed =>
1008 Error_Msg_Output
1009 (" reason: with clause",
1010 Info => True);
1012 when Elab =>
1013 Error_Msg_Output
1014 (" reason: pragma Elaborate in unit $",
1015 Info => True);
1017 when Elab_All =>
1018 Error_Msg_Output
1019 (" reason: pragma Elaborate_All in unit $",
1020 Info => True);
1022 when Elab_All_Desirable =>
1023 Error_Msg_Output
1024 (" reason: implicit Elaborate_All in unit $",
1025 Info => True);
1027 Error_Msg_Output
1028 (" recompile $ with -gnatwl for full details",
1029 Info => True);
1031 when Elab_Desirable =>
1032 Error_Msg_Output
1033 (" reason: implicit Elaborate in unit $",
1034 Info => True);
1036 Error_Msg_Output
1037 (" recompile $ with -gnatwl for full details",
1038 Info => True);
1040 when Spec_First =>
1041 Error_Msg_Output
1042 (" reason: spec always elaborated before body",
1043 Info => True);
1044 end case;
1046 Write_Elab_All_Chain (S);
1048 if SL.Elab_Body then
1049 Error_Msg_Unit_1 := Units.Table (SL.Before).Uname;
1050 Error_Msg_Unit_2 := Units.Table (SL.After).Uname;
1051 Error_Msg_Output
1052 (" $ must therefore be elaborated before $",
1053 True);
1055 Error_Msg_Unit_1 := Units.Table (SL.After).Uname;
1056 Error_Msg_Output
1057 (" (because $ has a pragma Elaborate_Body)",
1058 True);
1059 end if;
1061 if not Zero_Formatting then
1062 Write_Eol;
1063 end if;
1064 end Elab_Error_Msg;
1066 ---------------------
1067 -- Find_Elab_Order --
1068 ---------------------
1070 procedure Find_Elab_Order is
1071 U : Unit_Id;
1072 Best_So_Far : Unit_Id;
1074 begin
1075 Succ.Init;
1076 Num_Left := Int (Units.Last - Units.First + 1);
1078 -- Initialize unit table for elaboration control
1080 for U in Units.First .. Units.Last loop
1081 UNR.Increment_Last;
1082 UNR.Table (UNR.Last).Successors := No_Successor;
1083 UNR.Table (UNR.Last).Num_Pred := 0;
1084 UNR.Table (UNR.Last).Nextnp := No_Unit_Id;
1085 UNR.Table (UNR.Last).Elab_Order := 0;
1086 UNR.Table (UNR.Last).Elab_Position := 0;
1087 end loop;
1089 -- Output warning if -p used with no -gnatE units
1091 if Pessimistic_Elab_Order
1092 and not Dynamic_Elaboration_Checks_Specified
1093 then
1094 if OpenVMS_On_Target then
1095 Error_Msg ("?use of /PESSIMISTIC_ELABORATION questionable");
1096 else
1097 Error_Msg ("?use of -p switch questionable");
1098 end if;
1100 Error_Msg ("?since all units compiled with static elaboration model");
1101 end if;
1103 -- Gather dependencies and output them if option set
1105 Gather_Dependencies;
1107 -- Output elaboration dependencies if option is set
1109 if Elab_Dependency_Output or Debug_Flag_E then
1110 Write_Dependencies;
1111 end if;
1113 -- Initialize the no predecessor list
1115 No_Pred := No_Unit_Id;
1117 for U in UNR.First .. UNR.Last loop
1118 if UNR.Table (U).Num_Pred = 0 then
1119 UNR.Table (U).Nextnp := No_Pred;
1120 No_Pred := U;
1121 end if;
1122 end loop;
1124 -- OK, now we determine the elaboration order proper. All we do is to
1125 -- select the best choice from the no predecessor list until all the
1126 -- nodes have been chosen.
1128 Outer : loop
1130 -- If there are no nodes with predecessors, then either we are
1131 -- done, as indicated by Num_Left being set to zero, or we have
1132 -- a circularity. In the latter case, diagnose the circularity,
1133 -- removing it from the graph and continue
1135 Get_No_Pred : while No_Pred = No_Unit_Id loop
1136 exit Outer when Num_Left < 1;
1137 Diagnose_Elaboration_Problem;
1138 end loop Get_No_Pred;
1140 U := No_Pred;
1141 Best_So_Far := No_Unit_Id;
1143 -- Loop to choose best entry in No_Pred list
1145 No_Pred_Search : loop
1146 if Debug_Flag_N then
1147 Write_Str (" considering choice of ");
1148 Write_Unit_Name (Units.Table (U).Uname);
1149 Write_Eol;
1151 if Units.Table (U).Elaborate_Body then
1152 Write_Str
1153 (" Elaborate_Body = True, Num_Pred for body = ");
1154 Write_Int
1155 (Int (UNR.Table (Corresponding_Body (U)).Num_Pred));
1156 else
1157 Write_Str
1158 (" Elaborate_Body = False");
1159 end if;
1161 Write_Eol;
1162 end if;
1164 -- This is a candididate to be considered for choice
1166 if Best_So_Far = No_Unit_Id
1167 or else ((not Pessimistic_Elab_Order)
1168 and then Better_Choice (U, Best_So_Far))
1169 or else (Pessimistic_Elab_Order
1170 and then Pessimistic_Better_Choice (U, Best_So_Far))
1171 then
1172 if Debug_Flag_N then
1173 Write_Str (" tentatively chosen (best so far)");
1174 Write_Eol;
1175 end if;
1177 Best_So_Far := U;
1178 end if;
1180 U := UNR.Table (U).Nextnp;
1181 exit No_Pred_Search when U = No_Unit_Id;
1182 end loop No_Pred_Search;
1184 -- If no candididate chosen, it means that no unit has No_Pred = 0,
1185 -- but there are units left, hence we have a circular dependency,
1186 -- which we will get Diagnose_Elaboration_Problem to diagnose it.
1188 if Best_So_Far = No_Unit_Id then
1189 Diagnose_Elaboration_Problem;
1191 -- Otherwise choose the best candidate found
1193 else
1194 Choose (Best_So_Far);
1195 end if;
1196 end loop Outer;
1197 end Find_Elab_Order;
1199 -------------------------
1200 -- Gather_Dependencies --
1201 -------------------------
1203 procedure Gather_Dependencies is
1204 Withed_Unit : Unit_Id;
1206 begin
1207 -- Loop through all units
1209 for U in Units.First .. Units.Last loop
1210 Cur_Unit := U;
1212 -- If this is not an interface to a stand-alone library and
1213 -- there is a body and a spec, then spec must be elaborated first
1214 -- Note that the corresponding spec immediately follows the body
1216 if not Units.Table (U).SAL_Interface
1217 and then Units.Table (U).Utype = Is_Body
1218 then
1219 Build_Link (Corresponding_Spec (U), U, Spec_First);
1220 end if;
1222 -- If this unit is not an interface to a stand-alone library,
1223 -- process WITH references for this unit ignoring generic units and
1224 -- interfaces to stand-alone libraries.
1226 if not Units.Table (U).SAL_Interface then
1228 W in Units.Table (U).First_With .. Units.Table (U).Last_With
1229 loop
1230 if Withs.Table (W).Sfile /= No_File
1231 and then (not Withs.Table (W).SAL_Interface)
1232 then
1233 -- Check for special case of withing a unit that does not
1234 -- exist any more. If the unit was completely missing we
1235 -- would already have detected this, but a nasty case arises
1236 -- when we have a subprogram body with no spec, and some
1237 -- obsolete unit with's a previous (now disappeared) spec.
1239 if Get_Name_Table_Info (Withs.Table (W).Uname) = 0 then
1240 Error_Msg_File_1 := Units.Table (U).Sfile;
1241 Error_Msg_Unit_1 := Withs.Table (W).Uname;
1242 Error_Msg ("{ depends on $ which no longer exists");
1243 goto Next_With;
1244 end if;
1246 Withed_Unit :=
1247 Unit_Id (Unit_Id_Of (Withs.Table (W).Uname));
1249 -- Pragma Elaborate_All case, for this we use the recursive
1250 -- Elab_All_Links procedure to establish the links.
1252 if Withs.Table (W).Elaborate_All then
1254 -- Reset flags used to stop multiple visits to a given
1255 -- node.
1257 for Uref in UNR.First .. UNR.Last loop
1258 UNR.Table (Uref).Visited := False;
1259 end loop;
1261 -- Now establish all the links we need
1263 Elab_All_Links
1264 (Withed_Unit, U, Elab_All,
1265 Make_Elab_Entry
1266 (Withs.Table (W).Uname, No_Elab_All_Link));
1268 -- Elaborate_All_Desirable case, for this we establish the
1269 -- same links as above, but with a different reason.
1271 elsif Withs.Table (W).Elab_All_Desirable then
1273 -- Reset flags used to stop multiple visits to a given
1274 -- node.
1276 for Uref in UNR.First .. UNR.Last loop
1277 UNR.Table (Uref).Visited := False;
1278 end loop;
1280 -- Now establish all the links we need
1282 Elab_All_Links
1283 (Withed_Unit, U, Elab_All_Desirable,
1284 Make_Elab_Entry
1285 (Withs.Table (W).Uname, No_Elab_All_Link));
1287 -- Pragma Elaborate case. We must build a link for the
1288 -- withed unit itself, and also the corresponding body if
1289 -- there is one.
1291 -- However, skip this processing if there is no ALI file for
1292 -- the WITH entry, because this means it is a generic (even
1293 -- when we fix the generics so that an ALI file is present,
1294 -- we probably still will have no ALI file for unchecked and
1295 -- other special cases).
1297 elsif Withs.Table (W).Elaborate
1298 and then Withs.Table (W).Afile /= No_File
1299 then
1300 Build_Link (Withed_Unit, U, Withed);
1302 if Units.Table (Withed_Unit).Utype = Is_Spec then
1303 Build_Link
1304 (Corresponding_Body (Withed_Unit), U, Elab);
1305 end if;
1307 -- Elaborate_Desirable case, for this we establish
1308 -- the same links as above, but with a different reason.
1310 elsif Withs.Table (W).Elab_Desirable then
1311 Build_Link (Withed_Unit, U, Withed);
1313 if Units.Table (Withed_Unit).Utype = Is_Spec then
1314 Build_Link
1315 (Corresponding_Body (Withed_Unit),
1316 U, Elab_Desirable);
1317 end if;
1319 -- A limited_with does not establish an elaboration
1320 -- dependence (that's the whole point!).
1322 elsif Withs.Table (W).Limited_With then
1323 null;
1325 -- Case of normal WITH with no elaboration pragmas, just
1326 -- build the single link to the directly referenced unit
1328 else
1329 Build_Link (Withed_Unit, U, Withed);
1330 end if;
1331 end if;
1333 <<Next_With>>
1334 null;
1335 end loop;
1336 end if;
1337 end loop;
1338 end Gather_Dependencies;
1340 ------------------
1341 -- Is_Body_Unit --
1342 ------------------
1344 function Is_Body_Unit (U : Unit_Id) return Boolean is
1345 begin
1346 return Units.Table (U).Utype = Is_Body
1347 or else Units.Table (U).Utype = Is_Body_Only;
1348 end Is_Body_Unit;
1350 -----------------------------
1351 -- Is_Pure_Or_Preelab_Unit --
1352 -----------------------------
1354 function Is_Pure_Or_Preelab_Unit (U : Unit_Id) return Boolean is
1355 begin
1356 -- If we have a body with separate spec, test flags on the spec
1358 if Units.Table (U).Utype = Is_Body then
1359 return Units.Table (U + 1).Preelab
1360 or else
1361 Units.Table (U + 1).Pure;
1363 -- Otherwise we have a spec or body acting as spec, test flags on unit
1365 else
1366 return Units.Table (U).Preelab
1367 or else
1368 Units.Table (U).Pure;
1369 end if;
1370 end Is_Pure_Or_Preelab_Unit;
1372 ---------------------
1373 -- Is_Waiting_Body --
1374 ---------------------
1376 function Is_Waiting_Body (U : Unit_Id) return Boolean is
1377 begin
1378 return Units.Table (U).Utype = Is_Body
1379 and then UNR.Table (Corresponding_Spec (U)).Elab_Position /= 0;
1380 end Is_Waiting_Body;
1382 ---------------------
1383 -- Make_Elab_Entry --
1384 ---------------------
1386 function Make_Elab_Entry
1387 (Unam : Unit_Name_Type;
1388 Link : Elab_All_Id) return Elab_All_Id
1390 begin
1391 Elab_All_Entries.Increment_Last;
1392 Elab_All_Entries.Table (Elab_All_Entries.Last).Needed_By := Unam;
1393 Elab_All_Entries.Table (Elab_All_Entries.Last).Next_Elab := Link;
1394 return Elab_All_Entries.Last;
1395 end Make_Elab_Entry;
1397 -------------------------------
1398 -- Pessimistic_Better_Choice --
1399 -------------------------------
1401 function Pessimistic_Better_Choice (U1, U2 : Unit_Id) return Boolean is
1402 UT1 : Unit_Record renames Units.Table (U1);
1403 UT2 : Unit_Record renames Units.Table (U2);
1405 begin
1406 if Debug_Flag_B then
1407 Write_Str ("Pessimistic_Better_Choice (");
1408 Write_Unit_Name (UT1.Uname);
1409 Write_Str (", ");
1410 Write_Unit_Name (UT2.Uname);
1411 Write_Line (")");
1412 end if;
1414 -- Note: the checks here are applied in sequence, and the ordering is
1415 -- significant (i.e. the more important criteria are applied first).
1417 -- If either unit is predefined or internal, then we use the normal
1418 -- Better_Choice rule, since we don't want to disturb the elaboration
1419 -- rules of the language with -p, same treatment for Pure/Preelab.
1421 -- Prefer a predefined unit to a non-predefined unit
1423 if UT1.Predefined and then not UT2.Predefined then
1424 if Debug_Flag_B then
1425 Write_Line (" True: u1 is predefined, u2 is not");
1426 end if;
1428 return True;
1430 elsif UT2.Predefined and then not UT1.Predefined then
1431 if Debug_Flag_B then
1432 Write_Line (" False: u2 is predefined, u1 is not");
1433 end if;
1435 return False;
1437 -- Prefer an internal unit to a non-internal unit
1439 elsif UT1.Internal and then not UT2.Internal then
1440 if Debug_Flag_B then
1441 Write_Line (" True: u1 is internal, u2 is not");
1442 end if;
1444 return True;
1446 elsif UT2.Internal and then not UT1.Internal then
1447 if Debug_Flag_B then
1448 Write_Line (" False: u2 is internal, u1 is not");
1449 end if;
1451 return False;
1453 -- Prefer a pure or preelaborable unit to one that is not
1455 elsif Is_Pure_Or_Preelab_Unit (U1)
1456 and then not
1457 Is_Pure_Or_Preelab_Unit (U2)
1458 then
1459 if Debug_Flag_B then
1460 Write_Line (" True: u1 is pure/preelab, u2 is not");
1461 end if;
1463 return True;
1465 elsif Is_Pure_Or_Preelab_Unit (U2)
1466 and then not
1467 Is_Pure_Or_Preelab_Unit (U1)
1468 then
1469 if Debug_Flag_B then
1470 Write_Line (" False: u2 is pure/preelab, u1 is not");
1471 end if;
1473 return False;
1475 -- Prefer anything else to a waiting body. We want to make bodies wait
1476 -- as long as possible, till we are forced to choose them!
1478 elsif Is_Waiting_Body (U1) and then not Is_Waiting_Body (U2) then
1479 if Debug_Flag_B then
1480 Write_Line (" False: u1 is waiting body, u2 is not");
1481 end if;
1483 return False;
1485 elsif Is_Waiting_Body (U2) and then not Is_Waiting_Body (U1) then
1486 if Debug_Flag_B then
1487 Write_Line (" True: u2 is waiting body, u1 is not");
1488 end if;
1490 return True;
1492 -- Prefer a spec to a body (!)
1494 elsif Is_Body_Unit (U1) and then not Is_Body_Unit (U2) then
1495 if Debug_Flag_B then
1496 Write_Line (" False: u1 is body, u2 is not");
1497 end if;
1499 return False;
1501 elsif Is_Body_Unit (U2) and then not Is_Body_Unit (U1) then
1502 if Debug_Flag_B then
1503 Write_Line (" True: u2 is body, u1 is not");
1504 end if;
1506 return True;
1508 -- If both are waiting bodies, then prefer the one whose spec is
1509 -- less recently elaborated. Consider the following:
1511 -- spec of A
1512 -- spec of B
1513 -- body of A or B?
1515 -- The normal waiting body preference would have placed the body of
1516 -- A before the spec of B if it could. Since it could not, there it
1517 -- must be the case that A depends on B. It is therefore a good idea
1518 -- to put the body of B last so that if there is an elaboration order
1519 -- problem, we will find it (that's what pssimistic order is about)
1521 elsif Is_Waiting_Body (U1) and then Is_Waiting_Body (U2) then
1522 declare
1523 Result : constant Boolean :=
1524 UNR.Table (Corresponding_Spec (U1)).Elab_Position <
1525 UNR.Table (Corresponding_Spec (U2)).Elab_Position;
1526 begin
1527 if Debug_Flag_B then
1528 if Result then
1529 Write_Line (" True: based on waiting body elab positions");
1530 else
1531 Write_Line (" False: based on waiting body elab positions");
1532 end if;
1533 end if;
1535 return Result;
1536 end;
1537 end if;
1539 -- Remaining choice rules are disabled by Debug flag -do
1541 if not Debug_Flag_O then
1543 -- The following deal with the case of specs which have been marked
1544 -- as Elaborate_Body_Desirable. In the normal case, we generally want
1545 -- to delay the elaboration of these specs as long as possible, so
1546 -- that bodies have better chance of being elaborated closer to the
1547 -- specs. Pessimistic_Better_Choice as usual wants to do the opposite
1548 -- and elaborate such specs as early as possible.
1550 -- If we have two units, one of which is a spec for which this flag
1551 -- is set, and the other is not, we normally prefer to delay the spec
1552 -- for which the flag is set, so again Pessimistic_Better_Choice does
1553 -- the opposite.
1555 if not UT1.Elaborate_Body_Desirable
1556 and then UT2.Elaborate_Body_Desirable
1557 then
1558 if Debug_Flag_B then
1559 Write_Line (" False: u1 is elab body desirable, u2 is not");
1560 end if;
1562 return False;
1564 elsif not UT2.Elaborate_Body_Desirable
1565 and then UT1.Elaborate_Body_Desirable
1566 then
1567 if Debug_Flag_B then
1568 Write_Line (" True: u1 is elab body desirable, u2 is not");
1569 end if;
1571 return True;
1573 -- If we have two specs that are both marked as Elaborate_Body
1574 -- desirable, we normally prefer the one whose body is nearer to
1575 -- being able to be elaborated, based on the Num_Pred count. This
1576 -- helps to ensure bodies are as close to specs as possible. As
1577 -- usual, Pessimistic_Better_Choice does the opposite.
1579 elsif UT1.Elaborate_Body_Desirable
1580 and then UT2.Elaborate_Body_Desirable
1581 then
1582 declare
1583 Result : constant Boolean :=
1584 UNR.Table (Corresponding_Body (U1)).Num_Pred >=
1585 UNR.Table (Corresponding_Body (U2)).Num_Pred;
1586 begin
1587 if Debug_Flag_B then
1588 if Result then
1589 Write_Line (" True based on Num_Pred compare");
1590 else
1591 Write_Line (" False based on Num_Pred compare");
1592 end if;
1593 end if;
1595 return Result;
1596 end;
1597 end if;
1598 end if;
1600 -- If we fall through, it means that no preference rule applies, so we
1601 -- use alphabetical order to at least give a deterministic result. Since
1602 -- Pessimistic_Better_Choice is in the business of stirring up the
1603 -- order, we will use reverse alphabetical ordering.
1605 if Debug_Flag_B then
1606 Write_Line (" choose on reverse alpha order");
1607 end if;
1609 return Uname_Less (UT2.Uname, UT1.Uname);
1610 end Pessimistic_Better_Choice;
1612 ----------------
1613 -- Unit_Id_Of --
1614 ----------------
1616 function Unit_Id_Of (Uname : Unit_Name_Type) return Unit_Id is
1617 Info : constant Int := Get_Name_Table_Info (Uname);
1618 begin
1619 pragma Assert (Info /= 0 and then Unit_Id (Info) /= No_Unit_Id);
1620 return Unit_Id (Info);
1621 end Unit_Id_Of;
1623 ------------------------
1624 -- Write_Dependencies --
1625 ------------------------
1627 procedure Write_Dependencies is
1628 begin
1629 if not Zero_Formatting then
1630 Write_Eol;
1631 Write_Str (" ELABORATION ORDER DEPENDENCIES");
1632 Write_Eol;
1633 Write_Eol;
1634 end if;
1636 Info_Prefix_Suppress := True;
1638 for S in Succ_First .. Succ.Last loop
1639 Elab_Error_Msg (S);
1640 end loop;
1642 Info_Prefix_Suppress := False;
1644 if not Zero_Formatting then
1645 Write_Eol;
1646 end if;
1647 end Write_Dependencies;
1649 --------------------------
1650 -- Write_Elab_All_Chain --
1651 --------------------------
1653 procedure Write_Elab_All_Chain (S : Successor_Id) is
1654 ST : constant Successor_Link := Succ.Table (S);
1655 After : constant Unit_Name_Type := Units.Table (ST.After).Uname;
1657 L : Elab_All_Id;
1658 Nam : Unit_Name_Type;
1660 First_Name : Boolean := True;
1662 begin
1663 if ST.Reason in Elab_All .. Elab_All_Desirable then
1664 L := ST.Elab_All_Link;
1665 while L /= No_Elab_All_Link loop
1666 Nam := Elab_All_Entries.Table (L).Needed_By;
1667 Error_Msg_Unit_1 := Nam;
1668 Error_Msg_Output (" $", Info => True);
1670 Get_Name_String (Nam);
1672 if Name_Buffer (Name_Len) = 'b' then
1673 if First_Name then
1674 Error_Msg_Output
1675 (" must be elaborated along with its spec:",
1676 Info => True);
1678 else
1679 Error_Msg_Output
1680 (" which must be elaborated " &
1681 "along with its spec:",
1682 Info => True);
1683 end if;
1685 else
1686 if First_Name then
1687 Error_Msg_Output
1688 (" is withed by:",
1689 Info => True);
1691 else
1692 Error_Msg_Output
1693 (" which is withed by:",
1694 Info => True);
1695 end if;
1696 end if;
1698 First_Name := False;
1700 L := Elab_All_Entries.Table (L).Next_Elab;
1701 end loop;
1703 Error_Msg_Unit_1 := After;
1704 Error_Msg_Output (" $", Info => True);
1705 end if;
1706 end Write_Elab_All_Chain;
1708 end Binde;