Small ChangeLog tweak.
[official-gcc.git] / gcc / ada / binde.adb
blob869cc4347d638eff03f71df18178b94c8fe7e735
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- B I N D E --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2016, 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 Opt; use Opt;
31 with Osint;
32 with Output; use Output;
33 with Table;
35 with System.Case_Util; use System.Case_Util;
36 with System.OS_Lib;
38 package body Binde is
40 -- We now have Elab_New, a new elaboration-order algorithm.
42 -- However, any change to elaboration order can break some programs.
43 -- Therefore, we are keeping the old algorithm in place, to be selected
44 -- by switches.
46 -- The new algorithm has the following interesting properties:
48 -- * The static and dynamic models use the same elaboration order. The
49 -- static model might get an error, but if it does not, it will use
50 -- the same order as the dynamic model.
52 -- * Each SCC (see below) is elaborated together; that is, units from
53 -- different SCCs are not interspersed.
55 -- * In particular, this implies that if an SCC contains just a spec and
56 -- the corresponding body, and nothing else, the body will be
57 -- elaborated immediately after the spec. This is expected to result
58 -- in a better elaboration order for most programs, because in this
59 -- case, a call from outside the library unit cannot get ABE.
61 -- * Pragmas Elaborate_All (explicit and implicit) are ignored. Instead,
62 -- we behave as if every legal pragma Elaborate_All were present. That
63 -- is, if it would be legal to have "pragma Elaborate_All(Y);" on X,
64 -- then we behave as if such a pragma exists, even if it does not.
66 Do_Old : constant Boolean := False;
67 Do_New : constant Boolean := True;
68 -- True to enable the old and new algorithms, respectively. Used for
69 -- debugging/experimentation.
71 Doing_New : Boolean := False;
72 -- True if we are currently doing the new algorithm. Print certain
73 -- messages only when doing the "new" elab order algorithm, so we don't get
74 -- duplicates. And use different heuristics in Better_Choice_Optimistic.
76 -- The following data structures are used to represent the graph that is
77 -- used to determine the elaboration order (using a topological sort).
79 -- The following structures are used to record successors. If B is a
80 -- successor of A in this table, it means that A must be elaborated before
81 -- B is elaborated. For example, if Y (body) says "with X;", then Y (body)
82 -- will be a successor of X (spec), and X (spec) will be a predecessor of
83 -- Y (body).
85 -- Note that we store the successors of each unit explicitly. We don't
86 -- store the predecessors, but we store a count of them.
88 -- The basic algorithm is to first compute a directed graph of units (type
89 -- Unit_Node_Record, below), with successors as edges. A unit is "ready"
90 -- (to be chosen as the next to be elaborated) if it has no predecessors
91 -- that have not yet been chosen. We use heuristics to decide which of the
92 -- ready units should be elaborated next, and "choose" that one (which
93 -- means we append it to the elaboration-order table).
95 type Successor_Id is new Nat;
96 -- Identification of single successor entry
98 No_Successor : constant Successor_Id := 0;
99 -- Used to indicate end of list of successors
101 type Elab_All_Id is new Nat;
102 -- Identification of Elab_All entry link
104 No_Elab_All_Link : constant Elab_All_Id := 0;
105 -- Used to indicate end of list
107 -- Succ_Reason indicates the reason for a particular elaboration link
109 type Succ_Reason is
110 (Withed,
111 -- After directly with's Before, so the spec of Before must be
112 -- elaborated before After is elaborated.
114 Forced,
115 -- Before and After come from a pair of lines in the forced elaboration
116 -- order file.
118 Elab,
119 -- After directly mentions Before in a pragma Elaborate, so the body of
120 -- Before must be elaborated before After is elaborated.
122 Elab_All,
123 -- After either mentions Before directly in a pragma Elaborate_All, or
124 -- mentions a third unit, X, which itself requires that Before be
125 -- elaborated before unit X is elaborated. The Elab_All_Link list traces
126 -- the dependencies in the latter case.
128 Elab_All_Desirable,
129 -- This is just like Elab_All, except that the Elaborate_All was not
130 -- explicitly present in the source, but rather was created by the front
131 -- end, which decided that it was "desirable".
133 Elab_Desirable,
134 -- This is just like Elab, except that the Elaborate was not explicitly
135 -- present in the source, but rather was created by the front end, which
136 -- decided that it was "desirable".
138 Spec_First);
139 -- After is a body, and Before is the corresponding spec
141 -- Successor_Link contains the information for one link
143 type Successor_Link is record
144 Before : Unit_Id;
145 -- Predecessor unit
147 After : Unit_Id;
148 -- Successor unit
150 Next : Successor_Id;
151 -- Next successor on this list
153 Reason : Succ_Reason;
154 -- Reason for this link
156 Elab_Body : Boolean;
157 -- Set True if this link is needed for the special Elaborate_Body
158 -- processing described below.
160 Reason_Unit : Unit_Id;
161 -- For Reason = Elab, or Elab_All or Elab_Desirable, records the unit
162 -- containing the pragma leading to the link.
164 Elab_All_Link : Elab_All_Id;
165 -- If Reason = Elab_All or Elab_Desirable, then this points to the
166 -- first element in a list of Elab_All entries that record the with
167 -- chain resulting in this particular dependency.
168 end record;
170 -- Note on handling of Elaborate_Body. Basically, if we have a pragma
171 -- Elaborate_Body in a unit, it means that the spec and body have to be
172 -- handled as a single entity from the point of view of determining an
173 -- elaboration order. What we do is to essentially remove the body from
174 -- consideration completely, and transfer all its links (other than the
175 -- spec link) to the spec. Then when the spec gets chosen, we choose the
176 -- body right afterwards. We mark the links that get moved from the body to
177 -- the spec by setting their Elab_Body flag True, so that we can understand
178 -- what is going on.
180 Succ_First : constant := 1;
182 package Succ is new Table.Table
183 (Table_Component_Type => Successor_Link,
184 Table_Index_Type => Successor_Id,
185 Table_Low_Bound => Succ_First,
186 Table_Initial => 500,
187 Table_Increment => 200,
188 Table_Name => "Succ");
190 -- For the case of Elaborate_All, the following table is used to record
191 -- chains of with relationships that lead to the Elab_All link. These are
192 -- used solely for diagnostic purposes
194 type Elab_All_Entry is record
195 Needed_By : Unit_Name_Type;
196 -- Name of unit from which referencing unit was with'ed or otherwise
197 -- needed as a result of Elaborate_All or Elaborate_Desirable.
199 Next_Elab : Elab_All_Id;
200 -- Link to next entry on chain (No_Elab_All_Link marks end of list)
201 end record;
203 package Elab_All_Entries is new Table.Table
204 (Table_Component_Type => Elab_All_Entry,
205 Table_Index_Type => Elab_All_Id,
206 Table_Low_Bound => 1,
207 Table_Initial => 2000,
208 Table_Increment => 200,
209 Table_Name => "Elab_All_Entries");
211 type Unit_Id_Array_Ptr is access Unit_Id_Array;
213 -- A Unit_Node_Record is built for each active unit
215 type Unit_Node_Record is record
216 Successors : Successor_Id;
217 -- Pointer to list of links for successor nodes
219 Num_Pred : Int;
220 -- Number of predecessors for this unit that have not yet been chosen.
221 -- Normally non-negative, but can go negative in the case of units
222 -- chosen by the diagnose error procedure (when cycles are being removed
223 -- from the graph).
225 Nextnp : Unit_Id;
226 -- Forward pointer for list of units with no predecessors
228 Visited : Boolean;
229 -- Used in computing transitive closure for Elaborate_All and also in
230 -- locating cycles and paths in the diagnose routines.
232 Elab_Position : Natural;
233 -- Initialized to zero. Set non-zero when a unit is chosen and placed in
234 -- the elaboration order. The value represents the ordinal position in
235 -- the elaboration order.
237 -- The following are for Elab_New. We compute the strongly connected
238 -- components (SCCs) of the directed graph of units. The edges are the
239 -- Successors, which do not include pragmas Elaborate_All (explicit or
240 -- implicit) in Elab_New. In addition, we assume there is a edge
241 -- pointing from a body to its corresponding spec; this edge is not
242 -- included in Successors, because of course a spec is elaborated BEFORE
243 -- its body, not after.
245 SCC_Root : Unit_Id;
246 -- Each unit points to the root of its SCC, which is just an arbitrary
247 -- member of the SCC. Two units are in the same SCC if and only if their
248 -- SCC_Roots are equal. U is the root of its SCC if and only if
249 -- SCC(U)=U.
251 Nodes : Unit_Id_Array_Ptr;
252 -- Present only in the root of an SCC. This is the set of units in the
253 -- SCC, in no particular order.
255 SCC_Num_Pred : Int;
256 -- Present only in the root of an SCC. This is the number of predecessor
257 -- units of the SCC that are in other SCCs, and that have not yet been
258 -- chosen.
260 Validate_Seen : Boolean := False;
261 -- See procedure Validate below
262 end record;
264 package UNR is new Table.Table
265 (Table_Component_Type => Unit_Node_Record,
266 Table_Index_Type => Unit_Id,
267 Table_Low_Bound => First_Unit_Entry,
268 Table_Initial => 500,
269 Table_Increment => 200,
270 Table_Name => "UNR");
272 No_Pred : Unit_Id;
273 -- Head of list of items with no predecessors
275 Num_Left : Int;
276 -- Number of entries not yet dealt with
278 Cur_Unit : Unit_Id;
279 -- Current unit, set by Gather_Dependencies, and picked up in Build_Link to
280 -- set the Reason_Unit field of the created dependency link.
282 Num_Chosen : Natural;
283 -- Number of units chosen in the elaboration order so far
285 -----------------------
286 -- Local Subprograms --
287 -----------------------
289 function Debug_Flag_Older return Boolean;
290 function Debug_Flag_Old return Boolean;
291 -- True if debug flags select the old or older algorithms. Pretty much any
292 -- change to elaboration order can break some programs. For example,
293 -- programs can depend on elaboration order even without failing
294 -- access-before-elaboration checks. A trivial example is a program that
295 -- prints text during elaboration. Therefore, we have flags to revert to
296 -- the old(er) algorithms.
298 procedure Validate (Order : Unit_Id_Array; Doing_New : Boolean);
299 -- Assert that certain properties are true
301 function Better_Choice_Optimistic
302 (U1 : Unit_Id;
303 U2 : Unit_Id) return Boolean;
304 -- U1 and U2 are both permitted candidates for selection as the next unit
305 -- to be elaborated. This function determines whether U1 is a better choice
306 -- than U2, i.e. should be elaborated in preference to U2, based on a set
307 -- of heuristics that establish a friendly and predictable order (see body
308 -- for details). The result is True if U1 is a better choice than U2, and
309 -- False if it is a worse choice, or there is no preference between them.
311 function Better_Choice_Pessimistic
312 (U1 : Unit_Id;
313 U2 : Unit_Id) return Boolean;
314 -- This is like Better_Choice_Optimistic, and has the same interface, but
315 -- returns true if U1 is a worse choice than U2 in the sense of the -p
316 -- (pessimistic elaboration order) switch. We still have to obey Ada rules,
317 -- so it is not quite the direct inverse of Better_Choice_Optimistic.
319 function Better_Choice (U1 : Unit_Id; U2 : Unit_Id) return Boolean;
320 -- Calls Better_Choice_Optimistic or Better_Choice_Pessimistic as
321 -- appropriate. Also takes care of the U2 = No_Unit_Id case.
323 procedure Build_Link
324 (Before : Unit_Id;
325 After : Unit_Id;
326 R : Succ_Reason;
327 Ea_Id : Elab_All_Id := No_Elab_All_Link);
328 -- Establish a successor link, Before must be elaborated before After, and
329 -- the reason for the link is R. Ea_Id is the contents to be placed in the
330 -- Elab_All_Link of the entry.
332 procedure Choose (Elab_Order : in out Unit_Id_Table; Chosen : Unit_Id);
333 -- Chosen is the next entry chosen in the elaboration order. This procedure
334 -- updates all data structures appropriately.
336 function Corresponding_Body (U : Unit_Id) return Unit_Id;
337 pragma Inline (Corresponding_Body);
338 -- Given a unit that is a spec for which there is a separate body, return
339 -- the unit id of the body. It is an error to call this routine with a unit
340 -- that is not a spec, or that does not have a separate body.
342 function Corresponding_Spec (U : Unit_Id) return Unit_Id;
343 pragma Inline (Corresponding_Spec);
344 -- Given a unit that is a body for which there is a separate spec, return
345 -- the unit id of the spec. It is an error to call this routine with a unit
346 -- that is not a body, or that does not have a separate spec.
348 procedure Diagnose_Elaboration_Problem
349 (Elab_Order : in out Unit_Id_Table);
350 -- Called when no elaboration order can be found. Outputs an appropriate
351 -- diagnosis of the problem, and then abandons the bind.
353 procedure Elab_All_Links
354 (Before : Unit_Id;
355 After : Unit_Id;
356 Reason : Succ_Reason;
357 Link : Elab_All_Id);
358 -- Used to compute the transitive closure of elaboration links for an
359 -- Elaborate_All pragma (Reason = Elab_All) or for an indication of
360 -- Elaborate_All_Desirable (Reason = Elab_All_Desirable). Unit After has a
361 -- pragma Elaborate_All or the front end has determined that a reference
362 -- probably requires Elaborate_All, and unit Before must be previously
363 -- elaborated. First a link is built making sure that unit Before is
364 -- elaborated before After, then a recursive call ensures that we also
365 -- build links for any units needed by Before (i.e. these units must/should
366 -- also be elaborated before After). Link is used to build a chain of
367 -- Elab_All_Entries to explain the reason for a link. The value passed is
368 -- the chain so far.
370 procedure Elab_Error_Msg (S : Successor_Id);
371 -- Given a successor link, outputs an error message of the form
372 -- "$ must be elaborated before $ ..." where ... is the reason.
374 procedure Force_Elab_Order;
375 -- Gather dependencies from the forced elaboration order file (-f switch)
377 procedure Gather_Dependencies;
378 -- Compute dependencies, building the Succ and UNR tables
380 procedure Init;
381 -- Initialize global data structures in this package body
383 function Is_Body_Unit (U : Unit_Id) return Boolean;
384 pragma Inline (Is_Body_Unit);
385 -- Determines if given unit is a body
387 function Is_Pure_Or_Preelab_Unit (U : Unit_Id) return Boolean;
388 -- Returns True if corresponding unit is Pure or Preelaborate. Includes
389 -- dealing with testing flags on spec if it is given a body.
391 function Is_Waiting_Body (U : Unit_Id) return Boolean;
392 pragma Inline (Is_Waiting_Body);
393 -- Determines if U is a waiting body, defined as a body that has
394 -- not been elaborated, but whose spec has been elaborated.
396 function Make_Elab_All_Entry
397 (Unam : Unit_Name_Type;
398 Link : Elab_All_Id) return Elab_All_Id;
399 -- Make an Elab_All_Entries table entry with the given Unam and Link
401 function Unit_Id_Of (Uname : Unit_Name_Type) return Unit_Id;
402 -- This function uses the Info field set in the names table to obtain
403 -- the unit Id of a unit, given its name id value.
405 procedure Write_Closure (Order : Unit_Id_Array);
406 -- Write the closure. This is for the -R and -Ra switches, "list closure
407 -- display".
409 procedure Write_Dependencies;
410 -- Write out dependencies (called only if appropriate option is set)
412 procedure Write_Elab_All_Chain (S : Successor_Id);
413 -- If the reason for the link S is Elaborate_All or Elaborate_Desirable,
414 -- then this routine will output the "needed by" explanation chain.
416 procedure Write_Elab_Order (Order : Unit_Id_Array; Title : String);
417 -- Display elaboration order. This is for the -l switch. Title is a heading
418 -- to print; an empty string is passed to indicate Zero_Formatting.
420 package Elab_New is
422 -- Implementation of the new algorithm
424 procedure Write_SCC (U : Unit_Id);
425 -- Write the unit names of the units in the SCC in which U lives
427 procedure Find_Elab_Order (Elab_Order : out Unit_Id_Table);
429 Illegal_Elab_All : Boolean := False;
430 -- Set true if Find_Elab_Order found an illegal pragma Elaborate_All
431 -- (explicit or implicit).
433 function SCC (U : Unit_Id) return Unit_Id;
434 -- The root of the strongly connected component containing U
436 function SCC_Num_Pred (U : Unit_Id) return Int;
437 -- The SCC_Num_Pred of the SCC in which U lives
439 function Nodes (U : Unit_Id) return Unit_Id_Array_Ptr;
440 -- The nodes of the strongly connected component containing U
442 end Elab_New;
444 use Elab_New;
446 package Elab_Old is
448 -- Implementation of the old algorithm
450 procedure Find_Elab_Order (Elab_Order : out Unit_Id_Table);
452 end Elab_Old;
454 -- Most of the code is shared between old and new; such code is outside
455 -- packages Elab_Old and Elab_New.
457 -------------------
458 -- Better_Choice --
459 -------------------
461 function Better_Choice (U1 : Unit_Id; U2 : Unit_Id) return Boolean is
462 pragma Assert (U1 /= No_Unit_Id);
463 begin
464 if U2 = No_Unit_Id then
465 return True;
466 end if;
468 if Pessimistic_Elab_Order then
469 return Better_Choice_Pessimistic (U1, U2);
470 else
471 return Better_Choice_Optimistic (U1, U2);
472 end if;
473 end Better_Choice;
475 ------------------------------
476 -- Better_Choice_Optimistic --
477 ------------------------------
479 function Better_Choice_Optimistic
480 (U1 : Unit_Id;
481 U2 : Unit_Id) return Boolean
483 UT1 : Unit_Record renames Units.Table (U1);
484 UT2 : Unit_Record renames Units.Table (U2);
486 begin
487 if Debug_Flag_B then
488 Write_Str ("Better_Choice_Optimistic (");
489 Write_Unit_Name (UT1.Uname);
490 Write_Str (", ");
491 Write_Unit_Name (UT2.Uname);
492 Write_Line (")");
493 end if;
495 -- Note: the checks here are applied in sequence, and the ordering is
496 -- significant (i.e. the more important criteria are applied first).
498 -- Prefer a waiting body to one that is not a waiting body
500 if Is_Waiting_Body (U1) and then not Is_Waiting_Body (U2) then
501 if Debug_Flag_B then
502 Write_Line (" True: u1 is waiting body, u2 is not");
503 end if;
505 return True;
507 elsif Is_Waiting_Body (U2) and then not Is_Waiting_Body (U1) then
508 if Debug_Flag_B then
509 Write_Line (" False: u2 is waiting body, u1 is not");
510 end if;
512 return False;
514 -- Prefer a predefined unit to a non-predefined unit
516 elsif UT1.Predefined and then not UT2.Predefined then
517 if Debug_Flag_B then
518 Write_Line (" True: u1 is predefined, u2 is not");
519 end if;
521 return True;
523 elsif UT2.Predefined and then not UT1.Predefined then
524 if Debug_Flag_B then
525 Write_Line (" False: u2 is predefined, u1 is not");
526 end if;
528 return False;
530 -- Prefer an internal unit to a non-internal unit
532 elsif UT1.Internal and then not UT2.Internal then
533 if Debug_Flag_B then
534 Write_Line (" True: u1 is internal, u2 is not");
535 end if;
536 return True;
538 elsif UT2.Internal and then not UT1.Internal then
539 if Debug_Flag_B then
540 Write_Line (" False: u2 is internal, u1 is not");
541 end if;
543 return False;
545 -- Prefer a pure or preelaborated unit to one that is not. Pure should
546 -- come before preelaborated.
548 elsif Is_Pure_Or_Preelab_Unit (U1)
549 and then not
550 Is_Pure_Or_Preelab_Unit (U2)
551 then
552 if Debug_Flag_B then
553 Write_Line (" True: u1 is pure/preelab, u2 is not");
554 end if;
556 return True;
558 elsif Is_Pure_Or_Preelab_Unit (U2)
559 and then not
560 Is_Pure_Or_Preelab_Unit (U1)
561 then
562 if Debug_Flag_B then
563 Write_Line (" False: u2 is pure/preelab, u1 is not");
564 end if;
566 return False;
568 -- Prefer a body to a spec
570 elsif Is_Body_Unit (U1) and then not Is_Body_Unit (U2) then
571 if Debug_Flag_B then
572 Write_Line (" True: u1 is body, u2 is not");
573 end if;
575 return True;
577 elsif Is_Body_Unit (U2) and then not Is_Body_Unit (U1) then
578 if Debug_Flag_B then
579 Write_Line (" False: u2 is body, u1 is not");
580 end if;
582 return False;
584 -- If both are waiting bodies, then prefer the one whose spec is more
585 -- recently elaborated. Consider the following:
587 -- spec of A
588 -- spec of B
589 -- body of A or B?
591 -- The normal waiting body preference would have placed the body of A
592 -- before the spec of B if it could. Since it could not, then it must be
593 -- the case that A depends on B. It is therefore a good idea to put the
594 -- body of B first.
596 elsif Is_Waiting_Body (U1) and then Is_Waiting_Body (U2) then
597 declare
598 Result : constant Boolean :=
599 UNR.Table (Corresponding_Spec (U1)).Elab_Position >
600 UNR.Table (Corresponding_Spec (U2)).Elab_Position;
601 begin
602 if Debug_Flag_B then
603 if Result then
604 Write_Line (" True: based on waiting body elab positions");
605 else
606 Write_Line (" False: based on waiting body elab positions");
607 end if;
608 end if;
610 return Result;
611 end;
612 end if;
614 -- Remaining choice rules are disabled by Debug flag -do
616 if not Debug_Flag_Older then
618 -- The following deal with the case of specs that have been marked
619 -- as Elaborate_Body_Desirable. We generally want to delay these
620 -- specs as long as possible, so that the bodies have a better chance
621 -- of being elaborated closer to the specs.
623 -- If we have two units, one of which is a spec for which this flag
624 -- is set, and the other is not, we prefer to delay the spec for
625 -- which the flag is set.
627 if not UT1.Elaborate_Body_Desirable
628 and then UT2.Elaborate_Body_Desirable
629 then
630 if Debug_Flag_B then
631 Write_Line (" True: u1 is elab body desirable, u2 is not");
632 end if;
634 return True;
636 elsif not UT2.Elaborate_Body_Desirable
637 and then UT1.Elaborate_Body_Desirable
638 then
639 if Debug_Flag_B then
640 Write_Line (" False: u1 is elab body desirable, u2 is not");
641 end if;
643 return False;
645 -- If we have two specs that are both marked as Elaborate_Body
646 -- desirable, we prefer the one whose body is nearer to being able
647 -- to be elaborated, based on the Num_Pred count. This helps to
648 -- ensure bodies are as close to specs as possible.
650 elsif UT1.Elaborate_Body_Desirable
651 and then UT2.Elaborate_Body_Desirable
652 then
653 declare
654 Result : constant Boolean :=
655 UNR.Table (Corresponding_Body (U1)).Num_Pred <
656 UNR.Table (Corresponding_Body (U2)).Num_Pred;
657 begin
658 if Debug_Flag_B then
659 if Result then
660 Write_Line (" True based on Num_Pred compare");
661 else
662 Write_Line (" False based on Num_Pred compare");
663 end if;
664 end if;
666 return Result;
667 end;
668 end if;
669 end if;
671 -- If we have two specs in the same SCC, choose the one whose body is
672 -- closer to being ready.
674 if Doing_New
675 and then SCC (U1) = SCC (U2)
676 and then Units.Table (U1).Utype = Is_Spec
677 and then Units.Table (U2).Utype = Is_Spec
678 and then UNR.Table (Corresponding_Body (U1)).Num_Pred /=
679 UNR.Table (Corresponding_Body (U2)).Num_Pred
680 then
681 if UNR.Table (Corresponding_Body (U1)).Num_Pred <
682 UNR.Table (Corresponding_Body (U2)).Num_Pred
683 then
684 if Debug_Flag_B then
685 Write_Str (" True: same SCC; ");
686 Write_Int (UNR.Table (Corresponding_Body (U1)).Num_Pred);
687 Write_Str (" < ");
688 Write_Int (UNR.Table (Corresponding_Body (U2)).Num_Pred);
689 Write_Eol;
690 end if;
692 return True;
693 else
694 if Debug_Flag_B then
695 Write_Str (" False: same SCC; ");
696 Write_Int (UNR.Table (Corresponding_Body (U1)).Num_Pred);
697 Write_Str (" > ");
698 Write_Int (UNR.Table (Corresponding_Body (U2)).Num_Pred);
699 Write_Eol;
700 end if;
702 return False;
703 end if;
704 end if;
706 -- If we fall through, it means that no preference rule applies, so we
707 -- use alphabetical order to at least give a deterministic result.
709 if Debug_Flag_B then
710 Write_Line (" choose on alpha order");
711 end if;
713 return Uname_Less (UT1.Uname, UT2.Uname);
714 end Better_Choice_Optimistic;
716 -------------------------------
717 -- Better_Choice_Pessimistic --
718 -------------------------------
720 function Better_Choice_Pessimistic
721 (U1 : Unit_Id;
722 U2 : Unit_Id) return Boolean
724 UT1 : Unit_Record renames Units.Table (U1);
725 UT2 : Unit_Record renames Units.Table (U2);
727 begin
728 if Debug_Flag_B then
729 Write_Str ("Better_Choice_Pessimistic (");
730 Write_Unit_Name (UT1.Uname);
731 Write_Str (", ");
732 Write_Unit_Name (UT2.Uname);
733 Write_Line (")");
734 end if;
736 -- Note: the checks here are applied in sequence, and the ordering is
737 -- significant (i.e. the more important criteria are applied first).
739 -- If either unit is predefined or internal, then we use the normal
740 -- Better_Choice_Optimistic rule, since we don't want to disturb the
741 -- elaboration rules of the language with -p; same treatment for
742 -- Pure/Preelab.
744 -- Prefer a predefined unit to a non-predefined unit
746 if UT1.Predefined and then not UT2.Predefined then
747 if Debug_Flag_B then
748 Write_Line (" True: u1 is predefined, u2 is not");
749 end if;
751 return True;
753 elsif UT2.Predefined and then not UT1.Predefined then
754 if Debug_Flag_B then
755 Write_Line (" False: u2 is predefined, u1 is not");
756 end if;
758 return False;
760 -- Prefer an internal unit to a non-internal unit
762 elsif UT1.Internal and then not UT2.Internal then
763 if Debug_Flag_B then
764 Write_Line (" True: u1 is internal, u2 is not");
765 end if;
767 return True;
769 elsif UT2.Internal and then not UT1.Internal then
770 if Debug_Flag_B then
771 Write_Line (" False: u2 is internal, u1 is not");
772 end if;
774 return False;
776 -- Prefer a pure or preelaborated unit to one that is not
778 elsif Is_Pure_Or_Preelab_Unit (U1)
779 and then not
780 Is_Pure_Or_Preelab_Unit (U2)
781 then
782 if Debug_Flag_B then
783 Write_Line (" True: u1 is pure/preelab, u2 is not");
784 end if;
786 return True;
788 elsif Is_Pure_Or_Preelab_Unit (U2)
789 and then not
790 Is_Pure_Or_Preelab_Unit (U1)
791 then
792 if Debug_Flag_B then
793 Write_Line (" False: u2 is pure/preelab, u1 is not");
794 end if;
796 return False;
798 -- Prefer anything else to a waiting body. We want to make bodies wait
799 -- as long as possible, till we are forced to choose them.
801 elsif Is_Waiting_Body (U1) and then not Is_Waiting_Body (U2) then
802 if Debug_Flag_B then
803 Write_Line (" False: u1 is waiting body, u2 is not");
804 end if;
806 return False;
808 elsif Is_Waiting_Body (U2) and then not Is_Waiting_Body (U1) then
809 if Debug_Flag_B then
810 Write_Line (" True: u2 is waiting body, u1 is not");
811 end if;
813 return True;
815 -- Prefer a spec to a body (this is mandatory)
817 elsif Is_Body_Unit (U1) and then not Is_Body_Unit (U2) then
818 if Debug_Flag_B then
819 Write_Line (" False: u1 is body, u2 is not");
820 end if;
822 return False;
824 elsif Is_Body_Unit (U2) and then not Is_Body_Unit (U1) then
825 if Debug_Flag_B then
826 Write_Line (" True: u2 is body, u1 is not");
827 end if;
829 return True;
831 -- If both are waiting bodies, then prefer the one whose spec is less
832 -- recently elaborated. Consider the following:
834 -- spec of A
835 -- spec of B
836 -- body of A or B?
838 -- The normal waiting body preference would have placed the body of A
839 -- before the spec of B if it could. Since it could not, then it must be
840 -- the case that A depends on B. It is therefore a good idea to put the
841 -- body of B last so that if there is an elaboration order problem, we
842 -- will find it (that's what pessimistic order is about).
844 elsif Is_Waiting_Body (U1) and then Is_Waiting_Body (U2) then
845 declare
846 Result : constant Boolean :=
847 UNR.Table (Corresponding_Spec (U1)).Elab_Position <
848 UNR.Table (Corresponding_Spec (U2)).Elab_Position;
849 begin
850 if Debug_Flag_B then
851 if Result then
852 Write_Line (" True: based on waiting body elab positions");
853 else
854 Write_Line (" False: based on waiting body elab positions");
855 end if;
856 end if;
858 return Result;
859 end;
860 end if;
862 -- Remaining choice rules are disabled by Debug flag -do
864 if not Debug_Flag_Older then
866 -- The following deal with the case of specs that have been marked as
867 -- Elaborate_Body_Desirable. In the normal case, we generally want to
868 -- delay the elaboration of these specs as long as possible, so that
869 -- bodies have better chance of being elaborated closer to the specs.
870 -- Better_Choice_Pessimistic as usual wants to do the opposite and
871 -- elaborate such specs as early as possible.
873 -- If we have two units, one of which is a spec for which this flag
874 -- is set, and the other is not, we normally prefer to delay the spec
875 -- for which the flag is set, so again Better_Choice_Pessimistic does
876 -- the opposite.
878 if not UT1.Elaborate_Body_Desirable
879 and then UT2.Elaborate_Body_Desirable
880 then
881 if Debug_Flag_B then
882 Write_Line (" False: u1 is elab body desirable, u2 is not");
883 end if;
885 return False;
887 elsif not UT2.Elaborate_Body_Desirable
888 and then UT1.Elaborate_Body_Desirable
889 then
890 if Debug_Flag_B then
891 Write_Line (" True: u1 is elab body desirable, u2 is not");
892 end if;
894 return True;
896 -- If we have two specs that are both marked as Elaborate_Body
897 -- desirable, we normally prefer the one whose body is nearer to
898 -- being able to be elaborated, based on the Num_Pred count. This
899 -- helps to ensure bodies are as close to specs as possible. As
900 -- usual, Better_Choice_Pessimistic does the opposite.
902 elsif UT1.Elaborate_Body_Desirable
903 and then UT2.Elaborate_Body_Desirable
904 then
905 declare
906 Result : constant Boolean :=
907 UNR.Table (Corresponding_Body (U1)).Num_Pred >=
908 UNR.Table (Corresponding_Body (U2)).Num_Pred;
909 begin
910 if Debug_Flag_B then
911 if Result then
912 Write_Line (" True based on Num_Pred compare");
913 else
914 Write_Line (" False based on Num_Pred compare");
915 end if;
916 end if;
918 return Result;
919 end;
920 end if;
921 end if;
923 -- If we fall through, it means that no preference rule applies, so we
924 -- use alphabetical order to at least give a deterministic result. Since
925 -- Better_Choice_Pessimistic is in the business of stirring up the
926 -- order, we will use reverse alphabetical ordering.
928 if Debug_Flag_B then
929 Write_Line (" choose on reverse alpha order");
930 end if;
932 return Uname_Less (UT2.Uname, UT1.Uname);
933 end Better_Choice_Pessimistic;
935 ----------------
936 -- Build_Link --
937 ----------------
939 procedure Build_Link
940 (Before : Unit_Id;
941 After : Unit_Id;
942 R : Succ_Reason;
943 Ea_Id : Elab_All_Id := No_Elab_All_Link)
945 Cspec : Unit_Id;
947 begin
948 Succ.Append
949 ((Before => Before,
950 After => No_Unit_Id, -- filled in below
951 Next => UNR.Table (Before).Successors,
952 Reason => R,
953 Elab_Body => False, -- set correctly below
954 Reason_Unit => Cur_Unit,
955 Elab_All_Link => Ea_Id));
956 UNR.Table (Before).Successors := Succ.Last;
958 -- Deal with special Elab_Body case. If the After of this link is
959 -- a body whose spec has Elaborate_All set, and this is not the link
960 -- directly from the body to the spec, then we make the After of the
961 -- link reference its spec instead, marking the link appropriately.
963 if Units.Table (After).Utype = Is_Body then
964 Cspec := Corresponding_Spec (After);
966 if Units.Table (Cspec).Elaborate_Body
967 and then Cspec /= Before
968 then
969 Succ.Table (Succ.Last).After := Cspec;
970 Succ.Table (Succ.Last).Elab_Body := True;
971 UNR.Table (Cspec).Num_Pred := UNR.Table (Cspec).Num_Pred + 1;
972 return;
973 end if;
974 end if;
976 -- Fall through on normal case
978 Succ.Table (Succ.Last).After := After;
979 Succ.Table (Succ.Last).Elab_Body := False;
980 UNR.Table (After).Num_Pred := UNR.Table (After).Num_Pred + 1;
981 end Build_Link;
983 ------------
984 -- Choose --
985 ------------
987 procedure Choose (Elab_Order : in out Unit_Id_Table; Chosen : Unit_Id) is
988 pragma Assert (Chosen /= No_Unit_Id);
989 S : Successor_Id;
990 U : Unit_Id;
992 begin
993 if Debug_Flag_C then
994 Write_Str ("Choosing Unit ");
995 Write_Unit_Name (Units.Table (Chosen).Uname);
996 Write_Eol;
997 end if;
999 -- We shouldn't be choosing something with unelaborated predecessors,
1000 -- and we shouldn't call this twice on the same unit. But that's not
1001 -- true when this is called from Diagnose_Elaboration_Problem.
1003 if Errors_Detected = 0 then
1004 pragma Assert (UNR.Table (Chosen).Num_Pred = 0);
1005 pragma Assert (UNR.Table (Chosen).Elab_Position = 0);
1006 pragma Assert (not Doing_New or else SCC_Num_Pred (Chosen) = 0);
1007 null;
1008 end if;
1010 -- Add to elaboration order. Note that units having no elaboration code
1011 -- are not treated specially yet. The special casing of this is in
1012 -- Bindgen, where Gen_Elab_Calls skips over them. Meanwhile we need them
1013 -- here, because the object file list is also driven by the contents of
1014 -- the Elab_Order table.
1016 Append (Elab_Order, Chosen);
1018 -- Remove from No_Pred list. This is a little inefficient and may be we
1019 -- should doubly link the list, but it will do for now.
1021 if No_Pred = Chosen then
1022 No_Pred := UNR.Table (Chosen).Nextnp;
1024 else
1025 -- Note that we just ignore the situation where it does not
1026 -- appear in the No_Pred list, this happens in calls from the
1027 -- Diagnose_Elaboration_Problem routine, where cycles are being
1028 -- removed arbitrarily from the graph.
1030 U := No_Pred;
1031 while U /= No_Unit_Id loop
1032 if UNR.Table (U).Nextnp = Chosen then
1033 UNR.Table (U).Nextnp := UNR.Table (Chosen).Nextnp;
1034 exit;
1035 end if;
1037 U := UNR.Table (U).Nextnp;
1038 end loop;
1039 end if;
1041 -- For all successors, decrement the number of predecessors, and if it
1042 -- becomes zero, then add to no-predecessor list.
1044 S := UNR.Table (Chosen).Successors;
1045 while S /= No_Successor loop
1046 U := Succ.Table (S).After;
1047 UNR.Table (U).Num_Pred := UNR.Table (U).Num_Pred - 1;
1049 if Debug_Flag_N then
1050 Write_Str (" decrementing Num_Pred for unit ");
1051 Write_Unit_Name (Units.Table (U).Uname);
1052 Write_Str (" new value = ");
1053 Write_Int (UNR.Table (U).Num_Pred);
1054 Write_Eol;
1055 end if;
1057 if UNR.Table (U).Num_Pred = 0 then
1058 UNR.Table (U).Nextnp := No_Pred;
1059 No_Pred := U;
1060 end if;
1062 if Doing_New and then SCC (U) /= SCC (Chosen) then
1063 UNR.Table (SCC (U)).SCC_Num_Pred :=
1064 UNR.Table (SCC (U)).SCC_Num_Pred - 1;
1066 if Debug_Flag_N then
1067 Write_Str (" decrementing SCC_Num_Pred for unit ");
1068 Write_Unit_Name (Units.Table (U).Uname);
1069 Write_Str (" new value = ");
1070 Write_Int (SCC_Num_Pred (U));
1071 Write_Eol;
1072 end if;
1073 end if;
1075 S := Succ.Table (S).Next;
1076 end loop;
1078 -- All done, adjust number of units left count and set elaboration pos
1080 Num_Left := Num_Left - 1;
1081 Num_Chosen := Num_Chosen + 1;
1083 pragma Assert
1084 (Errors_Detected > 0 or else Num_Chosen = Natural (Last (Elab_Order)));
1086 UNR.Table (Chosen).Elab_Position := Num_Chosen;
1088 -- If we just chose a spec with Elaborate_Body set, then we must
1089 -- immediately elaborate the body, before any other units.
1091 if Units.Table (Chosen).Elaborate_Body then
1093 -- If the unit is a spec only, then there is no body. This is a bit
1094 -- odd given that Elaborate_Body is here, but it is valid in an RCI
1095 -- unit, where we only have the interface in the stub bind.
1097 if Units.Table (Chosen).Utype = Is_Spec_Only
1098 and then Units.Table (Chosen).RCI
1099 then
1100 null;
1101 else
1102 Choose (Elab_Order, Corresponding_Body (Chosen));
1103 end if;
1104 end if;
1105 end Choose;
1107 ------------------------
1108 -- Corresponding_Body --
1109 ------------------------
1111 -- Currently if the body and spec are separate, then they appear as two
1112 -- separate units in the same ALI file, with the body appearing first and
1113 -- the spec appearing second.
1115 function Corresponding_Body (U : Unit_Id) return Unit_Id is
1116 begin
1117 pragma Assert (Units.Table (U).Utype = Is_Spec);
1118 return U - 1;
1119 end Corresponding_Body;
1121 ------------------------
1122 -- Corresponding_Spec --
1123 ------------------------
1125 -- Currently if the body and spec are separate, then they appear as two
1126 -- separate units in the same ALI file, with the body appearing first and
1127 -- the spec appearing second.
1129 function Corresponding_Spec (U : Unit_Id) return Unit_Id is
1130 begin
1131 pragma Assert (Units.Table (U).Utype = Is_Body);
1132 return U + 1;
1133 end Corresponding_Spec;
1135 --------------------
1136 -- Debug_Flag_Old --
1137 --------------------
1139 function Debug_Flag_Old return Boolean is
1140 begin
1141 return Debug_Flag_P;
1142 end Debug_Flag_Old;
1144 ----------------------
1145 -- Debug_Flag_Older --
1146 ----------------------
1148 function Debug_Flag_Older return Boolean is
1149 begin
1150 return Debug_Flag_O;
1151 end Debug_Flag_Older;
1153 ----------------------------------
1154 -- Diagnose_Elaboration_Problem --
1155 ----------------------------------
1157 procedure Diagnose_Elaboration_Problem
1158 (Elab_Order : in out Unit_Id_Table)
1160 function Find_Path
1161 (Ufrom : Unit_Id;
1162 Uto : Unit_Id;
1163 ML : Nat) return Boolean;
1164 -- Recursive routine used to find a path from node Ufrom to node Uto.
1165 -- If a path exists, returns True and outputs an appropriate set of
1166 -- error messages giving the path. Also calls Choose for each of the
1167 -- nodes so that they get removed from the remaining set. There are
1168 -- two cases of calls, either Ufrom = Uto for an attempt to find a
1169 -- cycle, or Ufrom is a spec and Uto the corresponding body for the
1170 -- case of an unsatisfiable Elaborate_Body pragma. ML is the minimum
1171 -- acceptable length for a path.
1173 ---------------
1174 -- Find_Path --
1175 ---------------
1177 function Find_Path
1178 (Ufrom : Unit_Id;
1179 Uto : Unit_Id;
1180 ML : Nat) return Boolean
1182 function Find_Link (U : Unit_Id; PL : Nat) return Boolean;
1183 -- This is the inner recursive routine, it determines if a path
1184 -- exists from U to Uto, and if so returns True and outputs the
1185 -- appropriate set of error messages. PL is the path length
1187 ---------------
1188 -- Find_Link --
1189 ---------------
1191 function Find_Link (U : Unit_Id; PL : Nat) return Boolean is
1192 S : Successor_Id;
1194 begin
1195 -- Recursion ends if we are at terminating node and the path is
1196 -- sufficiently long, generate error message and return True.
1198 if U = Uto and then PL >= ML then
1199 Choose (Elab_Order, U);
1200 return True;
1202 -- All done if already visited
1204 elsif UNR.Table (U).Visited then
1205 return False;
1207 -- Otherwise mark as visited and look at all successors
1209 else
1210 UNR.Table (U).Visited := True;
1212 S := UNR.Table (U).Successors;
1213 while S /= No_Successor loop
1214 if Find_Link (Succ.Table (S).After, PL + 1) then
1215 Elab_Error_Msg (S);
1216 Choose (Elab_Order, U);
1217 return True;
1218 end if;
1220 S := Succ.Table (S).Next;
1221 end loop;
1223 -- Falling through means this does not lead to a path
1225 return False;
1226 end if;
1227 end Find_Link;
1229 -- Start of processing for Find_Path
1231 begin
1232 -- Initialize all non-chosen nodes to not visited yet
1234 for U in Units.First .. Units.Last loop
1235 UNR.Table (U).Visited := UNR.Table (U).Elab_Position /= 0;
1236 end loop;
1238 -- Now try to find the path
1240 return Find_Link (Ufrom, 0);
1241 end Find_Path;
1243 -- Start of processing for Diagnose_Elaboration_Problem
1245 begin
1246 Set_Standard_Error;
1248 -- Output state of things if debug flag N set
1250 if Debug_Flag_N then
1251 declare
1252 NP : Int;
1254 begin
1255 Write_Eol;
1256 Write_Eol;
1257 Write_Str ("Diagnose_Elaboration_Problem called");
1258 Write_Eol;
1259 Write_Str ("List of remaining unchosen units and predecessors");
1260 Write_Eol;
1262 for U in Units.First .. Units.Last loop
1263 if UNR.Table (U).Elab_Position = 0 then
1264 NP := UNR.Table (U).Num_Pred;
1265 Write_Eol;
1266 Write_Str (" Unchosen unit: #");
1267 Write_Int (Int (U));
1268 Write_Str (" ");
1269 Write_Unit_Name (Units.Table (U).Uname);
1270 Write_Str (" (Num_Pred = ");
1271 Write_Int (NP);
1272 Write_Char (')');
1273 Write_Eol;
1275 if NP = 0 then
1276 if Units.Table (U).Elaborate_Body then
1277 Write_Str
1278 (" (not chosen because of Elaborate_Body)");
1279 Write_Eol;
1280 else
1281 Write_Str (" ****************** why not chosen?");
1282 Write_Eol;
1283 end if;
1284 end if;
1286 -- Search links list to find unchosen predecessors
1288 for S in Succ.First .. Succ.Last loop
1289 declare
1290 SL : Successor_Link renames Succ.Table (S);
1292 begin
1293 if SL.After = U
1294 and then UNR.Table (SL.Before).Elab_Position = 0
1295 then
1296 Write_Str (" unchosen predecessor: #");
1297 Write_Int (Int (SL.Before));
1298 Write_Str (" ");
1299 Write_Unit_Name (Units.Table (SL.Before).Uname);
1300 Write_Eol;
1301 NP := NP - 1;
1302 end if;
1303 end;
1304 end loop;
1306 if NP /= 0 then
1307 Write_Str (" **************** Num_Pred value wrong!");
1308 Write_Eol;
1309 end if;
1310 end if;
1311 end loop;
1312 end;
1313 end if;
1315 -- Output the header for the error, and manually increment the error
1316 -- count. We are using Error_Msg_Output rather than Error_Msg here for
1317 -- two reasons:
1319 -- This is really only one error, not one for each line
1320 -- We want this output on standard output since it is voluminous
1322 -- But we do need to deal with the error count manually in this case
1324 Errors_Detected := Errors_Detected + 1;
1325 Error_Msg_Output ("elaboration circularity detected", Info => False);
1327 -- Try to find cycles starting with any of the remaining nodes that have
1328 -- not yet been chosen. There must be at least one (there is some reason
1329 -- we are being called).
1331 for U in Units.First .. Units.Last loop
1332 if UNR.Table (U).Elab_Position = 0 then
1333 if Find_Path (U, U, 1) then
1334 raise Unrecoverable_Error;
1335 end if;
1336 end if;
1337 end loop;
1339 -- We should never get here, since we were called for some reason, and
1340 -- we should have found and eliminated at least one bad path.
1342 raise Program_Error;
1343 end Diagnose_Elaboration_Problem;
1345 --------------------
1346 -- Elab_All_Links --
1347 --------------------
1349 procedure Elab_All_Links
1350 (Before : Unit_Id;
1351 After : Unit_Id;
1352 Reason : Succ_Reason;
1353 Link : Elab_All_Id)
1355 begin
1356 if UNR.Table (Before).Visited then
1357 return;
1358 end if;
1360 -- Build the direct link for Before
1362 UNR.Table (Before).Visited := True;
1363 Build_Link (Before, After, Reason, Link);
1365 -- Process all units with'ed by Before recursively
1367 for W in Units.Table (Before).First_With ..
1368 Units.Table (Before).Last_With
1369 loop
1370 -- Skip if this with is an interface to a stand-alone library. Skip
1371 -- also if no ALI file for this WITH, happens for language defined
1372 -- generics while bootstrapping the compiler (see body of routine
1373 -- Lib.Writ.Write_With_Lines). Finally, skip if it is a limited with
1374 -- clause, which does not impose an elaboration link.
1376 if not Withs.Table (W).SAL_Interface
1377 and then Withs.Table (W).Afile /= No_File
1378 and then not Withs.Table (W).Limited_With
1379 then
1380 declare
1381 Info : constant Int :=
1382 Get_Name_Table_Int (Withs.Table (W).Uname);
1384 begin
1385 -- If the unit is unknown, for some unknown reason, fail
1386 -- graciously explaining that the unit is unknown. Without
1387 -- this check, gnatbind will crash in Unit_Id_Of.
1389 if Info = 0 or else Unit_Id (Info) = No_Unit_Id then
1390 declare
1391 Withed : String :=
1392 Get_Name_String (Withs.Table (W).Uname);
1393 Last_Withed : Natural := Withed'Last;
1394 Withing : String :=
1395 Get_Name_String
1396 (Units.Table (Before).Uname);
1397 Last_Withing : Natural := Withing'Last;
1398 Spec_Body : String := " (Spec)";
1400 begin
1401 To_Mixed (Withed);
1402 To_Mixed (Withing);
1404 if Last_Withed > 2
1405 and then Withed (Last_Withed - 1) = '%'
1406 then
1407 Last_Withed := Last_Withed - 2;
1408 end if;
1410 if Last_Withing > 2
1411 and then Withing (Last_Withing - 1) = '%'
1412 then
1413 Last_Withing := Last_Withing - 2;
1414 end if;
1416 if Units.Table (Before).Utype = Is_Body
1417 or else Units.Table (Before).Utype = Is_Body_Only
1418 then
1419 Spec_Body := " (Body)";
1420 end if;
1422 Osint.Fail
1423 ("could not find unit "
1424 & Withed (Withed'First .. Last_Withed) & " needed by "
1425 & Withing (Withing'First .. Last_Withing) & Spec_Body);
1426 end;
1427 end if;
1429 Elab_All_Links
1430 (Unit_Id_Of (Withs.Table (W).Uname),
1431 After,
1432 Reason,
1433 Make_Elab_All_Entry (Withs.Table (W).Uname, Link));
1434 end;
1435 end if;
1436 end loop;
1438 -- Process corresponding body, if there is one
1440 if Units.Table (Before).Utype = Is_Spec then
1441 Elab_All_Links
1442 (Corresponding_Body (Before),
1443 After, Reason,
1444 Make_Elab_All_Entry
1445 (Units.Table (Corresponding_Body (Before)).Uname, Link));
1446 end if;
1447 end Elab_All_Links;
1449 --------------------
1450 -- Elab_Error_Msg --
1451 --------------------
1453 procedure Elab_Error_Msg (S : Successor_Id) is
1454 SL : Successor_Link renames Succ.Table (S);
1456 begin
1457 -- Nothing to do if internal unit involved and no -da flag
1459 if not Debug_Flag_A
1460 and then
1461 (Is_Internal_File_Name (Units.Table (SL.Before).Sfile)
1462 or else
1463 Is_Internal_File_Name (Units.Table (SL.After).Sfile))
1464 then
1465 return;
1466 end if;
1468 -- Here we want to generate output
1470 Error_Msg_Unit_1 := Units.Table (SL.Before).Uname;
1472 if SL.Elab_Body then
1473 Error_Msg_Unit_2 := Units.Table (Corresponding_Body (SL.After)).Uname;
1474 else
1475 Error_Msg_Unit_2 := Units.Table (SL.After).Uname;
1476 end if;
1478 Error_Msg_Output (" $ must be elaborated before $", Info => True);
1480 Error_Msg_Unit_1 := Units.Table (SL.Reason_Unit).Uname;
1482 case SL.Reason is
1483 when Withed =>
1484 Error_Msg_Output
1485 (" reason: with clause",
1486 Info => True);
1488 when Forced =>
1489 Error_Msg_Output
1490 (" reason: forced by -f switch",
1491 Info => True);
1493 when Elab =>
1494 Error_Msg_Output
1495 (" reason: pragma Elaborate in unit $",
1496 Info => True);
1498 when Elab_All =>
1499 Error_Msg_Output
1500 (" reason: pragma Elaborate_All in unit $",
1501 Info => True);
1503 when Elab_All_Desirable =>
1504 Error_Msg_Output
1505 (" reason: implicit Elaborate_All in unit $",
1506 Info => True);
1508 Error_Msg_Output
1509 (" recompile $ with -gnatel for full details",
1510 Info => True);
1512 when Elab_Desirable =>
1513 Error_Msg_Output
1514 (" reason: implicit Elaborate in unit $",
1515 Info => True);
1517 Error_Msg_Output
1518 (" recompile $ with -gnatel for full details",
1519 Info => True);
1521 when Spec_First =>
1522 Error_Msg_Output
1523 (" reason: spec always elaborated before body",
1524 Info => True);
1525 end case;
1527 Write_Elab_All_Chain (S);
1529 if SL.Elab_Body then
1530 Error_Msg_Unit_1 := Units.Table (SL.Before).Uname;
1531 Error_Msg_Unit_2 := Units.Table (SL.After).Uname;
1532 Error_Msg_Output
1533 (" $ must therefore be elaborated before $", True);
1535 Error_Msg_Unit_1 := Units.Table (SL.After).Uname;
1536 Error_Msg_Output
1537 (" (because $ has a pragma Elaborate_Body)", True);
1538 end if;
1540 if not Zero_Formatting then
1541 Write_Eol;
1542 end if;
1543 end Elab_Error_Msg;
1545 ---------------------
1546 -- Find_Elab_Order --
1547 ---------------------
1549 procedure Find_Elab_Order
1550 (Elab_Order : out Unit_Id_Table;
1551 First_Main_Lib_File : File_Name_Type)
1553 function Num_Spec_Body_Pairs (Order : Unit_Id_Array) return Nat;
1554 -- Number of cases where the body of a unit immediately follows the
1555 -- corresponding spec. Such cases are good, because calls to that unit
1556 -- from outside can't get ABE.
1558 -------------------------
1559 -- Num_Spec_Body_Pairs --
1560 -------------------------
1562 function Num_Spec_Body_Pairs (Order : Unit_Id_Array) return Nat is
1563 Result : Nat := 0;
1565 begin
1566 for J in Order'First + 1 .. Order'Last loop
1567 if Units.Table (Order (J - 1)).Utype = Is_Spec
1568 and then Units.Table (Order (J)).Utype = Is_Body
1569 and then Corresponding_Spec (Order (J)) = Order (J - 1)
1570 then
1571 Result := Result + 1;
1572 end if;
1573 end loop;
1575 return Result;
1576 end Num_Spec_Body_Pairs;
1578 -- Local variables
1580 Old_Elab_Order : Unit_Id_Table;
1582 -- Start of processing for Find_Elab_Order
1584 begin
1585 -- Output warning if -p used with no -gnatE units
1587 if Pessimistic_Elab_Order
1588 and not Dynamic_Elaboration_Checks_Specified
1589 then
1590 Error_Msg ("?use of -p switch questionable");
1591 Error_Msg ("?since all units compiled with static elaboration model");
1592 end if;
1594 if Do_New then
1595 if Debug_Flag_V then
1596 Write_Line ("Doing new...");
1597 end if;
1599 Doing_New := True;
1600 Init;
1601 Elab_New.Find_Elab_Order (Elab_Order);
1602 end if;
1604 -- Elab_New does not support the pessimistic order, so if that was
1605 -- requested, use the old results. Use Elab_Old if -dp was selected.
1606 -- Elab_New does not yet give proper error messages for illegal
1607 -- Elaborate_Alls, so if there is one, run Elab_Old.
1609 if Do_Old
1610 or Pessimistic_Elab_Order
1611 or Debug_Flag_Old
1612 or Illegal_Elab_All
1613 then
1614 if Debug_Flag_V then
1615 Write_Line ("Doing old...");
1616 end if;
1618 Doing_New := False;
1619 Init;
1620 Elab_Old.Find_Elab_Order (Old_Elab_Order);
1621 end if;
1623 declare
1624 Old_Order : Unit_Id_Array renames
1625 Old_Elab_Order.Table (1 .. Last (Old_Elab_Order));
1626 New_Order : Unit_Id_Array renames
1627 Elab_Order.Table (1 .. Last (Elab_Order));
1628 Old_Pairs : constant Nat := Num_Spec_Body_Pairs (Old_Order);
1629 New_Pairs : constant Nat := Num_Spec_Body_Pairs (New_Order);
1631 begin
1632 if Do_Old and Do_New then
1633 Write_Line (Get_Name_String (First_Main_Lib_File));
1635 pragma Assert (Old_Order'Length = New_Order'Length);
1636 pragma Debug (Validate (Old_Order, Doing_New => False));
1637 pragma Debug (Validate (New_Order, Doing_New => True));
1639 -- Misc debug printouts that can be used for experimentation by
1640 -- changing the 'if's below.
1642 if True then
1643 if New_Order = Old_Order then
1644 Write_Line ("Elab_New: same order.");
1645 else
1646 Write_Line ("Elab_New: diff order.");
1647 end if;
1648 end if;
1650 if New_Order /= Old_Order and then False then
1651 Write_Line ("Elaboration orders differ:");
1652 Write_Elab_Order
1653 (Old_Order, Title => "OLD ELABORATION ORDER");
1654 Write_Elab_Order
1655 (New_Order, Title => "NEW ELABORATION ORDER");
1656 end if;
1658 if True then
1659 Write_Str ("Pairs: ");
1660 Write_Int (Old_Pairs);
1662 if Old_Pairs = New_Pairs then
1663 Write_Str (" = ");
1664 elsif Old_Pairs < New_Pairs then
1665 Write_Str (" < ");
1666 else
1667 Write_Str (" > ");
1668 end if;
1670 Write_Int (New_Pairs);
1671 Write_Eol;
1672 end if;
1674 if Old_Pairs /= New_Pairs and then False then
1675 Write_Str ("Pairs: ");
1676 Write_Int (Old_Pairs);
1678 if Old_Pairs < New_Pairs then
1679 Write_Str (" < ");
1680 else
1681 Write_Str (" > ");
1682 end if;
1684 Write_Int (New_Pairs);
1685 Write_Eol;
1687 if Old_Pairs /= New_Pairs and then Debug_Flag_V then
1688 Write_Elab_Order
1689 (Old_Order, Title => "OLD ELABORATION ORDER");
1690 Write_Elab_Order
1691 (New_Order, Title => "NEW ELABORATION ORDER");
1692 pragma Assert (New_Pairs >= Old_Pairs);
1693 end if;
1694 end if;
1695 end if;
1697 -- The Elab_New algorithm doesn't implement the -p switch, so if that
1698 -- was used, use the results from the old algorithm.
1700 if Pessimistic_Elab_Order or Debug_Flag_Old then
1701 New_Order := Old_Order;
1702 end if;
1704 -- Now set the Elab_Positions in the Units table. It is important to
1705 -- do this late, in case we're running both Elab_New and Elab_Old.
1707 declare
1708 Units_Array : Units.Table_Type renames
1709 Units.Table (Units.First .. Units.Last);
1711 begin
1712 for J in New_Order'Range loop
1713 pragma Assert
1714 (UNR.Table (New_Order (J)).Elab_Position = Positive (J));
1715 Units_Array (New_Order (J)).Elab_Position := Positive (J);
1716 end loop;
1717 end;
1719 if Errors_Detected = 0 then
1721 -- Display elaboration order if -l was specified
1723 if Elab_Order_Output then
1724 if Zero_Formatting then
1725 Write_Elab_Order (New_Order, Title => "");
1726 else
1727 Write_Elab_Order (New_Order, Title => "ELABORATION ORDER");
1728 end if;
1729 end if;
1731 -- Display list of sources in the closure (except predefined
1732 -- sources) if -R was used. Include predefined sources if -Ra
1733 -- was used.
1735 if List_Closure then
1736 Write_Closure (New_Order);
1737 end if;
1738 end if;
1739 end;
1740 end Find_Elab_Order;
1742 ----------------------
1743 -- Force_Elab_Order --
1744 ----------------------
1746 procedure Force_Elab_Order is
1747 use System.OS_Lib;
1748 -- There is a lot of fiddly string manipulation below, because we don't
1749 -- want to depend on misc utility packages like Ada.Characters.Handling.
1751 function Get_Line return String;
1752 -- Read the next line from the file content read by Read_File. Strip
1753 -- all leading and trailing blanks. Convert "(spec)" or "(body)" to
1754 -- "%s"/"%b". Remove comments (Ada style; "--" to end of line).
1756 function Read_File (Name : String) return String_Ptr;
1757 -- Read the entire contents of the named file
1759 ---------------
1760 -- Read_File --
1761 ---------------
1763 function Read_File (Name : String) return String_Ptr is
1765 -- All of the following calls should succeed, because we checked the
1766 -- file in Switch.B, but we double check and raise Program_Error on
1767 -- failure, just in case.
1769 F : constant File_Descriptor := Open_Read (Name, Binary);
1771 begin
1772 if F = Invalid_FD then
1773 raise Program_Error;
1774 end if;
1776 declare
1777 Len : constant Natural := Natural (File_Length (F));
1778 Result : constant String_Ptr := new String (1 .. Len);
1779 Len_Read : constant Natural :=
1780 Read (F, Result (1)'Address, Len);
1782 Status : Boolean;
1784 begin
1785 if Len_Read /= Len then
1786 raise Program_Error;
1787 end if;
1789 Close (F, Status);
1791 if not Status then
1792 raise Program_Error;
1793 end if;
1795 return Result;
1796 end;
1797 end Read_File;
1799 Cur : Positive := 1;
1800 S : String_Ptr := Read_File (Force_Elab_Order_File.all);
1802 --------------
1803 -- Get_Line --
1804 --------------
1806 function Get_Line return String is
1807 First : Positive := Cur;
1808 Last : Natural;
1810 begin
1811 -- Skip to end of line
1813 while Cur <= S'Last
1814 and then S (Cur) /= ASCII.LF
1815 and then S (Cur) /= ASCII.CR
1816 loop
1817 Cur := Cur + 1;
1818 end loop;
1820 -- Strip leading blanks
1822 while First <= S'Last and then S (First) = ' ' loop
1823 First := First + 1;
1824 end loop;
1826 -- Strip trailing blanks and comment
1828 Last := Cur - 1;
1830 for J in First .. Last - 1 loop
1831 if S (J .. J + 1) = "--" then
1832 Last := J - 1;
1833 exit;
1834 end if;
1835 end loop;
1837 while Last >= First and then S (Last) = ' ' loop
1838 Last := Last - 1;
1839 end loop;
1841 -- Convert "(spec)" or "(body)" to "%s"/"%b", strip trailing blanks
1842 -- again.
1844 declare
1845 Body_String : constant String := "(body)";
1846 BL : constant Positive := Body_String'Length;
1847 Spec_String : constant String := "(spec)";
1848 SL : constant Positive := Spec_String'Length;
1850 Line : String renames S (First .. Last);
1852 Is_Body : Boolean := False;
1853 Is_Spec : Boolean := False;
1855 begin
1856 if Line'Length >= SL
1857 and then Line (Last - SL + 1 .. Last) = Spec_String
1858 then
1859 Is_Spec := True;
1860 Last := Last - SL;
1861 elsif Line'Length >= BL
1862 and then Line (Last - BL + 1 .. Last) = Body_String
1863 then
1864 Is_Body := True;
1865 Last := Last - BL;
1866 end if;
1868 while Last >= First and then S (Last) = ' ' loop
1869 Last := Last - 1;
1870 end loop;
1872 -- Skip past LF or CR/LF
1874 if Cur <= S'Last and then S (Cur) = ASCII.CR then
1875 Cur := Cur + 1;
1876 end if;
1878 if Cur <= S'Last and then S (Cur) = ASCII.LF then
1879 Cur := Cur + 1;
1880 end if;
1882 if Is_Spec then
1883 return Line (First .. Last) & "%s";
1884 elsif Is_Body then
1885 return Line (First .. Last) & "%b";
1886 else
1887 return Line;
1888 end if;
1889 end;
1890 end Get_Line;
1892 -- Local variables
1894 Empty_Name : constant Unit_Name_Type := Name_Find ("");
1895 Prev_Unit : Unit_Id := No_Unit_Id;
1897 -- Start of processing for Force_Elab_Order
1899 begin
1900 -- Loop through the file content, and build a dependency link for each
1901 -- pair of lines. Ignore lines that should be ignored.
1903 while Cur <= S'Last loop
1904 declare
1905 Uname : constant Unit_Name_Type := Name_Find (Get_Line);
1907 begin
1908 if Uname = Empty_Name then
1909 null; -- silently skip blank lines
1911 elsif Get_Name_Table_Int (Uname) = 0
1912 or else Unit_Id (Get_Name_Table_Int (Uname)) = No_Unit_Id
1913 then
1914 if Doing_New then
1915 Write_Line
1916 ("""" & Get_Name_String (Uname)
1917 & """: not present; ignored");
1918 end if;
1920 else
1921 declare
1922 Cur_Unit : constant Unit_Id := Unit_Id_Of (Uname);
1924 begin
1925 if Is_Internal_File_Name (Units.Table (Cur_Unit).Sfile) then
1926 if Doing_New then
1927 Write_Line
1928 ("""" & Get_Name_String (Uname) &
1929 """: predefined unit ignored");
1930 end if;
1932 else
1933 if Prev_Unit /= No_Unit_Id then
1934 if Doing_New then
1935 Write_Unit_Name (Units.Table (Prev_Unit).Uname);
1936 Write_Str (" <-- ");
1937 Write_Unit_Name (Units.Table (Cur_Unit).Uname);
1938 Write_Eol;
1939 end if;
1941 Build_Link
1942 (Before => Prev_Unit,
1943 After => Cur_Unit,
1944 R => Forced);
1945 end if;
1947 Prev_Unit := Cur_Unit;
1948 end if;
1949 end;
1950 end if;
1951 end;
1952 end loop;
1954 Free (S);
1955 end Force_Elab_Order;
1957 -------------------------
1958 -- Gather_Dependencies --
1959 -------------------------
1961 procedure Gather_Dependencies is
1962 Withed_Unit : Unit_Id;
1964 begin
1965 -- Loop through all units
1967 for U in Units.First .. Units.Last loop
1968 Cur_Unit := U;
1970 -- If this is not an interface to a stand-alone library and there is
1971 -- a body and a spec, then spec must be elaborated first. Note that
1972 -- the corresponding spec immediately follows the body.
1974 if not Units.Table (U).SAL_Interface
1975 and then Units.Table (U).Utype = Is_Body
1976 then
1977 Build_Link (Corresponding_Spec (U), U, Spec_First);
1978 end if;
1980 -- If this unit is not an interface to a stand-alone library, process
1981 -- WITH references for this unit ignoring interfaces to stand-alone
1982 -- libraries.
1984 if not Units.Table (U).SAL_Interface then
1985 for W in Units.Table (U).First_With ..
1986 Units.Table (U).Last_With
1987 loop
1988 if Withs.Table (W).Sfile /= No_File
1989 and then (not Withs.Table (W).SAL_Interface)
1990 then
1991 -- Check for special case of withing a unit that does not
1992 -- exist any more. If the unit was completely missing we
1993 -- would already have detected this, but a nasty case arises
1994 -- when we have a subprogram body with no spec, and some
1995 -- obsolete unit with's a previous (now disappeared) spec.
1997 if Get_Name_Table_Int (Withs.Table (W).Uname) = 0 then
1998 if Doing_New then
1999 Error_Msg_File_1 := Units.Table (U).Sfile;
2000 Error_Msg_Unit_1 := Withs.Table (W).Uname;
2001 Error_Msg ("{ depends on $ which no longer exists");
2002 end if;
2004 goto Next_With;
2005 end if;
2007 Withed_Unit := Unit_Id_Of (Withs.Table (W).Uname);
2009 -- Pragma Elaborate_All case, for this we use the recursive
2010 -- Elab_All_Links procedure to establish the links.
2012 -- Elab_New ignores Elaborate_All and Elab_All_Desirable,
2013 -- except for error messages.
2015 if Withs.Table (W).Elaborate_All and then not Doing_New then
2017 -- Reset flags used to stop multiple visits to a given
2018 -- node.
2020 for Uref in UNR.First .. UNR.Last loop
2021 UNR.Table (Uref).Visited := False;
2022 end loop;
2024 -- Now establish all the links we need
2026 Elab_All_Links
2027 (Withed_Unit, U, Elab_All,
2028 Make_Elab_All_Entry
2029 (Withs.Table (W).Uname, No_Elab_All_Link));
2031 -- Elaborate_All_Desirable case, for this we establish the
2032 -- same links as above, but with a different reason.
2034 elsif Withs.Table (W).Elab_All_Desirable
2035 and then not Doing_New
2036 then
2037 -- Reset flags used to stop multiple visits to a given
2038 -- node.
2040 for Uref in UNR.First .. UNR.Last loop
2041 UNR.Table (Uref).Visited := False;
2042 end loop;
2044 -- Now establish all the links we need
2046 Elab_All_Links
2047 (Withed_Unit, U, Elab_All_Desirable,
2048 Make_Elab_All_Entry
2049 (Withs.Table (W).Uname, No_Elab_All_Link));
2051 -- Pragma Elaborate case. We must build a link for the
2052 -- withed unit itself, and also the corresponding body if
2053 -- there is one.
2055 -- However, skip this processing if there is no ALI file for
2056 -- the WITH entry, because this means it is a generic (even
2057 -- when we fix the generics so that an ALI file is present,
2058 -- we probably still will have no ALI file for unchecked and
2059 -- other special cases).
2061 elsif Withs.Table (W).Elaborate
2062 and then Withs.Table (W).Afile /= No_File
2063 then
2064 Build_Link (Withed_Unit, U, Withed);
2066 if Units.Table (Withed_Unit).Utype = Is_Spec then
2067 Build_Link
2068 (Corresponding_Body (Withed_Unit), U, Elab);
2069 end if;
2071 -- Elaborate_Desirable case, for this we establish the same
2072 -- links as above, but with a different reason.
2074 elsif Withs.Table (W).Elab_Desirable then
2075 Build_Link (Withed_Unit, U, Withed);
2077 if Units.Table (Withed_Unit).Utype = Is_Spec then
2078 Build_Link
2079 (Corresponding_Body (Withed_Unit),
2080 U, Elab_Desirable);
2081 end if;
2083 -- A limited_with does not establish an elaboration
2084 -- dependence (that's the whole point).
2086 elsif Withs.Table (W).Limited_With then
2087 null;
2089 -- Case of normal WITH with no elaboration pragmas, just
2090 -- build the single link to the directly referenced unit
2092 else
2093 Build_Link (Withed_Unit, U, Withed);
2094 end if;
2095 end if;
2097 <<Next_With>>
2098 null;
2099 end loop;
2100 end if;
2101 end loop;
2103 -- If -f<elab_order> switch was given, take into account dependences
2104 -- specified in the file <elab_order>.
2106 if Force_Elab_Order_File /= null then
2107 Force_Elab_Order;
2108 end if;
2110 -- Output elaboration dependencies if option is set
2112 if Elab_Dependency_Output or Debug_Flag_E then
2113 if Doing_New then
2114 Write_Dependencies;
2115 end if;
2116 end if;
2117 end Gather_Dependencies;
2119 ----------
2120 -- Init --
2121 ----------
2123 procedure Init is
2124 begin
2125 Num_Chosen := 0;
2126 Num_Left := Int (Units.Last - Units.First + 1);
2127 Succ.Init;
2128 Elab_All_Entries.Init;
2129 UNR.Init;
2131 -- Initialize unit table for elaboration control
2133 for U in Units.First .. Units.Last loop
2134 UNR.Append
2135 ((Successors => No_Successor,
2136 Num_Pred => 0,
2137 Nextnp => No_Unit_Id,
2138 Visited => False,
2139 Elab_Position => 0,
2140 SCC_Root => No_Unit_Id,
2141 Nodes => null,
2142 SCC_Num_Pred => 0,
2143 Validate_Seen => False));
2144 end loop;
2145 end Init;
2147 ------------------
2148 -- Is_Body_Unit --
2149 ------------------
2151 function Is_Body_Unit (U : Unit_Id) return Boolean is
2152 begin
2153 return
2154 Units.Table (U).Utype = Is_Body
2155 or else Units.Table (U).Utype = Is_Body_Only;
2156 end Is_Body_Unit;
2158 -----------------------------
2159 -- Is_Pure_Or_Preelab_Unit --
2160 -----------------------------
2162 function Is_Pure_Or_Preelab_Unit (U : Unit_Id) return Boolean is
2163 begin
2164 -- If we have a body with separate spec, test flags on the spec
2166 if Units.Table (U).Utype = Is_Body then
2167 return
2168 Units.Table (Corresponding_Spec (U)).Preelab
2169 or else Units.Table (Corresponding_Spec (U)).Pure;
2171 -- Otherwise we have a spec or body acting as spec, test flags on unit
2173 else
2174 return Units.Table (U).Preelab or else Units.Table (U).Pure;
2175 end if;
2176 end Is_Pure_Or_Preelab_Unit;
2178 ---------------------
2179 -- Is_Waiting_Body --
2180 ---------------------
2182 function Is_Waiting_Body (U : Unit_Id) return Boolean is
2183 begin
2184 return
2185 Units.Table (U).Utype = Is_Body
2186 and then UNR.Table (Corresponding_Spec (U)).Elab_Position /= 0;
2187 end Is_Waiting_Body;
2189 -------------------------
2190 -- Make_Elab_All_Entry --
2191 -------------------------
2193 function Make_Elab_All_Entry
2194 (Unam : Unit_Name_Type;
2195 Link : Elab_All_Id) return Elab_All_Id
2197 begin
2198 Elab_All_Entries.Append ((Needed_By => Unam, Next_Elab => Link));
2199 return Elab_All_Entries.Last;
2200 end Make_Elab_All_Entry;
2202 ----------------
2203 -- Unit_Id_Of --
2204 ----------------
2206 function Unit_Id_Of (Uname : Unit_Name_Type) return Unit_Id is
2207 Info : constant Int := Get_Name_Table_Int (Uname);
2209 begin
2210 pragma Assert (Info /= 0 and then Unit_Id (Info) /= No_Unit_Id);
2211 return Unit_Id (Info);
2212 end Unit_Id_Of;
2214 --------------
2215 -- Validate --
2216 --------------
2218 procedure Validate (Order : Unit_Id_Array; Doing_New : Boolean) is
2219 Cur_SCC : Unit_Id := No_Unit_Id;
2220 OK : Boolean := True;
2221 Msg : String := "Old: ";
2223 begin
2224 if Doing_New then
2225 Msg := "New: ";
2226 end if;
2228 -- For each unit, assert that its successors are elaborated after it
2230 for J in Order'Range loop
2231 declare
2232 U : constant Unit_Id := Order (J);
2233 S : Successor_Id := UNR.Table (U).Successors;
2235 begin
2236 while S /= No_Successor loop
2237 if UNR.Table (Succ.Table (S).After).Elab_Position <=
2238 UNR.Table (U).Elab_Position
2239 then
2240 OK := False;
2241 Write_Line (Msg & " elab order failed");
2242 end if;
2244 S := Succ.Table (S).Next;
2245 end loop;
2246 end;
2247 end loop;
2249 -- An SCC of size 2 units necessarily consists of a spec and the
2250 -- corresponding body. Assert that the body is elaborated immediately
2251 -- after the spec, with nothing in between. (We only have SCCs in the
2252 -- new algorithm.)
2254 if Doing_New then
2255 for J in Order'Range loop
2256 declare
2257 U : constant Unit_Id := Order (J);
2259 begin
2260 if Nodes (U)'Length = 2 then
2261 if Units.Table (U).Utype = Is_Spec then
2262 if Order (J + 1) /= Corresponding_Body (U) then
2263 OK := False;
2264 Write_Line (Msg & "Bad spec with SCC of size 2:");
2265 Write_SCC (SCC (U));
2266 end if;
2267 end if;
2269 if Units.Table (U).Utype = Is_Body then
2270 if Order (J - 1) /= Corresponding_Spec (U) then
2271 OK := False;
2272 Write_Line (Msg & "Bad body with SCC of size 2:");
2273 Write_SCC (SCC (U));
2274 end if;
2275 end if;
2276 end if;
2277 end;
2278 end loop;
2280 -- Assert that all units of an SCC are elaborated together, with no
2281 -- units from other SCCs in between. The above spec/body case is a
2282 -- special case of this general rule.
2284 for J in Order'Range loop
2285 declare
2286 U : constant Unit_Id := Order (J);
2288 begin
2289 if SCC (U) /= Cur_SCC then
2290 Cur_SCC := SCC (U);
2291 if UNR.Table (Cur_SCC).Validate_Seen then
2292 OK := False;
2293 Write_Line (Msg & "SCC not elaborated together:");
2294 Write_SCC (Cur_SCC);
2295 end if;
2297 UNR.Table (Cur_SCC).Validate_Seen := True;
2298 end if;
2299 end;
2300 end loop;
2301 end if;
2303 pragma Assert (OK);
2304 end Validate;
2306 -------------------
2307 -- Write_Closure --
2308 -------------------
2310 procedure Write_Closure (Order : Unit_Id_Array) is
2311 package Closure_Sources is new Table.Table
2312 (Table_Component_Type => File_Name_Type,
2313 Table_Index_Type => Natural,
2314 Table_Low_Bound => 1,
2315 Table_Initial => 10,
2316 Table_Increment => 100,
2317 Table_Name => "Gnatbind.Closure_Sources");
2318 -- Table to record the sources in the closure, to avoid duplications
2320 function Put_In_Sources (S : File_Name_Type) return Boolean;
2321 -- Check if S is already in table Sources and put in Sources if it is
2322 -- not. Return False if the source is already in Sources, and True if
2323 -- it is added.
2325 --------------------
2326 -- Put_In_Sources --
2327 --------------------
2329 function Put_In_Sources (S : File_Name_Type) return Boolean is
2330 begin
2331 for J in 1 .. Closure_Sources.Last loop
2332 if Closure_Sources.Table (J) = S then
2333 return False;
2334 end if;
2335 end loop;
2337 Closure_Sources.Append (S);
2338 return True;
2339 end Put_In_Sources;
2341 -- Local variables
2343 Source : File_Name_Type;
2345 -- Start of processing for Write_Closure
2347 begin
2348 Closure_Sources.Init;
2350 if not Zero_Formatting then
2351 Write_Eol;
2352 Write_Str ("REFERENCED SOURCES");
2353 Write_Eol;
2354 end if;
2356 for J in reverse Order'Range loop
2357 Source := Units.Table (Order (J)).Sfile;
2359 -- Do not include same source more than once
2361 if Put_In_Sources (Source)
2363 -- Do not include run-time units unless -Ra switch set
2365 and then (List_Closure_All
2366 or else not Is_Internal_File_Name (Source))
2367 then
2368 if not Zero_Formatting then
2369 Write_Str (" ");
2370 end if;
2372 Write_Str (Get_Name_String (Source));
2373 Write_Eol;
2374 end if;
2375 end loop;
2377 -- Subunits do not appear in the elaboration table because they are
2378 -- subsumed by their parent units, but we need to list them for other
2379 -- tools. For now they are listed after other files, rather than right
2380 -- after their parent, since there is no easy link between the
2381 -- elaboration table and the ALIs table ??? As subunits may appear
2382 -- repeatedly in the list, if the parent unit appears in the context of
2383 -- several units in the closure, duplicates are suppressed.
2385 for J in Sdep.First .. Sdep.Last loop
2386 Source := Sdep.Table (J).Sfile;
2388 if Sdep.Table (J).Subunit_Name /= No_Name
2389 and then Put_In_Sources (Source)
2390 and then not Is_Internal_File_Name (Source)
2391 then
2392 if not Zero_Formatting then
2393 Write_Str (" ");
2394 end if;
2396 Write_Str (Get_Name_String (Source));
2397 Write_Eol;
2398 end if;
2399 end loop;
2401 if not Zero_Formatting then
2402 Write_Eol;
2403 end if;
2404 end Write_Closure;
2406 ------------------------
2407 -- Write_Dependencies --
2408 ------------------------
2410 procedure Write_Dependencies is
2411 begin
2412 if not Zero_Formatting then
2413 Write_Eol;
2414 Write_Str (" ELABORATION ORDER DEPENDENCIES");
2415 Write_Eol;
2416 Write_Eol;
2417 end if;
2419 Info_Prefix_Suppress := True;
2421 for S in Succ_First .. Succ.Last loop
2422 Elab_Error_Msg (S);
2423 end loop;
2425 Info_Prefix_Suppress := False;
2427 if not Zero_Formatting then
2428 Write_Eol;
2429 end if;
2430 end Write_Dependencies;
2432 --------------------------
2433 -- Write_Elab_All_Chain --
2434 --------------------------
2436 procedure Write_Elab_All_Chain (S : Successor_Id) is
2437 ST : constant Successor_Link := Succ.Table (S);
2438 After : constant Unit_Name_Type := Units.Table (ST.After).Uname;
2440 L : Elab_All_Id;
2441 Nam : Unit_Name_Type;
2443 First_Name : Boolean := True;
2445 begin
2446 if ST.Reason in Elab_All .. Elab_All_Desirable then
2447 L := ST.Elab_All_Link;
2448 while L /= No_Elab_All_Link loop
2449 Nam := Elab_All_Entries.Table (L).Needed_By;
2450 Error_Msg_Unit_1 := Nam;
2451 Error_Msg_Output (" $", Info => True);
2453 Get_Name_String (Nam);
2455 if Name_Buffer (Name_Len) = 'b' then
2456 if First_Name then
2457 Error_Msg_Output
2458 (" must be elaborated along with its spec:",
2459 Info => True);
2461 else
2462 Error_Msg_Output
2463 (" which must be elaborated along with its "
2464 & "spec:",
2465 Info => True);
2466 end if;
2468 else
2469 if First_Name then
2470 Error_Msg_Output
2471 (" is withed by:",
2472 Info => True);
2474 else
2475 Error_Msg_Output
2476 (" which is withed by:",
2477 Info => True);
2478 end if;
2479 end if;
2481 First_Name := False;
2483 L := Elab_All_Entries.Table (L).Next_Elab;
2484 end loop;
2486 Error_Msg_Unit_1 := After;
2487 Error_Msg_Output (" $", Info => True);
2488 end if;
2489 end Write_Elab_All_Chain;
2491 ----------------------
2492 -- Write_Elab_Order --
2493 ----------------------
2495 procedure Write_Elab_Order
2496 (Order : Unit_Id_Array; Title : String)
2498 begin
2499 if Title /= "" then
2500 Write_Eol;
2501 Write_Str (Title);
2502 Write_Eol;
2503 end if;
2505 for J in Order'Range loop
2506 if not Units.Table (Order (J)).SAL_Interface then
2507 if not Zero_Formatting then
2508 Write_Str (" ");
2509 end if;
2511 Write_Unit_Name (Units.Table (Order (J)).Uname);
2512 Write_Eol;
2513 end if;
2514 end loop;
2516 if Title /= "" then
2517 Write_Eol;
2518 end if;
2519 end Write_Elab_Order;
2521 --------------
2522 -- Elab_New --
2523 --------------
2525 package body Elab_New is
2527 generic
2528 type Node is (<>);
2529 First_Node : Node;
2530 Last_Node : Node;
2531 type Node_Array is array (Pos range <>) of Node;
2532 with function Successors (N : Node) return Node_Array;
2533 with procedure Create_SCC (Root : Node; Nodes : Node_Array);
2535 procedure Compute_Strongly_Connected_Components;
2536 -- Compute SCCs for a directed graph. The nodes in the graph are all
2537 -- values of type Node in the range First_Node .. Last_Node.
2538 -- Successors(N) returns the nodes pointed to by the edges emanating
2539 -- from N. Create_SCC is a callback that is called once for each SCC,
2540 -- passing in the Root node for that SCC (which is an arbitrary node in
2541 -- the SCC used as a representative of that SCC), and the set of Nodes
2542 -- in that SCC.
2544 -- This is generic, in case we want to use it elsewhere; then we could
2545 -- move this into a separate library unit. Unfortunately, it's not as
2546 -- generic as one might like. Ideally, we would have "type Node is
2547 -- private;", and pass in iterators to iterate over all nodes, and over
2548 -- the successors of a given node. However, that leads to using advanced
2549 -- features of Ada that are not allowed in the compiler and binder for
2550 -- bootstrapping reasons. It also leads to trampolines, which are not
2551 -- allowed in the compiler and binder. Restricting Node to be discrete
2552 -- allows us to iterate over all nodes with a 'for' loop, and allows us
2553 -- to attach temporary information to nodes by having an array indexed
2554 -- by Node.
2556 procedure Compute_Unit_SCCs;
2557 -- Use the above generic procedure to compute the SCCs for the graph of
2558 -- units. Store in each Unit_Node_Record the SCC_Root and Nodes
2559 -- components. Also initialize the SCC_Num_Pred components.
2561 procedure Find_Elab_All_Errors;
2562 -- Generate an error for illegal Elaborate_All pragmas (explicit or
2563 -- implicit). A pragma Elaborate_All (Y) on unit X is legal if and only
2564 -- if X and Y are in different SCCs.
2566 -------------------------------------------
2567 -- Compute_Strongly_Connected_Components --
2568 -------------------------------------------
2570 procedure Compute_Strongly_Connected_Components is
2572 -- This uses Tarjan's algorithm for finding SCCs. Comments here are
2573 -- intended to tell what it does, but if you want to know how it
2574 -- works, you have to look it up. Please do not modify this code
2575 -- without reading up on Tarjan's algorithm.
2577 subtype Node_Index is Nat;
2578 No_Index : constant Node_Index := 0;
2580 Num_Nodes : constant Nat :=
2581 Node'Pos (Last_Node) - Node'Pos (First_Node) + 1;
2582 Stack : Node_Array (1 .. Num_Nodes);
2583 Top : Node_Index := 0;
2584 -- Stack of nodes, pushed when first visited. All nodes of an SCC are
2585 -- popped at once when the SCC is found.
2587 subtype Valid_Node is Node range First_Node .. Last_Node;
2588 Node_Indices : array (Valid_Node) of Node_Index :=
2589 (others => No_Index);
2590 -- Each node has an "index", which is the sequential number in the
2591 -- order in which they are visited in the recursive walk. No_Index
2592 -- means "not yet visited"; we want to avoid walking any node more
2593 -- than once.
2595 Index : Node_Index := 1;
2596 -- Next value to be assigned to a node index
2598 Low_Links : array (Valid_Node) of Node_Index;
2599 -- Low_Links (N) is the smallest index of nodes reachable from N
2601 On_Stack : array (Valid_Node) of Boolean := (others => False);
2602 -- True if the node is currently on the stack
2604 procedure Walk (N : Valid_Node);
2605 -- Recursive depth-first graph walk, with the node index used to
2606 -- avoid visiting a node more than once.
2608 ----------
2609 -- Walk --
2610 ----------
2612 procedure Walk (N : Valid_Node) is
2613 Stack_Position_Of_N : constant Pos := Top + 1;
2614 S : constant Node_Array := Successors (N);
2616 begin
2617 -- Assign the index and low link, increment Index for next call to
2618 -- Walk.
2620 Node_Indices (N) := Index;
2621 Low_Links (N) := Index;
2622 Index := Index + 1;
2624 -- Push it on the stack:
2626 Top := Stack_Position_Of_N;
2627 Stack (Top) := N;
2628 On_Stack (N) := True;
2630 -- Walk not-yet-visited subnodes, and update low link for visited
2631 -- ones as appropriate.
2633 for J in S'Range loop
2634 if Node_Indices (S (J)) = No_Index then
2635 Walk (S (J));
2636 Low_Links (N) :=
2637 Node_Index'Min (Low_Links (N), Low_Links (S (J)));
2638 elsif On_Stack (S (J)) then
2639 Low_Links (N) :=
2640 Node_Index'Min (Low_Links (N), Node_Indices (S (J)));
2641 end if;
2642 end loop;
2644 -- If the index is (still) equal to the low link, we've found an
2645 -- SCC. Pop the whole SCC off the stack, and call Create_SCC.
2647 if Low_Links (N) = Node_Indices (N) then
2648 declare
2649 SCC : Node_Array renames
2650 Stack (Stack_Position_Of_N .. Top);
2651 pragma Assert (SCC'Length >= 1);
2652 pragma Assert (SCC (SCC'First) = N);
2654 begin
2655 for J in SCC'Range loop
2656 On_Stack (SCC (J)) := False;
2657 end loop;
2659 Create_SCC (Root => N, Nodes => SCC);
2660 pragma Assert (Top - SCC'Length = Stack_Position_Of_N - 1);
2661 Top := Stack_Position_Of_N - 1; -- pop all
2662 end;
2663 end if;
2664 end Walk;
2666 -- Start of processing for Compute_Strongly_Connected_Components
2668 begin
2669 -- Walk all the nodes that have not yet been walked
2671 for N in Valid_Node loop
2672 if Node_Indices (N) = No_Index then
2673 Walk (N);
2674 end if;
2675 end loop;
2676 end Compute_Strongly_Connected_Components;
2678 -----------------------
2679 -- Compute_Unit_SCCs --
2680 -----------------------
2682 procedure Compute_Unit_SCCs is
2683 function Successors (U : Unit_Id) return Unit_Id_Array;
2684 -- Return all the units that must be elaborated after U. In addition,
2685 -- if U is a body, include the corresponding spec; this ensures that
2686 -- a spec/body pair are always in the same SCC.
2688 procedure Create_SCC (Root : Unit_Id; Nodes : Unit_Id_Array);
2689 -- Set Nodes of the Root, and set SCC_Root of all the Nodes
2691 procedure Init_SCC_Num_Pred (U : Unit_Id);
2692 -- Initialize the SCC_Num_Pred fields, so that the root of each SCC
2693 -- has a count of the number of successors of all the units in the
2694 -- SCC, but only for successors outside the SCC.
2696 procedure Compute_SCCs is new Compute_Strongly_Connected_Components
2697 (Node => Unit_Id,
2698 First_Node => Units.First,
2699 Last_Node => Units.Last,
2700 Node_Array => Unit_Id_Array,
2701 Successors => Successors,
2702 Create_SCC => Create_SCC);
2704 ----------------
2705 -- Create_SCC --
2706 ----------------
2708 procedure Create_SCC (Root : Unit_Id; Nodes : Unit_Id_Array) is
2709 begin
2710 if Debug_Flag_V then
2711 Write_Str ("Root = ");
2712 Write_Int (Int (Root));
2713 Write_Str (" ");
2714 Write_Unit_Name (Units.Table (Root).Uname);
2715 Write_Str (" -- ");
2716 Write_Int (Nodes'Length);
2717 Write_Str (" units:");
2718 Write_Eol;
2720 for J in Nodes'Range loop
2721 Write_Str (" ");
2722 Write_Int (Int (Nodes (J)));
2723 Write_Str (" ");
2724 Write_Unit_Name (Units.Table (Nodes (J)).Uname);
2725 Write_Eol;
2726 end loop;
2727 end if;
2729 pragma Assert (Nodes (Nodes'First) = Root);
2730 pragma Assert (UNR.Table (Root).Nodes = null);
2731 UNR.Table (Root).Nodes := new Unit_Id_Array'(Nodes);
2733 for J in Nodes'Range loop
2734 pragma Assert (SCC (Nodes (J)) = No_Unit_Id);
2735 UNR.Table (Nodes (J)).SCC_Root := Root;
2736 end loop;
2737 end Create_SCC;
2739 ----------------
2740 -- Successors --
2741 ----------------
2743 function Successors (U : Unit_Id) return Unit_Id_Array is
2744 S : Successor_Id := UNR.Table (U).Successors;
2745 Tab : Unit_Id_Table;
2747 begin
2748 -- Pretend that a spec is a successor of its body (even though it
2749 -- isn't), just so both get included.
2751 if Units.Table (U).Utype = Is_Body then
2752 Append (Tab, Corresponding_Spec (U));
2753 end if;
2755 -- Now include the real successors
2757 while S /= No_Successor loop
2758 pragma Assert (Succ.Table (S).Before = U);
2759 Append (Tab, Succ.Table (S).After);
2760 S := Succ.Table (S).Next;
2761 end loop;
2763 declare
2764 Result : constant Unit_Id_Array := Tab.Table (1 .. Last (Tab));
2766 begin
2767 Free (Tab);
2768 return Result;
2769 end;
2770 end Successors;
2772 -----------------------
2773 -- Init_SCC_Num_Pred --
2774 -----------------------
2776 procedure Init_SCC_Num_Pred (U : Unit_Id) is
2777 begin
2778 if UNR.Table (U).Visited then
2779 return;
2780 end if;
2782 UNR.Table (U).Visited := True;
2784 declare
2785 S : Successor_Id := UNR.Table (U).Successors;
2787 begin
2788 while S /= No_Successor loop
2789 pragma Assert (Succ.Table (S).Before = U);
2790 Init_SCC_Num_Pred (Succ.Table (S).After);
2792 if SCC (U) /= SCC (Succ.Table (S).After) then
2793 UNR.Table (SCC (Succ.Table (S).After)).SCC_Num_Pred :=
2794 UNR.Table (SCC (Succ.Table (S).After)).SCC_Num_Pred + 1;
2795 end if;
2797 S := Succ.Table (S).Next;
2798 end loop;
2799 end;
2800 end Init_SCC_Num_Pred;
2802 -- Start of processing for Compute_Unit_SCCs
2804 begin
2805 Compute_SCCs;
2807 for Uref in UNR.First .. UNR.Last loop
2808 pragma Assert (not UNR.Table (Uref).Visited);
2809 null;
2810 end loop;
2812 for Uref in UNR.First .. UNR.Last loop
2813 Init_SCC_Num_Pred (Uref);
2814 end loop;
2816 -- Assert that SCC_Root of all units has been set to a valid unit,
2817 -- and that SCC_Num_Pred has not been modified in non-root units.
2819 for Uref in UNR.First .. UNR.Last loop
2820 pragma Assert (UNR.Table (Uref).SCC_Root /= No_Unit_Id);
2821 pragma Assert (UNR.Table (Uref).SCC_Root in UNR.First .. UNR.Last);
2823 if SCC (Uref) /= Uref then
2824 pragma Assert (UNR.Table (Uref).SCC_Num_Pred = 0);
2825 null;
2826 end if;
2827 end loop;
2828 end Compute_Unit_SCCs;
2830 --------------------------
2831 -- Find_Elab_All_Errors --
2832 --------------------------
2834 procedure Find_Elab_All_Errors is
2835 Withed_Unit : Unit_Id;
2837 begin
2838 for U in Units.First .. Units.Last loop
2840 -- If this unit is not an interface to a stand-alone library,
2841 -- process WITH references for this unit ignoring interfaces to
2842 -- stand-alone libraries.
2844 if not Units.Table (U).SAL_Interface then
2845 for W in Units.Table (U).First_With ..
2846 Units.Table (U).Last_With
2847 loop
2848 if Withs.Table (W).Sfile /= No_File
2849 and then (not Withs.Table (W).SAL_Interface)
2850 then
2851 -- Check for special case of withing a unit that does not
2852 -- exist any more.
2854 if Get_Name_Table_Int (Withs.Table (W).Uname) = 0 then
2855 goto Next_With;
2856 end if;
2858 Withed_Unit := Unit_Id_Of (Withs.Table (W).Uname);
2860 -- If it's Elaborate_All or Elab_All_Desirable, check
2861 -- that the withER and withEE are not in the same SCC.
2863 if Withs.Table (W).Elaborate_All
2864 or else Withs.Table (W).Elab_All_Desirable
2865 then
2866 if SCC (U) = SCC (Withed_Unit) then
2867 Illegal_Elab_All := True; -- ????
2869 -- We could probably give better error messages
2870 -- than Elab_Old here, but for now, to avoid
2871 -- disruption, we don't give any error here.
2872 -- Instead, we set the Illegal_Elab_All flag above,
2873 -- and then run the Elab_Old algorithm to issue the
2874 -- error message. Ideally, we would like to print
2875 -- multiple errors rather than stopping after the
2876 -- first cycle.
2878 if False then
2879 Error_Msg_Output
2880 ("illegal pragma Elaborate_All",
2881 Info => False);
2882 end if;
2883 end if;
2884 end if;
2885 end if;
2887 <<Next_With>>
2888 null;
2889 end loop;
2890 end if;
2891 end loop;
2892 end Find_Elab_All_Errors;
2894 ---------------------
2895 -- Find_Elab_Order --
2896 ---------------------
2898 procedure Find_Elab_Order (Elab_Order : out Unit_Id_Table) is
2899 Best_So_Far : Unit_Id;
2900 U : Unit_Id;
2902 begin
2903 -- Gather dependencies and output them if option set
2905 Gather_Dependencies;
2907 Compute_Unit_SCCs;
2909 -- Initialize the no-predecessor list
2911 No_Pred := No_Unit_Id;
2912 for U in UNR.First .. UNR.Last loop
2913 if UNR.Table (U).Num_Pred = 0 then
2914 UNR.Table (U).Nextnp := No_Pred;
2915 No_Pred := U;
2916 end if;
2917 end loop;
2919 -- OK, now we determine the elaboration order proper. All we do is to
2920 -- select the best choice from the no-predecessor list until all the
2921 -- nodes have been chosen.
2923 Outer : loop
2925 -- If there are no nodes with predecessors, then either we are
2926 -- done, as indicated by Num_Left being set to zero, or we have
2927 -- a circularity. In the latter case, diagnose the circularity,
2928 -- removing it from the graph and continue.
2929 -- ????But Diagnose_Elaboration_Problem always raises an
2930 -- exception.
2932 Get_No_Pred : while No_Pred = No_Unit_Id loop
2933 exit Outer when Num_Left < 1;
2934 Diagnose_Elaboration_Problem (Elab_Order);
2935 end loop Get_No_Pred;
2937 U := No_Pred;
2938 Best_So_Far := No_Unit_Id;
2940 -- Loop to choose best entry in No_Pred list
2942 No_Pred_Search : loop
2943 if Debug_Flag_N then
2944 Write_Str (" considering choice of ");
2945 Write_Unit_Name (Units.Table (U).Uname);
2946 Write_Eol;
2948 if Units.Table (U).Elaborate_Body then
2949 Write_Str
2950 (" Elaborate_Body = True, Num_Pred for body = ");
2951 Write_Int
2952 (UNR.Table (Corresponding_Body (U)).Num_Pred);
2953 else
2954 Write_Str
2955 (" Elaborate_Body = False");
2956 end if;
2958 Write_Eol;
2959 end if;
2961 -- Don't even consider units whose SCC is not ready. This
2962 -- ensures that all units of an SCC will be elaborated
2963 -- together, with no other units in between.
2965 if SCC_Num_Pred (U) = 0
2966 and then Better_Choice (U, Best_So_Far)
2967 then
2968 if Debug_Flag_N then
2969 Write_Str (" tentatively chosen (best so far)");
2970 Write_Eol;
2971 end if;
2973 Best_So_Far := U;
2974 end if;
2976 U := UNR.Table (U).Nextnp;
2977 exit No_Pred_Search when U = No_Unit_Id;
2978 end loop No_Pred_Search;
2980 -- Choose the best candidate found
2982 Choose (Elab_Order, Best_So_Far);
2984 -- If it's a spec with a body, and the body is not yet chosen,
2985 -- choose the body if possible. The case where the body is
2986 -- already chosen is Elaborate_Body; the above call to Choose
2987 -- the spec will also Choose the body.
2989 if Units.Table (Best_So_Far).Utype = Is_Spec
2990 and then UNR.Table
2991 (Corresponding_Body (Best_So_Far)).Elab_Position = 0
2992 then
2993 declare
2994 Choose_The_Body : constant Boolean :=
2995 UNR.Table (Corresponding_Body
2996 (Best_So_Far)).Num_Pred = 0;
2998 begin
2999 if Debug_Flag_B then
3000 Write_Str ("Can we choose the body?... ");
3002 if Choose_The_Body then
3003 Write_Line ("Yes!");
3004 else
3005 Write_Line ("No.");
3006 end if;
3007 end if;
3009 if Choose_The_Body then
3010 Choose (Elab_Order, Corresponding_Body (Best_So_Far));
3011 end if;
3012 end;
3013 end if;
3015 -- Finally, choose all the rest of the units in the same SCC as
3016 -- Best_So_Far. If it hasn't been chosen (Elab_Position = 0), and
3017 -- it's ready to be chosen (Num_Pred = 0), then we can choose it.
3019 loop
3020 declare
3021 Chose_One_Or_More : Boolean := False;
3022 SCC : Unit_Id_Array renames Nodes (Best_So_Far).all;
3024 begin
3025 for J in SCC'Range loop
3026 if UNR.Table (SCC (J)).Elab_Position = 0
3027 and then UNR.Table (SCC (J)).Num_Pred = 0
3028 then
3029 Chose_One_Or_More := True;
3030 Choose (Elab_Order, SCC (J));
3031 end if;
3032 end loop;
3034 exit when not Chose_One_Or_More;
3035 end;
3036 end loop;
3037 end loop Outer;
3039 Find_Elab_All_Errors;
3040 end Find_Elab_Order;
3042 -----------
3043 -- Nodes --
3044 -----------
3046 function Nodes (U : Unit_Id) return Unit_Id_Array_Ptr is
3047 begin
3048 return UNR.Table (SCC (U)).Nodes;
3049 end Nodes;
3051 ---------
3052 -- SCC --
3053 ---------
3055 function SCC (U : Unit_Id) return Unit_Id is
3056 begin
3057 return UNR.Table (U).SCC_Root;
3058 end SCC;
3060 ------------------
3061 -- SCC_Num_Pred --
3062 ------------------
3064 function SCC_Num_Pred (U : Unit_Id) return Int is
3065 begin
3066 return UNR.Table (SCC (U)).SCC_Num_Pred;
3067 end SCC_Num_Pred;
3069 ---------------
3070 -- Write_SCC --
3071 ---------------
3073 procedure Write_SCC (U : Unit_Id) is
3074 pragma Assert (SCC (U) = U);
3075 begin
3076 for J in Nodes (U)'Range loop
3077 Write_Int (Int (UNR.Table (Nodes (U) (J)).Elab_Position));
3078 Write_Str (". ");
3079 Write_Unit_Name (Units.Table (Nodes (U) (J)).Uname);
3080 Write_Eol;
3081 end loop;
3083 Write_Eol;
3084 end Write_SCC;
3086 end Elab_New;
3088 --------------
3089 -- Elab_Old --
3090 --------------
3092 package body Elab_Old is
3094 ---------------------
3095 -- Find_Elab_Order --
3096 ---------------------
3098 procedure Find_Elab_Order (Elab_Order : out Unit_Id_Table) is
3099 Best_So_Far : Unit_Id;
3100 U : Unit_Id;
3102 begin
3103 -- Gather dependencies and output them if option set
3105 Gather_Dependencies;
3107 -- Initialize the no-predecessor list
3109 No_Pred := No_Unit_Id;
3110 for U in UNR.First .. UNR.Last loop
3111 if UNR.Table (U).Num_Pred = 0 then
3112 UNR.Table (U).Nextnp := No_Pred;
3113 No_Pred := U;
3114 end if;
3115 end loop;
3117 -- OK, now we determine the elaboration order proper. All we do is to
3118 -- select the best choice from the no-predecessor list until all the
3119 -- nodes have been chosen.
3121 Outer : loop
3123 -- If there are no nodes with predecessors, then either we are
3124 -- done, as indicated by Num_Left being set to zero, or we have
3125 -- a circularity. In the latter case, diagnose the circularity,
3126 -- removing it from the graph and continue.
3127 -- ????But Diagnose_Elaboration_Problem always raises an
3128 -- exception.
3130 Get_No_Pred : while No_Pred = No_Unit_Id loop
3131 exit Outer when Num_Left < 1;
3132 Diagnose_Elaboration_Problem (Elab_Order);
3133 end loop Get_No_Pred;
3135 U := No_Pred;
3136 Best_So_Far := No_Unit_Id;
3138 -- Loop to choose best entry in No_Pred list
3140 No_Pred_Search : loop
3141 if Debug_Flag_N then
3142 Write_Str (" considering choice of ");
3143 Write_Unit_Name (Units.Table (U).Uname);
3144 Write_Eol;
3146 if Units.Table (U).Elaborate_Body then
3147 Write_Str
3148 (" Elaborate_Body = True, Num_Pred for body = ");
3149 Write_Int
3150 (UNR.Table (Corresponding_Body (U)).Num_Pred);
3151 else
3152 Write_Str
3153 (" Elaborate_Body = False");
3154 end if;
3156 Write_Eol;
3157 end if;
3159 -- This is a candididate to be considered for choice
3161 if Better_Choice (U, Best_So_Far) then
3162 if Debug_Flag_N then
3163 Write_Str (" tentatively chosen (best so far)");
3164 Write_Eol;
3165 end if;
3167 Best_So_Far := U;
3168 end if;
3170 U := UNR.Table (U).Nextnp;
3171 exit No_Pred_Search when U = No_Unit_Id;
3172 end loop No_Pred_Search;
3174 -- Choose the best candidate found
3176 Choose (Elab_Order, Best_So_Far);
3177 end loop Outer;
3178 end Find_Elab_Order;
3180 end Elab_Old;
3182 end Binde;