1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2024, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- This package contains the routines for writing the library information
30 -----------------------------------
31 -- Format of Library Information --
32 -----------------------------------
34 -- This section describes the format of the library information that is
35 -- associated with object files. The exact method of this association is
36 -- potentially implementation dependent and is described and implemented in
37 -- package ali. From the point of view of the description here, all we need
38 -- to know is that the information is represented as a string of characters
39 -- that is somehow associated with an object file, and can be retrieved. If
40 -- no library information exists for a given object file, then we take this
41 -- as equivalent to the non-existence of the object file, as if source file
42 -- has not been previously compiled.
44 -- The library information is written as a series of lines of the form:
46 -- Key_Character parameter parameter ...
48 -- The following sections describe the format of these lines in detail
50 --------------------------------------
51 -- Making Changes to the ALI Format --
52 --------------------------------------
54 -- A number of tools use ali.adb to parse ali files. This means that
55 -- changes to this format can cause old versions of these tools to be
56 -- incompatible with new versions of the compiler. Any changes to ali file
57 -- formats must be carefully evaluated to understand any such possible
58 -- conflicts, and in particular, it is very undesirable to create conflicts
59 -- between older versions of GNAT Studio and newer versions of the
62 -- If the following guidelines are respected, downward compatibility
63 -- problems (old tools reading new ali files) should be minimized:
65 -- The basic key character format must be kept
67 -- The V line must be the first line, this is checked by ali.adb even in
68 -- Ignore_Errors mode, and is used to verify that the file at hand is
69 -- indeed likely intended to be an ali file.
71 -- The P line must be present, though may be modified in contents
72 -- according to remaining guidelines. Again, ali.adb assumes the P
73 -- line is present even in Ignore_Errors mode.
75 -- New modifiers can generally be added (in particular adding new two
76 -- letter modifiers to the P or U lines is always safe)
78 -- Adding entirely new lines (with a new key letter) to the ali file is
79 -- always safe, at any point (other than before the V line), since such
80 -- lines will be ignored.
82 -- Following the guidelines in this section should ensure that this problem
83 -- is minimized and that old tools will be able to deal successfully with
84 -- new ali formats. Note that this does not apply to the compiler itself,
85 -- which always requires consistency between the ali files and the binder.
86 -- That is because one of the main functions of the binder is to ensure
87 -- consistency of the partition, and this can be compromised if the ali
88 -- files are inconsistent.
94 -- The initial header lines in the file give information about the
95 -- compilation environment, and identify other special information such as
96 -- main program parameters.
102 -- V "xxxxxxxxxxxxxxxx"
104 -- This line indicates the library output version, as defined in
105 -- Gnatvsn. It ensures that separate object modules of a program are
106 -- consistent. It has to be changed if anything changes which would
107 -- affect successful binding of separately compiled modules. Examples
108 -- of such changes are modifications in the format of the library info
109 -- described in this package, or modifications to calling sequences, or
110 -- to the way that data is represented.
112 -- Note: the V line absolutely must be the first line, and no change
113 -- to the ALI format should change this, since even in Ignore_Errors
114 -- mode, Scan_ALI insists on finding a V line.
116 -- ---------------------
117 -- -- M Main Program --
118 -- ---------------------
120 -- M type [priority] [T=time-slice] [C=cpu] W=?
122 -- This line appears only if the main unit for this file is suitable
123 -- for use as a main program. The parameters are:
127 -- P for a parameterless procedure
128 -- F for a function returning a value of integral type
129 -- (used for writing a main program returning an exit status)
133 -- Present only if there was a valid pragma Priority in the
134 -- corresponding unit to set the main task priority. It is an
135 -- unsigned decimal integer.
139 -- Present only if there was a valid pragma Time_Slice in the
140 -- corresponding unit. It is an unsigned decimal integer in the
141 -- range 0 .. 10**9 giving the time slice value in units of
142 -- milliseconds. The actual significance of this parameter is
147 -- Present only if there was a valid pragma CPU in the
148 -- corresponding unit to set the main task affinity. It is an
149 -- unsigned decimal integer.
153 -- This parameter indicates the wide character encoding method used
154 -- when compiling the main program file. The ? character is the
155 -- single character used in the -gnatW? switch. This is used to
156 -- provide the default wide-character encoding for Wide_Text_IO
165 -- One of these lines appears for each of the arguments present in the
166 -- call to the gnat1 program. This can be used if it is necessary to
167 -- reconstruct this call (e.g. for fix and continue).
169 -- -------------------
170 -- -- P Parameters --
171 -- -------------------
175 -- Indicates various information that applies to the compilation of the
176 -- corresponding source file. Parameters is a sequence of zero or more
177 -- two letter codes that indicate configuration pragmas and other
178 -- parameters that apply:
180 -- The arguments are as follows:
182 -- CE Compilation errors. If this is present it means that the ali
183 -- file resulted from a compilation with the -gnatQ switch set,
184 -- and illegalities were detected. The ali file contents may
185 -- not be completely reliable, but the format will be correct
186 -- and complete. Note that NO is always present if CE is
189 -- DB Detect_Blocking pragma is in effect for all units in this
192 -- Ex A valid Partition_Elaboration_Policy pragma applies to all
193 -- the units in this file, where x is the first character
194 -- (upper case) of the policy name (e.g. 'C' for Concurrent).
196 -- FX Units in this file use front-end exceptions, with explicit
197 -- handlers to trigger AT-END actions on exception paths.
199 -- GP Set if this compilation was done in GNATprove mode, either
200 -- from direct use of GNATprove, or from use of -gnatdF.
202 -- ID Interrupts_System_By_Default pragma applies to this
203 -- partition. No handlers will be installed by default,
204 -- including signal handlers. This is a configuration
207 -- Lx A valid Locking_Policy pragma applies to all the units in
208 -- this file, where x is the first character (upper case) of
209 -- the policy name (e.g. 'C' for Ceiling_Locking).
211 -- NO No object. This flag indicates that the units in this file
212 -- were not compiled to produce an object. This can occur as a
213 -- result of the use of -gnatc, or if no object can be produced
214 -- (e.g. when a package spec is compiled instead of the body,
215 -- or a subunit on its own). Note that in GNATprove mode, we
216 -- do produce an object. The object is not suitable for binding
217 -- and linking, but we do not set NO, instead we set GP.
219 -- NR No_Run_Time. Indicates that a pragma No_Run_Time applies
220 -- to all units in the file.
222 -- NS Normalize_Scalars pragma in effect for all units in
225 -- OH Pragma Default_Scalar_Storage_Order (High_Order_First) is
226 -- present in a configuration pragma file that applies.
228 -- OL Pragma Default_Scalar_Storage_Order (Low_Order_First) is
229 -- present in a configuration pragma file that applies.
231 -- Qx A valid Queueing_Policy pragma applies to all the units
232 -- in this file, where x is the first character (upper case)
233 -- of the policy name (e.g. 'P' for Priority_Queueing).
235 -- SL Indicates that the unit is an Interface to a Standalone
236 -- Library. Note that this indication is never given by the
237 -- compiler, but is added by the Project Manager in gnatmake
238 -- when an Interface ALI file is copied to the library
241 -- SS This unit references System.Secondary_Stack (that is,
242 -- the unit makes use of the secondary stack facilities).
244 -- Tx A valid Task_Dispatching_Policy pragma applies to all
245 -- the units in this file, where x is the first character
246 -- (upper case) of the corresponding policy name (e.g. 'F'
247 -- for FIFO_Within_Priorities).
249 -- UA Unreserve_All_Interrupts pragma was processed in one or
250 -- more units in this file
252 -- ZX Units in this file use zero-cost exceptions and have
253 -- generated exception tables. If ZX is not present, the
254 -- longjmp/setjmp exception scheme is in use.
256 -- Note that language defined units never output policy (Lx, Tx, Qx)
257 -- parameters. Language defined units must correctly handle all
258 -- possible cases. These values are checked for consistency by the
259 -- binder and then copied to the generated binder output file.
261 -- Note: The P line must be present. Even in Ignore_Errors mode, Scan_ALI
262 -- insists on finding a P line. So if changes are made to the ALI format,
263 -- they should not include removing the P line.
265 -- ---------------------
266 -- -- R Restrictions --
267 -- ---------------------
269 -- There are two forms for R lines, positional and named. The positional
270 -- notation is now considered obsolescent, it is not generated by the most
271 -- recent versions of the compiler except under control of the debug switch
272 -- -gnatdR, but is still recognized by the binder.
274 -- The recognition by the binder is to ease the transition, and better deal
275 -- with some cases of inconsistent builds using incompatible versions of
276 -- the compiler and binder. The named notation is the current preferred
279 -- Note that R lines are generated using the information in unit Rident,
280 -- and intepreted by the binder using the information in System.Rident.
281 -- Normally these two units should be effectively identical. However in
282 -- some cases of inconsistent builds, they may be different. This may lead
283 -- to binder diagnostics, which can be suppressed using the -C switch for
284 -- the binder, which results in ignoring unrecognized restrictions in the
287 -- ---------------------------------------
288 -- -- R Restrictions (Positional Form) --
289 -- ---------------------------------------
291 -- The first R line records the status of restrictions generated by pragma
292 -- Restrictions encountered, as well as information on what the compiler
293 -- has been able to determine with respect to restrictions violations.
296 -- R <<restriction-characters>> <<restriction-param-id-entries>>
298 -- The first parameter is a string of characters that records
299 -- information regarding restrictions that do not take parameter not
300 -- take parameter values. It is a string of characters, one character
301 -- for each value (in order) in All_Boolean_Restrictions. There are
302 -- three possible settings for each restriction:
304 -- r Restricted. Unit was compiled under control of a pragma
305 -- Restrictions for the corresponding restriction. In this case
306 -- the unit certainly does not violate the Restriction, since
307 -- this would have been detected by the compiler.
309 -- n Not used. The unit was not compiled under control of a pragma
310 -- Restrictions for the corresponding restriction, and does not
311 -- make any use of the referenced feature.
313 -- v Violated. The unit was not compiled under control of a pragma
314 -- Restrictions for the corresponding restriction, and it does
315 -- indeed use the referenced feature.
317 -- This information is used in the binder to check consistency, i.e. to
318 -- detect cases where one unit has "r" and another unit has "v", which
319 -- is not permitted, since these restrictions are partition-wide.
321 -- The second parameter, which immediately follows the first (with no
322 -- separating space) gives restriction information for identifiers for
323 -- which a parameter is given.
325 -- The parameter is a string of entries, one for each value in
326 -- Restrict.All_Parameter_Restrictions. Each entry has two components
327 -- in sequence, the first indicating whether or not there is a
328 -- restriction, and the second indicating whether or not the compiler
329 -- detected violations. In the boolean case it is not necessary to
330 -- separate these, since if a restriction is set, and violated, that is
331 -- an error. But in the parameter case, this is not true. For example,
332 -- we can have a unit with a pragma Restrictions (Max_Tasks => 4),
333 -- where the compiler can detect that there are exactly three tasks
334 -- declared. Both of these pieces of information must be passed to the
335 -- binder. The parameter of 4 is important in case the total number of
336 -- tasks in the partition is greater than 4. The parameter of 3 is
337 -- important in case some other unit has a restrictions pragma with
340 -- The component for the presence of restriction has one of two
343 -- n No pragma for this restriction is present in the set of units
344 -- for this ali file.
346 -- rN At least one pragma for this restriction is present in the
347 -- set of units for this ali file. The value N is the minimum
348 -- parameter value encountered in any such pragma. N is in the
349 -- range of Integer (a value larger than N'Last causes the
350 -- pragma to be ignored).
352 -- The component for the violation detection has one of three
355 -- n No violations were detected by the compiler
357 -- vN A violation was detected. N is either the maximum or total
358 -- count of violations (depending on the checking type) in all
359 -- the units represented by the ali file). Note that this
360 -- setting is only allowed for restrictions that are in
361 -- Checked_[Max|Sum]_Parameter_Restrictions. The value here is
362 -- known to be exact by the compiler and is in the range of
365 -- vN+ A violation was detected. The compiler cannot determine
366 -- the exact count of violations, but it is at least N.
368 -- There are no spaces within the parameter string, so the entry
369 -- described above in the header of this section for Max_Tasks would
370 -- appear as the string r4v3.
372 -- Note: The restrictions line is required to be present. Even in
373 -- Ignore_Errors mode, Scan_ALI expects to find an R line and will
374 -- signal a fatal error if it is missing. This means that future
375 -- changes to the ALI file format must retain the R line.
377 -- ----------------------------------
378 -- -- R Restrictions (Named Form) --
379 -- ----------------------------------
381 -- The first R line for named form announces that named notation will be
382 -- used, and also assures that there is at least one R line present, which
383 -- makes parsing of ali files simpler. A blank line preceds the RN line.
387 -- In named notation, the restrictions are given as a series of lines,
388 -- one per restrictions that is specified or violated (no information is
389 -- present for restrictions that are not specified or violated). In the
390 -- following name is the name of the restriction in all upper case.
392 -- For boolean restrictions, we have only two possibilities. A restrictions
393 -- pragma is present, or a violation is detected:
397 -- A restriction pragma is present for the named boolean restriction.
398 -- No violations were detected by the compiler (or the unit in question
399 -- would have been found to be illegal).
403 -- No restriction pragma is present for the named boolean restriction.
404 -- However, the compiler did detect one or more violations of this
405 -- restriction, which may require a binder consistency check. Note that
406 -- one case of a violation is the use of a Restriction_Set attribute for
407 -- the restriction that yielded False.
409 -- For the case of restrictions that take a parameter, we need both the
410 -- information from pragma if present, and the actual information about
411 -- what possible violations occur. For example, we can have a unit with
412 -- a pragma Restrictions (Max_Tasks => 4), where the compiler can detect
413 -- that there are exactly three tasks declared. Both of these pieces
414 -- of information must be passed to the binder. The parameter of 4 is
415 -- important in case the total number of tasks in the partition is greater
416 -- than 4. The parameter of 3 is important in case some other unit has a
417 -- restrictions pragma with Max_Tasks=>2.
421 -- A restriction pragma is present for the named restriction which is
422 -- one of the restrictions taking a parameter. The value N (a decimal
423 -- integer) is the value given in the restriction pragma.
427 -- A restriction pragma may or may not be present for the restriction
428 -- given by name (one of the restrictions taking a parameter). But in
429 -- either case, the compiler detected possible violations. N (a decimal
430 -- integer) is the maximum or total count of violations (depending
431 -- on the checking type) in all the units represented by the ali file).
432 -- The value here is known to be exact by the compiler and is in the
433 -- range of Natural. Note that if an RR line is present for the same
434 -- restriction, then the value in the RV line cannot exceed the value
435 -- in the RR line (since otherwise the compiler would have detected a
436 -- violation of the restriction).
440 -- Similar to the above, but the compiler cannot determine the exact
441 -- count of violations, but it is at least N.
443 -- -------------------------------------------------
444 -- -- R Restrictions (No_Dependence Information) --
445 -- -------------------------------------------------
447 -- Subsequent R lines are present only if pragma Restriction No_Dependence
448 -- is used. There is one such line for each such pragma appearing in the
449 -- extended main unit. The format is:
453 -- Here the unit name is in all lower case. The components of the unit
454 -- name are separated by periods. The names themselves are in encoded
455 -- form, as documented in Namet.
457 -- -------------------------
458 -- -- I Interrupt States --
459 -- -------------------------
461 -- I interrupt-number interrupt-state line-number
463 -- This line records information from an Interrupt_State pragma. There
464 -- is one line for each separate pragma, and if no such pragmas are
465 -- used, then no I lines are present.
467 -- The interrupt-number is an unsigned positive integer giving the
468 -- value of the interrupt as defined in Ada.Interrupts.Names.
470 -- The interrupt-state is one of r/s/u for Runtime/System/User
472 -- The line number is an unsigned decimal integer giving the line
473 -- number of the corresponding Interrupt_State pragma. This is used
474 -- in consistency messages.
476 -- --------------------------------------
477 -- -- S Priority Specific Dispatching --
478 -- --------------------------------------
480 -- S policy_identifier first_priority last_priority line-number
482 -- This line records information from a Priority_Specific_Dispatching
483 -- pragma. There is one line for each separate pragma, and if no such
484 -- pragmas are used, then no S lines are present.
486 -- The policy_identifier is the first character (upper case) of the
487 -- corresponding policy name (e.g. 'F' for FIFO_Within_Priorities).
489 -- The first_priority and last_priority fields define the range of
490 -- priorities to which the specified dispatching policy apply.
492 -- The line number is an unsigned decimal integer giving the line
493 -- number of the corresponding Priority_Specific_Dispatching pragma.
494 -- This is used in consistency messages.
496 ----------------------------
497 -- Compilation Unit Lines --
498 ----------------------------
500 -- Following these header lines, a set of information lines appears for
501 -- each compilation unit that appears in the corresponding object file. In
502 -- particular, when a package body or subprogram body is compiled, there
503 -- will be two sets of information, one for the spec and one for the body,
504 -- with the entry for the body appearing first. This is the only case in
505 -- which a single ALI file contains more than one unit (in particular note
506 -- that subunits do *not* count as compilation units for this purpose, and
507 -- generate no library information, since they are inlined).
509 -- --------------------
510 -- -- U Unit Header --
511 -- --------------------
513 -- The lines for each compilation unit have the following form
515 -- U unit-name source-name version <<attributes>>
517 -- This line identifies the unit to which this section of the library
518 -- information file applies. The first three parameters are the unit
519 -- name in internal format, as described in package Uname, and the name
520 -- of the source file containing the unit.
522 -- Version is the version given as eight hexadecimal characters with
523 -- upper case letters. This value is the exclusive or of the source
524 -- checksums of the unit and all its semantically dependent units.
526 -- The <<attributes>> are a series of two letter codes indicating
527 -- information about the unit:
529 -- BD Unit does not have pragma Elaborate_Body, but the elaboration
530 -- circuit has determined that it would be a good idea if this
531 -- pragma were present, since the body of the package contains
532 -- elaboration code that modifies one or more variables in the
533 -- visible part of the package. The binder will try, but does
534 -- not promise, to keep the elaboration of the body close to
535 -- the elaboration of the spec.
537 -- DE Dynamic Elaboration. This unit was compiled with the dynamic
538 -- elaboration model, as set by either the -gnatE switch or
539 -- pragma Elaboration_Checks (Dynamic).
541 -- EB Unit has pragma Elaborate_Body, or is a generic instance that
542 -- has a body. Set for instances because RM 12.3(20) requires
543 -- that the body be immediately elaborated after the spec (we
544 -- would normally do that anyway, because elaborate spec and
545 -- body together whenever possible, and for an instance it is
546 -- always possible; however setting EB ensures that this is done
547 -- even when using the -p gnatbind switch).
549 -- EE Elaboration entity is present which must be set true when
550 -- the unit is elaborated. The name of the elaboration entity is
551 -- formed from the unit name in the usual way. If EE is present,
552 -- then this boolean must be set True as part of the elaboration
553 -- processing routine generated by the binder. Note that EE can
554 -- be set even if NE is set. This happens when the boolean is
555 -- needed solely for checking for the case of access before
558 -- GE Unit is a generic declaration, or corresponding body
560 -- IL Unit source uses a style with identifiers in all lower-case
561 -- IU (IL) or all upper case (IU). If the standard mixed-case usage
562 -- is detected, or the compiler cannot determine the style, then
563 -- no I parameter will appear.
565 -- IS Initialize_Scalars pragma applies to this unit, or else there
566 -- is at least one use of the Invalid_Value attribute.
568 -- KM Unit source uses a style with keywords in mixed case (KM)
569 -- KU or all upper case (KU). If the standard lower-case usage is
570 -- is detected, or the compiler cannot determine the style, then
571 -- no K parameter will appear.
573 -- NE Unit has no elaboration routine. All subprogram bodies and
574 -- specs are in this category. Package bodies and specs may or
575 -- may not have NE set, depending on whether or not elaboration
576 -- code is required. Set if N_Compilation_Unit node has flag
577 -- Has_No_Elaboration_Code set.
579 -- OL The units in this file are compiled with a local pragma
580 -- Optimize_Alignment, so no consistency requirement applies
581 -- to these units. All internal units have this status since
582 -- they have an automatic default of Optimize_Alignment (Off).
584 -- OO Optimize_Alignment (Off) is the default setting for all
585 -- units in this file. All files in the partition that specify
586 -- a default must specify the same default.
588 -- OS Optimize_Alignment (Space) is the default setting for all
589 -- units in this file. All files in the partition that specify
590 -- a default must specify the same default.
592 -- OT Optimize_Alignment (Time) is the default setting for all
593 -- units in this file. All files in the partition that specify
594 -- a default must specify the same default.
596 -- PF The unit has a library-level (package) finalizer
598 -- PK Unit is package, rather than a subprogram
600 -- PU Unit has pragma Pure
602 -- PR Unit has pragma Preelaborate
604 -- RA Unit declares a Remote Access to Class-Wide (RACW) type
606 -- RC Unit has pragma Remote_Call_Interface
608 -- RT Unit has pragma Remote_Types
610 -- SE Compilation of unit encountered one or more serious errors.
611 -- Normally the generation of an ALI file is suppressed if there
612 -- is a serious error, but this can be overridden with -gnatQ.
614 -- SP Unit has pragma Shared_Passive
616 -- SU Unit is a subprogram, rather than a package
618 -- The attributes may appear in any order, separated by spaces
620 -- -----------------------------
621 -- -- W, Y and Z Withed Units --
622 -- -----------------------------
624 -- Following each U line, is a series of lines of the form
626 -- W unit-name [source-name lib-name] [E] [EA] [ED] [AD]
628 -- Y unit-name [source-name lib-name] [E] [EA] [ED] [AD]
630 -- Z unit-name [source-name lib-name] [E] [EA] [ED] [AD]
632 -- One W line is present for each unit that is mentioned in an explicit
633 -- nonlimited with clause by the current unit. One Y line is present
634 -- for each unit that is mentioned in an explicit limited with clause
635 -- by the current unit. One Z line is present for each unit that is
636 -- only implicitly withed by the current unit. The first parameter is
637 -- the unit name in internal format. The second parameter is the file
638 -- name of the file that must be compiled to compile this unit. It is
639 -- usually the file for the body, except for packages which have no
640 -- body. For units that need a body, if the source file for the body
641 -- cannot be found, the file name of the spec is used instead. The
642 -- third parameter is the file name of the library information file
643 -- that contains the results of compiling this unit. The optional
644 -- modifiers are used as follows:
646 -- E pragma Elaborate applies to this unit
648 -- EA pragma Elaborate_All applies to this unit
650 -- ED Elaborate_Desirable set for this unit, which means that there
651 -- is no Elaborate, but the analysis suggests that Program_Error
652 -- may be raised if the Elaborate conditions cannot be satisfied.
653 -- The binder will attempt to treat ED as E if it can.
655 -- AD Elaborate_All_Desirable set for this unit, which means that
656 -- there is no Elaborate_All, but the analysis suggests that
657 -- Program_Error may be raised if the Elaborate_All conditions
658 -- cannot be satisfied. The binder will attempt to treat AD as
661 -- The parameter source-name and lib-name are omitted for the case of a
662 -- generic unit compiled with earlier versions of GNAT which did not
663 -- generate object or ali files for generics. For compatibility in the
664 -- bootstrap path we continue to omit these entries for predefined
665 -- generic units, even though we do now generate object and ali files.
667 -- However, in SPARK mode, we always generate source-name and lib-name
668 -- parameters. Bootstrap issues do not apply there, and we need this
669 -- information to properly compute frame conditions of subprograms.
671 -- The parameter source-name and lib-name are also omitted for the W
672 -- lines that result from use of a Restriction_Set attribute which gets
673 -- a result of False from a No_Dependence check, in the case where the
674 -- unit is not in the semantic closure. In such a case, the bare W
675 -- line is generated, but no D (dependency) line. This will make the
676 -- binder do the consistency check, but not include the unit in the
677 -- partition closure (unless it is properly With'ed somewhere).
679 -- --------------------
680 -- -- T Task Stacks --
681 -- --------------------
683 -- Following the W lines (if any, or the U line if not), is an optional
684 -- line that identifies the number of default-sized primary and secondary
685 -- stacks that the binder needs to create for the tasks declared within the
686 -- unit. For each compilation unit, a line is present in the form:
688 -- T primary-stack-quantity secondary-stack-quantity
690 -- The first parameter of T defines the number of task objects declared
691 -- in the unit that have no Storage_Size specified. The second parameter
692 -- defines the number of task objects declared in the unit that have no
693 -- Secondary_Stack_Size specified. These values are non-zero only if
694 -- the restrictions No_Implicit_Heap_Allocations or
695 -- No_Implicit_Task_Allocations are active.
697 -- -----------------------
698 -- -- L Linker_Options --
699 -- -----------------------
701 -- Following the T and W lines (if any, or the U line if not), are
702 -- an optional series of lines that indicates the usage of the pragma
703 -- Linker_Options in the associated unit. For each appearance of a pragma
704 -- Linker_Options (or Link_With) in the unit, a line is present with the
709 -- where string is the string from the unit line enclosed in quotes.
710 -- Within the quotes the following can occur:
712 -- c graphic characters in range 20-7E other than " or {
713 -- "" indicating a single " character
714 -- {hh} indicating a character whose code is hex hh (0-9,A-F)
715 -- {00} [ASCII.NUL] is used as a separator character
716 -- to separate multiple arguments of a single
717 -- Linker_Options pragma.
719 -- For further details, see Stringt.Write_String_Table_Entry. Note that
720 -- wide characters in the form {hhhh} cannot be produced, since pragma
721 -- Linker_Option accepts only String, not Wide_String.
723 -- The L lines are required to appear in the same order as the
724 -- corresponding Linker_Options (or Link_With) pragmas appear in the
725 -- source file, so that this order is preserved by the binder in
726 -- constructing the set of linker arguments.
728 -- Note: Linker_Options lines never appear in the ALI file generated for
729 -- a predefined generic unit, and there is cicuitry in Sem_Prag to enforce
730 -- this restriction, which is needed because of not generating source name
731 -- and lib name parameters on the with lines for such files, as explained
732 -- above in the section on with lines.
738 -- The final section of unit-specific lines contains notes which record
739 -- annotations inserted in source code for processing by external tools
740 -- using pragmas. For each occurrence of any of these pragmas, a line is
741 -- generated with the following syntax:
743 -- N x<sloc> [<arg_id>:]<arg> ...
752 -- <sloc> is the source location of the pragma in line:col[:filename]
753 -- format. The file name is omitted if it is the same as the current
754 -- unit (it therefore appears explicitly in the case of pragmas
755 -- occurring in subunits, which do not have U sections of their own).
757 -- Successive entries record the pragma_argument_associations.
759 -- If a pragma argument identifier is present, the entry is prefixed
760 -- with the pragma argument identifier <arg_id> followed by a colon.
762 -- <arg> represents the pragma argument, and has the following
765 -- - identifiers are output verbatim
766 -- - static string expressions are output as literals encoded as
768 -- - static integer expressions are output as decimal literals
769 -- - any other expression is replaced by the placeholder "<expr>"
771 ---------------------
772 -- Reference Lines --
773 ---------------------
775 -- The reference lines contain information about references from any of the
776 -- units in the compilation (including body version and version attributes,
777 -- linker options pragmas and source dependencies).
779 -- ------------------------------------
780 -- -- E External Version References --
781 -- ------------------------------------
783 -- One of these lines is present for each use of 'Body_Version or 'Version
784 -- in any of the units of the compilation. These are used by the linker to
785 -- determine which version symbols must be output. The format is simply:
789 -- where name is the external name, i.e. the unit name with either a S or a
790 -- B for spec or body version referenced (Body_Version always references
791 -- the body, Version references the Spec, except in the case of a reference
792 -- to a subprogram with no separate spec). Upper half and wide character
793 -- codes are encoded using the same method as in Namet (Uhh for upper half,
794 -- Whhhh for wide character, where hh are hex digits).
796 -- ---------------------
797 -- -- D Dependencies --
798 -- ---------------------
800 -- The dependency lines indicate the source files on which the compiled
801 -- units depend. This is used by the binder for consistency checking.
802 -- These lines are also referenced by the cross-reference information.
804 -- D source-name time-stamp checksum (sub)unit-name line:file-name
806 -- source-name also includes preprocessing data file and preprocessing
807 -- definition file. These preprocessing files may be given as full
808 -- path names instead of simple file names. If a full path name
809 -- includes a directory with spaces, the path name is quoted (quote
810 -- characters (") added at start and end, and any internal quotes are
813 -- The time-stamp field contains the time stamp of the corresponding
814 -- source file. See types.ads for details on time stamp representation.
816 -- The checksum is an 8-hex digit representation of the source file
817 -- checksum, with letters given in lower case.
819 -- If the unit is not a subunit, the (sub)unit name is the unit name in
820 -- internal format, as described in package Uname. If the unit is a
821 -- subunit, the (sub)unit name is the fully qualified name of the
822 -- subunit in all lower case letters.
824 -- The line:file-name entry is present only if a Source_Reference
825 -- pragma appeared in the source file identified by source-name. In
826 -- this case, it gives the information from this pragma. Note that this
827 -- allows cross-reference information to be related back to the
828 -- original file. Note: the reason the line number comes first is that
829 -- a leading digit immediately identifies this as a Source_Reference
830 -- entry, rather than a subunit-name.
832 -- A line number of zero for line: in this entry indicates that there
833 -- is more than one source reference pragma. In this case, the line
834 -- numbers in the cross-reference are correct, and refer to the
835 -- original line number, but there is no information that allows a
836 -- reader of the ALI file to determine the exact mapping of physical
837 -- line numbers back to the original source.
839 -- Files with a zero checksum and a non-zero time stamp are in general
840 -- files on which the compilation depends but which are not Ada files
841 -- with further dependencies. This includes preprocessor data files
842 -- and preprocessor definition files.
844 -- Note: blank lines are ignored when the library information is read,
845 -- and separate sections of the file are separated by blank lines to
846 -- ease readability. Blanks between fields are also ignored.
848 -- For entries corresponding to files that were not present (and thus
849 -- resulted in error messages), or for files that are not part of the
850 -- dependency set, both the time stamp and checksum are set to all zero
851 -- characters. These dummy entries are ignored by the binder in
852 -- dependency checking, but must be present for proper interpretation
853 -- of the cross-reference data.
855 -- -------------------------
856 -- -- G Invocation Graph --
857 -- -------------------------
859 -- An invocation graph line has the following format:
861 -- G line-kind line-attributes
863 -- Attribute line-kind is a Character which denotes the nature of the
864 -- line. Table ALI.Invocation_Graph_Line_Codes lists all legal values.
866 -- Attribute line-attributes depends on the value of line-kind, and is
867 -- contents are described further below.
869 -- An invocation signature uniquely identifies an invocation construct in
870 -- the ALI file namespace, and has the following format:
872 -- [ name scope line column (locations | "none") ]
874 -- Attribute name is a String which denotes the name of the construct
876 -- Attribute scope is a String which denotes the qualified name of the
877 -- scope where the construct is declared.
879 -- Attribute line is a Positive which denotes the line number where the
880 -- initial declaration of the construct appears.
882 -- Attribute column is a Positive which denotes the column number where
883 -- the initial declaration of the construct appears.
885 -- Attribute locations is a String which denotes the line and column
886 -- locations of all instances where the initial declaration of the
887 -- construct appears.
889 -- When the line-kind denotes invocation graph attributes, line-attributes
890 -- are set as follows:
894 -- Attribute encoding-kind is a Character which specifies the encoding
895 -- kind used when collecting invocation constructs and relations. Table
896 -- ALI.Invocation_Graph_Encoding_Codes lists all legal values.
898 -- When the line-kind denotes an invocation construct, line-attributes are
901 -- construct-kind construct-spec-placement construct-body-placement
902 -- construct-signature
904 -- Attribute construct-kind is a Character which denotes the nature of
905 -- the construct. Table ALI.Invocation_Construct_Codes lists all legal
908 -- Attribute construct-spec-placement is a Character which denotes the
909 -- placement of the construct's spec within the unit. All legal values
910 -- are listed in table ALI.Spec_And_Body_Placement_Codes.
912 -- Attribute construct-body-placement is a Character which denotes the
913 -- placement of the construct's body within the unit. All legal values
914 -- are listed in table ALI.Spec_And_Body_Placement_Codes.
916 -- Attribute construct-signature is the invocation signature of the
919 -- When the line-kind denotes an invocation relation, line-attributes are
922 -- relation-kind (extra-name | "none") invoker-signature
925 -- Attribute relation-kind is a Character which denotes the nature of
926 -- the relation. All legal values are listed in ALI.Invocation_Codes.
928 -- Attribute extra-name is a String which denotes the name of an extra
929 -- entity used for error diagnostics. The value of extra-name depends
930 -- on the relation-kind as follows:
932 -- Accept_Alternative - related entry
933 -- Access_Taken - related subprogram
934 -- Call - not present
935 -- Controlled_Adjustment - related controlled type
936 -- Controlled_Finalization - related controlled type
937 -- Controlled_Initialization - related controlled type
938 -- Default_Initial_Condition_Verification - related private type
939 -- Initial_Condition_Verification - not present
940 -- Instantiation - not present
941 -- Internal_Controlled_Adjustment - related controlled type
942 -- Internal_Controlled_Finalization - related controlled type
943 -- Internal_Controlled_Initialization - related controlled type
944 -- Invariant_Verification - related private type
945 -- Postcondition_Verification - related routine
946 -- Protected_Entry_Call - not present
947 -- Protected_Subprogram_Call - not present
948 -- Task_Activation - not present
949 -- Task_Entry_Call - not present
950 -- Type_Initialization - related type
952 -- Attribute invoker-signature is the invocation signature of the
955 -- Attribute target-signature is the invocation signature of the target
957 --------------------------
958 -- Cross-Reference Data --
959 --------------------------
961 -- The cross-reference data follows the dependency lines. See the spec of
962 -- Lib.Xref in file lib-xref.ads for details on the format of this data.
964 ---------------------------------
965 -- Source Coverage Obligations --
966 ---------------------------------
968 -- The Source Coverage Obligation (SCO) information follows the cross-
969 -- reference data. See the spec of Par_SCO in file par_sco.ads for full
970 -- details of the format.
972 ---------------------------------------
973 -- SPARK Cross-Reference Information --
974 ---------------------------------------
976 -- The SPARK cross-reference information follows the SCO information. See
977 -- the spec of SPARK_Xrefs in file spark_xrefs.ads for full details of the
980 -------------------------------
981 -- ALI File Generation for C --
982 -------------------------------
984 -- The C compiler can also generate ALI files for use by the IDE's in
985 -- providing navigation services in C. These ALI files are a subset of
986 -- the specification above, lacking all Ada-specific output. Primarily
987 -- the IDE uses the cross-reference sections of such files.
989 ----------------------
990 -- Global Variables --
991 ----------------------
993 -- The table defined here stores one entry for each Interrupt_State pragma
994 -- encountered either in the main source or in an ancillary with'ed source.
995 -- Since interrupt state values have to be consistent across all units in a
996 -- partition, we detect inconsistencies at compile time when we can.
998 type Interrupt_State_Entry
is record
999 Interrupt_Number
: Pos
;
1000 -- Interrupt number value
1002 Interrupt_State
: Character;
1003 -- Set to r/s/u for Runtime/System/User
1005 Pragma_Loc
: Source_Ptr
;
1006 -- Location of pragma setting this value in place
1009 package Interrupt_States
is new Table
.Table
(
1010 Table_Component_Type
=> Interrupt_State_Entry
,
1011 Table_Index_Type
=> Nat
,
1012 Table_Low_Bound
=> 1,
1013 Table_Initial
=> 30,
1014 Table_Increment
=> 200,
1015 Table_Name
=> "Name_Interrupt_States");
1017 -- The table structure defined here stores one entry for each
1018 -- Priority_Specific_Dispatching pragma encountered either in the main
1019 -- source or in an ancillary with'ed source. Since have to be consistent
1020 -- across all units in a partition, we may as well detect inconsistencies
1021 -- at compile time when we can.
1023 type Specific_Dispatching_Entry
is record
1024 Dispatching_Policy
: Character;
1025 -- First character (upper case) of the corresponding policy name
1027 First_Priority
: Nat
;
1028 -- Lower bound of the priority range to which the specified dispatching
1031 Last_Priority
: Nat
;
1032 -- Upper bound of the priority range to which the specified dispatching
1035 Pragma_Loc
: Source_Ptr
;
1036 -- Location of pragma setting this value in place
1039 package Specific_Dispatching
is new Table
.Table
(
1040 Table_Component_Type
=> Specific_Dispatching_Entry
,
1041 Table_Index_Type
=> Nat
,
1042 Table_Low_Bound
=> 1,
1043 Table_Initial
=> 10,
1044 Table_Increment
=> 100,
1045 Table_Name
=> "Name_Priority_Specific_Dispatching");
1051 procedure Ensure_System_Dependency
;
1052 -- This procedure ensures that a dependency is created on system.ads. Even
1053 -- if there is no semantic dependency, Targparm has read the file to
1054 -- acquire target parameters, so we need a source dependency.
1056 procedure Write_ALI
(Object
: Boolean);
1057 -- This procedure writes the library information for the current main unit
1058 -- The Object parameter is true if an object file is created, and false
1059 -- otherwise. Note that the pseudo-object file generated in GNATprove mode
1060 -- does count as an object file from this point of view.
1061 -- May output duplicate D lines caused by generic instantiations. This is
1062 -- by design as GNATcoverage relies on them for its coverage of generic
1063 -- instantiations, although this may be revisited in the future.
1065 procedure Add_Preprocessing_Dependency
(S
: Source_File_Index
);
1066 -- Indicate that there is a dependency to be added on a preprocessing data
1067 -- file or on a preprocessing definition file.