1 \input texinfo @c -*-texinfo-*-
4 @c oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
6 @c GNAT DOCUMENTATION o
10 @c Copyright (C) 1992-2005 Ada Core Technologies, Inc. o
12 @c GNAT is free software; you can redistribute it and/or modify it under o
13 @c terms of the GNU General Public License as published by the Free Soft- o
14 @c ware Foundation; either version 2, or (at your option) any later ver- o
15 @c sion. GNAT is distributed in the hope that it will be useful, but WITH- o
16 @c OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY o
17 @c or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License o
18 @c for more details. You should have received a copy of the GNU General o
19 @c Public License distributed with GNAT; see file COPYING. If not, write o
20 @c to the Free Software Foundation, 51 Franklin Street, Fifth Floor, o
21 @c Boston, MA 02110-1301, USA. o
23 @c oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
25 @c oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
27 @c GNAT_UGN Style Guide
29 @c 1. Always put a @noindent on the line before the first paragraph
30 @c after any of these commands:
42 @c 2. DO NOT use @example. Use @smallexample instead.
43 @c a) DO NOT use highlighting commands (@b{}, @i{}) inside an @smallexample
44 @c context. These can interfere with the readability of the texi
45 @c source file. Instead, use one of the following annotated
46 @c @smallexample commands, and preprocess the texi file with the
47 @c ada2texi tool (which generates appropriate highlighting):
48 @c @smallexample @c ada
49 @c @smallexample @c adanocomment
50 @c @smallexample @c projectfile
51 @c b) The "@c ada" markup will result in boldface for reserved words
52 @c and italics for comments
53 @c c) The "@c adanocomment" markup will result only in boldface for
54 @c reserved words (comments are left alone)
55 @c d) The "@c projectfile" markup is like "@c ada" except that the set
56 @c of reserved words include the new reserved words for project files
58 @c 3. Each @chapter, @section, @subsection, @subsubsection, etc.
59 @c command must be preceded by two empty lines
61 @c 4. The @item command should be on a line of its own if it is in an
62 @c @itemize or @enumerate command.
64 @c 5. When talking about ALI files use "ALI" (all uppercase), not "Ali"
67 @c 6. DO NOT put trailing spaces at the end of a line. Such spaces will
68 @c cause the document build to fail.
70 @c 7. DO NOT use @cartouche for examples that are longer than around 10 lines.
71 @c This command inhibits page breaks, so long examples in a @cartouche can
72 @c lead to large, ugly patches of empty space on a page.
74 @c NOTE: This file should be submitted to xgnatugn with either the vms flag
75 @c or the unw flag set. The unw flag covers topics for both Unix and
78 @c oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
81 @setfilename gnat_ugn_vms.info
85 @setfilename gnat_ugn_unw.info
93 @set FILE gnat_ugn_unw
98 @set FILE gnat_ugn_vms
101 @settitle @value{EDITION} User's Guide @value{PLATFORM}
102 @dircategory GNU Ada tools
104 * @value{EDITION} User's Guide (@value{FILE}) @value{PLATFORM}
107 @include gcc-common.texi
109 @setchapternewpage odd
114 Copyright @copyright{} 1995-2005, Free Software Foundation
116 Permission is granted to copy, distribute and/or modify this document
117 under the terms of the GNU Free Documentation License, Version 1.2
118 or any later version published by the Free Software Foundation;
119 with the Invariant Sections being ``GNU Free Documentation License'', with the
120 Front-Cover Texts being
121 ``@value{EDITION} User's Guide'',
122 and with no Back-Cover Texts.
123 A copy of the license is included in the section entitled
124 ``GNU Free Documentation License''.
129 @title @value{EDITION} User's Guide
134 @titlefont{@i{@value{PLATFORM}}}
140 @subtitle GNAT, The GNU Ada 95 Compiler
141 @subtitle GCC version @value{version-GCC}
146 @vskip 0pt plus 1filll
153 @node Top, About This Guide, (dir), (dir)
154 @top @value{EDITION} User's Guide
157 @value{EDITION} User's Guide @value{PLATFORM}
160 GNAT, The GNU Ada 95 Compiler@*
161 GCC version @value{version-GCC}@*
168 * Getting Started with GNAT::
169 * The GNAT Compilation Model::
170 * Compiling Using gcc::
171 * Binding Using gnatbind::
172 * Linking Using gnatlink::
173 * The GNAT Make Program gnatmake::
174 * Improving Performance::
175 * Renaming Files Using gnatchop::
176 * Configuration Pragmas::
177 * Handling Arbitrary File Naming Conventions Using gnatname::
178 * GNAT Project Manager::
179 * The Cross-Referencing Tools gnatxref and gnatfind::
180 * The GNAT Pretty-Printer gnatpp::
181 * The GNAT Metric Tool gnatmetric::
182 * File Name Krunching Using gnatkr::
183 * Preprocessing Using gnatprep::
185 * The GNAT Run-Time Library Builder gnatlbr::
187 * The GNAT Library Browser gnatls::
188 * Cleaning Up Using gnatclean::
190 * GNAT and Libraries::
191 * Using the GNU make Utility::
193 * Memory Management Issues::
194 * Creating Sample Bodies Using gnatstub::
195 * Other Utility Programs::
196 * Running and Debugging Ada Programs::
198 * Compatibility with DEC Ada::
200 * Platform-Specific Information for the Run-Time Libraries::
201 * Example of Binder Output File::
202 * Elaboration Order Handling in GNAT::
204 * Compatibility and Porting Guide::
206 * Microsoft Windows Topics::
208 * GNU Free Documentation License::
211 --- The Detailed Node Listing ---
215 * What This Guide Contains::
216 * What You Should Know before Reading This Guide::
217 * Related Information::
220 Getting Started with GNAT
223 * Running a Simple Ada Program::
224 * Running a Program with Multiple Units::
225 * Using the gnatmake Utility::
227 * Editing with Emacs::
230 * Introduction to GPS::
231 * Introduction to Glide and GVD::
234 The GNAT Compilation Model
236 * Source Representation::
237 * Foreign Language Representation::
238 * File Naming Rules::
239 * Using Other File Names::
240 * Alternative File Naming Schemes::
241 * Generating Object Files::
242 * Source Dependencies::
243 * The Ada Library Information Files::
244 * Binding an Ada Program::
245 * Mixed Language Programming::
246 * Building Mixed Ada & C++ Programs::
247 * Comparison between GNAT and C/C++ Compilation Models::
248 * Comparison between GNAT and Conventional Ada Library Models::
250 * Placement of temporary files::
253 Foreign Language Representation
256 * Other 8-Bit Codes::
257 * Wide Character Encodings::
259 Compiling Ada Programs With gcc
261 * Compiling Programs::
263 * Search Paths and the Run-Time Library (RTL)::
264 * Order of Compilation Issues::
269 * Output and Error Message Control::
270 * Warning Message Control::
271 * Debugging and Assertion Control::
272 * Validity Checking::
275 * Stack Overflow Checking::
276 * Using gcc for Syntax Checking::
277 * Using gcc for Semantic Checking::
278 * Compiling Different Versions of Ada::
279 * Character Set Control::
280 * File Naming Control::
281 * Subprogram Inlining Control::
282 * Auxiliary Output Control::
283 * Debugging Control::
284 * Exception Handling Control::
285 * Units to Sources Mapping Files::
286 * Integrated Preprocessing::
291 Binding Ada Programs With gnatbind
294 * Switches for gnatbind::
295 * Command-Line Access::
296 * Search Paths for gnatbind::
297 * Examples of gnatbind Usage::
299 Switches for gnatbind
301 * Consistency-Checking Modes::
302 * Binder Error Message Control::
303 * Elaboration Control::
305 * Binding with Non-Ada Main Programs::
306 * Binding Programs with No Main Subprogram::
308 Linking Using gnatlink
311 * Switches for gnatlink::
312 * Setting Stack Size from gnatlink::
313 * Setting Heap Size from gnatlink::
315 The GNAT Make Program gnatmake
318 * Switches for gnatmake::
319 * Mode Switches for gnatmake::
320 * Notes on the Command Line::
321 * How gnatmake Works::
322 * Examples of gnatmake Usage::
324 Improving Performance
325 * Performance Considerations::
326 * Reducing the Size of Ada Executables with gnatelim::
328 Performance Considerations
329 * Controlling Run-Time Checks::
330 * Use of Restrictions::
331 * Optimization Levels::
332 * Debugging Optimized Code::
333 * Inlining of Subprograms::
334 * Optimization and Strict Aliasing::
336 * Coverage Analysis::
339 Reducing the Size of Ada Executables with gnatelim
342 * Correcting the List of Eliminate Pragmas::
343 * Making Your Executables Smaller::
344 * Summary of the gnatelim Usage Cycle::
346 Renaming Files Using gnatchop
348 * Handling Files with Multiple Units::
349 * Operating gnatchop in Compilation Mode::
350 * Command Line for gnatchop::
351 * Switches for gnatchop::
352 * Examples of gnatchop Usage::
354 Configuration Pragmas
356 * Handling of Configuration Pragmas::
357 * The Configuration Pragmas Files::
359 Handling Arbitrary File Naming Conventions Using gnatname
361 * Arbitrary File Naming Conventions::
363 * Switches for gnatname::
364 * Examples of gnatname Usage::
369 * Examples of Project Files::
370 * Project File Syntax::
371 * Objects and Sources in Project Files::
372 * Importing Projects::
373 * Project Extension::
374 * Project Hierarchy Extension::
375 * External References in Project Files::
376 * Packages in Project Files::
377 * Variables from Imported Projects::
380 * Stand-alone Library Projects::
381 * Switches Related to Project Files::
382 * Tools Supporting Project Files::
383 * An Extended Example::
384 * Project File Complete Syntax::
386 The Cross-Referencing Tools gnatxref and gnatfind
388 * gnatxref Switches::
389 * gnatfind Switches::
390 * Project Files for gnatxref and gnatfind::
391 * Regular Expressions in gnatfind and gnatxref::
392 * Examples of gnatxref Usage::
393 * Examples of gnatfind Usage::
395 The GNAT Pretty-Printer gnatpp
397 * Switches for gnatpp::
400 The GNAT Metrics Tool gnatmetric
402 * Switches for gnatmetric::
404 File Name Krunching Using gnatkr
409 * Examples of gnatkr Usage::
411 Preprocessing Using gnatprep
414 * Switches for gnatprep::
415 * Form of Definitions File::
416 * Form of Input Text for gnatprep::
419 The GNAT Run-Time Library Builder gnatlbr
422 * Switches for gnatlbr::
423 * Examples of gnatlbr Usage::
426 The GNAT Library Browser gnatls
429 * Switches for gnatls::
430 * Examples of gnatls Usage::
432 Cleaning Up Using gnatclean
434 * Running gnatclean::
435 * Switches for gnatclean::
436 @c * Examples of gnatclean Usage::
442 * Introduction to Libraries in GNAT::
443 * General Ada Libraries::
444 * Stand-alone Ada Libraries::
445 * Rebuilding the GNAT Run-Time Library::
447 Using the GNU make Utility
449 * Using gnatmake in a Makefile::
450 * Automatically Creating a List of Directories::
451 * Generating the Command Line Switches::
452 * Overcoming Command Line Length Limits::
455 Memory Management Issues
457 * Some Useful Memory Pools::
458 * The GNAT Debug Pool Facility::
463 Some Useful Memory Pools
465 The GNAT Debug Pool Facility
471 * Switches for gnatmem::
472 * Example of gnatmem Usage::
475 Sample Bodies Using gnatstub
478 * Switches for gnatstub::
480 Other Utility Programs
482 * Using Other Utility Programs with GNAT::
483 * The External Symbol Naming Scheme of GNAT::
485 * Ada Mode for Glide::
487 * Converting Ada Files to html with gnathtml::
489 Running and Debugging Ada Programs
491 * The GNAT Debugger GDB::
493 * Introduction to GDB Commands::
494 * Using Ada Expressions::
495 * Calling User-Defined Subprograms::
496 * Using the Next Command in a Function::
499 * Debugging Generic Units::
500 * GNAT Abnormal Termination or Failure to Terminate::
501 * Naming Conventions for GNAT Source Files::
502 * Getting Internal Debugging Information::
510 Compatibility with DEC Ada
512 * Ada 95 Compatibility::
513 * Differences in the Definition of Package System::
514 * Language-Related Features::
515 * The Package STANDARD::
516 * The Package SYSTEM::
517 * Tasking and Task-Related Features::
518 * Implementation of Tasks in DEC Ada for OpenVMS Alpha Systems::
519 * Pragmas and Pragma-Related Features::
520 * Library of Predefined Units::
522 * Main Program Definition::
523 * Implementation-Defined Attributes::
524 * Compiler and Run-Time Interfacing::
525 * Program Compilation and Library Management::
527 * Implementation Limits::
530 Language-Related Features
532 * Integer Types and Representations::
533 * Floating-Point Types and Representations::
534 * Pragmas Float_Representation and Long_Float::
535 * Fixed-Point Types and Representations::
536 * Record and Array Component Alignment::
538 * Other Representation Clauses::
540 Implementation of Tasks in DEC Ada for OpenVMS Alpha Systems
542 * Assigning Task IDs::
543 * Task IDs and Delays::
544 * Task-Related Pragmas::
545 * Scheduling and Task Priority::
547 * External Interrupts::
549 Pragmas and Pragma-Related Features
551 * Restrictions on the Pragma INLINE::
552 * Restrictions on the Pragma INTERFACE::
553 * Restrictions on the Pragma SYSTEM_NAME::
555 Library of Predefined Units
557 * Changes to DECLIB::
561 * Shared Libraries and Options Files::
565 Platform-Specific Information for the Run-Time Libraries
567 * Summary of Run-Time Configurations::
568 * Specifying a Run-Time Library::
569 * Choosing the Scheduling Policy::
570 * Solaris-Specific Considerations::
571 * IRIX-Specific Considerations::
572 * Linux-Specific Considerations::
573 * AIX-Specific Considerations::
575 Example of Binder Output File
577 Elaboration Order Handling in GNAT
579 * Elaboration Code in Ada 95::
580 * Checking the Elaboration Order in Ada 95::
581 * Controlling the Elaboration Order in Ada 95::
582 * Controlling Elaboration in GNAT - Internal Calls::
583 * Controlling Elaboration in GNAT - External Calls::
584 * Default Behavior in GNAT - Ensuring Safety::
585 * Treatment of Pragma Elaborate::
586 * Elaboration Issues for Library Tasks::
587 * Mixing Elaboration Models::
588 * What to Do If the Default Elaboration Behavior Fails::
589 * Elaboration for Access-to-Subprogram Values::
590 * Summary of Procedures for Elaboration Control::
591 * Other Elaboration Order Considerations::
595 * Basic Assembler Syntax::
596 * A Simple Example of Inline Assembler::
597 * Output Variables in Inline Assembler::
598 * Input Variables in Inline Assembler::
599 * Inlining Inline Assembler Code::
600 * Other Asm Functionality::
602 Compatibility and Porting Guide
604 * Compatibility with Ada 83::
605 * Implementation-dependent characteristics::
606 * Compatibility with DEC Ada 83::
607 * Compatibility with Other Ada 95 Systems::
608 * Representation Clauses::
610 * Transitioning from Alpha to Integrity OpenVMS::
614 Microsoft Windows Topics
616 * Using GNAT on Windows::
617 * CONSOLE and WINDOWS subsystems::
619 * Mixed-Language Programming on Windows::
620 * Windows Calling Conventions::
621 * Introduction to Dynamic Link Libraries (DLLs)::
622 * Using DLLs with GNAT::
623 * Building DLLs with GNAT::
624 * GNAT and Windows Resources::
626 * GNAT and COM/DCOM Objects::
633 @node About This Guide
634 @unnumbered About This Guide
638 This guide describes the use of @value{EDITION},
639 a full language compiler for the Ada
640 95 programming language, implemented on HP's Alpha and
641 Integrity (ia64) OpenVMS platforms.
644 This guide describes the use of @value{EDITION},
645 a compiler and software development
646 toolset for the full Ada 95 programming language.
648 It describes the features of the compiler and tools, and details
649 how to use them to build Ada 95 applications.
652 For ease of exposition, ``GNAT Pro'' will be referred to simply as
653 ``GNAT'' in the remainder of this document.
657 * What This Guide Contains::
658 * What You Should Know before Reading This Guide::
659 * Related Information::
663 @node What This Guide Contains
664 @unnumberedsec What This Guide Contains
667 This guide contains the following chapters:
671 @ref{Getting Started with GNAT}, describes how to get started compiling
672 and running Ada programs with the GNAT Ada programming environment.
674 @ref{The GNAT Compilation Model}, describes the compilation model used
678 @ref{Compiling Using gcc}, describes how to compile
679 Ada programs with @command{gcc}, the Ada compiler.
682 @ref{Binding Using gnatbind}, describes how to
683 perform binding of Ada programs with @code{gnatbind}, the GNAT binding
687 @ref{Linking Using gnatlink},
688 describes @command{gnatlink}, a
689 program that provides for linking using the GNAT run-time library to
690 construct a program. @command{gnatlink} can also incorporate foreign language
691 object units into the executable.
694 @ref{The GNAT Make Program gnatmake}, describes @command{gnatmake}, a
695 utility that automatically determines the set of sources
696 needed by an Ada compilation unit, and executes the necessary compilations
700 @ref{Improving Performance}, shows various techniques for making your
701 Ada program run faster or take less space.
702 It discusses the effect of the compiler's optimization switch and
703 also describes the @command{gnatelim} tool.
706 @ref{Renaming Files Using gnatchop}, describes
707 @code{gnatchop}, a utility that allows you to preprocess a file that
708 contains Ada source code, and split it into one or more new files, one
709 for each compilation unit.
712 @ref{Configuration Pragmas}, describes the configuration pragmas
716 @ref{Handling Arbitrary File Naming Conventions Using gnatname},
717 shows how to override the default GNAT file naming conventions,
718 either for an individual unit or globally.
721 @ref{GNAT Project Manager}, describes how to use project files
722 to organize large projects.
725 @ref{The Cross-Referencing Tools gnatxref and gnatfind}, discusses
726 @code{gnatxref} and @code{gnatfind}, two tools that provide an easy
727 way to navigate through sources.
730 @ref{The GNAT Pretty-Printer gnatpp}, shows how to produce a reformatted
731 version of an Ada source file with control over casing, indentation,
732 comment placement, and other elements of program presentation style.
735 @ref{The GNAT Metric Tool gnatmetric}, shows how to compute various
736 metrics for an Ada source file, such as the number of types and subprograms,
737 and assorted complexity measures.
740 @ref{File Name Krunching Using gnatkr}, describes the @code{gnatkr}
741 file name krunching utility, used to handle shortened
742 file names on operating systems with a limit on the length of names.
745 @ref{Preprocessing Using gnatprep}, describes @code{gnatprep}, a
746 preprocessor utility that allows a single source file to be used to
747 generate multiple or parameterized source files, by means of macro
752 @ref{The GNAT Run-Time Library Builder gnatlbr}, describes @command{gnatlbr},
753 a tool for rebuilding the GNAT run time with user-supplied
754 configuration pragmas.
758 @ref{The GNAT Library Browser gnatls}, describes @code{gnatls}, a
759 utility that displays information about compiled units, including dependences
760 on the corresponding sources files, and consistency of compilations.
763 @ref{Cleaning Up Using gnatclean}, describes @code{gnatclean}, a utility
764 to delete files that are produced by the compiler, binder and linker.
768 @ref{GNAT and Libraries}, describes the process of creating and using
769 Libraries with GNAT. It also describes how to recompile the GNAT run-time
773 @ref{Using the GNU make Utility}, describes some techniques for using
774 the GNAT toolset in Makefiles.
778 @ref{Memory Management Issues}, describes some useful predefined storage pools
779 and in particular the GNAT Debug Pool facility, which helps detect incorrect
782 It also describes @command{gnatmem}, a utility that monitors dynamic
783 allocation and deallocation and helps detect ``memory leaks''.
787 @ref{Creating Sample Bodies Using gnatstub}, discusses @code{gnatstub},
788 a utility that generates empty but compilable bodies for library units.
791 @ref{Other Utility Programs}, discusses several other GNAT utilities,
792 including @code{gnathtml}.
795 @ref{Running and Debugging Ada Programs}, describes how to run and debug
800 @ref{Compatibility with DEC Ada}, details the compatibility of GNAT with
801 DEC Ada 83 @footnote{``DEC Ada'' refers to the legacy product originally
802 developed by Digital Equipment Corporation and currently supported by HP.}
807 @ref{Platform-Specific Information for the Run-Time Libraries},
808 describes the various run-time
809 libraries supported by GNAT on various platforms and explains how to
810 choose a particular library.
813 @ref{Example of Binder Output File}, shows the source code for the binder
814 output file for a sample program.
817 @ref{Elaboration Order Handling in GNAT}, describes how GNAT helps
818 you deal with elaboration order issues.
821 @ref{Inline Assembler}, shows how to use the inline assembly facility
825 @ref{Compatibility and Porting Guide}, includes sections on compatibility
826 of GNAT with other Ada 83 and Ada 95 compilation systems, to assist
827 in porting code from other environments.
831 @ref{Microsoft Windows Topics}, presents information relevant to the
832 Microsoft Windows platform.
836 @c *************************************************
837 @node What You Should Know before Reading This Guide
838 @c *************************************************
839 @unnumberedsec What You Should Know before Reading This Guide
841 @cindex Ada 95 Language Reference Manual
843 This user's guide assumes that you are familiar with Ada 95 language, as
844 described in the International Standard ANSI/ISO/IEC-8652:1995, January
847 @node Related Information
848 @unnumberedsec Related Information
851 For further information about related tools, refer to the following
856 @cite{GNAT Reference Manual}, which contains all reference
857 material for the GNAT implementation of Ada 95.
861 @cite{Using the GNAT Programming System}, which describes the GPS
862 integrated development environment.
865 @cite{GNAT Programming System Tutorial}, which introduces the
866 main GPS features through examples.
870 @cite{Ada 95 Language Reference Manual}, which contains all reference
871 material for the Ada 95 programming language.
874 @cite{Debugging with GDB}
876 , located in the GNU:[DOCS] directory,
878 contains all details on the use of the GNU source-level debugger.
881 @cite{GNU Emacs Manual}
883 , located in the GNU:[DOCS] directory if the EMACS kit is installed,
885 contains full information on the extensible editor and programming
892 @unnumberedsec Conventions
894 @cindex Typographical conventions
897 Following are examples of the typographical and graphic conventions used
902 @code{Functions}, @code{utility program names}, @code{standard names},
909 @file{File Names}, @file{button names}, and @file{field names}.
918 [optional information or parameters]
921 Examples are described by text
923 and then shown this way.
928 Commands that are entered by the user are preceded in this manual by the
929 characters @w{``@code{$ }''} (dollar sign followed by space). If your system
930 uses this sequence as a prompt, then the commands will appear exactly as
931 you see them in the manual. If your system uses some other prompt, then
932 the command will appear with the @code{$} replaced by whatever prompt
933 character you are using.
936 Full file names are shown with the ``@code{/}'' character
937 as the directory separator; e.g., @file{parent-dir/subdir/myfile.adb}.
938 If you are using GNAT on a Windows platform, please note that
939 the ``@code{\}'' character should be used instead.
942 @c ****************************
943 @node Getting Started with GNAT
944 @chapter Getting Started with GNAT
947 This chapter describes some simple ways of using GNAT to build
948 executable Ada programs.
950 @ref{Running GNAT}, through @ref{Using the gnatmake Utility},
951 show how to use the command line environment.
952 @ref{Introduction to Glide and GVD}, provides a brief
953 introduction to the visually-oriented IDE for GNAT.
954 Supplementing Glide on some platforms is GPS, the
955 GNAT Programming System, which offers a richer graphical
956 ``look and feel'', enhanced configurability, support for
957 development in other programming language, comprehensive
958 browsing features, and many other capabilities.
959 For information on GPS please refer to
960 @cite{Using the GNAT Programming System}.
965 * Running a Simple Ada Program::
966 * Running a Program with Multiple Units::
967 * Using the gnatmake Utility::
969 * Editing with Emacs::
972 * Introduction to GPS::
973 * Introduction to Glide and GVD::
978 @section Running GNAT
981 Three steps are needed to create an executable file from an Ada source
986 The source file(s) must be compiled.
988 The file(s) must be bound using the GNAT binder.
990 All appropriate object files must be linked to produce an executable.
994 All three steps are most commonly handled by using the @command{gnatmake}
995 utility program that, given the name of the main program, automatically
996 performs the necessary compilation, binding and linking steps.
998 @node Running a Simple Ada Program
999 @section Running a Simple Ada Program
1002 Any text editor may be used to prepare an Ada program.
1005 used, the optional Ada mode may be helpful in laying out the program.
1008 program text is a normal text file. We will suppose in our initial
1009 example that you have used your editor to prepare the following
1010 standard format text file:
1012 @smallexample @c ada
1014 with Ada.Text_IO; use Ada.Text_IO;
1017 Put_Line ("Hello WORLD!");
1023 This file should be named @file{hello.adb}.
1024 With the normal default file naming conventions, GNAT requires
1026 contain a single compilation unit whose file name is the
1028 with periods replaced by hyphens; the
1029 extension is @file{ads} for a
1030 spec and @file{adb} for a body.
1031 You can override this default file naming convention by use of the
1032 special pragma @code{Source_File_Name} (@pxref{Using Other File Names}).
1033 Alternatively, if you want to rename your files according to this default
1034 convention, which is probably more convenient if you will be using GNAT
1035 for all your compilations, then the @code{gnatchop} utility
1036 can be used to generate correctly-named source files
1037 (@pxref{Renaming Files Using gnatchop}).
1039 You can compile the program using the following command (@code{$} is used
1040 as the command prompt in the examples in this document):
1047 @command{gcc} is the command used to run the compiler. This compiler is
1048 capable of compiling programs in several languages, including Ada 95 and
1049 C. It assumes that you have given it an Ada program if the file extension is
1050 either @file{.ads} or @file{.adb}, and it will then call
1051 the GNAT compiler to compile the specified file.
1054 The @option{-c} switch is required. It tells @command{gcc} to only do a
1055 compilation. (For C programs, @command{gcc} can also do linking, but this
1056 capability is not used directly for Ada programs, so the @option{-c}
1057 switch must always be present.)
1060 This compile command generates a file
1061 @file{hello.o}, which is the object
1062 file corresponding to your Ada program. It also generates
1063 an ``Ada Library Information'' file @file{hello.ali},
1064 which contains additional information used to check
1065 that an Ada program is consistent.
1066 To build an executable file,
1067 use @code{gnatbind} to bind the program
1068 and @command{gnatlink} to link it. The
1069 argument to both @code{gnatbind} and @command{gnatlink} is the name of the
1070 @file{ALI} file, but the default extension of @file{.ali} can
1071 be omitted. This means that in the most common case, the argument
1072 is simply the name of the main program:
1080 A simpler method of carrying out these steps is to use
1082 a master program that invokes all the required
1083 compilation, binding and linking tools in the correct order. In particular,
1084 @command{gnatmake} automatically recompiles any sources that have been
1085 modified since they were last compiled, or sources that depend
1086 on such modified sources, so that ``version skew'' is avoided.
1087 @cindex Version skew (avoided by @command{gnatmake})
1090 $ gnatmake hello.adb
1094 The result is an executable program called @file{hello}, which can be
1102 assuming that the current directory is on the search path
1103 for executable programs.
1106 and, if all has gone well, you will see
1113 appear in response to this command.
1115 @c ****************************************
1116 @node Running a Program with Multiple Units
1117 @section Running a Program with Multiple Units
1120 Consider a slightly more complicated example that has three files: a
1121 main program, and the spec and body of a package:
1123 @smallexample @c ada
1126 package Greetings is
1131 with Ada.Text_IO; use Ada.Text_IO;
1132 package body Greetings is
1135 Put_Line ("Hello WORLD!");
1138 procedure Goodbye is
1140 Put_Line ("Goodbye WORLD!");
1157 Following the one-unit-per-file rule, place this program in the
1158 following three separate files:
1162 spec of package @code{Greetings}
1165 body of package @code{Greetings}
1168 body of main program
1172 To build an executable version of
1173 this program, we could use four separate steps to compile, bind, and link
1174 the program, as follows:
1178 $ gcc -c greetings.adb
1184 Note that there is no required order of compilation when using GNAT.
1185 In particular it is perfectly fine to compile the main program first.
1186 Also, it is not necessary to compile package specs in the case where
1187 there is an accompanying body; you only need to compile the body. If you want
1188 to submit these files to the compiler for semantic checking and not code
1189 generation, then use the
1190 @option{-gnatc} switch:
1193 $ gcc -c greetings.ads -gnatc
1197 Although the compilation can be done in separate steps as in the
1198 above example, in practice it is almost always more convenient
1199 to use the @command{gnatmake} tool. All you need to know in this case
1200 is the name of the main program's source file. The effect of the above four
1201 commands can be achieved with a single one:
1204 $ gnatmake gmain.adb
1208 In the next section we discuss the advantages of using @command{gnatmake} in
1211 @c *****************************
1212 @node Using the gnatmake Utility
1213 @section Using the @command{gnatmake} Utility
1216 If you work on a program by compiling single components at a time using
1217 @command{gcc}, you typically keep track of the units you modify. In order to
1218 build a consistent system, you compile not only these units, but also any
1219 units that depend on the units you have modified.
1220 For example, in the preceding case,
1221 if you edit @file{gmain.adb}, you only need to recompile that file. But if
1222 you edit @file{greetings.ads}, you must recompile both
1223 @file{greetings.adb} and @file{gmain.adb}, because both files contain
1224 units that depend on @file{greetings.ads}.
1226 @code{gnatbind} will warn you if you forget one of these compilation
1227 steps, so that it is impossible to generate an inconsistent program as a
1228 result of forgetting to do a compilation. Nevertheless it is tedious and
1229 error-prone to keep track of dependencies among units.
1230 One approach to handle the dependency-bookkeeping is to use a
1231 makefile. However, makefiles present maintenance problems of their own:
1232 if the dependencies change as you change the program, you must make
1233 sure that the makefile is kept up-to-date manually, which is also an
1234 error-prone process.
1236 The @command{gnatmake} utility takes care of these details automatically.
1237 Invoke it using either one of the following forms:
1240 $ gnatmake gmain.adb
1241 $ gnatmake ^gmain^GMAIN^
1245 The argument is the name of the file containing the main program;
1246 you may omit the extension. @command{gnatmake}
1247 examines the environment, automatically recompiles any files that need
1248 recompiling, and binds and links the resulting set of object files,
1249 generating the executable file, @file{^gmain^GMAIN.EXE^}.
1250 In a large program, it
1251 can be extremely helpful to use @command{gnatmake}, because working out by hand
1252 what needs to be recompiled can be difficult.
1254 Note that @command{gnatmake}
1255 takes into account all the Ada 95 rules that
1256 establish dependencies among units. These include dependencies that result
1257 from inlining subprogram bodies, and from
1258 generic instantiation. Unlike some other
1259 Ada make tools, @command{gnatmake} does not rely on the dependencies that were
1260 found by the compiler on a previous compilation, which may possibly
1261 be wrong when sources change. @command{gnatmake} determines the exact set of
1262 dependencies from scratch each time it is run.
1265 @node Editing with Emacs
1266 @section Editing with Emacs
1270 Emacs is an extensible self-documenting text editor that is available in a
1271 separate VMSINSTAL kit.
1273 Invoke Emacs by typing @kbd{Emacs} at the command prompt. To get started,
1274 click on the Emacs Help menu and run the Emacs Tutorial.
1275 In a character cell terminal, Emacs help is invoked with @kbd{Ctrl-h} (also
1276 written as @kbd{C-h}), and the tutorial by @kbd{C-h t}.
1278 Documentation on Emacs and other tools is available in Emacs under the
1279 pull-down menu button: @code{Help - Info}. After selecting @code{Info},
1280 use the middle mouse button to select a topic (e.g. Emacs).
1282 In a character cell terminal, do @kbd{C-h i} to invoke info, and then @kbd{m}
1283 (stands for menu) followed by the menu item desired, as in @kbd{m Emacs}, to
1284 get to the Emacs manual.
1285 Help on Emacs is also available by typing @kbd{HELP EMACS} at the DCL command
1288 The tutorial is highly recommended in order to learn the intricacies of Emacs,
1289 which is sufficiently extensible to provide for a complete programming
1290 environment and shell for the sophisticated user.
1294 @node Introduction to GPS
1295 @section Introduction to GPS
1296 @cindex GPS (GNAT Programming System)
1297 @cindex GNAT Programming System (GPS)
1299 Although the command line interface (@command{gnatmake}, etc.) alone
1300 is sufficient, a graphical Interactive Development
1301 Environment can make it easier for you to compose, navigate, and debug
1302 programs. This section describes the main features of GPS
1303 (``GNAT Programming System''), the GNAT graphical IDE.
1304 You will see how to use GPS to build and debug an executable, and
1305 you will also learn some of the basics of the GNAT ``project'' facility.
1307 GPS enables you to do much more than is presented here;
1308 e.g., you can produce a call graph, interface to a third-party
1309 Version Control System, and inspect the generated assembly language
1311 Indeed, GPS also supports languages other than Ada.
1312 Such additional information, and an explanation of all of the GPS menu
1313 items. may be found in the on-line help, which includes
1314 a user's guide and a tutorial (these are also accessible from the GNAT
1318 * Building a New Program with GPS::
1319 * Simple Debugging with GPS::
1322 @node Building a New Program with GPS
1323 @subsection Building a New Program with GPS
1325 GPS invokes the GNAT compilation tools using information
1326 contained in a @emph{project} (also known as a @emph{project file}):
1327 a collection of properties such
1328 as source directories, identities of main subprograms, tool switches, etc.,
1329 and their associated values.
1330 See @ref{GNAT Project Manager} for details.
1331 In order to run GPS, you will need to either create a new project
1332 or else open an existing one.
1334 This section will explain how you can use GPS to create a project,
1335 to associate Ada source files with a project, and to build and run
1339 @item @emph{Creating a project}
1341 Invoke GPS, either from the command line or the platform's IDE.
1342 After it starts, GPS will display a ``Welcome'' screen with three
1347 @code{Start with default project in directory}
1350 @code{Create new project with wizard}
1353 @code{Open existing project}
1357 Select @code{Create new project with wizard} and press @code{OK}.
1358 A new window will appear. In the text box labeled with
1359 @code{Enter the name of the project to create}, type @file{sample}
1360 as the project name.
1361 In the next box, browse to choose the directory in which you
1362 would like to create the project file.
1363 After selecting an appropriate directory, press @code{Forward}.
1365 A window will appear with the title
1366 @code{Version Control System Configuration}.
1367 Simply press @code{Forward}.
1369 A window will appear with the title
1370 @code{Please select the source directories for this project}.
1371 The directory that you specified for the project file will be selected
1372 by default as the one to use for sources; simply press @code{Forward}.
1374 A window will appear with the title
1375 @code{Please select the build directory for this project}.
1376 The directory that you specified for the project file will be selected
1377 by default for object files and executables;
1378 simply press @code{Forward}.
1380 A window will appear with the title
1381 @code{Please select the main units for this project}.
1382 You will supply this information later, after creating the source file.
1383 Simply press @code{Forward} for now.
1385 A window will appear with the title
1386 @code{Please select the switches to build the project}.
1387 Press @code{Apply}. This will create a project file named
1388 @file{sample.prj} in the directory that you had specified.
1390 @item @emph{Creating and saving the source file}
1392 After you create the new project, a GPS window will appear, which is
1393 partitioned into two main sections:
1397 A @emph{Workspace area}, initially greyed out, which you will use for
1398 creating and editing source files
1401 Directly below, a @emph{Messages area}, which initially displays a
1402 ``Welcome'' message.
1403 (If the Messages area is not visible, drag its border upward to expand it.)
1407 Select @code{File} on the menu bar, and then the @code{New} command.
1408 The Workspace area will become white, and you can now
1409 enter the source program explicitly.
1410 Type the following text
1412 @smallexample @c ada
1414 with Ada.Text_IO; use Ada.Text_IO;
1417 Put_Line("Hello from GPS!");
1423 Select @code{File}, then @code{Save As}, and enter the source file name
1425 The file will be saved in the same directory you specified as the
1426 location of the default project file.
1428 @item @emph{Updating the project file}
1430 You need to add the new source file to the project.
1432 the @code{Project} menu and then @code{Edit project properties}.
1433 Click the @code{Main files} tab on the left, and then the
1435 Choose @file{hello.adb} from the list, and press @code{Open}.
1436 The project settings window will reflect this action.
1439 @item @emph{Building and running the program}
1441 In the main GPS window, now choose the @code{Build} menu, then @code{Make},
1442 and select @file{hello.adb}.
1443 The Messages window will display the resulting invocations of @command{gcc},
1444 @command{gnatbind}, and @command{gnatlink}
1445 (reflecting the default switch settings from the
1446 project file that you created) and then a ``successful compilation/build''
1449 To run the program, choose the @code{Build} menu, then @code{Run}, and
1450 select @command{hello}.
1451 An @emph{Arguments Selection} window will appear.
1452 There are no command line arguments, so just click @code{OK}.
1454 The Messages window will now display the program's output (the string
1455 @code{Hello from GPS}), and at the bottom of the GPS window a status
1456 update is displayed (@code{Run: hello}).
1457 Close the GPS window (or select @code{File}, then @code{Exit}) to
1458 terminate this GPS session.
1461 @node Simple Debugging with GPS
1462 @subsection Simple Debugging with GPS
1464 This section illustrates basic debugging techniques (setting breakpoints,
1465 examining/modifying variables, single stepping).
1468 @item @emph{Opening a project}
1470 Start GPS and select @code{Open existing project}; browse to
1471 specify the project file @file{sample.prj} that you had created in the
1474 @item @emph{Creating a source file}
1476 Select @code{File}, then @code{New}, and type in the following program:
1478 @smallexample @c ada
1480 with Ada.Text_IO; use Ada.Text_IO;
1481 procedure Example is
1482 Line : String (1..80);
1485 Put_Line("Type a line of text at each prompt; an empty line to exit");
1489 Put_Line (Line (1..N) );
1497 Select @code{File}, then @code{Save as}, and enter the file name
1500 @item @emph{Updating the project file}
1502 Add @code{Example} as a new main unit for the project:
1505 Select @code{Project}, then @code{Edit Project Properties}.
1508 Select the @code{Main files} tab, click @code{Add}, then
1509 select the file @file{example.adb} from the list, and
1511 You will see the file name appear in the list of main units
1517 @item @emph{Building/running the executable}
1519 To build the executable
1520 select @code{Build}, then @code{Make}, and then choose @file{example.adb}.
1522 Run the program to see its effect (in the Messages area).
1523 Each line that you enter is displayed; an empty line will
1524 cause the loop to exit and the program to terminate.
1526 @item @emph{Debugging the program}
1528 Note that the @option{-g} switches to @command{gcc} and @command{gnatlink},
1529 which are required for debugging, are on by default when you create
1531 Thus unless you intentionally remove these settings, you will be able
1532 to debug any program that you develop using GPS.
1535 @item @emph{Initializing}
1537 Select @code{Debug}, then @code{Initialize}, then @file{example}
1539 @item @emph{Setting a breakpoint}
1541 After performing the initialization step, you will observe a small
1542 icon to the right of each line number.
1543 This serves as a toggle for breakpoints; clicking the icon will
1544 set a breakpoint at the corresponding line (the icon will change to
1545 a red circle with an ``x''), and clicking it again
1546 will remove the breakpoint / reset the icon.
1548 For purposes of this example, set a breakpoint at line 10 (the
1549 statement @code{Put_Line@ (Line@ (1..N));}
1551 @item @emph{Starting program execution}
1553 Select @code{Debug}, then @code{Run}. When the
1554 @code{Program Arguments} window appears, click @code{OK}.
1555 A console window will appear; enter some line of text,
1556 e.g. @code{abcde}, at the prompt.
1557 The program will pause execution when it gets to the
1558 breakpoint, and the corresponding line is highlighted.
1560 @item @emph{Examining a variable}
1562 Move the mouse over one of the occurrences of the variable @code{N}.
1563 You will see the value (5) displayed, in ``tool tip'' fashion.
1564 Right click on @code{N}, select @code{Debug}, then select @code{Display N}.
1565 You will see information about @code{N} appear in the @code{Debugger Data}
1566 pane, showing the value as 5.
1568 @item @emph{Assigning a new value to a variable}
1570 Right click on the @code{N} in the @code{Debugger Data} pane, and
1571 select @code{Set value of N}.
1572 When the input window appears, enter the value @code{4} and click
1574 This value does not automatically appear in the @code{Debugger Data}
1575 pane; to see it, right click again on the @code{N} in the
1576 @code{Debugger Data} pane and select @code{Update value}.
1577 The new value, 4, will appear in red.
1579 @item @emph{Single stepping}
1581 Select @code{Debug}, then @code{Next}.
1582 This will cause the next statement to be executed, in this case the
1583 call of @code{Put_Line} with the string slice.
1584 Notice in the console window that the displayed string is simply
1585 @code{abcd} and not @code{abcde} which you had entered.
1586 This is because the upper bound of the slice is now 4 rather than 5.
1588 @item @emph{Removing a breakpoint}
1590 Toggle the breakpoint icon at line 10.
1592 @item @emph{Resuming execution from a breakpoint}
1594 Select @code{Debug}, then @code{Continue}.
1595 The program will reach the next iteration of the loop, and
1596 wait for input after displaying the prompt.
1597 This time, just hit the @kbd{Enter} key.
1598 The value of @code{N} will be 0, and the program will terminate.
1599 The console window will disappear.
1603 @node Introduction to Glide and GVD
1604 @section Introduction to Glide and GVD
1608 This section describes the main features of Glide,
1609 a GNAT graphical IDE, and also shows how to use the basic commands in GVD,
1610 the GNU Visual Debugger.
1611 These tools may be present in addition to, or in place of, GPS on some
1613 Additional information on Glide and GVD may be found
1614 in the on-line help for these tools.
1617 * Building a New Program with Glide::
1618 * Simple Debugging with GVD::
1619 * Other Glide Features::
1622 @node Building a New Program with Glide
1623 @subsection Building a New Program with Glide
1625 The simplest way to invoke Glide is to enter @command{glide}
1626 at the command prompt. It will generally be useful to issue this
1627 as a background command, thus allowing you to continue using
1628 your command window for other purposes while Glide is running:
1635 Glide will start up with an initial screen displaying the top-level menu items
1636 as well as some other information. The menu selections are as follows
1638 @item @code{Buffers}
1649 For this introductory example, you will need to create a new Ada source file.
1650 First, select the @code{Files} menu. This will pop open a menu with around
1651 a dozen or so items. To create a file, select the @code{Open file...} choice.
1652 Depending on the platform, you may see a pop-up window where you can browse
1653 to an appropriate directory and then enter the file name, or else simply
1654 see a line at the bottom of the Glide window where you can likewise enter
1655 the file name. Note that in Glide, when you attempt to open a non-existent
1656 file, the effect is to create a file with that name. For this example enter
1657 @file{hello.adb} as the name of the file.
1659 A new buffer will now appear, occupying the entire Glide window,
1660 with the file name at the top. The menu selections are slightly different
1661 from the ones you saw on the opening screen; there is an @code{Entities} item,
1662 and in place of @code{Glide} there is now an @code{Ada} item. Glide uses
1663 the file extension to identify the source language, so @file{adb} indicates
1666 You will enter some of the source program lines explicitly,
1667 and use the syntax-oriented template mechanism to enter other lines.
1668 First, type the following text:
1670 with Ada.Text_IO; use Ada.Text_IO;
1676 Observe that Glide uses different colors to distinguish reserved words from
1677 identifiers. Also, after the @code{procedure Hello is} line, the cursor is
1678 automatically indented in anticipation of declarations. When you enter
1679 @code{begin}, Glide recognizes that there are no declarations and thus places
1680 @code{begin} flush left. But after the @code{begin} line the cursor is again
1681 indented, where the statement(s) will be placed.
1683 The main part of the program will be a @code{for} loop. Instead of entering
1684 the text explicitly, however, use a statement template. Select the @code{Ada}
1685 item on the top menu bar, move the mouse to the @code{Statements} item,
1686 and you will see a large selection of alternatives. Choose @code{for loop}.
1687 You will be prompted (at the bottom of the buffer) for a loop name;
1688 simply press the @key{Enter} key since a loop name is not needed.
1689 You should see the beginning of a @code{for} loop appear in the source
1690 program window. You will now be prompted for the name of the loop variable;
1691 enter a line with the identifier @code{ind} (lower case). Note that,
1692 by default, Glide capitalizes the name (you can override such behavior
1693 if you wish, although this is outside the scope of this introduction).
1694 Next, Glide prompts you for the loop range; enter a line containing
1695 @code{1..5} and you will see this also appear in the source program,
1696 together with the remaining elements of the @code{for} loop syntax.
1698 Next enter the statement (with an intentional error, a missing semicolon)
1699 that will form the body of the loop:
1701 Put_Line("Hello, World" & Integer'Image(I))
1705 Finally, type @code{end Hello;} as the last line in the program.
1706 Now save the file: choose the @code{File} menu item, and then the
1707 @code{Save buffer} selection. You will see a message at the bottom
1708 of the buffer confirming that the file has been saved.
1710 You are now ready to attempt to build the program. Select the @code{Ada}
1711 item from the top menu bar. Although we could choose simply to compile
1712 the file, we will instead attempt to do a build (which invokes
1713 @command{gnatmake}) since, if the compile is successful, we want to build
1714 an executable. Thus select @code{Ada build}. This will fail because of the
1715 compilation error, and you will notice that the Glide window has been split:
1716 the top window contains the source file, and the bottom window contains the
1717 output from the GNAT tools. Glide allows you to navigate from a compilation
1718 error to the source file position corresponding to the error: click the
1719 middle mouse button (or simultaneously press the left and right buttons,
1720 on a two-button mouse) on the diagnostic line in the tool window. The
1721 focus will shift to the source window, and the cursor will be positioned
1722 on the character at which the error was detected.
1724 Correct the error: type in a semicolon to terminate the statement.
1725 Although you can again save the file explicitly, you can also simply invoke
1726 @code{Ada} @result{} @code{Build} and you will be prompted to save the file.
1727 This time the build will succeed; the tool output window shows you the
1728 options that are supplied by default. The GNAT tools' output (e.g.
1729 object and ALI files, executable) will go in the directory from which
1732 To execute the program, choose @code{Ada} and then @code{Run}.
1733 You should see the program's output displayed in the bottom window:
1743 @node Simple Debugging with GVD
1744 @subsection Simple Debugging with GVD
1747 This section describes how to set breakpoints, examine/modify variables,
1748 and step through execution.
1750 In order to enable debugging, you need to pass the @option{-g} switch
1751 to both the compiler and to @command{gnatlink}. If you are using
1752 the command line, passing @option{-g} to @command{gnatmake} will have
1753 this effect. You can then launch GVD, e.g. on the @code{hello} program,
1754 by issuing the command:
1761 If you are using Glide, then @option{-g} is passed to the relevant tools
1762 by default when you do a build. Start the debugger by selecting the
1763 @code{Ada} menu item, and then @code{Debug}.
1765 GVD comes up in a multi-part window. One pane shows the names of files
1766 comprising your executable; another pane shows the source code of the current
1767 unit (initially your main subprogram), another pane shows the debugger output
1768 and user interactions, and the fourth pane (the data canvas at the top
1769 of the window) displays data objects that you have selected.
1771 To the left of the source file pane, you will notice green dots adjacent
1772 to some lines. These are lines for which object code exists and where
1773 breakpoints can thus be set. You set/reset a breakpoint by clicking
1774 the green dot. When a breakpoint is set, the dot is replaced by an @code{X}
1775 in a red circle. Clicking the circle toggles the breakpoint off,
1776 and the red circle is replaced by the green dot.
1778 For this example, set a breakpoint at the statement where @code{Put_Line}
1781 Start program execution by selecting the @code{Run} button on the top menu bar.
1782 (The @code{Start} button will also start your program, but it will
1783 cause program execution to break at the entry to your main subprogram.)
1784 Evidence of reaching the breakpoint will appear: the source file line will be
1785 highlighted, and the debugger interactions pane will display
1788 You can examine the values of variables in several ways. Move the mouse
1789 over an occurrence of @code{Ind} in the @code{for} loop, and you will see
1790 the value (now @code{1}) displayed. Alternatively, right-click on @code{Ind}
1791 and select @code{Display Ind}; a box showing the variable's name and value
1792 will appear in the data canvas.
1794 Although a loop index is a constant with respect to Ada semantics,
1795 you can change its value in the debugger. Right-click in the box
1796 for @code{Ind}, and select the @code{Set Value of Ind} item.
1797 Enter @code{2} as the new value, and press @command{OK}.
1798 The box for @code{Ind} shows the update.
1800 Press the @code{Step} button on the top menu bar; this will step through
1801 one line of program text (the invocation of @code{Put_Line}), and you can
1802 observe the effect of having modified @code{Ind} since the value displayed
1805 Remove the breakpoint, and resume execution by selecting the @code{Cont}
1806 button. You will see the remaining output lines displayed in the debugger
1807 interaction window, along with a message confirming normal program
1810 @node Other Glide Features
1811 @subsection Other Glide Features
1814 You may have observed that some of the menu selections contain abbreviations;
1815 e.g., @code{(C-x C-f)} for @code{Open file...} in the @code{Files} menu.
1816 These are @emph{shortcut keys} that you can use instead of selecting
1817 menu items. The @key{C} stands for @key{Ctrl}; thus @code{(C-x C-f)} means
1818 @key{Ctrl-x} followed by @key{Ctrl-f}, and this sequence can be used instead
1819 of selecting @code{Files} and then @code{Open file...}.
1821 To abort a Glide command, type @key{Ctrl-g}.
1823 If you want Glide to start with an existing source file, you can either
1824 launch Glide as above and then open the file via @code{Files} @result{}
1825 @code{Open file...}, or else simply pass the name of the source file
1826 on the command line:
1833 While you are using Glide, a number of @emph{buffers} exist.
1834 You create some explicitly; e.g., when you open/create a file.
1835 Others arise as an effect of the commands that you issue; e.g., the buffer
1836 containing the output of the tools invoked during a build. If a buffer
1837 is hidden, you can bring it into a visible window by first opening
1838 the @code{Buffers} menu and then selecting the desired entry.
1840 If a buffer occupies only part of the Glide screen and you want to expand it
1841 to fill the entire screen, then click in the buffer and then select
1842 @code{Files} @result{} @code{One Window}.
1844 If a window is occupied by one buffer and you want to split the window
1845 to bring up a second buffer, perform the following steps:
1847 @item Select @code{Files} @result{} @code{Split Window};
1848 this will produce two windows each of which holds the original buffer
1849 (these are not copies, but rather different views of the same buffer contents)
1851 @item With the focus in one of the windows,
1852 select the desired buffer from the @code{Buffers} menu
1856 To exit from Glide, choose @code{Files} @result{} @code{Exit}.
1859 @node The GNAT Compilation Model
1860 @chapter The GNAT Compilation Model
1861 @cindex GNAT compilation model
1862 @cindex Compilation model
1865 * Source Representation::
1866 * Foreign Language Representation::
1867 * File Naming Rules::
1868 * Using Other File Names::
1869 * Alternative File Naming Schemes::
1870 * Generating Object Files::
1871 * Source Dependencies::
1872 * The Ada Library Information Files::
1873 * Binding an Ada Program::
1874 * Mixed Language Programming::
1875 * Building Mixed Ada & C++ Programs::
1876 * Comparison between GNAT and C/C++ Compilation Models::
1877 * Comparison between GNAT and Conventional Ada Library Models::
1879 * Placement of temporary files::
1884 This chapter describes the compilation model used by GNAT. Although
1885 similar to that used by other languages, such as C and C++, this model
1886 is substantially different from the traditional Ada compilation models,
1887 which are based on a library. The model is initially described without
1888 reference to the library-based model. If you have not previously used an
1889 Ada compiler, you need only read the first part of this chapter. The
1890 last section describes and discusses the differences between the GNAT
1891 model and the traditional Ada compiler models. If you have used other
1892 Ada compilers, this section will help you to understand those
1893 differences, and the advantages of the GNAT model.
1895 @node Source Representation
1896 @section Source Representation
1900 Ada source programs are represented in standard text files, using
1901 Latin-1 coding. Latin-1 is an 8-bit code that includes the familiar
1902 7-bit ASCII set, plus additional characters used for
1903 representing foreign languages (@pxref{Foreign Language Representation}
1904 for support of non-USA character sets). The format effector characters
1905 are represented using their standard ASCII encodings, as follows:
1910 Vertical tab, @code{16#0B#}
1914 Horizontal tab, @code{16#09#}
1918 Carriage return, @code{16#0D#}
1922 Line feed, @code{16#0A#}
1926 Form feed, @code{16#0C#}
1930 Source files are in standard text file format. In addition, GNAT will
1931 recognize a wide variety of stream formats, in which the end of
1932 physical lines is marked by any of the following sequences:
1933 @code{LF}, @code{CR}, @code{CR-LF}, or @code{LF-CR}. This is useful
1934 in accommodating files that are imported from other operating systems.
1936 @cindex End of source file
1937 @cindex Source file, end
1939 The end of a source file is normally represented by the physical end of
1940 file. However, the control character @code{16#1A#} (@code{SUB}) is also
1941 recognized as signalling the end of the source file. Again, this is
1942 provided for compatibility with other operating systems where this
1943 code is used to represent the end of file.
1945 Each file contains a single Ada compilation unit, including any pragmas
1946 associated with the unit. For example, this means you must place a
1947 package declaration (a package @dfn{spec}) and the corresponding body in
1948 separate files. An Ada @dfn{compilation} (which is a sequence of
1949 compilation units) is represented using a sequence of files. Similarly,
1950 you will place each subunit or child unit in a separate file.
1952 @node Foreign Language Representation
1953 @section Foreign Language Representation
1956 GNAT supports the standard character sets defined in Ada 95 as well as
1957 several other non-standard character sets for use in localized versions
1958 of the compiler (@pxref{Character Set Control}).
1961 * Other 8-Bit Codes::
1962 * Wide Character Encodings::
1970 The basic character set is Latin-1. This character set is defined by ISO
1971 standard 8859, part 1. The lower half (character codes @code{16#00#}
1972 ... @code{16#7F#)} is identical to standard ASCII coding, but the upper half
1973 is used to represent additional characters. These include extended letters
1974 used by European languages, such as French accents, the vowels with umlauts
1975 used in German, and the extra letter A-ring used in Swedish.
1977 @findex Ada.Characters.Latin_1
1978 For a complete list of Latin-1 codes and their encodings, see the source
1979 file of library unit @code{Ada.Characters.Latin_1} in file
1980 @file{a-chlat1.ads}.
1981 You may use any of these extended characters freely in character or
1982 string literals. In addition, the extended characters that represent
1983 letters can be used in identifiers.
1985 @node Other 8-Bit Codes
1986 @subsection Other 8-Bit Codes
1989 GNAT also supports several other 8-bit coding schemes:
1992 @item ISO 8859-2 (Latin-2)
1995 Latin-2 letters allowed in identifiers, with uppercase and lowercase
1998 @item ISO 8859-3 (Latin-3)
2001 Latin-3 letters allowed in identifiers, with uppercase and lowercase
2004 @item ISO 8859-4 (Latin-4)
2007 Latin-4 letters allowed in identifiers, with uppercase and lowercase
2010 @item ISO 8859-5 (Cyrillic)
2013 ISO 8859-5 letters (Cyrillic) allowed in identifiers, with uppercase and
2014 lowercase equivalence.
2016 @item ISO 8859-15 (Latin-9)
2019 ISO 8859-15 (Latin-9) letters allowed in identifiers, with uppercase and
2020 lowercase equivalence
2022 @item IBM PC (code page 437)
2023 @cindex code page 437
2024 This code page is the normal default for PCs in the U.S. It corresponds
2025 to the original IBM PC character set. This set has some, but not all, of
2026 the extended Latin-1 letters, but these letters do not have the same
2027 encoding as Latin-1. In this mode, these letters are allowed in
2028 identifiers with uppercase and lowercase equivalence.
2030 @item IBM PC (code page 850)
2031 @cindex code page 850
2032 This code page is a modification of 437 extended to include all the
2033 Latin-1 letters, but still not with the usual Latin-1 encoding. In this
2034 mode, all these letters are allowed in identifiers with uppercase and
2035 lowercase equivalence.
2037 @item Full Upper 8-bit
2038 Any character in the range 80-FF allowed in identifiers, and all are
2039 considered distinct. In other words, there are no uppercase and lowercase
2040 equivalences in this range. This is useful in conjunction with
2041 certain encoding schemes used for some foreign character sets (e.g.
2042 the typical method of representing Chinese characters on the PC).
2045 No upper-half characters in the range 80-FF are allowed in identifiers.
2046 This gives Ada 83 compatibility for identifier names.
2050 For precise data on the encodings permitted, and the uppercase and lowercase
2051 equivalences that are recognized, see the file @file{csets.adb} in
2052 the GNAT compiler sources. You will need to obtain a full source release
2053 of GNAT to obtain this file.
2055 @node Wide Character Encodings
2056 @subsection Wide Character Encodings
2059 GNAT allows wide character codes to appear in character and string
2060 literals, and also optionally in identifiers, by means of the following
2061 possible encoding schemes:
2066 In this encoding, a wide character is represented by the following five
2074 Where @code{a}, @code{b}, @code{c}, @code{d} are the four hexadecimal
2075 characters (using uppercase letters) of the wide character code. For
2076 example, ESC A345 is used to represent the wide character with code
2078 This scheme is compatible with use of the full Wide_Character set.
2080 @item Upper-Half Coding
2081 @cindex Upper-Half Coding
2082 The wide character with encoding @code{16#abcd#} where the upper bit is on
2083 (in other words, ``a'' is in the range 8-F) is represented as two bytes,
2084 @code{16#ab#} and @code{16#cd#}. The second byte cannot be a format control
2085 character, but is not required to be in the upper half. This method can
2086 be also used for shift-JIS or EUC, where the internal coding matches the
2089 @item Shift JIS Coding
2090 @cindex Shift JIS Coding
2091 A wide character is represented by a two-character sequence,
2093 @code{16#cd#}, with the restrictions described for upper-half encoding as
2094 described above. The internal character code is the corresponding JIS
2095 character according to the standard algorithm for Shift-JIS
2096 conversion. Only characters defined in the JIS code set table can be
2097 used with this encoding method.
2101 A wide character is represented by a two-character sequence
2103 @code{16#cd#}, with both characters being in the upper half. The internal
2104 character code is the corresponding JIS character according to the EUC
2105 encoding algorithm. Only characters defined in the JIS code set table
2106 can be used with this encoding method.
2109 A wide character is represented using
2110 UCS Transformation Format 8 (UTF-8) as defined in Annex R of ISO
2111 10646-1/Am.2. Depending on the character value, the representation
2112 is a one, two, or three byte sequence:
2117 16#0000#-16#007f#: 2#0xxxxxxx#
2118 16#0080#-16#07ff#: 2#110xxxxx# 2#10xxxxxx#
2119 16#0800#-16#ffff#: 2#1110xxxx# 2#10xxxxxx# 2#10xxxxxx#
2124 where the xxx bits correspond to the left-padded bits of the
2125 16-bit character value. Note that all lower half ASCII characters
2126 are represented as ASCII bytes and all upper half characters and
2127 other wide characters are represented as sequences of upper-half
2128 (The full UTF-8 scheme allows for encoding 31-bit characters as
2129 6-byte sequences, but in this implementation, all UTF-8 sequences
2130 of four or more bytes length will be treated as illegal).
2131 @item Brackets Coding
2132 In this encoding, a wide character is represented by the following eight
2140 Where @code{a}, @code{b}, @code{c}, @code{d} are the four hexadecimal
2141 characters (using uppercase letters) of the wide character code. For
2142 example, [``A345''] is used to represent the wide character with code
2143 @code{16#A345#}. It is also possible (though not required) to use the
2144 Brackets coding for upper half characters. For example, the code
2145 @code{16#A3#} can be represented as @code{[``A3'']}.
2147 This scheme is compatible with use of the full Wide_Character set,
2148 and is also the method used for wide character encoding in the standard
2149 ACVC (Ada Compiler Validation Capability) test suite distributions.
2154 Note: Some of these coding schemes do not permit the full use of the
2155 Ada 95 character set. For example, neither Shift JIS, nor EUC allow the
2156 use of the upper half of the Latin-1 set.
2158 @node File Naming Rules
2159 @section File Naming Rules
2162 The default file name is determined by the name of the unit that the
2163 file contains. The name is formed by taking the full expanded name of
2164 the unit and replacing the separating dots with hyphens and using
2165 ^lowercase^uppercase^ for all letters.
2167 An exception arises if the file name generated by the above rules starts
2168 with one of the characters
2175 and the second character is a
2176 minus. In this case, the character ^tilde^dollar sign^ is used in place
2177 of the minus. The reason for this special rule is to avoid clashes with
2178 the standard names for child units of the packages System, Ada,
2179 Interfaces, and GNAT, which use the prefixes
2188 The file extension is @file{.ads} for a spec and
2189 @file{.adb} for a body. The following list shows some
2190 examples of these rules.
2197 @item arith_functions.ads
2198 Arith_Functions (package spec)
2199 @item arith_functions.adb
2200 Arith_Functions (package body)
2202 Func.Spec (child package spec)
2204 Func.Spec (child package body)
2206 Sub (subunit of Main)
2207 @item ^a~bad.adb^A$BAD.ADB^
2208 A.Bad (child package body)
2212 Following these rules can result in excessively long
2213 file names if corresponding
2214 unit names are long (for example, if child units or subunits are
2215 heavily nested). An option is available to shorten such long file names
2216 (called file name ``krunching''). This may be particularly useful when
2217 programs being developed with GNAT are to be used on operating systems
2218 with limited file name lengths. @xref{Using gnatkr}.
2220 Of course, no file shortening algorithm can guarantee uniqueness over
2221 all possible unit names; if file name krunching is used, it is your
2222 responsibility to ensure no name clashes occur. Alternatively you
2223 can specify the exact file names that you want used, as described
2224 in the next section. Finally, if your Ada programs are migrating from a
2225 compiler with a different naming convention, you can use the gnatchop
2226 utility to produce source files that follow the GNAT naming conventions.
2227 (For details @pxref{Renaming Files Using gnatchop}.)
2229 Note: in the case of @code{Windows NT/XP} or @code{OpenVMS} operating
2230 systems, case is not significant. So for example on @code{Windows XP}
2231 if the canonical name is @code{main-sub.adb}, you can use the file name
2232 @code{Main-Sub.adb} instead. However, case is significant for other
2233 operating systems, so for example, if you want to use other than
2234 canonically cased file names on a Unix system, you need to follow
2235 the procedures described in the next section.
2237 @node Using Other File Names
2238 @section Using Other File Names
2242 In the previous section, we have described the default rules used by
2243 GNAT to determine the file name in which a given unit resides. It is
2244 often convenient to follow these default rules, and if you follow them,
2245 the compiler knows without being explicitly told where to find all
2248 However, in some cases, particularly when a program is imported from
2249 another Ada compiler environment, it may be more convenient for the
2250 programmer to specify which file names contain which units. GNAT allows
2251 arbitrary file names to be used by means of the Source_File_Name pragma.
2252 The form of this pragma is as shown in the following examples:
2253 @cindex Source_File_Name pragma
2255 @smallexample @c ada
2257 pragma Source_File_Name (My_Utilities.Stacks,
2258 Spec_File_Name => "myutilst_a.ada");
2259 pragma Source_File_name (My_Utilities.Stacks,
2260 Body_File_Name => "myutilst.ada");
2265 As shown in this example, the first argument for the pragma is the unit
2266 name (in this example a child unit). The second argument has the form
2267 of a named association. The identifier
2268 indicates whether the file name is for a spec or a body;
2269 the file name itself is given by a string literal.
2271 The source file name pragma is a configuration pragma, which means that
2272 normally it will be placed in the @file{gnat.adc}
2273 file used to hold configuration
2274 pragmas that apply to a complete compilation environment.
2275 For more details on how the @file{gnat.adc} file is created and used
2276 see @ref{Handling of Configuration Pragmas}.
2277 @cindex @file{gnat.adc}
2280 GNAT allows completely arbitrary file names to be specified using the
2281 source file name pragma. However, if the file name specified has an
2282 extension other than @file{.ads} or @file{.adb} it is necessary to use
2283 a special syntax when compiling the file. The name in this case must be
2284 preceded by the special sequence @code{-x} followed by a space and the name
2285 of the language, here @code{ada}, as in:
2288 $ gcc -c -x ada peculiar_file_name.sim
2293 @command{gnatmake} handles non-standard file names in the usual manner (the
2294 non-standard file name for the main program is simply used as the
2295 argument to gnatmake). Note that if the extension is also non-standard,
2296 then it must be included in the gnatmake command, it may not be omitted.
2298 @node Alternative File Naming Schemes
2299 @section Alternative File Naming Schemes
2300 @cindex File naming schemes, alternative
2303 In the previous section, we described the use of the @code{Source_File_Name}
2304 pragma to allow arbitrary names to be assigned to individual source files.
2305 However, this approach requires one pragma for each file, and especially in
2306 large systems can result in very long @file{gnat.adc} files, and also create
2307 a maintenance problem.
2309 GNAT also provides a facility for specifying systematic file naming schemes
2310 other than the standard default naming scheme previously described. An
2311 alternative scheme for naming is specified by the use of
2312 @code{Source_File_Name} pragmas having the following format:
2313 @cindex Source_File_Name pragma
2315 @smallexample @c ada
2316 pragma Source_File_Name (
2317 Spec_File_Name => FILE_NAME_PATTERN
2318 [,Casing => CASING_SPEC]
2319 [,Dot_Replacement => STRING_LITERAL]);
2321 pragma Source_File_Name (
2322 Body_File_Name => FILE_NAME_PATTERN
2323 [,Casing => CASING_SPEC]
2324 [,Dot_Replacement => STRING_LITERAL]);
2326 pragma Source_File_Name (
2327 Subunit_File_Name => FILE_NAME_PATTERN
2328 [,Casing => CASING_SPEC]
2329 [,Dot_Replacement => STRING_LITERAL]);
2331 FILE_NAME_PATTERN ::= STRING_LITERAL
2332 CASING_SPEC ::= Lowercase | Uppercase | Mixedcase
2336 The @code{FILE_NAME_PATTERN} string shows how the file name is constructed.
2337 It contains a single asterisk character, and the unit name is substituted
2338 systematically for this asterisk. The optional parameter
2339 @code{Casing} indicates
2340 whether the unit name is to be all upper-case letters, all lower-case letters,
2341 or mixed-case. If no
2342 @code{Casing} parameter is used, then the default is all
2343 ^lower-case^upper-case^.
2345 The optional @code{Dot_Replacement} string is used to replace any periods
2346 that occur in subunit or child unit names. If no @code{Dot_Replacement}
2347 argument is used then separating dots appear unchanged in the resulting
2349 Although the above syntax indicates that the
2350 @code{Casing} argument must appear
2351 before the @code{Dot_Replacement} argument, but it
2352 is also permissible to write these arguments in the opposite order.
2354 As indicated, it is possible to specify different naming schemes for
2355 bodies, specs, and subunits. Quite often the rule for subunits is the
2356 same as the rule for bodies, in which case, there is no need to give
2357 a separate @code{Subunit_File_Name} rule, and in this case the
2358 @code{Body_File_name} rule is used for subunits as well.
2360 The separate rule for subunits can also be used to implement the rather
2361 unusual case of a compilation environment (e.g. a single directory) which
2362 contains a subunit and a child unit with the same unit name. Although
2363 both units cannot appear in the same partition, the Ada Reference Manual
2364 allows (but does not require) the possibility of the two units coexisting
2365 in the same environment.
2367 The file name translation works in the following steps:
2372 If there is a specific @code{Source_File_Name} pragma for the given unit,
2373 then this is always used, and any general pattern rules are ignored.
2376 If there is a pattern type @code{Source_File_Name} pragma that applies to
2377 the unit, then the resulting file name will be used if the file exists. If
2378 more than one pattern matches, the latest one will be tried first, and the
2379 first attempt resulting in a reference to a file that exists will be used.
2382 If no pattern type @code{Source_File_Name} pragma that applies to the unit
2383 for which the corresponding file exists, then the standard GNAT default
2384 naming rules are used.
2389 As an example of the use of this mechanism, consider a commonly used scheme
2390 in which file names are all lower case, with separating periods copied
2391 unchanged to the resulting file name, and specs end with @file{.1.ada}, and
2392 bodies end with @file{.2.ada}. GNAT will follow this scheme if the following
2395 @smallexample @c ada
2396 pragma Source_File_Name
2397 (Spec_File_Name => "*.1.ada");
2398 pragma Source_File_Name
2399 (Body_File_Name => "*.2.ada");
2403 The default GNAT scheme is actually implemented by providing the following
2404 default pragmas internally:
2406 @smallexample @c ada
2407 pragma Source_File_Name
2408 (Spec_File_Name => "*.ads", Dot_Replacement => "-");
2409 pragma Source_File_Name
2410 (Body_File_Name => "*.adb", Dot_Replacement => "-");
2414 Our final example implements a scheme typically used with one of the
2415 Ada 83 compilers, where the separator character for subunits was ``__''
2416 (two underscores), specs were identified by adding @file{_.ADA}, bodies
2417 by adding @file{.ADA}, and subunits by
2418 adding @file{.SEP}. All file names were
2419 upper case. Child units were not present of course since this was an
2420 Ada 83 compiler, but it seems reasonable to extend this scheme to use
2421 the same double underscore separator for child units.
2423 @smallexample @c ada
2424 pragma Source_File_Name
2425 (Spec_File_Name => "*_.ADA",
2426 Dot_Replacement => "__",
2427 Casing = Uppercase);
2428 pragma Source_File_Name
2429 (Body_File_Name => "*.ADA",
2430 Dot_Replacement => "__",
2431 Casing = Uppercase);
2432 pragma Source_File_Name
2433 (Subunit_File_Name => "*.SEP",
2434 Dot_Replacement => "__",
2435 Casing = Uppercase);
2438 @node Generating Object Files
2439 @section Generating Object Files
2442 An Ada program consists of a set of source files, and the first step in
2443 compiling the program is to generate the corresponding object files.
2444 These are generated by compiling a subset of these source files.
2445 The files you need to compile are the following:
2449 If a package spec has no body, compile the package spec to produce the
2450 object file for the package.
2453 If a package has both a spec and a body, compile the body to produce the
2454 object file for the package. The source file for the package spec need
2455 not be compiled in this case because there is only one object file, which
2456 contains the code for both the spec and body of the package.
2459 For a subprogram, compile the subprogram body to produce the object file
2460 for the subprogram. The spec, if one is present, is as usual in a
2461 separate file, and need not be compiled.
2465 In the case of subunits, only compile the parent unit. A single object
2466 file is generated for the entire subunit tree, which includes all the
2470 Compile child units independently of their parent units
2471 (though, of course, the spec of all the ancestor unit must be present in order
2472 to compile a child unit).
2476 Compile generic units in the same manner as any other units. The object
2477 files in this case are small dummy files that contain at most the
2478 flag used for elaboration checking. This is because GNAT always handles generic
2479 instantiation by means of macro expansion. However, it is still necessary to
2480 compile generic units, for dependency checking and elaboration purposes.
2484 The preceding rules describe the set of files that must be compiled to
2485 generate the object files for a program. Each object file has the same
2486 name as the corresponding source file, except that the extension is
2489 You may wish to compile other files for the purpose of checking their
2490 syntactic and semantic correctness. For example, in the case where a
2491 package has a separate spec and body, you would not normally compile the
2492 spec. However, it is convenient in practice to compile the spec to make
2493 sure it is error-free before compiling clients of this spec, because such
2494 compilations will fail if there is an error in the spec.
2496 GNAT provides an option for compiling such files purely for the
2497 purposes of checking correctness; such compilations are not required as
2498 part of the process of building a program. To compile a file in this
2499 checking mode, use the @option{-gnatc} switch.
2501 @node Source Dependencies
2502 @section Source Dependencies
2505 A given object file clearly depends on the source file which is compiled
2506 to produce it. Here we are using @dfn{depends} in the sense of a typical
2507 @code{make} utility; in other words, an object file depends on a source
2508 file if changes to the source file require the object file to be
2510 In addition to this basic dependency, a given object may depend on
2511 additional source files as follows:
2515 If a file being compiled @code{with}'s a unit @var{X}, the object file
2516 depends on the file containing the spec of unit @var{X}. This includes
2517 files that are @code{with}'ed implicitly either because they are parents
2518 of @code{with}'ed child units or they are run-time units required by the
2519 language constructs used in a particular unit.
2522 If a file being compiled instantiates a library level generic unit, the
2523 object file depends on both the spec and body files for this generic
2527 If a file being compiled instantiates a generic unit defined within a
2528 package, the object file depends on the body file for the package as
2529 well as the spec file.
2533 @cindex @option{-gnatn} switch
2534 If a file being compiled contains a call to a subprogram for which
2535 pragma @code{Inline} applies and inlining is activated with the
2536 @option{-gnatn} switch, the object file depends on the file containing the
2537 body of this subprogram as well as on the file containing the spec. Note
2538 that for inlining to actually occur as a result of the use of this switch,
2539 it is necessary to compile in optimizing mode.
2541 @cindex @option{-gnatN} switch
2542 The use of @option{-gnatN} activates a more extensive inlining optimization
2543 that is performed by the front end of the compiler. This inlining does
2544 not require that the code generation be optimized. Like @option{-gnatn},
2545 the use of this switch generates additional dependencies.
2547 @option{-gnatN} automatically implies @option{-gnatn} so it is not necessary
2548 to specify both options.
2551 If an object file O depends on the proper body of a subunit through inlining
2552 or instantiation, it depends on the parent unit of the subunit. This means that
2553 any modification of the parent unit or one of its subunits affects the
2557 The object file for a parent unit depends on all its subunit body files.
2560 The previous two rules meant that for purposes of computing dependencies and
2561 recompilation, a body and all its subunits are treated as an indivisible whole.
2564 These rules are applied transitively: if unit @code{A} @code{with}'s
2565 unit @code{B}, whose elaboration calls an inlined procedure in package
2566 @code{C}, the object file for unit @code{A} will depend on the body of
2567 @code{C}, in file @file{c.adb}.
2569 The set of dependent files described by these rules includes all the
2570 files on which the unit is semantically dependent, as described in the
2571 Ada 95 Language Reference Manual. However, it is a superset of what the
2572 ARM describes, because it includes generic, inline, and subunit dependencies.
2574 An object file must be recreated by recompiling the corresponding source
2575 file if any of the source files on which it depends are modified. For
2576 example, if the @code{make} utility is used to control compilation,
2577 the rule for an Ada object file must mention all the source files on
2578 which the object file depends, according to the above definition.
2579 The determination of the necessary
2580 recompilations is done automatically when one uses @command{gnatmake}.
2583 @node The Ada Library Information Files
2584 @section The Ada Library Information Files
2585 @cindex Ada Library Information files
2586 @cindex @file{ALI} files
2589 Each compilation actually generates two output files. The first of these
2590 is the normal object file that has a @file{.o} extension. The second is a
2591 text file containing full dependency information. It has the same
2592 name as the source file, but an @file{.ali} extension.
2593 This file is known as the Ada Library Information (@file{ALI}) file.
2594 The following information is contained in the @file{ALI} file.
2598 Version information (indicates which version of GNAT was used to compile
2599 the unit(s) in question)
2602 Main program information (including priority and time slice settings,
2603 as well as the wide character encoding used during compilation).
2606 List of arguments used in the @command{gcc} command for the compilation
2609 Attributes of the unit, including configuration pragmas used, an indication
2610 of whether the compilation was successful, exception model used etc.
2613 A list of relevant restrictions applying to the unit (used for consistency)
2617 Categorization information (e.g. use of pragma @code{Pure}).
2620 Information on all @code{with}'ed units, including presence of
2621 @code{Elaborate} or @code{Elaborate_All} pragmas.
2624 Information from any @code{Linker_Options} pragmas used in the unit
2627 Information on the use of @code{Body_Version} or @code{Version}
2628 attributes in the unit.
2631 Dependency information. This is a list of files, together with
2632 time stamp and checksum information. These are files on which
2633 the unit depends in the sense that recompilation is required
2634 if any of these units are modified.
2637 Cross-reference data. Contains information on all entities referenced
2638 in the unit. Used by tools like @code{gnatxref} and @code{gnatfind} to
2639 provide cross-reference information.
2644 For a full detailed description of the format of the @file{ALI} file,
2645 see the source of the body of unit @code{Lib.Writ}, contained in file
2646 @file{lib-writ.adb} in the GNAT compiler sources.
2648 @node Binding an Ada Program
2649 @section Binding an Ada Program
2652 When using languages such as C and C++, once the source files have been
2653 compiled the only remaining step in building an executable program
2654 is linking the object modules together. This means that it is possible to
2655 link an inconsistent version of a program, in which two units have
2656 included different versions of the same header.
2658 The rules of Ada do not permit such an inconsistent program to be built.
2659 For example, if two clients have different versions of the same package,
2660 it is illegal to build a program containing these two clients.
2661 These rules are enforced by the GNAT binder, which also determines an
2662 elaboration order consistent with the Ada rules.
2664 The GNAT binder is run after all the object files for a program have
2665 been created. It is given the name of the main program unit, and from
2666 this it determines the set of units required by the program, by reading the
2667 corresponding ALI files. It generates error messages if the program is
2668 inconsistent or if no valid order of elaboration exists.
2670 If no errors are detected, the binder produces a main program, in Ada by
2671 default, that contains calls to the elaboration procedures of those
2672 compilation unit that require them, followed by
2673 a call to the main program. This Ada program is compiled to generate the
2674 object file for the main program. The name of
2675 the Ada file is @file{b~@var{xxx}.adb} (with the corresponding spec
2676 @file{b~@var{xxx}.ads}) where @var{xxx} is the name of the
2679 Finally, the linker is used to build the resulting executable program,
2680 using the object from the main program from the bind step as well as the
2681 object files for the Ada units of the program.
2683 @node Mixed Language Programming
2684 @section Mixed Language Programming
2685 @cindex Mixed Language Programming
2688 This section describes how to develop a mixed-language program,
2689 specifically one that comprises units in both Ada and C.
2692 * Interfacing to C::
2693 * Calling Conventions::
2696 @node Interfacing to C
2697 @subsection Interfacing to C
2699 Interfacing Ada with a foreign language such as C involves using
2700 compiler directives to import and/or export entity definitions in each
2701 language---using @code{extern} statements in C, for instance, and the
2702 @code{Import}, @code{Export}, and @code{Convention} pragmas in Ada. For
2703 a full treatment of these topics, read Appendix B, section 1 of the Ada
2704 95 Language Reference Manual.
2706 There are two ways to build a program using GNAT that contains some Ada
2707 sources and some foreign language sources, depending on whether or not
2708 the main subprogram is written in Ada. Here is a source example with
2709 the main subprogram in Ada:
2715 void print_num (int num)
2717 printf ("num is %d.\n", num);
2723 /* num_from_Ada is declared in my_main.adb */
2724 extern int num_from_Ada;
2728 return num_from_Ada;
2732 @smallexample @c ada
2734 procedure My_Main is
2736 -- Declare then export an Integer entity called num_from_Ada
2737 My_Num : Integer := 10;
2738 pragma Export (C, My_Num, "num_from_Ada");
2740 -- Declare an Ada function spec for Get_Num, then use
2741 -- C function get_num for the implementation.
2742 function Get_Num return Integer;
2743 pragma Import (C, Get_Num, "get_num");
2745 -- Declare an Ada procedure spec for Print_Num, then use
2746 -- C function print_num for the implementation.
2747 procedure Print_Num (Num : Integer);
2748 pragma Import (C, Print_Num, "print_num");
2751 Print_Num (Get_Num);
2757 To build this example, first compile the foreign language files to
2758 generate object files:
2765 Then, compile the Ada units to produce a set of object files and ALI
2768 gnatmake ^-c^/ACTIONS=COMPILE^ my_main.adb
2772 Run the Ada binder on the Ada main program:
2774 gnatbind my_main.ali
2778 Link the Ada main program, the Ada objects and the other language
2781 gnatlink my_main.ali file1.o file2.o
2785 The last three steps can be grouped in a single command:
2787 gnatmake my_main.adb -largs file1.o file2.o
2790 @cindex Binder output file
2792 If the main program is in a language other than Ada, then you may have
2793 more than one entry point into the Ada subsystem. You must use a special
2794 binder option to generate callable routines that initialize and
2795 finalize the Ada units (@pxref{Binding with Non-Ada Main Programs}).
2796 Calls to the initialization and finalization routines must be inserted
2797 in the main program, or some other appropriate point in the code. The
2798 call to initialize the Ada units must occur before the first Ada
2799 subprogram is called, and the call to finalize the Ada units must occur
2800 after the last Ada subprogram returns. The binder will place the
2801 initialization and finalization subprograms into the
2802 @file{b~@var{xxx}.adb} file where they can be accessed by your C
2803 sources. To illustrate, we have the following example:
2807 extern void adainit (void);
2808 extern void adafinal (void);
2809 extern int add (int, int);
2810 extern int sub (int, int);
2812 int main (int argc, char *argv[])
2818 /* Should print "21 + 7 = 28" */
2819 printf ("%d + %d = %d\n", a, b, add (a, b));
2820 /* Should print "21 - 7 = 14" */
2821 printf ("%d - %d = %d\n", a, b, sub (a, b));
2827 @smallexample @c ada
2830 function Add (A, B : Integer) return Integer;
2831 pragma Export (C, Add, "add");
2835 package body Unit1 is
2836 function Add (A, B : Integer) return Integer is
2844 function Sub (A, B : Integer) return Integer;
2845 pragma Export (C, Sub, "sub");
2849 package body Unit2 is
2850 function Sub (A, B : Integer) return Integer is
2859 The build procedure for this application is similar to the last
2860 example's. First, compile the foreign language files to generate object
2863 ^gcc -c main.c^gcc -c main.c^
2867 Next, compile the Ada units to produce a set of object files and ALI
2870 gnatmake ^-c^/ACTIONS=COMPILE^ unit1.adb
2871 gnatmake ^-c^/ACTIONS=COMPILE^ unit2.adb
2875 Run the Ada binder on every generated ALI file. Make sure to use the
2876 @option{-n} option to specify a foreign main program:
2878 gnatbind ^-n^/NOMAIN^ unit1.ali unit2.ali
2882 Link the Ada main program, the Ada objects and the foreign language
2883 objects. You need only list the last ALI file here:
2885 gnatlink unit2.ali main.o -o exec_file
2888 This procedure yields a binary executable called @file{exec_file}.
2891 @node Calling Conventions
2892 @subsection Calling Conventions
2893 @cindex Foreign Languages
2894 @cindex Calling Conventions
2895 GNAT follows standard calling sequence conventions and will thus interface
2896 to any other language that also follows these conventions. The following
2897 Convention identifiers are recognized by GNAT:
2900 @cindex Interfacing to Ada
2901 @cindex Other Ada compilers
2902 @cindex Convention Ada
2904 This indicates that the standard Ada calling sequence will be
2905 used and all Ada data items may be passed without any limitations in the
2906 case where GNAT is used to generate both the caller and callee. It is also
2907 possible to mix GNAT generated code and code generated by another Ada
2908 compiler. In this case, the data types should be restricted to simple
2909 cases, including primitive types. Whether complex data types can be passed
2910 depends on the situation. Probably it is safe to pass simple arrays, such
2911 as arrays of integers or floats. Records may or may not work, depending
2912 on whether both compilers lay them out identically. Complex structures
2913 involving variant records, access parameters, tasks, or protected types,
2914 are unlikely to be able to be passed.
2916 Note that in the case of GNAT running
2917 on a platform that supports DEC Ada 83, a higher degree of compatibility
2918 can be guaranteed, and in particular records are layed out in an identical
2919 manner in the two compilers. Note also that if output from two different
2920 compilers is mixed, the program is responsible for dealing with elaboration
2921 issues. Probably the safest approach is to write the main program in the
2922 version of Ada other than GNAT, so that it takes care of its own elaboration
2923 requirements, and then call the GNAT-generated adainit procedure to ensure
2924 elaboration of the GNAT components. Consult the documentation of the other
2925 Ada compiler for further details on elaboration.
2927 However, it is not possible to mix the tasking run time of GNAT and
2928 DEC Ada 83, All the tasking operations must either be entirely within
2929 GNAT compiled sections of the program, or entirely within DEC Ada 83
2930 compiled sections of the program.
2932 @cindex Interfacing to Assembly
2933 @cindex Convention Assembler
2935 Specifies assembler as the convention. In practice this has the
2936 same effect as convention Ada (but is not equivalent in the sense of being
2937 considered the same convention).
2939 @cindex Convention Asm
2942 Equivalent to Assembler.
2944 @cindex Interfacing to COBOL
2945 @cindex Convention COBOL
2948 Data will be passed according to the conventions described
2949 in section B.4 of the Ada 95 Reference Manual.
2952 @cindex Interfacing to C
2953 @cindex Convention C
2955 Data will be passed according to the conventions described
2956 in section B.3 of the Ada 95 Reference Manual.
2958 @findex C varargs function
2959 @cindex Intefacing to C varargs function
2960 @cindex varargs function interfaces
2961 @item C varargs function
2962 In C, @code{varargs} allows a function to take a variable number of
2963 arguments. There is no direct equivalent in this to Ada. One
2964 approach that can be used is to create a C wrapper for each
2965 different profile and then interface to this C wrapper. For
2966 example, to print an @code{int} value using @code{printf},
2967 create a C function @code{printfi} that takes two arguments, a
2968 pointer to a string and an int, and calls @code{printf}.
2969 Then in the Ada program, use pragma @code{Import} to
2970 interface to printfi.
2972 It may work on some platforms to directly interface to
2973 a @code{varargs} function by providing a specific Ada profile
2974 for a a particular call. However, this does not work on
2975 all platforms, since there is no guarantee that the
2976 calling sequence for a two argument normal C function
2977 is the same as for calling a @code{varargs} C function with
2978 the same two arguments.
2980 @cindex Convention Default
2985 @cindex Convention External
2991 @cindex Interfacing to C++
2992 @cindex Convention C++
2994 This stands for C++. For most purposes this is identical to C.
2995 See the separate description of the specialized GNAT pragmas relating to
2996 C++ interfacing for further details.
2999 @cindex Interfacing to Fortran
3000 @cindex Convention Fortran
3002 Data will be passed according to the conventions described
3003 in section B.5 of the Ada 95 Reference Manual.
3006 This applies to an intrinsic operation, as defined in the Ada 95
3007 Reference Manual. If a a pragma Import (Intrinsic) applies to a subprogram,
3008 this means that the body of the subprogram is provided by the compiler itself,
3009 usually by means of an efficient code sequence, and that the user does not
3010 supply an explicit body for it. In an application program, the pragma can
3011 only be applied to the following two sets of names, which the GNAT compiler
3016 Rotate_Left, Rotate_Right, Shift_Left, Shift_Right, Shift_Right_-
3017 Arithmetic. The corresponding subprogram declaration must have
3018 two formal parameters. The
3019 first one must be a signed integer type or a modular type with a binary
3020 modulus, and the second parameter must be of type Natural.
3021 The return type must be the same as the type of the first argument. The size
3022 of this type can only be 8, 16, 32, or 64.
3023 @item binary arithmetic operators: ``+'', ``-'', ``*'', ``/''
3024 The corresponding operator declaration must have parameters and result type
3025 that have the same root numeric type (for example, all three are long_float
3026 types). This simplifies the definition of operations that use type checking
3027 to perform dimensional checks:
3029 @smallexample @c ada
3030 type Distance is new Long_Float;
3031 type Time is new Long_Float;
3032 type Velocity is new Long_Float;
3033 function "/" (D : Distance; T : Time)
3035 pragma Import (Intrinsic, "/");
3039 This common idiom is often programmed with a generic definition and an
3040 explicit body. The pragma makes it simpler to introduce such declarations.
3041 It incurs no overhead in compilation time or code size, because it is
3042 implemented as a single machine instruction.
3048 @cindex Convention Stdcall
3050 This is relevant only to NT/Win95 implementations of GNAT,
3051 and specifies that the Stdcall calling sequence will be used, as defined
3052 by the NT API. Nevertheless, to ease building cross-platform bindings this
3053 convention will be handled as a C calling convention on non Windows
3057 @cindex Convention DLL
3059 This is equivalent to Stdcall.
3062 @cindex Convention Win32
3064 This is equivalent to Stdcall.
3068 @cindex Convention Stubbed
3070 This is a special convention that indicates that the compiler
3071 should provide a stub body that raises @code{Program_Error}.
3075 GNAT additionally provides a useful pragma @code{Convention_Identifier}
3076 that can be used to parametrize conventions and allow additional synonyms
3077 to be specified. For example if you have legacy code in which the convention
3078 identifier Fortran77 was used for Fortran, you can use the configuration
3081 @smallexample @c ada
3082 pragma Convention_Identifier (Fortran77, Fortran);
3086 And from now on the identifier Fortran77 may be used as a convention
3087 identifier (for example in an @code{Import} pragma) with the same
3090 @node Building Mixed Ada & C++ Programs
3091 @section Building Mixed Ada & C++ Programs
3094 A programmer inexperienced with mixed-language development may find that
3095 building an application containing both Ada and C++ code can be a
3096 challenge. As a matter of fact, interfacing with C++ has not been
3097 standardized in the Ada 95 Reference Manual due to the immaturity of --
3098 and lack of standards for -- C++ at the time. This section gives a few
3099 hints that should make this task easier. The first section addresses
3100 the differences regarding interfacing with C. The second section
3101 looks into the delicate problem of linking the complete application from
3102 its Ada and C++ parts. The last section gives some hints on how the GNAT
3103 run time can be adapted in order to allow inter-language dispatching
3104 with a new C++ compiler.
3107 * Interfacing to C++::
3108 * Linking a Mixed C++ & Ada Program::
3109 * A Simple Example::
3110 * Adapting the Run Time to a New C++ Compiler::
3113 @node Interfacing to C++
3114 @subsection Interfacing to C++
3117 GNAT supports interfacing with C++ compilers generating code that is
3118 compatible with the standard Application Binary Interface of the given
3122 Interfacing can be done at 3 levels: simple data, subprograms, and
3123 classes. In the first two cases, GNAT offers a specific @var{Convention
3124 CPP} that behaves exactly like @var{Convention C}. Usually, C++ mangles
3125 the names of subprograms, and currently, GNAT does not provide any help
3126 to solve the demangling problem. This problem can be addressed in two
3130 by modifying the C++ code in order to force a C convention using
3131 the @code{extern "C"} syntax.
3134 by figuring out the mangled name and use it as the Link_Name argument of
3139 Interfacing at the class level can be achieved by using the GNAT specific
3140 pragmas such as @code{CPP_Class} and @code{CPP_Virtual}. See the GNAT
3141 Reference Manual for additional information.
3143 @node Linking a Mixed C++ & Ada Program
3144 @subsection Linking a Mixed C++ & Ada Program
3147 Usually the linker of the C++ development system must be used to link
3148 mixed applications because most C++ systems will resolve elaboration
3149 issues (such as calling constructors on global class instances)
3150 transparently during the link phase. GNAT has been adapted to ease the
3151 use of a foreign linker for the last phase. Three cases can be
3156 Using GNAT and G++ (GNU C++ compiler) from the same GCC installation:
3157 The C++ linker can simply be called by using the C++ specific driver
3158 called @code{c++}. Note that this setup is not very common because it
3159 may involve recompiling the whole GCC tree from sources, which makes it
3160 harder to upgrade the compilation system for one language without
3161 destabilizing the other.
3166 $ gnatmake ada_unit -largs file1.o file2.o --LINK=c++
3170 Using GNAT and G++ from two different GCC installations: If both
3171 compilers are on the PATH, the previous method may be used. It is
3172 important to note that environment variables such as C_INCLUDE_PATH,
3173 GCC_EXEC_PREFIX, BINUTILS_ROOT, and GCC_ROOT will affect both compilers
3174 at the same time and may make one of the two compilers operate
3175 improperly if set during invocation of the wrong compiler. It is also
3176 very important that the linker uses the proper @file{libgcc.a} GCC
3177 library -- that is, the one from the C++ compiler installation. The
3178 implicit link command as suggested in the gnatmake command from the
3179 former example can be replaced by an explicit link command with the
3180 full-verbosity option in order to verify which library is used:
3183 $ gnatlink -v -v ada_unit file1.o file2.o --LINK=c++
3185 If there is a problem due to interfering environment variables, it can
3186 be worked around by using an intermediate script. The following example
3187 shows the proper script to use when GNAT has not been installed at its
3188 default location and g++ has been installed at its default location:
3196 $ gnatlink -v -v ada_unit file1.o file2.o --LINK=./my_script
3200 Using a non-GNU C++ compiler: The commands previously described can be
3201 used to insure that the C++ linker is used. Nonetheless, you need to add
3202 a few more parameters to the link command line, depending on the exception
3205 If the @code{setjmp/longjmp} exception mechanism is used, only the paths
3206 to the libgcc libraries are required:
3211 CC $* `gcc -print-file-name=libgcc.a` `gcc -print-file-name=libgcc_eh.a`
3212 $ gnatlink ada_unit file1.o file2.o --LINK=./my_script
3215 Where CC is the name of the non-GNU C++ compiler.
3217 If the @code{zero cost} exception mechanism is used, and the platform
3218 supports automatic registration of exception tables (e.g. Solaris or IRIX),
3219 paths to more objects are required:
3224 CC `gcc -print-file-name=crtbegin.o` $* \
3225 `gcc -print-file-name=libgcc.a` `gcc -print-file-name=libgcc_eh.a` \
3226 `gcc -print-file-name=crtend.o`
3227 $ gnatlink ada_unit file1.o file2.o --LINK=./my_script
3230 If the @code{zero cost} exception mechanism is used, and the platform
3231 doesn't support automatic registration of exception tables (e.g. HP-UX,
3232 Tru64 or AIX), the simple approach described above will not work and
3233 a pre-linking phase using GNAT will be necessary.
3237 @node A Simple Example
3238 @subsection A Simple Example
3240 The following example, provided as part of the GNAT examples, shows how
3241 to achieve procedural interfacing between Ada and C++ in both
3242 directions. The C++ class A has two methods. The first method is exported
3243 to Ada by the means of an extern C wrapper function. The second method
3244 calls an Ada subprogram. On the Ada side, The C++ calls are modelled by
3245 a limited record with a layout comparable to the C++ class. The Ada
3246 subprogram, in turn, calls the C++ method. So, starting from the C++
3247 main program, the process passes back and forth between the two
3251 Here are the compilation commands:
3253 $ gnatmake -c simple_cpp_interface
3256 $ gnatbind -n simple_cpp_interface
3257 $ gnatlink simple_cpp_interface -o cpp_main --LINK=$(CPLUSPLUS)
3258 -lstdc++ ex7.o cpp_main.o
3262 Here are the corresponding sources:
3270 void adainit (void);
3271 void adafinal (void);
3272 void method1 (A *t);
3294 class A : public Origin @{
3296 void method1 (void);
3297 void method2 (int v);
3307 extern "C" @{ void ada_method2 (A *t, int v);@}
3309 void A::method1 (void)
3312 printf ("in A::method1, a_value = %d \n",a_value);
3316 void A::method2 (int v)
3318 ada_method2 (this, v);
3319 printf ("in A::method2, a_value = %d \n",a_value);
3326 printf ("in A::A, a_value = %d \n",a_value);
3330 @b{package} @b{body} Simple_Cpp_Interface @b{is}
3332 @b{procedure} Ada_Method2 (This : @b{in} @b{out} A; V : Integer) @b{is}
3336 @b{end} Ada_Method2;
3338 @b{end} Simple_Cpp_Interface;
3340 @b{package} Simple_Cpp_Interface @b{is}
3341 @b{type} A @b{is} @b{limited}
3346 @b{pragma} Convention (C, A);
3348 @b{procedure} Method1 (This : @b{in} @b{out} A);
3349 @b{pragma} Import (C, Method1);
3351 @b{procedure} Ada_Method2 (This : @b{in} @b{out} A; V : Integer);
3352 @b{pragma} Export (C, Ada_Method2);
3354 @b{end} Simple_Cpp_Interface;
3357 @node Adapting the Run Time to a New C++ Compiler
3358 @subsection Adapting the Run Time to a New C++ Compiler
3360 GNAT offers the capability to derive Ada 95 tagged types directly from
3361 preexisting C++ classes and . See ``Interfacing with C++'' in the
3362 @cite{GNAT Reference Manual}. The mechanism used by GNAT for achieving
3364 has been made user configurable through a GNAT library unit
3365 @code{Interfaces.CPP}. The default version of this file is adapted to
3366 the GNU C++ compiler. Internal knowledge of the virtual
3367 table layout used by the new C++ compiler is needed to configure
3368 properly this unit. The Interface of this unit is known by the compiler
3369 and cannot be changed except for the value of the constants defining the
3370 characteristics of the virtual table: CPP_DT_Prologue_Size, CPP_DT_Entry_Size,
3371 CPP_TSD_Prologue_Size, CPP_TSD_Entry_Size. Read comments in the source
3372 of this unit for more details.
3374 @node Comparison between GNAT and C/C++ Compilation Models
3375 @section Comparison between GNAT and C/C++ Compilation Models
3378 The GNAT model of compilation is close to the C and C++ models. You can
3379 think of Ada specs as corresponding to header files in C. As in C, you
3380 don't need to compile specs; they are compiled when they are used. The
3381 Ada @code{with} is similar in effect to the @code{#include} of a C
3384 One notable difference is that, in Ada, you may compile specs separately
3385 to check them for semantic and syntactic accuracy. This is not always
3386 possible with C headers because they are fragments of programs that have
3387 less specific syntactic or semantic rules.
3389 The other major difference is the requirement for running the binder,
3390 which performs two important functions. First, it checks for
3391 consistency. In C or C++, the only defense against assembling
3392 inconsistent programs lies outside the compiler, in a makefile, for
3393 example. The binder satisfies the Ada requirement that it be impossible
3394 to construct an inconsistent program when the compiler is used in normal
3397 @cindex Elaboration order control
3398 The other important function of the binder is to deal with elaboration
3399 issues. There are also elaboration issues in C++ that are handled
3400 automatically. This automatic handling has the advantage of being
3401 simpler to use, but the C++ programmer has no control over elaboration.
3402 Where @code{gnatbind} might complain there was no valid order of
3403 elaboration, a C++ compiler would simply construct a program that
3404 malfunctioned at run time.
3406 @node Comparison between GNAT and Conventional Ada Library Models
3407 @section Comparison between GNAT and Conventional Ada Library Models
3410 This section is intended to be useful to Ada programmers who have
3411 previously used an Ada compiler implementing the traditional Ada library
3412 model, as described in the Ada 95 Language Reference Manual. If you
3413 have not used such a system, please go on to the next section.
3415 @cindex GNAT library
3416 In GNAT, there is no @dfn{library} in the normal sense. Instead, the set of
3417 source files themselves acts as the library. Compiling Ada programs does
3418 not generate any centralized information, but rather an object file and
3419 a ALI file, which are of interest only to the binder and linker.
3420 In a traditional system, the compiler reads information not only from
3421 the source file being compiled, but also from the centralized library.
3422 This means that the effect of a compilation depends on what has been
3423 previously compiled. In particular:
3427 When a unit is @code{with}'ed, the unit seen by the compiler corresponds
3428 to the version of the unit most recently compiled into the library.
3431 Inlining is effective only if the necessary body has already been
3432 compiled into the library.
3435 Compiling a unit may obsolete other units in the library.
3439 In GNAT, compiling one unit never affects the compilation of any other
3440 units because the compiler reads only source files. Only changes to source
3441 files can affect the results of a compilation. In particular:
3445 When a unit is @code{with}'ed, the unit seen by the compiler corresponds
3446 to the source version of the unit that is currently accessible to the
3451 Inlining requires the appropriate source files for the package or
3452 subprogram bodies to be available to the compiler. Inlining is always
3453 effective, independent of the order in which units are complied.
3456 Compiling a unit never affects any other compilations. The editing of
3457 sources may cause previous compilations to be out of date if they
3458 depended on the source file being modified.
3462 The most important result of these differences is that order of compilation
3463 is never significant in GNAT. There is no situation in which one is
3464 required to do one compilation before another. What shows up as order of
3465 compilation requirements in the traditional Ada library becomes, in
3466 GNAT, simple source dependencies; in other words, there is only a set
3467 of rules saying what source files must be present when a file is
3471 @node Placement of temporary files
3472 @section Placement of temporary files
3473 @cindex Temporary files (user control over placement)
3476 GNAT creates temporary files in the directory designated by the environment
3477 variable @env{TMPDIR}.
3478 (See the HP @emph{C RTL Reference Manual} on the function @code{getenv()}
3479 for detailed information on how environment variables are resolved.
3480 For most users the easiest way to make use of this feature is to simply
3481 define @env{TMPDIR} as a job level logical name).
3482 For example, if you wish to use a Ramdisk (assuming DECRAM is installed)
3483 for compiler temporary files, then you can include something like the
3484 following command in your @file{LOGIN.COM} file:
3487 $ define/job TMPDIR "/disk$scratchram/000000/temp/"
3491 If @env{TMPDIR} is not defined, then GNAT uses the directory designated by
3492 @env{TMP}; if @env{TMP} is not defined, then GNAT uses the directory
3493 designated by @env{TEMP}.
3494 If none of these environment variables are defined then GNAT uses the
3495 directory designated by the logical name @code{SYS$SCRATCH:}
3496 (by default the user's home directory). If all else fails
3497 GNAT uses the current directory for temporary files.
3500 @c *************************
3501 @node Compiling Using gcc
3502 @chapter Compiling Using @command{gcc}
3505 This chapter discusses how to compile Ada programs using the @command{gcc}
3506 command. It also describes the set of switches
3507 that can be used to control the behavior of the compiler.
3509 * Compiling Programs::
3510 * Switches for gcc::
3511 * Search Paths and the Run-Time Library (RTL)::
3512 * Order of Compilation Issues::
3516 @node Compiling Programs
3517 @section Compiling Programs
3520 The first step in creating an executable program is to compile the units
3521 of the program using the @command{gcc} command. You must compile the
3526 the body file (@file{.adb}) for a library level subprogram or generic
3530 the spec file (@file{.ads}) for a library level package or generic
3531 package that has no body
3534 the body file (@file{.adb}) for a library level package
3535 or generic package that has a body
3540 You need @emph{not} compile the following files
3545 the spec of a library unit which has a body
3552 because they are compiled as part of compiling related units. GNAT
3554 when the corresponding body is compiled, and subunits when the parent is
3557 @cindex cannot generate code
3558 If you attempt to compile any of these files, you will get one of the
3559 following error messages (where fff is the name of the file you compiled):
3562 cannot generate code for file @var{fff} (package spec)
3563 to check package spec, use -gnatc
3565 cannot generate code for file @var{fff} (missing subunits)
3566 to check parent unit, use -gnatc
3568 cannot generate code for file @var{fff} (subprogram spec)
3569 to check subprogram spec, use -gnatc
3571 cannot generate code for file @var{fff} (subunit)
3572 to check subunit, use -gnatc
3576 As indicated by the above error messages, if you want to submit
3577 one of these files to the compiler to check for correct semantics
3578 without generating code, then use the @option{-gnatc} switch.
3580 The basic command for compiling a file containing an Ada unit is
3583 $ gcc -c [@var{switches}] @file{file name}
3587 where @var{file name} is the name of the Ada file (usually
3589 @file{.ads} for a spec or @file{.adb} for a body).
3592 @option{-c} switch to tell @command{gcc} to compile, but not link, the file.
3594 The result of a successful compilation is an object file, which has the
3595 same name as the source file but an extension of @file{.o} and an Ada
3596 Library Information (ALI) file, which also has the same name as the
3597 source file, but with @file{.ali} as the extension. GNAT creates these
3598 two output files in the current directory, but you may specify a source
3599 file in any directory using an absolute or relative path specification
3600 containing the directory information.
3603 @command{gcc} is actually a driver program that looks at the extensions of
3604 the file arguments and loads the appropriate compiler. For example, the
3605 GNU C compiler is @file{cc1}, and the Ada compiler is @file{gnat1}.
3606 These programs are in directories known to the driver program (in some
3607 configurations via environment variables you set), but need not be in
3608 your path. The @command{gcc} driver also calls the assembler and any other
3609 utilities needed to complete the generation of the required object
3612 It is possible to supply several file names on the same @command{gcc}
3613 command. This causes @command{gcc} to call the appropriate compiler for
3614 each file. For example, the following command lists three separate
3615 files to be compiled:
3618 $ gcc -c x.adb y.adb z.c
3622 calls @code{gnat1} (the Ada compiler) twice to compile @file{x.adb} and
3623 @file{y.adb}, and @code{cc1} (the C compiler) once to compile @file{z.c}.
3624 The compiler generates three object files @file{x.o}, @file{y.o} and
3625 @file{z.o} and the two ALI files @file{x.ali} and @file{y.ali} from the
3626 Ada compilations. Any switches apply to all the files ^listed,^listed.^
3629 @option{-gnat@var{x}} switches, which apply only to Ada compilations.
3632 @node Switches for gcc
3633 @section Switches for @command{gcc}
3636 The @command{gcc} command accepts switches that control the
3637 compilation process. These switches are fully described in this section.
3638 First we briefly list all the switches, in alphabetical order, then we
3639 describe the switches in more detail in functionally grouped sections.
3641 More switches exist for GCC than those documented here, especially
3642 for specific targets. However, their use is not recommended as
3643 they may change code generation in ways that are incompatible with
3644 the Ada run-time library, or can cause inconsistencies between
3648 * Output and Error Message Control::
3649 * Warning Message Control::
3650 * Debugging and Assertion Control::
3651 * Validity Checking::
3654 * Stack Overflow Checking::
3655 * Using gcc for Syntax Checking::
3656 * Using gcc for Semantic Checking::
3657 * Compiling Different Versions of Ada::
3658 * Character Set Control::
3659 * File Naming Control::
3660 * Subprogram Inlining Control::
3661 * Auxiliary Output Control::
3662 * Debugging Control::
3663 * Exception Handling Control::
3664 * Units to Sources Mapping Files::
3665 * Integrated Preprocessing::
3666 * Code Generation Control::
3675 @cindex @option{-b} (@command{gcc})
3676 @item -b @var{target}
3677 Compile your program to run on @var{target}, which is the name of a
3678 system configuration. You must have a GNAT cross-compiler built if
3679 @var{target} is not the same as your host system.
3682 @cindex @option{-B} (@command{gcc})
3683 Load compiler executables (for example, @code{gnat1}, the Ada compiler)
3684 from @var{dir} instead of the default location. Only use this switch
3685 when multiple versions of the GNAT compiler are available. See the
3686 @command{gcc} manual page for further details. You would normally use the
3687 @option{-b} or @option{-V} switch instead.
3690 @cindex @option{-c} (@command{gcc})
3691 Compile. Always use this switch when compiling Ada programs.
3693 Note: for some other languages when using @command{gcc}, notably in
3694 the case of C and C++, it is possible to use
3695 use @command{gcc} without a @option{-c} switch to
3696 compile and link in one step. In the case of GNAT, you
3697 cannot use this approach, because the binder must be run
3698 and @command{gcc} cannot be used to run the GNAT binder.
3702 @cindex @option{-fno-inline} (@command{gcc})
3703 Suppresses all back-end inlining, even if other optimization or inlining
3705 This includes suppression of inlining that results
3706 from the use of the pragma @code{Inline_Always}.
3707 See also @option{-gnatn} and @option{-gnatN}.
3709 @item -fno-strict-aliasing
3710 @cindex @option{-fno-strict-aliasing} (@command{gcc})
3711 Causes the compiler to avoid assumptions regarding non-aliasing
3712 of objects of different types. See
3713 @ref{Optimization and Strict Aliasing} for details.
3716 @cindex @option{-fstack-check} (@command{gcc})
3717 Activates stack checking.
3718 See @ref{Stack Overflow Checking} for details of the use of this option.
3721 @cindex @option{-fstack-usage} (@command{gcc})
3722 Makes the compiler output stack usage information for the program, on a
3723 per-function basis. The description of the format is to be found in
3724 the GCC documentation.
3726 @item -fcallgraph-info
3727 @cindex @option{-fcallgraph-info} (@command{gcc})
3728 Makes the compiler output callgraph information for the program, on a
3729 per-file basis. The information is generated in the VCG format. It can
3730 be decorated with additional, per-node information if other debugging
3731 options are enabled (only works with -fstack-usage as of this writing).
3734 @cindex @option{^-g^/DEBUG^} (@command{gcc})
3735 Generate debugging information. This information is stored in the object
3736 file and copied from there to the final executable file by the linker,
3737 where it can be read by the debugger. You must use the
3738 @option{^-g^/DEBUG^} switch if you plan on using the debugger.
3741 @cindex @option{-gnat83} (@command{gcc})
3742 Enforce Ada 83 restrictions.
3745 @cindex @option{-gnat95} (@command{gcc})
3746 Enforce Ada 95 restrictions.
3749 @cindex @option{-gnat05} (@command{gcc})
3750 Allow full Ada 2005 features.
3753 @cindex @option{-gnata} (@command{gcc})
3754 Assertions enabled. @code{Pragma Assert} and @code{pragma Debug} to be
3758 @cindex @option{-gnatA} (@command{gcc})
3759 Avoid processing @file{gnat.adc}. If a gnat.adc file is present,
3763 @cindex @option{-gnatb} (@command{gcc})
3764 Generate brief messages to @file{stderr} even if verbose mode set.
3767 @cindex @option{-gnatc} (@command{gcc})
3768 Check syntax and semantics only (no code generation attempted).
3771 @cindex @option{-gnatd} (@command{gcc})
3772 Specify debug options for the compiler. The string of characters after
3773 the @option{-gnatd} specify the specific debug options. The possible
3774 characters are 0-9, a-z, A-Z, optionally preceded by a dot. See
3775 compiler source file @file{debug.adb} for details of the implemented
3776 debug options. Certain debug options are relevant to applications
3777 programmers, and these are documented at appropriate points in this
3781 @cindex @option{-gnatD} (@command{gcc})
3782 Create expanded source files for source level debugging. This switch
3783 also suppress generation of cross-reference information
3784 (see @option{-gnatx}).
3786 @item -gnatec=@var{path}
3787 @cindex @option{-gnatec} (@command{gcc})
3788 Specify a configuration pragma file
3790 (the equal sign is optional)
3792 (@pxref{The Configuration Pragmas Files}).
3794 @item ^-gnateD^/DATA_PREPROCESSING=^symbol[=value]
3795 @cindex @option{-gnateD} (@command{gcc})
3796 Defines a symbol, associated with value, for preprocessing.
3797 (@pxref{Integrated Preprocessing}).
3800 @cindex @option{-gnatef} (@command{gcc})
3801 Display full source path name in brief error messages.
3803 @item -gnatem=@var{path}
3804 @cindex @option{-gnatem} (@command{gcc})
3805 Specify a mapping file
3807 (the equal sign is optional)
3809 (@pxref{Units to Sources Mapping Files}).
3811 @item -gnatep=@var{file}
3812 @cindex @option{-gnatep} (@command{gcc})
3813 Specify a preprocessing data file
3815 (the equal sign is optional)
3817 (@pxref{Integrated Preprocessing}).
3820 @cindex @option{-gnatE} (@command{gcc})
3821 Full dynamic elaboration checks.
3824 @cindex @option{-gnatf} (@command{gcc})
3825 Full errors. Multiple errors per line, all undefined references, do not
3826 attempt to suppress cascaded errors.
3829 @cindex @option{-gnatF} (@command{gcc})
3830 Externals names are folded to all uppercase.
3833 @cindex @option{-gnatg} (@command{gcc})
3834 Internal GNAT implementation mode. This should not be used for
3835 applications programs, it is intended only for use by the compiler
3836 and its run-time library. For documentation, see the GNAT sources.
3837 Note that @option{-gnatg} implies @option{-gnatwu} so that warnings
3838 are generated on unreferenced entities, and all warnings are treated
3842 @cindex @option{-gnatG} (@command{gcc})
3843 List generated expanded code in source form.
3845 @item ^-gnath^/HELP^
3846 @cindex @option{^-gnath^/HELP^} (@command{gcc})
3847 Output usage information. The output is written to @file{stdout}.
3849 @item ^-gnati^/IDENTIFIER_CHARACTER_SET=^@var{c}
3850 @cindex @option{^-gnati^/IDENTIFIER_CHARACTER_SET^} (@command{gcc})
3851 Identifier character set
3853 (@var{c}=1/2/3/4/8/9/p/f/n/w).
3856 For details of the possible selections for @var{c},
3857 see @ref{Character Set Control}.
3860 @item -gnatk=@var{n}
3861 @cindex @option{-gnatk} (@command{gcc})
3862 Limit file names to @var{n} (1-999) characters ^(@code{k} = krunch)^^.
3865 @cindex @option{-gnatl} (@command{gcc})
3866 Output full source listing with embedded error messages.
3869 @cindex @option{-gnatL} (@command{gcc})
3870 This switch is deprecated. You can use @option{--RTS=sjlj} instead to enable
3871 @code{setjmp/longjmp} exception mechanism.
3873 @item -gnatm=@var{n}
3874 @cindex @option{-gnatm} (@command{gcc})
3875 Limit number of detected error or warning messages to @var{n}
3876 where @var{n} is in the range 1..999_999. The default setting if
3877 no switch is given is 9999. Compilation is terminated if this
3881 @cindex @option{-gnatn} (@command{gcc})
3882 Activate inlining for subprograms for which
3883 pragma @code{inline} is specified. This inlining is performed
3884 by the GCC back-end.
3887 @cindex @option{-gnatN} (@command{gcc})
3888 Activate front end inlining for subprograms for which
3889 pragma @code{Inline} is specified. This inlining is performed
3890 by the front end and will be visible in the
3891 @option{-gnatG} output.
3892 In some cases, this has proved more effective than the back end
3893 inlining resulting from the use of
3896 @option{-gnatN} automatically implies
3897 @option{-gnatn} so it is not necessary
3898 to specify both options. There are a few cases that the back-end inlining
3899 catches that cannot be dealt with in the front-end.
3902 @cindex @option{-gnato} (@command{gcc})
3903 Enable numeric overflow checking (which is not normally enabled by
3904 default). Not that division by zero is a separate check that is not
3905 controlled by this switch (division by zero checking is on by default).
3908 @cindex @option{-gnatp} (@command{gcc})
3909 Suppress all checks.
3912 @cindex @option{-gnatP} (@command{gcc})
3913 Enable polling. This is required on some systems (notably Windows NT) to
3914 obtain asynchronous abort and asynchronous transfer of control capability.
3915 See the description of pragma Polling in the GNAT Reference Manual for
3919 @cindex @option{-gnatq} (@command{gcc})
3920 Don't quit; try semantics, even if parse errors.
3923 @cindex @option{-gnatQ} (@command{gcc})
3924 Don't quit; generate @file{ALI} and tree files even if illegalities.
3926 @item ^-gnatR[0/1/2/3[s]]^/REPRESENTATION_INFO^
3927 @cindex @option{-gnatR} (@command{gcc})
3928 Output representation information for declared types and objects.
3931 @cindex @option{-gnats} (@command{gcc})
3935 @cindex @option{-gnatS} (@command{gcc})
3936 Print package Standard.
3939 @cindex @option{-gnatt} (@command{gcc})
3940 Generate tree output file.
3942 @item ^-gnatT^/TABLE_MULTIPLIER=^@var{nnn}
3943 @cindex @option{^-gnatT^/TABLE_MULTIPLIER^} (@command{gcc})
3944 All compiler tables start at @var{nnn} times usual starting size.
3947 @cindex @option{-gnatu} (@command{gcc})
3948 List units for this compilation.
3951 @cindex @option{-gnatU} (@command{gcc})
3952 Tag all error messages with the unique string ``error:''
3955 @cindex @option{-gnatv} (@command{gcc})
3956 Verbose mode. Full error output with source lines to @file{stdout}.
3959 @cindex @option{-gnatV} (@command{gcc})
3960 Control level of validity checking. See separate section describing
3963 @item ^-gnatw@var{xxx}^/WARNINGS=(@var{option}[,...])^
3964 @cindex @option{^-gnatw^/WARNINGS^} (@command{gcc})
3966 ^@var{xxx} is a string of option letters that^the list of options^ denotes
3967 the exact warnings that
3968 are enabled or disabled (@pxref{Warning Message Control}).
3970 @item ^-gnatW^/WIDE_CHARACTER_ENCODING=^@var{e}
3971 @cindex @option{^-gnatW^/WIDE_CHARACTER_ENCODING^} (@command{gcc})
3972 Wide character encoding method
3974 (@var{e}=n/h/u/s/e/8).
3977 (@var{e}=@code{BRACKETS, NONE, HEX, UPPER, SHIFT_JIS, EUC, UTF8})
3981 @cindex @option{-gnatx} (@command{gcc})
3982 Suppress generation of cross-reference information.
3984 @item ^-gnaty^/STYLE_CHECKS=(option,option..)^
3985 @cindex @option{^-gnaty^/STYLE_CHECKS^} (@command{gcc})
3986 Enable built-in style checks (@pxref{Style Checking}).
3988 @item ^-gnatz^/DISTRIBUTION_STUBS=^@var{m}
3989 @cindex @option{^-gnatz^/DISTRIBUTION_STUBS^} (@command{gcc})
3990 Distribution stub generation and compilation
3992 (@var{m}=r/c for receiver/caller stubs).
3995 (@var{m}=@code{RECEIVER} or @code{CALLER} to specify the type of stubs
3996 to be generated and compiled).
4000 This switch is deprecated. When zero cost exception handling is not the
4001 default and this is supported, you can use @option{--RTS=zcx} instead.
4003 @item ^-I^/SEARCH=^@var{dir}
4004 @cindex @option{^-I^/SEARCH^} (@command{gcc})
4006 Direct GNAT to search the @var{dir} directory for source files needed by
4007 the current compilation
4008 (@pxref{Search Paths and the Run-Time Library (RTL)}).
4010 @item ^-I-^/NOCURRENT_DIRECTORY^
4011 @cindex @option{^-I-^/NOCURRENT_DIRECTORY^} (@command{gcc})
4013 Except for the source file named in the command line, do not look for source
4014 files in the directory containing the source file named in the command line
4015 (@pxref{Search Paths and the Run-Time Library (RTL)}).
4019 @cindex @option{-mbig-switch} (@command{gcc})
4020 @cindex @code{case} statement (effect of @option{-mbig-switch} option)
4021 This standard gcc switch causes the compiler to use larger offsets in its
4022 jump table representation for @code{case} statements.
4023 This may result in less efficient code, but is sometimes necessary
4024 (for example on HP-UX targets)
4025 @cindex HP-UX and @option{-mbig-switch} option
4026 in order to compile large and/or nested @code{case} statements.
4029 @cindex @option{-o} (@command{gcc})
4030 This switch is used in @command{gcc} to redirect the generated object file
4031 and its associated ALI file. Beware of this switch with GNAT, because it may
4032 cause the object file and ALI file to have different names which in turn
4033 may confuse the binder and the linker.
4037 @cindex @option{-nostdinc} (@command{gcc})
4038 Inhibit the search of the default location for the GNAT Run Time
4039 Library (RTL) source files.
4042 @cindex @option{-nostdlib} (@command{gcc})
4043 Inhibit the search of the default location for the GNAT Run Time
4044 Library (RTL) ALI files.
4048 @cindex @option{-O} (@command{gcc})
4049 @var{n} controls the optimization level.
4053 No optimization, the default setting if no @option{-O} appears
4056 Normal optimization, the default if you specify @option{-O} without
4060 Extensive optimization
4063 Extensive optimization with automatic inlining of subprograms not
4064 specified by pragma @code{Inline}. This applies only to
4065 inlining within a unit. For details on control of inlining
4066 see @ref{Subprogram Inlining Control}.
4072 @cindex @option{/NOOPTIMIZE} (@code{GNAT COMPILE})
4073 Equivalent to @option{/OPTIMIZE=NONE}.
4074 This is the default behavior in the absence of an @option{/OPTMIZE}
4077 @item /OPTIMIZE[=(keyword[,...])]
4078 @cindex @option{/OPTIMIZE} (@code{GNAT COMPILE})
4079 Selects the level of optimization for your program. The supported
4080 keywords are as follows:
4083 Perform most optimizations, including those that
4085 This is the default if the @option{/OPTMIZE} qualifier is supplied
4086 without keyword options.
4089 Do not do any optimizations. Same as @code{/NOOPTIMIZE}.
4092 Perform some optimizations, but omit ones that are costly.
4095 Same as @code{SOME}.
4098 Full optimization, and also attempt automatic inlining of small
4099 subprograms within a unit even when pragma @code{Inline}
4100 is not specified (@pxref{Inlining of Subprograms}).
4103 Try to unroll loops. This keyword may be specified together with
4104 any keyword above other than @code{NONE}. Loop unrolling
4105 usually, but not always, improves the performance of programs.
4110 @item -pass-exit-codes
4111 @cindex @option{-pass-exit-codes} (@command{gcc})
4112 Catch exit codes from the compiler and use the most meaningful as
4116 @item --RTS=@var{rts-path}
4117 @cindex @option{--RTS} (@command{gcc})
4118 Specifies the default location of the runtime library. Same meaning as the
4119 equivalent @command{gnatmake} flag (@pxref{Switches for gnatmake}).
4122 @cindex @option{^-S^/ASM^} (@command{gcc})
4123 ^Used in place of @option{-c} to^Used to^
4124 cause the assembler source file to be
4125 generated, using @file{^.s^.S^} as the extension,
4126 instead of the object file.
4127 This may be useful if you need to examine the generated assembly code.
4129 @item ^-fverbose-asm^/VERBOSE_ASM^
4130 @cindex @option{^-fverbose-asm^/VERBOSE_ASM^} (@command{gcc})
4131 ^Used in conjunction with @option{-S}^Used in place of @option{/ASM}^
4132 to cause the generated assembly code file to be annotated with variable
4133 names, making it significantly easier to follow.
4136 @cindex @option{^-v^/VERBOSE^} (@command{gcc})
4137 Show commands generated by the @command{gcc} driver. Normally used only for
4138 debugging purposes or if you need to be sure what version of the
4139 compiler you are executing.
4143 @cindex @option{-V} (@command{gcc})
4144 Execute @var{ver} version of the compiler. This is the @command{gcc}
4145 version, not the GNAT version.
4151 You may combine a sequence of GNAT switches into a single switch. For
4152 example, the combined switch
4154 @cindex Combining GNAT switches
4160 is equivalent to specifying the following sequence of switches:
4163 -gnato -gnatf -gnati3
4167 @c NEED TO CHECK THIS FOR VMS
4170 The following restrictions apply to the combination of switches
4175 The switch @option{-gnatc} if combined with other switches must come
4176 first in the string.
4179 The switch @option{-gnats} if combined with other switches must come
4180 first in the string.
4184 @option{^-gnatz^/DISTRIBUTION_STUBS^}, @option{-gnatzc}, and @option{-gnatzr}
4185 may not be combined with any other switches.
4189 Once a ``y'' appears in the string (that is a use of the @option{-gnaty}
4190 switch), then all further characters in the switch are interpreted
4191 as style modifiers (see description of @option{-gnaty}).
4194 Once a ``d'' appears in the string (that is a use of the @option{-gnatd}
4195 switch), then all further characters in the switch are interpreted
4196 as debug flags (see description of @option{-gnatd}).
4199 Once a ``w'' appears in the string (that is a use of the @option{-gnatw}
4200 switch), then all further characters in the switch are interpreted
4201 as warning mode modifiers (see description of @option{-gnatw}).
4204 Once a ``V'' appears in the string (that is a use of the @option{-gnatV}
4205 switch), then all further characters in the switch are interpreted
4206 as validity checking options (see description of @option{-gnatV}).
4210 @node Output and Error Message Control
4211 @subsection Output and Error Message Control
4215 The standard default format for error messages is called ``brief format''.
4216 Brief format messages are written to @file{stderr} (the standard error
4217 file) and have the following form:
4220 e.adb:3:04: Incorrect spelling of keyword "function"
4221 e.adb:4:20: ";" should be "is"
4225 The first integer after the file name is the line number in the file,
4226 and the second integer is the column number within the line.
4227 @code{glide} can parse the error messages
4228 and point to the referenced character.
4229 The following switches provide control over the error message
4235 @cindex @option{-gnatv} (@command{gcc})
4238 The v stands for verbose.
4240 The effect of this setting is to write long-format error
4241 messages to @file{stdout} (the standard output file.
4242 The same program compiled with the
4243 @option{-gnatv} switch would generate:
4247 3. funcion X (Q : Integer)
4249 >>> Incorrect spelling of keyword "function"
4252 >>> ";" should be "is"
4257 The vertical bar indicates the location of the error, and the @samp{>>>}
4258 prefix can be used to search for error messages. When this switch is
4259 used the only source lines output are those with errors.
4262 @cindex @option{-gnatl} (@command{gcc})
4264 The @code{l} stands for list.
4266 This switch causes a full listing of
4267 the file to be generated. The output might look as follows:
4273 3. funcion X (Q : Integer)
4275 >>> Incorrect spelling of keyword "function"
4278 >>> ";" should be "is"
4290 When you specify the @option{-gnatv} or @option{-gnatl} switches and
4291 standard output is redirected, a brief summary is written to
4292 @file{stderr} (standard error) giving the number of error messages and
4293 warning messages generated.
4296 @cindex @option{-gnatU} (@command{gcc})
4297 This switch forces all error messages to be preceded by the unique
4298 string ``error:''. This means that error messages take a few more
4299 characters in space, but allows easy searching for and identification
4303 @cindex @option{-gnatb} (@command{gcc})
4305 The @code{b} stands for brief.
4307 This switch causes GNAT to generate the
4308 brief format error messages to @file{stderr} (the standard error
4309 file) as well as the verbose
4310 format message or full listing (which as usual is written to
4311 @file{stdout} (the standard output file).
4313 @item -gnatm^^=^@var{n}
4314 @cindex @option{-gnatm} (@command{gcc})
4316 The @code{m} stands for maximum.
4318 @var{n} is a decimal integer in the
4319 range of 1 to 999 and limits the number of error messages to be
4320 generated. For example, using @option{-gnatm2} might yield
4323 e.adb:3:04: Incorrect spelling of keyword "function"
4324 e.adb:5:35: missing ".."
4325 fatal error: maximum errors reached
4326 compilation abandoned
4330 @cindex @option{-gnatf} (@command{gcc})
4331 @cindex Error messages, suppressing
4333 The @code{f} stands for full.
4335 Normally, the compiler suppresses error messages that are likely to be
4336 redundant. This switch causes all error
4337 messages to be generated. In particular, in the case of
4338 references to undefined variables. If a given variable is referenced
4339 several times, the normal format of messages is
4341 e.adb:7:07: "V" is undefined (more references follow)
4345 where the parenthetical comment warns that there are additional
4346 references to the variable @code{V}. Compiling the same program with the
4347 @option{-gnatf} switch yields
4350 e.adb:7:07: "V" is undefined
4351 e.adb:8:07: "V" is undefined
4352 e.adb:8:12: "V" is undefined
4353 e.adb:8:16: "V" is undefined
4354 e.adb:9:07: "V" is undefined
4355 e.adb:9:12: "V" is undefined
4359 The @option{-gnatf} switch also generates additional information for
4360 some error messages. Some examples are:
4364 Full details on entities not available in high integrity mode
4366 Details on possibly non-portable unchecked conversion
4368 List possible interpretations for ambiguous calls
4370 Additional details on incorrect parameters
4374 @cindex @option{-gnatq} (@command{gcc})
4376 The @code{q} stands for quit (really ``don't quit'').
4378 In normal operation mode, the compiler first parses the program and
4379 determines if there are any syntax errors. If there are, appropriate
4380 error messages are generated and compilation is immediately terminated.
4382 GNAT to continue with semantic analysis even if syntax errors have been
4383 found. This may enable the detection of more errors in a single run. On
4384 the other hand, the semantic analyzer is more likely to encounter some
4385 internal fatal error when given a syntactically invalid tree.
4388 @cindex @option{-gnatQ} (@command{gcc})
4389 In normal operation mode, the @file{ALI} file is not generated if any
4390 illegalities are detected in the program. The use of @option{-gnatQ} forces
4391 generation of the @file{ALI} file. This file is marked as being in
4392 error, so it cannot be used for binding purposes, but it does contain
4393 reasonably complete cross-reference information, and thus may be useful
4394 for use by tools (e.g. semantic browsing tools or integrated development
4395 environments) that are driven from the @file{ALI} file. This switch
4396 implies @option{-gnatq}, since the semantic phase must be run to get a
4397 meaningful ALI file.
4399 In addition, if @option{-gnatt} is also specified, then the tree file is
4400 generated even if there are illegalities. It may be useful in this case
4401 to also specify @option{-gnatq} to ensure that full semantic processing
4402 occurs. The resulting tree file can be processed by ASIS, for the purpose
4403 of providing partial information about illegal units, but if the error
4404 causes the tree to be badly malformed, then ASIS may crash during the
4407 When @option{-gnatQ} is used and the generated @file{ALI} file is marked as
4408 being in error, @command{gnatmake} will attempt to recompile the source when it
4409 finds such an @file{ALI} file, including with switch @option{-gnatc}.
4411 Note that @option{-gnatQ} has no effect if @option{-gnats} is specified,
4412 since ALI files are never generated if @option{-gnats} is set.
4416 @node Warning Message Control
4417 @subsection Warning Message Control
4418 @cindex Warning messages
4420 In addition to error messages, which correspond to illegalities as defined
4421 in the Ada 95 Reference Manual, the compiler detects two kinds of warning
4424 First, the compiler considers some constructs suspicious and generates a
4425 warning message to alert you to a possible error. Second, if the
4426 compiler detects a situation that is sure to raise an exception at
4427 run time, it generates a warning message. The following shows an example
4428 of warning messages:
4430 e.adb:4:24: warning: creation of object may raise Storage_Error
4431 e.adb:10:17: warning: static value out of range
4432 e.adb:10:17: warning: "Constraint_Error" will be raised at run time
4436 GNAT considers a large number of situations as appropriate
4437 for the generation of warning messages. As always, warnings are not
4438 definite indications of errors. For example, if you do an out-of-range
4439 assignment with the deliberate intention of raising a
4440 @code{Constraint_Error} exception, then the warning that may be
4441 issued does not indicate an error. Some of the situations for which GNAT
4442 issues warnings (at least some of the time) are given in the following
4443 list. This list is not complete, and new warnings are often added to
4444 subsequent versions of GNAT. The list is intended to give a general idea
4445 of the kinds of warnings that are generated.
4449 Possible infinitely recursive calls
4452 Out-of-range values being assigned
4455 Possible order of elaboration problems
4461 Fixed-point type declarations with a null range
4464 Direct_IO or Sequential_IO instantiated with a type that has access values
4467 Variables that are never assigned a value
4470 Variables that are referenced before being initialized
4473 Task entries with no corresponding @code{accept} statement
4476 Duplicate accepts for the same task entry in a @code{select}
4479 Objects that take too much storage
4482 Unchecked conversion between types of differing sizes
4485 Missing @code{return} statement along some execution path in a function
4488 Incorrect (unrecognized) pragmas
4491 Incorrect external names
4494 Allocation from empty storage pool
4497 Potentially blocking operation in protected type
4500 Suspicious parenthesization of expressions
4503 Mismatching bounds in an aggregate
4506 Attempt to return local value by reference
4509 Premature instantiation of a generic body
4512 Attempt to pack aliased components
4515 Out of bounds array subscripts
4518 Wrong length on string assignment
4521 Violations of style rules if style checking is enabled
4524 Unused @code{with} clauses
4527 @code{Bit_Order} usage that does not have any effect
4530 @code{Standard.Duration} used to resolve universal fixed expression
4533 Dereference of possibly null value
4536 Declaration that is likely to cause storage error
4539 Internal GNAT unit @code{with}'ed by application unit
4542 Values known to be out of range at compile time
4545 Unreferenced labels and variables
4548 Address overlays that could clobber memory
4551 Unexpected initialization when address clause present
4554 Bad alignment for address clause
4557 Useless type conversions
4560 Redundant assignment statements and other redundant constructs
4563 Useless exception handlers
4566 Accidental hiding of name by child unit
4569 Access before elaboration detected at compile time
4572 A range in a @code{for} loop that is known to be null or might be null
4577 The following switches are available to control the handling of
4583 @emph{Activate all optional errors.}
4584 @cindex @option{-gnatwa} (@command{gcc})
4585 This switch activates most optional warning messages, see remaining list
4586 in this section for details on optional warning messages that can be
4587 individually controlled. The warnings that are not turned on by this
4589 @option{-gnatwd} (implicit dereferencing),
4590 @option{-gnatwh} (hiding),
4591 and @option{-gnatwl} (elaboration warnings).
4592 All other optional warnings are turned on.
4595 @emph{Suppress all optional errors.}
4596 @cindex @option{-gnatwA} (@command{gcc})
4597 This switch suppresses all optional warning messages, see remaining list
4598 in this section for details on optional warning messages that can be
4599 individually controlled.
4602 @emph{Activate warnings on bad fixed values.}
4603 @cindex @option{-gnatwb} (@command{gcc})
4604 @cindex Bad fixed values
4605 @cindex Fixed-point Small value
4607 This switch activates warnings for static fixed-point expressions whose
4608 value is not an exact multiple of Small. Such values are implementation
4609 dependent, since an implementation is free to choose either of the multiples
4610 that surround the value. GNAT always chooses the closer one, but this is not
4611 required behavior, and it is better to specify a value that is an exact
4612 multiple, ensuring predictable execution. The default is that such warnings
4616 @emph{Suppress warnings on bad fixed values.}
4617 @cindex @option{-gnatwB} (@command{gcc})
4618 This switch suppresses warnings for static fixed-point expressions whose
4619 value is not an exact multiple of Small.
4622 @emph{Activate warnings on conditionals.}
4623 @cindex @option{-gnatwc} (@command{gcc})
4624 @cindex Conditionals, constant
4625 This switch activates warnings for conditional expressions used in
4626 tests that are known to be True or False at compile time. The default
4627 is that such warnings are not generated.
4628 Note that this warning does
4629 not get issued for the use of boolean variables or constants whose
4630 values are known at compile time, since this is a standard technique
4631 for conditional compilation in Ada, and this would generate too many
4632 ``false positive'' warnings.
4633 This warning can also be turned on using @option{-gnatwa}.
4636 @emph{Suppress warnings on conditionals.}
4637 @cindex @option{-gnatwC} (@command{gcc})
4638 This switch suppresses warnings for conditional expressions used in
4639 tests that are known to be True or False at compile time.
4642 @emph{Activate warnings on implicit dereferencing.}
4643 @cindex @option{-gnatwd} (@command{gcc})
4644 If this switch is set, then the use of a prefix of an access type
4645 in an indexed component, slice, or selected component without an
4646 explicit @code{.all} will generate a warning. With this warning
4647 enabled, access checks occur only at points where an explicit
4648 @code{.all} appears in the source code (assuming no warnings are
4649 generated as a result of this switch). The default is that such
4650 warnings are not generated.
4651 Note that @option{-gnatwa} does not affect the setting of
4652 this warning option.
4655 @emph{Suppress warnings on implicit dereferencing.}
4656 @cindex @option{-gnatwD} (@command{gcc})
4657 @cindex Implicit dereferencing
4658 @cindex Dereferencing, implicit
4659 This switch suppresses warnings for implicit dereferences in
4660 indexed components, slices, and selected components.
4663 @emph{Treat warnings as errors.}
4664 @cindex @option{-gnatwe} (@command{gcc})
4665 @cindex Warnings, treat as error
4666 This switch causes warning messages to be treated as errors.
4667 The warning string still appears, but the warning messages are counted
4668 as errors, and prevent the generation of an object file.
4671 @emph{Activate warnings on unreferenced formals.}
4672 @cindex @option{-gnatwf} (@command{gcc})
4673 @cindex Formals, unreferenced
4674 This switch causes a warning to be generated if a formal parameter
4675 is not referenced in the body of the subprogram. This warning can
4676 also be turned on using @option{-gnatwa} or @option{-gnatwu}.
4679 @emph{Suppress warnings on unreferenced formals.}
4680 @cindex @option{-gnatwF} (@command{gcc})
4681 This switch suppresses warnings for unreferenced formal
4682 parameters. Note that the
4683 combination @option{-gnatwu} followed by @option{-gnatwF} has the
4684 effect of warning on unreferenced entities other than subprogram
4688 @emph{Activate warnings on unrecognized pragmas.}
4689 @cindex @option{-gnatwg} (@command{gcc})
4690 @cindex Pragmas, unrecognized
4691 This switch causes a warning to be generated if an unrecognized
4692 pragma is encountered. Apart from issuing this warning, the
4693 pragma is ignored and has no effect. This warning can
4694 also be turned on using @option{-gnatwa}. The default
4695 is that such warnings are issued (satisfying the Ada Reference
4696 Manual requirement that such warnings appear).
4699 @emph{Suppress warnings on unrecognized pragmas.}
4700 @cindex @option{-gnatwG} (@command{gcc})
4701 This switch suppresses warnings for unrecognized pragmas.
4704 @emph{Activate warnings on hiding.}
4705 @cindex @option{-gnatwh} (@command{gcc})
4706 @cindex Hiding of Declarations
4707 This switch activates warnings on hiding declarations.
4708 A declaration is considered hiding
4709 if it is for a non-overloadable entity, and it declares an entity with the
4710 same name as some other entity that is directly or use-visible. The default
4711 is that such warnings are not generated.
4712 Note that @option{-gnatwa} does not affect the setting of this warning option.
4715 @emph{Suppress warnings on hiding.}
4716 @cindex @option{-gnatwH} (@command{gcc})
4717 This switch suppresses warnings on hiding declarations.
4720 @emph{Activate warnings on implementation units.}
4721 @cindex @option{-gnatwi} (@command{gcc})
4722 This switch activates warnings for a @code{with} of an internal GNAT
4723 implementation unit, defined as any unit from the @code{Ada},
4724 @code{Interfaces}, @code{GNAT},
4725 ^^@code{DEC},^ or @code{System}
4726 hierarchies that is not
4727 documented in either the Ada Reference Manual or the GNAT
4728 Programmer's Reference Manual. Such units are intended only
4729 for internal implementation purposes and should not be @code{with}'ed
4730 by user programs. The default is that such warnings are generated
4731 This warning can also be turned on using @option{-gnatwa}.
4734 @emph{Disable warnings on implementation units.}
4735 @cindex @option{-gnatwI} (@command{gcc})
4736 This switch disables warnings for a @code{with} of an internal GNAT
4737 implementation unit.
4740 @emph{Activate warnings on obsolescent features (Annex J).}
4741 @cindex @option{-gnatwj} (@command{gcc})
4742 @cindex Features, obsolescent
4743 @cindex Obsolescent features
4744 If this warning option is activated, then warnings are generated for
4745 calls to subprograms marked with @code{pragma Obsolescent} and
4746 for use of features in Annex J of the Ada Reference Manual. In the
4747 case of Annex J, not all features are flagged. In particular use
4748 of the renamed packages (like @code{Text_IO}) and use of package
4749 @code{ASCII} are not flagged, since these are very common and
4750 would generate many annoying positive warnings. The default is that
4751 such warnings are not generated.
4753 In addition to the above cases, warnings are also generated for
4754 GNAT features that have been provided in past versions but which
4755 have been superseded (typically by features in the new Ada standard).
4756 For example, @code{pragma Ravenscar} will be flagged since its
4757 function is replaced by @code{pragma Profile(Ravenscar)}.
4759 Note that this warning option functions differently from the
4760 restriction @code{No_Obsolescent_Features} in two respects.
4761 First, the restriction applies only to annex J features.
4762 Second, the restriction does flag uses of package @code{ASCII}.
4765 @emph{Suppress warnings on obsolescent features (Annex J).}
4766 @cindex @option{-gnatwJ} (@command{gcc})
4767 This switch disables warnings on use of obsolescent features.
4770 @emph{Activate warnings on variables that could be constants.}
4771 @cindex @option{-gnatwk} (@command{gcc})
4772 This switch activates warnings for variables that are initialized but
4773 never modified, and then could be declared constants.
4776 @emph{Suppress warnings on variables that could be constants.}
4777 @cindex @option{-gnatwK} (@command{gcc})
4778 This switch disables warnings on variables that could be declared constants.
4781 @emph{Activate warnings for missing elaboration pragmas.}
4782 @cindex @option{-gnatwl} (@command{gcc})
4783 @cindex Elaboration, warnings
4784 This switch activates warnings on missing
4785 @code{pragma Elaborate_All} statements.
4786 See the section in this guide on elaboration checking for details on
4787 when such pragma should be used. Warnings are also generated if you
4788 are using the static mode of elaboration, and a @code{pragma Elaborate}
4789 is encountered. The default is that such warnings
4791 This warning is not automatically turned on by the use of @option{-gnatwa}.
4794 @emph{Suppress warnings for missing elaboration pragmas.}
4795 @cindex @option{-gnatwL} (@command{gcc})
4796 This switch suppresses warnings on missing pragma Elaborate_All statements.
4797 See the section in this guide on elaboration checking for details on
4798 when such pragma should be used.
4801 @emph{Activate warnings on modified but unreferenced variables.}
4802 @cindex @option{-gnatwm} (@command{gcc})
4803 This switch activates warnings for variables that are assigned (using
4804 an initialization value or with one or more assignment statements) but
4805 whose value is never read. The warning is suppressed for volatile
4806 variables and also for variables that are renamings of other variables
4807 or for which an address clause is given.
4808 This warning can also be turned on using @option{-gnatwa}.
4811 @emph{Disable warnings on modified but unreferenced variables.}
4812 @cindex @option{-gnatwM} (@command{gcc})
4813 This switch disables warnings for variables that are assigned or
4814 initialized, but never read.
4817 @emph{Set normal warnings mode.}
4818 @cindex @option{-gnatwn} (@command{gcc})
4819 This switch sets normal warning mode, in which enabled warnings are
4820 issued and treated as warnings rather than errors. This is the default
4821 mode. the switch @option{-gnatwn} can be used to cancel the effect of
4822 an explicit @option{-gnatws} or
4823 @option{-gnatwe}. It also cancels the effect of the
4824 implicit @option{-gnatwe} that is activated by the
4825 use of @option{-gnatg}.
4828 @emph{Activate warnings on address clause overlays.}
4829 @cindex @option{-gnatwo} (@command{gcc})
4830 @cindex Address Clauses, warnings
4831 This switch activates warnings for possibly unintended initialization
4832 effects of defining address clauses that cause one variable to overlap
4833 another. The default is that such warnings are generated.
4834 This warning can also be turned on using @option{-gnatwa}.
4837 @emph{Suppress warnings on address clause overlays.}
4838 @cindex @option{-gnatwO} (@command{gcc})
4839 This switch suppresses warnings on possibly unintended initialization
4840 effects of defining address clauses that cause one variable to overlap
4844 @emph{Activate warnings on ineffective pragma Inlines.}
4845 @cindex @option{-gnatwp} (@command{gcc})
4846 @cindex Inlining, warnings
4847 This switch activates warnings for failure of front end inlining
4848 (activated by @option{-gnatN}) to inline a particular call. There are
4849 many reasons for not being able to inline a call, including most
4850 commonly that the call is too complex to inline.
4851 This warning can also be turned on using @option{-gnatwa}.
4854 @emph{Suppress warnings on ineffective pragma Inlines.}
4855 @cindex @option{-gnatwP} (@command{gcc})
4856 This switch suppresses warnings on ineffective pragma Inlines. If the
4857 inlining mechanism cannot inline a call, it will simply ignore the
4861 @emph{Activate warnings on redundant constructs.}
4862 @cindex @option{-gnatwr} (@command{gcc})
4863 This switch activates warnings for redundant constructs. The following
4864 is the current list of constructs regarded as redundant:
4865 This warning can also be turned on using @option{-gnatwa}.
4869 Assignment of an item to itself.
4871 Type conversion that converts an expression to its own type.
4873 Use of the attribute @code{Base} where @code{typ'Base} is the same
4876 Use of pragma @code{Pack} when all components are placed by a record
4877 representation clause.
4879 Exception handler containing only a reraise statement (raise with no
4880 operand) which has no effect.
4882 Use of the operator abs on an operand that is known at compile time
4885 Comparison of boolean expressions to an explicit True value.
4889 @emph{Suppress warnings on redundant constructs.}
4890 @cindex @option{-gnatwR} (@command{gcc})
4891 This switch suppresses warnings for redundant constructs.
4894 @emph{Suppress all warnings.}
4895 @cindex @option{-gnatws} (@command{gcc})
4896 This switch completely suppresses the
4897 output of all warning messages from the GNAT front end.
4898 Note that it does not suppress warnings from the @command{gcc} back end.
4899 To suppress these back end warnings as well, use the switch @option{-w}
4900 in addition to @option{-gnatws}.
4903 @emph{Activate warnings on unused entities.}
4904 @cindex @option{-gnatwu} (@command{gcc})
4905 This switch activates warnings to be generated for entities that
4906 are declared but not referenced, and for units that are @code{with}'ed
4908 referenced. In the case of packages, a warning is also generated if
4909 no entities in the package are referenced. This means that if the package
4910 is referenced but the only references are in @code{use}
4911 clauses or @code{renames}
4912 declarations, a warning is still generated. A warning is also generated
4913 for a generic package that is @code{with}'ed but never instantiated.
4914 In the case where a package or subprogram body is compiled, and there
4915 is a @code{with} on the corresponding spec
4916 that is only referenced in the body,
4917 a warning is also generated, noting that the
4918 @code{with} can be moved to the body. The default is that
4919 such warnings are not generated.
4920 This switch also activates warnings on unreferenced formals
4921 (it includes the effect of @option{-gnatwf}).
4922 This warning can also be turned on using @option{-gnatwa}.
4925 @emph{Suppress warnings on unused entities.}
4926 @cindex @option{-gnatwU} (@command{gcc})
4927 This switch suppresses warnings for unused entities and packages.
4928 It also turns off warnings on unreferenced formals (and thus includes
4929 the effect of @option{-gnatwF}).
4932 @emph{Activate warnings on unassigned variables.}
4933 @cindex @option{-gnatwv} (@command{gcc})
4934 @cindex Unassigned variable warnings
4935 This switch activates warnings for access to variables which
4936 may not be properly initialized. The default is that
4937 such warnings are generated.
4940 @emph{Suppress warnings on unassigned variables.}
4941 @cindex @option{-gnatwV} (@command{gcc})
4942 This switch suppresses warnings for access to variables which
4943 may not be properly initialized.
4946 @emph{Activate warnings for Ada 2005 compatibility issues.}
4947 @cindex @option{-gnatwy} (@command{gcc})
4948 @cindex Ada 2005 compatibility issues warnings
4949 For the most part Ada 2005 is upwards compatible with Ada 95,
4950 but there are some exceptions (for example the fact that
4951 @code{interface} is now a reserved word in Ada 2005). This
4952 switch activates several warnings to help in identifying
4953 and correcting such incompatibilities. The default is that
4954 these warnings are generated. Note that at one point Ada 2005
4955 was called Ada 0Y, hence the choice of character.
4958 @emph{Disable warnings for Ada 2005 compatibility issues.}
4959 @cindex @option{-gnatwY} (@command{gcc})
4960 @cindex Ada 2005 compatibility issues warnings
4961 This switch suppresses several warnings intended to help in identifying
4962 incompatibilities between Ada 95 and Ada 2005.
4965 @emph{Activate warnings on Export/Import pragmas.}
4966 @cindex @option{-gnatwx} (@command{gcc})
4967 @cindex Export/Import pragma warnings
4968 This switch activates warnings on Export/Import pragmas when
4969 the compiler detects a possible conflict between the Ada and
4970 foreign language calling sequences. For example, the use of
4971 default parameters in a convention C procedure is dubious
4972 because the C compiler cannot supply the proper default, so
4973 a warning is issued. The default is that such warnings are
4977 @emph{Suppress warnings on Export/Import pragmas.}
4978 @cindex @option{-gnatwX} (@command{gcc})
4979 This switch suppresses warnings on Export/Import pragmas.
4980 The sense of this is that you are telling the compiler that
4981 you know what you are doing in writing the pragma, and it
4982 should not complain at you.
4985 @emph{Activate warnings on unchecked conversions.}
4986 @cindex @option{-gnatwz} (@command{gcc})
4987 @cindex Unchecked_Conversion warnings
4988 This switch activates warnings for unchecked conversions
4989 where the types are known at compile time to have different
4991 is that such warnings are generated.
4994 @emph{Suppress warnings on unchecked conversions.}
4995 @cindex @option{-gnatwZ} (@command{gcc})
4996 This switch suppresses warnings for unchecked conversions
4997 where the types are known at compile time to have different
5000 @item ^-Wuninitialized^WARNINGS=UNINITIALIZED^
5001 @cindex @option{-Wuninitialized}
5002 The warnings controlled by the @option{-gnatw} switch are generated by the
5003 front end of the compiler. In some cases, the @option{^gcc^GCC^} back end
5004 can provide additional warnings. One such useful warning is provided by
5005 @option{^-Wuninitialized^WARNINGS=UNINITIALIZED^}. This must be used in
5006 conjunction with tunrning on optimization mode. This causes the flow
5007 analysis circuits of the back end optimizer to output additional
5008 warnings about uninitialized variables.
5010 @item ^-w^/NO_BACK_END_WARNINGS^
5012 This switch suppresses warnings from the @option{^gcc^GCC^} back end. It may
5013 be used in conjunction with @option{-gnatws} to ensure that all warnings
5014 are suppressed during the entire compilation process.
5020 A string of warning parameters can be used in the same parameter. For example:
5027 will turn on all optional warnings except for elaboration pragma warnings,
5028 and also specify that warnings should be treated as errors.
5030 When no switch @option{^-gnatw^/WARNINGS^} is used, this is equivalent to:
5055 @node Debugging and Assertion Control
5056 @subsection Debugging and Assertion Control
5060 @cindex @option{-gnata} (@command{gcc})
5066 The pragmas @code{Assert} and @code{Debug} normally have no effect and
5067 are ignored. This switch, where @samp{a} stands for assert, causes
5068 @code{Assert} and @code{Debug} pragmas to be activated.
5070 The pragmas have the form:
5074 @b{pragma} Assert (@var{Boolean-expression} [,
5075 @var{static-string-expression}])
5076 @b{pragma} Debug (@var{procedure call})
5081 The @code{Assert} pragma causes @var{Boolean-expression} to be tested.
5082 If the result is @code{True}, the pragma has no effect (other than
5083 possible side effects from evaluating the expression). If the result is
5084 @code{False}, the exception @code{Assert_Failure} declared in the package
5085 @code{System.Assertions} is
5086 raised (passing @var{static-string-expression}, if present, as the
5087 message associated with the exception). If no string expression is
5088 given the default is a string giving the file name and line number
5091 The @code{Debug} pragma causes @var{procedure} to be called. Note that
5092 @code{pragma Debug} may appear within a declaration sequence, allowing
5093 debugging procedures to be called between declarations.
5096 @item /DEBUG[=debug-level]
5098 Specifies how much debugging information is to be included in
5099 the resulting object file where 'debug-level' is one of the following:
5102 Include both debugger symbol records and traceback
5104 This is the default setting.
5106 Include both debugger symbol records and traceback in
5109 Excludes both debugger symbol records and traceback
5110 the object file. Same as /NODEBUG.
5112 Includes only debugger symbol records in the object
5113 file. Note that this doesn't include traceback information.
5118 @node Validity Checking
5119 @subsection Validity Checking
5120 @findex Validity Checking
5123 The Ada 95 Reference Manual has specific requirements for checking
5124 for invalid values. In particular, RM 13.9.1 requires that the
5125 evaluation of invalid values (for example from unchecked conversions),
5126 not result in erroneous execution. In GNAT, the result of such an
5127 evaluation in normal default mode is to either use the value
5128 unmodified, or to raise Constraint_Error in those cases where use
5129 of the unmodified value would cause erroneous execution. The cases
5130 where unmodified values might lead to erroneous execution are case
5131 statements (where a wild jump might result from an invalid value),
5132 and subscripts on the left hand side (where memory corruption could
5133 occur as a result of an invalid value).
5135 The @option{-gnatV^@var{x}^^} switch allows more control over the validity
5138 The @code{x} argument is a string of letters that
5139 indicate validity checks that are performed or not performed in addition
5140 to the default checks described above.
5143 The options allowed for this qualifier
5144 indicate validity checks that are performed or not performed in addition
5145 to the default checks described above.
5151 @emph{All validity checks.}
5152 @cindex @option{-gnatVa} (@command{gcc})
5153 All validity checks are turned on.
5155 That is, @option{-gnatVa} is
5156 equivalent to @option{gnatVcdfimorst}.
5160 @emph{Validity checks for copies.}
5161 @cindex @option{-gnatVc} (@command{gcc})
5162 The right hand side of assignments, and the initializing values of
5163 object declarations are validity checked.
5166 @emph{Default (RM) validity checks.}
5167 @cindex @option{-gnatVd} (@command{gcc})
5168 Some validity checks are done by default following normal Ada semantics
5170 A check is done in case statements that the expression is within the range
5171 of the subtype. If it is not, Constraint_Error is raised.
5172 For assignments to array components, a check is done that the expression used
5173 as index is within the range. If it is not, Constraint_Error is raised.
5174 Both these validity checks may be turned off using switch @option{-gnatVD}.
5175 They are turned on by default. If @option{-gnatVD} is specified, a subsequent
5176 switch @option{-gnatVd} will leave the checks turned on.
5177 Switch @option{-gnatVD} should be used only if you are sure that all such
5178 expressions have valid values. If you use this switch and invalid values
5179 are present, then the program is erroneous, and wild jumps or memory
5180 overwriting may occur.
5183 @emph{Validity checks for floating-point values.}
5184 @cindex @option{-gnatVf} (@command{gcc})
5185 In the absence of this switch, validity checking occurs only for discrete
5186 values. If @option{-gnatVf} is specified, then validity checking also applies
5187 for floating-point values, and NaN's and infinities are considered invalid,
5188 as well as out of range values for constrained types. Note that this means
5189 that standard @code{IEEE} infinity mode is not allowed. The exact contexts
5190 in which floating-point values are checked depends on the setting of other
5191 options. For example,
5192 @option{^-gnatVif^VALIDITY_CHECKING=(IN_PARAMS,FLOATS)^} or
5193 @option{^-gnatVfi^VALIDITY_CHECKING=(FLOATS,IN_PARAMS)^}
5194 (the order does not matter) specifies that floating-point parameters of mode
5195 @code{in} should be validity checked.
5198 @emph{Validity checks for @code{in} mode parameters}
5199 @cindex @option{-gnatVi} (@command{gcc})
5200 Arguments for parameters of mode @code{in} are validity checked in function
5201 and procedure calls at the point of call.
5204 @emph{Validity checks for @code{in out} mode parameters.}
5205 @cindex @option{-gnatVm} (@command{gcc})
5206 Arguments for parameters of mode @code{in out} are validity checked in
5207 procedure calls at the point of call. The @code{'m'} here stands for
5208 modify, since this concerns parameters that can be modified by the call.
5209 Note that there is no specific option to test @code{out} parameters,
5210 but any reference within the subprogram will be tested in the usual
5211 manner, and if an invalid value is copied back, any reference to it
5212 will be subject to validity checking.
5215 @emph{No validity checks.}
5216 @cindex @option{-gnatVn} (@command{gcc})
5217 This switch turns off all validity checking, including the default checking
5218 for case statements and left hand side subscripts. Note that the use of
5219 the switch @option{-gnatp} suppresses all run-time checks, including
5220 validity checks, and thus implies @option{-gnatVn}. When this switch
5221 is used, it cancels any other @option{-gnatV} previously issued.
5224 @emph{Validity checks for operator and attribute operands.}
5225 @cindex @option{-gnatVo} (@command{gcc})
5226 Arguments for predefined operators and attributes are validity checked.
5227 This includes all operators in package @code{Standard},
5228 the shift operators defined as intrinsic in package @code{Interfaces}
5229 and operands for attributes such as @code{Pos}. Checks are also made
5230 on individual component values for composite comparisons.
5233 @emph{Validity checks for parameters.}
5234 @cindex @option{-gnatVp} (@command{gcc})
5235 This controls the treatment of parameters within a subprogram (as opposed
5236 to @option{-gnatVi} and @option{-gnatVm} which control validity testing
5237 of parameters on a call. If either of these call options is used, then
5238 normally an assumption is made within a subprogram that the input arguments
5239 have been validity checking at the point of call, and do not need checking
5240 again within a subprogram). If @option{-gnatVp} is set, then this assumption
5241 is not made, and parameters are not assumed to be valid, so their validity
5242 will be checked (or rechecked) within the subprogram.
5245 @emph{Validity checks for function returns.}
5246 @cindex @option{-gnatVr} (@command{gcc})
5247 The expression in @code{return} statements in functions is validity
5251 @emph{Validity checks for subscripts.}
5252 @cindex @option{-gnatVs} (@command{gcc})
5253 All subscripts expressions are checked for validity, whether they appear
5254 on the right side or left side (in default mode only left side subscripts
5255 are validity checked).
5258 @emph{Validity checks for tests.}
5259 @cindex @option{-gnatVt} (@command{gcc})
5260 Expressions used as conditions in @code{if}, @code{while} or @code{exit}
5261 statements are checked, as well as guard expressions in entry calls.
5266 The @option{-gnatV} switch may be followed by
5267 ^a string of letters^a list of options^
5268 to turn on a series of validity checking options.
5270 @option{^-gnatVcr^/VALIDITY_CHECKING=(COPIES, RETURNS)^}
5271 specifies that in addition to the default validity checking, copies and
5272 function return expressions are to be validity checked.
5273 In order to make it easier
5274 to specify the desired combination of effects,
5276 the upper case letters @code{CDFIMORST} may
5277 be used to turn off the corresponding lower case option.
5280 the prefix @code{NO} on an option turns off the corresponding validity
5283 @item @code{NOCOPIES}
5284 @item @code{NODEFAULT}
5285 @item @code{NOFLOATS}
5286 @item @code{NOIN_PARAMS}
5287 @item @code{NOMOD_PARAMS}
5288 @item @code{NOOPERANDS}
5289 @item @code{NORETURNS}
5290 @item @code{NOSUBSCRIPTS}
5291 @item @code{NOTESTS}
5295 @option{^-gnatVaM^/VALIDITY_CHECKING=(ALL, NOMOD_PARAMS)^}
5296 turns on all validity checking options except for
5297 checking of @code{@b{in out}} procedure arguments.
5299 The specification of additional validity checking generates extra code (and
5300 in the case of @option{-gnatVa} the code expansion can be substantial.
5301 However, these additional checks can be very useful in detecting
5302 uninitialized variables, incorrect use of unchecked conversion, and other
5303 errors leading to invalid values. The use of pragma @code{Initialize_Scalars}
5304 is useful in conjunction with the extra validity checking, since this
5305 ensures that wherever possible uninitialized variables have invalid values.
5307 See also the pragma @code{Validity_Checks} which allows modification of
5308 the validity checking mode at the program source level, and also allows for
5309 temporary disabling of validity checks.
5311 @node Style Checking
5312 @subsection Style Checking
5313 @findex Style checking
5316 The @option{-gnaty^x^(option,option,...)^} switch
5317 @cindex @option{-gnaty} (@command{gcc})
5318 causes the compiler to
5319 enforce specified style rules. A limited set of style rules has been used
5320 in writing the GNAT sources themselves. This switch allows user programs
5321 to activate all or some of these checks. If the source program fails a
5322 specified style check, an appropriate warning message is given, preceded by
5323 the character sequence ``(style)''.
5325 @code{(option,option,...)} is a sequence of keywords
5328 The string @var{x} is a sequence of letters or digits
5330 indicating the particular style
5331 checks to be performed. The following checks are defined:
5336 @emph{Specify indentation level.}
5337 If a digit from 1-9 appears
5338 ^in the string after @option{-gnaty}^as an option for /STYLE_CHECKS^
5339 then proper indentation is checked, with the digit indicating the
5340 indentation level required.
5341 The general style of required indentation is as specified by
5342 the examples in the Ada Reference Manual. Full line comments must be
5343 aligned with the @code{--} starting on a column that is a multiple of
5344 the alignment level.
5347 @emph{Check attribute casing.}
5348 If the ^letter a^word ATTRIBUTE^ appears in the string after @option{-gnaty}
5349 then attribute names, including the case of keywords such as @code{digits}
5350 used as attributes names, must be written in mixed case, that is, the
5351 initial letter and any letter following an underscore must be uppercase.
5352 All other letters must be lowercase.
5355 @emph{Blanks not allowed at statement end.}
5356 If the ^letter b^word BLANKS^ appears in the string after @option{-gnaty} then
5357 trailing blanks are not allowed at the end of statements. The purpose of this
5358 rule, together with h (no horizontal tabs), is to enforce a canonical format
5359 for the use of blanks to separate source tokens.
5362 @emph{Check comments.}
5363 If the ^letter c^word COMMENTS^ appears in the string after @option{-gnaty}
5364 then comments must meet the following set of rules:
5369 The ``@code{--}'' that starts the column must either start in column one,
5370 or else at least one blank must precede this sequence.
5373 Comments that follow other tokens on a line must have at least one blank
5374 following the ``@code{--}'' at the start of the comment.
5377 Full line comments must have two blanks following the ``@code{--}'' that
5378 starts the comment, with the following exceptions.
5381 A line consisting only of the ``@code{--}'' characters, possibly preceded
5382 by blanks is permitted.
5385 A comment starting with ``@code{--x}'' where @code{x} is a special character
5387 This allows proper processing of the output generated by specialized tools
5388 including @command{gnatprep} (where ``@code{--!}'' is used) and the SPARK
5390 language (where ``@code{--#}'' is used). For the purposes of this rule, a
5391 special character is defined as being in one of the ASCII ranges
5392 @code{16#21#..16#2F#} or @code{16#3A#..16#3F#}.
5393 Note that this usage is not permitted
5394 in GNAT implementation units (i.e. when @option{-gnatg} is used).
5397 A line consisting entirely of minus signs, possibly preceded by blanks, is
5398 permitted. This allows the construction of box comments where lines of minus
5399 signs are used to form the top and bottom of the box.
5402 A comment that starts and ends with ``@code{--}'' is permitted as long as at
5403 least one blank follows the initial ``@code{--}''. Together with the preceding
5404 rule, this allows the construction of box comments, as shown in the following
5407 ---------------------------
5408 -- This is a box comment --
5409 -- with two text lines. --
5410 ---------------------------
5414 @item ^d^DOS_LINE_ENDINGS^
5415 @emph{Check no DOS line terminators present.}
5416 If the ^letter d^word DOS_LINE_ENDINGS^ appears in the string after
5417 @option{-gnaty} then all lines must be terminated by a single ASCII.LF
5418 character (in particular the DOS line terminator sequence CR/LF is not
5422 @emph{Check end/exit labels.}
5423 If the ^letter e^word END^ appears in the string after @option{-gnaty} then
5424 optional labels on @code{end} statements ending subprograms and on
5425 @code{exit} statements exiting named loops, are required to be present.
5428 @emph{No form feeds or vertical tabs.}
5429 If the ^letter f^word VTABS^ appears in the string after @option{-gnaty} then
5430 neither form feeds nor vertical tab characters are permitted
5434 @emph{No horizontal tabs.}
5435 If the ^letter h^word HTABS^ appears in the string after @option{-gnaty} then
5436 horizontal tab characters are not permitted in the source text.
5437 Together with the b (no blanks at end of line) check, this
5438 enforces a canonical form for the use of blanks to separate
5442 @emph{Check if-then layout.}
5443 If the ^letter i^word IF_THEN^ appears in the string after @option{-gnaty},
5444 then the keyword @code{then} must appear either on the same
5445 line as corresponding @code{if}, or on a line on its own, lined
5446 up under the @code{if} with at least one non-blank line in between
5447 containing all or part of the condition to be tested.
5450 @emph{Check keyword casing.}
5451 If the ^letter k^word KEYWORD^ appears in the string after @option{-gnaty} then
5452 all keywords must be in lower case (with the exception of keywords
5453 such as @code{digits} used as attribute names to which this check
5457 @emph{Check layout.}
5458 If the ^letter l^word LAYOUT^ appears in the string after @option{-gnaty} then
5459 layout of statement and declaration constructs must follow the
5460 recommendations in the Ada Reference Manual, as indicated by the
5461 form of the syntax rules. For example an @code{else} keyword must
5462 be lined up with the corresponding @code{if} keyword.
5464 There are two respects in which the style rule enforced by this check
5465 option are more liberal than those in the Ada Reference Manual. First
5466 in the case of record declarations, it is permissible to put the
5467 @code{record} keyword on the same line as the @code{type} keyword, and
5468 then the @code{end} in @code{end record} must line up under @code{type}.
5469 For example, either of the following two layouts is acceptable:
5471 @smallexample @c ada
5487 Second, in the case of a block statement, a permitted alternative
5488 is to put the block label on the same line as the @code{declare} or
5489 @code{begin} keyword, and then line the @code{end} keyword up under
5490 the block label. For example both the following are permitted:
5492 @smallexample @c ada
5510 The same alternative format is allowed for loops. For example, both of
5511 the following are permitted:
5513 @smallexample @c ada
5515 Clear : while J < 10 loop
5526 @item ^Lnnn^MAX_NESTING=nnn^
5527 @emph{Set maximum nesting level}
5528 If the sequence ^Lnnn^MAX_NESTING=nnn^, where nnn is a decimal number in
5529 the range 0-999, appears in the string after @option{-gnaty} then the
5530 maximum level of nesting of constructs (including subprograms, loops,
5531 blocks, packages, and conditionals) may not exceed the given value. A
5532 value of zero disconnects this style check.
5534 @item ^m^LINE_LENGTH^
5535 @emph{Check maximum line length.}
5536 If the ^letter m^word LINE_LENGTH^ appears in the string after @option{-gnaty}
5537 then the length of source lines must not exceed 79 characters, including
5538 any trailing blanks. The value of 79 allows convenient display on an
5539 80 character wide device or window, allowing for possible special
5540 treatment of 80 character lines. Note that this count is of raw
5541 characters in the source text. This means that a tab character counts
5542 as one character in this count and a wide character sequence counts as
5543 several characters (however many are needed in the encoding).
5545 @item ^Mnnn^MAX_LENGTH=nnn^
5546 @emph{Set maximum line length.}
5547 If the sequence ^M^MAX_LENGTH=^nnn, where nnn is a decimal number, appears in
5548 the string after @option{-gnaty} then the length of lines must not exceed the
5551 @item ^n^STANDARD_CASING^
5552 @emph{Check casing of entities in Standard.}
5553 If the ^letter n^word STANDARD_CASING^ appears in the string
5554 after @option{-gnaty} then any identifier from Standard must be cased
5555 to match the presentation in the Ada Reference Manual (for example,
5556 @code{Integer} and @code{ASCII.NUL}).
5558 @item ^o^ORDERED_SUBPROGRAMS^
5559 @emph{Check order of subprogram bodies.}
5560 If the ^letter o^word ORDERED_SUBPROGRAMS^ appears in the string
5561 after @option{-gnaty} then all subprogram bodies in a given scope
5562 (e.g. a package body) must be in alphabetical order. The ordering
5563 rule uses normal Ada rules for comparing strings, ignoring casing
5564 of letters, except that if there is a trailing numeric suffix, then
5565 the value of this suffix is used in the ordering (e.g. Junk2 comes
5569 @emph{Check pragma casing.}
5570 If the ^letter p^word PRAGMA^ appears in the string after @option{-gnaty} then
5571 pragma names must be written in mixed case, that is, the
5572 initial letter and any letter following an underscore must be uppercase.
5573 All other letters must be lowercase.
5575 @item ^r^REFERENCES^
5576 @emph{Check references.}
5577 If the ^letter r^word REFERENCES^ appears in the string after @option{-gnaty}
5578 then all identifier references must be cased in the same way as the
5579 corresponding declaration. No specific casing style is imposed on
5580 identifiers. The only requirement is for consistency of references
5584 @emph{Check separate specs.}
5585 If the ^letter s^word SPECS^ appears in the string after @option{-gnaty} then
5586 separate declarations (``specs'') are required for subprograms (a
5587 body is not allowed to serve as its own declaration). The only
5588 exception is that parameterless library level procedures are
5589 not required to have a separate declaration. This exception covers
5590 the most frequent form of main program procedures.
5593 @emph{Check token spacing.}
5594 If the ^letter t^word TOKEN^ appears in the string after @option{-gnaty} then
5595 the following token spacing rules are enforced:
5600 The keywords @code{@b{abs}} and @code{@b{not}} must be followed by a space.
5603 The token @code{=>} must be surrounded by spaces.
5606 The token @code{<>} must be preceded by a space or a left parenthesis.
5609 Binary operators other than @code{**} must be surrounded by spaces.
5610 There is no restriction on the layout of the @code{**} binary operator.
5613 Colon must be surrounded by spaces.
5616 Colon-equal (assignment, initialization) must be surrounded by spaces.
5619 Comma must be the first non-blank character on the line, or be
5620 immediately preceded by a non-blank character, and must be followed
5624 If the token preceding a left parenthesis ends with a letter or digit, then
5625 a space must separate the two tokens.
5628 A right parenthesis must either be the first non-blank character on
5629 a line, or it must be preceded by a non-blank character.
5632 A semicolon must not be preceded by a space, and must not be followed by
5633 a non-blank character.
5636 A unary plus or minus may not be followed by a space.
5639 A vertical bar must be surrounded by spaces.
5642 @item ^u^UNNECESSARY_BLANK_LINES^
5643 @emph{Check unnecessary blank lines.}
5644 Check for unnecessary blank lines. A blank line is considered
5645 unnecessary if it appears at the end of the file, or if more than
5646 one blank line occurs in sequence.
5648 @item ^x^XTRA_PARENS^
5649 @emph{Check extra parentheses.}
5650 Check for the use of an unnecessary extra level of parentheses (C-style)
5651 around conditions in @code{if} statements, @code{while} statements and
5652 @code{exit} statements.
5657 In the above rules, appearing in column one is always permitted, that is,
5658 counts as meeting either a requirement for a required preceding space,
5659 or as meeting a requirement for no preceding space.
5661 Appearing at the end of a line is also always permitted, that is, counts
5662 as meeting either a requirement for a following space, or as meeting
5663 a requirement for no following space.
5666 If any of these style rules is violated, a message is generated giving
5667 details on the violation. The initial characters of such messages are
5668 always ``@code{(style)}''. Note that these messages are treated as warning
5669 messages, so they normally do not prevent the generation of an object
5670 file. The @option{-gnatwe} switch can be used to treat warning messages,
5671 including style messages, as fatal errors.
5675 @option{-gnaty} on its own (that is not
5676 followed by any letters or digits),
5677 is equivalent to @code{gnaty3abcefhiklmnprst}, that is all checking
5678 options enabled with the exception of @option{-gnatyo},
5679 @option{-gnatyd}, @option{-gnatyu}, and @option{-gnatyx}.
5682 /STYLE_CHECKS=ALL_BUILTIN enables all checking options with
5683 the exception of ORDERED_SUBPROGRAMS, UNNECESSARY_BLANK_LINES,
5684 XTRA_PARENS, and DOS_LINE_ENDINGS. In addition
5686 an indentation level of 3 is set. This is similar to the standard
5687 checking option that is used for the GNAT sources.
5696 clears any previously set style checks.
5698 @node Run-Time Checks
5699 @subsection Run-Time Checks
5700 @cindex Division by zero
5701 @cindex Access before elaboration
5702 @cindex Checks, division by zero
5703 @cindex Checks, access before elaboration
5706 If you compile with the default options, GNAT will insert many run-time
5707 checks into the compiled code, including code that performs range
5708 checking against constraints, but not arithmetic overflow checking for
5709 integer operations (including division by zero) or checks for access
5710 before elaboration on subprogram calls. All other run-time checks, as
5711 required by the Ada 95 Reference Manual, are generated by default.
5712 The following @command{gcc} switches refine this default behavior:
5717 @cindex @option{-gnatp} (@command{gcc})
5718 @cindex Suppressing checks
5719 @cindex Checks, suppressing
5721 Suppress all run-time checks as though @code{pragma Suppress (all_checks})
5722 had been present in the source. Validity checks are also suppressed (in
5723 other words @option{-gnatp} also implies @option{-gnatVn}.
5724 Use this switch to improve the performance
5725 of the code at the expense of safety in the presence of invalid data or
5729 @cindex @option{-gnato} (@command{gcc})
5730 @cindex Overflow checks
5731 @cindex Check, overflow
5732 Enables overflow checking for integer operations.
5733 This causes GNAT to generate slower and larger executable
5734 programs by adding code to check for overflow (resulting in raising
5735 @code{Constraint_Error} as required by standard Ada
5736 semantics). These overflow checks correspond to situations in which
5737 the true value of the result of an operation may be outside the base
5738 range of the result type. The following example shows the distinction:
5740 @smallexample @c ada
5741 X1 : Integer := Integer'Last;
5742 X2 : Integer range 1 .. 5 := 5;
5743 X3 : Integer := Integer'Last;
5744 X4 : Integer range 1 .. 5 := 5;
5745 F : Float := 2.0E+20;
5754 Here the first addition results in a value that is outside the base range
5755 of Integer, and hence requires an overflow check for detection of the
5756 constraint error. Thus the first assignment to @code{X1} raises a
5757 @code{Constraint_Error} exception only if @option{-gnato} is set.
5759 The second increment operation results in a violation
5760 of the explicit range constraint, and such range checks are always
5761 performed (unless specifically suppressed with a pragma @code{suppress}
5762 or the use of @option{-gnatp}).
5764 The two conversions of @code{F} both result in values that are outside
5765 the base range of type @code{Integer} and thus will raise
5766 @code{Constraint_Error} exceptions only if @option{-gnato} is used.
5767 The fact that the result of the second conversion is assigned to
5768 variable @code{X4} with a restricted range is irrelevant, since the problem
5769 is in the conversion, not the assignment.
5771 Basically the rule is that in the default mode (@option{-gnato} not
5772 used), the generated code assures that all integer variables stay
5773 within their declared ranges, or within the base range if there is
5774 no declared range. This prevents any serious problems like indexes
5775 out of range for array operations.
5777 What is not checked in default mode is an overflow that results in
5778 an in-range, but incorrect value. In the above example, the assignments
5779 to @code{X1}, @code{X2}, @code{X3} all give results that are within the
5780 range of the target variable, but the result is wrong in the sense that
5781 it is too large to be represented correctly. Typically the assignment
5782 to @code{X1} will result in wrap around to the largest negative number.
5783 The conversions of @code{F} will result in some @code{Integer} value
5784 and if that integer value is out of the @code{X4} range then the
5785 subsequent assignment would generate an exception.
5787 @findex Machine_Overflows
5788 Note that the @option{-gnato} switch does not affect the code generated
5789 for any floating-point operations; it applies only to integer
5791 For floating-point, GNAT has the @code{Machine_Overflows}
5792 attribute set to @code{False} and the normal mode of operation is to
5793 generate IEEE NaN and infinite values on overflow or invalid operations
5794 (such as dividing 0.0 by 0.0).
5796 The reason that we distinguish overflow checking from other kinds of
5797 range constraint checking is that a failure of an overflow check can
5798 generate an incorrect value, but cannot cause erroneous behavior. This
5799 is unlike the situation with a constraint check on an array subscript,
5800 where failure to perform the check can result in random memory description,
5801 or the range check on a case statement, where failure to perform the check
5802 can cause a wild jump.
5804 Note again that @option{-gnato} is off by default, so overflow checking is
5805 not performed in default mode. This means that out of the box, with the
5806 default settings, GNAT does not do all the checks expected from the
5807 language description in the Ada Reference Manual. If you want all constraint
5808 checks to be performed, as described in this Manual, then you must
5809 explicitly use the -gnato switch either on the @command{gnatmake} or
5810 @command{gcc} command.
5813 @cindex @option{-gnatE} (@command{gcc})
5814 @cindex Elaboration checks
5815 @cindex Check, elaboration
5816 Enables dynamic checks for access-before-elaboration
5817 on subprogram calls and generic instantiations.
5818 For full details of the effect and use of this switch,
5819 @xref{Compiling Using gcc}.
5824 The setting of these switches only controls the default setting of the
5825 checks. You may modify them using either @code{Suppress} (to remove
5826 checks) or @code{Unsuppress} (to add back suppressed checks) pragmas in
5829 @node Stack Overflow Checking
5830 @subsection Stack Overflow Checking
5831 @cindex Stack Overflow Checking
5832 @cindex -fstack-check
5835 For most operating systems, @command{gcc} does not perform stack overflow
5836 checking by default. This means that if the main environment task or
5837 some other task exceeds the available stack space, then unpredictable
5838 behavior will occur.
5840 To activate stack checking, compile all units with the gcc option
5841 @option{-fstack-check}. For example:
5844 gcc -c -fstack-check package1.adb
5848 Units compiled with this option will generate extra instructions to check
5849 that any use of the stack (for procedure calls or for declaring local
5850 variables in declare blocks) do not exceed the available stack space.
5851 If the space is exceeded, then a @code{Storage_Error} exception is raised.
5853 For declared tasks, the stack size is always controlled by the size
5854 given in an applicable @code{Storage_Size} pragma (or is set to
5855 the default size if no pragma is used.
5857 For the environment task, the stack size depends on
5858 system defaults and is unknown to the compiler. The stack
5859 may even dynamically grow on some systems, precluding the
5860 normal Ada semantics for stack overflow. In the worst case,
5861 unbounded stack usage, causes unbounded stack expansion
5862 resulting in the system running out of virtual memory.
5864 The stack checking may still work correctly if a fixed
5865 size stack is allocated, but this cannot be guaranteed.
5866 To ensure that a clean exception is signalled for stack
5867 overflow, set the environment variable
5868 @code{GNAT_STACK_LIMIT} to indicate the maximum
5869 stack area that can be used, as in:
5870 @cindex GNAT_STACK_LIMIT
5873 SET GNAT_STACK_LIMIT 1600
5877 The limit is given in kilobytes, so the above declaration would
5878 set the stack limit of the environment task to 1.6 megabytes.
5879 Note that the only purpose of this usage is to limit the amount
5880 of stack used by the environment task. If it is necessary to
5881 increase the amount of stack for the environment task, then this
5882 is an operating systems issue, and must be addressed with the
5883 appropriate operating systems commands.
5885 @node Using gcc for Syntax Checking
5886 @subsection Using @command{gcc} for Syntax Checking
5889 @cindex @option{-gnats} (@command{gcc})
5893 The @code{s} stands for ``syntax''.
5896 Run GNAT in syntax checking only mode. For
5897 example, the command
5900 $ gcc -c -gnats x.adb
5904 compiles file @file{x.adb} in syntax-check-only mode. You can check a
5905 series of files in a single command
5907 , and can use wild cards to specify such a group of files.
5908 Note that you must specify the @option{-c} (compile
5909 only) flag in addition to the @option{-gnats} flag.
5912 You may use other switches in conjunction with @option{-gnats}. In
5913 particular, @option{-gnatl} and @option{-gnatv} are useful to control the
5914 format of any generated error messages.
5916 When the source file is empty or contains only empty lines and/or comments,
5917 the output is a warning:
5920 $ gcc -c -gnats -x ada toto.txt
5921 toto.txt:1:01: warning: empty file, contains no compilation units
5925 Otherwise, the output is simply the error messages, if any. No object file or
5926 ALI file is generated by a syntax-only compilation. Also, no units other
5927 than the one specified are accessed. For example, if a unit @code{X}
5928 @code{with}'s a unit @code{Y}, compiling unit @code{X} in syntax
5929 check only mode does not access the source file containing unit
5932 @cindex Multiple units, syntax checking
5933 Normally, GNAT allows only a single unit in a source file. However, this
5934 restriction does not apply in syntax-check-only mode, and it is possible
5935 to check a file containing multiple compilation units concatenated
5936 together. This is primarily used by the @code{gnatchop} utility
5937 (@pxref{Renaming Files Using gnatchop}).
5940 @node Using gcc for Semantic Checking
5941 @subsection Using @command{gcc} for Semantic Checking
5944 @cindex @option{-gnatc} (@command{gcc})
5948 The @code{c} stands for ``check''.
5950 Causes the compiler to operate in semantic check mode,
5951 with full checking for all illegalities specified in the
5952 Ada 95 Reference Manual, but without generation of any object code
5953 (no object file is generated).
5955 Because dependent files must be accessed, you must follow the GNAT
5956 semantic restrictions on file structuring to operate in this mode:
5960 The needed source files must be accessible
5961 (@pxref{Search Paths and the Run-Time Library (RTL)}).
5964 Each file must contain only one compilation unit.
5967 The file name and unit name must match (@pxref{File Naming Rules}).
5970 The output consists of error messages as appropriate. No object file is
5971 generated. An @file{ALI} file is generated for use in the context of
5972 cross-reference tools, but this file is marked as not being suitable
5973 for binding (since no object file is generated).
5974 The checking corresponds exactly to the notion of
5975 legality in the Ada 95 Reference Manual.
5977 Any unit can be compiled in semantics-checking-only mode, including
5978 units that would not normally be compiled (subunits,
5979 and specifications where a separate body is present).
5982 @node Compiling Different Versions of Ada
5983 @subsection Compiling Different Versions of Ada
5985 @cindex Compatibility with Ada 83
5988 @cindex Ada 2005 mode
5990 GNAT is primarily an Ada 95 compiler, but the switches described in
5991 this section allow operation in Ada 83 compatibility mode, and also
5992 allow the use of a preliminary implementation of many of the expected
5993 new features in Ada 2005, the forthcoming new version of the standard.
5995 @item -gnat83 (Ada 83 Compatibility Mode)
5996 @cindex @option{-gnat83} (@command{gcc})
5997 @cindex ACVC, Ada 83 tests
6000 Although GNAT is primarily an Ada 95 compiler, it accepts this switch to
6001 specify that an Ada 83 program is to be compiled in Ada 83 mode. If you specify
6002 this switch, GNAT rejects most Ada 95 extensions and applies Ada 83 semantics
6003 where this can be done easily.
6004 It is not possible to guarantee this switch does a perfect
6005 job; for example, some subtle tests, such as are
6006 found in earlier ACVC tests (and that have been removed from the ACATS suite
6007 for Ada 95), might not compile correctly.
6008 Nevertheless, this switch may be useful in some circumstances, for example
6009 where, due to contractual reasons, legacy code needs to be maintained
6010 using only Ada 83 features.
6012 With few exceptions (most notably the need to use @code{<>} on
6013 @cindex Generic formal parameters
6014 unconstrained generic formal parameters, the use of the new Ada 95
6015 reserved words, and the use of packages
6016 with optional bodies), it is not necessary to use the
6017 @option{-gnat83} switch when compiling Ada 83 programs, because, with rare
6018 exceptions, Ada 95 is upwardly compatible with Ada 83. This
6019 means that a correct Ada 83 program is usually also a correct Ada 95
6021 For further information, please refer to @ref{Compatibility and Porting Guide}.
6023 @item -gnat95 (Ada 95 mode)
6024 @cindex @option{-gnat95} (@command{gcc})
6027 GNAT is primarily an Ada 95 compiler, and all current releases of GNAT Pro
6028 compile in Ada 95 mode by default. Typically, Ada 95 is sufficiently upwards
6029 compatible with Ada 83, that legacy Ada 83 programs may be compiled using
6030 this default Ada95 mode without problems (see section above describing the
6031 use of @option{-gnat83} to run in Ada 83 mode).
6033 In Ada 95 mode, the use of Ada 2005 features will in general cause error
6034 messages or warnings. Some specialized releases of GNAT (notably the GAP
6035 academic version) operate in Ada 2005 mode by default (see section below
6036 describing the use of @option{-gnat05} to run in Ada 2005 mode). For such
6037 versions the @option{-gnat95} switch may be used to enforce Ada 95 mode.
6038 This option also can be used to cancel the effect of a previous
6039 @option{-gnat83} or @option{-gnat05} switch earlier in the command line.
6042 @item -gnat05 (Ada 2005 mode)
6043 @cindex @option{-gnat05} (@command{gcc})
6046 Although GNAT is primarily an Ada 95 compiler, it can be set to operate
6047 in Ada 2005 mode using this option. Although the new standard has not
6048 yet been issued (as of early 2005), many features have been discussed and
6049 approved in ``Ada Issues'' (AI's). For the text of these AI's, see
6050 @url{www.ada-auth.org/cgi-bin/cvsweb.cgi/AIs}. Included with GNAT
6051 releases is a file @file{features-ada0y} that describes the current set
6052 of implemented Ada 2005 features.
6054 If these features are used in Ada 95 mode (which is the normal default),
6055 then error messages or warnings may be
6056 generated, reflecting the fact that these new features are otherwise
6057 unauthorized extensions to Ada 95. The use of the @option{-gnat05}
6058 switch (or an equivalent pragma) causes these messages to be suppressed.
6060 Note that some specialized releases of GNAT (notably the GAP academic
6061 version) have Ada 2005 mode on by default, and in such environments,
6062 the Ada 2005 features can be used freely without the use of switches.
6066 @node Character Set Control
6067 @subsection Character Set Control
6069 @item ^-gnati^/IDENTIFIER_CHARACTER_SET=^@var{c}
6070 @cindex @option{^-gnati^/IDENTIFIER_CHARACTER_SET^} (@command{gcc})
6073 Normally GNAT recognizes the Latin-1 character set in source program
6074 identifiers, as described in the Ada 95 Reference Manual.
6076 GNAT to recognize alternate character sets in identifiers. @var{c} is a
6077 single character ^^or word^ indicating the character set, as follows:
6081 ISO 8859-1 (Latin-1) identifiers
6084 ISO 8859-2 (Latin-2) letters allowed in identifiers
6087 ISO 8859-3 (Latin-3) letters allowed in identifiers
6090 ISO 8859-4 (Latin-4) letters allowed in identifiers
6093 ISO 8859-5 (Cyrillic) letters allowed in identifiers
6096 ISO 8859-15 (Latin-9) letters allowed in identifiers
6099 IBM PC letters (code page 437) allowed in identifiers
6102 IBM PC letters (code page 850) allowed in identifiers
6104 @item ^f^FULL_UPPER^
6105 Full upper-half codes allowed in identifiers
6108 No upper-half codes allowed in identifiers
6111 Wide-character codes (that is, codes greater than 255)
6112 allowed in identifiers
6115 @xref{Foreign Language Representation}, for full details on the
6116 implementation of these character sets.
6118 @item ^-gnatW^/WIDE_CHARACTER_ENCODING=^@var{e}
6119 @cindex @option{^-gnatW^/WIDE_CHARACTER_ENCODING^} (@command{gcc})
6120 Specify the method of encoding for wide characters.
6121 @var{e} is one of the following:
6126 Hex encoding (brackets coding also recognized)
6129 Upper half encoding (brackets encoding also recognized)
6132 Shift/JIS encoding (brackets encoding also recognized)
6135 EUC encoding (brackets encoding also recognized)
6138 UTF-8 encoding (brackets encoding also recognized)
6141 Brackets encoding only (default value)
6143 For full details on the these encoding
6144 methods see @ref{Wide Character Encodings}.
6145 Note that brackets coding is always accepted, even if one of the other
6146 options is specified, so for example @option{-gnatW8} specifies that both
6147 brackets and @code{UTF-8} encodings will be recognized. The units that are
6148 with'ed directly or indirectly will be scanned using the specified
6149 representation scheme, and so if one of the non-brackets scheme is
6150 used, it must be used consistently throughout the program. However,
6151 since brackets encoding is always recognized, it may be conveniently
6152 used in standard libraries, allowing these libraries to be used with
6153 any of the available coding schemes.
6154 scheme. If no @option{-gnatW?} parameter is present, then the default
6155 representation is Brackets encoding only.
6157 Note that the wide character representation that is specified (explicitly
6158 or by default) for the main program also acts as the default encoding used
6159 for Wide_Text_IO files if not specifically overridden by a WCEM form
6163 @node File Naming Control
6164 @subsection File Naming Control
6167 @item ^-gnatk^/FILE_NAME_MAX_LENGTH=^@var{n}
6168 @cindex @option{-gnatk} (@command{gcc})
6169 Activates file name ``krunching''. @var{n}, a decimal integer in the range
6170 1-999, indicates the maximum allowable length of a file name (not
6171 including the @file{.ads} or @file{.adb} extension). The default is not
6172 to enable file name krunching.
6174 For the source file naming rules, @xref{File Naming Rules}.
6177 @node Subprogram Inlining Control
6178 @subsection Subprogram Inlining Control
6183 @cindex @option{-gnatn} (@command{gcc})
6185 The @code{n} here is intended to suggest the first syllable of the
6188 GNAT recognizes and processes @code{Inline} pragmas. However, for the
6189 inlining to actually occur, optimization must be enabled. To enable
6190 inlining of subprograms specified by pragma @code{Inline},
6191 you must also specify this switch.
6192 In the absence of this switch, GNAT does not attempt
6193 inlining and does not need to access the bodies of
6194 subprograms for which @code{pragma Inline} is specified if they are not
6195 in the current unit.
6197 If you specify this switch the compiler will access these bodies,
6198 creating an extra source dependency for the resulting object file, and
6199 where possible, the call will be inlined.
6200 For further details on when inlining is possible
6201 see @ref{Inlining of Subprograms}.
6204 @cindex @option{-gnatN} (@command{gcc})
6205 The front end inlining activated by this switch is generally more extensive,
6206 and quite often more effective than the standard @option{-gnatn} inlining mode.
6207 It will also generate additional dependencies.
6209 @option{-gnatN} automatically implies @option{-gnatn} so it is not necessary
6210 to specify both options.
6213 @node Auxiliary Output Control
6214 @subsection Auxiliary Output Control
6218 @cindex @option{-gnatt} (@command{gcc})
6219 @cindex Writing internal trees
6220 @cindex Internal trees, writing to file
6221 Causes GNAT to write the internal tree for a unit to a file (with the
6222 extension @file{.adt}.
6223 This not normally required, but is used by separate analysis tools.
6225 these tools do the necessary compilations automatically, so you should
6226 not have to specify this switch in normal operation.
6229 @cindex @option{-gnatu} (@command{gcc})
6230 Print a list of units required by this compilation on @file{stdout}.
6231 The listing includes all units on which the unit being compiled depends
6232 either directly or indirectly.
6235 @item -pass-exit-codes
6236 @cindex @option{-pass-exit-codes} (@command{gcc})
6237 If this switch is not used, the exit code returned by @command{gcc} when
6238 compiling multiple files indicates whether all source files have
6239 been successfully used to generate object files or not.
6241 When @option{-pass-exit-codes} is used, @command{gcc} exits with an extended
6242 exit status and allows an integrated development environment to better
6243 react to a compilation failure. Those exit status are:
6247 There was an error in at least one source file.
6249 At least one source file did not generate an object file.
6251 The compiler died unexpectedly (internal error for example).
6253 An object file has been generated for every source file.
6258 @node Debugging Control
6259 @subsection Debugging Control
6263 @cindex Debugging options
6266 @cindex @option{-gnatd} (@command{gcc})
6267 Activate internal debugging switches. @var{x} is a letter or digit, or
6268 string of letters or digits, which specifies the type of debugging
6269 outputs desired. Normally these are used only for internal development
6270 or system debugging purposes. You can find full documentation for these
6271 switches in the body of the @code{Debug} unit in the compiler source
6272 file @file{debug.adb}.
6276 @cindex @option{-gnatG} (@command{gcc})
6277 This switch causes the compiler to generate auxiliary output containing
6278 a pseudo-source listing of the generated expanded code. Like most Ada
6279 compilers, GNAT works by first transforming the high level Ada code into
6280 lower level constructs. For example, tasking operations are transformed
6281 into calls to the tasking run-time routines. A unique capability of GNAT
6282 is to list this expanded code in a form very close to normal Ada source.
6283 This is very useful in understanding the implications of various Ada
6284 usage on the efficiency of the generated code. There are many cases in
6285 Ada (e.g. the use of controlled types), where simple Ada statements can
6286 generate a lot of run-time code. By using @option{-gnatG} you can identify
6287 these cases, and consider whether it may be desirable to modify the coding
6288 approach to improve efficiency.
6290 The format of the output is very similar to standard Ada source, and is
6291 easily understood by an Ada programmer. The following special syntactic
6292 additions correspond to low level features used in the generated code that
6293 do not have any exact analogies in pure Ada source form. The following
6294 is a partial list of these special constructions. See the specification
6295 of package @code{Sprint} in file @file{sprint.ads} for a full list.
6298 @item new @var{xxx} [storage_pool = @var{yyy}]
6299 Shows the storage pool being used for an allocator.
6301 @item at end @var{procedure-name};
6302 Shows the finalization (cleanup) procedure for a scope.
6304 @item (if @var{expr} then @var{expr} else @var{expr})
6305 Conditional expression equivalent to the @code{x?y:z} construction in C.
6307 @item @var{target}^^^(@var{source})
6308 A conversion with floating-point truncation instead of rounding.
6310 @item @var{target}?(@var{source})
6311 A conversion that bypasses normal Ada semantic checking. In particular
6312 enumeration types and fixed-point types are treated simply as integers.
6314 @item @var{target}?^^^(@var{source})
6315 Combines the above two cases.
6317 @item @var{x} #/ @var{y}
6318 @itemx @var{x} #mod @var{y}
6319 @itemx @var{x} #* @var{y}
6320 @itemx @var{x} #rem @var{y}
6321 A division or multiplication of fixed-point values which are treated as
6322 integers without any kind of scaling.
6324 @item free @var{expr} [storage_pool = @var{xxx}]
6325 Shows the storage pool associated with a @code{free} statement.
6327 @item freeze @var{typename} [@var{actions}]
6328 Shows the point at which @var{typename} is frozen, with possible
6329 associated actions to be performed at the freeze point.
6331 @item reference @var{itype}
6332 Reference (and hence definition) to internal type @var{itype}.
6334 @item @var{function-name}! (@var{arg}, @var{arg}, @var{arg})
6335 Intrinsic function call.
6337 @item @var{labelname} : label
6338 Declaration of label @var{labelname}.
6340 @item @var{expr} && @var{expr} && @var{expr} ... && @var{expr}
6341 A multiple concatenation (same effect as @var{expr} & @var{expr} &
6342 @var{expr}, but handled more efficiently).
6344 @item [constraint_error]
6345 Raise the @code{Constraint_Error} exception.
6347 @item @var{expression}'reference
6348 A pointer to the result of evaluating @var{expression}.
6350 @item @var{target-type}!(@var{source-expression})
6351 An unchecked conversion of @var{source-expression} to @var{target-type}.
6353 @item [@var{numerator}/@var{denominator}]
6354 Used to represent internal real literals (that) have no exact
6355 representation in base 2-16 (for example, the result of compile time
6356 evaluation of the expression 1.0/27.0).
6360 @cindex @option{-gnatD} (@command{gcc})
6361 When used in conjunction with @option{-gnatG}, this switch causes
6362 the expanded source, as described above for
6363 @option{-gnatG} to be written to files with names
6364 @file{^xxx.dg^XXX_DG^}, where @file{xxx} is the normal file name,
6365 instead of to the standard ooutput file. For
6366 example, if the source file name is @file{hello.adb}, then a file
6367 @file{^hello.adb.dg^HELLO.ADB_DG^} will be written. The debugging
6368 information generated by the @command{gcc} @option{^-g^/DEBUG^} switch
6369 will refer to the generated @file{^xxx.dg^XXX_DG^} file. This allows
6370 you to do source level debugging using the generated code which is
6371 sometimes useful for complex code, for example to find out exactly
6372 which part of a complex construction raised an exception. This switch
6373 also suppress generation of cross-reference information (see
6374 @option{-gnatx}) since otherwise the cross-reference information
6375 would refer to the @file{^.dg^.DG^} file, which would cause
6376 confusion since this is not the original source file.
6378 Note that @option{-gnatD} actually implies @option{-gnatG}
6379 automatically, so it is not necessary to give both options.
6380 In other words @option{-gnatD} is equivalent to @option{-gnatDG}).
6383 @item -gnatR[0|1|2|3[s]]
6384 @cindex @option{-gnatR} (@command{gcc})
6385 This switch controls output from the compiler of a listing showing
6386 representation information for declared types and objects. For
6387 @option{-gnatR0}, no information is output (equivalent to omitting
6388 the @option{-gnatR} switch). For @option{-gnatR1} (which is the default,
6389 so @option{-gnatR} with no parameter has the same effect), size and alignment
6390 information is listed for declared array and record types. For
6391 @option{-gnatR2}, size and alignment information is listed for all
6392 expression information for values that are computed at run time for
6393 variant records. These symbolic expressions have a mostly obvious
6394 format with #n being used to represent the value of the n'th
6395 discriminant. See source files @file{repinfo.ads/adb} in the
6396 @code{GNAT} sources for full details on the format of @option{-gnatR3}
6397 output. If the switch is followed by an s (e.g. @option{-gnatR2s}), then
6398 the output is to a file with the name @file{^file.rep^file_REP^} where
6399 file is the name of the corresponding source file.
6402 @item /REPRESENTATION_INFO
6403 @cindex @option{/REPRESENTATION_INFO} (@command{gcc})
6404 This qualifier controls output from the compiler of a listing showing
6405 representation information for declared types and objects. For
6406 @option{/REPRESENTATION_INFO=NONE}, no information is output
6407 (equivalent to omitting the @option{/REPRESENTATION_INFO} qualifier).
6408 @option{/REPRESENTATION_INFO} without option is equivalent to
6409 @option{/REPRESENTATION_INFO=ARRAYS}.
6410 For @option{/REPRESENTATION_INFO=ARRAYS}, size and alignment
6411 information is listed for declared array and record types. For
6412 @option{/REPRESENTATION_INFO=OBJECTS}, size and alignment information
6413 is listed for all expression information for values that are computed
6414 at run time for variant records. These symbolic expressions have a mostly
6415 obvious format with #n being used to represent the value of the n'th
6416 discriminant. See source files @file{REPINFO.ADS/ADB} in the
6417 @code{GNAT} sources for full details on the format of
6418 @option{/REPRESENTATION_INFO=SYMBOLIC} output.
6419 If _FILE is added at the end of an option
6420 (e.g. @option{/REPRESENTATION_INFO=ARRAYS_FILE}),
6421 then the output is to a file with the name @file{file_REP} where
6422 file is the name of the corresponding source file.
6426 @cindex @option{-gnatS} (@command{gcc})
6427 The use of the switch @option{-gnatS} for an
6428 Ada compilation will cause the compiler to output a
6429 representation of package Standard in a form very
6430 close to standard Ada. It is not quite possible to
6431 do this entirely in standard Ada (since new
6432 numeric base types cannot be created in standard
6433 Ada), but the output is easily
6434 readable to any Ada programmer, and is useful to
6435 determine the characteristics of target dependent
6436 types in package Standard.
6439 @cindex @option{-gnatx} (@command{gcc})
6440 Normally the compiler generates full cross-referencing information in
6441 the @file{ALI} file. This information is used by a number of tools,
6442 including @code{gnatfind} and @code{gnatxref}. The @option{-gnatx} switch
6443 suppresses this information. This saves some space and may slightly
6444 speed up compilation, but means that these tools cannot be used.
6447 @node Exception Handling Control
6448 @subsection Exception Handling Control
6451 GNAT uses two methods for handling exceptions at run-time. The
6452 @code{setjmp/longjmp} method saves the context when entering
6453 a frame with an exception handler. Then when an exception is
6454 raised, the context can be restored immediately, without the
6455 need for tracing stack frames. This method provides very fast
6456 exception propagation, but introduces significant overhead for
6457 the use of exception handlers, even if no exception is raised.
6459 The other approach is called ``zero cost'' exception handling.
6460 With this method, the compiler builds static tables to describe
6461 the exception ranges. No dynamic code is required when entering
6462 a frame containing an exception handler. When an exception is
6463 raised, the tables are used to control a back trace of the
6464 subprogram invocation stack to locate the required exception
6465 handler. This method has considerably poorer performance for
6466 the propagation of exceptions, but there is no overhead for
6467 exception handlers if no exception is raised. Note that in this
6468 mode and in the context of mixed Ada and C/C++ programming,
6469 to propagate an exception through a C/C++ code, the C/C++ code
6470 must be compiled with the @option{-funwind-tables} GCC's
6473 The following switches can be used to control which of the
6474 two exception handling methods is used.
6480 @cindex @option{--RTS=sjlj} (@command{gnatmake})
6481 This switch causes the setjmp/longjmp run-time to be used
6482 for exception handling. If this is the default mechanism for the
6483 target (see below), then this has no effect. If the default
6484 mechanism for the target is zero cost exceptions, then
6485 this switch can be used to modify this default, and must be
6486 used for all units in the partition.
6487 This option is rarely used. One case in which it may be
6488 advantageous is if you have an application where exception
6489 raising is common and the overall performance of the
6490 application is improved by favoring exception propagation.
6493 @cindex @option{--RTS=zcx} (@command{gnatmake})
6494 @cindex Zero Cost Exceptions
6495 This switch causes the zero cost approach to be used
6496 for exception handling. If this is the default mechanism for the
6497 target (see below), then this has no effect. If the default
6498 mechanism for the target is setjmp/longjmp exceptions, then
6499 this switch can be used to modify this default, and must be
6500 used for all units in the partition.
6501 This option can only be used if the zero cost approach
6502 is available for the target in use (see below).
6506 The @code{setjmp/longjmp} approach is available on all targets, while
6507 the @code{zero cost} approach is available on selected targets.
6508 To determine whether zero cost exceptions can be used for a
6509 particular target, look at the private part of the file system.ads.
6510 Either @code{GCC_ZCX_Support} or @code{Front_End_ZCX_Support} must
6511 be True to use the zero cost approach. If both of these switches
6512 are set to False, this means that zero cost exception handling
6513 is not yet available for that target. The switch
6514 @code{ZCX_By_Default} indicates the default approach. If this
6515 switch is set to True, then the @code{zero cost} approach is
6518 @node Units to Sources Mapping Files
6519 @subsection Units to Sources Mapping Files
6523 @item -gnatem^^=^@var{path}
6524 @cindex @option{-gnatem} (@command{gcc})
6525 A mapping file is a way to communicate to the compiler two mappings:
6526 from unit names to file names (without any directory information) and from
6527 file names to path names (with full directory information). These mappings
6528 are used by the compiler to short-circuit the path search.
6530 The use of mapping files is not required for correct operation of the
6531 compiler, but mapping files can improve efficiency, particularly when
6532 sources are read over a slow network connection. In normal operation,
6533 you need not be concerned with the format or use of mapping files,
6534 and the @option{-gnatem} switch is not a switch that you would use
6535 explicitly. it is intended only for use by automatic tools such as
6536 @command{gnatmake} running under the project file facility. The
6537 description here of the format of mapping files is provided
6538 for completeness and for possible use by other tools.
6540 A mapping file is a sequence of sets of three lines. In each set,
6541 the first line is the unit name, in lower case, with ``@code{%s}''
6543 specifications and ``@code{%b}'' appended for bodies; the second line is the
6544 file name; and the third line is the path name.
6550 /gnat/project1/sources/main.2.ada
6553 When the switch @option{-gnatem} is specified, the compiler will create
6554 in memory the two mappings from the specified file. If there is any problem
6555 (non existent file, truncated file or duplicate entries), no mapping
6558 Several @option{-gnatem} switches may be specified; however, only the last
6559 one on the command line will be taken into account.
6561 When using a project file, @command{gnatmake} create a temporary mapping file
6562 and communicates it to the compiler using this switch.
6566 @node Integrated Preprocessing
6567 @subsection Integrated Preprocessing
6570 GNAT sources may be preprocessed immediately before compilation; the actual
6571 text of the source is not the text of the source file, but is derived from it
6572 through a process called preprocessing. Integrated preprocessing is specified
6573 through switches @option{-gnatep} and/or @option{-gnateD}. @option{-gnatep}
6574 indicates, through a text file, the preprocessing data to be used.
6575 @option{-gnateD} specifies or modifies the values of preprocessing symbol.
6578 It is recommended that @command{gnatmake} switch ^-s^/SWITCH_CHECK^ should be
6579 used when Integrated Preprocessing is used. The reason is that preprocessing
6580 with another Preprocessing Data file without changing the sources will
6581 not trigger recompilation without this switch.
6584 Note that @command{gnatmake} switch ^-m^/MINIMAL_RECOMPILATION^ will almost
6585 always trigger recompilation for sources that are preprocessed,
6586 because @command{gnatmake} cannot compute the checksum of the source after
6590 The actual preprocessing function is described in details in section
6591 @ref{Preprocessing Using gnatprep}. This section only describes how integrated
6592 preprocessing is triggered and parameterized.
6596 @item -gnatep=@var{file}
6597 @cindex @option{-gnatep} (@command{gcc})
6598 This switch indicates to the compiler the file name (without directory
6599 information) of the preprocessor data file to use. The preprocessor data file
6600 should be found in the source directories.
6603 A preprocessing data file is a text file with significant lines indicating
6604 how should be preprocessed either a specific source or all sources not
6605 mentioned in other lines. A significant line is a non empty, non comment line.
6606 Comments are similar to Ada comments.
6609 Each significant line starts with either a literal string or the character '*'.
6610 A literal string is the file name (without directory information) of the source
6611 to preprocess. A character '*' indicates the preprocessing for all the sources
6612 that are not specified explicitly on other lines (order of the lines is not
6613 significant). It is an error to have two lines with the same file name or two
6614 lines starting with the character '*'.
6617 After the file name or the character '*', another optional literal string
6618 indicating the file name of the definition file to be used for preprocessing
6619 (@pxref{Form of Definitions File}). The definition files are found by the
6620 compiler in one of the source directories. In some cases, when compiling
6621 a source in a directory other than the current directory, if the definition
6622 file is in the current directory, it may be necessary to add the current
6623 directory as a source directory through switch ^-I.^/SEARCH=[]^, otherwise
6624 the compiler would not find the definition file.
6627 Then, optionally, ^switches^switches^ similar to those of @code{gnatprep} may
6628 be found. Those ^switches^switches^ are:
6633 Causes both preprocessor lines and the lines deleted by
6634 preprocessing to be replaced by blank lines, preserving the line number.
6635 This ^switch^switch^ is always implied; however, if specified after @option{-c}
6636 it cancels the effect of @option{-c}.
6639 Causes both preprocessor lines and the lines deleted
6640 by preprocessing to be retained as comments marked
6641 with the special string ``@code{--! }''.
6643 @item -Dsymbol=value
6644 Define or redefine a symbol, associated with value. A symbol is an Ada
6645 identifier, or an Ada reserved word, with the exception of @code{if},
6646 @code{else}, @code{elsif}, @code{end}, @code{and}, @code{or} and @code{then}.
6647 @code{value} is either a literal string, an Ada identifier or any Ada reserved
6648 word. A symbol declared with this ^switch^switch^ replaces a symbol with the
6649 same name defined in a definition file.
6652 Causes a sorted list of symbol names and values to be
6653 listed on the standard output file.
6656 Causes undefined symbols to be treated as having the value @code{FALSE}
6658 of a preprocessor test. In the absence of this option, an undefined symbol in
6659 a @code{#if} or @code{#elsif} test will be treated as an error.
6664 Examples of valid lines in a preprocessor data file:
6667 "toto.adb" "prep.def" -u
6668 -- preprocess "toto.adb", using definition file "prep.def",
6669 -- undefined symbol are False.
6672 -- preprocess all other sources without a definition file;
6673 -- suppressed lined are commented; symbol VERSION has the value V101.
6675 "titi.adb" "prep2.def" -s
6676 -- preprocess "titi.adb", using definition file "prep2.def";
6677 -- list all symbols with their values.
6680 @item ^-gnateD^/DATA_PREPROCESSING=^symbol[=value]
6681 @cindex @option{-gnateD} (@command{gcc})
6682 Define or redefine a preprocessing symbol, associated with value. If no value
6683 is given on the command line, then the value of the symbol is @code{True}.
6684 A symbol is an identifier, following normal Ada (case-insensitive)
6685 rules for its syntax, and value is any sequence (including an empty sequence)
6686 of characters from the set (letters, digits, period, underline).
6687 Ada reserved words may be used as symbols, with the exceptions of @code{if},
6688 @code{else}, @code{elsif}, @code{end}, @code{and}, @code{or} and @code{then}.
6691 A symbol declared with this ^switch^switch^ on the command line replaces a
6692 symbol with the same name either in a definition file or specified with a
6693 ^switch^switch^ -D in the preprocessor data file.
6696 This switch is similar to switch @option{^-D^/ASSOCIATE^} of @code{gnatprep}.
6700 @node Code Generation Control
6701 @subsection Code Generation Control
6705 The GCC technology provides a wide range of target dependent
6706 @option{-m} switches for controlling
6707 details of code generation with respect to different versions of
6708 architectures. This includes variations in instruction sets (e.g.
6709 different members of the power pc family), and different requirements
6710 for optimal arrangement of instructions (e.g. different members of
6711 the x86 family). The list of available @option{-m} switches may be
6712 found in the GCC documentation.
6714 Use of the these @option{-m} switches may in some cases result in improved
6717 The GNAT Pro technology is tested and qualified without any
6718 @option{-m} switches,
6719 so generally the most reliable approach is to avoid the use of these
6720 switches. However, we generally expect most of these switches to work
6721 successfully with GNAT Pro, and many customers have reported successful
6722 use of these options.
6724 Our general advice is to avoid the use of @option{-m} switches unless
6725 special needs lead to requirements in this area. In particular,
6726 there is no point in using @option{-m} switches to improve performance
6727 unless you actually see a performance improvement.
6731 @subsection Return Codes
6732 @cindex Return Codes
6733 @cindex @option{/RETURN_CODES=VMS}
6736 On VMS, GNAT compiled programs return POSIX-style codes by default,
6737 e.g. @option{/RETURN_CODES=POSIX}.
6739 To enable VMS style return codes, use GNAT BIND and LINK with the option
6740 @option{/RETURN_CODES=VMS}. For example:
6743 GNAT BIND MYMAIN.ALI /RETURN_CODES=VMS
6744 GNAT LINK MYMAIN.ALI /RETURN_CODES=VMS
6748 Programs built with /RETURN_CODES=VMS are suitable to be called in
6749 VMS DCL scripts. Programs compiled with the default /RETURN_CODES=POSIX
6750 are suitable for spawning with appropriate GNAT RTL routines.
6754 @node Search Paths and the Run-Time Library (RTL)
6755 @section Search Paths and the Run-Time Library (RTL)
6758 With the GNAT source-based library system, the compiler must be able to
6759 find source files for units that are needed by the unit being compiled.
6760 Search paths are used to guide this process.
6762 The compiler compiles one source file whose name must be given
6763 explicitly on the command line. In other words, no searching is done
6764 for this file. To find all other source files that are needed (the most
6765 common being the specs of units), the compiler examines the following
6766 directories, in the following order:
6770 The directory containing the source file of the main unit being compiled
6771 (the file name on the command line).
6774 Each directory named by an @option{^-I^/SOURCE_SEARCH^} switch given on the
6775 @command{gcc} command line, in the order given.
6778 @findex ADA_PRJ_INCLUDE_FILE
6779 Each of the directories listed in the text file whose name is given
6780 by the @code{ADA_PRJ_INCLUDE_FILE} ^environment variable^logical name^.
6783 @code{ADA_PRJ_INCLUDE_FILE} is normally set by gnatmake or by the ^gnat^GNAT^
6784 driver when project files are used. It should not normally be set
6788 @findex ADA_INCLUDE_PATH
6789 Each of the directories listed in the value of the
6790 @code{ADA_INCLUDE_PATH} ^environment variable^logical name^.
6792 Construct this value
6793 exactly as the @code{PATH} environment variable: a list of directory
6794 names separated by colons (semicolons when working with the NT version).
6797 Normally, define this value as a logical name containing a comma separated
6798 list of directory names.
6800 This variable can also be defined by means of an environment string
6801 (an argument to the DEC C exec* set of functions).
6805 DEFINE ANOTHER_PATH FOO:[BAG]
6806 DEFINE ADA_INCLUDE_PATH ANOTHER_PATH,FOO:[BAM],FOO:[BAR]
6809 By default, the path includes GNU:[LIB.OPENVMS7_x.2_8_x.DECLIB]
6810 first, followed by the standard Ada 95
6811 libraries in GNU:[LIB.OPENVMS7_x.2_8_x.ADAINCLUDE].
6812 If this is not redefined, the user will obtain the DEC Ada 83 IO packages
6813 (Text_IO, Sequential_IO, etc)
6814 instead of the Ada95 packages. Thus, in order to get the Ada 95
6815 packages by default, ADA_INCLUDE_PATH must be redefined.
6819 The content of the @file{ada_source_path} file which is part of the GNAT
6820 installation tree and is used to store standard libraries such as the
6821 GNAT Run Time Library (RTL) source files.
6823 @ref{Installing a library}
6828 Specifying the switch @option{^-I-^/NOCURRENT_DIRECTORY^}
6829 inhibits the use of the directory
6830 containing the source file named in the command line. You can still
6831 have this directory on your search path, but in this case it must be
6832 explicitly requested with a @option{^-I^/SOURCE_SEARCH^} switch.
6834 Specifying the switch @option{-nostdinc}
6835 inhibits the search of the default location for the GNAT Run Time
6836 Library (RTL) source files.
6838 The compiler outputs its object files and ALI files in the current
6841 Caution: The object file can be redirected with the @option{-o} switch;
6842 however, @command{gcc} and @code{gnat1} have not been coordinated on this
6843 so the @file{ALI} file will not go to the right place. Therefore, you should
6844 avoid using the @option{-o} switch.
6848 The packages @code{Ada}, @code{System}, and @code{Interfaces} and their
6849 children make up the GNAT RTL, together with the simple @code{System.IO}
6850 package used in the @code{"Hello World"} example. The sources for these units
6851 are needed by the compiler and are kept together in one directory. Not
6852 all of the bodies are needed, but all of the sources are kept together
6853 anyway. In a normal installation, you need not specify these directory
6854 names when compiling or binding. Either the environment variables or
6855 the built-in defaults cause these files to be found.
6857 In addition to the language-defined hierarchies (@code{System}, @code{Ada} and
6858 @code{Interfaces}), the GNAT distribution provides a fourth hierarchy,
6859 consisting of child units of @code{GNAT}. This is a collection of generally
6860 useful types, subprograms, etc. See the @cite{GNAT Reference Manual} for
6863 Besides simplifying access to the RTL, a major use of search paths is
6864 in compiling sources from multiple directories. This can make
6865 development environments much more flexible.
6867 @node Order of Compilation Issues
6868 @section Order of Compilation Issues
6871 If, in our earlier example, there was a spec for the @code{hello}
6872 procedure, it would be contained in the file @file{hello.ads}; yet this
6873 file would not have to be explicitly compiled. This is the result of the
6874 model we chose to implement library management. Some of the consequences
6875 of this model are as follows:
6879 There is no point in compiling specs (except for package
6880 specs with no bodies) because these are compiled as needed by clients. If
6881 you attempt a useless compilation, you will receive an error message.
6882 It is also useless to compile subunits because they are compiled as needed
6886 There are no order of compilation requirements: performing a
6887 compilation never obsoletes anything. The only way you can obsolete
6888 something and require recompilations is to modify one of the
6889 source files on which it depends.
6892 There is no library as such, apart from the ALI files
6893 (@pxref{The Ada Library Information Files}, for information on the format
6894 of these files). For now we find it convenient to create separate ALI files,
6895 but eventually the information therein may be incorporated into the object
6899 When you compile a unit, the source files for the specs of all units
6900 that it @code{with}'s, all its subunits, and the bodies of any generics it
6901 instantiates must be available (reachable by the search-paths mechanism
6902 described above), or you will receive a fatal error message.
6909 The following are some typical Ada compilation command line examples:
6912 @item $ gcc -c xyz.adb
6913 Compile body in file @file{xyz.adb} with all default options.
6916 @item $ gcc -c -O2 -gnata xyz-def.adb
6919 @item $ GNAT COMPILE /OPTIMIZE=ALL -gnata xyz-def.adb
6922 Compile the child unit package in file @file{xyz-def.adb} with extensive
6923 optimizations, and pragma @code{Assert}/@code{Debug} statements
6926 @item $ gcc -c -gnatc abc-def.adb
6927 Compile the subunit in file @file{abc-def.adb} in semantic-checking-only
6931 @node Binding Using gnatbind
6932 @chapter Binding Using @code{gnatbind}
6936 * Running gnatbind::
6937 * Switches for gnatbind::
6938 * Command-Line Access::
6939 * Search Paths for gnatbind::
6940 * Examples of gnatbind Usage::
6944 This chapter describes the GNAT binder, @code{gnatbind}, which is used
6945 to bind compiled GNAT objects. The @code{gnatbind} program performs
6946 four separate functions:
6950 Checks that a program is consistent, in accordance with the rules in
6951 Chapter 10 of the Ada 95 Reference Manual. In particular, error
6952 messages are generated if a program uses inconsistent versions of a
6956 Checks that an acceptable order of elaboration exists for the program
6957 and issues an error message if it cannot find an order of elaboration
6958 that satisfies the rules in Chapter 10 of the Ada 95 Language Manual.
6961 Generates a main program incorporating the given elaboration order.
6962 This program is a small Ada package (body and spec) that
6963 must be subsequently compiled
6964 using the GNAT compiler. The necessary compilation step is usually
6965 performed automatically by @command{gnatlink}. The two most important
6966 functions of this program
6967 are to call the elaboration routines of units in an appropriate order
6968 and to call the main program.
6971 Determines the set of object files required by the given main program.
6972 This information is output in the forms of comments in the generated program,
6973 to be read by the @command{gnatlink} utility used to link the Ada application.
6976 @node Running gnatbind
6977 @section Running @code{gnatbind}
6980 The form of the @code{gnatbind} command is
6983 $ gnatbind [@i{switches}] @i{mainprog}[.ali] [@i{switches}]
6987 where @file{@i{mainprog}.adb} is the Ada file containing the main program
6988 unit body. If no switches are specified, @code{gnatbind} constructs an Ada
6989 package in two files whose names are
6990 @file{b~@i{mainprog}.ads}, and @file{b~@i{mainprog}.adb}.
6991 For example, if given the
6992 parameter @file{hello.ali}, for a main program contained in file
6993 @file{hello.adb}, the binder output files would be @file{b~hello.ads}
6994 and @file{b~hello.adb}.
6996 When doing consistency checking, the binder takes into consideration
6997 any source files it can locate. For example, if the binder determines
6998 that the given main program requires the package @code{Pack}, whose
7000 file is @file{pack.ali} and whose corresponding source spec file is
7001 @file{pack.ads}, it attempts to locate the source file @file{pack.ads}
7002 (using the same search path conventions as previously described for the
7003 @command{gcc} command). If it can locate this source file, it checks that
7005 or source checksums of the source and its references to in @file{ALI} files
7006 match. In other words, any @file{ALI} files that mentions this spec must have
7007 resulted from compiling this version of the source file (or in the case
7008 where the source checksums match, a version close enough that the
7009 difference does not matter).
7011 @cindex Source files, use by binder
7012 The effect of this consistency checking, which includes source files, is
7013 that the binder ensures that the program is consistent with the latest
7014 version of the source files that can be located at bind time. Editing a
7015 source file without compiling files that depend on the source file cause
7016 error messages to be generated by the binder.
7018 For example, suppose you have a main program @file{hello.adb} and a
7019 package @code{P}, from file @file{p.ads} and you perform the following
7024 Enter @code{gcc -c hello.adb} to compile the main program.
7027 Enter @code{gcc -c p.ads} to compile package @code{P}.
7030 Edit file @file{p.ads}.
7033 Enter @code{gnatbind hello}.
7037 At this point, the file @file{p.ali} contains an out-of-date time stamp
7038 because the file @file{p.ads} has been edited. The attempt at binding
7039 fails, and the binder generates the following error messages:
7042 error: "hello.adb" must be recompiled ("p.ads" has been modified)
7043 error: "p.ads" has been modified and must be recompiled
7047 Now both files must be recompiled as indicated, and then the bind can
7048 succeed, generating a main program. You need not normally be concerned
7049 with the contents of this file, but for reference purposes a sample
7050 binder output file is given in @ref{Example of Binder Output File}.
7052 In most normal usage, the default mode of @command{gnatbind} which is to
7053 generate the main package in Ada, as described in the previous section.
7054 In particular, this means that any Ada programmer can read and understand
7055 the generated main program. It can also be debugged just like any other
7056 Ada code provided the @option{^-g^/DEBUG^} switch is used for
7057 @command{gnatbind} and @command{gnatlink}.
7059 However for some purposes it may be convenient to generate the main
7060 program in C rather than Ada. This may for example be helpful when you
7061 are generating a mixed language program with the main program in C. The
7062 GNAT compiler itself is an example.
7063 The use of the @option{^-C^/BIND_FILE=C^} switch
7064 for both @code{gnatbind} and @command{gnatlink} will cause the program to
7065 be generated in C (and compiled using the gnu C compiler).
7067 @node Switches for gnatbind
7068 @section Switches for @command{gnatbind}
7071 The following switches are available with @code{gnatbind}; details will
7072 be presented in subsequent sections.
7075 * Consistency-Checking Modes::
7076 * Binder Error Message Control::
7077 * Elaboration Control::
7079 * Binding with Non-Ada Main Programs::
7080 * Binding Programs with No Main Subprogram::
7085 @item ^-aO^/OBJECT_SEARCH^
7086 @cindex @option{^-aO^/OBJECT_SEARCH^} (@command{gnatbind})
7087 Specify directory to be searched for ALI files.
7089 @item ^-aI^/SOURCE_SEARCH^
7090 @cindex @option{^-aI^/SOURCE_SEARCH^} (@command{gnatbind})
7091 Specify directory to be searched for source file.
7093 @item ^-A^/BIND_FILE=ADA^
7094 @cindex @option{^-A^/BIND_FILE=ADA^} (@command{gnatbind})
7095 Generate binder program in Ada (default)
7097 @item ^-b^/REPORT_ERRORS=BRIEF^
7098 @cindex @option{^-b^/REPORT_ERRORS=BRIEF^} (@command{gnatbind})
7099 Generate brief messages to @file{stderr} even if verbose mode set.
7101 @item ^-c^/NOOUTPUT^
7102 @cindex @option{^-c^/NOOUTPUT^} (@command{gnatbind})
7103 Check only, no generation of binder output file.
7105 @item ^-C^/BIND_FILE=C^
7106 @cindex @option{^-C^/BIND_FILE=C^} (@command{gnatbind})
7107 Generate binder program in C
7109 @item ^-e^/ELABORATION_DEPENDENCIES^
7110 @cindex @option{^-e^/ELABORATION_DEPENDENCIES^} (@command{gnatbind})
7111 Output complete list of elaboration-order dependencies.
7113 @item ^-E^/STORE_TRACEBACKS^
7114 @cindex @option{^-E^/STORE_TRACEBACKS^} (@command{gnatbind})
7115 Store tracebacks in exception occurrences when the target supports it.
7116 This is the default with the zero cost exception mechanism.
7118 @c The following may get moved to an appendix
7119 This option is currently supported on the following targets:
7120 all x86 ports, Solaris, Windows, HP-UX, AIX, PowerPC VxWorks and Alpha VxWorks.
7122 See also the packages @code{GNAT.Traceback} and
7123 @code{GNAT.Traceback.Symbolic} for more information.
7125 Note that on x86 ports, you must not use @option{-fomit-frame-pointer}
7126 @command{gcc} option.
7129 @item ^-F^/FORCE_ELABS_FLAGS^
7130 @cindex @option{^-F^/FORCE_ELABS_FLAGS^} (@command{gnatbind})
7131 Force the checks of elaboration flags. @command{gnatbind} does not normally
7132 generate checks of elaboration flags for the main executable, except when
7133 a Stand-Alone Library is used. However, there are cases when this cannot be
7134 detected by gnatbind. An example is importing an interface of a Stand-Alone
7135 Library through a pragma Import and only specifying through a linker switch
7136 this Stand-Alone Library. This switch is used to guarantee that elaboration
7137 flag checks are generated.
7140 @cindex @option{^-h^/HELP^} (@command{gnatbind})
7141 Output usage (help) information
7144 @cindex @option{^-I^/SEARCH^} (@command{gnatbind})
7145 Specify directory to be searched for source and ALI files.
7147 @item ^-I-^/NOCURRENT_DIRECTORY^
7148 @cindex @option{^-I-^/NOCURRENT_DIRECTORY^} (@command{gnatbind})
7149 Do not look for sources in the current directory where @code{gnatbind} was
7150 invoked, and do not look for ALI files in the directory containing the
7151 ALI file named in the @code{gnatbind} command line.
7153 @item ^-l^/ORDER_OF_ELABORATION^
7154 @cindex @option{^-l^/ORDER_OF_ELABORATION^} (@command{gnatbind})
7155 Output chosen elaboration order.
7157 @item ^-Lxxx^/BUILD_LIBRARY=xxx^
7158 @cindex @option{^-L^/BUILD_LIBRARY^} (@command{gnatbind})
7159 Bind the units for library building. In this case the adainit and
7160 adafinal procedures (@pxref{Binding with Non-Ada Main Programs})
7161 are renamed to ^xxxinit^XXXINIT^ and
7162 ^xxxfinal^XXXFINAL^.
7163 Implies ^-n^/NOCOMPILE^.
7165 (@xref{GNAT and Libraries}, for more details.)
7168 On OpenVMS, these init and final procedures are exported in uppercase
7169 letters. For example if /BUILD_LIBRARY=toto is used, the exported name of
7170 the init procedure will be "TOTOINIT" and the exported name of the final
7171 procedure will be "TOTOFINAL".
7174 @item ^-Mxyz^/RENAME_MAIN=xyz^
7175 @cindex @option{^-M^/RENAME_MAIN^} (@command{gnatbind})
7176 Rename generated main program from main to xyz
7178 @item ^-m^/ERROR_LIMIT=^@var{n}
7179 @cindex @option{^-m^/ERROR_LIMIT^} (@command{gnatbind})
7180 Limit number of detected errors to @var{n}, where @var{n} is
7181 in the range 1..999_999. The default value if no switch is
7182 given is 9999. Binding is terminated if the limit is exceeded.
7184 Furthermore, under Windows, the sources pointed to by the libraries path
7185 set in the registry are not searched for.
7189 @cindex @option{^-n^/NOMAIN^} (@command{gnatbind})
7193 @cindex @option{-nostdinc} (@command{gnatbind})
7194 Do not look for sources in the system default directory.
7197 @cindex @option{-nostdlib} (@command{gnatbind})
7198 Do not look for library files in the system default directory.
7200 @item --RTS=@var{rts-path}
7201 @cindex @option{--RTS} (@code{gnatbind})
7202 Specifies the default location of the runtime library. Same meaning as the
7203 equivalent @command{gnatmake} flag (@pxref{Switches for gnatmake}).
7205 @item ^-o ^/OUTPUT=^@var{file}
7206 @cindex @option{^-o ^/OUTPUT^} (@command{gnatbind})
7207 Name the output file @var{file} (default is @file{b~@var{xxx}.adb}).
7208 Note that if this option is used, then linking must be done manually,
7209 gnatlink cannot be used.
7211 @item ^-O^/OBJECT_LIST^
7212 @cindex @option{^-O^/OBJECT_LIST^} (@command{gnatbind})
7215 @item ^-p^/PESSIMISTIC_ELABORATION^
7216 @cindex @option{^-p^/PESSIMISTIC_ELABORATION^} (@command{gnatbind})
7217 Pessimistic (worst-case) elaboration order
7219 @item ^-s^/READ_SOURCES=ALL^
7220 @cindex @option{^-s^/READ_SOURCES=ALL^} (@command{gnatbind})
7221 Require all source files to be present.
7223 @item ^-S@var{xxx}^/INITIALIZE_SCALARS=@var{xxx}^
7224 @cindex @option{^-S^/INITIALIZE_SCALARS^} (@command{gnatbind})
7225 Specifies the value to be used when detecting uninitialized scalar
7226 objects with pragma Initialize_Scalars.
7227 The @var{xxx} ^string specified with the switch^option^ may be either
7229 @item ``@option{^in^INVALID^}'' requesting an invalid value where possible
7230 @item ``@option{^lo^LOW^}'' for the lowest possible value
7231 @item ``@option{^hi^HIGH^}'' for the highest possible value
7232 @item ``@option{xx}'' for a value consisting of repeated bytes with the
7233 value 16#xx# (i.e. xx is a string of two hexadecimal digits).
7236 In addition, you can specify @option{-Sev} to indicate that the value is
7237 to be set at run time. In this case, the program will look for an environment
7238 @cindex GNAT_INIT_SCALARS
7239 variable of the form @code{GNAT_INIT_SCALARS=xx}, where xx is one
7240 of @option{in/lo/hi/xx} with the same meanings as above.
7241 If no environment variable is found, or if it does not have a valid value,
7242 then the default is @option{in} (invalid values).
7246 @cindex @option{-static} (@code{gnatbind})
7247 Link against a static GNAT run time.
7250 @cindex @option{-shared} (@code{gnatbind})
7251 Link against a shared GNAT run time when available.
7254 @item ^-t^/NOTIME_STAMP_CHECK^
7255 @cindex @option{^-t^/NOTIME_STAMP_CHECK^} (@code{gnatbind})
7256 Tolerate time stamp and other consistency errors
7258 @item ^-T@var{n}^/TIME_SLICE=@var{n}^
7259 @cindex @option{^-T^/TIME_SLICE^} (@code{gnatbind})
7260 Set the time slice value to @var{n} milliseconds. If the system supports
7261 the specification of a specific time slice value, then the indicated value
7262 is used. If the system does not support specific time slice values, but
7263 does support some general notion of round-robin scheduling, then any
7264 non-zero value will activate round-robin scheduling.
7266 A value of zero is treated specially. It turns off time
7267 slicing, and in addition, indicates to the tasking run time that the
7268 semantics should match as closely as possible the Annex D
7269 requirements of the Ada RM, and in particular sets the default
7270 scheduling policy to @code{FIFO_Within_Priorities}.
7272 @item ^-v^/REPORT_ERRORS=VERBOSE^
7273 @cindex @option{^-v^/REPORT_ERRORS=VERBOSE^} (@code{gnatbind})
7274 Verbose mode. Write error messages, header, summary output to
7279 @cindex @option{-w} (@code{gnatbind})
7280 Warning mode (@var{x}=s/e for suppress/treat as error)
7284 @item /WARNINGS=NORMAL
7285 @cindex @option{/WARNINGS} (@code{gnatbind})
7286 Normal warnings mode. Warnings are issued but ignored
7288 @item /WARNINGS=SUPPRESS
7289 @cindex @option{/WARNINGS} (@code{gnatbind})
7290 All warning messages are suppressed
7292 @item /WARNINGS=ERROR
7293 @cindex @option{/WARNINGS} (@code{gnatbind})
7294 Warning messages are treated as fatal errors
7297 @item ^-x^/READ_SOURCES=NONE^
7298 @cindex @option{^-x^/READ_SOURCES^} (@code{gnatbind})
7299 Exclude source files (check object consistency only).
7302 @item /READ_SOURCES=AVAILABLE
7303 @cindex @option{/READ_SOURCES} (@code{gnatbind})
7304 Default mode, in which sources are checked for consistency only if
7308 @item ^-z^/ZERO_MAIN^
7309 @cindex @option{^-z^/ZERO_MAIN^} (@code{gnatbind})
7315 You may obtain this listing of switches by running @code{gnatbind} with
7319 @node Consistency-Checking Modes
7320 @subsection Consistency-Checking Modes
7323 As described earlier, by default @code{gnatbind} checks
7324 that object files are consistent with one another and are consistent
7325 with any source files it can locate. The following switches control binder
7330 @item ^-s^/READ_SOURCES=ALL^
7331 @cindex @option{^-s^/READ_SOURCES=ALL^} (@code{gnatbind})
7332 Require source files to be present. In this mode, the binder must be
7333 able to locate all source files that are referenced, in order to check
7334 their consistency. In normal mode, if a source file cannot be located it
7335 is simply ignored. If you specify this switch, a missing source
7338 @item ^-x^/READ_SOURCES=NONE^
7339 @cindex @option{^-x^/READ_SOURCES=NONE^} (@code{gnatbind})
7340 Exclude source files. In this mode, the binder only checks that ALI
7341 files are consistent with one another. Source files are not accessed.
7342 The binder runs faster in this mode, and there is still a guarantee that
7343 the resulting program is self-consistent.
7344 If a source file has been edited since it was last compiled, and you
7345 specify this switch, the binder will not detect that the object
7346 file is out of date with respect to the source file. Note that this is the
7347 mode that is automatically used by @command{gnatmake} because in this
7348 case the checking against sources has already been performed by
7349 @command{gnatmake} in the course of compilation (i.e. before binding).
7352 @item /READ_SOURCES=AVAILABLE
7353 @cindex @code{/READ_SOURCES=AVAILABLE} (@code{gnatbind})
7354 This is the default mode in which source files are checked if they are
7355 available, and ignored if they are not available.
7359 @node Binder Error Message Control
7360 @subsection Binder Error Message Control
7363 The following switches provide control over the generation of error
7364 messages from the binder:
7368 @item ^-v^/REPORT_ERRORS=VERBOSE^
7369 @cindex @option{^-v^/REPORT_ERRORS=VERBOSE^} (@code{gnatbind})
7370 Verbose mode. In the normal mode, brief error messages are generated to
7371 @file{stderr}. If this switch is present, a header is written
7372 to @file{stdout} and any error messages are directed to @file{stdout}.
7373 All that is written to @file{stderr} is a brief summary message.
7375 @item ^-b^/REPORT_ERRORS=BRIEF^
7376 @cindex @option{^-b^/REPORT_ERRORS=BRIEF^} (@code{gnatbind})
7377 Generate brief error messages to @file{stderr} even if verbose mode is
7378 specified. This is relevant only when used with the
7379 @option{^-v^/REPORT_ERRORS=VERBOSE^} switch.
7383 @cindex @option{-m} (@code{gnatbind})
7384 Limits the number of error messages to @var{n}, a decimal integer in the
7385 range 1-999. The binder terminates immediately if this limit is reached.
7388 @cindex @option{-M} (@code{gnatbind})
7389 Renames the generated main program from @code{main} to @code{xxx}.
7390 This is useful in the case of some cross-building environments, where
7391 the actual main program is separate from the one generated
7395 @item ^-ws^/WARNINGS=SUPPRESS^
7396 @cindex @option{^-ws^/WARNINGS=SUPPRESS^} (@code{gnatbind})
7398 Suppress all warning messages.
7400 @item ^-we^/WARNINGS=ERROR^
7401 @cindex @option{^-we^/WARNINGS=ERROR^} (@code{gnatbind})
7402 Treat any warning messages as fatal errors.
7405 @item /WARNINGS=NORMAL
7406 Standard mode with warnings generated, but warnings do not get treated
7410 @item ^-t^/NOTIME_STAMP_CHECK^
7411 @cindex @option{^-t^/NOTIME_STAMP_CHECK^} (@code{gnatbind})
7412 @cindex Time stamp checks, in binder
7413 @cindex Binder consistency checks
7414 @cindex Consistency checks, in binder
7415 The binder performs a number of consistency checks including:
7419 Check that time stamps of a given source unit are consistent
7421 Check that checksums of a given source unit are consistent
7423 Check that consistent versions of @code{GNAT} were used for compilation
7425 Check consistency of configuration pragmas as required
7429 Normally failure of such checks, in accordance with the consistency
7430 requirements of the Ada Reference Manual, causes error messages to be
7431 generated which abort the binder and prevent the output of a binder
7432 file and subsequent link to obtain an executable.
7434 The @option{^-t^/NOTIME_STAMP_CHECK^} switch converts these error messages
7435 into warnings, so that
7436 binding and linking can continue to completion even in the presence of such
7437 errors. The result may be a failed link (due to missing symbols), or a
7438 non-functional executable which has undefined semantics.
7439 @emph{This means that
7440 @option{^-t^/NOTIME_STAMP_CHECK^} should be used only in unusual situations,
7444 @node Elaboration Control
7445 @subsection Elaboration Control
7448 The following switches provide additional control over the elaboration
7449 order. For full details see @ref{Elaboration Order Handling in GNAT}.
7452 @item ^-p^/PESSIMISTIC_ELABORATION^
7453 @cindex @option{^-p^/PESSIMISTIC_ELABORATION^} (@code{gnatbind})
7454 Normally the binder attempts to choose an elaboration order that is
7455 likely to minimize the likelihood of an elaboration order error resulting
7456 in raising a @code{Program_Error} exception. This switch reverses the
7457 action of the binder, and requests that it deliberately choose an order
7458 that is likely to maximize the likelihood of an elaboration error.
7459 This is useful in ensuring portability and avoiding dependence on
7460 accidental fortuitous elaboration ordering.
7462 Normally it only makes sense to use the @option{^-p^/PESSIMISTIC_ELABORATION^}
7464 elaboration checking is used (@option{-gnatE} switch used for compilation).
7465 This is because in the default static elaboration mode, all necessary
7466 @code{Elaborate_All} pragmas are implicitly inserted.
7467 These implicit pragmas are still respected by the binder in
7468 @option{^-p^/PESSIMISTIC_ELABORATION^} mode, so a
7469 safe elaboration order is assured.
7472 @node Output Control
7473 @subsection Output Control
7476 The following switches allow additional control over the output
7477 generated by the binder.
7482 @item ^-A^/BIND_FILE=ADA^
7483 @cindex @option{^-A^/BIND_FILE=ADA^} (@code{gnatbind})
7484 Generate binder program in Ada (default). The binder program is named
7485 @file{b~@var{mainprog}.adb} by default. This can be changed with
7486 @option{^-o^/OUTPUT^} @code{gnatbind} option.
7488 @item ^-c^/NOOUTPUT^
7489 @cindex @option{^-c^/NOOUTPUT^} (@code{gnatbind})
7490 Check only. Do not generate the binder output file. In this mode the
7491 binder performs all error checks but does not generate an output file.
7493 @item ^-C^/BIND_FILE=C^
7494 @cindex @option{^-C^/BIND_FILE=C^} (@code{gnatbind})
7495 Generate binder program in C. The binder program is named
7496 @file{b_@var{mainprog}.c}.
7497 This can be changed with @option{^-o^/OUTPUT^} @code{gnatbind}
7500 @item ^-e^/ELABORATION_DEPENDENCIES^
7501 @cindex @option{^-e^/ELABORATION_DEPENDENCIES^} (@code{gnatbind})
7502 Output complete list of elaboration-order dependencies, showing the
7503 reason for each dependency. This output can be rather extensive but may
7504 be useful in diagnosing problems with elaboration order. The output is
7505 written to @file{stdout}.
7508 @cindex @option{^-h^/HELP^} (@code{gnatbind})
7509 Output usage information. The output is written to @file{stdout}.
7511 @item ^-K^/LINKER_OPTION_LIST^
7512 @cindex @option{^-K^/LINKER_OPTION_LIST^} (@code{gnatbind})
7513 Output linker options to @file{stdout}. Includes library search paths,
7514 contents of pragmas Ident and Linker_Options, and libraries added
7517 @item ^-l^/ORDER_OF_ELABORATION^
7518 @cindex @option{^-l^/ORDER_OF_ELABORATION^} (@code{gnatbind})
7519 Output chosen elaboration order. The output is written to @file{stdout}.
7521 @item ^-O^/OBJECT_LIST^
7522 @cindex @option{^-O^/OBJECT_LIST^} (@code{gnatbind})
7523 Output full names of all the object files that must be linked to provide
7524 the Ada component of the program. The output is written to @file{stdout}.
7525 This list includes the files explicitly supplied and referenced by the user
7526 as well as implicitly referenced run-time unit files. The latter are
7527 omitted if the corresponding units reside in shared libraries. The
7528 directory names for the run-time units depend on the system configuration.
7530 @item ^-o ^/OUTPUT=^@var{file}
7531 @cindex @option{^-o^/OUTPUT^} (@code{gnatbind})
7532 Set name of output file to @var{file} instead of the normal
7533 @file{b~@var{mainprog}.adb} default. Note that @var{file} denote the Ada
7534 binder generated body filename. In C mode you would normally give
7535 @var{file} an extension of @file{.c} because it will be a C source program.
7536 Note that if this option is used, then linking must be done manually.
7537 It is not possible to use gnatlink in this case, since it cannot locate
7540 @item ^-r^/RESTRICTION_LIST^
7541 @cindex @option{^-r^/RESTRICTION_LIST^} (@code{gnatbind})
7542 Generate list of @code{pragma Restrictions} that could be applied to
7543 the current unit. This is useful for code audit purposes, and also may
7544 be used to improve code generation in some cases.
7548 @node Binding with Non-Ada Main Programs
7549 @subsection Binding with Non-Ada Main Programs
7552 In our description so far we have assumed that the main
7553 program is in Ada, and that the task of the binder is to generate a
7554 corresponding function @code{main} that invokes this Ada main
7555 program. GNAT also supports the building of executable programs where
7556 the main program is not in Ada, but some of the called routines are
7557 written in Ada and compiled using GNAT (@pxref{Mixed Language Programming}).
7558 The following switch is used in this situation:
7562 @cindex @option{^-n^/NOMAIN^} (@code{gnatbind})
7563 No main program. The main program is not in Ada.
7567 In this case, most of the functions of the binder are still required,
7568 but instead of generating a main program, the binder generates a file
7569 containing the following callable routines:
7574 You must call this routine to initialize the Ada part of the program by
7575 calling the necessary elaboration routines. A call to @code{adainit} is
7576 required before the first call to an Ada subprogram.
7578 Note that it is assumed that the basic execution environment must be setup
7579 to be appropriate for Ada execution at the point where the first Ada
7580 subprogram is called. In particular, if the Ada code will do any
7581 floating-point operations, then the FPU must be setup in an appropriate
7582 manner. For the case of the x86, for example, full precision mode is
7583 required. The procedure GNAT.Float_Control.Reset may be used to ensure
7584 that the FPU is in the right state.
7588 You must call this routine to perform any library-level finalization
7589 required by the Ada subprograms. A call to @code{adafinal} is required
7590 after the last call to an Ada subprogram, and before the program
7595 If the @option{^-n^/NOMAIN^} switch
7596 @cindex @option{^-n^/NOMAIN^} (@command{gnatbind})
7597 @cindex Binder, multiple input files
7598 is given, more than one ALI file may appear on
7599 the command line for @code{gnatbind}. The normal @dfn{closure}
7600 calculation is performed for each of the specified units. Calculating
7601 the closure means finding out the set of units involved by tracing
7602 @code{with} references. The reason it is necessary to be able to
7603 specify more than one ALI file is that a given program may invoke two or
7604 more quite separate groups of Ada units.
7606 The binder takes the name of its output file from the last specified ALI
7607 file, unless overridden by the use of the @option{^-o file^/OUTPUT=file^}.
7608 @cindex @option{^-o^/OUTPUT^} (@command{gnatbind})
7609 The output is an Ada unit in source form that can
7610 be compiled with GNAT unless the -C switch is used in which case the
7611 output is a C source file, which must be compiled using the C compiler.
7612 This compilation occurs automatically as part of the @command{gnatlink}
7615 Currently the GNAT run time requires a FPU using 80 bits mode
7616 precision. Under targets where this is not the default it is required to
7617 call GNAT.Float_Control.Reset before using floating point numbers (this
7618 include float computation, float input and output) in the Ada code. A
7619 side effect is that this could be the wrong mode for the foreign code
7620 where floating point computation could be broken after this call.
7622 @node Binding Programs with No Main Subprogram
7623 @subsection Binding Programs with No Main Subprogram
7626 It is possible to have an Ada program which does not have a main
7627 subprogram. This program will call the elaboration routines of all the
7628 packages, then the finalization routines.
7630 The following switch is used to bind programs organized in this manner:
7633 @item ^-z^/ZERO_MAIN^
7634 @cindex @option{^-z^/ZERO_MAIN^} (@code{gnatbind})
7635 Normally the binder checks that the unit name given on the command line
7636 corresponds to a suitable main subprogram. When this switch is used,
7637 a list of ALI files can be given, and the execution of the program
7638 consists of elaboration of these units in an appropriate order.
7641 @node Command-Line Access
7642 @section Command-Line Access
7645 The package @code{Ada.Command_Line} provides access to the command-line
7646 arguments and program name. In order for this interface to operate
7647 correctly, the two variables
7659 are declared in one of the GNAT library routines. These variables must
7660 be set from the actual @code{argc} and @code{argv} values passed to the
7661 main program. With no @option{^n^/NOMAIN^} present, @code{gnatbind}
7662 generates the C main program to automatically set these variables.
7663 If the @option{^n^/NOMAIN^} switch is used, there is no automatic way to
7664 set these variables. If they are not set, the procedures in
7665 @code{Ada.Command_Line} will not be available, and any attempt to use
7666 them will raise @code{Constraint_Error}. If command line access is
7667 required, your main program must set @code{gnat_argc} and
7668 @code{gnat_argv} from the @code{argc} and @code{argv} values passed to
7671 @node Search Paths for gnatbind
7672 @section Search Paths for @code{gnatbind}
7675 The binder takes the name of an ALI file as its argument and needs to
7676 locate source files as well as other ALI files to verify object consistency.
7678 For source files, it follows exactly the same search rules as @command{gcc}
7679 (@pxref{Search Paths and the Run-Time Library (RTL)}). For ALI files the
7680 directories searched are:
7684 The directory containing the ALI file named in the command line, unless
7685 the switch @option{^-I-^/NOCURRENT_DIRECTORY^} is specified.
7688 All directories specified by @option{^-I^/SEARCH^}
7689 switches on the @code{gnatbind}
7690 command line, in the order given.
7693 @findex ADA_PRJ_OBJECTS_FILE
7694 Each of the directories listed in the text file whose name is given
7695 by the @code{ADA_PRJ_OBJECTS_FILE} ^environment variable^logical name^.
7698 @code{ADA_PRJ_OBJECTS_FILE} is normally set by gnatmake or by the ^gnat^GNAT^
7699 driver when project files are used. It should not normally be set
7703 @findex ADA_OBJECTS_PATH
7704 Each of the directories listed in the value of the
7705 @code{ADA_OBJECTS_PATH} ^environment variable^logical name^.
7707 Construct this value
7708 exactly as the @code{PATH} environment variable: a list of directory
7709 names separated by colons (semicolons when working with the NT version
7713 Normally, define this value as a logical name containing a comma separated
7714 list of directory names.
7716 This variable can also be defined by means of an environment string
7717 (an argument to the DEC C exec* set of functions).
7721 DEFINE ANOTHER_PATH FOO:[BAG]
7722 DEFINE ADA_OBJECTS_PATH ANOTHER_PATH,FOO:[BAM],FOO:[BAR]
7725 By default, the path includes GNU:[LIB.OPENVMS7_x.2_8_x.DECLIB]
7726 first, followed by the standard Ada 95
7727 libraries in GNU:[LIB.OPENVMS7_x.2_8_x.ADALIB].
7728 If this is not redefined, the user will obtain the DEC Ada 83 IO packages
7729 (Text_IO, Sequential_IO, etc)
7730 instead of the Ada95 packages. Thus, in order to get the Ada 95
7731 packages by default, ADA_OBJECTS_PATH must be redefined.
7735 The content of the @file{ada_object_path} file which is part of the GNAT
7736 installation tree and is used to store standard libraries such as the
7737 GNAT Run Time Library (RTL) unless the switch @option{-nostdlib} is
7740 @ref{Installing a library}
7745 In the binder the switch @option{^-I^/SEARCH^}
7746 @cindex @option{^-I^/SEARCH^} (@command{gnatbind})
7747 is used to specify both source and
7748 library file paths. Use @option{^-aI^/SOURCE_SEARCH^}
7749 @cindex @option{^-aI^/SOURCE_SEARCH^} (@command{gnatbind})
7750 instead if you want to specify
7751 source paths only, and @option{^-aO^/LIBRARY_SEARCH^}
7752 @cindex @option{^-aO^/LIBRARY_SEARCH^} (@command{gnatbind})
7753 if you want to specify library paths
7754 only. This means that for the binder
7755 @option{^-I^/SEARCH=^}@var{dir} is equivalent to
7756 @option{^-aI^/SOURCE_SEARCH=^}@var{dir}
7757 @option{^-aO^/OBJECT_SEARCH=^}@var{dir}.
7758 The binder generates the bind file (a C language source file) in the
7759 current working directory.
7765 The packages @code{Ada}, @code{System}, and @code{Interfaces} and their
7766 children make up the GNAT Run-Time Library, together with the package
7767 GNAT and its children, which contain a set of useful additional
7768 library functions provided by GNAT. The sources for these units are
7769 needed by the compiler and are kept together in one directory. The ALI
7770 files and object files generated by compiling the RTL are needed by the
7771 binder and the linker and are kept together in one directory, typically
7772 different from the directory containing the sources. In a normal
7773 installation, you need not specify these directory names when compiling
7774 or binding. Either the environment variables or the built-in defaults
7775 cause these files to be found.
7777 Besides simplifying access to the RTL, a major use of search paths is
7778 in compiling sources from multiple directories. This can make
7779 development environments much more flexible.
7781 @node Examples of gnatbind Usage
7782 @section Examples of @code{gnatbind} Usage
7785 This section contains a number of examples of using the GNAT binding
7786 utility @code{gnatbind}.
7789 @item gnatbind hello
7790 The main program @code{Hello} (source program in @file{hello.adb}) is
7791 bound using the standard switch settings. The generated main program is
7792 @file{b~hello.adb}. This is the normal, default use of the binder.
7795 @item gnatbind hello -o mainprog.adb
7798 @item gnatbind HELLO.ALI /OUTPUT=Mainprog.ADB
7800 The main program @code{Hello} (source program in @file{hello.adb}) is
7801 bound using the standard switch settings. The generated main program is
7802 @file{mainprog.adb} with the associated spec in
7803 @file{mainprog.ads}. Note that you must specify the body here not the
7804 spec, in the case where the output is in Ada. Note that if this option
7805 is used, then linking must be done manually, since gnatlink will not
7806 be able to find the generated file.
7809 @item gnatbind main -C -o mainprog.c -x
7812 @item gnatbind MAIN.ALI /BIND_FILE=C /OUTPUT=Mainprog.C /READ_SOURCES=NONE
7814 The main program @code{Main} (source program in
7815 @file{main.adb}) is bound, excluding source files from the
7816 consistency checking, generating
7817 the file @file{mainprog.c}.
7820 @item gnatbind -x main_program -C -o mainprog.c
7821 This command is exactly the same as the previous example. Switches may
7822 appear anywhere in the command line, and single letter switches may be
7823 combined into a single switch.
7827 @item gnatbind -n math dbase -C -o ada-control.c
7830 @item gnatbind /NOMAIN math dbase /BIND_FILE=C /OUTPUT=ada-control.c
7832 The main program is in a language other than Ada, but calls to
7833 subprograms in packages @code{Math} and @code{Dbase} appear. This call
7834 to @code{gnatbind} generates the file @file{ada-control.c} containing
7835 the @code{adainit} and @code{adafinal} routines to be called before and
7836 after accessing the Ada units.
7839 @c ------------------------------------
7840 @node Linking Using gnatlink
7841 @chapter Linking Using @command{gnatlink}
7842 @c ------------------------------------
7846 This chapter discusses @command{gnatlink}, a tool that links
7847 an Ada program and builds an executable file. This utility
7848 invokes the system linker ^(via the @command{gcc} command)^^
7849 with a correct list of object files and library references.
7850 @command{gnatlink} automatically determines the list of files and
7851 references for the Ada part of a program. It uses the binder file
7852 generated by the @command{gnatbind} to determine this list.
7855 * Running gnatlink::
7856 * Switches for gnatlink::
7857 * Setting Stack Size from gnatlink::
7858 * Setting Heap Size from gnatlink::
7861 @node Running gnatlink
7862 @section Running @command{gnatlink}
7865 The form of the @command{gnatlink} command is
7868 $ gnatlink [@var{switches}] @var{mainprog}[.ali]
7869 [@var{non-Ada objects}] [@var{linker options}]
7873 The arguments of @command{gnatlink} (switches, main @file{ALI} file,
7875 or linker options) may be in any order, provided that no non-Ada object may
7876 be mistaken for a main @file{ALI} file.
7877 Any file name @file{F} without the @file{.ali}
7878 extension will be taken as the main @file{ALI} file if a file exists
7879 whose name is the concatenation of @file{F} and @file{.ali}.
7882 @file{@var{mainprog}.ali} references the ALI file of the main program.
7883 The @file{.ali} extension of this file can be omitted. From this
7884 reference, @command{gnatlink} locates the corresponding binder file
7885 @file{b~@var{mainprog}.adb} and, using the information in this file along
7886 with the list of non-Ada objects and linker options, constructs a
7887 linker command file to create the executable.
7889 The arguments other than the @command{gnatlink} switches and the main
7890 @file{ALI} file are passed to the linker uninterpreted.
7891 They typically include the names of
7892 object files for units written in other languages than Ada and any library
7893 references required to resolve references in any of these foreign language
7894 units, or in @code{Import} pragmas in any Ada units.
7896 @var{linker options} is an optional list of linker specific
7898 The default linker called by gnatlink is @var{gcc} which in
7899 turn calls the appropriate system linker.
7900 Standard options for the linker such as @option{-lmy_lib} or
7901 @option{-Ldir} can be added as is.
7902 For options that are not recognized by
7903 @var{gcc} as linker options, use the @var{gcc} switches @option{-Xlinker} or
7905 Refer to the GCC documentation for
7906 details. Here is an example showing how to generate a linker map:
7910 $ gnatlink my_prog -Wl,-Map,MAPFILE
7915 <<Need example for VMS>>
7918 Using @var{linker options} it is possible to set the program stack and
7919 heap size. See @ref{Setting Stack Size from gnatlink} and
7920 @ref{Setting Heap Size from gnatlink}.
7922 @command{gnatlink} determines the list of objects required by the Ada
7923 program and prepends them to the list of objects passed to the linker.
7924 @command{gnatlink} also gathers any arguments set by the use of
7925 @code{pragma Linker_Options} and adds them to the list of arguments
7926 presented to the linker.
7929 @command{gnatlink} accepts the following types of extra files on the command
7930 line: objects (.OBJ), libraries (.OLB), sharable images (.EXE), and
7931 options files (.OPT). These are recognized and handled according to their
7935 @node Switches for gnatlink
7936 @section Switches for @command{gnatlink}
7939 The following switches are available with the @command{gnatlink} utility:
7944 @item ^-A^/BIND_FILE=ADA^
7945 @cindex @option{^-A^/BIND_FILE=ADA^} (@command{gnatlink})
7946 The binder has generated code in Ada. This is the default.
7948 @item ^-C^/BIND_FILE=C^
7949 @cindex @option{^-C^/BIND_FILE=C^} (@command{gnatlink})
7950 If instead of generating a file in Ada, the binder has generated one in
7951 C, then the linker needs to know about it. Use this switch to signal
7952 to @command{gnatlink} that the binder has generated C code rather than
7955 @item ^-f^/FORCE_OBJECT_FILE_LIST^
7956 @cindex Command line length
7957 @cindex @option{^-f^/FORCE_OBJECT_FILE_LIST^} (@command{gnatlink})
7958 On some targets, the command line length is limited, and @command{gnatlink}
7959 will generate a separate file for the linker if the list of object files
7961 The @option{^-f^/FORCE_OBJECT_FILE_LIST^} switch forces this file
7962 to be generated even if
7963 the limit is not exceeded. This is useful in some cases to deal with
7964 special situations where the command line length is exceeded.
7967 @cindex Debugging information, including
7968 @cindex @option{^-g^/DEBUG^} (@command{gnatlink})
7969 The option to include debugging information causes the Ada bind file (in
7970 other words, @file{b~@var{mainprog}.adb}) to be compiled with
7971 @option{^-g^/DEBUG^}.
7972 In addition, the binder does not delete the @file{b~@var{mainprog}.adb},
7973 @file{b~@var{mainprog}.o} and @file{b~@var{mainprog}.ali} files.
7974 Without @option{^-g^/DEBUG^}, the binder removes these files by
7975 default. The same procedure apply if a C bind file was generated using
7976 @option{^-C^/BIND_FILE=C^} @code{gnatbind} option, in this case the filenames
7977 are @file{b_@var{mainprog}.c} and @file{b_@var{mainprog}.o}.
7979 @item ^-n^/NOCOMPILE^
7980 @cindex @option{^-n^/NOCOMPILE^} (@command{gnatlink})
7981 Do not compile the file generated by the binder. This may be used when
7982 a link is rerun with different options, but there is no need to recompile
7986 @cindex @option{^-v^/VERBOSE^} (@command{gnatlink})
7987 Causes additional information to be output, including a full list of the
7988 included object files. This switch option is most useful when you want
7989 to see what set of object files are being used in the link step.
7991 @item ^-v -v^/VERBOSE/VERBOSE^
7992 @cindex @option{^-v -v^/VERBOSE/VERBOSE^} (@command{gnatlink})
7993 Very verbose mode. Requests that the compiler operate in verbose mode when
7994 it compiles the binder file, and that the system linker run in verbose mode.
7996 @item ^-o ^/EXECUTABLE=^@var{exec-name}
7997 @cindex @option{^-o^/EXECUTABLE^} (@command{gnatlink})
7998 @var{exec-name} specifies an alternate name for the generated
7999 executable program. If this switch is omitted, the executable has the same
8000 name as the main unit. For example, @code{gnatlink try.ali} creates
8001 an executable called @file{^try^TRY.EXE^}.
8004 @item -b @var{target}
8005 @cindex @option{-b} (@command{gnatlink})
8006 Compile your program to run on @var{target}, which is the name of a
8007 system configuration. You must have a GNAT cross-compiler built if
8008 @var{target} is not the same as your host system.
8011 @cindex @option{-B} (@command{gnatlink})
8012 Load compiler executables (for example, @code{gnat1}, the Ada compiler)
8013 from @var{dir} instead of the default location. Only use this switch
8014 when multiple versions of the GNAT compiler are available. See the
8015 @command{gcc} manual page for further details. You would normally use the
8016 @option{-b} or @option{-V} switch instead.
8018 @item --GCC=@var{compiler_name}
8019 @cindex @option{--GCC=compiler_name} (@command{gnatlink})
8020 Program used for compiling the binder file. The default is
8021 @command{gcc}. You need to use quotes around @var{compiler_name} if
8022 @code{compiler_name} contains spaces or other separator characters. As
8023 an example @option{--GCC="foo -x -y"} will instruct @command{gnatlink} to use
8024 @code{foo -x -y} as your compiler. Note that switch @option{-c} is always
8025 inserted after your command name. Thus in the above example the compiler
8026 command that will be used by @command{gnatlink} will be @code{foo -c -x -y}.
8027 If several @option{--GCC=compiler_name} are used, only the last
8028 @var{compiler_name} is taken into account. However, all the additional
8029 switches are also taken into account. Thus,
8030 @option{--GCC="foo -x -y" --GCC="bar -z -t"} is equivalent to
8031 @option{--GCC="bar -x -y -z -t"}.
8033 @item --LINK=@var{name}
8034 @cindex @option{--LINK=} (@command{gnatlink})
8035 @var{name} is the name of the linker to be invoked. This is especially
8036 useful in mixed language programs since languages such as C++ require
8037 their own linker to be used. When this switch is omitted, the default
8038 name for the linker is @command{gcc}. When this switch is used, the
8039 specified linker is called instead of @command{gcc} with exactly the same
8040 parameters that would have been passed to @command{gcc} so if the desired
8041 linker requires different parameters it is necessary to use a wrapper
8042 script that massages the parameters before invoking the real linker. It
8043 may be useful to control the exact invocation by using the verbose
8049 @item /DEBUG=TRACEBACK
8050 @cindex @code{/DEBUG=TRACEBACK} (@command{gnatlink})
8051 This qualifier causes sufficient information to be included in the
8052 executable file to allow a traceback, but does not include the full
8053 symbol information needed by the debugger.
8055 @item /IDENTIFICATION="<string>"
8056 @code{"<string>"} specifies the string to be stored in the image file
8057 identification field in the image header.
8058 It overrides any pragma @code{Ident} specified string.
8060 @item /NOINHIBIT-EXEC
8061 Generate the executable file even if there are linker warnings.
8063 @item /NOSTART_FILES
8064 Don't link in the object file containing the ``main'' transfer address.
8065 Used when linking with a foreign language main program compiled with a
8069 Prefer linking with object libraries over sharable images, even without
8075 @node Setting Stack Size from gnatlink
8076 @section Setting Stack Size from @command{gnatlink}
8079 Under Windows systems, it is possible to specify the program stack size from
8080 @command{gnatlink} using either:
8084 @item using @option{-Xlinker} linker option
8087 $ gnatlink hello -Xlinker --stack=0x10000,0x1000
8090 This sets the stack reserve size to 0x10000 bytes and the stack commit
8091 size to 0x1000 bytes.
8093 @item using @option{-Wl} linker option
8096 $ gnatlink hello -Wl,--stack=0x1000000
8099 This sets the stack reserve size to 0x1000000 bytes. Note that with
8100 @option{-Wl} option it is not possible to set the stack commit size
8101 because the coma is a separator for this option.
8105 @node Setting Heap Size from gnatlink
8106 @section Setting Heap Size from @command{gnatlink}
8109 Under Windows systems, it is possible to specify the program heap size from
8110 @command{gnatlink} using either:
8114 @item using @option{-Xlinker} linker option
8117 $ gnatlink hello -Xlinker --heap=0x10000,0x1000
8120 This sets the heap reserve size to 0x10000 bytes and the heap commit
8121 size to 0x1000 bytes.
8123 @item using @option{-Wl} linker option
8126 $ gnatlink hello -Wl,--heap=0x1000000
8129 This sets the heap reserve size to 0x1000000 bytes. Note that with
8130 @option{-Wl} option it is not possible to set the heap commit size
8131 because the coma is a separator for this option.
8135 @node The GNAT Make Program gnatmake
8136 @chapter The GNAT Make Program @command{gnatmake}
8140 * Running gnatmake::
8141 * Switches for gnatmake::
8142 * Mode Switches for gnatmake::
8143 * Notes on the Command Line::
8144 * How gnatmake Works::
8145 * Examples of gnatmake Usage::
8148 A typical development cycle when working on an Ada program consists of
8149 the following steps:
8153 Edit some sources to fix bugs.
8159 Compile all sources affected.
8169 The third step can be tricky, because not only do the modified files
8170 @cindex Dependency rules
8171 have to be compiled, but any files depending on these files must also be
8172 recompiled. The dependency rules in Ada can be quite complex, especially
8173 in the presence of overloading, @code{use} clauses, generics and inlined
8176 @command{gnatmake} automatically takes care of the third and fourth steps
8177 of this process. It determines which sources need to be compiled,
8178 compiles them, and binds and links the resulting object files.
8180 Unlike some other Ada make programs, the dependencies are always
8181 accurately recomputed from the new sources. The source based approach of
8182 the GNAT compilation model makes this possible. This means that if
8183 changes to the source program cause corresponding changes in
8184 dependencies, they will always be tracked exactly correctly by
8187 @node Running gnatmake
8188 @section Running @command{gnatmake}
8191 The usual form of the @command{gnatmake} command is
8194 $ gnatmake [@var{switches}] @var{file_name}
8195 [@var{file_names}] [@var{mode_switches}]
8199 The only required argument is one @var{file_name}, which specifies
8200 a compilation unit that is a main program. Several @var{file_names} can be
8201 specified: this will result in several executables being built.
8202 If @code{switches} are present, they can be placed before the first
8203 @var{file_name}, between @var{file_names} or after the last @var{file_name}.
8204 If @var{mode_switches} are present, they must always be placed after
8205 the last @var{file_name} and all @code{switches}.
8207 If you are using standard file extensions (.adb and .ads), then the
8208 extension may be omitted from the @var{file_name} arguments. However, if
8209 you are using non-standard extensions, then it is required that the
8210 extension be given. A relative or absolute directory path can be
8211 specified in a @var{file_name}, in which case, the input source file will
8212 be searched for in the specified directory only. Otherwise, the input
8213 source file will first be searched in the directory where
8214 @command{gnatmake} was invoked and if it is not found, it will be search on
8215 the source path of the compiler as described in
8216 @ref{Search Paths and the Run-Time Library (RTL)}.
8218 All @command{gnatmake} output (except when you specify
8219 @option{^-M^/DEPENDENCIES_LIST^}) is to
8220 @file{stderr}. The output produced by the
8221 @option{^-M^/DEPENDENCIES_LIST^} switch is send to
8224 @node Switches for gnatmake
8225 @section Switches for @command{gnatmake}
8228 You may specify any of the following switches to @command{gnatmake}:
8233 @item --GCC=@var{compiler_name}
8234 @cindex @option{--GCC=compiler_name} (@command{gnatmake})
8235 Program used for compiling. The default is `@command{gcc}'. You need to use
8236 quotes around @var{compiler_name} if @code{compiler_name} contains
8237 spaces or other separator characters. As an example @option{--GCC="foo -x
8238 -y"} will instruct @command{gnatmake} to use @code{foo -x -y} as your
8239 compiler. Note that switch @option{-c} is always inserted after your
8240 command name. Thus in the above example the compiler command that will
8241 be used by @command{gnatmake} will be @code{foo -c -x -y}.
8242 If several @option{--GCC=compiler_name} are used, only the last
8243 @var{compiler_name} is taken into account. However, all the additional
8244 switches are also taken into account. Thus,
8245 @option{--GCC="foo -x -y" --GCC="bar -z -t"} is equivalent to
8246 @option{--GCC="bar -x -y -z -t"}.
8248 @item --GNATBIND=@var{binder_name}
8249 @cindex @option{--GNATBIND=binder_name} (@command{gnatmake})
8250 Program used for binding. The default is `@code{gnatbind}'. You need to
8251 use quotes around @var{binder_name} if @var{binder_name} contains spaces
8252 or other separator characters. As an example @option{--GNATBIND="bar -x
8253 -y"} will instruct @command{gnatmake} to use @code{bar -x -y} as your
8254 binder. Binder switches that are normally appended by @command{gnatmake} to
8255 `@code{gnatbind}' are now appended to the end of @code{bar -x -y}.
8257 @item --GNATLINK=@var{linker_name}
8258 @cindex @option{--GNATLINK=linker_name} (@command{gnatmake})
8259 Program used for linking. The default is `@command{gnatlink}'. You need to
8260 use quotes around @var{linker_name} if @var{linker_name} contains spaces
8261 or other separator characters. As an example @option{--GNATLINK="lan -x
8262 -y"} will instruct @command{gnatmake} to use @code{lan -x -y} as your
8263 linker. Linker switches that are normally appended by @command{gnatmake} to
8264 `@command{gnatlink}' are now appended to the end of @code{lan -x -y}.
8268 @item ^-a^/ALL_FILES^
8269 @cindex @option{^-a^/ALL_FILES^} (@command{gnatmake})
8270 Consider all files in the make process, even the GNAT internal system
8271 files (for example, the predefined Ada library files), as well as any
8272 locked files. Locked files are files whose ALI file is write-protected.
8274 @command{gnatmake} does not check these files,
8275 because the assumption is that the GNAT internal files are properly up
8276 to date, and also that any write protected ALI files have been properly
8277 installed. Note that if there is an installation problem, such that one
8278 of these files is not up to date, it will be properly caught by the
8280 You may have to specify this switch if you are working on GNAT
8281 itself. The switch @option{^-a^/ALL_FILES^} is also useful
8282 in conjunction with @option{^-f^/FORCE_COMPILE^}
8283 if you need to recompile an entire application,
8284 including run-time files, using special configuration pragmas,
8285 such as a @code{Normalize_Scalars} pragma.
8288 @code{gnatmake ^-a^/ALL_FILES^} compiles all GNAT
8291 @code{gcc -c -gnatpg} rather than @code{gcc -c}.
8294 the @code{/CHECKS=SUPPRESS_ALL /STYLE_CHECKS=GNAT} switch.
8297 @item ^-b^/ACTIONS=BIND^
8298 @cindex @option{^-b^/ACTIONS=BIND^} (@command{gnatmake})
8299 Bind only. Can be combined with @option{^-c^/ACTIONS=COMPILE^} to do
8300 compilation and binding, but no link.
8301 Can be combined with @option{^-l^/ACTIONS=LINK^}
8302 to do binding and linking. When not combined with
8303 @option{^-c^/ACTIONS=COMPILE^}
8304 all the units in the closure of the main program must have been previously
8305 compiled and must be up to date. The root unit specified by @var{file_name}
8306 may be given without extension, with the source extension or, if no GNAT
8307 Project File is specified, with the ALI file extension.
8309 @item ^-c^/ACTIONS=COMPILE^
8310 @cindex @option{^-c^/ACTIONS=COMPILE^} (@command{gnatmake})
8311 Compile only. Do not perform binding, except when @option{^-b^/ACTIONS=BIND^}
8312 is also specified. Do not perform linking, except if both
8313 @option{^-b^/ACTIONS=BIND^} and
8314 @option{^-l^/ACTIONS=LINK^} are also specified.
8315 If the root unit specified by @var{file_name} is not a main unit, this is the
8316 default. Otherwise @command{gnatmake} will attempt binding and linking
8317 unless all objects are up to date and the executable is more recent than
8321 @cindex @option{^-C^/MAPPING^} (@command{gnatmake})
8322 Use a temporary mapping file. A mapping file is a way to communicate to the
8323 compiler two mappings: from unit names to file names (without any directory
8324 information) and from file names to path names (with full directory
8325 information). These mappings are used by the compiler to short-circuit the path
8326 search. When @command{gnatmake} is invoked with this switch, it will create
8327 a temporary mapping file, initially populated by the project manager,
8328 if @option{^-P^/PROJECT_FILE^} is used, otherwise initially empty.
8329 Each invocation of the compiler will add the newly accessed sources to the
8330 mapping file. This will improve the source search during the next invocation
8333 @item ^-C=^/USE_MAPPING_FILE=^@var{file}
8334 @cindex @option{^-C=^/USE_MAPPING^} (@command{gnatmake})
8335 Use a specific mapping file. The file, specified as a path name (absolute or
8336 relative) by this switch, should already exist, otherwise the switch is
8337 ineffective. The specified mapping file will be communicated to the compiler.
8338 This switch is not compatible with a project file
8339 (^-P^/PROJECT_FILE=^@var{file}) or with multiple compiling processes
8340 (^-j^/PROCESSES=^nnn, when nnn is greater than 1).
8342 @item ^-D ^/DIRECTORY_OBJECTS=^@var{dir}
8343 @cindex @option{^-D^/DIRECTORY_OBJECTS^} (@command{gnatmake})
8344 Put all object files and ALI file in directory @var{dir}.
8345 If the @option{^-D^/DIRECTORY_OBJECTS^} switch is not used, all object files
8346 and ALI files go in the current working directory.
8348 This switch cannot be used when using a project file.
8352 @cindex @option{-eL} (@command{gnatmake})
8353 Follow all symbolic links when processing project files.
8356 @item ^-f^/FORCE_COMPILE^
8357 @cindex @option{^-f^/FORCE_COMPILE^} (@command{gnatmake})
8358 Force recompilations. Recompile all sources, even though some object
8359 files may be up to date, but don't recompile predefined or GNAT internal
8360 files or locked files (files with a write-protected ALI file),
8361 unless the @option{^-a^/ALL_FILES^} switch is also specified.
8363 @item ^-F^/FULL_PATH_IN_BRIEF_MESSAGES^
8364 @cindex @option{^-F^/FULL_PATH_IN_BRIEF_MESSAGES^} (@command{gnatmake})
8365 When using project files, if some errors or warnings are detected during
8366 parsing and verbose mode is not in effect (no use of switch
8367 ^-v^/VERBOSE^), then error lines start with the full path name of the project
8368 file, rather than its simple file name.
8370 @item ^-i^/IN_PLACE^
8371 @cindex @option{^-i^/IN_PLACE^} (@command{gnatmake})
8372 In normal mode, @command{gnatmake} compiles all object files and ALI files
8373 into the current directory. If the @option{^-i^/IN_PLACE^} switch is used,
8374 then instead object files and ALI files that already exist are overwritten
8375 in place. This means that once a large project is organized into separate
8376 directories in the desired manner, then @command{gnatmake} will automatically
8377 maintain and update this organization. If no ALI files are found on the
8378 Ada object path (@ref{Search Paths and the Run-Time Library (RTL)}),
8379 the new object and ALI files are created in the
8380 directory containing the source being compiled. If another organization
8381 is desired, where objects and sources are kept in different directories,
8382 a useful technique is to create dummy ALI files in the desired directories.
8383 When detecting such a dummy file, @command{gnatmake} will be forced to
8384 recompile the corresponding source file, and it will be put the resulting
8385 object and ALI files in the directory where it found the dummy file.
8387 @item ^-j^/PROCESSES=^@var{n}
8388 @cindex @option{^-j^/PROCESSES^} (@command{gnatmake})
8389 @cindex Parallel make
8390 Use @var{n} processes to carry out the (re)compilations. On a
8391 multiprocessor machine compilations will occur in parallel. In the
8392 event of compilation errors, messages from various compilations might
8393 get interspersed (but @command{gnatmake} will give you the full ordered
8394 list of failing compiles at the end). If this is problematic, rerun
8395 the make process with n set to 1 to get a clean list of messages.
8397 @item ^-k^/CONTINUE_ON_ERROR^
8398 @cindex @option{^-k^/CONTINUE_ON_ERROR^} (@command{gnatmake})
8399 Keep going. Continue as much as possible after a compilation error. To
8400 ease the programmer's task in case of compilation errors, the list of
8401 sources for which the compile fails is given when @command{gnatmake}
8404 If @command{gnatmake} is invoked with several @file{file_names} and with this
8405 switch, if there are compilation errors when building an executable,
8406 @command{gnatmake} will not attempt to build the following executables.
8408 @item ^-l^/ACTIONS=LINK^
8409 @cindex @option{^-l^/ACTIONS=LINK^} (@command{gnatmake})
8410 Link only. Can be combined with @option{^-b^/ACTIONS=BIND^} to binding
8411 and linking. Linking will not be performed if combined with
8412 @option{^-c^/ACTIONS=COMPILE^}
8413 but not with @option{^-b^/ACTIONS=BIND^}.
8414 When not combined with @option{^-b^/ACTIONS=BIND^}
8415 all the units in the closure of the main program must have been previously
8416 compiled and must be up to date, and the main program needs to have been bound.
8417 The root unit specified by @var{file_name}
8418 may be given without extension, with the source extension or, if no GNAT
8419 Project File is specified, with the ALI file extension.
8421 @item ^-m^/MINIMAL_RECOMPILATION^
8422 @cindex @option{^-m^/MINIMAL_RECOMPILATION^} (@command{gnatmake})
8423 Specify that the minimum necessary amount of recompilations
8424 be performed. In this mode @command{gnatmake} ignores time
8425 stamp differences when the only
8426 modifications to a source file consist in adding/removing comments,
8427 empty lines, spaces or tabs. This means that if you have changed the
8428 comments in a source file or have simply reformatted it, using this
8429 switch will tell gnatmake not to recompile files that depend on it
8430 (provided other sources on which these files depend have undergone no
8431 semantic modifications). Note that the debugging information may be
8432 out of date with respect to the sources if the @option{-m} switch causes
8433 a compilation to be switched, so the use of this switch represents a
8434 trade-off between compilation time and accurate debugging information.
8436 @item ^-M^/DEPENDENCIES_LIST^
8437 @cindex Dependencies, producing list
8438 @cindex @option{^-M^/DEPENDENCIES_LIST^} (@command{gnatmake})
8439 Check if all objects are up to date. If they are, output the object
8440 dependences to @file{stdout} in a form that can be directly exploited in
8441 a @file{Makefile}. By default, each source file is prefixed with its
8442 (relative or absolute) directory name. This name is whatever you
8443 specified in the various @option{^-aI^/SOURCE_SEARCH^}
8444 and @option{^-I^/SEARCH^} switches. If you use
8445 @code{gnatmake ^-M^/DEPENDENCIES_LIST^}
8446 @option{^-q^/QUIET^}
8447 (see below), only the source file names,
8448 without relative paths, are output. If you just specify the
8449 @option{^-M^/DEPENDENCIES_LIST^}
8450 switch, dependencies of the GNAT internal system files are omitted. This
8451 is typically what you want. If you also specify
8452 the @option{^-a^/ALL_FILES^} switch,
8453 dependencies of the GNAT internal files are also listed. Note that
8454 dependencies of the objects in external Ada libraries (see switch
8455 @option{^-aL^/SKIP_MISSING=^}@var{dir} in the following list)
8458 @item ^-n^/DO_OBJECT_CHECK^
8459 @cindex @option{^-n^/DO_OBJECT_CHECK^} (@command{gnatmake})
8460 Don't compile, bind, or link. Checks if all objects are up to date.
8461 If they are not, the full name of the first file that needs to be
8462 recompiled is printed.
8463 Repeated use of this option, followed by compiling the indicated source
8464 file, will eventually result in recompiling all required units.
8466 @item ^-o ^/EXECUTABLE=^@var{exec_name}
8467 @cindex @option{^-o^/EXECUTABLE^} (@command{gnatmake})
8468 Output executable name. The name of the final executable program will be
8469 @var{exec_name}. If the @option{^-o^/EXECUTABLE^} switch is omitted the default
8470 name for the executable will be the name of the input file in appropriate form
8471 for an executable file on the host system.
8473 This switch cannot be used when invoking @command{gnatmake} with several
8476 @item ^-P^/PROJECT_FILE=^@var{project}
8477 @cindex @option{^-P^/PROJECT_FILE^} (@command{gnatmake})
8478 Use project file @var{project}. Only one such switch can be used.
8479 @xref{gnatmake and Project Files}.
8482 @cindex @option{^-q^/QUIET^} (@command{gnatmake})
8483 Quiet. When this flag is not set, the commands carried out by
8484 @command{gnatmake} are displayed.
8486 @item ^-s^/SWITCH_CHECK/^
8487 @cindex @option{^-s^/SWITCH_CHECK^} (@command{gnatmake})
8488 Recompile if compiler switches have changed since last compilation.
8489 All compiler switches but -I and -o are taken into account in the
8491 orders between different ``first letter'' switches are ignored, but
8492 orders between same switches are taken into account. For example,
8493 @option{-O -O2} is different than @option{-O2 -O}, but @option{-g -O}
8494 is equivalent to @option{-O -g}.
8496 This switch is recommended when Integrated Preprocessing is used.
8499 @cindex @option{^-u^/UNIQUE^} (@command{gnatmake})
8500 Unique. Recompile at most the main files. It implies -c. Combined with
8501 -f, it is equivalent to calling the compiler directly. Note that using
8502 ^-u^/UNIQUE^ with a project file and no main has a special meaning
8503 (@pxref{Project Files and Main Subprograms}).
8505 @item ^-U^/ALL_PROJECTS^
8506 @cindex @option{^-U^/ALL_PROJECTS^} (@command{gnatmake})
8507 When used without a project file or with one or several mains on the command
8508 line, is equivalent to ^-u^/UNIQUE^. When used with a project file and no main
8509 on the command line, all sources of all project files are checked and compiled
8510 if not up to date, and libraries are rebuilt, if necessary.
8513 @cindex @option{^-v^/REASONS^} (@command{gnatmake})
8514 Verbose. Display the reason for all recompilations @command{gnatmake}
8515 decides are necessary.
8517 @item ^-vP^/MESSAGES_PROJECT_FILE=^@emph{x}
8518 Indicate the verbosity of the parsing of GNAT project files.
8519 @xref{Switches Related to Project Files}.
8521 @item ^-x^/NON_PROJECT_UNIT_COMPILATION^
8522 @cindex @option{^-x^/NON_PROJECT_UNIT_COMPILATION^} (@command{gnatmake})
8523 Indicate that sources that are not part of any Project File may be compiled.
8524 Normally, when using Project Files, only sources that are part of a Project
8525 File may be compile. When this switch is used, a source outside of all Project
8526 Files may be compiled. The ALI file and the object file will be put in the
8527 object directory of the main Project. The compilation switches used will only
8528 be those specified on the command line.
8530 @item ^-X^/EXTERNAL_REFERENCE=^@var{name=value}
8531 Indicate that external variable @var{name} has the value @var{value}.
8532 The Project Manager will use this value for occurrences of
8533 @code{external(name)} when parsing the project file.
8534 @xref{Switches Related to Project Files}.
8537 @cindex @option{^-z^/NOMAIN^} (@command{gnatmake})
8538 No main subprogram. Bind and link the program even if the unit name
8539 given on the command line is a package name. The resulting executable
8540 will execute the elaboration routines of the package and its closure,
8541 then the finalization routines.
8544 @cindex @option{^-g^/DEBUG^} (@command{gnatmake})
8545 Enable debugging. This switch is simply passed to the compiler and to the
8551 @item @command{gcc} @asis{switches}
8553 Any uppercase or multi-character switch that is not a @command{gnatmake} switch
8554 is passed to @command{gcc} (e.g. @option{-O}, @option{-gnato,} etc.)
8557 Any qualifier that cannot be recognized as a qualifier for @code{GNAT MAKE}
8558 but is recognizable as a valid qualifier for @code{GNAT COMPILE} is
8559 automatically treated as a compiler switch, and passed on to all
8560 compilations that are carried out.
8565 Source and library search path switches:
8569 @item ^-aI^/SOURCE_SEARCH=^@var{dir}
8570 @cindex @option{^-aI^/SOURCE_SEARCH^} (@command{gnatmake})
8571 When looking for source files also look in directory @var{dir}.
8572 The order in which source files search is undertaken is
8573 described in @ref{Search Paths and the Run-Time Library (RTL)}.
8575 @item ^-aL^/SKIP_MISSING=^@var{dir}
8576 @cindex @option{^-aL^/SKIP_MISSING^} (@command{gnatmake})
8577 Consider @var{dir} as being an externally provided Ada library.
8578 Instructs @command{gnatmake} to skip compilation units whose @file{.ALI}
8579 files have been located in directory @var{dir}. This allows you to have
8580 missing bodies for the units in @var{dir} and to ignore out of date bodies
8581 for the same units. You still need to specify
8582 the location of the specs for these units by using the switches
8583 @option{^-aI^/SOURCE_SEARCH=^@var{dir}}
8584 or @option{^-I^/SEARCH=^@var{dir}}.
8585 Note: this switch is provided for compatibility with previous versions
8586 of @command{gnatmake}. The easier method of causing standard libraries
8587 to be excluded from consideration is to write-protect the corresponding
8590 @item ^-aO^/OBJECT_SEARCH=^@var{dir}
8591 @cindex @option{^-aO^/OBJECT_SEARCH^} (@command{gnatmake})
8592 When searching for library and object files, look in directory
8593 @var{dir}. The order in which library files are searched is described in
8594 @ref{Search Paths for gnatbind}.
8596 @item ^-A^/CONDITIONAL_SOURCE_SEARCH=^@var{dir}
8597 @cindex Search paths, for @command{gnatmake}
8598 @cindex @option{^-A^/CONDITIONAL_SOURCE_SEARCH^} (@command{gnatmake})
8599 Equivalent to @option{^-aL^/SKIP_MISSING=^@var{dir}
8600 ^-aI^/SOURCE_SEARCH=^@var{dir}}.
8602 @item ^-I^/SEARCH=^@var{dir}
8603 @cindex @option{^-I^/SEARCH^} (@command{gnatmake})
8604 Equivalent to @option{^-aO^/OBJECT_SEARCH=^@var{dir}
8605 ^-aI^/SOURCE_SEARCH=^@var{dir}}.
8607 @item ^-I-^/NOCURRENT_DIRECTORY^
8608 @cindex @option{^-I-^/NOCURRENT_DIRECTORY^} (@command{gnatmake})
8609 @cindex Source files, suppressing search
8610 Do not look for source files in the directory containing the source
8611 file named in the command line.
8612 Do not look for ALI or object files in the directory
8613 where @command{gnatmake} was invoked.
8615 @item ^-L^/LIBRARY_SEARCH=^@var{dir}
8616 @cindex @option{^-L^/LIBRARY_SEARCH^} (@command{gnatmake})
8617 @cindex Linker libraries
8618 Add directory @var{dir} to the list of directories in which the linker
8619 will search for libraries. This is equivalent to
8620 @option{-largs ^-L^/LIBRARY_SEARCH=^}@var{dir}.
8622 Furthermore, under Windows, the sources pointed to by the libraries path
8623 set in the registry are not searched for.
8627 @cindex @option{-nostdinc} (@command{gnatmake})
8628 Do not look for source files in the system default directory.
8631 @cindex @option{-nostdlib} (@command{gnatmake})
8632 Do not look for library files in the system default directory.
8634 @item --RTS=@var{rts-path}
8635 @cindex @option{--RTS} (@command{gnatmake})
8636 Specifies the default location of the runtime library. GNAT looks for the
8638 in the following directories, and stops as soon as a valid runtime is found
8639 (@file{adainclude} or @file{ada_source_path}, and @file{adalib} or
8640 @file{ada_object_path} present):
8643 @item <current directory>/$rts_path
8645 @item <default-search-dir>/$rts_path
8647 @item <default-search-dir>/rts-$rts_path
8651 The selected path is handled like a normal RTS path.
8655 @node Mode Switches for gnatmake
8656 @section Mode Switches for @command{gnatmake}
8659 The mode switches (referred to as @code{mode_switches}) allow the
8660 inclusion of switches that are to be passed to the compiler itself, the
8661 binder or the linker. The effect of a mode switch is to cause all
8662 subsequent switches up to the end of the switch list, or up to the next
8663 mode switch, to be interpreted as switches to be passed on to the
8664 designated component of GNAT.
8668 @item -cargs @var{switches}
8669 @cindex @option{-cargs} (@command{gnatmake})
8670 Compiler switches. Here @var{switches} is a list of switches
8671 that are valid switches for @command{gcc}. They will be passed on to
8672 all compile steps performed by @command{gnatmake}.
8674 @item -bargs @var{switches}
8675 @cindex @option{-bargs} (@command{gnatmake})
8676 Binder switches. Here @var{switches} is a list of switches
8677 that are valid switches for @code{gnatbind}. They will be passed on to
8678 all bind steps performed by @command{gnatmake}.
8680 @item -largs @var{switches}
8681 @cindex @option{-largs} (@command{gnatmake})
8682 Linker switches. Here @var{switches} is a list of switches
8683 that are valid switches for @command{gnatlink}. They will be passed on to
8684 all link steps performed by @command{gnatmake}.
8686 @item -margs @var{switches}
8687 @cindex @option{-margs} (@command{gnatmake})
8688 Make switches. The switches are directly interpreted by @command{gnatmake},
8689 regardless of any previous occurrence of @option{-cargs}, @option{-bargs}
8693 @node Notes on the Command Line
8694 @section Notes on the Command Line
8697 This section contains some additional useful notes on the operation
8698 of the @command{gnatmake} command.
8702 @cindex Recompilation, by @command{gnatmake}
8703 If @command{gnatmake} finds no ALI files, it recompiles the main program
8704 and all other units required by the main program.
8705 This means that @command{gnatmake}
8706 can be used for the initial compile, as well as during subsequent steps of
8707 the development cycle.
8710 If you enter @code{gnatmake @var{file}.adb}, where @file{@var{file}.adb}
8711 is a subunit or body of a generic unit, @command{gnatmake} recompiles
8712 @file{@var{file}.adb} (because it finds no ALI) and stops, issuing a
8716 In @command{gnatmake} the switch @option{^-I^/SEARCH^}
8717 is used to specify both source and
8718 library file paths. Use @option{^-aI^/SOURCE_SEARCH^}
8719 instead if you just want to specify
8720 source paths only and @option{^-aO^/OBJECT_SEARCH^}
8721 if you want to specify library paths
8725 @command{gnatmake} will ignore any files whose ALI file is write-protected.
8726 This may conveniently be used to exclude standard libraries from
8727 consideration and in particular it means that the use of the
8728 @option{^-f^/FORCE_COMPILE^} switch will not recompile these files
8729 unless @option{^-a^/ALL_FILES^} is also specified.
8732 @command{gnatmake} has been designed to make the use of Ada libraries
8733 particularly convenient. Assume you have an Ada library organized
8734 as follows: @i{^obj-dir^[OBJ_DIR]^} contains the objects and ALI files for
8735 of your Ada compilation units,
8736 whereas @i{^include-dir^[INCLUDE_DIR]^} contains the
8737 specs of these units, but no bodies. Then to compile a unit
8738 stored in @code{main.adb}, which uses this Ada library you would just type
8742 $ gnatmake -aI@var{include-dir} -aL@var{obj-dir} main
8745 $ gnatmake /SOURCE_SEARCH=@i{[INCLUDE_DIR]}
8746 /SKIP_MISSING=@i{[OBJ_DIR]} main
8751 Using @command{gnatmake} along with the
8752 @option{^-m (minimal recompilation)^/MINIMAL_RECOMPILATION^}
8753 switch provides a mechanism for avoiding unnecessary rcompilations. Using
8755 you can update the comments/format of your
8756 source files without having to recompile everything. Note, however, that
8757 adding or deleting lines in a source files may render its debugging
8758 info obsolete. If the file in question is a spec, the impact is rather
8759 limited, as that debugging info will only be useful during the
8760 elaboration phase of your program. For bodies the impact can be more
8761 significant. In all events, your debugger will warn you if a source file
8762 is more recent than the corresponding object, and alert you to the fact
8763 that the debugging information may be out of date.
8766 @node How gnatmake Works
8767 @section How @command{gnatmake} Works
8770 Generally @command{gnatmake} automatically performs all necessary
8771 recompilations and you don't need to worry about how it works. However,
8772 it may be useful to have some basic understanding of the @command{gnatmake}
8773 approach and in particular to understand how it uses the results of
8774 previous compilations without incorrectly depending on them.
8776 First a definition: an object file is considered @dfn{up to date} if the
8777 corresponding ALI file exists and if all the source files listed in the
8778 dependency section of this ALI file have time stamps matching those in
8779 the ALI file. This means that neither the source file itself nor any
8780 files that it depends on have been modified, and hence there is no need
8781 to recompile this file.
8783 @command{gnatmake} works by first checking if the specified main unit is up
8784 to date. If so, no compilations are required for the main unit. If not,
8785 @command{gnatmake} compiles the main program to build a new ALI file that
8786 reflects the latest sources. Then the ALI file of the main unit is
8787 examined to find all the source files on which the main program depends,
8788 and @command{gnatmake} recursively applies the above procedure on all these
8791 This process ensures that @command{gnatmake} only trusts the dependencies
8792 in an existing ALI file if they are known to be correct. Otherwise it
8793 always recompiles to determine a new, guaranteed accurate set of
8794 dependencies. As a result the program is compiled ``upside down'' from what may
8795 be more familiar as the required order of compilation in some other Ada
8796 systems. In particular, clients are compiled before the units on which
8797 they depend. The ability of GNAT to compile in any order is critical in
8798 allowing an order of compilation to be chosen that guarantees that
8799 @command{gnatmake} will recompute a correct set of new dependencies if
8802 When invoking @command{gnatmake} with several @var{file_names}, if a unit is
8803 imported by several of the executables, it will be recompiled at most once.
8805 Note: when using non-standard naming conventions
8806 (@pxref{Using Other File Names}), changing through a configuration pragmas
8807 file the version of a source and invoking @command{gnatmake} to recompile may
8808 have no effect, if the previous version of the source is still accessible
8809 by @command{gnatmake}. It may be necessary to use the switch
8810 ^-f^/FORCE_COMPILE^.
8812 @node Examples of gnatmake Usage
8813 @section Examples of @command{gnatmake} Usage
8816 @item gnatmake hello.adb
8817 Compile all files necessary to bind and link the main program
8818 @file{hello.adb} (containing unit @code{Hello}) and bind and link the
8819 resulting object files to generate an executable file @file{^hello^HELLO.EXE^}.
8821 @item gnatmake main1 main2 main3
8822 Compile all files necessary to bind and link the main programs
8823 @file{main1.adb} (containing unit @code{Main1}), @file{main2.adb}
8824 (containing unit @code{Main2}) and @file{main3.adb}
8825 (containing unit @code{Main3}) and bind and link the resulting object files
8826 to generate three executable files @file{^main1^MAIN1.EXE^},
8827 @file{^main2^MAIN2.EXE^}
8828 and @file{^main3^MAIN3.EXE^}.
8831 @item gnatmake -q Main_Unit -cargs -O2 -bargs -l
8835 @item gnatmake Main_Unit /QUIET
8836 /COMPILER_QUALIFIERS /OPTIMIZE=ALL
8837 /BINDER_QUALIFIERS /ORDER_OF_ELABORATION
8839 Compile all files necessary to bind and link the main program unit
8840 @code{Main_Unit} (from file @file{main_unit.adb}). All compilations will
8841 be done with optimization level 2 and the order of elaboration will be
8842 listed by the binder. @command{gnatmake} will operate in quiet mode, not
8843 displaying commands it is executing.
8846 @c *************************
8847 @node Improving Performance
8848 @chapter Improving Performance
8849 @cindex Improving performance
8852 This chapter presents several topics related to program performance.
8853 It first describes some of the tradeoffs that need to be considered
8854 and some of the techniques for making your program run faster.
8855 It then documents the @command{gnatelim} tool, which can reduce
8856 the size of program executables.
8860 * Performance Considerations::
8861 * Reducing the Size of Ada Executables with gnatelim::
8865 @c *****************************
8866 @node Performance Considerations
8867 @section Performance Considerations
8870 The GNAT system provides a number of options that allow a trade-off
8875 performance of the generated code
8878 speed of compilation
8881 minimization of dependences and recompilation
8884 the degree of run-time checking.
8888 The defaults (if no options are selected) aim at improving the speed
8889 of compilation and minimizing dependences, at the expense of performance
8890 of the generated code:
8897 no inlining of subprogram calls
8900 all run-time checks enabled except overflow and elaboration checks
8904 These options are suitable for most program development purposes. This
8905 chapter describes how you can modify these choices, and also provides
8906 some guidelines on debugging optimized code.
8909 * Controlling Run-Time Checks::
8910 * Use of Restrictions::
8911 * Optimization Levels::
8912 * Debugging Optimized Code::
8913 * Inlining of Subprograms::
8914 * Optimization and Strict Aliasing::
8916 * Coverage Analysis::
8920 @node Controlling Run-Time Checks
8921 @subsection Controlling Run-Time Checks
8924 By default, GNAT generates all run-time checks, except arithmetic overflow
8925 checking for integer operations and checks for access before elaboration on
8926 subprogram calls. The latter are not required in default mode, because all
8927 necessary checking is done at compile time.
8928 @cindex @option{-gnatp} (@command{gcc})
8929 @cindex @option{-gnato} (@command{gcc})
8930 Two gnat switches, @option{-gnatp} and @option{-gnato} allow this default to
8931 be modified. @xref{Run-Time Checks}.
8933 Our experience is that the default is suitable for most development
8936 We treat integer overflow specially because these
8937 are quite expensive and in our experience are not as important as other
8938 run-time checks in the development process. Note that division by zero
8939 is not considered an overflow check, and divide by zero checks are
8940 generated where required by default.
8942 Elaboration checks are off by default, and also not needed by default, since
8943 GNAT uses a static elaboration analysis approach that avoids the need for
8944 run-time checking. This manual contains a full chapter discussing the issue
8945 of elaboration checks, and if the default is not satisfactory for your use,
8946 you should read this chapter.
8948 For validity checks, the minimal checks required by the Ada Reference
8949 Manual (for case statements and assignments to array elements) are on
8950 by default. These can be suppressed by use of the @option{-gnatVn} switch.
8951 Note that in Ada 83, there were no validity checks, so if the Ada 83 mode
8952 is acceptable (or when comparing GNAT performance with an Ada 83 compiler),
8953 it may be reasonable to routinely use @option{-gnatVn}. Validity checks
8954 are also suppressed entirely if @option{-gnatp} is used.
8956 @cindex Overflow checks
8957 @cindex Checks, overflow
8960 @cindex pragma Suppress
8961 @cindex pragma Unsuppress
8962 Note that the setting of the switches controls the default setting of
8963 the checks. They may be modified using either @code{pragma Suppress} (to
8964 remove checks) or @code{pragma Unsuppress} (to add back suppressed
8965 checks) in the program source.
8967 @node Use of Restrictions
8968 @subsection Use of Restrictions
8971 The use of pragma Restrictions allows you to control which features are
8972 permitted in your program. Apart from the obvious point that if you avoid
8973 relatively expensive features like finalization (enforceable by the use
8974 of pragma Restrictions (No_Finalization), the use of this pragma does not
8975 affect the generated code in most cases.
8977 One notable exception to this rule is that the possibility of task abort
8978 results in some distributed overhead, particularly if finalization or
8979 exception handlers are used. The reason is that certain sections of code
8980 have to be marked as non-abortable.
8982 If you use neither the @code{abort} statement, nor asynchronous transfer
8983 of control (@code{select .. then abort}), then this distributed overhead
8984 is removed, which may have a general positive effect in improving
8985 overall performance. Especially code involving frequent use of tasking
8986 constructs and controlled types will show much improved performance.
8987 The relevant restrictions pragmas are
8990 pragma Restrictions (No_Abort_Statements);
8991 pragma Restrictions (Max_Asynchronous_Select_Nesting => 0);
8995 It is recommended that these restriction pragmas be used if possible. Note
8996 that this also means that you can write code without worrying about the
8997 possibility of an immediate abort at any point.
8999 @node Optimization Levels
9000 @subsection Optimization Levels
9001 @cindex @option{^-O^/OPTIMIZE^} (@command{gcc})
9004 The default is optimization off. This results in the fastest compile
9005 times, but GNAT makes absolutely no attempt to optimize, and the
9006 generated programs are considerably larger and slower than when
9007 optimization is enabled. You can use the
9009 @option{-O@var{n}} switch, where @var{n} is an integer from 0 to 3,
9012 @code{OPTIMIZE} qualifier
9014 to @command{gcc} to control the optimization level:
9017 @item ^-O0^/OPTIMIZE=NONE^
9018 No optimization (the default);
9019 generates unoptimized code but has
9020 the fastest compilation time.
9022 @item ^-O1^/OPTIMIZE=SOME^
9023 Medium level optimization;
9024 optimizes reasonably well but does not
9025 degrade compilation time significantly.
9027 @item ^-O2^/OPTIMIZE=ALL^
9029 @itemx /OPTIMIZE=DEVELOPMENT
9032 generates highly optimized code and has
9033 the slowest compilation time.
9035 @item ^-O3^/OPTIMIZE=INLINING^
9036 Full optimization as in @option{-O2},
9037 and also attempts automatic inlining of small
9038 subprograms within a unit (@pxref{Inlining of Subprograms}).
9042 Higher optimization levels perform more global transformations on the
9043 program and apply more expensive analysis algorithms in order to generate
9044 faster and more compact code. The price in compilation time, and the
9045 resulting improvement in execution time,
9046 both depend on the particular application and the hardware environment.
9047 You should experiment to find the best level for your application.
9049 Since the precise set of optimizations done at each level will vary from
9050 release to release (and sometime from target to target), it is best to think
9051 of the optimization settings in general terms.
9052 The @cite{Using GNU GCC} manual contains details about
9053 ^the @option{-O} settings and a number of @option{-f} options that^how to^
9054 individually enable or disable specific optimizations.
9056 Unlike some other compilation systems, ^@command{gcc}^GNAT^ has
9057 been tested extensively at all optimization levels. There are some bugs
9058 which appear only with optimization turned on, but there have also been
9059 bugs which show up only in @emph{unoptimized} code. Selecting a lower
9060 level of optimization does not improve the reliability of the code
9061 generator, which in practice is highly reliable at all optimization
9064 Note regarding the use of @option{-O3}: The use of this optimization level
9065 is generally discouraged with GNAT, since it often results in larger
9066 executables which run more slowly. See further discussion of this point
9067 in @ref{Inlining of Subprograms}.
9069 @node Debugging Optimized Code
9070 @subsection Debugging Optimized Code
9071 @cindex Debugging optimized code
9072 @cindex Optimization and debugging
9075 Although it is possible to do a reasonable amount of debugging at
9077 non-zero optimization levels,
9078 the higher the level the more likely that
9081 @option{/OPTIMIZE} settings other than @code{NONE},
9082 such settings will make it more likely that
9084 source-level constructs will have been eliminated by optimization.
9085 For example, if a loop is strength-reduced, the loop
9086 control variable may be completely eliminated and thus cannot be
9087 displayed in the debugger.
9088 This can only happen at @option{-O2} or @option{-O3}.
9089 Explicit temporary variables that you code might be eliminated at
9090 ^level^setting^ @option{-O1} or higher.
9092 The use of the @option{^-g^/DEBUG^} switch,
9093 @cindex @option{^-g^/DEBUG^} (@command{gcc})
9094 which is needed for source-level debugging,
9095 affects the size of the program executable on disk,
9096 and indeed the debugging information can be quite large.
9097 However, it has no effect on the generated code (and thus does not
9098 degrade performance)
9100 Since the compiler generates debugging tables for a compilation unit before
9101 it performs optimizations, the optimizing transformations may invalidate some
9102 of the debugging data. You therefore need to anticipate certain
9103 anomalous situations that may arise while debugging optimized code.
9104 These are the most common cases:
9108 @i{The ``hopping Program Counter'':} Repeated @code{step} or @code{next}
9110 the PC bouncing back and forth in the code. This may result from any of
9111 the following optimizations:
9115 @i{Common subexpression elimination:} using a single instance of code for a
9116 quantity that the source computes several times. As a result you
9117 may not be able to stop on what looks like a statement.
9120 @i{Invariant code motion:} moving an expression that does not change within a
9121 loop, to the beginning of the loop.
9124 @i{Instruction scheduling:} moving instructions so as to
9125 overlap loads and stores (typically) with other code, or in
9126 general to move computations of values closer to their uses. Often
9127 this causes you to pass an assignment statement without the assignment
9128 happening and then later bounce back to the statement when the
9129 value is actually needed. Placing a breakpoint on a line of code
9130 and then stepping over it may, therefore, not always cause all the
9131 expected side-effects.
9135 @i{The ``big leap'':} More commonly known as @emph{cross-jumping}, in which
9136 two identical pieces of code are merged and the program counter suddenly
9137 jumps to a statement that is not supposed to be executed, simply because
9138 it (and the code following) translates to the same thing as the code
9139 that @emph{was} supposed to be executed. This effect is typically seen in
9140 sequences that end in a jump, such as a @code{goto}, a @code{return}, or
9141 a @code{break} in a C @code{^switch^switch^} statement.
9144 @i{The ``roving variable'':} The symptom is an unexpected value in a variable.
9145 There are various reasons for this effect:
9149 In a subprogram prologue, a parameter may not yet have been moved to its
9153 A variable may be dead, and its register re-used. This is
9154 probably the most common cause.
9157 As mentioned above, the assignment of a value to a variable may
9161 A variable may be eliminated entirely by value propagation or
9162 other means. In this case, GCC may incorrectly generate debugging
9163 information for the variable
9167 In general, when an unexpected value appears for a local variable or parameter
9168 you should first ascertain if that value was actually computed by
9169 your program, as opposed to being incorrectly reported by the debugger.
9171 array elements in an object designated by an access value
9172 are generally less of a problem, once you have ascertained that the access
9174 Typically, this means checking variables in the preceding code and in the
9175 calling subprogram to verify that the value observed is explainable from other
9176 values (one must apply the procedure recursively to those
9177 other values); or re-running the code and stopping a little earlier
9178 (perhaps before the call) and stepping to better see how the variable obtained
9179 the value in question; or continuing to step @emph{from} the point of the
9180 strange value to see if code motion had simply moved the variable's
9185 In light of such anomalies, a recommended technique is to use @option{-O0}
9186 early in the software development cycle, when extensive debugging capabilities
9187 are most needed, and then move to @option{-O1} and later @option{-O2} as
9188 the debugger becomes less critical.
9189 Whether to use the @option{^-g^/DEBUG^} switch in the release version is
9190 a release management issue.
9192 Note that if you use @option{-g} you can then use the @command{strip} program
9193 on the resulting executable,
9194 which removes both debugging information and global symbols.
9197 @node Inlining of Subprograms
9198 @subsection Inlining of Subprograms
9201 A call to a subprogram in the current unit is inlined if all the
9202 following conditions are met:
9206 The optimization level is at least @option{-O1}.
9209 The called subprogram is suitable for inlining: It must be small enough
9210 and not contain nested subprograms or anything else that @command{gcc}
9211 cannot support in inlined subprograms.
9214 The call occurs after the definition of the body of the subprogram.
9217 @cindex pragma Inline
9219 Either @code{pragma Inline} applies to the subprogram or it is
9220 small and automatic inlining (optimization level @option{-O3}) is
9225 Calls to subprograms in @code{with}'ed units are normally not inlined.
9226 To achieve this level of inlining, the following conditions must all be
9231 The optimization level is at least @option{-O1}.
9234 The called subprogram is suitable for inlining: It must be small enough
9235 and not contain nested subprograms or anything else @command{gcc} cannot
9236 support in inlined subprograms.
9239 The call appears in a body (not in a package spec).
9242 There is a @code{pragma Inline} for the subprogram.
9245 @cindex @option{-gnatn} (@command{gcc})
9246 The @option{^-gnatn^/INLINE^} switch
9247 is used in the @command{gcc} command line
9250 Note that specifying the @option{-gnatn} switch causes additional
9251 compilation dependencies. Consider the following:
9253 @smallexample @c ada
9273 With the default behavior (no @option{-gnatn} switch specified), the
9274 compilation of the @code{Main} procedure depends only on its own source,
9275 @file{main.adb}, and the spec of the package in file @file{r.ads}. This
9276 means that editing the body of @code{R} does not require recompiling
9279 On the other hand, the call @code{R.Q} is not inlined under these
9280 circumstances. If the @option{-gnatn} switch is present when @code{Main}
9281 is compiled, the call will be inlined if the body of @code{Q} is small
9282 enough, but now @code{Main} depends on the body of @code{R} in
9283 @file{r.adb} as well as on the spec. This means that if this body is edited,
9284 the main program must be recompiled. Note that this extra dependency
9285 occurs whether or not the call is in fact inlined by @command{gcc}.
9287 The use of front end inlining with @option{-gnatN} generates similar
9288 additional dependencies.
9290 @cindex @option{^-fno-inline^/INLINE=SUPPRESS^} (@command{gcc})
9291 Note: The @option{^-fno-inline^/INLINE=SUPPRESS^} switch
9292 can be used to prevent
9293 all inlining. This switch overrides all other conditions and ensures
9294 that no inlining occurs. The extra dependences resulting from
9295 @option{-gnatn} will still be active, even if
9296 this switch is used to suppress the resulting inlining actions.
9298 Note regarding the use of @option{-O3}: There is no difference in inlining
9299 behavior between @option{-O2} and @option{-O3} for subprograms with an explicit
9300 pragma @code{Inline} assuming the use of @option{-gnatn}
9301 or @option{-gnatN} (the switches that activate inlining). If you have used
9302 pragma @code{Inline} in appropriate cases, then it is usually much better
9303 to use @option{-O2} and @option{-gnatn} and avoid the use of @option{-O3} which
9304 in this case only has the effect of inlining subprograms you did not
9305 think should be inlined. We often find that the use of @option{-O3} slows
9306 down code by performing excessive inlining, leading to increased instruction
9307 cache pressure from the increased code size. So the bottom line here is
9308 that you should not automatically assume that @option{-O3} is better than
9309 @option{-O2}, and indeed you should use @option{-O3} only if tests show that
9310 it actually improves performance.
9312 @node Optimization and Strict Aliasing
9313 @subsection Optimization and Strict Aliasing
9315 @cindex Strict Aliasing
9316 @cindex No_Strict_Aliasing
9319 The strong typing capabilities of Ada allow an optimizer to generate
9320 efficient code in situations where other languages would be forced to
9321 make worst case assumptions preventing such optimizations. Consider
9322 the following example:
9324 @smallexample @c ada
9327 type Int1 is new Integer;
9328 type Int2 is new Integer;
9329 type Int1A is access Int1;
9330 type Int2A is access Int2;
9337 for J in Data'Range loop
9338 if Data (J) = Int1V.all then
9339 Int2V.all := Int2V.all + 1;
9348 In this example, since the variable @code{Int1V} can only access objects
9349 of type @code{Int1}, and @code{Int2V} can only access objects of type
9350 @code{Int2}, there is no possibility that the assignment to
9351 @code{Int2V.all} affects the value of @code{Int1V.all}. This means that
9352 the compiler optimizer can "know" that the value @code{Int1V.all} is constant
9353 for all iterations of the loop and avoid the extra memory reference
9354 required to dereference it each time through the loop.
9356 This kind of optimization, called strict aliasing analysis, is
9357 triggered by specifying an optimization level of @option{-O2} or
9358 higher and allows @code{GNAT} to generate more efficient code
9359 when access values are involved.
9361 However, although this optimization is always correct in terms of
9362 the formal semantics of the Ada Reference Manual, difficulties can
9363 arise if features like @code{Unchecked_Conversion} are used to break
9364 the typing system. Consider the following complete program example:
9366 @smallexample @c ada
9369 type int1 is new integer;
9370 type int2 is new integer;
9371 type a1 is access int1;
9372 type a2 is access int2;
9377 function to_a2 (Input : a1) return a2;
9380 with Unchecked_Conversion;
9382 function to_a2 (Input : a1) return a2 is
9384 new Unchecked_Conversion (a1, a2);
9386 return to_a2u (Input);
9392 with Text_IO; use Text_IO;
9394 v1 : a1 := new int1;
9395 v2 : a2 := to_a2 (v1);
9399 put_line (int1'image (v1.all));
9405 This program prints out 0 in @code{-O0} or @code{-O1}
9406 mode, but it prints out 1 in @code{-O2} mode. That's
9407 because in strict aliasing mode, the compiler can and
9408 does assume that the assignment to @code{v2.all} could not
9409 affect the value of @code{v1.all}, since different types
9412 This behavior is not a case of non-conformance with the standard, since
9413 the Ada RM specifies that an unchecked conversion where the resulting
9414 bit pattern is not a correct value of the target type can result in an
9415 abnormal value and attempting to reference an abnormal value makes the
9416 execution of a program erroneous. That's the case here since the result
9417 does not point to an object of type @code{int2}. This means that the
9418 effect is entirely unpredictable.
9420 However, although that explanation may satisfy a language
9421 lawyer, in practice an applications programmer expects an
9422 unchecked conversion involving pointers to create true
9423 aliases and the behavior of printing 1 seems plain wrong.
9424 In this case, the strict aliasing optimization is unwelcome.
9426 Indeed the compiler recognizes this possibility, and the
9427 unchecked conversion generates a warning:
9430 p2.adb:5:07: warning: possible aliasing problem with type "a2"
9431 p2.adb:5:07: warning: use -fno-strict-aliasing switch for references
9432 p2.adb:5:07: warning: or use "pragma No_Strict_Aliasing (a2);"
9436 Unfortunately the problem is recognized when compiling the body of
9437 package @code{p2}, but the actual "bad" code is generated while
9438 compiling the body of @code{m} and this latter compilation does not see
9439 the suspicious @code{Unchecked_Conversion}.
9441 As implied by the warning message, there are approaches you can use to
9442 avoid the unwanted strict aliasing optimization in a case like this.
9444 One possibility is to simply avoid the use of @code{-O2}, but
9445 that is a bit drastic, since it throws away a number of useful
9446 optimizations that do not involve strict aliasing assumptions.
9448 A less drastic approach is to compile the program using the
9449 option @code{-fno-strict-aliasing}. Actually it is only the
9450 unit containing the dereferencing of the suspicious pointer
9451 that needs to be compiled. So in this case, if we compile
9452 unit @code{m} with this switch, then we get the expected
9453 value of zero printed. Analyzing which units might need
9454 the switch can be painful, so a more reasonable approach
9455 is to compile the entire program with options @code{-O2}
9456 and @code{-fno-strict-aliasing}. If the performance is
9457 satisfactory with this combination of options, then the
9458 advantage is that the entire issue of possible "wrong"
9459 optimization due to strict aliasing is avoided.
9461 To avoid the use of compiler switches, the configuration
9462 pragma @code{No_Strict_Aliasing} with no parameters may be
9463 used to specify that for all access types, the strict
9464 aliasing optimization should be suppressed.
9466 However, these approaches are still overkill, in that they causes
9467 all manipulations of all access values to be deoptimized. A more
9468 refined approach is to concentrate attention on the specific
9469 access type identified as problematic.
9471 First, if a careful analysis of uses of the pointer shows
9472 that there are no possible problematic references, then
9473 the warning can be suppressed by bracketing the
9474 instantiation of @code{Unchecked_Conversion} to turn
9477 @smallexample @c ada
9478 pragma Warnings (Off);
9480 new Unchecked_Conversion (a1, a2);
9481 pragma Warnings (On);
9485 Of course that approach is not appropriate for this particular
9486 example, since indeed there is a problematic reference. In this
9487 case we can take one of two other approaches.
9489 The first possibility is to move the instantiation of unchecked
9490 conversion to the unit in which the type is declared. In
9491 this example, we would move the instantiation of
9492 @code{Unchecked_Conversion} from the body of package
9493 @code{p2} to the spec of package @code{p1}. Now the
9494 warning disappears. That's because any use of the
9495 access type knows there is a suspicious unchecked
9496 conversion, and the strict aliasing optimization
9497 is automatically suppressed for the type.
9499 If it is not practical to move the unchecked conversion to the same unit
9500 in which the destination access type is declared (perhaps because the
9501 source type is not visible in that unit), you may use pragma
9502 @code{No_Strict_Aliasing} for the type. This pragma must occur in the
9503 same declarative sequence as the declaration of the access type:
9505 @smallexample @c ada
9506 type a2 is access int2;
9507 pragma No_Strict_Aliasing (a2);
9511 Here again, the compiler now knows that the strict aliasing optimization
9512 should be suppressed for any reference to type @code{a2} and the
9513 expected behavior is obtained.
9515 Finally, note that although the compiler can generate warnings for
9516 simple cases of unchecked conversions, there are tricker and more
9517 indirect ways of creating type incorrect aliases which the compiler
9518 cannot detect. Examples are the use of address overlays and unchecked
9519 conversions involving composite types containing access types as
9520 components. In such cases, no warnings are generated, but there can
9521 still be aliasing problems. One safe coding practice is to forbid the
9522 use of address clauses for type overlaying, and to allow unchecked
9523 conversion only for primitive types. This is not really a significant
9524 restriction since any possible desired effect can be achieved by
9525 unchecked conversion of access values.
9528 @node Coverage Analysis
9529 @subsection Coverage Analysis
9532 GNAT supports the Digital Performance Coverage Analyzer (PCA), which allows
9533 the user to determine the distribution of execution time across a program,
9534 @pxref{Profiling} for details of usage.
9537 @node Reducing the Size of Ada Executables with gnatelim
9538 @section Reducing the Size of Ada Executables with @code{gnatelim}
9542 This section describes @command{gnatelim}, a tool which detects unused
9543 subprograms and helps the compiler to create a smaller executable for your
9548 * Running gnatelim::
9549 * Correcting the List of Eliminate Pragmas::
9550 * Making Your Executables Smaller::
9551 * Summary of the gnatelim Usage Cycle::
9554 @node About gnatelim
9555 @subsection About @code{gnatelim}
9558 When a program shares a set of Ada
9559 packages with other programs, it may happen that this program uses
9560 only a fraction of the subprograms defined in these packages. The code
9561 created for these unused subprograms increases the size of the executable.
9563 @code{gnatelim} tracks unused subprograms in an Ada program and
9564 outputs a list of GNAT-specific pragmas @code{Eliminate} marking all the
9565 subprograms that are declared but never called. By placing the list of
9566 @code{Eliminate} pragmas in the GNAT configuration file @file{gnat.adc} and
9567 recompiling your program, you may decrease the size of its executable,
9568 because the compiler will not generate the code for 'eliminated' subprograms.
9569 See GNAT Reference Manual for more information about this pragma.
9571 @code{gnatelim} needs as its input data the name of the main subprogram
9572 and a bind file for a main subprogram.
9574 To create a bind file for @code{gnatelim}, run @code{gnatbind} for
9575 the main subprogram. @code{gnatelim} can work with both Ada and C
9576 bind files; when both are present, it uses the Ada bind file.
9577 The following commands will build the program and create the bind file:
9580 $ gnatmake ^-c Main_Prog^/ACTIONS=COMPILE MAIN_PROG^
9581 $ gnatbind main_prog
9584 Note that @code{gnatelim} needs neither object nor ALI files.
9586 @node Running gnatelim
9587 @subsection Running @code{gnatelim}
9590 @code{gnatelim} has the following command-line interface:
9593 $ gnatelim [options] name
9597 @code{name} should be a name of a source file that contains the main subprogram
9598 of a program (partition).
9600 @code{gnatelim} has the following switches:
9605 @cindex @option{^-q^/QUIET^} (@command{gnatelim})
9606 Quiet mode: by default @code{gnatelim} outputs to the standard error
9607 stream the number of program units left to be processed. This option turns
9611 @cindex @option{^-v^/VERBOSE^} (@command{gnatelim})
9612 Verbose mode: @code{gnatelim} version information is printed as Ada
9613 comments to the standard output stream. Also, in addition to the number of
9614 program units left @code{gnatelim} will output the name of the current unit
9618 @cindex @option{^-a^/ALL^} (@command{gnatelim})
9619 Also look for subprograms from the GNAT run time that can be eliminated. Note
9620 that when @file{gnat.adc} is produced using this switch, the entire program
9621 must be recompiled with switch @option{^-a^/ALL_FILES^} to @command{gnatmake}.
9623 @item ^-I^/INCLUDE_DIRS=^@var{dir}
9624 @cindex @option{^-I^/INCLUDE_DIRS^} (@command{gnatelim})
9625 When looking for source files also look in directory @var{dir}. Specifying
9626 @option{^-I-^/INCLUDE_DIRS=-^} instructs @code{gnatelim} not to look for
9627 sources in the current directory.
9629 @item ^-b^/BIND_FILE=^@var{bind_file}
9630 @cindex @option{^-b^/BIND_FILE^} (@command{gnatelim})
9631 Specifies @var{bind_file} as the bind file to process. If not set, the name
9632 of the bind file is computed from the full expanded Ada name
9633 of a main subprogram.
9635 @item ^-C^/CONFIG_FILE=^@var{config_file}
9636 @cindex @option{^-C^/CONFIG_FILE^} (@command{gnatelim})
9637 Specifies a file @var{config_file} that contains configuration pragmas. The
9638 file must be specified with full path.
9640 @item ^--GCC^/COMPILER^=@var{compiler_name}
9641 @cindex @option{^-GCC^/COMPILER^} (@command{gnatelim})
9642 Instructs @code{gnatelim} to use specific @command{gcc} compiler instead of one
9643 available on the path.
9645 @item ^--GNATMAKE^/GNATMAKE^=@var{gnatmake_name}
9646 @cindex @option{^--GNATMAKE^/GNATMAKE^} (@command{gnatelim})
9647 Instructs @code{gnatelim} to use specific @command{gnatmake} instead of one
9648 available on the path.
9652 @code{gnatelim} sends its output to the standard output stream, and all the
9653 tracing and debug information is sent to the standard error stream.
9654 In order to produce a proper GNAT configuration file
9655 @file{gnat.adc}, redirection must be used:
9659 $ PIPE GNAT ELIM MAIN_PROG.ADB > GNAT.ADC
9662 $ gnatelim main_prog.adb > gnat.adc
9671 $ gnatelim main_prog.adb >> gnat.adc
9675 in order to append the @code{gnatelim} output to the existing contents of
9679 @node Correcting the List of Eliminate Pragmas
9680 @subsection Correcting the List of Eliminate Pragmas
9683 In some rare cases @code{gnatelim} may try to eliminate
9684 subprograms that are actually called in the program. In this case, the
9685 compiler will generate an error message of the form:
9688 file.adb:106:07: cannot call eliminated subprogram "My_Prog"
9692 You will need to manually remove the wrong @code{Eliminate} pragmas from
9693 the @file{gnat.adc} file. You should recompile your program
9694 from scratch after that, because you need a consistent @file{gnat.adc} file
9695 during the entire compilation.
9697 @node Making Your Executables Smaller
9698 @subsection Making Your Executables Smaller
9701 In order to get a smaller executable for your program you now have to
9702 recompile the program completely with the new @file{gnat.adc} file
9703 created by @code{gnatelim} in your current directory:
9706 $ gnatmake ^-f main_prog^/FORCE_COMPILE MAIN_PROG^
9710 (Use the @option{^-f^/FORCE_COMPILE^} option for @command{gnatmake} to
9711 recompile everything
9712 with the set of pragmas @code{Eliminate} that you have obtained with
9713 @command{gnatelim}).
9715 Be aware that the set of @code{Eliminate} pragmas is specific to each
9716 program. It is not recommended to merge sets of @code{Eliminate}
9717 pragmas created for different programs in one @file{gnat.adc} file.
9719 @node Summary of the gnatelim Usage Cycle
9720 @subsection Summary of the gnatelim Usage Cycle
9723 Here is a quick summary of the steps to be taken in order to reduce
9724 the size of your executables with @code{gnatelim}. You may use
9725 other GNAT options to control the optimization level,
9726 to produce the debugging information, to set search path, etc.
9733 $ gnatmake ^-c main_prog^/ACTIONS=COMPILE MAIN_PROG^
9734 $ gnatbind main_prog
9738 Generate a list of @code{Eliminate} pragmas
9741 $ PIPE GNAT ELIM MAIN_PROG > GNAT.ADC
9744 $ gnatelim main_prog >[>] gnat.adc
9749 Recompile the application
9752 $ gnatmake ^-f main_prog^/FORCE_COMPILE MAIN_PROG^
9757 @c ********************************
9758 @node Renaming Files Using gnatchop
9759 @chapter Renaming Files Using @code{gnatchop}
9763 This chapter discusses how to handle files with multiple units by using
9764 the @code{gnatchop} utility. This utility is also useful in renaming
9765 files to meet the standard GNAT default file naming conventions.
9768 * Handling Files with Multiple Units::
9769 * Operating gnatchop in Compilation Mode::
9770 * Command Line for gnatchop::
9771 * Switches for gnatchop::
9772 * Examples of gnatchop Usage::
9775 @node Handling Files with Multiple Units
9776 @section Handling Files with Multiple Units
9779 The basic compilation model of GNAT requires that a file submitted to the
9780 compiler have only one unit and there be a strict correspondence
9781 between the file name and the unit name.
9783 The @code{gnatchop} utility allows both of these rules to be relaxed,
9784 allowing GNAT to process files which contain multiple compilation units
9785 and files with arbitrary file names. @code{gnatchop}
9786 reads the specified file and generates one or more output files,
9787 containing one unit per file. The unit and the file name correspond,
9788 as required by GNAT.
9790 If you want to permanently restructure a set of ``foreign'' files so that
9791 they match the GNAT rules, and do the remaining development using the
9792 GNAT structure, you can simply use @command{gnatchop} once, generate the
9793 new set of files and work with them from that point on.
9795 Alternatively, if you want to keep your files in the ``foreign'' format,
9796 perhaps to maintain compatibility with some other Ada compilation
9797 system, you can set up a procedure where you use @command{gnatchop} each
9798 time you compile, regarding the source files that it writes as temporary
9799 files that you throw away.
9801 @node Operating gnatchop in Compilation Mode
9802 @section Operating gnatchop in Compilation Mode
9805 The basic function of @code{gnatchop} is to take a file with multiple units
9806 and split it into separate files. The boundary between files is reasonably
9807 clear, except for the issue of comments and pragmas. In default mode, the
9808 rule is that any pragmas between units belong to the previous unit, except
9809 that configuration pragmas always belong to the following unit. Any comments
9810 belong to the following unit. These rules
9811 almost always result in the right choice of
9812 the split point without needing to mark it explicitly and most users will
9813 find this default to be what they want. In this default mode it is incorrect to
9814 submit a file containing only configuration pragmas, or one that ends in
9815 configuration pragmas, to @code{gnatchop}.
9817 However, using a special option to activate ``compilation mode'',
9819 can perform another function, which is to provide exactly the semantics
9820 required by the RM for handling of configuration pragmas in a compilation.
9821 In the absence of configuration pragmas (at the main file level), this
9822 option has no effect, but it causes such configuration pragmas to be handled
9823 in a quite different manner.
9825 First, in compilation mode, if @code{gnatchop} is given a file that consists of
9826 only configuration pragmas, then this file is appended to the
9827 @file{gnat.adc} file in the current directory. This behavior provides
9828 the required behavior described in the RM for the actions to be taken
9829 on submitting such a file to the compiler, namely that these pragmas
9830 should apply to all subsequent compilations in the same compilation
9831 environment. Using GNAT, the current directory, possibly containing a
9832 @file{gnat.adc} file is the representation
9833 of a compilation environment. For more information on the
9834 @file{gnat.adc} file, see @ref{Handling of Configuration Pragmas}.
9836 Second, in compilation mode, if @code{gnatchop}
9837 is given a file that starts with
9838 configuration pragmas, and contains one or more units, then these
9839 configuration pragmas are prepended to each of the chopped files. This
9840 behavior provides the required behavior described in the RM for the
9841 actions to be taken on compiling such a file, namely that the pragmas
9842 apply to all units in the compilation, but not to subsequently compiled
9845 Finally, if configuration pragmas appear between units, they are appended
9846 to the previous unit. This results in the previous unit being illegal,
9847 since the compiler does not accept configuration pragmas that follow
9848 a unit. This provides the required RM behavior that forbids configuration
9849 pragmas other than those preceding the first compilation unit of a
9852 For most purposes, @code{gnatchop} will be used in default mode. The
9853 compilation mode described above is used only if you need exactly
9854 accurate behavior with respect to compilations, and you have files
9855 that contain multiple units and configuration pragmas. In this
9856 circumstance the use of @code{gnatchop} with the compilation mode
9857 switch provides the required behavior, and is for example the mode
9858 in which GNAT processes the ACVC tests.
9860 @node Command Line for gnatchop
9861 @section Command Line for @code{gnatchop}
9864 The @code{gnatchop} command has the form:
9867 $ gnatchop switches @var{file name} [@var{file name} @var{file name} ...]
9872 The only required argument is the file name of the file to be chopped.
9873 There are no restrictions on the form of this file name. The file itself
9874 contains one or more Ada units, in normal GNAT format, concatenated
9875 together. As shown, more than one file may be presented to be chopped.
9877 When run in default mode, @code{gnatchop} generates one output file in
9878 the current directory for each unit in each of the files.
9880 @var{directory}, if specified, gives the name of the directory to which
9881 the output files will be written. If it is not specified, all files are
9882 written to the current directory.
9884 For example, given a
9885 file called @file{hellofiles} containing
9887 @smallexample @c ada
9892 with Text_IO; use Text_IO;
9905 $ gnatchop ^hellofiles^HELLOFILES.^
9909 generates two files in the current directory, one called
9910 @file{hello.ads} containing the single line that is the procedure spec,
9911 and the other called @file{hello.adb} containing the remaining text. The
9912 original file is not affected. The generated files can be compiled in
9916 When gnatchop is invoked on a file that is empty or that contains only empty
9917 lines and/or comments, gnatchop will not fail, but will not produce any
9920 For example, given a
9921 file called @file{toto.txt} containing
9923 @smallexample @c ada
9935 $ gnatchop ^toto.txt^TOT.TXT^
9939 will not produce any new file and will result in the following warnings:
9942 toto.txt:1:01: warning: empty file, contains no compilation units
9943 no compilation units found
9944 no source files written
9947 @node Switches for gnatchop
9948 @section Switches for @code{gnatchop}
9951 @command{gnatchop} recognizes the following switches:
9956 @item ^-c^/COMPILATION^
9957 @cindex @option{^-c^/COMPILATION^} (@code{gnatchop})
9958 Causes @code{gnatchop} to operate in compilation mode, in which
9959 configuration pragmas are handled according to strict RM rules. See
9960 previous section for a full description of this mode.
9964 This passes the given @option{-gnatxxx} switch to @code{gnat} which is
9965 used to parse the given file. Not all @code{xxx} options make sense,
9966 but for example, the use of @option{-gnati2} allows @code{gnatchop} to
9967 process a source file that uses Latin-2 coding for identifiers.
9971 Causes @code{gnatchop} to generate a brief help summary to the standard
9972 output file showing usage information.
9974 @item ^-k@var{mm}^/FILE_NAME_MAX_LENGTH=@var{mm}^
9975 @cindex @option{^-k^/FILE_NAME_MAX_LENGTH^} (@code{gnatchop})
9976 Limit generated file names to the specified number @code{mm}
9978 This is useful if the
9979 resulting set of files is required to be interoperable with systems
9980 which limit the length of file names.
9982 If no value is given, or
9983 if no @code{/FILE_NAME_MAX_LENGTH} qualifier is given,
9984 a default of 39, suitable for OpenVMS Alpha
9988 No space is allowed between the @option{-k} and the numeric value. The numeric
9989 value may be omitted in which case a default of @option{-k8},
9991 with DOS-like file systems, is used. If no @option{-k} switch
9993 there is no limit on the length of file names.
9996 @item ^-p^/PRESERVE^
9997 @cindex @option{^-p^/PRESERVE^} (@code{gnatchop})
9998 Causes the file ^modification^creation^ time stamp of the input file to be
9999 preserved and used for the time stamp of the output file(s). This may be
10000 useful for preserving coherency of time stamps in an environment where
10001 @code{gnatchop} is used as part of a standard build process.
10004 @cindex @option{^-q^/QUIET^} (@code{gnatchop})
10005 Causes output of informational messages indicating the set of generated
10006 files to be suppressed. Warnings and error messages are unaffected.
10008 @item ^-r^/REFERENCE^
10009 @cindex @option{^-r^/REFERENCE^} (@code{gnatchop})
10010 @findex Source_Reference
10011 Generate @code{Source_Reference} pragmas. Use this switch if the output
10012 files are regarded as temporary and development is to be done in terms
10013 of the original unchopped file. This switch causes
10014 @code{Source_Reference} pragmas to be inserted into each of the
10015 generated files to refers back to the original file name and line number.
10016 The result is that all error messages refer back to the original
10018 In addition, the debugging information placed into the object file (when
10019 the @option{^-g^/DEBUG^} switch of @command{gcc} or @command{gnatmake} is
10021 also refers back to this original file so that tools like profilers and
10022 debuggers will give information in terms of the original unchopped file.
10024 If the original file to be chopped itself contains
10025 a @code{Source_Reference}
10026 pragma referencing a third file, then gnatchop respects
10027 this pragma, and the generated @code{Source_Reference} pragmas
10028 in the chopped file refer to the original file, with appropriate
10029 line numbers. This is particularly useful when @code{gnatchop}
10030 is used in conjunction with @code{gnatprep} to compile files that
10031 contain preprocessing statements and multiple units.
10033 @item ^-v^/VERBOSE^
10034 @cindex @option{^-v^/VERBOSE^} (@code{gnatchop})
10035 Causes @code{gnatchop} to operate in verbose mode. The version
10036 number and copyright notice are output, as well as exact copies of
10037 the gnat1 commands spawned to obtain the chop control information.
10039 @item ^-w^/OVERWRITE^
10040 @cindex @option{^-w^/OVERWRITE^} (@code{gnatchop})
10041 Overwrite existing file names. Normally @code{gnatchop} regards it as a
10042 fatal error if there is already a file with the same name as a
10043 file it would otherwise output, in other words if the files to be
10044 chopped contain duplicated units. This switch bypasses this
10045 check, and causes all but the last instance of such duplicated
10046 units to be skipped.
10050 @cindex @option{--GCC=} (@code{gnatchop})
10051 Specify the path of the GNAT parser to be used. When this switch is used,
10052 no attempt is made to add the prefix to the GNAT parser executable.
10056 @node Examples of gnatchop Usage
10057 @section Examples of @code{gnatchop} Usage
10061 @item gnatchop /OVERWRITE HELLO_S.ADA [PRERELEASE.FILES]
10064 @item gnatchop -w hello_s.ada prerelease/files
10067 Chops the source file @file{hello_s.ada}. The output files will be
10068 placed in the directory @file{^prerelease/files^[PRERELEASE.FILES]^},
10070 files with matching names in that directory (no files in the current
10071 directory are modified).
10073 @item gnatchop ^archive^ARCHIVE.^
10074 Chops the source file @file{^archive^ARCHIVE.^}
10075 into the current directory. One
10076 useful application of @code{gnatchop} is in sending sets of sources
10077 around, for example in email messages. The required sources are simply
10078 concatenated (for example, using a ^Unix @code{cat}^VMS @code{APPEND/NEW}^
10080 @code{gnatchop} is used at the other end to reconstitute the original
10083 @item gnatchop file1 file2 file3 direc
10084 Chops all units in files @file{file1}, @file{file2}, @file{file3}, placing
10085 the resulting files in the directory @file{direc}. Note that if any units
10086 occur more than once anywhere within this set of files, an error message
10087 is generated, and no files are written. To override this check, use the
10088 @option{^-w^/OVERWRITE^} switch,
10089 in which case the last occurrence in the last file will
10090 be the one that is output, and earlier duplicate occurrences for a given
10091 unit will be skipped.
10094 @node Configuration Pragmas
10095 @chapter Configuration Pragmas
10096 @cindex Configuration pragmas
10097 @cindex Pragmas, configuration
10100 In Ada 95, configuration pragmas include those pragmas described as
10101 such in the Ada 95 Reference Manual, as well as
10102 implementation-dependent pragmas that are configuration pragmas. See the
10103 individual descriptions of pragmas in the GNAT Reference Manual for
10104 details on these additional GNAT-specific configuration pragmas. Most
10105 notably, the pragma @code{Source_File_Name}, which allows
10106 specifying non-default names for source files, is a configuration
10107 pragma. The following is a complete list of configuration pragmas
10108 recognized by @code{GNAT}:
10115 Component_Alignment
10121 External_Name_Casing
10122 Float_Representation
10131 Propagate_Exceptions
10134 Restricted_Run_Time
10136 Restrictions_Warnings
10141 Task_Dispatching_Policy
10150 * Handling of Configuration Pragmas::
10151 * The Configuration Pragmas Files::
10154 @node Handling of Configuration Pragmas
10155 @section Handling of Configuration Pragmas
10157 Configuration pragmas may either appear at the start of a compilation
10158 unit, in which case they apply only to that unit, or they may apply to
10159 all compilations performed in a given compilation environment.
10161 GNAT also provides the @code{gnatchop} utility to provide an automatic
10162 way to handle configuration pragmas following the semantics for
10163 compilations (that is, files with multiple units), described in the RM.
10164 See @ref{Operating gnatchop in Compilation Mode} for details.
10165 However, for most purposes, it will be more convenient to edit the
10166 @file{gnat.adc} file that contains configuration pragmas directly,
10167 as described in the following section.
10169 @node The Configuration Pragmas Files
10170 @section The Configuration Pragmas Files
10171 @cindex @file{gnat.adc}
10174 In GNAT a compilation environment is defined by the current
10175 directory at the time that a compile command is given. This current
10176 directory is searched for a file whose name is @file{gnat.adc}. If
10177 this file is present, it is expected to contain one or more
10178 configuration pragmas that will be applied to the current compilation.
10179 However, if the switch @option{-gnatA} is used, @file{gnat.adc} is not
10182 Configuration pragmas may be entered into the @file{gnat.adc} file
10183 either by running @code{gnatchop} on a source file that consists only of
10184 configuration pragmas, or more conveniently by
10185 direct editing of the @file{gnat.adc} file, which is a standard format
10188 In addition to @file{gnat.adc}, one additional file containing configuration
10189 pragmas may be applied to the current compilation using the switch
10190 @option{-gnatec}@var{path}. @var{path} must designate an existing file that
10191 contains only configuration pragmas. These configuration pragmas are
10192 in addition to those found in @file{gnat.adc} (provided @file{gnat.adc}
10193 is present and switch @option{-gnatA} is not used).
10195 It is allowed to specify several switches @option{-gnatec}, however only
10196 the last one on the command line will be taken into account.
10198 If you are using project file, a separate mechanism is provided using
10199 project attributes, see @ref{Specifying Configuration Pragmas} for more
10203 Of special interest to GNAT OpenVMS Alpha is the following
10204 configuration pragma:
10206 @smallexample @c ada
10208 pragma Extend_System (Aux_DEC);
10213 In the presence of this pragma, GNAT adds to the definition of the
10214 predefined package SYSTEM all the additional types and subprograms that are
10215 defined in DEC Ada. See @ref{Compatibility with DEC Ada} for details.
10218 @node Handling Arbitrary File Naming Conventions Using gnatname
10219 @chapter Handling Arbitrary File Naming Conventions Using @code{gnatname}
10220 @cindex Arbitrary File Naming Conventions
10223 * Arbitrary File Naming Conventions::
10224 * Running gnatname::
10225 * Switches for gnatname::
10226 * Examples of gnatname Usage::
10229 @node Arbitrary File Naming Conventions
10230 @section Arbitrary File Naming Conventions
10233 The GNAT compiler must be able to know the source file name of a compilation
10234 unit. When using the standard GNAT default file naming conventions
10235 (@code{.ads} for specs, @code{.adb} for bodies), the GNAT compiler
10236 does not need additional information.
10239 When the source file names do not follow the standard GNAT default file naming
10240 conventions, the GNAT compiler must be given additional information through
10241 a configuration pragmas file (@pxref{Configuration Pragmas})
10243 When the non standard file naming conventions are well-defined,
10244 a small number of pragmas @code{Source_File_Name} specifying a naming pattern
10245 (@pxref{Alternative File Naming Schemes}) may be sufficient. However,
10246 if the file naming conventions are irregular or arbitrary, a number
10247 of pragma @code{Source_File_Name} for individual compilation units
10249 To help maintain the correspondence between compilation unit names and
10250 source file names within the compiler,
10251 GNAT provides a tool @code{gnatname} to generate the required pragmas for a
10254 @node Running gnatname
10255 @section Running @code{gnatname}
10258 The usual form of the @code{gnatname} command is
10261 $ gnatname [@var{switches}] @var{naming_pattern} [@var{naming_patterns}]
10265 All of the arguments are optional. If invoked without any argument,
10266 @code{gnatname} will display its usage.
10269 When used with at least one naming pattern, @code{gnatname} will attempt to
10270 find all the compilation units in files that follow at least one of the
10271 naming patterns. To find these compilation units,
10272 @code{gnatname} will use the GNAT compiler in syntax-check-only mode on all
10276 One or several Naming Patterns may be given as arguments to @code{gnatname}.
10277 Each Naming Pattern is enclosed between double quotes.
10278 A Naming Pattern is a regular expression similar to the wildcard patterns
10279 used in file names by the Unix shells or the DOS prompt.
10282 Examples of Naming Patterns are
10291 For a more complete description of the syntax of Naming Patterns,
10292 see the second kind of regular expressions described in @file{g-regexp.ads}
10293 (the ``Glob'' regular expressions).
10296 When invoked with no switches, @code{gnatname} will create a configuration
10297 pragmas file @file{gnat.adc} in the current working directory, with pragmas
10298 @code{Source_File_Name} for each file that contains a valid Ada unit.
10300 @node Switches for gnatname
10301 @section Switches for @code{gnatname}
10304 Switches for @code{gnatname} must precede any specified Naming Pattern.
10307 You may specify any of the following switches to @code{gnatname}:
10312 @item ^-c^/CONFIG_FILE=^@file{file}
10313 @cindex @option{^-c^/CONFIG_FILE^} (@code{gnatname})
10314 Create a configuration pragmas file @file{file} (instead of the default
10317 There may be zero, one or more space between @option{-c} and
10320 @file{file} may include directory information. @file{file} must be
10321 writable. There may be only one switch @option{^-c^/CONFIG_FILE^}.
10322 When a switch @option{^-c^/CONFIG_FILE^} is
10323 specified, no switch @option{^-P^/PROJECT_FILE^} may be specified (see below).
10325 @item ^-d^/SOURCE_DIRS=^@file{dir}
10326 @cindex @option{^-d^/SOURCE_DIRS^} (@code{gnatname})
10327 Look for source files in directory @file{dir}. There may be zero, one or more
10328 spaces between @option{^-d^/SOURCE_DIRS=^} and @file{dir}.
10329 When a switch @option{^-d^/SOURCE_DIRS^}
10330 is specified, the current working directory will not be searched for source
10331 files, unless it is explicitly specified with a @option{^-d^/SOURCE_DIRS^}
10332 or @option{^-D^/DIR_FILES^} switch.
10333 Several switches @option{^-d^/SOURCE_DIRS^} may be specified.
10334 If @file{dir} is a relative path, it is relative to the directory of
10335 the configuration pragmas file specified with switch
10336 @option{^-c^/CONFIG_FILE^},
10337 or to the directory of the project file specified with switch
10338 @option{^-P^/PROJECT_FILE^} or,
10339 if neither switch @option{^-c^/CONFIG_FILE^}
10340 nor switch @option{^-P^/PROJECT_FILE^} are specified, it is relative to the
10341 current working directory. The directory
10342 specified with switch @option{^-d^/SOURCE_DIRS^} must exist and be readable.
10344 @item ^-D^/DIRS_FILE=^@file{file}
10345 @cindex @option{^-D^/DIRS_FILE^} (@code{gnatname})
10346 Look for source files in all directories listed in text file @file{file}.
10347 There may be zero, one or more spaces between @option{^-D^/DIRS_FILE=^}
10349 @file{file} must be an existing, readable text file.
10350 Each non empty line in @file{file} must be a directory.
10351 Specifying switch @option{^-D^/DIRS_FILE^} is equivalent to specifying as many
10352 switches @option{^-d^/SOURCE_DIRS^} as there are non empty lines in
10355 @item ^-f^/FOREIGN_PATTERN=^@file{pattern}
10356 @cindex @option{^-f^/FOREIGN_PATTERN^} (@code{gnatname})
10357 Foreign patterns. Using this switch, it is possible to add sources of languages
10358 other than Ada to the list of sources of a project file.
10359 It is only useful if a ^-P^/PROJECT_FILE^ switch is used.
10362 gnatname ^-Pprj -f"*.c"^/PROJECT_FILE=PRJ /FOREIGN_PATTERN=*.C^ "*.ada"
10365 will look for Ada units in all files with the @file{.ada} extension,
10366 and will add to the list of file for project @file{prj.gpr} the C files
10367 with extension ".^c^C^".
10370 @cindex @option{^-h^/HELP^} (@code{gnatname})
10371 Output usage (help) information. The output is written to @file{stdout}.
10373 @item ^-P^/PROJECT_FILE=^@file{proj}
10374 @cindex @option{^-P^/PROJECT_FILE^} (@code{gnatname})
10375 Create or update project file @file{proj}. There may be zero, one or more space
10376 between @option{-P} and @file{proj}. @file{proj} may include directory
10377 information. @file{proj} must be writable.
10378 There may be only one switch @option{^-P^/PROJECT_FILE^}.
10379 When a switch @option{^-P^/PROJECT_FILE^} is specified,
10380 no switch @option{^-c^/CONFIG_FILE^} may be specified.
10382 @item ^-v^/VERBOSE^
10383 @cindex @option{^-v^/VERBOSE^} (@code{gnatname})
10384 Verbose mode. Output detailed explanation of behavior to @file{stdout}.
10385 This includes name of the file written, the name of the directories to search
10386 and, for each file in those directories whose name matches at least one of
10387 the Naming Patterns, an indication of whether the file contains a unit,
10388 and if so the name of the unit.
10390 @item ^-v -v^/VERBOSE /VERBOSE^
10391 @cindex @option{^-v -v^/VERBOSE /VERBOSE^} (@code{gnatname})
10392 Very Verbose mode. In addition to the output produced in verbose mode,
10393 for each file in the searched directories whose name matches none of
10394 the Naming Patterns, an indication is given that there is no match.
10396 @item ^-x^/EXCLUDED_PATTERN=^@file{pattern}
10397 @cindex @option{^-x^/EXCLUDED_PATTERN^} (@code{gnatname})
10398 Excluded patterns. Using this switch, it is possible to exclude some files
10399 that would match the name patterns. For example,
10401 gnatname ^-x "*_nt.ada"^/EXCLUDED_PATTERN=*_nt.ada^ "*.ada"
10404 will look for Ada units in all files with the @file{.ada} extension,
10405 except those whose names end with @file{_nt.ada}.
10409 @node Examples of gnatname Usage
10410 @section Examples of @code{gnatname} Usage
10414 $ gnatname /CONFIG_FILE=[HOME.ME]NAMES.ADC /SOURCE_DIRS=SOURCES "[a-z]*.ada*"
10420 $ gnatname -c /home/me/names.adc -d sources "[a-z]*.ada*"
10425 In this example, the directory @file{^/home/me^[HOME.ME]^} must already exist
10426 and be writable. In addition, the directory
10427 @file{^/home/me/sources^[HOME.ME.SOURCES]^} (specified by
10428 @option{^-d sources^/SOURCE_DIRS=SOURCES^}) must exist and be readable.
10431 Note the optional spaces after @option{-c} and @option{-d}.
10436 $ gnatname -P/home/me/proj -x "*_nt_body.ada"
10437 -dsources -dsources/plus -Dcommon_dirs.txt "body_*" "spec_*"
10440 $ gnatname /PROJECT_FILE=[HOME.ME]PROJ
10441 /EXCLUDED_PATTERN=*_nt_body.ada
10442 /SOURCE_DIRS=(SOURCES,[SOURCES.PLUS])
10443 /DIRS_FILE=COMMON_DIRS.TXT "body_*" "spec_*"
10447 Note that several switches @option{^-d^/SOURCE_DIRS^} may be used,
10448 even in conjunction with one or several switches
10449 @option{^-D^/DIRS_FILE^}. Several Naming Patterns and one excluded pattern
10450 are used in this example.
10452 @c *****************************************
10453 @c * G N A T P r o j e c t M a n a g e r *
10454 @c *****************************************
10455 @node GNAT Project Manager
10456 @chapter GNAT Project Manager
10460 * Examples of Project Files::
10461 * Project File Syntax::
10462 * Objects and Sources in Project Files::
10463 * Importing Projects::
10464 * Project Extension::
10465 * Project Hierarchy Extension::
10466 * External References in Project Files::
10467 * Packages in Project Files::
10468 * Variables from Imported Projects::
10470 * Library Projects::
10471 * Stand-alone Library Projects::
10472 * Switches Related to Project Files::
10473 * Tools Supporting Project Files::
10474 * An Extended Example::
10475 * Project File Complete Syntax::
10478 @c ****************
10479 @c * Introduction *
10480 @c ****************
10483 @section Introduction
10486 This chapter describes GNAT's @emph{Project Manager}, a facility that allows
10487 you to manage complex builds involving a number of source files, directories,
10488 and compilation options for different system configurations. In particular,
10489 project files allow you to specify:
10492 The directory or set of directories containing the source files, and/or the
10493 names of the specific source files themselves
10495 The directory in which the compiler's output
10496 (@file{ALI} files, object files, tree files) is to be placed
10498 The directory in which the executable programs is to be placed
10500 ^Switch^Switch^ settings for any of the project-enabled tools
10501 (@command{gnatmake}, compiler, binder, linker, @code{gnatls}, @code{gnatxref},
10502 @code{gnatfind}); you can apply these settings either globally or to individual
10505 The source files containing the main subprogram(s) to be built
10507 The source programming language(s) (currently Ada and/or C)
10509 Source file naming conventions; you can specify these either globally or for
10510 individual compilation units
10517 @node Project Files
10518 @subsection Project Files
10521 Project files are written in a syntax close to that of Ada, using familiar
10522 notions such as packages, context clauses, declarations, default values,
10523 assignments, and inheritance. Finally, project files can be built
10524 hierarchically from other project files, simplifying complex system
10525 integration and project reuse.
10527 A @dfn{project} is a specific set of values for various compilation properties.
10528 The settings for a given project are described by means of
10529 a @dfn{project file}, which is a text file written in an Ada-like syntax.
10530 Property values in project files are either strings or lists of strings.
10531 Properties that are not explicitly set receive default values. A project
10532 file may interrogate the values of @dfn{external variables} (user-defined
10533 command-line switches or environment variables), and it may specify property
10534 settings conditionally, based on the value of such variables.
10536 In simple cases, a project's source files depend only on other source files
10537 in the same project, or on the predefined libraries. (@emph{Dependence} is
10539 the Ada technical sense; as in one Ada unit @code{with}ing another.) However,
10540 the Project Manager also allows more sophisticated arrangements,
10541 where the source files in one project depend on source files in other
10545 One project can @emph{import} other projects containing needed source files.
10547 You can organize GNAT projects in a hierarchy: a @emph{child} project
10548 can extend a @emph{parent} project, inheriting the parent's source files and
10549 optionally overriding any of them with alternative versions
10553 More generally, the Project Manager lets you structure large development
10554 efforts into hierarchical subsystems, where build decisions are delegated
10555 to the subsystem level, and thus different compilation environments
10556 (^switch^switch^ settings) used for different subsystems.
10558 The Project Manager is invoked through the
10559 @option{^-P^/PROJECT_FILE=^@emph{projectfile}}
10560 switch to @command{gnatmake} or to the @command{^gnat^GNAT^} front driver.
10562 There may be zero, one or more spaces between @option{-P} and
10563 @option{@emph{projectfile}}.
10565 If you want to define (on the command line) an external variable that is
10566 queried by the project file, you must use the
10567 @option{^-X^/EXTERNAT_REFERENCE=^@emph{vbl}=@emph{value}} switch.
10568 The Project Manager parses and interprets the project file, and drives the
10569 invoked tool based on the project settings.
10571 The Project Manager supports a wide range of development strategies,
10572 for systems of all sizes. Here are some typical practices that are
10576 Using a common set of source files, but generating object files in different
10577 directories via different ^switch^switch^ settings
10579 Using a mostly-shared set of source files, but with different versions of
10584 The destination of an executable can be controlled inside a project file
10585 using the @option{^-o^-o^}
10587 In the absence of such a ^switch^switch^ either inside
10588 the project file or on the command line, any executable files generated by
10589 @command{gnatmake} are placed in the directory @code{Exec_Dir} specified
10590 in the project file. If no @code{Exec_Dir} is specified, they will be placed
10591 in the object directory of the project.
10593 You can use project files to achieve some of the effects of a source
10594 versioning system (for example, defining separate projects for
10595 the different sets of sources that comprise different releases) but the
10596 Project Manager is independent of any source configuration management tools
10597 that might be used by the developers.
10599 The next section introduces the main features of GNAT's project facility
10600 through a sequence of examples; subsequent sections will present the syntax
10601 and semantics in more detail. A more formal description of the project
10602 facility appears in the GNAT Reference Manual.
10604 @c *****************************
10605 @c * Examples of Project Files *
10606 @c *****************************
10608 @node Examples of Project Files
10609 @section Examples of Project Files
10611 This section illustrates some of the typical uses of project files and
10612 explains their basic structure and behavior.
10615 * Common Sources with Different ^Switches^Switches^ and Directories::
10616 * Using External Variables::
10617 * Importing Other Projects::
10618 * Extending a Project::
10621 @node Common Sources with Different ^Switches^Switches^ and Directories
10622 @subsection Common Sources with Different ^Switches^Switches^ and Directories
10626 * Specifying the Object Directory::
10627 * Specifying the Exec Directory::
10628 * Project File Packages::
10629 * Specifying ^Switch^Switch^ Settings::
10630 * Main Subprograms::
10631 * Executable File Names::
10632 * Source File Naming Conventions::
10633 * Source Language(s)::
10637 Suppose that the Ada source files @file{pack.ads}, @file{pack.adb}, and
10638 @file{proc.adb} are in the @file{/common} directory. The file
10639 @file{proc.adb} contains an Ada main subprogram @code{Proc} that @code{with}s
10640 package @code{Pack}. We want to compile these source files under two sets
10641 of ^switches^switches^:
10644 When debugging, we want to pass the @option{-g} switch to @command{gnatmake},
10645 and the @option{^-gnata^-gnata^},
10646 @option{^-gnato^-gnato^},
10647 and @option{^-gnatE^-gnatE^} switches to the
10648 compiler; the compiler's output is to appear in @file{/common/debug}
10650 When preparing a release version, we want to pass the @option{^-O2^O2^} switch
10651 to the compiler; the compiler's output is to appear in @file{/common/release}
10655 The GNAT project files shown below, respectively @file{debug.gpr} and
10656 @file{release.gpr} in the @file{/common} directory, achieve these effects.
10669 ^/common/debug^[COMMON.DEBUG]^
10674 ^/common/release^[COMMON.RELEASE]^
10679 Here are the corresponding project files:
10681 @smallexample @c projectfile
10684 for Object_Dir use "debug";
10685 for Main use ("proc");
10688 for ^Default_Switches^Default_Switches^ ("Ada")
10690 for Executable ("proc.adb") use "proc1";
10695 package Compiler is
10696 for ^Default_Switches^Default_Switches^ ("Ada")
10697 use ("-fstack-check",
10700 "^-gnatE^-gnatE^");
10706 @smallexample @c projectfile
10709 for Object_Dir use "release";
10710 for Exec_Dir use ".";
10711 for Main use ("proc");
10713 package Compiler is
10714 for ^Default_Switches^Default_Switches^ ("Ada")
10722 The name of the project defined by @file{debug.gpr} is @code{"Debug"} (case
10723 insensitive), and analogously the project defined by @file{release.gpr} is
10724 @code{"Release"}. For consistency the file should have the same name as the
10725 project, and the project file's extension should be @code{"gpr"}. These
10726 conventions are not required, but a warning is issued if they are not followed.
10728 If the current directory is @file{^/temp^[TEMP]^}, then the command
10730 gnatmake ^-P/common/debug.gpr^/PROJECT_FILE=[COMMON]DEBUG^
10734 generates object and ALI files in @file{^/common/debug^[COMMON.DEBUG]^},
10735 as well as the @code{^proc1^PROC1.EXE^} executable,
10736 using the ^switch^switch^ settings defined in the project file.
10738 Likewise, the command
10740 gnatmake ^-P/common/release.gpr^/PROJECT_FILE=[COMMON]RELEASE^
10744 generates object and ALI files in @file{^/common/release^[COMMON.RELEASE]^},
10745 and the @code{^proc^PROC.EXE^}
10746 executable in @file{^/common^[COMMON]^},
10747 using the ^switch^switch^ settings from the project file.
10750 @unnumberedsubsubsec Source Files
10753 If a project file does not explicitly specify a set of source directories or
10754 a set of source files, then by default the project's source files are the
10755 Ada source files in the project file directory. Thus @file{pack.ads},
10756 @file{pack.adb}, and @file{proc.adb} are the source files for both projects.
10758 @node Specifying the Object Directory
10759 @unnumberedsubsubsec Specifying the Object Directory
10762 Several project properties are modeled by Ada-style @emph{attributes};
10763 a property is defined by supplying the equivalent of an Ada attribute
10764 definition clause in the project file.
10765 A project's object directory is another such a property; the corresponding
10766 attribute is @code{Object_Dir}, and its value is also a string expression,
10767 specified either as absolute or relative. In the later case,
10768 it is relative to the project file directory. Thus the compiler's
10769 output is directed to @file{^/common/debug^[COMMON.DEBUG]^}
10770 (for the @code{Debug} project)
10771 and to @file{^/common/release^[COMMON.RELEASE]^}
10772 (for the @code{Release} project).
10773 If @code{Object_Dir} is not specified, then the default is the project file
10776 @node Specifying the Exec Directory
10777 @unnumberedsubsubsec Specifying the Exec Directory
10780 A project's exec directory is another property; the corresponding
10781 attribute is @code{Exec_Dir}, and its value is also a string expression,
10782 either specified as relative or absolute. If @code{Exec_Dir} is not specified,
10783 then the default is the object directory (which may also be the project file
10784 directory if attribute @code{Object_Dir} is not specified). Thus the executable
10785 is placed in @file{^/common/debug^[COMMON.DEBUG]^}
10786 for the @code{Debug} project (attribute @code{Exec_Dir} not specified)
10787 and in @file{^/common^[COMMON]^} for the @code{Release} project.
10789 @node Project File Packages
10790 @unnumberedsubsubsec Project File Packages
10793 A GNAT tool that is integrated with the Project Manager is modeled by a
10794 corresponding package in the project file. In the example above,
10795 The @code{Debug} project defines the packages @code{Builder}
10796 (for @command{gnatmake}) and @code{Compiler};
10797 the @code{Release} project defines only the @code{Compiler} package.
10799 The Ada-like package syntax is not to be taken literally. Although packages in
10800 project files bear a surface resemblance to packages in Ada source code, the
10801 notation is simply a way to convey a grouping of properties for a named
10802 entity. Indeed, the package names permitted in project files are restricted
10803 to a predefined set, corresponding to the project-aware tools, and the contents
10804 of packages are limited to a small set of constructs.
10805 The packages in the example above contain attribute definitions.
10807 @node Specifying ^Switch^Switch^ Settings
10808 @unnumberedsubsubsec Specifying ^Switch^Switch^ Settings
10811 ^Switch^Switch^ settings for a project-aware tool can be specified through
10812 attributes in the package that corresponds to the tool.
10813 The example above illustrates one of the relevant attributes,
10814 @code{^Default_Switches^Default_Switches^}, which is defined in packages
10815 in both project files.
10816 Unlike simple attributes like @code{Source_Dirs},
10817 @code{^Default_Switches^Default_Switches^} is
10818 known as an @emph{associative array}. When you define this attribute, you must
10819 supply an ``index'' (a literal string), and the effect of the attribute
10820 definition is to set the value of the array at the specified index.
10821 For the @code{^Default_Switches^Default_Switches^} attribute,
10822 the index is a programming language (in our case, Ada),
10823 and the value specified (after @code{use}) must be a list
10824 of string expressions.
10826 The attributes permitted in project files are restricted to a predefined set.
10827 Some may appear at project level, others in packages.
10828 For any attribute that is an associative array, the index must always be a
10829 literal string, but the restrictions on this string (e.g., a file name or a
10830 language name) depend on the individual attribute.
10831 Also depending on the attribute, its specified value will need to be either a
10832 string or a string list.
10834 In the @code{Debug} project, we set the switches for two tools,
10835 @command{gnatmake} and the compiler, and thus we include the two corresponding
10836 packages; each package defines the @code{^Default_Switches^Default_Switches^}
10837 attribute with index @code{"Ada"}.
10838 Note that the package corresponding to
10839 @command{gnatmake} is named @code{Builder}. The @code{Release} project is
10840 similar, but only includes the @code{Compiler} package.
10842 In project @code{Debug} above, the ^switches^switches^ starting with
10843 @option{-gnat} that are specified in package @code{Compiler}
10844 could have been placed in package @code{Builder}, since @command{gnatmake}
10845 transmits all such ^switches^switches^ to the compiler.
10847 @node Main Subprograms
10848 @unnumberedsubsubsec Main Subprograms
10851 One of the specifiable properties of a project is a list of files that contain
10852 main subprograms. This property is captured in the @code{Main} attribute,
10853 whose value is a list of strings. If a project defines the @code{Main}
10854 attribute, it is not necessary to identify the main subprogram(s) when
10855 invoking @command{gnatmake} (@pxref{gnatmake and Project Files}).
10857 @node Executable File Names
10858 @unnumberedsubsubsec Executable File Names
10861 By default, the executable file name corresponding to a main source is
10862 deduced from the main source file name. Through the attributes
10863 @code{Executable} and @code{Executable_Suffix} of package @code{Builder},
10864 it is possible to change this default.
10865 In project @code{Debug} above, the executable file name
10866 for main source @file{^proc.adb^PROC.ADB^} is
10867 @file{^proc1^PROC1.EXE^}.
10868 Attribute @code{Executable_Suffix}, when specified, may change the suffix
10869 of the the executable files, when no attribute @code{Executable} applies:
10870 its value replace the platform-specific executable suffix.
10871 Attributes @code{Executable} and @code{Executable_Suffix} are the only ways to
10872 specify a non default executable file name when several mains are built at once
10873 in a single @command{gnatmake} command.
10875 @node Source File Naming Conventions
10876 @unnumberedsubsubsec Source File Naming Conventions
10879 Since the project files above do not specify any source file naming
10880 conventions, the GNAT defaults are used. The mechanism for defining source
10881 file naming conventions -- a package named @code{Naming} --
10882 is described below (@pxref{Naming Schemes}).
10884 @node Source Language(s)
10885 @unnumberedsubsubsec Source Language(s)
10888 Since the project files do not specify a @code{Languages} attribute, by
10889 default the GNAT tools assume that the language of the project file is Ada.
10890 More generally, a project can comprise source files
10891 in Ada, C, and/or other languages.
10893 @node Using External Variables
10894 @subsection Using External Variables
10897 Instead of supplying different project files for debug and release, we can
10898 define a single project file that queries an external variable (set either
10899 on the command line or via an ^environment variable^logical name^) in order to
10900 conditionally define the appropriate settings. Again, assume that the
10901 source files @file{pack.ads}, @file{pack.adb}, and @file{proc.adb} are
10902 located in directory @file{^/common^[COMMON]^}. The following project file,
10903 @file{build.gpr}, queries the external variable named @code{STYLE} and
10904 defines an object directory and ^switch^switch^ settings based on whether
10905 the value is @code{"deb"} (debug) or @code{"rel"} (release), and where
10906 the default is @code{"deb"}.
10908 @smallexample @c projectfile
10911 for Main use ("proc");
10913 type Style_Type is ("deb", "rel");
10914 Style : Style_Type := external ("STYLE", "deb");
10918 for Object_Dir use "debug";
10921 for Object_Dir use "release";
10922 for Exec_Dir use ".";
10931 for ^Default_Switches^Default_Switches^ ("Ada")
10933 for Executable ("proc") use "proc1";
10942 package Compiler is
10946 for ^Default_Switches^Default_Switches^ ("Ada")
10947 use ("^-gnata^-gnata^",
10949 "^-gnatE^-gnatE^");
10952 for ^Default_Switches^Default_Switches^ ("Ada")
10963 @code{Style_Type} is an example of a @emph{string type}, which is the project
10964 file analog of an Ada enumeration type but whose components are string literals
10965 rather than identifiers. @code{Style} is declared as a variable of this type.
10967 The form @code{external("STYLE", "deb")} is known as an
10968 @emph{external reference}; its first argument is the name of an
10969 @emph{external variable}, and the second argument is a default value to be
10970 used if the external variable doesn't exist. You can define an external
10971 variable on the command line via the @option{^-X^/EXTERNAL_REFERENCE^} switch,
10972 or you can use ^an environment variable^a logical name^
10973 as an external variable.
10975 Each @code{case} construct is expanded by the Project Manager based on the
10976 value of @code{Style}. Thus the command
10979 gnatmake -P/common/build.gpr -XSTYLE=deb
10985 gnatmake /PROJECT_FILE=[COMMON]BUILD.GPR /EXTERNAL_REFERENCE=STYLE=deb
10990 is equivalent to the @command{gnatmake} invocation using the project file
10991 @file{debug.gpr} in the earlier example. So is the command
10993 gnatmake ^-P/common/build.gpr^/PROJECT_FILE=[COMMON]BUILD.GPR^
10997 since @code{"deb"} is the default for @code{STYLE}.
11003 gnatmake -P/common/build.gpr -XSTYLE=rel
11009 GNAT MAKE /PROJECT_FILE=[COMMON]BUILD.GPR /EXTERNAL_REFERENCE=STYLE=rel
11014 is equivalent to the @command{gnatmake} invocation using the project file
11015 @file{release.gpr} in the earlier example.
11017 @node Importing Other Projects
11018 @subsection Importing Other Projects
11019 @cindex @code{ADA_PROJECT_PATH}
11022 A compilation unit in a source file in one project may depend on compilation
11023 units in source files in other projects. To compile this unit under
11024 control of a project file, the
11025 dependent project must @emph{import} the projects containing the needed source
11027 This effect is obtained using syntax similar to an Ada @code{with} clause,
11028 but where @code{with}ed entities are strings that denote project files.
11030 As an example, suppose that the two projects @code{GUI_Proj} and
11031 @code{Comm_Proj} are defined in the project files @file{gui_proj.gpr} and
11032 @file{comm_proj.gpr} in directories @file{^/gui^[GUI]^}
11033 and @file{^/comm^[COMM]^}, respectively.
11034 Suppose that the source files for @code{GUI_Proj} are
11035 @file{gui.ads} and @file{gui.adb}, and that the source files for
11036 @code{Comm_Proj} are @file{comm.ads} and @file{comm.adb}, where each set of
11037 files is located in its respective project file directory. Schematically:
11056 We want to develop an application in directory @file{^/app^[APP]^} that
11057 @code{with} the packages @code{GUI} and @code{Comm}, using the properties of
11058 the corresponding project files (e.g. the ^switch^switch^ settings
11059 and object directory).
11060 Skeletal code for a main procedure might be something like the following:
11062 @smallexample @c ada
11065 procedure App_Main is
11074 Here is a project file, @file{app_proj.gpr}, that achieves the desired
11077 @smallexample @c projectfile
11079 with "/gui/gui_proj", "/comm/comm_proj";
11080 project App_Proj is
11081 for Main use ("app_main");
11087 Building an executable is achieved through the command:
11089 gnatmake ^-P/app/app_proj^/PROJECT_FILE=[APP]APP_PROJ^
11092 which will generate the @code{^app_main^APP_MAIN.EXE^} executable
11093 in the directory where @file{app_proj.gpr} resides.
11095 If an imported project file uses the standard extension (@code{^gpr^GPR^}) then
11096 (as illustrated above) the @code{with} clause can omit the extension.
11098 Our example specified an absolute path for each imported project file.
11099 Alternatively, the directory name of an imported object can be omitted
11103 The imported project file is in the same directory as the importing project
11106 You have defined ^an environment variable^a logical name^
11107 that includes the directory containing
11108 the needed project file. The syntax of @code{ADA_PROJECT_PATH} is the same as
11109 the syntax of @code{ADA_INCLUDE_PATH} and @code{ADA_OBJECTS_PATH}: a list of
11110 directory names separated by colons (semicolons on Windows).
11114 Thus, if we define @code{ADA_PROJECT_PATH} to include @file{^/gui^[GUI]^} and
11115 @file{^/comm^[COMM]^}, then our project file @file{app_proj.gpr} can be written
11118 @smallexample @c projectfile
11120 with "gui_proj", "comm_proj";
11121 project App_Proj is
11122 for Main use ("app_main");
11128 Importing other projects can create ambiguities.
11129 For example, the same unit might be present in different imported projects, or
11130 it might be present in both the importing project and in an imported project.
11131 Both of these conditions are errors. Note that in the current version of
11132 the Project Manager, it is illegal to have an ambiguous unit even if the
11133 unit is never referenced by the importing project. This restriction may be
11134 relaxed in a future release.
11136 @node Extending a Project
11137 @subsection Extending a Project
11140 In large software systems it is common to have multiple
11141 implementations of a common interface; in Ada terms, multiple versions of a
11142 package body for the same specification. For example, one implementation
11143 might be safe for use in tasking programs, while another might only be used
11144 in sequential applications. This can be modeled in GNAT using the concept
11145 of @emph{project extension}. If one project (the ``child'') @emph{extends}
11146 another project (the ``parent'') then by default all source files of the
11147 parent project are inherited by the child, but the child project can
11148 override any of the parent's source files with new versions, and can also
11149 add new files. This facility is the project analog of a type extension in
11150 Object-Oriented Programming. Project hierarchies are permitted (a child
11151 project may be the parent of yet another project), and a project that
11152 inherits one project can also import other projects.
11154 As an example, suppose that directory @file{^/seq^[SEQ]^} contains the project
11155 file @file{seq_proj.gpr} as well as the source files @file{pack.ads},
11156 @file{pack.adb}, and @file{proc.adb}:
11169 Note that the project file can simply be empty (that is, no attribute or
11170 package is defined):
11172 @smallexample @c projectfile
11174 project Seq_Proj is
11180 implying that its source files are all the Ada source files in the project
11183 Suppose we want to supply an alternate version of @file{pack.adb}, in
11184 directory @file{^/tasking^[TASKING]^}, but use the existing versions of
11185 @file{pack.ads} and @file{proc.adb}. We can define a project
11186 @code{Tasking_Proj} that inherits @code{Seq_Proj}:
11190 ^/tasking^[TASKING]^
11196 project Tasking_Proj extends "/seq/seq_proj" is
11202 The version of @file{pack.adb} used in a build depends on which project file
11205 Note that we could have obtained the desired behavior using project import
11206 rather than project inheritance; a @code{base} project would contain the
11207 sources for @file{pack.ads} and @file{proc.adb}, a sequential project would
11208 import @code{base} and add @file{pack.adb}, and likewise a tasking project
11209 would import @code{base} and add a different version of @file{pack.adb}. The
11210 choice depends on whether other sources in the original project need to be
11211 overridden. If they do, then project extension is necessary, otherwise,
11212 importing is sufficient.
11215 In a project file that extends another project file, it is possible to
11216 indicate that an inherited source is not part of the sources of the extending
11217 project. This is necessary sometimes when a package spec has been overloaded
11218 and no longer requires a body: in this case, it is necessary to indicate that
11219 the inherited body is not part of the sources of the project, otherwise there
11220 will be a compilation error when compiling the spec.
11222 For that purpose, the attribute @code{Locally_Removed_Files} is used.
11223 Its value is a string list: a list of file names.
11225 @smallexample @c @projectfile
11226 project B extends "a" is
11227 for Source_Files use ("pkg.ads");
11228 -- New spec of Pkg does not need a completion
11229 for Locally_Removed_Files use ("pkg.adb");
11233 Attribute @code{Locally_Removed_Files} may also be used to check if a source
11234 is still needed: if it is possible to build using @command{gnatmake} when such
11235 a source is put in attribute @code{Locally_Removed_Files} of a project P, then
11236 it is possible to remove the source completely from a system that includes
11239 @c ***********************
11240 @c * Project File Syntax *
11241 @c ***********************
11243 @node Project File Syntax
11244 @section Project File Syntax
11253 * Associative Array Attributes::
11254 * case Constructions::
11258 This section describes the structure of project files.
11260 A project may be an @emph{independent project}, entirely defined by a single
11261 project file. Any Ada source file in an independent project depends only
11262 on the predefined library and other Ada source files in the same project.
11265 A project may also @dfn{depend on} other projects, in either or both of
11266 the following ways:
11268 @item It may import any number of projects
11269 @item It may extend at most one other project
11273 The dependence relation is a directed acyclic graph (the subgraph reflecting
11274 the ``extends'' relation is a tree).
11276 A project's @dfn{immediate sources} are the source files directly defined by
11277 that project, either implicitly by residing in the project file's directory,
11278 or explicitly through any of the source-related attributes described below.
11279 More generally, a project @var{proj}'s @dfn{sources} are the immediate sources
11280 of @var{proj} together with the immediate sources (unless overridden) of any
11281 project on which @var{proj} depends (either directly or indirectly).
11284 @subsection Basic Syntax
11287 As seen in the earlier examples, project files have an Ada-like syntax.
11288 The minimal project file is:
11289 @smallexample @c projectfile
11298 The identifier @code{Empty} is the name of the project.
11299 This project name must be present after the reserved
11300 word @code{end} at the end of the project file, followed by a semi-colon.
11302 Any name in a project file, such as the project name or a variable name,
11303 has the same syntax as an Ada identifier.
11305 The reserved words of project files are the Ada reserved words plus
11306 @code{extends}, @code{external}, and @code{project}. Note that the only Ada
11307 reserved words currently used in project file syntax are:
11335 Comments in project files have the same syntax as in Ada, two consecutives
11336 hyphens through the end of the line.
11339 @subsection Packages
11342 A project file may contain @emph{packages}. The name of a package must be one
11343 of the identifiers from the following list. A package
11344 with a given name may only appear once in a project file. Package names are
11345 case insensitive. The following package names are legal:
11361 @code{Cross_Reference}
11365 @code{Pretty_Printer}
11375 @code{Language_Processing}
11379 In its simplest form, a package may be empty:
11381 @smallexample @c projectfile
11391 A package may contain @emph{attribute declarations},
11392 @emph{variable declarations} and @emph{case constructions}, as will be
11395 When there is ambiguity between a project name and a package name,
11396 the name always designates the project. To avoid possible confusion, it is
11397 always a good idea to avoid naming a project with one of the
11398 names allowed for packages or any name that starts with @code{gnat}.
11401 @subsection Expressions
11404 An @emph{expression} is either a @emph{string expression} or a
11405 @emph{string list expression}.
11407 A @emph{string expression} is either a @emph{simple string expression} or a
11408 @emph{compound string expression}.
11410 A @emph{simple string expression} is one of the following:
11412 @item A literal string; e.g.@code{"comm/my_proj.gpr"}
11413 @item A string-valued variable reference (@pxref{Variables})
11414 @item A string-valued attribute reference (@pxref{Attributes})
11415 @item An external reference (@pxref{External References in Project Files})
11419 A @emph{compound string expression} is a concatenation of string expressions,
11420 using the operator @code{"&"}
11422 Path & "/" & File_Name & ".ads"
11426 A @emph{string list expression} is either a
11427 @emph{simple string list expression} or a
11428 @emph{compound string list expression}.
11430 A @emph{simple string list expression} is one of the following:
11432 @item A parenthesized list of zero or more string expressions,
11433 separated by commas
11435 File_Names := (File_Name, "gnat.adc", File_Name & ".orig");
11438 @item A string list-valued variable reference
11439 @item A string list-valued attribute reference
11443 A @emph{compound string list expression} is the concatenation (using
11444 @code{"&"}) of a simple string list expression and an expression. Note that
11445 each term in a compound string list expression, except the first, may be
11446 either a string expression or a string list expression.
11448 @smallexample @c projectfile
11450 File_Name_List := () & File_Name; -- One string in this list
11451 Extended_File_Name_List := File_Name_List & (File_Name & ".orig");
11453 Big_List := File_Name_List & Extended_File_Name_List;
11454 -- Concatenation of two string lists: three strings
11455 Illegal_List := "gnat.adc" & Extended_File_Name_List;
11456 -- Illegal: must start with a string list
11461 @subsection String Types
11464 A @emph{string type declaration} introduces a discrete set of string literals.
11465 If a string variable is declared to have this type, its value
11466 is restricted to the given set of literals.
11468 Here is an example of a string type declaration:
11470 @smallexample @c projectfile
11471 type OS is ("NT", "nt", "Unix", "GNU/Linux", "other OS");
11475 Variables of a string type are called @emph{typed variables}; all other
11476 variables are called @emph{untyped variables}. Typed variables are
11477 particularly useful in @code{case} constructions, to support conditional
11478 attribute declarations.
11479 (@pxref{case Constructions}).
11481 The string literals in the list are case sensitive and must all be different.
11482 They may include any graphic characters allowed in Ada, including spaces.
11484 A string type may only be declared at the project level, not inside a package.
11486 A string type may be referenced by its name if it has been declared in the same
11487 project file, or by an expanded name whose prefix is the name of the project
11488 in which it is declared.
11491 @subsection Variables
11494 A variable may be declared at the project file level, or within a package.
11495 Here are some examples of variable declarations:
11497 @smallexample @c projectfile
11499 This_OS : OS := external ("OS"); -- a typed variable declaration
11500 That_OS := "GNU/Linux"; -- an untyped variable declaration
11505 The syntax of a @emph{typed variable declaration} is identical to the Ada
11506 syntax for an object declaration. By contrast, the syntax of an untyped
11507 variable declaration is identical to an Ada assignment statement. In fact,
11508 variable declarations in project files have some of the characteristics of
11509 an assignment, in that successive declarations for the same variable are
11510 allowed. Untyped variable declarations do establish the expected kind of the
11511 variable (string or string list), and successive declarations for it must
11512 respect the initial kind.
11515 A string variable declaration (typed or untyped) declares a variable
11516 whose value is a string. This variable may be used as a string expression.
11517 @smallexample @c projectfile
11518 File_Name := "readme.txt";
11519 Saved_File_Name := File_Name & ".saved";
11523 A string list variable declaration declares a variable whose value is a list
11524 of strings. The list may contain any number (zero or more) of strings.
11526 @smallexample @c projectfile
11528 List_With_One_Element := ("^-gnaty^-gnaty^");
11529 List_With_Two_Elements := List_With_One_Element & "^-gnatg^-gnatg^";
11530 Long_List := ("main.ada", "pack1_.ada", "pack1.ada", "pack2_.ada"
11531 "pack2.ada", "util_.ada", "util.ada");
11535 The same typed variable may not be declared more than once at project level,
11536 and it may not be declared more than once in any package; it is in effect
11539 The same untyped variable may be declared several times. Declarations are
11540 elaborated in the order in which they appear, so the new value replaces
11541 the old one, and any subsequent reference to the variable uses the new value.
11542 However, as noted above, if a variable has been declared as a string, all
11544 declarations must give it a string value. Similarly, if a variable has
11545 been declared as a string list, all subsequent declarations
11546 must give it a string list value.
11548 A @emph{variable reference} may take several forms:
11551 @item The simple variable name, for a variable in the current package (if any)
11552 or in the current project
11553 @item An expanded name, whose prefix is a context name.
11557 A @emph{context} may be one of the following:
11560 @item The name of an existing package in the current project
11561 @item The name of an imported project of the current project
11562 @item The name of an ancestor project (i.e., a project extended by the current
11563 project, either directly or indirectly)
11564 @item An expanded name whose prefix is an imported/parent project name, and
11565 whose selector is a package name in that project.
11569 A variable reference may be used in an expression.
11572 @subsection Attributes
11575 A project (and its packages) may have @emph{attributes} that define
11576 the project's properties. Some attributes have values that are strings;
11577 others have values that are string lists.
11579 There are two categories of attributes: @emph{simple attributes}
11580 and @emph{associative arrays} (@pxref{Associative Array Attributes}).
11582 Legal project attribute names, and attribute names for each legal package are
11583 listed below. Attributes names are case-insensitive.
11585 The following attributes are defined on projects (all are simple attributes):
11587 @multitable @columnfractions .4 .3
11588 @item @emph{Attribute Name}
11590 @item @code{Source_Files}
11592 @item @code{Source_Dirs}
11594 @item @code{Source_List_File}
11596 @item @code{Object_Dir}
11598 @item @code{Exec_Dir}
11600 @item @code{Locally_Removed_Files}
11604 @item @code{Languages}
11606 @item @code{Main_Language}
11608 @item @code{Library_Dir}
11610 @item @code{Library_Name}
11612 @item @code{Library_Kind}
11614 @item @code{Library_Version}
11616 @item @code{Library_Interface}
11618 @item @code{Library_Auto_Init}
11620 @item @code{Library_Options}
11622 @item @code{Library_GCC}
11627 The following attributes are defined for package @code{Naming}
11628 (@pxref{Naming Schemes}):
11630 @multitable @columnfractions .4 .2 .2 .2
11631 @item Attribute Name @tab Category @tab Index @tab Value
11632 @item @code{Spec_Suffix}
11633 @tab associative array
11636 @item @code{Body_Suffix}
11637 @tab associative array
11640 @item @code{Separate_Suffix}
11641 @tab simple attribute
11644 @item @code{Casing}
11645 @tab simple attribute
11648 @item @code{Dot_Replacement}
11649 @tab simple attribute
11653 @tab associative array
11657 @tab associative array
11660 @item @code{Specification_Exceptions}
11661 @tab associative array
11664 @item @code{Implementation_Exceptions}
11665 @tab associative array
11671 The following attributes are defined for packages @code{Builder},
11672 @code{Compiler}, @code{Binder},
11673 @code{Linker}, @code{Cross_Reference}, and @code{Finder}
11674 (@pxref{^Switches^Switches^ and Project Files}).
11676 @multitable @columnfractions .4 .2 .2 .2
11677 @item Attribute Name @tab Category @tab Index @tab Value
11678 @item @code{^Default_Switches^Default_Switches^}
11679 @tab associative array
11682 @item @code{^Switches^Switches^}
11683 @tab associative array
11689 In addition, package @code{Compiler} has a single string attribute
11690 @code{Local_Configuration_Pragmas} and package @code{Builder} has a single
11691 string attribute @code{Global_Configuration_Pragmas}.
11694 Each simple attribute has a default value: the empty string (for string-valued
11695 attributes) and the empty list (for string list-valued attributes).
11697 An attribute declaration defines a new value for an attribute.
11699 Examples of simple attribute declarations:
11701 @smallexample @c projectfile
11702 for Object_Dir use "objects";
11703 for Source_Dirs use ("units", "test/drivers");
11707 The syntax of a @dfn{simple attribute declaration} is similar to that of an
11708 attribute definition clause in Ada.
11710 Attributes references may be appear in expressions.
11711 The general form for such a reference is @code{<entity>'<attribute>}:
11712 Associative array attributes are functions. Associative
11713 array attribute references must have an argument that is a string literal.
11717 @smallexample @c projectfile
11719 Naming'Dot_Replacement
11720 Imported_Project'Source_Dirs
11721 Imported_Project.Naming'Casing
11722 Builder'^Default_Switches^Default_Switches^("Ada")
11726 The prefix of an attribute may be:
11728 @item @code{project} for an attribute of the current project
11729 @item The name of an existing package of the current project
11730 @item The name of an imported project
11731 @item The name of a parent project that is extended by the current project
11732 @item An expanded name whose prefix is imported/parent project name,
11733 and whose selector is a package name
11738 @smallexample @c projectfile
11741 for Source_Dirs use project'Source_Dirs & "units";
11742 for Source_Dirs use project'Source_Dirs & "test/drivers"
11748 In the first attribute declaration, initially the attribute @code{Source_Dirs}
11749 has the default value: an empty string list. After this declaration,
11750 @code{Source_Dirs} is a string list of one element: @code{"units"}.
11751 After the second attribute declaration @code{Source_Dirs} is a string list of
11752 two elements: @code{"units"} and @code{"test/drivers"}.
11754 Note: this example is for illustration only. In practice,
11755 the project file would contain only one attribute declaration:
11757 @smallexample @c projectfile
11758 for Source_Dirs use ("units", "test/drivers");
11761 @node Associative Array Attributes
11762 @subsection Associative Array Attributes
11765 Some attributes are defined as @emph{associative arrays}. An associative
11766 array may be regarded as a function that takes a string as a parameter
11767 and delivers a string or string list value as its result.
11769 Here are some examples of single associative array attribute associations:
11771 @smallexample @c projectfile
11772 for Body ("main") use "Main.ada";
11773 for ^Switches^Switches^ ("main.ada")
11775 "^-gnatv^-gnatv^");
11776 for ^Switches^Switches^ ("main.ada")
11777 use Builder'^Switches^Switches^ ("main.ada")
11782 Like untyped variables and simple attributes, associative array attributes
11783 may be declared several times. Each declaration supplies a new value for the
11784 attribute, and replaces the previous setting.
11787 An associative array attribute may be declared as a full associative array
11788 declaration, with the value of the same attribute in an imported or extended
11791 @smallexample @c projectfile
11793 for Default_Switches use Default.Builder'Default_Switches;
11798 In this example, @code{Default} must be either an project imported by the
11799 current project, or the project that the current project extends. If the
11800 attribute is in a package (in this case, in package @code{Builder}), the same
11801 package needs to be specified.
11804 A full associative array declaration replaces any other declaration for the
11805 attribute, including other full associative array declaration. Single
11806 associative array associations may be declare after a full associative
11807 declaration, modifying the value for a single association of the attribute.
11809 @node case Constructions
11810 @subsection @code{case} Constructions
11813 A @code{case} construction is used in a project file to effect conditional
11815 Here is a typical example:
11817 @smallexample @c projectfile
11820 type OS_Type is ("GNU/Linux", "Unix", "NT", "VMS");
11822 OS : OS_Type := external ("OS", "GNU/Linux");
11826 package Compiler is
11828 when "GNU/Linux" | "Unix" =>
11829 for ^Default_Switches^Default_Switches^ ("Ada")
11830 use ("^-gnath^-gnath^");
11832 for ^Default_Switches^Default_Switches^ ("Ada")
11833 use ("^-gnatP^-gnatP^");
11842 The syntax of a @code{case} construction is based on the Ada case statement
11843 (although there is no @code{null} construction for empty alternatives).
11845 The case expression must a typed string variable.
11846 Each alternative comprises the reserved word @code{when}, either a list of
11847 literal strings separated by the @code{"|"} character or the reserved word
11848 @code{others}, and the @code{"=>"} token.
11849 Each literal string must belong to the string type that is the type of the
11851 An @code{others} alternative, if present, must occur last.
11853 After each @code{=>}, there are zero or more constructions. The only
11854 constructions allowed in a case construction are other case constructions and
11855 attribute declarations. String type declarations, variable declarations and
11856 package declarations are not allowed.
11858 The value of the case variable is often given by an external reference
11859 (@pxref{External References in Project Files}).
11861 @c ****************************************
11862 @c * Objects and Sources in Project Files *
11863 @c ****************************************
11865 @node Objects and Sources in Project Files
11866 @section Objects and Sources in Project Files
11869 * Object Directory::
11871 * Source Directories::
11872 * Source File Names::
11876 Each project has exactly one object directory and one or more source
11877 directories. The source directories must contain at least one source file,
11878 unless the project file explicitly specifies that no source files are present
11879 (@pxref{Source File Names}).
11881 @node Object Directory
11882 @subsection Object Directory
11885 The object directory for a project is the directory containing the compiler's
11886 output (such as @file{ALI} files and object files) for the project's immediate
11889 The object directory is given by the value of the attribute @code{Object_Dir}
11890 in the project file.
11892 @smallexample @c projectfile
11893 for Object_Dir use "objects";
11897 The attribute @var{Object_Dir} has a string value, the path name of the object
11898 directory. The path name may be absolute or relative to the directory of the
11899 project file. This directory must already exist, and be readable and writable.
11901 By default, when the attribute @code{Object_Dir} is not given an explicit value
11902 or when its value is the empty string, the object directory is the same as the
11903 directory containing the project file.
11905 @node Exec Directory
11906 @subsection Exec Directory
11909 The exec directory for a project is the directory containing the executables
11910 for the project's main subprograms.
11912 The exec directory is given by the value of the attribute @code{Exec_Dir}
11913 in the project file.
11915 @smallexample @c projectfile
11916 for Exec_Dir use "executables";
11920 The attribute @var{Exec_Dir} has a string value, the path name of the exec
11921 directory. The path name may be absolute or relative to the directory of the
11922 project file. This directory must already exist, and be writable.
11924 By default, when the attribute @code{Exec_Dir} is not given an explicit value
11925 or when its value is the empty string, the exec directory is the same as the
11926 object directory of the project file.
11928 @node Source Directories
11929 @subsection Source Directories
11932 The source directories of a project are specified by the project file
11933 attribute @code{Source_Dirs}.
11935 This attribute's value is a string list. If the attribute is not given an
11936 explicit value, then there is only one source directory, the one where the
11937 project file resides.
11939 A @code{Source_Dirs} attribute that is explicitly defined to be the empty list,
11942 @smallexample @c projectfile
11943 for Source_Dirs use ();
11947 indicates that the project contains no source files.
11949 Otherwise, each string in the string list designates one or more
11950 source directories.
11952 @smallexample @c projectfile
11953 for Source_Dirs use ("sources", "test/drivers");
11957 If a string in the list ends with @code{"/**"}, then the directory whose path
11958 name precedes the two asterisks, as well as all its subdirectories
11959 (recursively), are source directories.
11961 @smallexample @c projectfile
11962 for Source_Dirs use ("/system/sources/**");
11966 Here the directory @code{/system/sources} and all of its subdirectories
11967 (recursively) are source directories.
11969 To specify that the source directories are the directory of the project file
11970 and all of its subdirectories, you can declare @code{Source_Dirs} as follows:
11971 @smallexample @c projectfile
11972 for Source_Dirs use ("./**");
11976 Each of the source directories must exist and be readable.
11978 @node Source File Names
11979 @subsection Source File Names
11982 In a project that contains source files, their names may be specified by the
11983 attributes @code{Source_Files} (a string list) or @code{Source_List_File}
11984 (a string). Source file names never include any directory information.
11986 If the attribute @code{Source_Files} is given an explicit value, then each
11987 element of the list is a source file name.
11989 @smallexample @c projectfile
11990 for Source_Files use ("main.adb");
11991 for Source_Files use ("main.adb", "pack1.ads", "pack2.adb");
11995 If the attribute @code{Source_Files} is not given an explicit value,
11996 but the attribute @code{Source_List_File} is given a string value,
11997 then the source file names are contained in the text file whose path name
11998 (absolute or relative to the directory of the project file) is the
11999 value of the attribute @code{Source_List_File}.
12001 Each line in the file that is not empty or is not a comment
12002 contains a source file name.
12004 @smallexample @c projectfile
12005 for Source_List_File use "source_list.txt";
12009 By default, if neither the attribute @code{Source_Files} nor the attribute
12010 @code{Source_List_File} is given an explicit value, then each file in the
12011 source directories that conforms to the project's naming scheme
12012 (@pxref{Naming Schemes}) is an immediate source of the project.
12014 A warning is issued if both attributes @code{Source_Files} and
12015 @code{Source_List_File} are given explicit values. In this case, the attribute
12016 @code{Source_Files} prevails.
12018 Each source file name must be the name of one existing source file
12019 in one of the source directories.
12021 A @code{Source_Files} attribute whose value is an empty list
12022 indicates that there are no source files in the project.
12024 If the order of the source directories is known statically, that is if
12025 @code{"/**"} is not used in the string list @code{Source_Dirs}, then there may
12026 be several files with the same source file name. In this case, only the file
12027 in the first directory is considered as an immediate source of the project
12028 file. If the order of the source directories is not known statically, it is
12029 an error to have several files with the same source file name.
12031 Projects can be specified to have no Ada source
12032 files: the value of (@code{Source_Dirs} or @code{Source_Files} may be an empty
12033 list, or the @code{"Ada"} may be absent from @code{Languages}:
12035 @smallexample @c projectfile
12036 for Source_Dirs use ();
12037 for Source_Files use ();
12038 for Languages use ("C", "C++");
12042 Otherwise, a project must contain at least one immediate source.
12044 Projects with no source files are useful as template packages
12045 (@pxref{Packages in Project Files}) for other projects; in particular to
12046 define a package @code{Naming} (@pxref{Naming Schemes}).
12048 @c ****************************
12049 @c * Importing Projects *
12050 @c ****************************
12052 @node Importing Projects
12053 @section Importing Projects
12054 @cindex @code{ADA_PROJECT_PATH}
12057 An immediate source of a project P may depend on source files that
12058 are neither immediate sources of P nor in the predefined library.
12059 To get this effect, P must @emph{import} the projects that contain the needed
12062 @smallexample @c projectfile
12064 with "project1", "utilities.gpr";
12065 with "/namings/apex.gpr";
12072 As can be seen in this example, the syntax for importing projects is similar
12073 to the syntax for importing compilation units in Ada. However, project files
12074 use literal strings instead of names, and the @code{with} clause identifies
12075 project files rather than packages.
12077 Each literal string is the file name or path name (absolute or relative) of a
12078 project file. If a string corresponds to a file name, with no path or a
12079 relative path, then its location is determined by the @emph{project path}. The
12080 latter can be queried using @code{gnatls -v}. It contains:
12084 In first position, the directory containing the current project file.
12086 In last position, the default project directory. This default project directory
12087 is part of the GNAT installation and is the standard place to install project
12088 files giving access to standard support libraries.
12090 @ref{Installing a library}
12094 In between, all the directories referenced in the
12095 ^environment variable^logical name^ @env{ADA_PROJECT_PATH} if it exists.
12099 If a relative pathname is used, as in
12101 @smallexample @c projectfile
12106 then the full path for the project is constructed by concatenating this
12107 relative path to those in the project path, in order, until a matching file is
12108 found. Any symbolic link will be fully resolved in the directory of the
12109 importing project file before the imported project file is examined.
12111 If the @code{with}'ed project file name does not have an extension,
12112 the default is @file{^.gpr^.GPR^}. If a file with this extension is not found,
12113 then the file name as specified in the @code{with} clause (no extension) will
12114 be used. In the above example, if a file @code{project1.gpr} is found, then it
12115 will be used; otherwise, if a file @code{^project1^PROJECT1^} exists
12116 then it will be used; if neither file exists, this is an error.
12118 A warning is issued if the name of the project file does not match the
12119 name of the project; this check is case insensitive.
12121 Any source file that is an immediate source of the imported project can be
12122 used by the immediate sources of the importing project, transitively. Thus
12123 if @code{A} imports @code{B}, and @code{B} imports @code{C}, the immediate
12124 sources of @code{A} may depend on the immediate sources of @code{C}, even if
12125 @code{A} does not import @code{C} explicitly. However, this is not recommended,
12126 because if and when @code{B} ceases to import @code{C}, some sources in
12127 @code{A} will no longer compile.
12129 A side effect of this capability is that normally cyclic dependencies are not
12130 permitted: if @code{A} imports @code{B} (directly or indirectly) then @code{B}
12131 is not allowed to import @code{A}. However, there are cases when cyclic
12132 dependencies would be beneficial. For these cases, another form of import
12133 between projects exists, the @code{limited with}: a project @code{A} that
12134 imports a project @code{B} with a straigh @code{with} may also be imported,
12135 directly or indirectly, by @code{B} on the condition that imports from @code{B}
12136 to @code{A} include at least one @code{limited with}.
12138 @smallexample @c 0projectfile
12144 limited with "../a/a.gpr";
12152 limited with "../a/a.gpr";
12158 In the above legal example, there are two project cycles:
12161 @item A -> C -> D -> A
12165 In each of these cycle there is one @code{limited with}: import of @code{A}
12166 from @code{B} and import of @code{A} from @code{D}.
12168 The difference between straight @code{with} and @code{limited with} is that
12169 the name of a project imported with a @code{limited with} cannot be used in the
12170 project that imports it. In particular, its packages cannot be renamed and
12171 its variables cannot be referred to.
12173 An exception to the above rules for @code{limited with} is that for the main
12174 project specified to @command{gnatmake} or to the @command{GNAT} driver a
12175 @code{limited with} is equivalent to a straight @code{with}. For example,
12176 in the example above, projects @code{B} and @code{D} could not be main
12177 projects for @command{gnatmake} or to the @command{GNAT} driver, because they
12178 each have a @code{limited with} that is the only one in a cycle of importing
12181 @c *********************
12182 @c * Project Extension *
12183 @c *********************
12185 @node Project Extension
12186 @section Project Extension
12189 During development of a large system, it is sometimes necessary to use
12190 modified versions of some of the source files, without changing the original
12191 sources. This can be achieved through the @emph{project extension} facility.
12193 @smallexample @c projectfile
12194 project Modified_Utilities extends "/baseline/utilities.gpr" is ...
12198 A project extension declaration introduces an extending project
12199 (the @emph{child}) and a project being extended (the @emph{parent}).
12201 By default, a child project inherits all the sources of its parent.
12202 However, inherited sources can be overridden: a unit in a parent is hidden
12203 by a unit of the same name in the child.
12205 Inherited sources are considered to be sources (but not immediate sources)
12206 of the child project; see @ref{Project File Syntax}.
12208 An inherited source file retains any switches specified in the parent project.
12210 For example if the project @code{Utilities} contains the specification and the
12211 body of an Ada package @code{Util_IO}, then the project
12212 @code{Modified_Utilities} can contain a new body for package @code{Util_IO}.
12213 The original body of @code{Util_IO} will not be considered in program builds.
12214 However, the package specification will still be found in the project
12217 A child project can have only one parent but it may import any number of other
12220 A project is not allowed to import directly or indirectly at the same time a
12221 child project and any of its ancestors.
12223 @c *******************************
12224 @c * Project Hierarchy Extension *
12225 @c *******************************
12227 @node Project Hierarchy Extension
12228 @section Project Hierarchy Extension
12231 When extending a large system spanning multiple projects, it is often
12232 inconvenient to extend every project in the hierarchy that is impacted by a
12233 small change introduced. In such cases, it is possible to create a virtual
12234 extension of entire hierarchy using @code{extends all} relationship.
12236 When the project is extended using @code{extends all} inheritance, all projects
12237 that are imported by it, both directly and indirectly, are considered virtually
12238 extended. That is, the Project Manager creates "virtual projects"
12239 that extend every project in the hierarchy; all these virtual projects have
12240 no sources of their own and have as object directory the object directory of
12241 the root of "extending all" project.
12243 It is possible to explicitly extend one or more projects in the hierarchy
12244 in order to modify the sources. These extending projects must be imported by
12245 the "extending all" project, which will replace the corresponding virtual
12246 projects with the explicit ones.
12248 When building such a project hierarchy extension, the Project Manager will
12249 ensure that both modified sources and sources in virtual extending projects
12250 that depend on them, are recompiled.
12252 By means of example, consider the following hierarchy of projects.
12256 project A, containing package P1
12258 project B importing A and containing package P2 which depends on P1
12260 project C importing B and containing package P3 which depends on P2
12264 We want to modify packages P1 and P3.
12266 This project hierarchy will need to be extended as follows:
12270 Create project A1 that extends A, placing modified P1 there:
12272 @smallexample @c 0projectfile
12273 project A1 extends "(...)/A" is
12278 Create project C1 that "extends all" C and imports A1, placing modified
12281 @smallexample @c 0projectfile
12283 project C1 extends all "(...)/C" is
12288 When you build project C1, your entire modified project space will be
12289 recompiled, including the virtual project B1 that has been impacted by the
12290 "extending all" inheritance of project C.
12292 Note that if a Library Project in the hierarchy is virtually extended,
12293 the virtual project that extends the Library Project is not a Library Project.
12295 @c ****************************************
12296 @c * External References in Project Files *
12297 @c ****************************************
12299 @node External References in Project Files
12300 @section External References in Project Files
12303 A project file may contain references to external variables; such references
12304 are called @emph{external references}.
12306 An external variable is either defined as part of the environment (an
12307 environment variable in Unix, for example) or else specified on the command
12308 line via the @option{^-X^/EXTERNAL_REFERENCE=^@emph{vbl}=@emph{value}} switch.
12309 If both, then the command line value is used.
12311 The value of an external reference is obtained by means of the built-in
12312 function @code{external}, which returns a string value.
12313 This function has two forms:
12315 @item @code{external (external_variable_name)}
12316 @item @code{external (external_variable_name, default_value)}
12320 Each parameter must be a string literal. For example:
12322 @smallexample @c projectfile
12324 external ("OS", "GNU/Linux")
12328 In the form with one parameter, the function returns the value of
12329 the external variable given as parameter. If this name is not present in the
12330 environment, the function returns an empty string.
12332 In the form with two string parameters, the second argument is
12333 the value returned when the variable given as the first argument is not
12334 present in the environment. In the example above, if @code{"OS"} is not
12335 the name of ^an environment variable^a logical name^ and is not passed on
12336 the command line, then the returned value is @code{"GNU/Linux"}.
12338 An external reference may be part of a string expression or of a string
12339 list expression, and can therefore appear in a variable declaration or
12340 an attribute declaration.
12342 @smallexample @c projectfile
12344 type Mode_Type is ("Debug", "Release");
12345 Mode : Mode_Type := external ("MODE");
12352 @c *****************************
12353 @c * Packages in Project Files *
12354 @c *****************************
12356 @node Packages in Project Files
12357 @section Packages in Project Files
12360 A @emph{package} defines the settings for project-aware tools within a
12362 For each such tool one can declare a package; the names for these
12363 packages are preset (@pxref{Packages}).
12364 A package may contain variable declarations, attribute declarations, and case
12367 @smallexample @c projectfile
12370 package Builder is -- used by gnatmake
12371 for ^Default_Switches^Default_Switches^ ("Ada")
12380 The syntax of package declarations mimics that of package in Ada.
12382 Most of the packages have an attribute
12383 @code{^Default_Switches^Default_Switches^}.
12384 This attribute is an associative array, and its value is a string list.
12385 The index of the associative array is the name of a programming language (case
12386 insensitive). This attribute indicates the ^switch^switch^
12387 or ^switches^switches^ to be used
12388 with the corresponding tool.
12390 Some packages also have another attribute, @code{^Switches^Switches^},
12391 an associative array whose value is a string list.
12392 The index is the name of a source file.
12393 This attribute indicates the ^switch^switch^
12394 or ^switches^switches^ to be used by the corresponding
12395 tool when dealing with this specific file.
12397 Further information on these ^switch^switch^-related attributes is found in
12398 @ref{^Switches^Switches^ and Project Files}.
12400 A package may be declared as a @emph{renaming} of another package; e.g., from
12401 the project file for an imported project.
12403 @smallexample @c projectfile
12405 with "/global/apex.gpr";
12407 package Naming renames Apex.Naming;
12414 Packages that are renamed in other project files often come from project files
12415 that have no sources: they are just used as templates. Any modification in the
12416 template will be reflected automatically in all the project files that rename
12417 a package from the template.
12419 In addition to the tool-oriented packages, you can also declare a package
12420 named @code{Naming} to establish specialized source file naming conventions
12421 (@pxref{Naming Schemes}).
12423 @c ************************************
12424 @c * Variables from Imported Projects *
12425 @c ************************************
12427 @node Variables from Imported Projects
12428 @section Variables from Imported Projects
12431 An attribute or variable defined in an imported or parent project can
12432 be used in expressions in the importing / extending project.
12433 Such an attribute or variable is denoted by an expanded name whose prefix
12434 is either the name of the project or the expanded name of a package within
12437 @smallexample @c projectfile
12440 project Main extends "base" is
12441 Var1 := Imported.Var;
12442 Var2 := Base.Var & ".new";
12447 for ^Default_Switches^Default_Switches^ ("Ada")
12448 use Imported.Builder.Ada_^Switches^Switches^ &
12449 "^-gnatg^-gnatg^" &
12455 package Compiler is
12456 for ^Default_Switches^Default_Switches^ ("Ada")
12457 use Base.Compiler.Ada_^Switches^Switches^;
12468 The value of @code{Var1} is a copy of the variable @code{Var} defined
12469 in the project file @file{"imported.gpr"}
12471 the value of @code{Var2} is a copy of the value of variable @code{Var}
12472 defined in the project file @file{base.gpr}, concatenated with @code{".new"}
12474 attribute @code{^Default_Switches^Default_Switches^ ("Ada")} in package
12475 @code{Builder} is a string list that includes in its value a copy of the value
12476 of @code{Ada_^Switches^Switches^} defined in the @code{Builder} package
12477 in project file @file{imported.gpr} plus two new elements:
12478 @option{"^-gnatg^-gnatg^"}
12479 and @option{"^-v^-v^"};
12481 attribute @code{^Default_Switches^Default_Switches^ ("Ada")} in package
12482 @code{Compiler} is a copy of the variable @code{Ada_^Switches^Switches^}
12483 defined in the @code{Compiler} package in project file @file{base.gpr},
12484 the project being extended.
12487 @c ******************
12488 @c * Naming Schemes *
12489 @c ******************
12491 @node Naming Schemes
12492 @section Naming Schemes
12495 Sometimes an Ada software system is ported from a foreign compilation
12496 environment to GNAT, and the file names do not use the default GNAT
12497 conventions. Instead of changing all the file names (which for a variety
12498 of reasons might not be possible), you can define the relevant file
12499 naming scheme in the @code{Naming} package in your project file.
12502 Note that the use of pragmas described in
12503 @ref{Alternative File Naming Schemes} by mean of a configuration
12504 pragmas file is not supported when using project files. You must use
12505 the features described in this paragraph. You can however use specify
12506 other configuration pragmas (@pxref{Specifying Configuration Pragmas}).
12509 For example, the following
12510 package models the Apex file naming rules:
12512 @smallexample @c projectfile
12515 for Casing use "lowercase";
12516 for Dot_Replacement use ".";
12517 for Spec_Suffix ("Ada") use ".1.ada";
12518 for Body_Suffix ("Ada") use ".2.ada";
12525 For example, the following package models the DEC Ada file naming rules:
12527 @smallexample @c projectfile
12530 for Casing use "lowercase";
12531 for Dot_Replacement use "__";
12532 for Spec_Suffix ("Ada") use "_.^ada^ada^";
12533 for Body_Suffix ("Ada") use ".^ada^ada^";
12539 (Note that @code{Casing} is @code{"lowercase"} because GNAT gets the file
12540 names in lower case)
12544 You can define the following attributes in package @code{Naming}:
12549 This must be a string with one of the three values @code{"lowercase"},
12550 @code{"uppercase"} or @code{"mixedcase"}; these strings are case insensitive.
12553 If @var{Casing} is not specified, then the default is @code{"lowercase"}.
12555 @item @var{Dot_Replacement}
12556 This must be a string whose value satisfies the following conditions:
12559 @item It must not be empty
12560 @item It cannot start or end with an alphanumeric character
12561 @item It cannot be a single underscore
12562 @item It cannot start with an underscore followed by an alphanumeric
12563 @item It cannot contain a dot @code{'.'} except if the entire string
12568 If @code{Dot_Replacement} is not specified, then the default is @code{"-"}.
12570 @item @var{Spec_Suffix}
12571 This is an associative array (indexed by the programming language name, case
12572 insensitive) whose value is a string that must satisfy the following
12576 @item It must not be empty
12577 @item It must include at least one dot
12580 If @code{Spec_Suffix ("Ada")} is not specified, then the default is
12581 @code{"^.ads^.ADS^"}.
12583 @item @var{Body_Suffix}
12584 This is an associative array (indexed by the programming language name, case
12585 insensitive) whose value is a string that must satisfy the following
12589 @item It must not be empty
12590 @item It must include at least one dot
12591 @item It cannot end with the same string as @code{Spec_Suffix ("Ada")}
12594 If @code{Body_Suffix ("Ada")} is not specified, then the default is
12595 @code{"^.adb^.ADB^"}.
12597 @item @var{Separate_Suffix}
12598 This must be a string whose value satisfies the same conditions as
12599 @code{Body_Suffix}.
12602 If @code{Separate_Suffix ("Ada")} is not specified, then it defaults to same
12603 value as @code{Body_Suffix ("Ada")}.
12607 You can use the associative array attribute @code{Spec} to define
12608 the source file name for an individual Ada compilation unit's spec. The array
12609 index must be a string literal that identifies the Ada unit (case insensitive).
12610 The value of this attribute must be a string that identifies the file that
12611 contains this unit's spec (case sensitive or insensitive depending on the
12614 @smallexample @c projectfile
12615 for Spec ("MyPack.MyChild") use "mypack.mychild.spec";
12620 You can use the associative array attribute @code{Body} to
12621 define the source file name for an individual Ada compilation unit's body
12622 (possibly a subunit). The array index must be a string literal that identifies
12623 the Ada unit (case insensitive). The value of this attribute must be a string
12624 that identifies the file that contains this unit's body or subunit (case
12625 sensitive or insensitive depending on the operating system).
12627 @smallexample @c projectfile
12628 for Body ("MyPack.MyChild") use "mypack.mychild.body";
12632 @c ********************
12633 @c * Library Projects *
12634 @c ********************
12636 @node Library Projects
12637 @section Library Projects
12640 @emph{Library projects} are projects whose object code is placed in a library.
12641 (Note that this facility is not yet supported on all platforms)
12643 To create a library project, you need to define in its project file
12644 two project-level attributes: @code{Library_Name} and @code{Library_Dir}.
12645 Additionally, you may define the library-related attributes
12646 @code{Library_Kind}, @code{Library_Version}, @code{Library_Interface},
12647 @code{Library_Auto_Init}, @code{Library_Options} and @code{Library_GCC}.
12649 The @code{Library_Name} attribute has a string value. There is no restriction
12650 on the name of a library. It is the responsibility of the developer to
12651 choose a name that will be accepted by the platform. It is recommended to
12652 choose names that could be Ada identifiers; such names are almost guaranteed
12653 to be acceptable on all platforms.
12655 The @code{Library_Dir} attribute has a string value that designates the path
12656 (absolute or relative) of the directory where the library will reside.
12657 It must designate an existing directory, and this directory must be
12658 different from the project's object directory. It also needs to be writable.
12659 The directory should only be used for one library; the reason is that all
12660 files contained in this directory may be deleted by the Project Manager.
12662 If both @code{Library_Name} and @code{Library_Dir} are specified and
12663 are legal, then the project file defines a library project. The optional
12664 library-related attributes are checked only for such project files.
12666 The @code{Library_Kind} attribute has a string value that must be one of the
12667 following (case insensitive): @code{"static"}, @code{"dynamic"} or
12668 @code{"relocatable"} (which is a synonym for @code{"dynamic"}). If this
12669 attribute is not specified, the library is a static library, that is
12670 an archive of object files that can be potentially linked into an
12671 static executable. Otherwise, the library may be dynamic or
12672 relocatable, that is a library that is loaded only at the start of execution.
12674 If you need to build both a static and a dynamic library, you should use two
12675 different object directories, since in some cases some extra code needs to
12676 be generated for the latter. For such cases, it is recommended to either use
12677 two different project files, or a single one which uses external variables
12678 to indicate what kind of library should be build.
12680 The @code{Library_Version} attribute has a string value whose interpretation
12681 is platform dependent. It has no effect on VMS and Windows. On Unix, it is
12682 used only for dynamic/relocatable libraries as the internal name of the
12683 library (the @code{"soname"}). If the library file name (built from the
12684 @code{Library_Name}) is different from the @code{Library_Version}, then the
12685 library file will be a symbolic link to the actual file whose name will be
12686 @code{Library_Version}.
12690 @smallexample @c projectfile
12696 for Library_Dir use "lib_dir";
12697 for Library_Name use "dummy";
12698 for Library_Kind use "relocatable";
12699 for Library_Version use "libdummy.so." & Version;
12706 Directory @file{lib_dir} will contain the internal library file whose name
12707 will be @file{libdummy.so.1}, and @file{libdummy.so} will be a symbolic link to
12708 @file{libdummy.so.1}.
12710 When @command{gnatmake} detects that a project file
12711 is a library project file, it will check all immediate sources of the project
12712 and rebuild the library if any of the sources have been recompiled.
12714 Standard project files can import library project files. In such cases,
12715 the libraries will only be rebuild if some of its sources are recompiled
12716 because they are in the closure of some other source in an importing project.
12717 Sources of the library project files that are not in such a closure will
12718 not be checked, unless the full library is checked, because one of its sources
12719 needs to be recompiled.
12721 For instance, assume the project file @code{A} imports the library project file
12722 @code{L}. The immediate sources of A are @file{a1.adb}, @file{a2.ads} and
12723 @file{a2.adb}. The immediate sources of L are @file{l1.ads}, @file{l1.adb},
12724 @file{l2.ads}, @file{l2.adb}.
12726 If @file{l1.adb} has been modified, then the library associated with @code{L}
12727 will be rebuild when compiling all the immediate sources of @code{A} only
12728 if @file{a1.ads}, @file{a2.ads} or @file{a2.adb} includes a statement
12731 To be sure that all the sources in the library associated with @code{L} are
12732 up to date, and that all the sources of project @code{A} are also up to date,
12733 the following two commands needs to be used:
12740 When a library is built or rebuilt, an attempt is made first to delete all
12741 files in the library directory.
12742 All @file{ALI} files will also be copied from the object directory to the
12743 library directory. To build executables, @command{gnatmake} will use the
12744 library rather than the individual object files.
12747 It is also possible to create library project files for third-party libraries
12748 that are precompiled and cannot be compiled locally thanks to the
12749 @code{externally_built} attribute. (See @ref{Installing a library}).
12752 @c *******************************
12753 @c * Stand-alone Library Projects *
12754 @c *******************************
12756 @node Stand-alone Library Projects
12757 @section Stand-alone Library Projects
12760 A Stand-alone Library is a library that contains the necessary code to
12761 elaborate the Ada units that are included in the library. A Stand-alone
12762 Library is suitable to be used in an executable when the main is not
12763 in Ada. However, Stand-alone Libraries may also be used with an Ada main
12766 A Stand-alone Library Project is a Library Project where the library is
12767 a Stand-alone Library.
12769 To be a Stand-alone Library Project, in addition to the two attributes
12770 that make a project a Library Project (@code{Library_Name} and
12771 @code{Library_Dir}, see @ref{Library Projects}), the attribute
12772 @code{Library_Interface} must be defined.
12774 @smallexample @c projectfile
12776 for Library_Dir use "lib_dir";
12777 for Library_Name use "dummy";
12778 for Library_Interface use ("int1", "int1.child");
12782 Attribute @code{Library_Interface} has a non empty string list value,
12783 each string in the list designating a unit contained in an immediate source
12784 of the project file.
12786 When a Stand-alone Library is built, first the binder is invoked to build
12787 a package whose name depends on the library name
12788 (^b~dummy.ads/b^B$DUMMY.ADS/B^ in the example above).
12789 This binder-generated package includes initialization and
12790 finalization procedures whose
12791 names depend on the library name (dummyinit and dummyfinal in the example
12792 above). The object corresponding to this package is included in the library.
12794 A dynamic or relocatable Stand-alone Library is automatically initialized
12795 if automatic initialization of Stand-alone Libraries is supported on the
12796 platform and if attribute @code{Library_Auto_Init} is not specified or
12797 is specified with the value "true". A static Stand-alone Library is never
12798 automatically initialized.
12800 Single string attribute @code{Library_Auto_Init} may be specified with only
12801 two possible values: "false" or "true" (case-insensitive). Specifying
12802 "false" for attribute @code{Library_Auto_Init} will prevent automatic
12803 initialization of dynamic or relocatable libraries.
12805 When a non automatically initialized Stand-alone Library is used
12806 in an executable, its initialization procedure must be called before
12807 any service of the library is used.
12808 When the main subprogram is in Ada, it may mean that the initialization
12809 procedure has to be called during elaboration of another package.
12811 For a Stand-Alone Library, only the @file{ALI} files of the Interface Units
12812 (those that are listed in attribute @code{Library_Interface}) are copied to
12813 the Library Directory. As a consequence, only the Interface Units may be
12814 imported from Ada units outside of the library. If other units are imported,
12815 the binding phase will fail.
12817 When a Stand-Alone Library is bound, the switches that are specified in
12818 the attribute @code{Default_Switches ("Ada")} in package @code{Binder} are
12819 used in the call to @command{gnatbind}.
12821 The string list attribute @code{Library_Options} may be used to specified
12822 additional switches to the call to @command{gcc} to link the library.
12824 The attribute @code{Library_Src_Dir}, may be specified for a
12825 Stand-Alone Library. @code{Library_Src_Dir} is a simple attribute that has a
12826 single string value. Its value must be the path (absolute or relative to the
12827 project directory) of an existing directory. This directory cannot be the
12828 object directory or one of the source directories, but it can be the same as
12829 the library directory. The sources of the Interface
12830 Units of the library, necessary to an Ada client of the library, will be
12831 copied to the designated directory, called Interface Copy directory.
12832 These sources includes the specs of the Interface Units, but they may also
12833 include bodies and subunits, when pragmas @code{Inline} or @code{Inline_Always}
12834 are used, or when there is a generic units in the spec. Before the sources
12835 are copied to the Interface Copy directory, an attempt is made to delete all
12836 files in the Interface Copy directory.
12838 @c *************************************
12839 @c * Switches Related to Project Files *
12840 @c *************************************
12841 @node Switches Related to Project Files
12842 @section Switches Related to Project Files
12845 The following switches are used by GNAT tools that support project files:
12849 @item ^-P^/PROJECT_FILE=^@var{project}
12850 @cindex @option{^-P^/PROJECT_FILE^} (any tool supporting project files)
12851 Indicates the name of a project file. This project file will be parsed with
12852 the verbosity indicated by @option{^-vP^MESSAGE_PROJECT_FILES=^@emph{x}},
12853 if any, and using the external references indicated
12854 by @option{^-X^/EXTERNAL_REFERENCE^} switches, if any.
12856 There may zero, one or more spaces between @option{-P} and @var{project}.
12860 There must be only one @option{^-P^/PROJECT_FILE^} switch on the command line.
12863 Since the Project Manager parses the project file only after all the switches
12864 on the command line are checked, the order of the switches
12865 @option{^-P^/PROJECT_FILE^},
12866 @option{^-vP^/MESSAGES_PROJECT_FILE=^@emph{x}}
12867 or @option{^-X^/EXTERNAL_REFERENCE^} is not significant.
12869 @item ^-X^/EXTERNAL_REFERENCE=^@var{name=value}
12870 @cindex @option{^-X^/EXTERNAL_REFERENCE^} (any tool supporting project files)
12871 Indicates that external variable @var{name} has the value @var{value}.
12872 The Project Manager will use this value for occurrences of
12873 @code{external(name)} when parsing the project file.
12877 If @var{name} or @var{value} includes a space, then @var{name=value} should be
12878 put between quotes.
12886 Several @option{^-X^/EXTERNAL_REFERENCE^} switches can be used simultaneously.
12887 If several @option{^-X^/EXTERNAL_REFERENCE^} switches specify the same
12888 @var{name}, only the last one is used.
12891 An external variable specified with a @option{^-X^/EXTERNAL_REFERENCE^} switch
12892 takes precedence over the value of the same name in the environment.
12894 @item ^-vP^/MESSAGES_PROJECT_FILE=^@emph{x}
12895 @cindex @code{^-vP^/MESSAGES_PROJECT_FILE^} (any tool supporting project files)
12896 @c Previous line uses code vs option command, to stay less than 80 chars
12897 Indicates the verbosity of the parsing of GNAT project files.
12900 @option{-vP0} means Default;
12901 @option{-vP1} means Medium;
12902 @option{-vP2} means High.
12906 There are three possible options for this qualifier: DEFAULT, MEDIUM and
12911 The default is ^Default^DEFAULT^: no output for syntactically correct
12914 If several @option{^-vP^/MESSAGES_PROJECT_FILE=^@emph{x}} switches are present,
12915 only the last one is used.
12919 @c **********************************
12920 @c * Tools Supporting Project Files *
12921 @c **********************************
12923 @node Tools Supporting Project Files
12924 @section Tools Supporting Project Files
12927 * gnatmake and Project Files::
12928 * The GNAT Driver and Project Files::
12930 * Glide and Project Files::
12934 @node gnatmake and Project Files
12935 @subsection gnatmake and Project Files
12938 This section covers several topics related to @command{gnatmake} and
12939 project files: defining ^switches^switches^ for @command{gnatmake}
12940 and for the tools that it invokes; specifying configuration pragmas;
12941 the use of the @code{Main} attribute; building and rebuilding library project
12945 * ^Switches^Switches^ and Project Files::
12946 * Specifying Configuration Pragmas::
12947 * Project Files and Main Subprograms::
12948 * Library Project Files::
12951 @node ^Switches^Switches^ and Project Files
12952 @subsubsection ^Switches^Switches^ and Project Files
12955 It is not currently possible to specify VMS style qualifiers in the project
12956 files; only Unix style ^switches^switches^ may be specified.
12960 For each of the packages @code{Builder}, @code{Compiler}, @code{Binder}, and
12961 @code{Linker}, you can specify a @code{^Default_Switches^Default_Switches^}
12962 attribute, a @code{^Switches^Switches^} attribute, or both;
12963 as their names imply, these ^switch^switch^-related
12964 attributes affect the ^switches^switches^ that are used for each of these GNAT
12966 @command{gnatmake} is invoked. As will be explained below, these
12967 component-specific ^switches^switches^ precede
12968 the ^switches^switches^ provided on the @command{gnatmake} command line.
12970 The @code{^Default_Switches^Default_Switches^} attribute is an associative
12971 array indexed by language name (case insensitive) whose value is a string list.
12974 @smallexample @c projectfile
12976 package Compiler is
12977 for ^Default_Switches^Default_Switches^ ("Ada")
12978 use ("^-gnaty^-gnaty^",
12985 The @code{^Switches^Switches^} attribute is also an associative array,
12986 indexed by a file name (which may or may not be case sensitive, depending
12987 on the operating system) whose value is a string list. For example:
12989 @smallexample @c projectfile
12992 for ^Switches^Switches^ ("main1.adb")
12994 for ^Switches^Switches^ ("main2.adb")
13001 For the @code{Builder} package, the file names must designate source files
13002 for main subprograms. For the @code{Binder} and @code{Linker} packages, the
13003 file names must designate @file{ALI} or source files for main subprograms.
13004 In each case just the file name without an explicit extension is acceptable.
13006 For each tool used in a program build (@command{gnatmake}, the compiler, the
13007 binder, and the linker), the corresponding package @dfn{contributes} a set of
13008 ^switches^switches^ for each file on which the tool is invoked, based on the
13009 ^switch^switch^-related attributes defined in the package.
13010 In particular, the ^switches^switches^
13011 that each of these packages contributes for a given file @var{f} comprise:
13015 the value of attribute @code{^Switches^Switches^ (@var{f})},
13016 if it is specified in the package for the given file,
13018 otherwise, the value of @code{^Default_Switches^Default_Switches^ ("Ada")},
13019 if it is specified in the package.
13023 If neither of these attributes is defined in the package, then the package does
13024 not contribute any ^switches^switches^ for the given file.
13026 When @command{gnatmake} is invoked on a file, the ^switches^switches^ comprise
13027 two sets, in the following order: those contributed for the file
13028 by the @code{Builder} package;
13029 and the switches passed on the command line.
13031 When @command{gnatmake} invokes a tool (compiler, binder, linker) on a file,
13032 the ^switches^switches^ passed to the tool comprise three sets,
13033 in the following order:
13037 the applicable ^switches^switches^ contributed for the file
13038 by the @code{Builder} package in the project file supplied on the command line;
13041 those contributed for the file by the package (in the relevant project file --
13042 see below) corresponding to the tool; and
13045 the applicable switches passed on the command line.
13049 The term @emph{applicable ^switches^switches^} reflects the fact that
13050 @command{gnatmake} ^switches^switches^ may or may not be passed to individual
13051 tools, depending on the individual ^switch^switch^.
13053 @command{gnatmake} may invoke the compiler on source files from different
13054 projects. The Project Manager will use the appropriate project file to
13055 determine the @code{Compiler} package for each source file being compiled.
13056 Likewise for the @code{Binder} and @code{Linker} packages.
13058 As an example, consider the following package in a project file:
13060 @smallexample @c projectfile
13063 package Compiler is
13064 for ^Default_Switches^Default_Switches^ ("Ada")
13066 for ^Switches^Switches^ ("a.adb")
13068 for ^Switches^Switches^ ("b.adb")
13070 "^-gnaty^-gnaty^");
13077 If @command{gnatmake} is invoked with this project file, and it needs to
13078 compile, say, the files @file{a.adb}, @file{b.adb}, and @file{c.adb}, then
13079 @file{a.adb} will be compiled with the ^switch^switch^
13080 @option{^-O1^-O1^},
13081 @file{b.adb} with ^switches^switches^
13083 and @option{^-gnaty^-gnaty^},
13084 and @file{c.adb} with @option{^-g^-g^}.
13086 The following example illustrates the ordering of the ^switches^switches^
13087 contributed by different packages:
13089 @smallexample @c projectfile
13093 for ^Switches^Switches^ ("main.adb")
13101 package Compiler is
13102 for ^Switches^Switches^ ("main.adb")
13110 If you issue the command:
13113 gnatmake ^-Pproj2^/PROJECT_FILE=PROJ2^ -O0 main
13117 then the compiler will be invoked on @file{main.adb} with the following
13118 sequence of ^switches^switches^
13121 ^-g -O1 -O2 -O0^-g -O1 -O2 -O0^
13124 with the last @option{^-O^-O^}
13125 ^switch^switch^ having precedence over the earlier ones;
13126 several other ^switches^switches^
13127 (such as @option{^-c^-c^}) are added implicitly.
13129 The ^switches^switches^
13131 and @option{^-O1^-O1^} are contributed by package
13132 @code{Builder}, @option{^-O2^-O2^} is contributed
13133 by the package @code{Compiler}
13134 and @option{^-O0^-O0^} comes from the command line.
13136 The @option{^-g^-g^}
13137 ^switch^switch^ will also be passed in the invocation of
13138 @command{Gnatlink.}
13140 A final example illustrates switch contributions from packages in different
13143 @smallexample @c projectfile
13146 for Source_Files use ("pack.ads", "pack.adb");
13147 package Compiler is
13148 for ^Default_Switches^Default_Switches^ ("Ada")
13149 use ("^-gnata^-gnata^");
13157 for Source_Files use ("foo_main.adb", "bar_main.adb");
13159 for ^Switches^Switches^ ("foo_main.adb")
13167 -- Ada source file:
13169 procedure Foo_Main is
13177 gnatmake ^-PProj4^/PROJECT_FILE=PROJ4^ foo_main.adb -cargs -gnato
13181 then the ^switches^switches^ passed to the compiler for @file{foo_main.adb} are
13182 @option{^-g^-g^} (contributed by the package @code{Proj4.Builder}) and
13183 @option{^-gnato^-gnato^} (passed on the command line).
13184 When the imported package @code{Pack} is compiled, the ^switches^switches^ used
13185 are @option{^-g^-g^} from @code{Proj4.Builder},
13186 @option{^-gnata^-gnata^} (contributed from package @code{Proj3.Compiler},
13187 and @option{^-gnato^-gnato^} from the command line.
13190 When using @command{gnatmake} with project files, some ^switches^switches^ or
13191 arguments may be expressed as relative paths. As the working directory where
13192 compilation occurs may change, these relative paths are converted to absolute
13193 paths. For the ^switches^switches^ found in a project file, the relative paths
13194 are relative to the project file directory, for the switches on the command
13195 line, they are relative to the directory where @command{gnatmake} is invoked.
13196 The ^switches^switches^ for which this occurs are:
13202 ^-aI^-aI^, as well as all arguments that are not switches (arguments to
13204 ^-o^-o^, object files specified in package @code{Linker} or after
13205 -largs on the command line). The exception to this rule is the ^switch^switch^
13206 ^--RTS=^--RTS=^ for which a relative path argument is never converted.
13208 @node Specifying Configuration Pragmas
13209 @subsubsection Specifying Configuration Pragmas
13211 When using @command{gnatmake} with project files, if there exists a file
13212 @file{gnat.adc} that contains configuration pragmas, this file will be
13215 Configuration pragmas can be defined by means of the following attributes in
13216 project files: @code{Global_Configuration_Pragmas} in package @code{Builder}
13217 and @code{Local_Configuration_Pragmas} in package @code{Compiler}.
13219 Both these attributes are single string attributes. Their values is the path
13220 name of a file containing configuration pragmas. If a path name is relative,
13221 then it is relative to the project directory of the project file where the
13222 attribute is defined.
13224 When compiling a source, the configuration pragmas used are, in order,
13225 those listed in the file designated by attribute
13226 @code{Global_Configuration_Pragmas} in package @code{Builder} of the main
13227 project file, if it is specified, and those listed in the file designated by
13228 attribute @code{Local_Configuration_Pragmas} in package @code{Compiler} of
13229 the project file of the source, if it exists.
13231 @node Project Files and Main Subprograms
13232 @subsubsection Project Files and Main Subprograms
13235 When using a project file, you can invoke @command{gnatmake}
13236 with one or several main subprograms, by specifying their source files on the
13240 gnatmake ^-P^/PROJECT_FILE=^prj main1 main2 main3
13244 Each of these needs to be a source file of the same project, except
13245 when the switch ^-u^/UNIQUE^ is used.
13248 When ^-u^/UNIQUE^ is not used, all the mains need to be sources of the
13249 same project, one of the project in the tree rooted at the project specified
13250 on the command line. The package @code{Builder} of this common project, the
13251 "main project" is the one that is considered by @command{gnatmake}.
13254 When ^-u^/UNIQUE^ is used, the specified source files may be in projects
13255 imported directly or indirectly by the project specified on the command line.
13256 Note that if such a source file is not part of the project specified on the
13257 command line, the ^switches^switches^ found in package @code{Builder} of the
13258 project specified on the command line, if any, that are transmitted
13259 to the compiler will still be used, not those found in the project file of
13263 When using a project file, you can also invoke @command{gnatmake} without
13264 explicitly specifying any main, and the effect depends on whether you have
13265 defined the @code{Main} attribute. This attribute has a string list value,
13266 where each element in the list is the name of a source file (the file
13267 extension is optional) that contains a unit that can be a main subprogram.
13269 If the @code{Main} attribute is defined in a project file as a non-empty
13270 string list and the switch @option{^-u^/UNIQUE^} is not used on the command
13271 line, then invoking @command{gnatmake} with this project file but without any
13272 main on the command line is equivalent to invoking @command{gnatmake} with all
13273 the file names in the @code{Main} attribute on the command line.
13276 @smallexample @c projectfile
13279 for Main use ("main1", "main2", "main3");
13285 With this project file, @code{"gnatmake ^-Pprj^/PROJECT_FILE=PRJ^"}
13287 @code{"gnatmake ^-Pprj^/PROJECT_FILE=PRJ^ main1 main2 main3"}.
13289 When the project attribute @code{Main} is not specified, or is specified
13290 as an empty string list, or when the switch @option{-u} is used on the command
13291 line, then invoking @command{gnatmake} with no main on the command line will
13292 result in all immediate sources of the project file being checked, and
13293 potentially recompiled. Depending on the presence of the switch @option{-u},
13294 sources from other project files on which the immediate sources of the main
13295 project file depend are also checked and potentially recompiled. In other
13296 words, the @option{-u} switch is applied to all of the immediate sources of the
13299 When no main is specified on the command line and attribute @code{Main} exists
13300 and includes several mains, or when several mains are specified on the
13301 command line, the default ^switches^switches^ in package @code{Builder} will
13302 be used for all mains, even if there are specific ^switches^switches^
13303 specified for one or several mains.
13305 But the ^switches^switches^ from package @code{Binder} or @code{Linker} will be
13306 the specific ^switches^switches^ for each main, if they are specified.
13308 @node Library Project Files
13309 @subsubsection Library Project Files
13312 When @command{gnatmake} is invoked with a main project file that is a library
13313 project file, it is not allowed to specify one or more mains on the command
13317 When a library project file is specified, switches ^-b^/ACTION=BIND^ and
13318 ^-l^/ACTION=LINK^ have special meanings.
13321 @item ^-b^/ACTION=BIND^ is only allowed for stand-alone libraries. It indicates
13322 to @command{gnatmake} that @command{gnatbind} should be invoked for the
13325 @item ^-l^/ACTION=LINK^ may be used for all library projects. It indicates
13326 to @command{gnatmake} that the binder generated file should be compiled
13327 (in the case of a stand-alone library) and that the library should be built.
13331 @node The GNAT Driver and Project Files
13332 @subsection The GNAT Driver and Project Files
13335 A number of GNAT tools, other than @command{^gnatmake^gnatmake^}
13337 @command{^gnatbind^gnatbind^},
13338 @command{^gnatfind^gnatfind^},
13339 @command{^gnatlink^gnatlink^},
13340 @command{^gnatls^gnatls^},
13341 @command{^gnatelim^gnatelim^},
13342 @command{^gnatpp^gnatpp^},
13343 @command{^gnatmetric^gnatmetric^},
13344 @command{^gnatstub^gnatstub^},
13345 and @command{^gnatxref^gnatxref^}. However, none of these tools can be invoked
13346 directly with a project file switch (@option{^-P^/PROJECT_FILE=^}).
13347 They must be invoked through the @command{gnat} driver.
13349 The @command{gnat} driver is a front-end that accepts a number of commands and
13350 call the corresponding tool. It has been designed initially for VMS to convert
13351 VMS style qualifiers to Unix style switches, but it is now available to all
13352 the GNAT supported platforms.
13354 On non VMS platforms, the @command{gnat} driver accepts the following commands
13355 (case insensitive):
13359 BIND to invoke @command{^gnatbind^gnatbind^}
13361 CHOP to invoke @command{^gnatchop^gnatchop^}
13363 CLEAN to invoke @command{^gnatclean^gnatclean^}
13365 COMP or COMPILE to invoke the compiler
13367 ELIM to invoke @command{^gnatelim^gnatelim^}
13369 FIND to invoke @command{^gnatfind^gnatfind^}
13371 KR or KRUNCH to invoke @command{^gnatkr^gnatkr^}
13373 LINK to invoke @command{^gnatlink^gnatlink^}
13375 LS or LIST to invoke @command{^gnatls^gnatls^}
13377 MAKE to invoke @command{^gnatmake^gnatmake^}
13379 NAME to invoke @command{^gnatname^gnatname^}
13381 PREP or PREPROCESS to invoke @command{^gnatprep^gnatprep^}
13383 PP or PRETTY to invoke @command{^gnatpp^gnatpp^}
13385 METRIC to invoke @command{^gnatmetric^gnatmetric^}
13387 STUB to invoke @command{^gnatstub^gnatstub^}
13389 XREF to invoke @command{^gnatxref^gnatxref^}
13393 (note that the compiler is invoked using the command
13394 @command{^gnatmake -f -u -c^gnatmake -f -u -c^}).
13397 On non VMS platforms, between @command{gnat} and the command, two
13398 special switches may be used:
13402 @command{-v} to display the invocation of the tool.
13404 @command{-dn} to prevent the @command{gnat} driver from removing
13405 the temporary files it has created. These temporary files are
13406 configuration files and temporary file list files.
13410 The command may be followed by switches and arguments for the invoked
13414 gnat bind -C main.ali
13420 Switches may also be put in text files, one switch per line, and the text
13421 files may be specified with their path name preceded by '@@'.
13424 gnat bind @@args.txt main.ali
13428 In addition, for commands BIND, COMP or COMPILE, FIND, ELIM, LS or LIST, LINK,
13429 METRIC, PP or PRETTY, STUB and XREF, the project file related switches
13430 (@option{^-P^/PROJECT_FILE^},
13431 @option{^-X^/EXTERNAL_REFERENCE^} and
13432 @option{^-vP^/MESSAGES_PROJECT_FILE=^x}) may be used in addition to
13433 the switches of the invoking tool.
13436 When GNAT PP or GNAT PRETTY is used with a project file, but with no source
13437 specified on the command line, it invokes @command{^gnatpp^gnatpp^} with all
13438 the immediate sources of the specified project file.
13441 When GNAT METRIC is used with a project file, but with no source
13442 specified on the command line, it invokes @command{^gnatmetric^gnatmetric^}
13443 with all the immediate sources of the specified project file and with
13444 @option{^-d^/DIRECTORY^} with the parameter pointing to the object directory
13448 In addition, when GNAT PP, GNAT PRETTY or GNAT METRIC is used with
13449 a project file, no source is specified on the command line and
13450 switch ^-U^/ALL_PROJECTS^ is specified on the command line, then
13451 the underlying tool (^gnatpp^gnatpp^ or
13452 ^gnatmetric^gnatmetric^) is invoked for all sources of all projects,
13453 not only for the immediate sources of the main project.
13455 (-U stands for Universal or Union of the project files of the project tree)
13459 For each of the following commands, there is optionally a corresponding
13460 package in the main project.
13464 package @code{Binder} for command BIND (invoking @code{^gnatbind^gnatbind^})
13467 package @code{Compiler} for command COMP or COMPILE (invoking the compiler)
13470 package @code{Finder} for command FIND (invoking @code{^gnatfind^gnatfind^})
13473 package @code{Eliminate} for command ELIM (invoking
13474 @code{^gnatelim^gnatelim^})
13477 package @code{Gnatls} for command LS or LIST (invoking @code{^gnatls^gnatls^})
13480 package @code{Linker} for command LINK (invoking @code{^gnatlink^gnatlink^})
13483 package @code{Metrics} for command METRIC
13484 (invoking @code{^gnatmetric^gnatmetric^})
13487 package @code{Pretty_Printer} for command PP or PRETTY
13488 (invoking @code{^gnatpp^gnatpp^})
13491 package @code{Gnatstub} for command STUB
13492 (invoking @code{^gnatstub^gnatstub^})
13495 package @code{Cross_Reference} for command XREF (invoking
13496 @code{^gnatxref^gnatxref^})
13501 Package @code{Gnatls} has a unique attribute @code{^Switches^Switches^},
13502 a simple variable with a string list value. It contains ^switches^switches^
13503 for the invocation of @code{^gnatls^gnatls^}.
13505 @smallexample @c projectfile
13509 for ^Switches^Switches^
13518 All other packages have two attribute @code{^Switches^Switches^} and
13519 @code{^Default_Switches^Default_Switches^}.
13522 @code{^Switches^Switches^} is an associated array attribute, indexed by the
13523 source file name, that has a string list value: the ^switches^switches^ to be
13524 used when the tool corresponding to the package is invoked for the specific
13528 @code{^Default_Switches^Default_Switches^} is an associative array attribute,
13529 indexed by the programming language that has a string list value.
13530 @code{^Default_Switches^Default_Switches^ ("Ada")} contains the
13531 ^switches^switches^ for the invocation of the tool corresponding
13532 to the package, except if a specific @code{^Switches^Switches^} attribute
13533 is specified for the source file.
13535 @smallexample @c projectfile
13539 for Source_Dirs use ("./**");
13542 for ^Switches^Switches^ use
13549 package Compiler is
13550 for ^Default_Switches^Default_Switches^ ("Ada")
13551 use ("^-gnatv^-gnatv^",
13552 "^-gnatwa^-gnatwa^");
13558 for ^Default_Switches^Default_Switches^ ("Ada")
13566 for ^Default_Switches^Default_Switches^ ("Ada")
13568 for ^Switches^Switches^ ("main.adb")
13577 for ^Default_Switches^Default_Switches^ ("Ada")
13584 package Cross_Reference is
13585 for ^Default_Switches^Default_Switches^ ("Ada")
13590 end Cross_Reference;
13596 With the above project file, commands such as
13599 ^gnat comp -Pproj main^GNAT COMP /PROJECT_FILE=PROJ MAIN^
13600 ^gnat ls -Pproj main^GNAT LIST /PROJECT_FILE=PROJ MAIN^
13601 ^gnat xref -Pproj main^GNAT XREF /PROJECT_FILE=PROJ MAIN^
13602 ^gnat bind -Pproj main.ali^GNAT BIND /PROJECT_FILE=PROJ MAIN.ALI^
13603 ^gnat link -Pproj main.ali^GNAT LINK /PROJECT_FILE=PROJ MAIN.ALI^
13607 will set up the environment properly and invoke the tool with the switches
13608 found in the package corresponding to the tool:
13609 @code{^Default_Switches^Default_Switches^ ("Ada")} for all tools,
13610 except @code{^Switches^Switches^ ("main.adb")}
13611 for @code{^gnatlink^gnatlink^}.
13614 @node Glide and Project Files
13615 @subsection Glide and Project Files
13618 Glide will automatically recognize the @file{.gpr} extension for
13619 project files, and will
13620 convert them to its own internal format automatically. However, it
13621 doesn't provide a syntax-oriented editor for modifying these
13623 The project file will be loaded as text when you select the menu item
13624 @code{Ada} @result{} @code{Project} @result{} @code{Edit}.
13625 You can edit this text and save the @file{gpr} file;
13626 when you next select this project file in Glide it
13627 will be automatically reloaded.
13630 @c **********************
13631 @node An Extended Example
13632 @section An Extended Example
13635 Suppose that we have two programs, @var{prog1} and @var{prog2},
13636 whose sources are in corresponding directories. We would like
13637 to build them with a single @command{gnatmake} command, and we want to place
13638 their object files into @file{build} subdirectories of the source directories.
13639 Furthermore, we want to have to have two separate subdirectories
13640 in @file{build} -- @file{release} and @file{debug} -- which will contain
13641 the object files compiled with different set of compilation flags.
13643 In other words, we have the following structure:
13660 Here are the project files that we must place in a directory @file{main}
13661 to maintain this structure:
13665 @item We create a @code{Common} project with a package @code{Compiler} that
13666 specifies the compilation ^switches^switches^:
13671 @b{project} Common @b{is}
13673 @b{for} Source_Dirs @b{use} (); -- No source files
13677 @b{type} Build_Type @b{is} ("release", "debug");
13678 Build : Build_Type := External ("BUILD", "debug");
13681 @b{package} Compiler @b{is}
13682 @b{case} Build @b{is}
13683 @b{when} "release" =>
13684 @b{for} ^Default_Switches^Default_Switches^ ("Ada")
13685 @b{use} ("^-O2^-O2^");
13686 @b{when} "debug" =>
13687 @b{for} ^Default_Switches^Default_Switches^ ("Ada")
13688 @b{use} ("^-g^-g^");
13696 @item We create separate projects for the two programs:
13703 @b{project} Prog1 @b{is}
13705 @b{for} Source_Dirs @b{use} ("prog1");
13706 @b{for} Object_Dir @b{use} "prog1/build/" & Common.Build;
13708 @b{package} Compiler @b{renames} Common.Compiler;
13719 @b{project} Prog2 @b{is}
13721 @b{for} Source_Dirs @b{use} ("prog2");
13722 @b{for} Object_Dir @b{use} "prog2/build/" & Common.Build;
13724 @b{package} Compiler @b{renames} Common.Compiler;
13730 @item We create a wrapping project @code{Main}:
13739 @b{project} Main @b{is}
13741 @b{package} Compiler @b{renames} Common.Compiler;
13747 @item Finally we need to create a dummy procedure that @code{with}s (either
13748 explicitly or implicitly) all the sources of our two programs.
13753 Now we can build the programs using the command
13756 gnatmake ^-P^/PROJECT_FILE=^main dummy
13760 for the Debug mode, or
13764 gnatmake -Pmain -XBUILD=release
13770 GNAT MAKE /PROJECT_FILE=main /EXTERNAL_REFERENCE=BUILD=release
13775 for the Release mode.
13777 @c ********************************
13778 @c * Project File Complete Syntax *
13779 @c ********************************
13781 @node Project File Complete Syntax
13782 @section Project File Complete Syntax
13786 context_clause project_declaration
13792 @b{with} path_name @{ , path_name @} ;
13797 project_declaration ::=
13798 simple_project_declaration | project_extension
13800 simple_project_declaration ::=
13801 @b{project} <project_>simple_name @b{is}
13802 @{declarative_item@}
13803 @b{end} <project_>simple_name;
13805 project_extension ::=
13806 @b{project} <project_>simple_name @b{extends} path_name @b{is}
13807 @{declarative_item@}
13808 @b{end} <project_>simple_name;
13810 declarative_item ::=
13811 package_declaration |
13812 typed_string_declaration |
13813 other_declarative_item
13815 package_declaration ::=
13816 package_specification | package_renaming
13818 package_specification ::=
13819 @b{package} package_identifier @b{is}
13820 @{simple_declarative_item@}
13821 @b{end} package_identifier ;
13823 package_identifier ::=
13824 @code{Naming} | @code{Builder} | @code{Compiler} | @code{Binder} |
13825 @code{Linker} | @code{Finder} | @code{Cross_Reference} |
13826 @code{^gnatls^gnatls^} | @code{IDE} | @code{Pretty_Printer}
13828 package_renaming ::==
13829 @b{package} package_identifier @b{renames}
13830 <project_>simple_name.package_identifier ;
13832 typed_string_declaration ::=
13833 @b{type} <typed_string_>_simple_name @b{is}
13834 ( string_literal @{, string_literal@} );
13836 other_declarative_item ::=
13837 attribute_declaration |
13838 typed_variable_declaration |
13839 variable_declaration |
13842 attribute_declaration ::=
13843 full_associative_array_declaration |
13844 @b{for} attribute_designator @b{use} expression ;
13846 full_associative_array_declaration ::=
13847 @b{for} <associative_array_attribute_>simple_name @b{use}
13848 <project_>simple_name [ . <package_>simple_Name ] ' <attribute_>simple_name ;
13850 attribute_designator ::=
13851 <simple_attribute_>simple_name |
13852 <associative_array_attribute_>simple_name ( string_literal )
13854 typed_variable_declaration ::=
13855 <typed_variable_>simple_name : <typed_string_>name := string_expression ;
13857 variable_declaration ::=
13858 <variable_>simple_name := expression;
13868 attribute_reference
13874 ( <string_>expression @{ , <string_>expression @} )
13877 @b{external} ( string_literal [, string_literal] )
13879 attribute_reference ::=
13880 attribute_prefix ' <simple_attribute_>simple_name [ ( literal_string ) ]
13882 attribute_prefix ::=
13884 <project_>simple_name | package_identifier |
13885 <project_>simple_name . package_identifier
13887 case_construction ::=
13888 @b{case} <typed_variable_>name @b{is}
13893 @b{when} discrete_choice_list =>
13894 @{case_construction | attribute_declaration@}
13896 discrete_choice_list ::=
13897 string_literal @{| string_literal@} |
13901 simple_name @{. simple_name@}
13904 identifier (same as Ada)
13908 @node The Cross-Referencing Tools gnatxref and gnatfind
13909 @chapter The Cross-Referencing Tools @code{gnatxref} and @code{gnatfind}
13914 The compiler generates cross-referencing information (unless
13915 you set the @samp{-gnatx} switch), which are saved in the @file{.ali} files.
13916 This information indicates where in the source each entity is declared and
13917 referenced. Note that entities in package Standard are not included, but
13918 entities in all other predefined units are included in the output.
13920 Before using any of these two tools, you need to compile successfully your
13921 application, so that GNAT gets a chance to generate the cross-referencing
13924 The two tools @code{gnatxref} and @code{gnatfind} take advantage of this
13925 information to provide the user with the capability to easily locate the
13926 declaration and references to an entity. These tools are quite similar,
13927 the difference being that @code{gnatfind} is intended for locating
13928 definitions and/or references to a specified entity or entities, whereas
13929 @code{gnatxref} is oriented to generating a full report of all
13932 To use these tools, you must not compile your application using the
13933 @option{-gnatx} switch on the @command{gnatmake} command line
13934 (@pxref{The GNAT Make Program gnatmake}). Otherwise, cross-referencing
13935 information will not be generated.
13938 * gnatxref Switches::
13939 * gnatfind Switches::
13940 * Project Files for gnatxref and gnatfind::
13941 * Regular Expressions in gnatfind and gnatxref::
13942 * Examples of gnatxref Usage::
13943 * Examples of gnatfind Usage::
13946 @node gnatxref Switches
13947 @section @code{gnatxref} Switches
13950 The command invocation for @code{gnatxref} is:
13952 $ gnatxref [switches] sourcefile1 [sourcefile2 ...]
13959 @item sourcefile1, sourcefile2
13960 identifies the source files for which a report is to be generated. The
13961 ``with''ed units will be processed too. You must provide at least one file.
13963 These file names are considered to be regular expressions, so for instance
13964 specifying @file{source*.adb} is the same as giving every file in the current
13965 directory whose name starts with @file{source} and whose extension is
13968 You shouldn't specify any directory name, just base names. @command{gnatxref}
13969 and @command{gnatfind} will be able to locate these files by themselves using
13970 the source path. If you specify directories, no result is produced.
13975 The switches can be :
13978 @item ^-a^/ALL_FILES^
13979 @cindex @option{^-a^/ALL_FILES^} (@command{gnatxref})
13980 If this switch is present, @code{gnatfind} and @code{gnatxref} will parse
13981 the read-only files found in the library search path. Otherwise, these files
13982 will be ignored. This option can be used to protect Gnat sources or your own
13983 libraries from being parsed, thus making @code{gnatfind} and @code{gnatxref}
13984 much faster, and their output much smaller. Read-only here refers to access
13985 or permissions status in the file system for the current user.
13988 @cindex @option{-aIDIR} (@command{gnatxref})
13989 When looking for source files also look in directory DIR. The order in which
13990 source file search is undertaken is the same as for @command{gnatmake}.
13993 @cindex @option{-aODIR} (@command{gnatxref})
13994 When searching for library and object files, look in directory
13995 DIR. The order in which library files are searched is the same as for
13996 @command{gnatmake}.
13999 @cindex @option{-nostdinc} (@command{gnatxref})
14000 Do not look for sources in the system default directory.
14003 @cindex @option{-nostdlib} (@command{gnatxref})
14004 Do not look for library files in the system default directory.
14006 @item --RTS=@var{rts-path}
14007 @cindex @option{--RTS} (@command{gnatxref})
14008 Specifies the default location of the runtime library. Same meaning as the
14009 equivalent @command{gnatmake} flag (@pxref{Switches for gnatmake}).
14011 @item ^-d^/DERIVED_TYPES^
14012 @cindex @option{^-d^/DERIVED_TYPES^} (@command{gnatxref})
14013 If this switch is set @code{gnatxref} will output the parent type
14014 reference for each matching derived types.
14016 @item ^-f^/FULL_PATHNAME^
14017 @cindex @option{^-f^/FULL_PATHNAME^} (@command{gnatxref})
14018 If this switch is set, the output file names will be preceded by their
14019 directory (if the file was found in the search path). If this switch is
14020 not set, the directory will not be printed.
14022 @item ^-g^/IGNORE_LOCALS^
14023 @cindex @option{^-g^/IGNORE_LOCALS^} (@command{gnatxref})
14024 If this switch is set, information is output only for library-level
14025 entities, ignoring local entities. The use of this switch may accelerate
14026 @code{gnatfind} and @code{gnatxref}.
14029 @cindex @option{-IDIR} (@command{gnatxref})
14030 Equivalent to @samp{-aODIR -aIDIR}.
14033 @cindex @option{-pFILE} (@command{gnatxref})
14034 Specify a project file to use @xref{Project Files}. These project files are
14035 the @file{.adp} files used by Glide. If you need to use the @file{.gpr}
14036 project files, you should use gnatxref through the GNAT driver
14037 (@command{gnat xref -Pproject}).
14039 By default, @code{gnatxref} and @code{gnatfind} will try to locate a
14040 project file in the current directory.
14042 If a project file is either specified or found by the tools, then the content
14043 of the source directory and object directory lines are added as if they
14044 had been specified respectively by @samp{^-aI^/SOURCE_SEARCH^}
14045 and @samp{^-aO^OBJECT_SEARCH^}.
14047 Output only unused symbols. This may be really useful if you give your
14048 main compilation unit on the command line, as @code{gnatxref} will then
14049 display every unused entity and 'with'ed package.
14053 Instead of producing the default output, @code{gnatxref} will generate a
14054 @file{tags} file that can be used by vi. For examples how to use this
14055 feature, see @ref{Examples of gnatxref Usage}. The tags file is output
14056 to the standard output, thus you will have to redirect it to a file.
14062 All these switches may be in any order on the command line, and may even
14063 appear after the file names. They need not be separated by spaces, thus
14064 you can say @samp{gnatxref ^-ag^/ALL_FILES/IGNORE_LOCALS^} instead of
14065 @samp{gnatxref ^-a -g^/ALL_FILES /IGNORE_LOCALS^}.
14067 @node gnatfind Switches
14068 @section @code{gnatfind} Switches
14071 The command line for @code{gnatfind} is:
14074 $ gnatfind [switches] pattern[:sourcefile[:line[:column]]]
14083 An entity will be output only if it matches the regular expression found
14084 in @samp{pattern}, see @ref{Regular Expressions in gnatfind and gnatxref}.
14086 Omitting the pattern is equivalent to specifying @samp{*}, which
14087 will match any entity. Note that if you do not provide a pattern, you
14088 have to provide both a sourcefile and a line.
14090 Entity names are given in Latin-1, with uppercase/lowercase equivalence
14091 for matching purposes. At the current time there is no support for
14092 8-bit codes other than Latin-1, or for wide characters in identifiers.
14095 @code{gnatfind} will look for references, bodies or declarations
14096 of symbols referenced in @file{sourcefile}, at line @samp{line}
14097 and column @samp{column}. See @ref{Examples of gnatfind Usage}
14098 for syntax examples.
14101 is a decimal integer identifying the line number containing
14102 the reference to the entity (or entities) to be located.
14105 is a decimal integer identifying the exact location on the
14106 line of the first character of the identifier for the
14107 entity reference. Columns are numbered from 1.
14109 @item file1 file2 ...
14110 The search will be restricted to these source files. If none are given, then
14111 the search will be done for every library file in the search path.
14112 These file must appear only after the pattern or sourcefile.
14114 These file names are considered to be regular expressions, so for instance
14115 specifying 'source*.adb' is the same as giving every file in the current
14116 directory whose name starts with 'source' and whose extension is 'adb'.
14118 The location of the spec of the entity will always be displayed, even if it
14119 isn't in one of file1, file2,... The occurrences of the entity in the
14120 separate units of the ones given on the command line will also be displayed.
14122 Note that if you specify at least one file in this part, @code{gnatfind} may
14123 sometimes not be able to find the body of the subprograms...
14128 At least one of 'sourcefile' or 'pattern' has to be present on
14131 The following switches are available:
14135 @item ^-a^/ALL_FILES^
14136 @cindex @option{^-a^/ALL_FILES^} (@command{gnatfind})
14137 If this switch is present, @code{gnatfind} and @code{gnatxref} will parse
14138 the read-only files found in the library search path. Otherwise, these files
14139 will be ignored. This option can be used to protect Gnat sources or your own
14140 libraries from being parsed, thus making @code{gnatfind} and @code{gnatxref}
14141 much faster, and their output much smaller. Read-only here refers to access
14142 or permission status in the file system for the current user.
14145 @cindex @option{-aIDIR} (@command{gnatfind})
14146 When looking for source files also look in directory DIR. The order in which
14147 source file search is undertaken is the same as for @command{gnatmake}.
14150 @cindex @option{-aODIR} (@command{gnatfind})
14151 When searching for library and object files, look in directory
14152 DIR. The order in which library files are searched is the same as for
14153 @command{gnatmake}.
14156 @cindex @option{-nostdinc} (@command{gnatfind})
14157 Do not look for sources in the system default directory.
14160 @cindex @option{-nostdlib} (@command{gnatfind})
14161 Do not look for library files in the system default directory.
14163 @item --RTS=@var{rts-path}
14164 @cindex @option{--RTS} (@command{gnatfind})
14165 Specifies the default location of the runtime library. Same meaning as the
14166 equivalent @command{gnatmake} flag (@pxref{Switches for gnatmake}).
14168 @item ^-d^/DERIVED_TYPE_INFORMATION^
14169 @cindex @option{^-d^/DERIVED_TYPE_INFORMATION^} (@code{gnatfind})
14170 If this switch is set, then @code{gnatfind} will output the parent type
14171 reference for each matching derived types.
14173 @item ^-e^/EXPRESSIONS^
14174 @cindex @option{^-e^/EXPRESSIONS^} (@command{gnatfind})
14175 By default, @code{gnatfind} accept the simple regular expression set for
14176 @samp{pattern}. If this switch is set, then the pattern will be
14177 considered as full Unix-style regular expression.
14179 @item ^-f^/FULL_PATHNAME^
14180 @cindex @option{^-f^/FULL_PATHNAME^} (@command{gnatfind})
14181 If this switch is set, the output file names will be preceded by their
14182 directory (if the file was found in the search path). If this switch is
14183 not set, the directory will not be printed.
14185 @item ^-g^/IGNORE_LOCALS^
14186 @cindex @option{^-g^/IGNORE_LOCALS^} (@command{gnatfind})
14187 If this switch is set, information is output only for library-level
14188 entities, ignoring local entities. The use of this switch may accelerate
14189 @code{gnatfind} and @code{gnatxref}.
14192 @cindex @option{-IDIR} (@command{gnatfind})
14193 Equivalent to @samp{-aODIR -aIDIR}.
14196 @cindex @option{-pFILE} (@command{gnatfind})
14197 Specify a project file (@pxref{Project Files}) to use.
14198 By default, @code{gnatxref} and @code{gnatfind} will try to locate a
14199 project file in the current directory.
14201 If a project file is either specified or found by the tools, then the content
14202 of the source directory and object directory lines are added as if they
14203 had been specified respectively by @samp{^-aI^/SOURCE_SEARCH^} and
14204 @samp{^-aO^/OBJECT_SEARCH^}.
14206 @item ^-r^/REFERENCES^
14207 @cindex @option{^-r^/REFERENCES^} (@command{gnatfind})
14208 By default, @code{gnatfind} will output only the information about the
14209 declaration, body or type completion of the entities. If this switch is
14210 set, the @code{gnatfind} will locate every reference to the entities in
14211 the files specified on the command line (or in every file in the search
14212 path if no file is given on the command line).
14214 @item ^-s^/PRINT_LINES^
14215 @cindex @option{^-s^/PRINT_LINES^} (@command{gnatfind})
14216 If this switch is set, then @code{gnatfind} will output the content
14217 of the Ada source file lines were the entity was found.
14219 @item ^-t^/TYPE_HIERARCHY^
14220 @cindex @option{^-t^/TYPE_HIERARCHY^} (@command{gnatfind})
14221 If this switch is set, then @code{gnatfind} will output the type hierarchy for
14222 the specified type. It act like -d option but recursively from parent
14223 type to parent type. When this switch is set it is not possible to
14224 specify more than one file.
14229 All these switches may be in any order on the command line, and may even
14230 appear after the file names. They need not be separated by spaces, thus
14231 you can say @samp{gnatxref ^-ag^/ALL_FILES/IGNORE_LOCALS^} instead of
14232 @samp{gnatxref ^-a -g^/ALL_FILES /IGNORE_LOCALS^}.
14234 As stated previously, gnatfind will search in every directory in the
14235 search path. You can force it to look only in the current directory if
14236 you specify @code{*} at the end of the command line.
14238 @node Project Files for gnatxref and gnatfind
14239 @section Project Files for @command{gnatxref} and @command{gnatfind}
14242 Project files allow a programmer to specify how to compile its
14243 application, where to find sources, etc. These files are used
14245 primarily by the Glide Ada mode, but they can also be used
14248 @code{gnatxref} and @code{gnatfind}.
14250 A project file name must end with @file{.gpr}. If a single one is
14251 present in the current directory, then @code{gnatxref} and @code{gnatfind} will
14252 extract the information from it. If multiple project files are found, none of
14253 them is read, and you have to use the @samp{-p} switch to specify the one
14256 The following lines can be included, even though most of them have default
14257 values which can be used in most cases.
14258 The lines can be entered in any order in the file.
14259 Except for @file{src_dir} and @file{obj_dir}, you can only have one instance of
14260 each line. If you have multiple instances, only the last one is taken into
14265 [default: @code{"^./^[]^"}]
14266 specifies a directory where to look for source files. Multiple @code{src_dir}
14267 lines can be specified and they will be searched in the order they
14271 [default: @code{"^./^[]^"}]
14272 specifies a directory where to look for object and library files. Multiple
14273 @code{obj_dir} lines can be specified, and they will be searched in the order
14276 @item comp_opt=SWITCHES
14277 [default: @code{""}]
14278 creates a variable which can be referred to subsequently by using
14279 the @code{$@{comp_opt@}} notation. This is intended to store the default
14280 switches given to @command{gnatmake} and @command{gcc}.
14282 @item bind_opt=SWITCHES
14283 [default: @code{""}]
14284 creates a variable which can be referred to subsequently by using
14285 the @samp{$@{bind_opt@}} notation. This is intended to store the default
14286 switches given to @command{gnatbind}.
14288 @item link_opt=SWITCHES
14289 [default: @code{""}]
14290 creates a variable which can be referred to subsequently by using
14291 the @samp{$@{link_opt@}} notation. This is intended to store the default
14292 switches given to @command{gnatlink}.
14294 @item main=EXECUTABLE
14295 [default: @code{""}]
14296 specifies the name of the executable for the application. This variable can
14297 be referred to in the following lines by using the @samp{$@{main@}} notation.
14300 @item comp_cmd=COMMAND
14301 [default: @code{"GNAT COMPILE /SEARCH=$@{src_dir@} /DEBUG /TRY_SEMANTICS"}]
14304 @item comp_cmd=COMMAND
14305 [default: @code{"gcc -c -I$@{src_dir@} -g -gnatq"}]
14307 specifies the command used to compile a single file in the application.
14310 @item make_cmd=COMMAND
14311 [default: @code{"GNAT MAKE $@{main@}
14312 /SOURCE_SEARCH=$@{src_dir@} /OBJECT_SEARCH=$@{obj_dir@}
14313 /DEBUG /TRY_SEMANTICS /COMPILER_QUALIFIERS $@{comp_opt@}
14314 /BINDER_QUALIFIERS $@{bind_opt@} /LINKER_QUALIFIERS $@{link_opt@}"}]
14317 @item make_cmd=COMMAND
14318 [default: @code{"gnatmake $@{main@} -aI$@{src_dir@}
14319 -aO$@{obj_dir@} -g -gnatq -cargs $@{comp_opt@}
14320 -bargs $@{bind_opt@} -largs $@{link_opt@}"}]
14322 specifies the command used to recompile the whole application.
14324 @item run_cmd=COMMAND
14325 [default: @code{"$@{main@}"}]
14326 specifies the command used to run the application.
14328 @item debug_cmd=COMMAND
14329 [default: @code{"gdb $@{main@}"}]
14330 specifies the command used to debug the application
14335 @command{gnatxref} and @command{gnatfind} only take into account the
14336 @code{src_dir} and @code{obj_dir} lines, and ignore the others.
14338 @node Regular Expressions in gnatfind and gnatxref
14339 @section Regular Expressions in @code{gnatfind} and @code{gnatxref}
14342 As specified in the section about @command{gnatfind}, the pattern can be a
14343 regular expression. Actually, there are to set of regular expressions
14344 which are recognized by the program :
14347 @item globbing patterns
14348 These are the most usual regular expression. They are the same that you
14349 generally used in a Unix shell command line, or in a DOS session.
14351 Here is a more formal grammar :
14358 term ::= elmt -- matches elmt
14359 term ::= elmt elmt -- concatenation (elmt then elmt)
14360 term ::= * -- any string of 0 or more characters
14361 term ::= ? -- matches any character
14362 term ::= [char @{char@}] -- matches any character listed
14363 term ::= [char - char] -- matches any character in range
14367 @item full regular expression
14368 The second set of regular expressions is much more powerful. This is the
14369 type of regular expressions recognized by utilities such a @file{grep}.
14371 The following is the form of a regular expression, expressed in Ada
14372 reference manual style BNF is as follows
14379 regexp ::= term @{| term@} -- alternation (term or term ...)
14381 term ::= item @{item@} -- concatenation (item then item)
14383 item ::= elmt -- match elmt
14384 item ::= elmt * -- zero or more elmt's
14385 item ::= elmt + -- one or more elmt's
14386 item ::= elmt ? -- matches elmt or nothing
14389 elmt ::= nschar -- matches given character
14390 elmt ::= [nschar @{nschar@}] -- matches any character listed
14391 elmt ::= [^^^ nschar @{nschar@}] -- matches any character not listed
14392 elmt ::= [char - char] -- matches chars in given range
14393 elmt ::= \ char -- matches given character
14394 elmt ::= . -- matches any single character
14395 elmt ::= ( regexp ) -- parens used for grouping
14397 char ::= any character, including special characters
14398 nschar ::= any character except ()[].*+?^^^
14402 Following are a few examples :
14406 will match any of the two strings 'abcde' and 'fghi'.
14409 will match any string like 'abd', 'abcd', 'abccd', 'abcccd', and so on
14412 will match any string which has only lowercase characters in it (and at
14413 least one character
14418 @node Examples of gnatxref Usage
14419 @section Examples of @code{gnatxref} Usage
14421 @subsection General Usage
14424 For the following examples, we will consider the following units :
14426 @smallexample @c ada
14432 3: procedure Foo (B : in Integer);
14439 1: package body Main is
14440 2: procedure Foo (B : in Integer) is
14451 2: procedure Print (B : Integer);
14460 The first thing to do is to recompile your application (for instance, in
14461 that case just by doing a @samp{gnatmake main}, so that GNAT generates
14462 the cross-referencing information.
14463 You can then issue any of the following commands:
14465 @item gnatxref main.adb
14466 @code{gnatxref} generates cross-reference information for main.adb
14467 and every unit 'with'ed by main.adb.
14469 The output would be:
14477 Decl: main.ads 3:20
14478 Body: main.adb 2:20
14479 Ref: main.adb 4:13 5:13 6:19
14482 Ref: main.adb 6:8 7:8
14492 Decl: main.ads 3:15
14493 Body: main.adb 2:15
14496 Body: main.adb 1:14
14499 Ref: main.adb 6:12 7:12
14503 that is the entity @code{Main} is declared in main.ads, line 2, column 9,
14504 its body is in main.adb, line 1, column 14 and is not referenced any where.
14506 The entity @code{Print} is declared in bar.ads, line 2, column 15 and it
14507 it referenced in main.adb, line 6 column 12 and line 7 column 12.
14509 @item gnatxref package1.adb package2.ads
14510 @code{gnatxref} will generates cross-reference information for
14511 package1.adb, package2.ads and any other package 'with'ed by any
14517 @subsection Using gnatxref with vi
14519 @code{gnatxref} can generate a tags file output, which can be used
14520 directly from @file{vi}. Note that the standard version of @file{vi}
14521 will not work properly with overloaded symbols. Consider using another
14522 free implementation of @file{vi}, such as @file{vim}.
14525 $ gnatxref -v gnatfind.adb > tags
14529 will generate the tags file for @code{gnatfind} itself (if the sources
14530 are in the search path!).
14532 From @file{vi}, you can then use the command @samp{:tag @i{entity}}
14533 (replacing @i{entity} by whatever you are looking for), and vi will
14534 display a new file with the corresponding declaration of entity.
14537 @node Examples of gnatfind Usage
14538 @section Examples of @code{gnatfind} Usage
14542 @item gnatfind ^-f^/FULL_PATHNAME^ xyz:main.adb
14543 Find declarations for all entities xyz referenced at least once in
14544 main.adb. The references are search in every library file in the search
14547 The directories will be printed as well (as the @samp{^-f^/FULL_PATHNAME^}
14550 The output will look like:
14552 ^directory/^[directory]^main.ads:106:14: xyz <= declaration
14553 ^directory/^[directory]^main.adb:24:10: xyz <= body
14554 ^directory/^[directory]^foo.ads:45:23: xyz <= declaration
14558 that is to say, one of the entities xyz found in main.adb is declared at
14559 line 12 of main.ads (and its body is in main.adb), and another one is
14560 declared at line 45 of foo.ads
14562 @item gnatfind ^-fs^/FULL_PATHNAME/SOURCE_LINE^ xyz:main.adb
14563 This is the same command as the previous one, instead @code{gnatfind} will
14564 display the content of the Ada source file lines.
14566 The output will look like:
14569 ^directory/^[directory]^main.ads:106:14: xyz <= declaration
14571 ^directory/^[directory]^main.adb:24:10: xyz <= body
14573 ^directory/^[directory]^foo.ads:45:23: xyz <= declaration
14578 This can make it easier to find exactly the location your are looking
14581 @item gnatfind ^-r^/REFERENCES^ "*x*":main.ads:123 foo.adb
14582 Find references to all entities containing an x that are
14583 referenced on line 123 of main.ads.
14584 The references will be searched only in main.ads and foo.adb.
14586 @item gnatfind main.ads:123
14587 Find declarations and bodies for all entities that are referenced on
14588 line 123 of main.ads.
14590 This is the same as @code{gnatfind "*":main.adb:123}.
14592 @item gnatfind ^mydir/^[mydir]^main.adb:123:45
14593 Find the declaration for the entity referenced at column 45 in
14594 line 123 of file main.adb in directory mydir. Note that it
14595 is usual to omit the identifier name when the column is given,
14596 since the column position identifies a unique reference.
14598 The column has to be the beginning of the identifier, and should not
14599 point to any character in the middle of the identifier.
14603 @c *********************************
14604 @node The GNAT Pretty-Printer gnatpp
14605 @chapter The GNAT Pretty-Printer @command{gnatpp}
14607 @cindex Pretty-Printer
14610 ^The @command{gnatpp} tool^GNAT PRETTY^ is an ASIS-based utility
14611 for source reformatting / pretty-printing.
14612 It takes an Ada source file as input and generates a reformatted
14614 You can specify various style directives via switches; e.g.,
14615 identifier case conventions, rules of indentation, and comment layout.
14617 To produce a reformatted file, @command{gnatpp} generates and uses the ASIS
14618 tree for the input source and thus requires the input to be syntactically and
14619 semantically legal.
14620 If this condition is not met, @command{gnatpp} will terminate with an
14621 error message; no output file will be generated.
14623 If the compilation unit
14624 contained in the input source depends semantically upon units located
14625 outside the current directory, you have to provide the source search path
14626 when invoking @command{gnatpp}, if these units are contained in files with
14627 names that do not follow the GNAT file naming rules, you have to provide
14628 the configuration file describing the corresponding naming scheme;
14629 see the description of the @command{gnatpp}
14630 switches below. Another possibility is to use a project file and to
14631 call @command{gnatpp} through the @command{gnat} driver
14633 The @command{gnatpp} command has the form
14636 $ gnatpp [@var{switches}] @var{filename}
14643 @var{switches} is an optional sequence of switches defining such properties as
14644 the formatting rules, the source search path, and the destination for the
14648 @var{filename} is the name (including the extension) of the source file to
14649 reformat; ``wildcards'' or several file names on the same gnatpp command are
14650 allowed. The file name may contain path information; it does not have to
14651 follow the GNAT file naming rules
14655 * Switches for gnatpp::
14656 * Formatting Rules::
14659 @node Switches for gnatpp
14660 @section Switches for @command{gnatpp}
14663 The following subsections describe the various switches accepted by
14664 @command{gnatpp}, organized by category.
14667 You specify a switch by supplying a name and generally also a value.
14668 In many cases the values for a switch with a given name are incompatible with
14670 (for example the switch that controls the casing of a reserved word may have
14671 exactly one value: upper case, lower case, or
14672 mixed case) and thus exactly one such switch can be in effect for an
14673 invocation of @command{gnatpp}.
14674 If more than one is supplied, the last one is used.
14675 However, some values for the same switch are mutually compatible.
14676 You may supply several such switches to @command{gnatpp}, but then
14677 each must be specified in full, with both the name and the value.
14678 Abbreviated forms (the name appearing once, followed by each value) are
14680 For example, to set
14681 the alignment of the assignment delimiter both in declarations and in
14682 assignment statements, you must write @option{-A2A3}
14683 (or @option{-A2 -A3}), but not @option{-A23}.
14687 In many cases the set of options for a given qualifier are incompatible with
14688 each other (for example the qualifier that controls the casing of a reserved
14689 word may have exactly one option, which specifies either upper case, lower
14690 case, or mixed case), and thus exactly one such option can be in effect for
14691 an invocation of @command{gnatpp}.
14692 If more than one is supplied, the last one is used.
14693 However, some qualifiers have options that are mutually compatible,
14694 and then you may then supply several such options when invoking
14698 In most cases, it is obvious whether or not the
14699 ^values for a switch with a given name^options for a given qualifier^
14700 are compatible with each other.
14701 When the semantics might not be evident, the summaries below explicitly
14702 indicate the effect.
14705 * Alignment Control::
14707 * Construct Layout Control::
14708 * General Text Layout Control::
14709 * Other Formatting Options::
14710 * Setting the Source Search Path::
14711 * Output File Control::
14712 * Other gnatpp Switches::
14715 @node Alignment Control
14716 @subsection Alignment Control
14717 @cindex Alignment control in @command{gnatpp}
14720 Programs can be easier to read if certain constructs are vertically aligned.
14721 By default all alignments are set ON.
14722 Through the @option{^-A0^/ALIGN=OFF^} switch you may reset the default to
14723 OFF, and then use one or more of the other
14724 ^@option{-A@var{n}} switches^@option{/ALIGN} options^
14725 to activate alignment for specific constructs.
14728 @cindex @option{^-A@var{n}^/ALIGN^} (@command{gnatpp})
14732 Set all alignments to ON
14735 @item ^-A0^/ALIGN=OFF^
14736 Set all alignments to OFF
14738 @item ^-A1^/ALIGN=COLONS^
14739 Align @code{:} in declarations
14741 @item ^-A2^/ALIGN=DECLARATIONS^
14742 Align @code{:=} in initializations in declarations
14744 @item ^-A3^/ALIGN=STATEMENTS^
14745 Align @code{:=} in assignment statements
14747 @item ^-A4^/ALIGN=ARROWS^
14748 Align @code{=>} in associations
14750 @item ^-A5^/ALIGN=COMPONENT_CLAUSES^
14751 Align @code{at} keywords in the component clauses in record
14752 representation clauses
14756 The @option{^-A^/ALIGN^} switches are mutually compatible; any combination
14759 @node Casing Control
14760 @subsection Casing Control
14761 @cindex Casing control in @command{gnatpp}
14764 @command{gnatpp} allows you to specify the casing for reserved words,
14765 pragma names, attribute designators and identifiers.
14766 For identifiers you may define a
14767 general rule for name casing but also override this rule
14768 via a set of dictionary files.
14770 Three types of casing are supported: lower case, upper case, and mixed case.
14771 Lower and upper case are self-explanatory (but since some letters in
14772 Latin1 and other GNAT-supported character sets
14773 exist only in lower-case form, an upper case conversion will have no
14775 ``Mixed case'' means that the first letter, and also each letter immediately
14776 following an underscore, are converted to their uppercase forms;
14777 all the other letters are converted to their lowercase forms.
14780 @cindex @option{^-a@var{x}^/ATTRIBUTE^} (@command{gnatpp})
14781 @item ^-aL^/ATTRIBUTE_CASING=LOWER_CASE^
14782 Attribute designators are lower case
14784 @item ^-aU^/ATTRIBUTE_CASING=UPPER_CASE^
14785 Attribute designators are upper case
14787 @item ^-aM^/ATTRIBUTE_CASING=MIXED_CASE^
14788 Attribute designators are mixed case (this is the default)
14790 @cindex @option{^-k@var{x}^/KEYWORD_CASING^} (@command{gnatpp})
14791 @item ^-kL^/KEYWORD_CASING=LOWER_CASE^
14792 Keywords (technically, these are known in Ada as @emph{reserved words}) are
14793 lower case (this is the default)
14795 @item ^-kU^/KEYWORD_CASING=UPPER_CASE^
14796 Keywords are upper case
14798 @cindex @option{^-n@var{x}^/NAME_CASING^} (@command{gnatpp})
14799 @item ^-nD^/NAME_CASING=AS_DECLARED^
14800 Name casing for defining occurrences are as they appear in the source file
14801 (this is the default)
14803 @item ^-nU^/NAME_CASING=UPPER_CASE^
14804 Names are in upper case
14806 @item ^-nL^/NAME_CASING=LOWER_CASE^
14807 Names are in lower case
14809 @item ^-nM^/NAME_CASING=MIXED_CASE^
14810 Names are in mixed case
14812 @cindex @option{^-p@var{x}^/PRAGMA_CASING^} (@command{gnatpp})
14813 @item ^-pL^/PRAGMA_CASING=LOWER_CASE^
14814 Pragma names are lower case
14816 @item ^-pU^/PRAGMA_CASING=UPPER_CASE^
14817 Pragma names are upper case
14819 @item ^-pM^/PRAGMA_CASING=MIXED_CASE^
14820 Pragma names are mixed case (this is the default)
14822 @item ^-D@var{file}^/DICTIONARY=@var{file}^
14823 @cindex @option{^-D^/DICTIONARY^} (@command{gnatpp})
14824 Use @var{file} as a @emph{dictionary file} that defines
14825 the casing for a set of specified names,
14826 thereby overriding the effect on these names by
14827 any explicit or implicit
14828 ^-n^/NAME_CASING^ switch.
14829 To supply more than one dictionary file,
14830 use ^several @option{-D} switches^a list of files as options^.
14833 @option{gnatpp} implicitly uses a @emph{default dictionary file}
14834 to define the casing for the Ada predefined names and
14835 the names declared in the GNAT libraries.
14837 @item ^-D-^/SPECIFIC_CASING^
14838 @cindex @option{^-D-^/SPECIFIC_CASING^} (@command{gnatpp})
14839 Do not use the default dictionary file;
14840 instead, use the casing
14841 defined by a @option{^-n^/NAME_CASING^} switch and any explicit
14846 The structure of a dictionary file, and details on the conventions
14847 used in the default dictionary file, are defined in @ref{Name Casing}.
14849 The @option{^-D-^/SPECIFIC_CASING^} and
14850 @option{^-D@var{file}^/DICTIONARY=@var{file}^} switches are mutually
14853 @node Construct Layout Control
14854 @subsection Construct Layout Control
14855 @cindex Layout control in @command{gnatpp}
14858 This group of @command{gnatpp} switches controls the layout of comments and
14859 complex syntactic constructs. See @ref{Formatting Comments} for details
14863 @cindex @option{^-c@var{n}^/COMMENTS_LAYOUT^} (@command{gnatpp})
14864 @item ^-c0^/COMMENTS_LAYOUT=UNTOUCHED^
14865 All the comments remain unchanged
14867 @item ^-c1^/COMMENTS_LAYOUT=DEFAULT^
14868 GNAT-style comment line indentation (this is the default).
14870 @item ^-c2^/COMMENTS_LAYOUT=STANDARD_INDENT^
14871 Reference-manual comment line indentation.
14873 @item ^-c3^/COMMENTS_LAYOUT=GNAT_BEGINNING^
14874 GNAT-style comment beginning
14876 @item ^-c4^/COMMENTS_LAYOUT=REFORMAT^
14877 Reformat comment blocks
14879 @cindex @option{^-l@var{n}^/CONSTRUCT_LAYOUT^} (@command{gnatpp})
14880 @item ^-l1^/CONSTRUCT_LAYOUT=GNAT^
14881 GNAT-style layout (this is the default)
14883 @item ^-l2^/CONSTRUCT_LAYOUT=COMPACT^
14886 @item ^-l3^/CONSTRUCT_LAYOUT=UNCOMPACT^
14889 @cindex @option{^-N^/NOTABS^} (@command{gnatpp})
14891 All the VT characters are removed from the comment text. All the HT characters
14892 are expanded with the sequences of space characters to get to the next tab
14899 The @option{-c1} and @option{-c2} switches are incompatible.
14900 The @option{-c3} and @option{-c4} switches are compatible with each other and
14901 also with @option{-c1} and @option{-c2}. The @option{-c0} switch disables all
14902 the other comment formatting switches.
14904 The @option{-l1}, @option{-l2}, and @option{-l3} switches are incompatible.
14909 For the @option{/COMMENTS_LAYOUT} qualifier:
14912 The @option{DEFAULT} and @option{STANDARD_INDENT} options are incompatible.
14914 The @option{GNAT_BEGINNING} and @option{REFORMAT} options are compatible with
14915 each other and also with @option{DEFAULT} and @option{STANDARD_INDENT}.
14919 The @option{GNAT}, @option{COMPACT}, and @option{UNCOMPACT} options for the
14920 @option{/CONSTRUCT_LAYOUT} qualifier are incompatible.
14923 @node General Text Layout Control
14924 @subsection General Text Layout Control
14927 These switches allow control over line length and indentation.
14930 @item ^-M@i{nnn}^/LINE_LENGTH_MAX=@i{nnn}^
14931 @cindex @option{^-M^/LINE_LENGTH^} (@command{gnatpp})
14932 Maximum line length, @i{nnn} from 32 ..256, the default value is 79
14934 @item ^-i@i{nnn}^/INDENTATION_LEVEL=@i{nnn}^
14935 @cindex @option{^-i^/INDENTATION_LEVEL^} (@command{gnatpp})
14936 Indentation level, @i{nnn} from 1 .. 9, the default value is 3
14938 @item ^-cl@i{nnn}^/CONTINUATION_INDENT=@i{nnn}^
14939 @cindex @option{^-cl^/CONTINUATION_INDENT^} (@command{gnatpp})
14940 Indentation level for continuation lines (relative to the line being
14941 continued), @i{nnn} from 1 .. 9.
14943 value is one less then the (normal) indentation level, unless the
14944 indentation is set to 1 (in which case the default value for continuation
14945 line indentation is also 1)
14948 @node Other Formatting Options
14949 @subsection Other Formatting Options
14952 These switches control the inclusion of missing end/exit labels, and
14953 the indentation level in @b{case} statements.
14956 @item ^-e^/NO_MISSED_LABELS^
14957 @cindex @option{^-e^/NO_MISSED_LABELS^} (@command{gnatpp})
14958 Do not insert missing end/exit labels. An end label is the name of
14959 a construct that may optionally be repeated at the end of the
14960 construct's declaration;
14961 e.g., the names of packages, subprograms, and tasks.
14962 An exit label is the name of a loop that may appear as target
14963 of an exit statement within the loop.
14964 By default, @command{gnatpp} inserts these end/exit labels when
14965 they are absent from the original source. This option suppresses such
14966 insertion, so that the formatted source reflects the original.
14968 @item ^-ff^/FORM_FEED_AFTER_PRAGMA_PAGE^
14969 @cindex @option{^-ff^/FORM_FEED_AFTER_PRAGMA_PAGE^} (@command{gnatpp})
14970 Insert a Form Feed character after a pragma Page.
14972 @item ^-T@i{nnn}^/MAX_INDENT=@i{nnn}^
14973 @cindex @option{^-T^/MAX_INDENT^} (@command{gnatpp})
14974 Do not use an additional indentation level for @b{case} alternatives
14975 and variants if there are @i{nnn} or more (the default
14977 If @i{nnn} is 0, an additional indentation level is
14978 used for @b{case} alternatives and variants regardless of their number.
14981 @node Setting the Source Search Path
14982 @subsection Setting the Source Search Path
14985 To define the search path for the input source file, @command{gnatpp}
14986 uses the same switches as the GNAT compiler, with the same effects.
14989 @item ^-I^/SEARCH=^@var{dir}
14990 @cindex @option{^-I^/SEARCH^} (@code{gnatpp})
14991 The same as the corresponding gcc switch
14993 @item ^-I-^/NOCURRENT_DIRECTORY^
14994 @cindex @option{^-I-^/NOCURRENT_DIRECTORY^} (@code{gnatpp})
14995 The same as the corresponding gcc switch
14997 @item ^-gnatec^/CONFIGURATION_PRAGMAS_FILE^=@var{path}
14998 @cindex @option{^-gnatec^/CONFIGURATION_PRAGMAS_FILE^} (@code{gnatpp})
14999 The same as the corresponding gcc switch
15001 @item ^--RTS^/RUNTIME_SYSTEM^=@var{path}
15002 @cindex @option{^--RTS^/RUNTIME_SYSTEM^} (@code{gnatpp})
15003 The same as the corresponding gcc switch
15007 @node Output File Control
15008 @subsection Output File Control
15011 By default the output is sent to the file whose name is obtained by appending
15012 the ^@file{.pp}^@file{$PP}^ suffix to the name of the input file
15013 (if the file with this name already exists, it is unconditionally overwritten).
15014 Thus if the input file is @file{^my_ada_proc.adb^MY_ADA_PROC.ADB^} then
15015 @command{gnatpp} will produce @file{^my_ada_proc.adb.pp^MY_ADA_PROC.ADB$PP^}
15017 The output may be redirected by the following switches:
15020 @item ^-pipe^/STANDARD_OUTPUT^
15021 @cindex @option{^-pipe^/STANDARD_OUTPUT^} (@code{gnatpp})
15022 Send the output to @code{Standard_Output}
15024 @item ^-o @var{output_file}^/OUTPUT=@var{output_file}^
15025 @cindex @option{^-o^/OUTPUT^} (@code{gnatpp})
15026 Write the output into @var{output_file}.
15027 If @var{output_file} already exists, @command{gnatpp} terminates without
15028 reading or processing the input file.
15030 @item ^-of ^/FORCED_OUTPUT=^@var{output_file}
15031 @cindex @option{^-of^/FORCED_OUTPUT^} (@code{gnatpp})
15032 Write the output into @var{output_file}, overwriting the existing file
15033 (if one is present).
15035 @item ^-r^/REPLACE^
15036 @cindex @option{^-r^/REPLACE^} (@code{gnatpp})
15037 Replace the input source file with the reformatted output, and copy the
15038 original input source into the file whose name is obtained by appending the
15039 ^@file{.npp}^@file{$NPP}^ suffix to the name of the input file.
15040 If a file with this name already exists, @command{gnatpp} terminates without
15041 reading or processing the input file.
15043 @item ^-rf^/OVERRIDING_REPLACE^
15044 @cindex @option{^-rf^/OVERRIDING_REPLACE^} (@code{gnatpp})
15045 Like @option{^-r^/REPLACE^} except that if the file with the specified name
15046 already exists, it is overwritten.
15048 @item ^-rnb^/NO_BACKUP^
15049 @cindex @option{^-rnb^/NO_BACKUP^} (@code{gnatpp})
15050 Replace the input source file with the reformatted output without
15051 creating any backup copy of the input source.
15053 @item ^--eol=@var{xxx}^/END_OF_LINE=@var{xxx}^
15054 @cindex @option{^--eol^/END_OF_LINE^} (@code{gnatpp})
15055 Specifies the format of the reformatted output file. The @var{xxx}
15056 ^string specified with the switch^option^ may be either
15058 @item ``@option{^dos^DOS^}'' MS DOS style, lines end with CR LF characters
15059 @item ``@option{^crlf^CRLF^}''
15060 the same as @option{^crlf^CRLF^}
15061 @item ``@option{^unix^UNIX^}'' UNIX style, lines end with LF character
15062 @item ``@option{^lf^LF^}''
15063 the same as @option{^unix^UNIX^}
15069 Options @option{^-pipe^/STANDARD_OUTPUT^},
15070 @option{^-o^/OUTPUT^} and
15071 @option{^-of^/FORCED_OUTPUT^} are allowed only if the call to gnatpp
15072 contains only one file to reformat.
15074 @option{^--eol^/END_OF_LINE^}
15075 can not be used together
15076 with @option{^-pipe^/STANDARD_OUTPUT^} option.
15078 @node Other gnatpp Switches
15079 @subsection Other @code{gnatpp} Switches
15082 The additional @command{gnatpp} switches are defined in this subsection.
15085 @item ^-files @var{filename}^/FILES=@var{output_file}^
15086 @cindex @option{^-files^/FILES^} (@code{gnatpp})
15087 Take the argument source files from the specified file. This file should be an
15088 ordinary textual file containing file names separated by spaces or
15089 line breaks. You can use this switch more then once in the same call to
15090 @command{gnatpp}. You also can combine this switch with explicit list of
15093 @item ^-v^/VERBOSE^
15094 @cindex @option{^-v^/VERBOSE^} (@code{gnatpp})
15096 @command{gnatpp} generates version information and then
15097 a trace of the actions it takes to produce or obtain the ASIS tree.
15099 @item ^-w^/WARNINGS^
15100 @cindex @option{^-w^/WARNINGS^} (@code{gnatpp})
15102 @command{gnatpp} generates a warning whenever it can not provide
15103 a required layout in the result source.
15106 @node Formatting Rules
15107 @section Formatting Rules
15110 The following subsections show how @command{gnatpp} treats ``white space'',
15111 comments, program layout, and name casing.
15112 They provide the detailed descriptions of the switches shown above.
15115 * White Space and Empty Lines::
15116 * Formatting Comments::
15117 * Construct Layout::
15121 @node White Space and Empty Lines
15122 @subsection White Space and Empty Lines
15125 @command{gnatpp} does not have an option to control space characters.
15126 It will add or remove spaces according to the style illustrated by the
15127 examples in the @cite{Ada Reference Manual}.
15129 The only format effectors
15130 (see @cite{Ada Reference Manual}, paragraph 2.1(13))
15131 that will appear in the output file are platform-specific line breaks,
15132 and also format effectors within (but not at the end of) comments.
15133 In particular, each horizontal tab character that is not inside
15134 a comment will be treated as a space and thus will appear in the
15135 output file as zero or more spaces depending on
15136 the reformatting of the line in which it appears.
15137 The only exception is a Form Feed character, which is inserted after a
15138 pragma @code{Page} when @option{-ff} is set.
15140 The output file will contain no lines with trailing ``white space'' (spaces,
15143 Empty lines in the original source are preserved
15144 only if they separate declarations or statements.
15145 In such contexts, a
15146 sequence of two or more empty lines is replaced by exactly one empty line.
15147 Note that a blank line will be removed if it separates two ``comment blocks''
15148 (a comment block is a sequence of whole-line comments).
15149 In order to preserve a visual separation between comment blocks, use an
15150 ``empty comment'' (a line comprising only hyphens) rather than an empty line.
15151 Likewise, if for some reason you wish to have a sequence of empty lines,
15152 use a sequence of empty comments instead.
15154 @node Formatting Comments
15155 @subsection Formatting Comments
15158 Comments in Ada code are of two kinds:
15161 a @emph{whole-line comment}, which appears by itself (possibly preceded by
15162 ``white space'') on a line
15165 an @emph{end-of-line comment}, which follows some other Ada lexical element
15170 The indentation of a whole-line comment is that of either
15171 the preceding or following line in
15172 the formatted source, depending on switch settings as will be described below.
15174 For an end-of-line comment, @command{gnatpp} leaves the same number of spaces
15175 between the end of the preceding Ada lexical element and the beginning
15176 of the comment as appear in the original source,
15177 unless either the comment has to be split to
15178 satisfy the line length limitation, or else the next line contains a
15179 whole line comment that is considered a continuation of this end-of-line
15180 comment (because it starts at the same position).
15182 cases, the start of the end-of-line comment is moved right to the nearest
15183 multiple of the indentation level.
15184 This may result in a ``line overflow'' (the right-shifted comment extending
15185 beyond the maximum line length), in which case the comment is split as
15188 There is a difference between @option{^-c1^/COMMENTS_LAYOUT=DEFAULT^}
15189 (GNAT-style comment line indentation)
15190 and @option{^-c2^/COMMENTS_LAYOUT=STANDARD_INDENT^}
15191 (reference-manual comment line indentation).
15192 With reference-manual style, a whole-line comment is indented as if it
15193 were a declaration or statement at the same place
15194 (i.e., according to the indentation of the preceding line(s)).
15195 With GNAT style, a whole-line comment that is immediately followed by an
15196 @b{if} or @b{case} statement alternative, a record variant, or the reserved
15197 word @b{begin}, is indented based on the construct that follows it.
15200 @smallexample @c ada
15212 Reference-manual indentation produces:
15214 @smallexample @c ada
15226 while GNAT-style indentation produces:
15228 @smallexample @c ada
15240 The @option{^-c3^/COMMENTS_LAYOUT=GNAT_BEGINNING^} switch
15241 (GNAT style comment beginning) has the following
15246 For each whole-line comment that does not end with two hyphens,
15247 @command{gnatpp} inserts spaces if necessary after the starting two hyphens
15248 to ensure that there are at least two spaces between these hyphens and the
15249 first non-blank character of the comment.
15253 For an end-of-line comment, if in the original source the next line is a
15254 whole-line comment that starts at the same position
15255 as the end-of-line comment,
15256 then the whole-line comment (and all whole-line comments
15257 that follow it and that start at the same position)
15258 will start at this position in the output file.
15261 That is, if in the original source we have:
15263 @smallexample @c ada
15266 A := B + C; -- B must be in the range Low1..High1
15267 -- C must be in the range Low2..High2
15268 --B+C will be in the range Low1+Low2..High1+High2
15274 Then in the formatted source we get
15276 @smallexample @c ada
15279 A := B + C; -- B must be in the range Low1..High1
15280 -- C must be in the range Low2..High2
15281 -- B+C will be in the range Low1+Low2..High1+High2
15287 A comment that exceeds the line length limit will be split.
15289 @option{^-c4^/COMMENTS_LAYOUT=REFORMAT^} (reformat comment blocks) is set and
15290 the line belongs to a reformattable block, splitting the line generates a
15291 @command{gnatpp} warning.
15292 The @option{^-c4^/COMMENTS_LAYOUT=REFORMAT^} switch specifies that whole-line
15293 comments may be reformatted in typical
15294 word processor style (that is, moving words between lines and putting as
15295 many words in a line as possible).
15297 @node Construct Layout
15298 @subsection Construct Layout
15301 In several cases the suggested layout in the Ada Reference Manual includes
15302 an extra level of indentation that many programmers prefer to avoid. The
15303 affected cases include:
15307 @item Record type declaration (RM 3.8)
15309 @item Record representation clause (RM 13.5.1)
15311 @item Loop statement in case if a loop has a statement identifier (RM 5.6)
15313 @item Block statement in case if a block has a statement identifier (RM 5.6)
15317 In compact mode (when GNAT style layout or compact layout is set),
15318 the pretty printer uses one level of indentation instead
15319 of two. This is achieved in the record definition and record representation
15320 clause cases by putting the @code{record} keyword on the same line as the
15321 start of the declaration or representation clause, and in the block and loop
15322 case by putting the block or loop header on the same line as the statement
15326 The difference between GNAT style @option{^-l1^/CONSTRUCT_LAYOUT=GNAT^}
15327 and compact @option{^-l2^/CONSTRUCT_LAYOUT=COMPACT^}
15328 layout on the one hand, and uncompact layout
15329 @option{^-l3^/CONSTRUCT_LAYOUT=UNCOMPACT^} on the other hand,
15330 can be illustrated by the following examples:
15334 @multitable @columnfractions .5 .5
15335 @item @i{GNAT style, compact layout} @tab @i{Uncompact layout}
15338 @smallexample @c ada
15345 @smallexample @c ada
15354 @smallexample @c ada
15356 a at 0 range 0 .. 31;
15357 b at 4 range 0 .. 31;
15361 @smallexample @c ada
15364 a at 0 range 0 .. 31;
15365 b at 4 range 0 .. 31;
15370 @smallexample @c ada
15378 @smallexample @c ada
15388 @smallexample @c ada
15389 Clear : for J in 1 .. 10 loop
15394 @smallexample @c ada
15396 for J in 1 .. 10 loop
15407 GNAT style, compact layout Uncompact layout
15409 type q is record type q is
15410 a : integer; record
15411 b : integer; a : integer;
15412 end record; b : integer;
15415 for q use record for q use
15416 a at 0 range 0 .. 31; record
15417 b at 4 range 0 .. 31; a at 0 range 0 .. 31;
15418 end record; b at 4 range 0 .. 31;
15421 Block : declare Block :
15422 A : Integer := 3; declare
15423 begin A : Integer := 3;
15425 end Block; Proc (A, A);
15428 Clear : for J in 1 .. 10 loop Clear :
15429 A (J) := 0; for J in 1 .. 10 loop
15430 end loop Clear; A (J) := 0;
15437 A further difference between GNAT style layout and compact layout is that
15438 GNAT style layout inserts empty lines as separation for
15439 compound statements, return statements and bodies.
15442 @subsection Name Casing
15445 @command{gnatpp} always converts the usage occurrence of a (simple) name to
15446 the same casing as the corresponding defining identifier.
15448 You control the casing for defining occurrences via the
15449 @option{^-n^/NAME_CASING^} switch.
15451 With @option{-nD} (``as declared'', which is the default),
15454 With @option{/NAME_CASING=AS_DECLARED}, which is the default,
15456 defining occurrences appear exactly as in the source file
15457 where they are declared.
15458 The other ^values for this switch^options for this qualifier^ ---
15459 @option{^-nU^UPPER_CASE^},
15460 @option{^-nL^LOWER_CASE^},
15461 @option{^-nM^MIXED_CASE^} ---
15463 ^upper, lower, or mixed case, respectively^the corresponding casing^.
15464 If @command{gnatpp} changes the casing of a defining
15465 occurrence, it analogously changes the casing of all the
15466 usage occurrences of this name.
15468 If the defining occurrence of a name is not in the source compilation unit
15469 currently being processed by @command{gnatpp}, the casing of each reference to
15470 this name is changed according to the value of the @option{^-n^/NAME_CASING^}
15471 switch (subject to the dictionary file mechanism described below).
15472 Thus @command{gnatpp} acts as though the @option{^-n^/NAME_CASING^} switch
15474 casing for the defining occurrence of the name.
15476 Some names may need to be spelled with casing conventions that are not
15477 covered by the upper-, lower-, and mixed-case transformations.
15478 You can arrange correct casing by placing such names in a
15479 @emph{dictionary file},
15480 and then supplying a @option{^-D^/DICTIONARY^} switch.
15481 The casing of names from dictionary files overrides
15482 any @option{^-n^/NAME_CASING^} switch.
15484 To handle the casing of Ada predefined names and the names from GNAT libraries,
15485 @command{gnatpp} assumes a default dictionary file.
15486 The name of each predefined entity is spelled with the same casing as is used
15487 for the entity in the @cite{Ada Reference Manual}.
15488 The name of each entity in the GNAT libraries is spelled with the same casing
15489 as is used in the declaration of that entity.
15491 The @w{@option{^-D-^/SPECIFIC_CASING^}} switch suppresses the use of the
15492 default dictionary file.
15493 Instead, the casing for predefined and GNAT-defined names will be established
15494 by the @option{^-n^/NAME_CASING^} switch or explicit dictionary files.
15495 For example, by default the names @code{Ada.Text_IO} and @code{GNAT.OS_Lib}
15496 will appear as just shown,
15497 even in the presence of a @option{^-nU^/NAME_CASING=UPPER_CASE^} switch.
15498 To ensure that even such names are rendered in uppercase,
15499 additionally supply the @w{@option{^-D-^/SPECIFIC_CASING^}} switch
15500 (or else, less conveniently, place these names in upper case in a dictionary
15503 A dictionary file is
15504 a plain text file; each line in this file can be either a blank line
15505 (containing only space characters and ASCII.HT characters), an Ada comment
15506 line, or the specification of exactly one @emph{casing schema}.
15508 A casing schema is a string that has the following syntax:
15512 @var{casing_schema} ::= @var{identifier} | *@var{simple_identifier}*
15514 @var{simple_identifier} ::= @var{letter}@{@var{letter_or_digit}@}
15519 (See @cite{Ada Reference Manual}, Section 2.3) for the definition of the
15520 @var{identifier} lexical element and the @var{letter_or_digit} category.)
15522 The casing schema string can be followed by white space and/or an Ada-style
15523 comment; any amount of white space is allowed before the string.
15525 If a dictionary file is passed as
15527 the value of a @option{-D@var{file}} switch
15530 an option to the @option{/DICTIONARY} qualifier
15533 simple name and every identifier, @command{gnatpp} checks if the dictionary
15534 defines the casing for the name or for some of its parts (the term ``subword''
15535 is used below to denote the part of a name which is delimited by ``_'' or by
15536 the beginning or end of the word and which does not contain any ``_'' inside):
15540 if the whole name is in the dictionary, @command{gnatpp} uses for this name
15541 the casing defined by the dictionary; no subwords are checked for this word
15544 for every subword @command{gnatpp} checks if the dictionary contains the
15545 corresponding string of the form @code{*@var{simple_identifier}*},
15546 and if it does, the casing of this @var{simple_identifier} is used
15550 if the whole name does not contain any ``_'' inside, and if for this name
15551 the dictionary contains two entries - one of the form @var{identifier},
15552 and another - of the form *@var{simple_identifier}*, then the first one
15553 is applied to define the casing of this name
15556 if more than one dictionary file is passed as @command{gnatpp} switches, each
15557 dictionary adds new casing exceptions and overrides all the existing casing
15558 exceptions set by the previous dictionaries
15561 when @command{gnatpp} checks if the word or subword is in the dictionary,
15562 this check is not case sensitive
15566 For example, suppose we have the following source to reformat:
15568 @smallexample @c ada
15571 name1 : integer := 1;
15572 name4_name3_name2 : integer := 2;
15573 name2_name3_name4 : Boolean;
15576 name2_name3_name4 := name4_name3_name2 > name1;
15582 And suppose we have two dictionaries:
15599 If @command{gnatpp} is called with the following switches:
15603 @command{gnatpp -nM -D dict1 -D dict2 test.adb}
15606 @command{gnatpp test.adb /NAME_CASING=MIXED_CASE /DICTIONARY=(dict1, dict2)}
15611 then we will get the following name casing in the @command{gnatpp} output:
15613 @smallexample @c ada
15616 NAME1 : Integer := 1;
15617 Name4_NAME3_Name2 : Integer := 2;
15618 Name2_NAME3_Name4 : Boolean;
15621 Name2_NAME3_Name4 := Name4_NAME3_Name2 > NAME1;
15626 @c *********************************
15627 @node The GNAT Metric Tool gnatmetric
15628 @chapter The GNAT Metric Tool @command{gnatmetric}
15630 @cindex Metric tool
15633 ^The @command{gnatmetric} tool^@command{GNAT METRIC}^ is an ASIS-based utility
15634 for computing various program metrics.
15635 It takes an Ada source file as input and generates a file containing the
15636 metrics data as output. Various switches control which
15637 metrics are computed and output.
15639 @command{gnatmetric} generates and uses the ASIS
15640 tree for the input source and thus requires the input to be syntactically and
15641 semantically legal.
15642 If this condition is not met, @command{gnatmetric} will generate
15643 an error message; no metric information for this file will be
15644 computed and reported.
15646 If the compilation unit contained in the input source depends semantically
15647 upon units in files located outside the current directory, you have to provide
15648 the source search path when invoking @command{gnatmetric}.
15649 If it depends semantically upon units that are contained
15650 in files with names that do not follow the GNAT file naming rules, you have to
15651 provide the configuration file describing the corresponding naming scheme (see
15652 the description of the @command{gnatmetric} switches below.)
15653 Alternatively, you may use a project file and invoke @command{gnatmetric}
15654 through the @command{gnat} driver.
15657 The @command{gnatmetric} command has the form
15660 $ gnatmetric [@i{switches}] @{@i{filename}@} [@i{-cargs gcc_switches}]
15667 @i{switches} specify the metrics to compute and define the destination for
15671 Each @i{filename} is the name (including the extension) of a source
15672 file to process. ``Wildcards'' are allowed, and
15673 the file name may contain path information.
15674 If no @i{filename} is supplied, then the @i{switches} list must contain
15676 @option{-files} switch (@pxref{Other gnatmetric Switches}).
15677 Including both a @option{-files} switch and one or more
15678 @i{filename} arguments is permitted.
15681 @i{-cargs gcc_switches} is a list of switches for
15682 @command{gcc}. They will be passed on to all compiler invocations made by
15683 @command{gnatmetric} to generate the ASIS trees. Here you can provide
15684 @option{^-I^/INCLUDE_DIRS=^} switches to form the source search path,
15685 and use the @option{-gnatec} switch to set the configuration file.
15689 * Switches for gnatmetric::
15692 @node Switches for gnatmetric
15693 @section Switches for @command{gnatmetric}
15696 The following subsections describe the various switches accepted by
15697 @command{gnatmetric}, organized by category.
15700 * Output Files Control::
15701 * Disable Metrics For Local Units::
15702 * Line Metrics Control::
15703 * Syntax Metrics Control::
15704 * Complexity Metrics Control::
15705 * Other gnatmetric Switches::
15708 @node Output Files Control
15709 @subsection Output File Control
15710 @cindex Output file control in @command{gnatmetric}
15713 @command{gnatmetric} has two output formats. It can generate a
15714 textual (human-readable) form, and also XML. By default only textual
15715 output is generated.
15717 When generating the output in textual form, @command{gnatmetric} creates
15718 for each Ada source file a corresponding text file
15719 containing the computed metrics. By default, this file
15720 is placed in the same directory as where the source file is located, and
15721 its name is obtained
15722 by appending the ^@file{.metrix}^@file{$METRIX}^ suffix to the name of the
15725 All the output information generated in XML format is placed in a single
15726 file. By default this file is placed in the current directory and has the
15727 name ^@file{metrix.xml}^@file{METRIX$XML}^.
15729 Some of the computed metrics are summed over the units passed to
15730 @command{gnatmetric}; for example, the total number of lines of code.
15731 By default this information is sent to @file{stdout}, but a file
15732 can be specified with the @option{-og} switch.
15734 The following switches control the @command{gnatmetric} output:
15737 @cindex @option{^-x^/XML^} (@command{gnatmetric})
15739 Generate the XML output
15741 @cindex @option{^-nt^/NO_TEXT^} (@command{gnatmetric})
15742 @item ^-nt^/NO_TEXT^
15743 Do not generate the output in text form (implies @option{^-x^/XML^})
15745 @cindex @option{^-d^/DIRECTORY^} (@command{gnatmetric})
15746 @item ^-d @var{output_dir}^/DIRECTORY=@var{output_dir}^
15747 Put textual files with detailed metrics into @var{output_dir}
15749 @cindex @option{^-o^/SUFFIX_DETAILS^} (@command{gnatmetric})
15750 @item ^-o @var{file_suffix}^/SUFFIX_DETAILS=@var{file_suffix}^
15751 Use @var{file_suffix}, instead of ^@file{.metrix}^@file{$METRIX}^
15752 in the name of the output file.
15754 @cindex @option{^-og^/GLOBAL_OUTPUT^} (@command{gnatmetric})
15755 @item ^-og @var{file_name}^/GLOBAL_OUTPUT=@var{file_name}^
15756 Put global metrics into @var{file_name}
15758 @cindex @option{^-ox^/XML_OUTPUT^} (@command{gnatmetric})
15759 @item ^-ox @var{file_name}^/XML_OUTPUT=@var{file_name}^
15760 Put the XML output into @var{file_name} (also implies @option{^-x^/XML^})
15762 @cindex @option{^-sfn^/SHORT_SOURCE_FILE_NAME^} (@command{gnatmetric})
15763 @item ^-sfn^/SHORT_SOURCE_FILE_NAME^
15764 Use ``short'' source file names in the output. (The @command{gnatmetric}
15765 output includes the name(s) of the Ada source file(s) from which the metrics
15766 are computed. By default each name includes the absolute path. The
15767 @option{^-sfn^/SHORT_SOURCE_FILE_NAME^} switch causes @command{gnatmetric}
15768 to exclude all directory information from the file names that are output.)
15772 @node Disable Metrics For Local Units
15773 @subsection Disable Metrics For Local Units
15774 @cindex Disable Metrics For Local Units in @command{gnatmetric}
15777 @command{gnatmetric} relies on the GNAT compilation model @minus{}
15779 unit per one source file. It computes line metrics for the whole source
15780 file, and it also computes syntax
15781 and complexity metrics for the file's outermost unit.
15783 By default, @command{gnatmetric} will also compute all metrics for certain
15784 kinds of locally declared program units:
15788 subprogram (and generic subprogram) bodies;
15791 package (and generic package) specifications and bodies;
15794 task object and type specifications and bodies;
15797 protected object and type specifications and bodies.
15801 These kinds of entities will be referred to as
15802 @emph{eligible local program units}, or simply @emph{eligible local units},
15803 @cindex Eligible local unit (for @command{gnatmetric})
15804 in the discussion below.
15806 Note that a subprogram declaration, generic instantiation,
15807 or renaming declaration only receives metrics
15808 computation when it appear as the outermost entity
15811 Suppression of metrics computation for eligible local units can be
15812 obtained via the following switch:
15815 @cindex @option{^-n@var{x}^/SUPPRESS^} (@command{gnatmetric})
15816 @item ^-nolocal^/SUPPRESS=LOCAL_DETAILS^
15817 Do not compute detailed metrics for eligible local program units
15821 @node Line Metrics Control
15822 @subsection Line Metrics Control
15823 @cindex Line metrics control in @command{gnatmetric}
15826 For any (legal) source file, and for each of its
15827 eligible local program units, @command{gnatmetric} computes the following
15832 the total number of lines;
15835 the total number of code lines (i.e., non-blank lines that are not comments)
15838 the number of comment lines
15841 the number of code lines containing end-of-line comments;
15844 the number of empty lines and lines containing only space characters and/or
15845 format effectors (blank lines)
15849 If @command{gnatmetric} is invoked on more than one source file, it sums the
15850 values of the line metrics for all the files being processed and then
15851 generates the cumulative results.
15853 By default, all the line metrics are computed and reported. You can use the
15854 following switches to select the specific line metrics to be computed and
15855 reported (if any of these parameters is set, only explicitly specified line
15856 metrics are computed).
15859 @cindex @option{^-la^/LINES_ALL^} (@command{gnatmetric})
15860 @item ^-la^/LINES_ALL^
15861 The number of all lines
15863 @cindex @option{^-lcode^/CODE_LINES^} (@command{gnatmetric})
15864 @item ^-lcode^/CODE_LINES^
15865 The number of code lines
15867 @cindex @option{^-lcomm^/COMENT_LINES^} (@command{gnatmetric})
15868 @item ^-lcomm^/COMENT_LINES^
15869 The number of comment lines
15871 @cindex @option{^-leol^/MIXED_CODE_COMMENTS^} (@command{gnatmetric})
15872 @item ^-leol^/MIXED_CODE_COMMENTS^
15873 The number of code lines containing
15874 end-of-line comments
15876 @cindex @option{^-lb^/BLANK_LINES^} (@command{gnatmetric})
15877 @item ^-lb^/BLANK_LINES^
15878 The number of blank lines
15883 @node Syntax Metrics Control
15884 @subsection Syntax Metrics Control
15885 @cindex Syntax metrics control in @command{gnatmetric}
15888 @command{gnatmetric} computes various syntactic metrics for the
15889 outermost unit and for each eligible local unit:
15892 @item LSLOC (``Logical Source Lines Of Code'')
15893 The total number of declarations and the total number of statements
15895 @item Maximal static nesting level of inner program units
15897 @cite{Ada 95 Language Reference Manual}, 10.1(1), ``A program unit is either a
15898 package, a task unit, a protected unit, a
15899 protected entry, a generic unit, or an explicitly declared subprogram other
15900 than an enumeration literal.''
15902 @item Maximal nesting level of composite syntactic constructs
15903 This corresponds to the notion of the
15904 maximum nesting level in the GNAT built-in style checks
15905 (@pxref{Style Checking})
15909 For the outermost unit in the file, @command{gnatmetric} additionally computes
15910 the following metrics:
15913 @item Public subprograms
15914 This metric is computed for package specifications. It is the
15915 number of subprograms and generic subprograms declared in the visible
15916 part (including in nested packages, protected objects, and
15919 @item All subprograms
15920 This metric is computed for bodies and subunits. The
15921 metric is equal to a total number of subprogram bodies in the compilation
15923 Neither generic instantiations nor renamings-as-a-body nor body stubs
15924 are counted. Any subprogram body is counted, independently of its nesting
15925 level and enclosing constructs. Generic bodies and bodies of protected
15926 subprograms are counted in the same way as ``usual'' subprogram bodies.
15929 This metric is computed for package specifications and
15930 generic package declarations. It is the total number of types
15931 that can be referenced from outside this compilation unit, plus the
15932 number of types from all the visible parts of all the visible generic packages.
15933 Generic formal types are not counted. Only types, not subtypes,
15937 Along with the total number of public types, the following
15938 types are counted and reported separately:
15945 Root tagged types (abstract, non-abstract, private, non-private). Type
15946 extensions are @emph{not} counted
15949 Private types (including private extensions)
15960 This metric is computed for any compilation unit. It is equal to the total
15961 number of the declarations of different types given in the compilation unit.
15962 The private and the corresponding full type declaration are counted as one
15963 type declaration. Incomplete type declarations and generic formal types
15965 No distinction is made among different kinds of types (abstract,
15966 private etc.); the total number of types is computed and reported.
15971 By default, all the syntax metrics are computed and reported. You can use the
15972 following switches to select specific syntax metrics;
15973 if any of these is set, only the explicitly specified metrics are computed.
15976 @cindex @option{^-ed^/DECLARATION_TOTAL^} (@command{gnatmetric})
15977 @item ^-ed^/DECLARATION_TOTAL^
15978 The total number of declarations
15980 @cindex @option{^-es^/STATEMENT_TOTAL^} (@command{gnatmetric})
15981 @item ^-es^/STATEMENT_TOTAL^
15982 The total number of statements
15984 @cindex @option{^-eps^/^} (@command{gnatmetric})
15985 @item ^-eps^/INT_SUBPROGRAMS^
15986 The number of public subprograms in a compilation unit
15988 @cindex @option{^-eas^/SUBPROGRAMS_ALL^} (@command{gnatmetric})
15989 @item ^-eas^/SUBPROGRAMS_ALL^
15990 The number of all the subprograms in a compilation unit
15992 @cindex @option{^-ept^/INT_TYPES^} (@command{gnatmetric})
15993 @item ^-ept^/INT_TYPES^
15994 The number of public types in a compilation unit
15996 @cindex @option{^-eat^/TYPES_ALL^} (@command{gnatmetric})
15997 @item ^-eat^/TYPES_ALL^
15998 The number of all the types in a compilation unit
16000 @cindex @option{^-enu^/PROGRAM_NESTING_MAX^} (@command{gnatmetric})
16001 @item ^-enu^/PROGRAM_NESTING_MAX^
16002 The maximal program unit nesting level
16004 @cindex @option{^-ec^/CONSTRUCT_NESTING_MAX^} (@command{gnatmetric})
16005 @item ^-ec^/CONSTRUCT_NESTING_MAX^
16006 The maximal construct nesting level
16010 @node Complexity Metrics Control
16011 @subsection Complexity Metrics Control
16012 @cindex Complexity metrics control in @command{gnatmetric}
16015 For a program unit that is an executable body (a subprogram body (including
16016 generic bodies), task body, entry body or a package body containing
16017 its own statement sequence ) @command{gnatmetric} computes the following
16018 complexity metrics:
16022 McCabe cyclomatic complexity;
16025 McCabe essential complexity;
16028 maximal loop nesting level
16033 The McCabe complexity metrics are defined
16034 in @url{www.mccabe.com/pdf/nist235r.pdf}
16036 According to McCabe, both control statements and short-circuit control forms
16037 should be taken into account when computing cyclomatic complexity. For each
16038 body, we compute three metric values:
16042 the complexity introduced by control
16043 statements only, without taking into account short-circuit forms,
16046 the complexity introduced by short-circuit control forms only, and
16050 cyclomatic complexity, which is the sum of these two values.
16054 When computing cyclomatic and essential complexity, @command{gnatmetric} skips
16055 the code in the exception handlers and in all the nested program units.
16057 By default, all the complexity metrics are computed and reported.
16058 For more finely-grained control you can use
16059 the following switches:
16062 @cindex @option{^-n@var{x}^/SUPPRESS^} (@command{gnatmetric})
16064 @item ^-nocc^/SUPPRESS=CYCLOMATIC_COMPLEXITY^
16065 Do not compute the McCabe Cyclomatic Complexity
16067 @item ^-noec^/SUPPRESS=ESSENTIAL_COMPLEXITY^
16068 Do not compute the Essential Complexity
16070 @item ^-nonl^/SUPPRESS=MAXIMAL_LOOP_NESTING^
16071 Do not compute maximal loop nesting level
16073 @item ^-ne^/SUPPRESS=EXITS_AS_GOTOS^
16074 Do not consider @code{exit} statements as @code{goto}s when
16075 computing Essential Complexity
16079 @node Other gnatmetric Switches
16080 @subsection Other @code{gnatmetric} Switches
16083 Additional @command{gnatmetric} switches are as follows:
16086 @item ^-files @var{filename}^/FILES=@var{filename}^
16087 @cindex @option{^-files^/FILES^} (@code{gnatmetric})
16088 Take the argument source files from the specified file. This file should be an
16089 ordinary textual file containing file names separated by spaces or
16090 line breaks. You can use this switch more then once in the same call to
16091 @command{gnatmetric}. You also can combine this switch with
16092 an explicit list of files.
16094 @item ^-v^/VERBOSE^
16095 @cindex @option{^-v^/VERBOSE^} (@code{gnatmetric})
16097 @command{gnatmetric} generates version information and then
16098 a trace of sources being processed.
16100 @item ^-dv^/DEBUG_OUTPUT^
16101 @cindex @option{^-dv^/DEBUG_OUTPUT^} (@code{gnatmetric})
16103 @command{gnatmetric} generates various messages useful to understand what
16104 happens during the metrics computation
16107 @cindex @option{^-q^/QUIET^} (@code{gnatmetric})
16111 @c ***********************************
16112 @node File Name Krunching Using gnatkr
16113 @chapter File Name Krunching Using @code{gnatkr}
16117 This chapter discusses the method used by the compiler to shorten
16118 the default file names chosen for Ada units so that they do not
16119 exceed the maximum length permitted. It also describes the
16120 @code{gnatkr} utility that can be used to determine the result of
16121 applying this shortening.
16125 * Krunching Method::
16126 * Examples of gnatkr Usage::
16130 @section About @code{gnatkr}
16133 The default file naming rule in GNAT
16134 is that the file name must be derived from
16135 the unit name. The exact default rule is as follows:
16138 Take the unit name and replace all dots by hyphens.
16140 If such a replacement occurs in the
16141 second character position of a name, and the first character is
16142 ^a, g, s, or i^A, G, S, or I^ then replace the dot by the character
16143 ^~ (tilde)^$ (dollar sign)^
16144 instead of a minus.
16146 The reason for this exception is to avoid clashes
16147 with the standard names for children of System, Ada, Interfaces,
16148 and GNAT, which use the prefixes ^s- a- i- and g-^S- A- I- and G-^
16151 The @option{^-gnatk^/FILE_NAME_MAX_LENGTH=^@var{nn}}
16152 switch of the compiler activates a ``krunching''
16153 circuit that limits file names to nn characters (where nn is a decimal
16154 integer). For example, using OpenVMS,
16155 where the maximum file name length is
16156 39, the value of nn is usually set to 39, but if you want to generate
16157 a set of files that would be usable if ported to a system with some
16158 different maximum file length, then a different value can be specified.
16159 The default value of 39 for OpenVMS need not be specified.
16161 The @code{gnatkr} utility can be used to determine the krunched name for
16162 a given file, when krunched to a specified maximum length.
16165 @section Using @code{gnatkr}
16168 The @code{gnatkr} command has the form
16172 $ gnatkr @var{name} [@var{length}]
16178 $ gnatkr @var{name} /COUNT=nn
16183 @var{name} is the uncrunched file name, derived from the name of the unit
16184 in the standard manner described in the previous section (i.e. in particular
16185 all dots are replaced by hyphens). The file name may or may not have an
16186 extension (defined as a suffix of the form period followed by arbitrary
16187 characters other than period). If an extension is present then it will
16188 be preserved in the output. For example, when krunching @file{hellofile.ads}
16189 to eight characters, the result will be hellofil.ads.
16191 Note: for compatibility with previous versions of @code{gnatkr} dots may
16192 appear in the name instead of hyphens, but the last dot will always be
16193 taken as the start of an extension. So if @code{gnatkr} is given an argument
16194 such as @file{Hello.World.adb} it will be treated exactly as if the first
16195 period had been a hyphen, and for example krunching to eight characters
16196 gives the result @file{hellworl.adb}.
16198 Note that the result is always all lower case (except on OpenVMS where it is
16199 all upper case). Characters of the other case are folded as required.
16201 @var{length} represents the length of the krunched name. The default
16202 when no argument is given is ^8^39^ characters. A length of zero stands for
16203 unlimited, in other words do not chop except for system files where the
16204 implied crunching length is always eight characters.
16207 The output is the krunched name. The output has an extension only if the
16208 original argument was a file name with an extension.
16210 @node Krunching Method
16211 @section Krunching Method
16214 The initial file name is determined by the name of the unit that the file
16215 contains. The name is formed by taking the full expanded name of the
16216 unit and replacing the separating dots with hyphens and
16217 using ^lowercase^uppercase^
16218 for all letters, except that a hyphen in the second character position is
16219 replaced by a ^tilde^dollar sign^ if the first character is
16220 ^a, i, g, or s^A, I, G, or S^.
16221 The extension is @code{.ads} for a
16222 specification and @code{.adb} for a body.
16223 Krunching does not affect the extension, but the file name is shortened to
16224 the specified length by following these rules:
16228 The name is divided into segments separated by hyphens, tildes or
16229 underscores and all hyphens, tildes, and underscores are
16230 eliminated. If this leaves the name short enough, we are done.
16233 If the name is too long, the longest segment is located (left-most
16234 if there are two of equal length), and shortened by dropping
16235 its last character. This is repeated until the name is short enough.
16237 As an example, consider the krunching of @*@file{our-strings-wide_fixed.adb}
16238 to fit the name into 8 characters as required by some operating systems.
16241 our-strings-wide_fixed 22
16242 our strings wide fixed 19
16243 our string wide fixed 18
16244 our strin wide fixed 17
16245 our stri wide fixed 16
16246 our stri wide fixe 15
16247 our str wide fixe 14
16248 our str wid fixe 13
16254 Final file name: oustwifi.adb
16258 The file names for all predefined units are always krunched to eight
16259 characters. The krunching of these predefined units uses the following
16260 special prefix replacements:
16264 replaced by @file{^a^A^-}
16267 replaced by @file{^g^G^-}
16270 replaced by @file{^i^I^-}
16273 replaced by @file{^s^S^-}
16276 These system files have a hyphen in the second character position. That
16277 is why normal user files replace such a character with a
16278 ^tilde^dollar sign^, to
16279 avoid confusion with system file names.
16281 As an example of this special rule, consider
16282 @*@file{ada-strings-wide_fixed.adb}, which gets krunched as follows:
16285 ada-strings-wide_fixed 22
16286 a- strings wide fixed 18
16287 a- string wide fixed 17
16288 a- strin wide fixed 16
16289 a- stri wide fixed 15
16290 a- stri wide fixe 14
16291 a- str wide fixe 13
16297 Final file name: a-stwifi.adb
16301 Of course no file shortening algorithm can guarantee uniqueness over all
16302 possible unit names, and if file name krunching is used then it is your
16303 responsibility to ensure that no name clashes occur. The utility
16304 program @code{gnatkr} is supplied for conveniently determining the
16305 krunched name of a file.
16307 @node Examples of gnatkr Usage
16308 @section Examples of @code{gnatkr} Usage
16315 $ gnatkr very_long_unit_name.ads --> velounna.ads
16316 $ gnatkr grandparent-parent-child.ads --> grparchi.ads
16317 $ gnatkr Grandparent.Parent.Child.ads --> grparchi.ads
16318 $ gnatkr grandparent-parent-child --> grparchi
16320 $ gnatkr very_long_unit_name.ads/count=6 --> vlunna.ads
16321 $ gnatkr very_long_unit_name.ads/count=0 --> very_long_unit_name.ads
16324 @node Preprocessing Using gnatprep
16325 @chapter Preprocessing Using @code{gnatprep}
16329 The @code{gnatprep} utility provides
16330 a simple preprocessing capability for Ada programs.
16331 It is designed for use with GNAT, but is not dependent on any special
16336 * Switches for gnatprep::
16337 * Form of Definitions File::
16338 * Form of Input Text for gnatprep::
16341 @node Using gnatprep
16342 @section Using @code{gnatprep}
16345 To call @code{gnatprep} use
16348 $ gnatprep [-bcrsu] [-Dsymbol=value] infile outfile [deffile]
16355 is the full name of the input file, which is an Ada source
16356 file containing preprocessor directives.
16359 is the full name of the output file, which is an Ada source
16360 in standard Ada form. When used with GNAT, this file name will
16361 normally have an ads or adb suffix.
16364 is the full name of a text file containing definitions of
16365 symbols to be referenced by the preprocessor. This argument is
16366 optional, and can be replaced by the use of the @option{-D} switch.
16369 is an optional sequence of switches as described in the next section.
16372 @node Switches for gnatprep
16373 @section Switches for @code{gnatprep}
16378 @item ^-b^/BLANK_LINES^
16379 @cindex @option{^-b^/BLANK_LINES^} (@command{gnatprep})
16380 Causes both preprocessor lines and the lines deleted by
16381 preprocessing to be replaced by blank lines in the output source file,
16382 preserving line numbers in the output file.
16384 @item ^-c^/COMMENTS^
16385 @cindex @option{^-c^/COMMENTS^} (@command{gnatprep})
16386 Causes both preprocessor lines and the lines deleted
16387 by preprocessing to be retained in the output source as comments marked
16388 with the special string @code{"--! "}. This option will result in line numbers
16389 being preserved in the output file.
16391 @item ^-Dsymbol=value^/ASSOCIATE="symbol=value"^
16392 @cindex @option{^-D^/ASSOCIATE^} (@command{gnatprep})
16393 Defines a new symbol, associated with value. If no value is given on the
16394 command line, then symbol is considered to be @code{True}. This switch
16395 can be used in place of a definition file.
16399 @cindex @option{/REMOVE} (@command{gnatprep})
16400 This is the default setting which causes lines deleted by preprocessing
16401 to be entirely removed from the output file.
16404 @item ^-r^/REFERENCE^
16405 @cindex @option{^-r^/REFERENCE^} (@command{gnatprep})
16406 Causes a @code{Source_Reference} pragma to be generated that
16407 references the original input file, so that error messages will use
16408 the file name of this original file. The use of this switch implies
16409 that preprocessor lines are not to be removed from the file, so its
16410 use will force @option{^-b^/BLANK_LINES^} mode if
16411 @option{^-c^/COMMENTS^}
16412 has not been specified explicitly.
16414 Note that if the file to be preprocessed contains multiple units, then
16415 it will be necessary to @code{gnatchop} the output file from
16416 @code{gnatprep}. If a @code{Source_Reference} pragma is present
16417 in the preprocessed file, it will be respected by
16418 @code{gnatchop ^-r^/REFERENCE^}
16419 so that the final chopped files will correctly refer to the original
16420 input source file for @code{gnatprep}.
16422 @item ^-s^/SYMBOLS^
16423 @cindex @option{^-s^/SYMBOLS^} (@command{gnatprep})
16424 Causes a sorted list of symbol names and values to be
16425 listed on the standard output file.
16427 @item ^-u^/UNDEFINED^
16428 @cindex @option{^-u^/UNDEFINED^} (@command{gnatprep})
16429 Causes undefined symbols to be treated as having the value FALSE in the context
16430 of a preprocessor test. In the absence of this option, an undefined symbol in
16431 a @code{#if} or @code{#elsif} test will be treated as an error.
16437 Note: if neither @option{-b} nor @option{-c} is present,
16438 then preprocessor lines and
16439 deleted lines are completely removed from the output, unless -r is
16440 specified, in which case -b is assumed.
16443 @node Form of Definitions File
16444 @section Form of Definitions File
16447 The definitions file contains lines of the form
16454 where symbol is an identifier, following normal Ada (case-insensitive)
16455 rules for its syntax, and value is one of the following:
16459 Empty, corresponding to a null substitution
16461 A string literal using normal Ada syntax
16463 Any sequence of characters from the set
16464 (letters, digits, period, underline).
16468 Comment lines may also appear in the definitions file, starting with
16469 the usual @code{--},
16470 and comments may be added to the definitions lines.
16472 @node Form of Input Text for gnatprep
16473 @section Form of Input Text for @code{gnatprep}
16476 The input text may contain preprocessor conditional inclusion lines,
16477 as well as general symbol substitution sequences.
16479 The preprocessor conditional inclusion commands have the form
16484 #if @i{expression} [then]
16486 #elsif @i{expression} [then]
16488 #elsif @i{expression} [then]
16499 In this example, @i{expression} is defined by the following grammar:
16501 @i{expression} ::= <symbol>
16502 @i{expression} ::= <symbol> = "<value>"
16503 @i{expression} ::= <symbol> = <symbol>
16504 @i{expression} ::= <symbol> 'Defined
16505 @i{expression} ::= not @i{expression}
16506 @i{expression} ::= @i{expression} and @i{expression}
16507 @i{expression} ::= @i{expression} or @i{expression}
16508 @i{expression} ::= @i{expression} and then @i{expression}
16509 @i{expression} ::= @i{expression} or else @i{expression}
16510 @i{expression} ::= ( @i{expression} )
16514 For the first test (@i{expression} ::= <symbol>) the symbol must have
16515 either the value true or false, that is to say the right-hand of the
16516 symbol definition must be one of the (case-insensitive) literals
16517 @code{True} or @code{False}. If the value is true, then the
16518 corresponding lines are included, and if the value is false, they are
16521 The test (@i{expression} ::= <symbol> @code{'Defined}) is true only if
16522 the symbol has been defined in the definition file or by a @option{-D}
16523 switch on the command line. Otherwise, the test is false.
16525 The equality tests are case insensitive, as are all the preprocessor lines.
16527 If the symbol referenced is not defined in the symbol definitions file,
16528 then the effect depends on whether or not switch @option{-u}
16529 is specified. If so, then the symbol is treated as if it had the value
16530 false and the test fails. If this switch is not specified, then
16531 it is an error to reference an undefined symbol. It is also an error to
16532 reference a symbol that is defined with a value other than @code{True}
16535 The use of the @code{not} operator inverts the sense of this logical test, so
16536 that the lines are included only if the symbol is not defined.
16537 The @code{then} keyword is optional as shown
16539 The @code{#} must be the first non-blank character on a line, but
16540 otherwise the format is free form. Spaces or tabs may appear between
16541 the @code{#} and the keyword. The keywords and the symbols are case
16542 insensitive as in normal Ada code. Comments may be used on a
16543 preprocessor line, but other than that, no other tokens may appear on a
16544 preprocessor line. Any number of @code{elsif} clauses can be present,
16545 including none at all. The @code{else} is optional, as in Ada.
16547 The @code{#} marking the start of a preprocessor line must be the first
16548 non-blank character on the line, i.e. it must be preceded only by
16549 spaces or horizontal tabs.
16551 Symbol substitution outside of preprocessor lines is obtained by using
16559 anywhere within a source line, except in a comment or within a
16560 string literal. The identifier
16561 following the @code{$} must match one of the symbols defined in the symbol
16562 definition file, and the result is to substitute the value of the
16563 symbol in place of @code{$symbol} in the output file.
16565 Note that although the substitution of strings within a string literal
16566 is not possible, it is possible to have a symbol whose defined value is
16567 a string literal. So instead of setting XYZ to @code{hello} and writing:
16570 Header : String := "$XYZ";
16574 you should set XYZ to @code{"hello"} and write:
16577 Header : String := $XYZ;
16581 and then the substitution will occur as desired.
16584 @node The GNAT Run-Time Library Builder gnatlbr
16585 @chapter The GNAT Run-Time Library Builder @code{gnatlbr}
16587 @cindex Library builder
16590 @code{gnatlbr} is a tool for rebuilding the GNAT run time with user
16591 supplied configuration pragmas.
16594 * Running gnatlbr::
16595 * Switches for gnatlbr::
16596 * Examples of gnatlbr Usage::
16599 @node Running gnatlbr
16600 @section Running @code{gnatlbr}
16603 The @code{gnatlbr} command has the form
16606 $ GNAT LIBRARY /[CREATE | SET | DELETE]=directory [/CONFIG=file]
16609 @node Switches for gnatlbr
16610 @section Switches for @code{gnatlbr}
16613 @code{gnatlbr} recognizes the following switches:
16617 @item /CREATE=directory
16618 @cindex @code{/CREATE} (@code{gnatlbr})
16619 Create the new run-time library in the specified directory.
16621 @item /SET=directory
16622 @cindex @code{/SET} (@code{gnatlbr})
16623 Make the library in the specified directory the current run-time
16626 @item /DELETE=directory
16627 @cindex @code{/DELETE} (@code{gnatlbr})
16628 Delete the run-time library in the specified directory.
16631 @cindex @code{/CONFIG} (@code{gnatlbr})
16633 Use the configuration pragmas in the specified file when building
16637 Use the configuration pragmas in the specified file when compiling.
16641 @node Examples of gnatlbr Usage
16642 @section Example of @code{gnatlbr} Usage
16645 Contents of VAXFLOAT.ADC:
16646 pragma Float_Representation (VAX_Float);
16648 $ GNAT LIBRARY /CREATE=[.VAXFLOAT] /CONFIG=VAXFLOAT.ADC
16650 GNAT LIBRARY rebuilds the run-time library in directory [.VAXFLOAT]
16655 @node The GNAT Library Browser gnatls
16656 @chapter The GNAT Library Browser @code{gnatls}
16658 @cindex Library browser
16661 @code{gnatls} is a tool that outputs information about compiled
16662 units. It gives the relationship between objects, unit names and source
16663 files. It can also be used to check the source dependencies of a unit
16664 as well as various characteristics.
16668 * Switches for gnatls::
16669 * Examples of gnatls Usage::
16672 @node Running gnatls
16673 @section Running @code{gnatls}
16676 The @code{gnatls} command has the form
16679 $ gnatls switches @var{object_or_ali_file}
16683 The main argument is the list of object or @file{ali} files
16684 (@pxref{The Ada Library Information Files})
16685 for which information is requested.
16687 In normal mode, without additional option, @code{gnatls} produces a
16688 four-column listing. Each line represents information for a specific
16689 object. The first column gives the full path of the object, the second
16690 column gives the name of the principal unit in this object, the third
16691 column gives the status of the source and the fourth column gives the
16692 full path of the source representing this unit.
16693 Here is a simple example of use:
16697 ^./^[]^demo1.o demo1 DIF demo1.adb
16698 ^./^[]^demo2.o demo2 OK demo2.adb
16699 ^./^[]^hello.o h1 OK hello.adb
16700 ^./^[]^instr-child.o instr.child MOK instr-child.adb
16701 ^./^[]^instr.o instr OK instr.adb
16702 ^./^[]^tef.o tef DIF tef.adb
16703 ^./^[]^text_io_example.o text_io_example OK text_io_example.adb
16704 ^./^[]^tgef.o tgef DIF tgef.adb
16708 The first line can be interpreted as follows: the main unit which is
16710 object file @file{demo1.o} is demo1, whose main source is in
16711 @file{demo1.adb}. Furthermore, the version of the source used for the
16712 compilation of demo1 has been modified (DIF). Each source file has a status
16713 qualifier which can be:
16716 @item OK (unchanged)
16717 The version of the source file used for the compilation of the
16718 specified unit corresponds exactly to the actual source file.
16720 @item MOK (slightly modified)
16721 The version of the source file used for the compilation of the
16722 specified unit differs from the actual source file but not enough to
16723 require recompilation. If you use gnatmake with the qualifier
16724 @option{^-m (minimal recompilation)^/MINIMAL_RECOMPILATION^}, a file marked
16725 MOK will not be recompiled.
16727 @item DIF (modified)
16728 No version of the source found on the path corresponds to the source
16729 used to build this object.
16731 @item ??? (file not found)
16732 No source file was found for this unit.
16734 @item HID (hidden, unchanged version not first on PATH)
16735 The version of the source that corresponds exactly to the source used
16736 for compilation has been found on the path but it is hidden by another
16737 version of the same source that has been modified.
16741 @node Switches for gnatls
16742 @section Switches for @code{gnatls}
16745 @code{gnatls} recognizes the following switches:
16749 @item ^-a^/ALL_UNITS^
16750 @cindex @option{^-a^/ALL_UNITS^} (@code{gnatls})
16751 Consider all units, including those of the predefined Ada library.
16752 Especially useful with @option{^-d^/DEPENDENCIES^}.
16754 @item ^-d^/DEPENDENCIES^
16755 @cindex @option{^-d^/DEPENDENCIES^} (@code{gnatls})
16756 List sources from which specified units depend on.
16758 @item ^-h^/OUTPUT=OPTIONS^
16759 @cindex @option{^-h^/OUTPUT=OPTIONS^} (@code{gnatls})
16760 Output the list of options.
16762 @item ^-o^/OUTPUT=OBJECTS^
16763 @cindex @option{^-o^/OUTPUT=OBJECTS^} (@code{gnatls})
16764 Only output information about object files.
16766 @item ^-s^/OUTPUT=SOURCES^
16767 @cindex @option{^-s^/OUTPUT=SOURCES^} (@code{gnatls})
16768 Only output information about source files.
16770 @item ^-u^/OUTPUT=UNITS^
16771 @cindex @option{^-u^/OUTPUT=UNITS^} (@code{gnatls})
16772 Only output information about compilation units.
16774 @item ^-files^/FILES^=@var{file}
16775 @cindex @option{^-files^/FILES^} (@code{gnatls})
16776 Take as arguments the files listed in text file @var{file}.
16777 Text file @var{file} may contain empty lines that are ignored.
16778 Each non empty line should contain the name of an existing file.
16779 Several such switches may be specified simultaneously.
16781 @item ^-aO^/OBJECT_SEARCH=^@var{dir}
16782 @itemx ^-aI^/SOURCE_SEARCH=^@var{dir}
16783 @itemx ^-I^/SEARCH=^@var{dir}
16784 @itemx ^-I-^/NOCURRENT_DIRECTORY^
16786 @cindex @option{^-aO^/OBJECT_SEARCH^} (@code{gnatls})
16787 @cindex @option{^-aI^/SOURCE_SEARCH^} (@code{gnatls})
16788 @cindex @option{^-I^/SEARCH^} (@code{gnatls})
16789 @cindex @option{^-I-^/NOCURRENT_DIRECTORY^} (@code{gnatls})
16790 Source path manipulation. Same meaning as the equivalent @command{gnatmake}
16791 flags (@pxref{Switches for gnatmake}).
16793 @item --RTS=@var{rts-path}
16794 @cindex @option{--RTS} (@code{gnatls})
16795 Specifies the default location of the runtime library. Same meaning as the
16796 equivalent @command{gnatmake} flag (@pxref{Switches for gnatmake}).
16798 @item ^-v^/OUTPUT=VERBOSE^
16799 @cindex @option{^-v^/OUTPUT=VERBOSE^} (@code{gnatls})
16800 Verbose mode. Output the complete source, object and project paths. Do not use
16801 the default column layout but instead use long format giving as much as
16802 information possible on each requested units, including special
16803 characteristics such as:
16806 @item Preelaborable
16807 The unit is preelaborable in the Ada 95 sense.
16810 No elaboration code has been produced by the compiler for this unit.
16813 The unit is pure in the Ada 95 sense.
16815 @item Elaborate_Body
16816 The unit contains a pragma Elaborate_Body.
16819 The unit contains a pragma Remote_Types.
16821 @item Shared_Passive
16822 The unit contains a pragma Shared_Passive.
16825 This unit is part of the predefined environment and cannot be modified
16828 @item Remote_Call_Interface
16829 The unit contains a pragma Remote_Call_Interface.
16835 @node Examples of gnatls Usage
16836 @section Example of @code{gnatls} Usage
16840 Example of using the verbose switch. Note how the source and
16841 object paths are affected by the -I switch.
16844 $ gnatls -v -I.. demo1.o
16846 GNATLS 5.03w (20041123-34)
16847 Copyright 1997-2004 Free Software Foundation, Inc.
16849 Source Search Path:
16850 <Current_Directory>
16852 /home/comar/local/adainclude/
16854 Object Search Path:
16855 <Current_Directory>
16857 /home/comar/local/lib/gcc-lib/x86-linux/3.4.3/adalib/
16859 Project Search Path:
16860 <Current_Directory>
16861 /home/comar/local/lib/gnat/
16866 Kind => subprogram body
16867 Flags => No_Elab_Code
16868 Source => demo1.adb modified
16872 The following is an example of use of the dependency list.
16873 Note the use of the -s switch
16874 which gives a straight list of source files. This can be useful for
16875 building specialized scripts.
16878 $ gnatls -d demo2.o
16879 ./demo2.o demo2 OK demo2.adb
16885 $ gnatls -d -s -a demo1.o
16887 /home/comar/local/adainclude/ada.ads
16888 /home/comar/local/adainclude/a-finali.ads
16889 /home/comar/local/adainclude/a-filico.ads
16890 /home/comar/local/adainclude/a-stream.ads
16891 /home/comar/local/adainclude/a-tags.ads
16894 /home/comar/local/adainclude/gnat.ads
16895 /home/comar/local/adainclude/g-io.ads
16897 /home/comar/local/adainclude/system.ads
16898 /home/comar/local/adainclude/s-exctab.ads
16899 /home/comar/local/adainclude/s-finimp.ads
16900 /home/comar/local/adainclude/s-finroo.ads
16901 /home/comar/local/adainclude/s-secsta.ads
16902 /home/comar/local/adainclude/s-stalib.ads
16903 /home/comar/local/adainclude/s-stoele.ads
16904 /home/comar/local/adainclude/s-stratt.ads
16905 /home/comar/local/adainclude/s-tasoli.ads
16906 /home/comar/local/adainclude/s-unstyp.ads
16907 /home/comar/local/adainclude/unchconv.ads
16913 GNAT LIST /DEPENDENCIES /OUTPUT=SOURCES /ALL_UNITS DEMO1.ADB
16915 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]ada.ads
16916 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]a-finali.ads
16917 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]a-filico.ads
16918 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]a-stream.ads
16919 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]a-tags.ads
16923 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]gnat.ads
16924 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]g-io.ads
16926 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]system.ads
16927 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-exctab.ads
16928 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-finimp.ads
16929 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-finroo.ads
16930 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-secsta.ads
16931 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-stalib.ads
16932 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-stoele.ads
16933 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-stratt.ads
16934 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-tasoli.ads
16935 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]s-unstyp.ads
16936 GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB]unchconv.ads
16940 @node Cleaning Up Using gnatclean
16941 @chapter Cleaning Up Using @code{gnatclean}
16943 @cindex Cleaning tool
16946 @code{gnatclean} is a tool that allows the deletion of files produced by the
16947 compiler, binder and linker, including ALI files, object files, tree files,
16948 expanded source files, library files, interface copy source files, binder
16949 generated files and executable files.
16952 * Running gnatclean::
16953 * Switches for gnatclean::
16954 @c * Examples of gnatclean Usage::
16957 @node Running gnatclean
16958 @section Running @code{gnatclean}
16961 The @code{gnatclean} command has the form:
16964 $ gnatclean switches @var{names}
16968 @var{names} is a list of source file names. Suffixes @code{.^ads^ADS^} and
16969 @code{^adb^ADB^} may be omitted. If a project file is specified using switch
16970 @code{^-P^/PROJECT_FILE=^}, then @var{names} may be completely omitted.
16973 In normal mode, @code{gnatclean} delete the files produced by the compiler and,
16974 if switch @code{^-c^/COMPILER_FILES_ONLY^} is not specified, by the binder and
16975 the linker. In informative-only mode, specified by switch
16976 @code{^-n^/NODELETE^}, the list of files that would have been deleted in
16977 normal mode is listed, but no file is actually deleted.
16979 @node Switches for gnatclean
16980 @section Switches for @code{gnatclean}
16983 @code{gnatclean} recognizes the following switches:
16987 @item ^-c^/COMPILER_FILES_ONLY^
16988 @cindex @option{^-c^/COMPILER_FILES_ONLY^} (@code{gnatclean})
16989 Only attempt to delete the files produced by the compiler, not those produced
16990 by the binder or the linker. The files that are not to be deleted are library
16991 files, interface copy files, binder generated files and executable files.
16993 @item ^-D ^/DIRECTORY_OBJECTS=^@var{dir}
16994 @cindex @option{^-D^/DIRECTORY_OBJECTS^} (@code{gnatclean})
16995 Indicate that ALI and object files should normally be found in directory
16998 @item ^-F^/FULL_PATH_IN_BRIEF_MESSAGES^
16999 @cindex @option{^-F^/FULL_PATH_IN_BRIEF_MESSAGES^} (@code{gnatclean})
17000 When using project files, if some errors or warnings are detected during
17001 parsing and verbose mode is not in effect (no use of switch
17002 ^-v^/VERBOSE^), then error lines start with the full path name of the project
17003 file, rather than its simple file name.
17006 @cindex @option{^-h^/HELP^} (@code{gnatclean})
17007 Output a message explaining the usage of @code{^gnatclean^gnatclean^}.
17009 @item ^-n^/NODELETE^
17010 @cindex @option{^-n^/NODELETE^} (@code{gnatclean})
17011 Informative-only mode. Do not delete any files. Output the list of the files
17012 that would have been deleted if this switch was not specified.
17014 @item ^-P^/PROJECT_FILE=^@var{project}
17015 @cindex @option{^-P^/PROJECT_FILE^} (@code{gnatclean})
17016 Use project file @var{project}. Only one such switch can be used.
17017 When cleaning a project file, the files produced by the compilation of the
17018 immediate sources or inherited sources of the project files are to be
17019 deleted. This is not depending on the presence or not of executable names
17020 on the command line.
17023 @cindex @option{^-q^/QUIET^} (@code{gnatclean})
17024 Quiet output. If there are no error, do not ouuput anything, except in
17025 verbose mode (switch ^-v^/VERBOSE^) or in informative-only mode
17026 (switch ^-n^/NODELETE^).
17028 @item ^-r^/RECURSIVE^
17029 @cindex @option{^-r^/RECURSIVE^} (@code{gnatclean})
17030 When a project file is specified (using switch ^-P^/PROJECT_FILE=^),
17031 clean all imported and extended project files, recursively. If this switch
17032 is not specified, only the files related to the main project file are to be
17033 deleted. This switch has no effect if no project file is specified.
17035 @item ^-v^/VERBOSE^
17036 @cindex @option{^-v^/VERBOSE^} (@code{gnatclean})
17039 @item ^-vP^/MESSAGES_PROJECT_FILE=^@emph{x}
17040 @cindex @option{^-vP^/MESSAGES_PROJECT_FILE^} (@code{gnatclean})
17041 Indicates the verbosity of the parsing of GNAT project files.
17042 @xref{Switches Related to Project Files}.
17044 @item ^-X^/EXTERNAL_REFERENCE=^@var{name=value}
17045 @cindex @option{^-X^/EXTERNAL_REFERENCE^} (@code{gnatclean})
17046 Indicates that external variable @var{name} has the value @var{value}.
17047 The Project Manager will use this value for occurrences of
17048 @code{external(name)} when parsing the project file.
17049 @xref{Switches Related to Project Files}.
17051 @item ^-aO^/OBJECT_SEARCH=^@var{dir}
17052 @cindex @option{^-aO^/OBJECT_SEARCH^} (@code{gnatclean})
17053 When searching for ALI and object files, look in directory
17056 @item ^-I^/SEARCH=^@var{dir}
17057 @cindex @option{^-I^/SEARCH^} (@code{gnatclean})
17058 Equivalent to @option{^-aO^/OBJECT_SEARCH=^@var{dir}}.
17060 @item ^-I-^/NOCURRENT_DIRECTORY^
17061 @cindex @option{^-I-^/NOCURRENT_DIRECTORY^} (@code{gnatclean})
17062 @cindex Source files, suppressing search
17063 Do not look for ALI or object files in the directory
17064 where @code{gnatclean} was invoked.
17068 @c @node Examples of gnatclean Usage
17069 @c @section Examples of @code{gnatclean} Usage
17072 @node GNAT and Libraries
17073 @chapter GNAT and Libraries
17074 @cindex Library, building, installing, using
17077 This chapter describes how to build and use libraries with GNAT, and also shows
17078 how to recompile the GNAT run-time library. You should be familiar with the
17079 Project Manager facility (@pxref{GNAT Project Manager}) before reading this
17083 * Introduction to Libraries in GNAT::
17084 * General Ada Libraries::
17085 * Stand-alone Ada Libraries::
17086 * Rebuilding the GNAT Run-Time Library::
17089 @node Introduction to Libraries in GNAT
17090 @section Introduction to Libraries in GNAT
17093 A library is, conceptually, a collection of objects which does not have its
17094 own main thread of execution, but rather provides certain services to the
17095 applications that use it. A library can be either statically linked with the
17096 application, in which case its code is directly included in the application,
17097 or, on platforms that support it, be dynamically linked, in which case
17098 its code is shared by all applications making use of this library.
17100 GNAT supports both types of libraries.
17101 In the static case, the compiled code can be provided in different ways. The
17102 simplest approach is to provide directly the set of objects resulting from
17103 compilation of the library source files. Alternatively, you can group the
17104 objects into an archive using whatever commands are provided by the operating
17105 system. For the latter case, the objects are grouped into a shared library.
17107 In the GNAT environment, a library has three types of components:
17113 @xref{The Ada Library Information Files}.
17115 Object files, an archive or a shared library.
17119 A GNAT library may expose all its source files, which is useful for
17120 documentation purposes. Alternatively, it may expose only the units needed by
17121 an external user to make use of the library. That is to say, the specs
17122 reflecting the library services along with all the units needed to compile
17123 those specs, which can include generic bodies or any body implementing an
17124 inlined routine. In the case of @emph{stand-alone libraries} those exposed
17125 units are called @emph{interface units} (@pxref{Stand-alone Ada Libraries}).
17127 All compilation units comprising an application, including those in a library,
17128 need to be elaborated in an order partially defined by Ada's semantics. GNAT
17129 computes the elaboration order from the @file{ALI} files and this is why they
17130 constitute a mandatory part of GNAT libraries. Except in the case of
17131 @emph{stand-alone libraries}, where a specific library elaboration routine is
17132 produced independently of the application(s) using the library.
17134 @node General Ada Libraries
17135 @section General Ada Libraries
17138 * Building a library::
17139 * Installing a library::
17140 * Using a library::
17143 @node Building a library
17144 @subsection Building a library
17147 The easiest way to build a library is to use the Project Manager,
17148 which supports a special type of project called a @emph{Library Project}
17149 (@pxref{Library Projects}).
17151 A project is considered a library project, when two project-level attributes
17152 are defined in it: @code{Library_Name} and @code{Library_Dir}. In order to
17153 control different aspects of library configuration, additional optional
17154 project-level attributes can be specified:
17157 This attribute controls whether the library is to be static or dynamic
17159 @item Library_Version
17160 This attribute specifies the library version; this value is used
17161 during dynamic linking of shared libraries to determine if the currently
17162 installed versions of the binaries are compatible.
17164 @item Library_Options
17166 These attributes specify additional low-level options to be used during
17167 library generation, and redefine the actual application used to generate
17172 The GNAT Project Manager takes full care of the library maintenance task,
17173 including recompilation of the source files for which objects do not exist
17174 or are not up to date, assembly of the library archive, and installation of
17175 the library (i.e., copying associated source, object and @file{ALI} files
17176 to the specified location).
17178 Here is a simple library project file:
17179 @smallexample @c ada
17181 for Source_Dirs use ("src1", "src2");
17182 for Object_Dir use "obj";
17183 for Library_Name use "mylib";
17184 for Library_Dir use "lib";
17185 for Library_Kind use "dynamic";
17190 and the compilation command to build and install the library:
17192 @smallexample @c ada
17193 $ gnatmake -Pmy_lib
17197 It is not entirely trivial to perform manually all the steps required to
17198 produce a library. We recommend that you use the GNAT Project Manager
17199 for this task. In special cases where this is not desired, the necessary
17200 steps are discussed below.
17202 There are various possibilities for compiling the units that make up the
17203 library: for example with a Makefile (@pxref{Using the GNU make Utility}) or
17204 with a conventional script. For simple libraries, it is also possible to create
17205 a dummy main program which depends upon all the packages that comprise the
17206 interface of the library. This dummy main program can then be given to
17207 @command{gnatmake}, which will ensure that all necessary objects are built.
17209 After this task is accomplished, you should follow the standard procedure
17210 of the underlying operating system to produce the static or shared library.
17212 Here is an example of such a dummy program:
17213 @smallexample @c ada
17215 with My_Lib.Service1;
17216 with My_Lib.Service2;
17217 with My_Lib.Service3;
17218 procedure My_Lib_Dummy is
17226 Here are the generic commands that will build an archive or a shared library.
17229 # compiling the library
17230 $ gnatmake -c my_lib_dummy.adb
17232 # we don't need the dummy object itself
17233 $ rm my_lib_dummy.o my_lib_dummy.ali
17235 # create an archive with the remaining objects
17236 $ ar rc libmy_lib.a *.o
17237 # some systems may require "ranlib" to be run as well
17239 # or create a shared library
17240 $ gcc -shared -o libmy_lib.so *.o
17241 # some systems may require the code to have been compiled with -fPIC
17243 # remove the object files that are now in the library
17246 # Make the ALI files read-only so that gnatmake will not try to
17247 # regenerate the objects that are in the library
17252 Please note that the library must have a name of the form @file{libxxx.a} or
17253 @file{libxxx.so} (or @file{libxxx.dll} on Windows) in order to be accessed by
17254 the directive @option{-lxxx} at link time.
17256 @node Installing a library
17257 @subsection Installing a library
17258 @cindex @code{ADA_PROJECT_PATH}
17261 If you use project files, library installation is part of the library build
17262 process. Thus no further action is needed in order to make use of the
17263 libraries that are built as part of the general application build. A usable
17264 version of the library is installed in the directory specified by the
17265 @code{Library_Dir} attribute of the library project file.
17267 You may want to install a library in a context different from where the library
17268 is built. This situation arises with third party suppliers, who may want
17269 to distribute a library in binary form where the user is not expected to be
17270 able to recompile the library. The simplest option in this case is to provide
17271 a project file slightly different from the one used to build the library, by
17272 using the @code{externally_built} attribute. For instance, the project
17273 file used to build the library in the previous section can be changed into the
17274 following one when the library is installed:
17276 @smallexample @c projectfile
17278 for Source_Dirs use ("src1", "src2");
17279 for Library_Name use "mylib";
17280 for Library_Dir use "lib";
17281 for Library_Kind use "dynamic";
17282 for Externally_Built use "true";
17287 This project file assumes that the directories @file{src1},
17288 @file{src2}, and @file{lib} exist in
17289 the directory containing the project file. The @code{externally_built}
17290 attribute makes it clear to the GNAT builder that it should not attempt to
17291 recompile any of the units from this library. It allows the library provider to
17292 restrict the source set to the minimum necessary for clients to make use of the
17293 library as described in the first section of this chapter. It is the
17294 responsibility of the library provider to install the necessary sources, ALI
17295 files and libraries in the directories mentioned in the project file. For
17296 convenience, the user's library project file should be installed in a location
17297 that will be searched automatically by the GNAT
17298 builder. These are the directories referenced in the @code{ADA_PROJECT_PATH}
17299 environment variable (@pxref{Importing Projects}), and also the default GNAT
17300 library location that can be queried with @command{gnatls -v} and is usually of
17301 the form $gnat_install_root/lib/gnat.
17303 When project files are not an option, it is also possible, but not recommended,
17304 to install the library so that the sources needed to use the library are on the
17305 Ada source path and the ALI files & libraries be on the Ada Object path (see
17306 @ref{Search Paths and the Run-Time Library (RTL)}. Alternatively, the system
17307 administrator can place general-purpose libraries in the default compiler
17308 paths, by specifying the libraries' location in the configuration files
17309 @file{ada_source_path} and @file{ada_object_path}. These configuration files
17310 must be located in the GNAT installation tree at the same place as the gcc spec
17311 file. The location of the gcc spec file can be determined as follows:
17317 The configuration files mentioned above have a simple format: each line
17318 must contain one unique directory name.
17319 Those names are added to the corresponding path
17320 in their order of appearance in the file. The names can be either absolute
17321 or relative; in the latter case, they are relative to where theses files
17324 The files @file{ada_source_path} and @file{ada_object_path} might not be
17326 GNAT installation, in which case, GNAT will look for its run-time library in
17327 the directories @file{adainclude} (for the sources) and @file{adalib} (for the
17328 objects and @file{ALI} files). When the files exist, the compiler does not
17329 look in @file{adainclude} and @file{adalib}, and thus the
17330 @file{ada_source_path} file
17331 must contain the location for the GNAT run-time sources (which can simply
17332 be @file{adainclude}). In the same way, the @file{ada_object_path} file must
17333 contain the location for the GNAT run-time objects (which can simply
17336 You can also specify a new default path to the run-time library at compilation
17337 time with the switch @option{--RTS=rts-path}. You can thus choose / change
17338 the run-time library you want your program to be compiled with. This switch is
17339 recognized by @command{gcc}, @command{gnatmake}, @command{gnatbind},
17340 @command{gnatls}, @command{gnatfind} and @command{gnatxref}.
17342 It is possible to install a library before or after the standard GNAT
17343 library, by reordering the lines in the configuration files. In general, a
17344 library must be installed before the GNAT library if it redefines
17347 @node Using a library
17348 @subsection Using a library
17350 @noindent Once again, the project facility greatly simplifies the use of
17351 libraries. In this context, using a library is just a matter of adding a
17352 @code{with} clause in the user project. For instance, to make use of the
17353 library @code{My_Lib} shown in examples in earlier sections, you can
17356 @smallexample @c projectfile
17363 Even if you have a third-party, non-Ada library, you can still use GNAT's
17364 Project Manager facility to provide a wrapper for it. For example, the
17365 following project, when @code{with}ed by your main project, will link with the
17366 third-party library @file{liba.a}:
17368 @smallexample @c projectfile
17371 for Externally_Built use "true";
17372 for Library_Dir use "lib";
17373 for Library_Name use "a";
17374 for Library_Kind use "static";
17378 This is an alternative to the use of @code{pragma Linker_Options}. It is
17379 especially interesting in the context of systems with several interdependant
17380 static libraries where finding a proper linker order is not easy and best be
17381 left to the tools having visibility over project dependancy information.
17384 In order to use an Ada library manually, you need to make sure that this
17385 library is on both your source and object path
17386 (see @ref{Search Paths and the Run-Time Library (RTL)}
17387 and @ref{Search Paths for gnatbind}). Furthermore, when the objects are grouped
17388 in an archive or a shared library, you need to specify the desired
17389 library at link time.
17391 For example, you can use the library @file{mylib} installed in
17392 @file{/dir/my_lib_src} and @file{/dir/my_lib_obj} with the following commands:
17395 $ gnatmake -aI/dir/my_lib_src -aO/dir/my_lib_obj my_appl \
17400 This can be expressed more simply:
17405 when the following conditions are met:
17408 @file{/dir/my_lib_src} has been added by the user to the environment
17409 variable @code{ADA_INCLUDE_PATH}, or by the administrator to the file
17410 @file{ada_source_path}
17412 @file{/dir/my_lib_obj} has been added by the user to the environment
17413 variable @code{ADA_OBJECTS_PATH}, or by the administrator to the file
17414 @file{ada_object_path}
17416 a pragma @code{Linker_Options} has been added to one of the sources.
17419 @smallexample @c ada
17420 pragma Linker_Options ("-lmy_lib");
17424 @node Stand-alone Ada Libraries
17425 @section Stand-alone Ada Libraries
17426 @cindex Stand-alone library, building, using
17429 * Introduction to Stand-alone Libraries::
17430 * Building a Stand-alone Library::
17431 * Creating a Stand-alone Library to be used in a non-Ada context::
17432 * Restrictions in Stand-alone Libraries::
17435 @node Introduction to Stand-alone Libraries
17436 @subsection Introduction to Stand-alone Libraries
17439 A Stand-alone Library (abbreviated ``SAL'') is a library that contains the
17441 elaborate the Ada units that are included in the library. In contrast with
17442 an ordinary library, which consists of all sources, objects and @file{ALI}
17444 library, a SAL may specify a restricted subset of compilation units
17445 to serve as a library interface. In this case, the fully
17446 self-sufficient set of files will normally consist of an objects
17447 archive, the sources of interface units' specs, and the @file{ALI}
17448 files of interface units.
17449 If an interface spec contains a generic unit or an inlined subprogram,
17451 source must also be provided; if the units that must be provided in the source
17452 form depend on other units, the source and @file{ALI} files of those must
17455 The main purpose of a SAL is to minimize the recompilation overhead of client
17456 applications when a new version of the library is installed. Specifically,
17457 if the interface sources have not changed, client applications do not need to
17458 be recompiled. If, furthermore, a SAL is provided in the shared form and its
17459 version, controlled by @code{Library_Version} attribute, is not changed,
17460 then the clients do not need to be relinked.
17462 SALs also allow the library providers to minimize the amount of library source
17463 text exposed to the clients. Such ``information hiding'' might be useful or
17464 necessary for various reasons.
17466 Stand-alone libraries are also well suited to be used in an executable whose
17467 main routine is not written in Ada.
17469 @node Building a Stand-alone Library
17470 @subsection Building a Stand-alone Library
17473 GNAT's Project facility provides a simple way of building and installing
17474 stand-alone libraries; see @ref{Stand-alone Library Projects}.
17475 To be a Stand-alone Library Project, in addition to the two attributes
17476 that make a project a Library Project (@code{Library_Name} and
17477 @code{Library_Dir}; see @ref{Library Projects}), the attribute
17478 @code{Library_Interface} must be defined. For example:
17480 @smallexample @c projectfile
17482 for Library_Dir use "lib_dir";
17483 for Library_Name use "dummy";
17484 for Library_Interface use ("int1", "int1.child");
17489 Attribute @code{Library_Interface} has a non-empty string list value,
17490 each string in the list designating a unit contained in an immediate source
17491 of the project file.
17493 When a Stand-alone Library is built, first the binder is invoked to build
17494 a package whose name depends on the library name
17495 (@file{^b~dummy.ads/b^B$DUMMY.ADS/B^} in the example above).
17496 This binder-generated package includes initialization and
17497 finalization procedures whose
17498 names depend on the library name (@code{dummyinit} and @code{dummyfinal}
17500 above). The object corresponding to this package is included in the library.
17502 You must ensure timely (e.g., prior to any use of interfaces in the SAL)
17503 calling of these procedures if a static SAL is built, or if a shared SAL
17505 with the project-level attribute @code{Library_Auto_Init} set to
17508 For a Stand-Alone Library, only the @file{ALI} files of the Interface Units
17509 (those that are listed in attribute @code{Library_Interface}) are copied to
17510 the Library Directory. As a consequence, only the Interface Units may be
17511 imported from Ada units outside of the library. If other units are imported,
17512 the binding phase will fail.
17514 The attribute @code{Library_Src_Dir} may be specified for a
17515 Stand-Alone Library. @code{Library_Src_Dir} is a simple attribute that has a
17516 single string value. Its value must be the path (absolute or relative to the
17517 project directory) of an existing directory. This directory cannot be the
17518 object directory or one of the source directories, but it can be the same as
17519 the library directory. The sources of the Interface
17520 Units of the library that are needed by an Ada client of the library will be
17521 copied to the designated directory, called the Interface Copy directory.
17522 These sources include the specs of the Interface Units, but they may also
17523 include bodies and subunits, when pragmas @code{Inline} or @code{Inline_Always}
17524 are used, or when there is a generic unit in the spec. Before the sources
17525 are copied to the Interface Copy directory, an attempt is made to delete all
17526 files in the Interface Copy directory.
17528 Building stand-alone libraries by hand is somewhat tedious, but for those
17529 occasions when it is necessary here are the steps that you need to perform:
17532 Compile all library sources.
17535 Invoke the binder with the switch @option{-n} (No Ada main program),
17536 with all the @file{ALI} files of the interfaces, and
17537 with the switch @option{-L} to give specific names to the @code{init}
17538 and @code{final} procedures. For example:
17540 gnatbind -n int1.ali int2.ali -Lsal1
17544 Compile the binder generated file:
17550 Link the dynamic library with all the necessary object files,
17551 indicating to the linker the names of the @code{init} (and possibly
17552 @code{final}) procedures for automatic initialization (and finalization).
17553 The built library should be placed in a directory different from
17554 the object directory.
17557 Copy the @code{ALI} files of the interface to the library directory,
17558 add in this copy an indication that it is an interface to a SAL
17559 (i.e. add a word @option{SL} on the line in the @file{ALI} file that starts
17560 with letter ``P'') and make the modified copy of the @file{ALI} file
17565 Using SALs is not different from using other libraries
17566 (see @ref{Using a library}).
17568 @node Creating a Stand-alone Library to be used in a non-Ada context
17569 @subsection Creating a Stand-alone Library to be used in a non-Ada context
17572 It is easy to adapt the SAL build procedure discussed above for use of a SAL in
17575 The only extra step required is to ensure that library interface subprograms
17576 are compatible with the main program, by means of @code{pragma Export}
17577 or @code{pragma Convention}.
17579 Here is an example of simple library interface for use with C main program:
17581 @smallexample @c ada
17582 package Interface is
17584 procedure Do_Something;
17585 pragma Export (C, Do_Something, "do_something");
17587 procedure Do_Something_Else;
17588 pragma Export (C, Do_Something_Else, "do_something_else");
17594 On the foreign language side, you must provide a ``foreign'' view of the
17595 library interface; remember that it should contain elaboration routines in
17596 addition to interface subprograms.
17598 The example below shows the content of @code{mylib_interface.h} (note
17599 that there is no rule for the naming of this file, any name can be used)
17601 /* the library elaboration procedure */
17602 extern void mylibinit (void);
17604 /* the library finalization procedure */
17605 extern void mylibfinal (void);
17607 /* the interface exported by the library */
17608 extern void do_something (void);
17609 extern void do_something_else (void);
17613 Libraries built as explained above can be used from any program, provided
17614 that the elaboration procedures (named @code{mylibinit} in the previous
17615 example) are called before the library services are used. Any number of
17616 libraries can be used simultaneously, as long as the elaboration
17617 procedure of each library is called.
17619 Below is an example of a C program that uses the @code{mylib} library.
17622 #include "mylib_interface.h"
17627 /* First, elaborate the library before using it */
17630 /* Main program, using the library exported entities */
17632 do_something_else ();
17634 /* Library finalization at the end of the program */
17641 Note that invoking any library finalization procedure generated by
17642 @code{gnatbind} shuts down the Ada run-time environment.
17644 finalization of all Ada libraries must be performed at the end of the program.
17645 No call to these libraries or to the Ada run-time library should be made
17646 after the finalization phase.
17648 @node Restrictions in Stand-alone Libraries
17649 @subsection Restrictions in Stand-alone Libraries
17652 The pragmas listed below should be used with caution inside libraries,
17653 as they can create incompatibilities with other Ada libraries:
17655 @item pragma @code{Locking_Policy}
17656 @item pragma @code{Queuing_Policy}
17657 @item pragma @code{Task_Dispatching_Policy}
17658 @item pragma @code{Unreserve_All_Interrupts}
17662 When using a library that contains such pragmas, the user must make sure
17663 that all libraries use the same pragmas with the same values. Otherwise,
17664 @code{Program_Error} will
17665 be raised during the elaboration of the conflicting
17666 libraries. The usage of these pragmas and its consequences for the user
17667 should therefore be well documented.
17669 Similarly, the traceback in the exception occurrence mechanism should be
17670 enabled or disabled in a consistent manner across all libraries.
17671 Otherwise, Program_Error will be raised during the elaboration of the
17672 conflicting libraries.
17674 If the @code{Version} or @code{Body_Version}
17675 attributes are used inside a library, then you need to
17676 perform a @code{gnatbind} step that specifies all @file{ALI} files in all
17677 libraries, so that version identifiers can be properly computed.
17678 In practice these attributes are rarely used, so this is unlikely
17679 to be a consideration.
17681 @node Rebuilding the GNAT Run-Time Library
17682 @section Rebuilding the GNAT Run-Time Library
17683 @cindex GNAT Run-Time Library, rebuilding
17686 It may be useful to recompile the GNAT library in various contexts, the
17687 most important one being the use of partition-wide configuration pragmas
17688 such as @code{Normalize_Scalars}. A special Makefile called
17689 @code{Makefile.adalib} is provided to that effect and can be found in
17690 the directory containing the GNAT library. The location of this
17691 directory depends on the way the GNAT environment has been installed and can
17692 be determined by means of the command:
17699 The last entry in the object search path usually contains the
17700 gnat library. This Makefile contains its own documentation and in
17701 particular the set of instructions needed to rebuild a new library and
17704 @node Using the GNU make Utility
17705 @chapter Using the GNU @code{make} Utility
17709 This chapter offers some examples of makefiles that solve specific
17710 problems. It does not explain how to write a makefile (see the GNU make
17711 documentation), nor does it try to replace the @command{gnatmake} utility
17712 (@pxref{The GNAT Make Program gnatmake}).
17714 All the examples in this section are specific to the GNU version of
17715 make. Although @code{make} is a standard utility, and the basic language
17716 is the same, these examples use some advanced features found only in
17720 * Using gnatmake in a Makefile::
17721 * Automatically Creating a List of Directories::
17722 * Generating the Command Line Switches::
17723 * Overcoming Command Line Length Limits::
17726 @node Using gnatmake in a Makefile
17727 @section Using gnatmake in a Makefile
17732 Complex project organizations can be handled in a very powerful way by
17733 using GNU make combined with gnatmake. For instance, here is a Makefile
17734 which allows you to build each subsystem of a big project into a separate
17735 shared library. Such a makefile allows you to significantly reduce the link
17736 time of very big applications while maintaining full coherence at
17737 each step of the build process.
17739 The list of dependencies are handled automatically by
17740 @command{gnatmake}. The Makefile is simply used to call gnatmake in each of
17741 the appropriate directories.
17743 Note that you should also read the example on how to automatically
17744 create the list of directories
17745 (@pxref{Automatically Creating a List of Directories})
17746 which might help you in case your project has a lot of subdirectories.
17751 @font@heightrm=cmr8
17754 ## This Makefile is intended to be used with the following directory
17756 ## - The sources are split into a series of csc (computer software components)
17757 ## Each of these csc is put in its own directory.
17758 ## Their name are referenced by the directory names.
17759 ## They will be compiled into shared library (although this would also work
17760 ## with static libraries
17761 ## - The main program (and possibly other packages that do not belong to any
17762 ## csc is put in the top level directory (where the Makefile is).
17763 ## toplevel_dir __ first_csc (sources) __ lib (will contain the library)
17764 ## \_ second_csc (sources) __ lib (will contain the library)
17766 ## Although this Makefile is build for shared library, it is easy to modify
17767 ## to build partial link objects instead (modify the lines with -shared and
17770 ## With this makefile, you can change any file in the system or add any new
17771 ## file, and everything will be recompiled correctly (only the relevant shared
17772 ## objects will be recompiled, and the main program will be re-linked).
17774 # The list of computer software component for your project. This might be
17775 # generated automatically.
17778 # Name of the main program (no extension)
17781 # If we need to build objects with -fPIC, uncomment the following line
17784 # The following variable should give the directory containing libgnat.so
17785 # You can get this directory through 'gnatls -v'. This is usually the last
17786 # directory in the Object_Path.
17789 # The directories for the libraries
17790 # (This macro expands the list of CSC to the list of shared libraries, you
17791 # could simply use the expanded form :
17792 # LIB_DIR=aa/lib/libaa.so bb/lib/libbb.so cc/lib/libcc.so
17793 LIB_DIR=$@{foreach dir,$@{CSC_LIST@},$@{dir@}/lib/lib$@{dir@}.so@}
17795 $@{MAIN@}: objects $@{LIB_DIR@}
17796 gnatbind $@{MAIN@} $@{CSC_LIST:%=-aO%/lib@} -shared
17797 gnatlink $@{MAIN@} $@{CSC_LIST:%=-l%@}
17800 # recompile the sources
17801 gnatmake -c -i $@{MAIN@}.adb $@{NEED_FPIC@} $@{CSC_LIST:%=-I%@}
17803 # Note: In a future version of GNAT, the following commands will be simplified
17804 # by a new tool, gnatmlib
17806 mkdir -p $@{dir $@@ @}
17807 cd $@{dir $@@ @}; gcc -shared -o $@{notdir $@@ @} ../*.o -L$@{GLIB@} -lgnat
17808 cd $@{dir $@@ @}; cp -f ../*.ali .
17810 # The dependencies for the modules
17811 # Note that we have to force the expansion of *.o, since in some cases
17812 # make won't be able to do it itself.
17813 aa/lib/libaa.so: $@{wildcard aa/*.o@}
17814 bb/lib/libbb.so: $@{wildcard bb/*.o@}
17815 cc/lib/libcc.so: $@{wildcard cc/*.o@}
17817 # Make sure all of the shared libraries are in the path before starting the
17820 LD_LIBRARY_PATH=`pwd`/aa/lib:`pwd`/bb/lib:`pwd`/cc/lib ./$@{MAIN@}
17823 $@{RM@} -rf $@{CSC_LIST:%=%/lib@}
17824 $@{RM@} $@{CSC_LIST:%=%/*.ali@}
17825 $@{RM@} $@{CSC_LIST:%=%/*.o@}
17826 $@{RM@} *.o *.ali $@{MAIN@}
17829 @node Automatically Creating a List of Directories
17830 @section Automatically Creating a List of Directories
17833 In most makefiles, you will have to specify a list of directories, and
17834 store it in a variable. For small projects, it is often easier to
17835 specify each of them by hand, since you then have full control over what
17836 is the proper order for these directories, which ones should be
17839 However, in larger projects, which might involve hundreds of
17840 subdirectories, it might be more convenient to generate this list
17843 The example below presents two methods. The first one, although less
17844 general, gives you more control over the list. It involves wildcard
17845 characters, that are automatically expanded by @code{make}. Its
17846 shortcoming is that you need to explicitly specify some of the
17847 organization of your project, such as for instance the directory tree
17848 depth, whether some directories are found in a separate tree,...
17850 The second method is the most general one. It requires an external
17851 program, called @code{find}, which is standard on all Unix systems. All
17852 the directories found under a given root directory will be added to the
17858 @font@heightrm=cmr8
17861 # The examples below are based on the following directory hierarchy:
17862 # All the directories can contain any number of files
17863 # ROOT_DIRECTORY -> a -> aa -> aaa
17866 # -> b -> ba -> baa
17869 # This Makefile creates a variable called DIRS, that can be reused any time
17870 # you need this list (see the other examples in this section)
17872 # The root of your project's directory hierarchy
17876 # First method: specify explicitly the list of directories
17877 # This allows you to specify any subset of all the directories you need.
17880 DIRS := a/aa/ a/ab/ b/ba/
17883 # Second method: use wildcards
17884 # Note that the argument(s) to wildcard below should end with a '/'.
17885 # Since wildcards also return file names, we have to filter them out
17886 # to avoid duplicate directory names.
17887 # We thus use make's @code{dir} and @code{sort} functions.
17888 # It sets DIRs to the following value (note that the directories aaa and baa
17889 # are not given, unless you change the arguments to wildcard).
17890 # DIRS= ./a/a/ ./b/ ./a/aa/ ./a/ab/ ./a/ac/ ./b/ba/ ./b/bb/ ./b/bc/
17893 DIRS := $@{sort $@{dir $@{wildcard $@{ROOT_DIRECTORY@}/*/
17894 $@{ROOT_DIRECTORY@}/*/*/@}@}@}
17897 # Third method: use an external program
17898 # This command is much faster if run on local disks, avoiding NFS slowdowns.
17899 # This is the most complete command: it sets DIRs to the following value:
17900 # DIRS= ./a ./a/aa ./a/aa/aaa ./a/ab ./a/ac ./b ./b/ba ./b/ba/baa ./b/bb ./b/bc
17903 DIRS := $@{shell find $@{ROOT_DIRECTORY@} -type d -print@}
17907 @node Generating the Command Line Switches
17908 @section Generating the Command Line Switches
17911 Once you have created the list of directories as explained in the
17912 previous section (@pxref{Automatically Creating a List of Directories}),
17913 you can easily generate the command line arguments to pass to gnatmake.
17915 For the sake of completeness, this example assumes that the source path
17916 is not the same as the object path, and that you have two separate lists
17920 # see "Automatically creating a list of directories" to create
17925 GNATMAKE_SWITCHES := $@{patsubst %,-aI%,$@{SOURCE_DIRS@}@}
17926 GNATMAKE_SWITCHES += $@{patsubst %,-aO%,$@{OBJECT_DIRS@}@}
17929 gnatmake $@{GNATMAKE_SWITCHES@} main_unit
17932 @node Overcoming Command Line Length Limits
17933 @section Overcoming Command Line Length Limits
17936 One problem that might be encountered on big projects is that many
17937 operating systems limit the length of the command line. It is thus hard to give
17938 gnatmake the list of source and object directories.
17940 This example shows how you can set up environment variables, which will
17941 make @command{gnatmake} behave exactly as if the directories had been
17942 specified on the command line, but have a much higher length limit (or
17943 even none on most systems).
17945 It assumes that you have created a list of directories in your Makefile,
17946 using one of the methods presented in
17947 @ref{Automatically Creating a List of Directories}.
17948 For the sake of completeness, we assume that the object
17949 path (where the ALI files are found) is different from the sources patch.
17951 Note a small trick in the Makefile below: for efficiency reasons, we
17952 create two temporary variables (SOURCE_LIST and OBJECT_LIST), that are
17953 expanded immediately by @code{make}. This way we overcome the standard
17954 make behavior which is to expand the variables only when they are
17957 On Windows, if you are using the standard Windows command shell, you must
17958 replace colons with semicolons in the assignments to these variables.
17963 @font@heightrm=cmr8
17966 # In this example, we create both ADA_INCLUDE_PATH and ADA_OBJECT_PATH.
17967 # This is the same thing as putting the -I arguments on the command line.
17968 # (the equivalent of using -aI on the command line would be to define
17969 # only ADA_INCLUDE_PATH, the equivalent of -aO is ADA_OBJECT_PATH).
17970 # You can of course have different values for these variables.
17972 # Note also that we need to keep the previous values of these variables, since
17973 # they might have been set before running 'make' to specify where the GNAT
17974 # library is installed.
17976 # see "Automatically creating a list of directories" to create these
17982 space:=$@{empty@} $@{empty@}
17983 SOURCE_LIST := $@{subst $@{space@},:,$@{SOURCE_DIRS@}@}
17984 OBJECT_LIST := $@{subst $@{space@},:,$@{OBJECT_DIRS@}@}
17985 ADA_INCLUDE_PATH += $@{SOURCE_LIST@}
17986 ADA_OBJECT_PATH += $@{OBJECT_LIST@}
17987 export ADA_INCLUDE_PATH
17988 export ADA_OBJECT_PATH
17995 @node Memory Management Issues
17996 @chapter Memory Management Issues
17999 This chapter describes some useful memory pools provided in the GNAT library
18000 and in particular the GNAT Debug Pool facility, which can be used to detect
18001 incorrect uses of access values (including ``dangling references'').
18003 It also describes the @command{gnatmem} tool, which can be used to track down
18008 * Some Useful Memory Pools::
18009 * The GNAT Debug Pool Facility::
18011 * The gnatmem Tool::
18015 @node Some Useful Memory Pools
18016 @section Some Useful Memory Pools
18017 @findex Memory Pool
18018 @cindex storage, pool
18021 The @code{System.Pool_Global} package offers the Unbounded_No_Reclaim_Pool
18022 storage pool. Allocations use the standard system call @code{malloc} while
18023 deallocations use the standard system call @code{free}. No reclamation is
18024 performed when the pool goes out of scope. For performance reasons, the
18025 standard default Ada allocators/deallocators do not use any explicit storage
18026 pools but if they did, they could use this storage pool without any change in
18027 behavior. That is why this storage pool is used when the user
18028 manages to make the default implicit allocator explicit as in this example:
18029 @smallexample @c ada
18030 type T1 is access Something;
18031 -- no Storage pool is defined for T2
18032 type T2 is access Something_Else;
18033 for T2'Storage_Pool use T1'Storage_Pool;
18034 -- the above is equivalent to
18035 for T2'Storage_Pool use System.Pool_Global.Global_Pool_Object;
18039 The @code{System.Pool_Local} package offers the Unbounded_Reclaim_Pool storage
18040 pool. The allocation strategy is similar to @code{Pool_Local}'s
18041 except that the all
18042 storage allocated with this pool is reclaimed when the pool object goes out of
18043 scope. This pool provides a explicit mechanism similar to the implicit one
18044 provided by several Ada 83 compilers for allocations performed through a local
18045 access type and whose purpose was to reclaim memory when exiting the
18046 scope of a given local access. As an example, the following program does not
18047 leak memory even though it does not perform explicit deallocation:
18049 @smallexample @c ada
18050 with System.Pool_Local;
18051 procedure Pooloc1 is
18052 procedure Internal is
18053 type A is access Integer;
18054 X : System.Pool_Local.Unbounded_Reclaim_Pool;
18055 for A'Storage_Pool use X;
18058 for I in 1 .. 50 loop
18063 for I in 1 .. 100 loop
18070 The @code{System.Pool_Size} package implements the Stack_Bounded_Pool used when
18071 @code{Storage_Size} is specified for an access type.
18072 The whole storage for the pool is
18073 allocated at once, usually on the stack at the point where the access type is
18074 elaborated. It is automatically reclaimed when exiting the scope where the
18075 access type is defined. This package is not intended to be used directly by the
18076 user and it is implicitly used for each such declaration:
18078 @smallexample @c ada
18079 type T1 is access Something;
18080 for T1'Storage_Size use 10_000;
18084 @node The GNAT Debug Pool Facility
18085 @section The GNAT Debug Pool Facility
18087 @cindex storage, pool, memory corruption
18090 The use of unchecked deallocation and unchecked conversion can easily
18091 lead to incorrect memory references. The problems generated by such
18092 references are usually difficult to tackle because the symptoms can be
18093 very remote from the origin of the problem. In such cases, it is
18094 very helpful to detect the problem as early as possible. This is the
18095 purpose of the Storage Pool provided by @code{GNAT.Debug_Pools}.
18097 In order to use the GNAT specific debugging pool, the user must
18098 associate a debug pool object with each of the access types that may be
18099 related to suspected memory problems. See Ada Reference Manual 13.11.
18100 @smallexample @c ada
18101 type Ptr is access Some_Type;
18102 Pool : GNAT.Debug_Pools.Debug_Pool;
18103 for Ptr'Storage_Pool use Pool;
18107 @code{GNAT.Debug_Pools} is derived from a GNAT-specific kind of
18108 pool: the @code{Checked_Pool}. Such pools, like standard Ada storage pools,
18109 allow the user to redefine allocation and deallocation strategies. They
18110 also provide a checkpoint for each dereference, through the use of
18111 the primitive operation @code{Dereference} which is implicitly called at
18112 each dereference of an access value.
18114 Once an access type has been associated with a debug pool, operations on
18115 values of the type may raise four distinct exceptions,
18116 which correspond to four potential kinds of memory corruption:
18119 @code{GNAT.Debug_Pools.Accessing_Not_Allocated_Storage}
18121 @code{GNAT.Debug_Pools.Accessing_Deallocated_Storage}
18123 @code{GNAT.Debug_Pools.Freeing_Not_Allocated_Storage}
18125 @code{GNAT.Debug_Pools.Freeing_Deallocated_Storage }
18129 For types associated with a Debug_Pool, dynamic allocation is performed using
18130 the standard GNAT allocation routine. References to all allocated chunks of
18131 memory are kept in an internal dictionary. Several deallocation strategies are
18132 provided, whereupon the user can choose to release the memory to the system,
18133 keep it allocated for further invalid access checks, or fill it with an easily
18134 recognizable pattern for debug sessions. The memory pattern is the old IBM
18135 hexadecimal convention: @code{16#DEADBEEF#}.
18137 See the documentation in the file g-debpoo.ads for more information on the
18138 various strategies.
18140 Upon each dereference, a check is made that the access value denotes a
18141 properly allocated memory location. Here is a complete example of use of
18142 @code{Debug_Pools}, that includes typical instances of memory corruption:
18143 @smallexample @c ada
18147 with Gnat.Io; use Gnat.Io;
18148 with Unchecked_Deallocation;
18149 with Unchecked_Conversion;
18150 with GNAT.Debug_Pools;
18151 with System.Storage_Elements;
18152 with Ada.Exceptions; use Ada.Exceptions;
18153 procedure Debug_Pool_Test is
18155 type T is access Integer;
18156 type U is access all T;
18158 P : GNAT.Debug_Pools.Debug_Pool;
18159 for T'Storage_Pool use P;
18161 procedure Free is new Unchecked_Deallocation (Integer, T);
18162 function UC is new Unchecked_Conversion (U, T);
18165 procedure Info is new GNAT.Debug_Pools.Print_Info(Put_Line);
18175 Put_Line (Integer'Image(B.all));
18177 when E : others => Put_Line ("raised: " & Exception_Name (E));
18182 when E : others => Put_Line ("raised: " & Exception_Name (E));
18186 Put_Line (Integer'Image(B.all));
18188 when E : others => Put_Line ("raised: " & Exception_Name (E));
18193 when E : others => Put_Line ("raised: " & Exception_Name (E));
18196 end Debug_Pool_Test;
18200 The debug pool mechanism provides the following precise diagnostics on the
18201 execution of this erroneous program:
18204 Total allocated bytes : 0
18205 Total deallocated bytes : 0
18206 Current Water Mark: 0
18210 Total allocated bytes : 8
18211 Total deallocated bytes : 0
18212 Current Water Mark: 8
18215 raised: GNAT.DEBUG_POOLS.ACCESSING_DEALLOCATED_STORAGE
18216 raised: GNAT.DEBUG_POOLS.FREEING_DEALLOCATED_STORAGE
18217 raised: GNAT.DEBUG_POOLS.ACCESSING_NOT_ALLOCATED_STORAGE
18218 raised: GNAT.DEBUG_POOLS.FREEING_NOT_ALLOCATED_STORAGE
18220 Total allocated bytes : 8
18221 Total deallocated bytes : 4
18222 Current Water Mark: 4
18227 @node The gnatmem Tool
18228 @section The @command{gnatmem} Tool
18232 The @code{gnatmem} utility monitors dynamic allocation and
18233 deallocation activity in a program, and displays information about
18234 incorrect deallocations and possible sources of memory leaks.
18235 It provides three type of information:
18238 General information concerning memory management, such as the total
18239 number of allocations and deallocations, the amount of allocated
18240 memory and the high water mark, i.e. the largest amount of allocated
18241 memory in the course of program execution.
18244 Backtraces for all incorrect deallocations, that is to say deallocations
18245 which do not correspond to a valid allocation.
18248 Information on each allocation that is potentially the origin of a memory
18253 * Running gnatmem::
18254 * Switches for gnatmem::
18255 * Example of gnatmem Usage::
18258 @node Running gnatmem
18259 @subsection Running @code{gnatmem}
18262 @code{gnatmem} makes use of the output created by the special version of
18263 allocation and deallocation routines that record call information. This
18264 allows to obtain accurate dynamic memory usage history at a minimal cost to
18265 the execution speed. Note however, that @code{gnatmem} is not supported on
18266 all platforms (currently, it is supported on AIX, HP-UX, GNU/Linux x86,
18267 32-bit Solaris (sparc and x86) and Windows NT/2000/XP (x86).
18270 The @code{gnatmem} command has the form
18273 $ gnatmem [switches] user_program
18277 The program must have been linked with the instrumented version of the
18278 allocation and deallocation routines. This is done by linking with the
18279 @file{libgmem.a} library. For correct symbolic backtrace information,
18280 the user program should be compiled with debugging options
18281 @ref{Switches for gcc}. For example to build @file{my_program}:
18284 $ gnatmake -g my_program -largs -lgmem
18288 When running @file{my_program} the file @file{gmem.out} is produced. This file
18289 contains information about all allocations and deallocations done by the
18290 program. It is produced by the instrumented allocations and
18291 deallocations routines and will be used by @code{gnatmem}.
18294 Gnatmem must be supplied with the @file{gmem.out} file and the executable to
18295 examine. If the location of @file{gmem.out} file was not explicitly supplied by
18296 @code{-i} switch, gnatmem will assume that this file can be found in the
18297 current directory. For example, after you have executed @file{my_program},
18298 @file{gmem.out} can be analyzed by @code{gnatmem} using the command:
18301 $ gnatmem my_program
18305 This will produce the output with the following format:
18307 *************** debut cc
18309 $ gnatmem my_program
18313 Total number of allocations : 45
18314 Total number of deallocations : 6
18315 Final Water Mark (non freed mem) : 11.29 Kilobytes
18316 High Water Mark : 11.40 Kilobytes
18321 Allocation Root # 2
18322 -------------------
18323 Number of non freed allocations : 11
18324 Final Water Mark (non freed mem) : 1.16 Kilobytes
18325 High Water Mark : 1.27 Kilobytes
18327 my_program.adb:23 my_program.alloc
18333 The first block of output gives general information. In this case, the
18334 Ada construct ``@code{@b{new}}'' was executed 45 times, and only 6 calls to an
18335 Unchecked_Deallocation routine occurred.
18338 Subsequent paragraphs display information on all allocation roots.
18339 An allocation root is a specific point in the execution of the program
18340 that generates some dynamic allocation, such as a ``@code{@b{new}}''
18341 construct. This root is represented by an execution backtrace (or subprogram
18342 call stack). By default the backtrace depth for allocations roots is 1, so
18343 that a root corresponds exactly to a source location. The backtrace can
18344 be made deeper, to make the root more specific.
18346 @node Switches for gnatmem
18347 @subsection Switches for @code{gnatmem}
18350 @code{gnatmem} recognizes the following switches:
18355 @cindex @option{-q} (@code{gnatmem})
18356 Quiet. Gives the minimum output needed to identify the origin of the
18357 memory leaks. Omits statistical information.
18360 @cindex @var{N} (@code{gnatmem})
18361 N is an integer literal (usually between 1 and 10) which controls the
18362 depth of the backtraces defining allocation root. The default value for
18363 N is 1. The deeper the backtrace, the more precise the localization of
18364 the root. Note that the total number of roots can depend on this
18365 parameter. This parameter must be specified @emph{before} the name of the
18366 executable to be analyzed, to avoid ambiguity.
18369 @cindex @option{-b} (@code{gnatmem})
18370 This switch has the same effect as just depth parameter.
18372 @item -i @var{file}
18373 @cindex @option{-i} (@code{gnatmem})
18374 Do the @code{gnatmem} processing starting from @file{file}, rather than
18375 @file{gmem.out} in the current directory.
18378 @cindex @option{-m} (@code{gnatmem})
18379 This switch causes @code{gnatmem} to mask the allocation roots that have less
18380 than n leaks. The default value is 1. Specifying the value of 0 will allow to
18381 examine even the roots that didn't result in leaks.
18384 @cindex @option{-s} (@code{gnatmem})
18385 This switch causes @code{gnatmem} to sort the allocation roots according to the
18386 specified order of sort criteria, each identified by a single letter. The
18387 currently supported criteria are @code{n, h, w} standing respectively for
18388 number of unfreed allocations, high watermark, and final watermark
18389 corresponding to a specific root. The default order is @code{nwh}.
18393 @node Example of gnatmem Usage
18394 @subsection Example of @code{gnatmem} Usage
18397 The following example shows the use of @code{gnatmem}
18398 on a simple memory-leaking program.
18399 Suppose that we have the following Ada program:
18401 @smallexample @c ada
18404 with Unchecked_Deallocation;
18405 procedure Test_Gm is
18407 type T is array (1..1000) of Integer;
18408 type Ptr is access T;
18409 procedure Free is new Unchecked_Deallocation (T, Ptr);
18412 procedure My_Alloc is
18417 procedure My_DeAlloc is
18425 for I in 1 .. 5 loop
18426 for J in I .. 5 loop
18437 The program needs to be compiled with debugging option and linked with
18438 @code{gmem} library:
18441 $ gnatmake -g test_gm -largs -lgmem
18445 Then we execute the program as usual:
18452 Then @code{gnatmem} is invoked simply with
18458 which produces the following output (result may vary on different platforms):
18463 Total number of allocations : 18
18464 Total number of deallocations : 5
18465 Final Water Mark (non freed mem) : 53.00 Kilobytes
18466 High Water Mark : 56.90 Kilobytes
18468 Allocation Root # 1
18469 -------------------
18470 Number of non freed allocations : 11
18471 Final Water Mark (non freed mem) : 42.97 Kilobytes
18472 High Water Mark : 46.88 Kilobytes
18474 test_gm.adb:11 test_gm.my_alloc
18476 Allocation Root # 2
18477 -------------------
18478 Number of non freed allocations : 1
18479 Final Water Mark (non freed mem) : 10.02 Kilobytes
18480 High Water Mark : 10.02 Kilobytes
18482 s-secsta.adb:81 system.secondary_stack.ss_init
18484 Allocation Root # 3
18485 -------------------
18486 Number of non freed allocations : 1
18487 Final Water Mark (non freed mem) : 12 Bytes
18488 High Water Mark : 12 Bytes
18490 s-secsta.adb:181 system.secondary_stack.ss_init
18494 Note that the GNAT run time contains itself a certain number of
18495 allocations that have no corresponding deallocation,
18496 as shown here for root #2 and root
18497 #3. This is a normal behavior when the number of non freed allocations
18498 is one, it allocates dynamic data structures that the run time needs for
18499 the complete lifetime of the program. Note also that there is only one
18500 allocation root in the user program with a single line back trace:
18501 test_gm.adb:11 test_gm.my_alloc, whereas a careful analysis of the
18502 program shows that 'My_Alloc' is called at 2 different points in the
18503 source (line 21 and line 24). If those two allocation roots need to be
18504 distinguished, the backtrace depth parameter can be used:
18507 $ gnatmem 3 test_gm
18511 which will give the following output:
18516 Total number of allocations : 18
18517 Total number of deallocations : 5
18518 Final Water Mark (non freed mem) : 53.00 Kilobytes
18519 High Water Mark : 56.90 Kilobytes
18521 Allocation Root # 1
18522 -------------------
18523 Number of non freed allocations : 10
18524 Final Water Mark (non freed mem) : 39.06 Kilobytes
18525 High Water Mark : 42.97 Kilobytes
18527 test_gm.adb:11 test_gm.my_alloc
18528 test_gm.adb:24 test_gm
18529 b_test_gm.c:52 main
18531 Allocation Root # 2
18532 -------------------
18533 Number of non freed allocations : 1
18534 Final Water Mark (non freed mem) : 10.02 Kilobytes
18535 High Water Mark : 10.02 Kilobytes
18537 s-secsta.adb:81 system.secondary_stack.ss_init
18538 s-secsta.adb:283 <system__secondary_stack___elabb>
18539 b_test_gm.c:33 adainit
18541 Allocation Root # 3
18542 -------------------
18543 Number of non freed allocations : 1
18544 Final Water Mark (non freed mem) : 3.91 Kilobytes
18545 High Water Mark : 3.91 Kilobytes
18547 test_gm.adb:11 test_gm.my_alloc
18548 test_gm.adb:21 test_gm
18549 b_test_gm.c:52 main
18551 Allocation Root # 4
18552 -------------------
18553 Number of non freed allocations : 1
18554 Final Water Mark (non freed mem) : 12 Bytes
18555 High Water Mark : 12 Bytes
18557 s-secsta.adb:181 system.secondary_stack.ss_init
18558 s-secsta.adb:283 <system__secondary_stack___elabb>
18559 b_test_gm.c:33 adainit
18563 The allocation root #1 of the first example has been split in 2 roots #1
18564 and #3 thanks to the more precise associated backtrace.
18568 @node Creating Sample Bodies Using gnatstub
18569 @chapter Creating Sample Bodies Using @command{gnatstub}
18573 @command{gnatstub} creates body stubs, that is, empty but compilable bodies
18574 for library unit declarations.
18576 To create a body stub, @command{gnatstub} has to compile the library
18577 unit declaration. Therefore, bodies can be created only for legal
18578 library units. Moreover, if a library unit depends semantically upon
18579 units located outside the current directory, you have to provide
18580 the source search path when calling @command{gnatstub}, see the description
18581 of @command{gnatstub} switches below.
18584 * Running gnatstub::
18585 * Switches for gnatstub::
18588 @node Running gnatstub
18589 @section Running @command{gnatstub}
18592 @command{gnatstub} has the command-line interface of the form
18595 $ gnatstub [switches] filename [directory]
18602 is the name of the source file that contains a library unit declaration
18603 for which a body must be created. The file name may contain the path
18605 The file name does not have to follow the GNAT file name conventions. If the
18607 does not follow GNAT file naming conventions, the name of the body file must
18609 explicitly as the value of the @option{^-o^/BODY=^@var{body-name}} option.
18610 If the file name follows the GNAT file naming
18611 conventions and the name of the body file is not provided,
18614 of the body file from the argument file name by replacing the @file{.ads}
18616 with the @file{.adb} suffix.
18619 indicates the directory in which the body stub is to be placed (the default
18624 is an optional sequence of switches as described in the next section
18627 @node Switches for gnatstub
18628 @section Switches for @command{gnatstub}
18634 @cindex @option{^-f^/FULL^} (@command{gnatstub})
18635 If the destination directory already contains a file with the name of the
18637 for the argument spec file, replace it with the generated body stub.
18639 @item ^-hs^/HEADER=SPEC^
18640 @cindex @option{^-hs^/HEADER=SPEC^} (@command{gnatstub})
18641 Put the comment header (i.e., all the comments preceding the
18642 compilation unit) from the source of the library unit declaration
18643 into the body stub.
18645 @item ^-hg^/HEADER=GENERAL^
18646 @cindex @option{^-hg^/HEADER=GENERAL^} (@command{gnatstub})
18647 Put a sample comment header into the body stub.
18651 @cindex @option{-IDIR} (@command{gnatstub})
18653 @cindex @option{-I-} (@command{gnatstub})
18656 @item /NOCURRENT_DIRECTORY
18657 @cindex @option{/NOCURRENT_DIRECTORY} (@command{gnatstub})
18659 ^These switches have ^This switch has^ the same meaning as in calls to
18661 ^They define ^It defines ^ the source search path in the call to
18662 @command{gcc} issued
18663 by @command{gnatstub} to compile an argument source file.
18665 @item ^-gnatec^/CONFIGURATION_PRAGMAS_FILE=^@var{PATH}
18666 @cindex @option{^-gnatec^/CONFIGURATION_PRAGMAS_FILE^} (@command{gnatstub})
18667 This switch has the same meaning as in calls to @command{gcc}.
18668 It defines the additional configuration file to be passed to the call to
18669 @command{gcc} issued
18670 by @command{gnatstub} to compile an argument source file.
18672 @item ^-gnatyM^/MAX_LINE_LENGTH=^@var{n}
18673 @cindex @option{^-gnatyM^/MAX_LINE_LENGTH^} (@command{gnatstub})
18674 (@var{n} is a non-negative integer). Set the maximum line length in the
18675 body stub to @var{n}; the default is 79. The maximum value that can be
18676 specified is 32767. Note that in the special case of configuration
18677 pragma files, the maximum is always 32767 regardless of whether or
18678 not this switch appears.
18680 @item ^-gnaty^/STYLE_CHECKS=^@var{n}
18681 @cindex @option{^-gnaty^/STYLE_CHECKS=^} (@command{gnatstub})
18682 (@var{n} is a non-negative integer from 1 to 9). Set the indentation level in
18683 the generated body sample to @var{n}.
18684 The default indentation is 3.
18686 @item ^-gnatyo^/ORDERED_SUBPROGRAMS^
18687 @cindex @option{^-gnato^/ORDERED_SUBPROGRAMS^} (@command{gnatstub})
18688 Order local bodies alphabetically. (By default local bodies are ordered
18689 in the same way as the corresponding local specs in the argument spec file.)
18691 @item ^-i^/INDENTATION=^@var{n}
18692 @cindex @option{^-i^/INDENTATION^} (@command{gnatstub})
18693 Same as @option{^-gnaty^/STYLE_CHECKS=^@var{n}}
18695 @item ^-k^/TREE_FILE=SAVE^
18696 @cindex @option{^-k^/TREE_FILE=SAVE^} (@command{gnatstub})
18697 Do not remove the tree file (i.e., the snapshot of the compiler internal
18698 structures used by @command{gnatstub}) after creating the body stub.
18700 @item ^-l^/LINE_LENGTH=^@var{n}
18701 @cindex @option{^-l^/LINE_LENGTH^} (@command{gnatstub})
18702 Same as @option{^-gnatyM^/MAX_LINE_LENGTH=^@var{n}}
18704 @item ^-o^/BODY=^@var{body-name}
18705 @cindex @option{^-o^/BODY^} (@command{gnatstub})
18706 Body file name. This should be set if the argument file name does not
18708 the GNAT file naming
18709 conventions. If this switch is omitted the default name for the body will be
18711 from the argument file name according to the GNAT file naming conventions.
18714 @cindex @option{^-q^/QUIET^} (@command{gnatstub})
18715 Quiet mode: do not generate a confirmation when a body is
18716 successfully created, and do not generate a message when a body is not
18720 @item ^-r^/TREE_FILE=REUSE^
18721 @cindex @option{^-r^/TREE_FILE=REUSE^} (@command{gnatstub})
18722 Reuse the tree file (if it exists) instead of creating it. Instead of
18723 creating the tree file for the library unit declaration, @command{gnatstub}
18724 tries to find it in the current directory and use it for creating
18725 a body. If the tree file is not found, no body is created. This option
18726 also implies @option{^-k^/SAVE^}, whether or not
18727 the latter is set explicitly.
18729 @item ^-t^/TREE_FILE=OVERWRITE^
18730 @cindex @option{^-t^/TREE_FILE=OVERWRITE^} (@command{gnatstub})
18731 Overwrite the existing tree file. If the current directory already
18732 contains the file which, according to the GNAT file naming rules should
18733 be considered as a tree file for the argument source file,
18735 will refuse to create the tree file needed to create a sample body
18736 unless this option is set.
18738 @item ^-v^/VERBOSE^
18739 @cindex @option{^-v^/VERBOSE^} (@command{gnatstub})
18740 Verbose mode: generate version information.
18744 @node Other Utility Programs
18745 @chapter Other Utility Programs
18748 This chapter discusses some other utility programs available in the Ada
18752 * Using Other Utility Programs with GNAT::
18753 * The External Symbol Naming Scheme of GNAT::
18755 * Ada Mode for Glide::
18757 * Converting Ada Files to html with gnathtml::
18758 * Installing gnathtml::
18765 @node Using Other Utility Programs with GNAT
18766 @section Using Other Utility Programs with GNAT
18769 The object files generated by GNAT are in standard system format and in
18770 particular the debugging information uses this format. This means
18771 programs generated by GNAT can be used with existing utilities that
18772 depend on these formats.
18775 In general, any utility program that works with C will also often work with
18776 Ada programs generated by GNAT. This includes software utilities such as
18777 gprof (a profiling program), @code{gdb} (the FSF debugger), and utilities such
18781 @node The External Symbol Naming Scheme of GNAT
18782 @section The External Symbol Naming Scheme of GNAT
18785 In order to interpret the output from GNAT, when using tools that are
18786 originally intended for use with other languages, it is useful to
18787 understand the conventions used to generate link names from the Ada
18790 All link names are in all lowercase letters. With the exception of library
18791 procedure names, the mechanism used is simply to use the full expanded
18792 Ada name with dots replaced by double underscores. For example, suppose
18793 we have the following package spec:
18795 @smallexample @c ada
18806 The variable @code{MN} has a full expanded Ada name of @code{QRS.MN}, so
18807 the corresponding link name is @code{qrs__mn}.
18809 Of course if a @code{pragma Export} is used this may be overridden:
18811 @smallexample @c ada
18816 pragma Export (Var1, C, External_Name => "var1_name");
18818 pragma Export (Var2, C, Link_Name => "var2_link_name");
18825 In this case, the link name for @var{Var1} is whatever link name the
18826 C compiler would assign for the C function @var{var1_name}. This typically
18827 would be either @var{var1_name} or @var{_var1_name}, depending on operating
18828 system conventions, but other possibilities exist. The link name for
18829 @var{Var2} is @var{var2_link_name}, and this is not operating system
18833 One exception occurs for library level procedures. A potential ambiguity
18834 arises between the required name @code{_main} for the C main program,
18835 and the name we would otherwise assign to an Ada library level procedure
18836 called @code{Main} (which might well not be the main program).
18838 To avoid this ambiguity, we attach the prefix @code{_ada_} to such
18839 names. So if we have a library level procedure such as
18841 @smallexample @c ada
18844 procedure Hello (S : String);
18850 the external name of this procedure will be @var{_ada_hello}.
18853 @node Ada Mode for Glide
18854 @section Ada Mode for @code{Glide}
18855 @cindex Ada mode (for Glide)
18858 The Glide mode for programming in Ada (both Ada83 and Ada95) helps the
18859 user to understand and navigate existing code, and facilitates writing
18860 new code. It furthermore provides some utility functions for easier
18861 integration of standard Emacs features when programming in Ada.
18863 Its general features include:
18867 An Integrated Development Environment with functionality such as the
18872 ``Project files'' for configuration-specific aspects
18873 (e.g. directories and compilation options)
18876 Compiling and stepping through error messages.
18879 Running and debugging an applications within Glide.
18886 User configurability
18889 Some of the specific Ada mode features are:
18893 Functions for easy and quick stepping through Ada code
18896 Getting cross reference information for identifiers (e.g., finding a
18897 defining occurrence)
18900 Displaying an index menu of types and subprograms, allowing
18901 direct selection for browsing
18904 Automatic color highlighting of the various Ada entities
18907 Glide directly supports writing Ada code, via several facilities:
18911 Switching between spec and body files with possible
18912 autogeneration of body files
18915 Automatic formating of subprogram parameter lists
18918 Automatic indentation according to Ada syntax
18921 Automatic completion of identifiers
18924 Automatic (and configurable) casing of identifiers, keywords, and attributes
18927 Insertion of syntactic templates
18930 Block commenting / uncommenting
18934 For more information, please refer to the online documentation
18935 available in the @code{Glide} @result{} @code{Help} menu.
18938 @node Converting Ada Files to html with gnathtml
18939 @section Converting Ada Files to HTML with @code{gnathtml}
18942 This @code{Perl} script allows Ada source files to be browsed using
18943 standard Web browsers. For installation procedure, see the section
18944 @xref{Installing gnathtml}.
18946 Ada reserved keywords are highlighted in a bold font and Ada comments in
18947 a blue font. Unless your program was compiled with the gcc @option{-gnatx}
18948 switch to suppress the generation of cross-referencing information, user
18949 defined variables and types will appear in a different color; you will
18950 be able to click on any identifier and go to its declaration.
18952 The command line is as follow:
18954 $ perl gnathtml.pl [switches] ada-files
18958 You can pass it as many Ada files as you want. @code{gnathtml} will generate
18959 an html file for every ada file, and a global file called @file{index.htm}.
18960 This file is an index of every identifier defined in the files.
18962 The available switches are the following ones :
18966 @cindex @option{-83} (@code{gnathtml})
18967 Only the subset on the Ada 83 keywords will be highlighted, not the full
18968 Ada 95 keywords set.
18970 @item -cc @var{color}
18971 @cindex @option{-cc} (@code{gnathtml})
18972 This option allows you to change the color used for comments. The default
18973 value is green. The color argument can be any name accepted by html.
18976 @cindex @option{-d} (@code{gnathtml})
18977 If the ada files depend on some other files (using for instance the
18978 @code{with} command, the latter will also be converted to html.
18979 Only the files in the user project will be converted to html, not the files
18980 in the run-time library itself.
18983 @cindex @option{-D} (@code{gnathtml})
18984 This command is the same as @option{-d} above, but @command{gnathtml} will
18985 also look for files in the run-time library, and generate html files for them.
18987 @item -ext @var{extension}
18988 @cindex @option{-ext} (@code{gnathtml})
18989 This option allows you to change the extension of the generated HTML files.
18990 If you do not specify an extension, it will default to @file{htm}.
18993 @cindex @option{-f} (@code{gnathtml})
18994 By default, gnathtml will generate html links only for global entities
18995 ('with'ed units, global variables and types,...). If you specify the
18996 @option{-f} on the command line, then links will be generated for local
18999 @item -l @var{number}
19000 @cindex @option{-l} (@code{gnathtml})
19001 If this switch is provided and @var{number} is not 0, then @code{gnathtml}
19002 will number the html files every @var{number} line.
19005 @cindex @option{-I} (@code{gnathtml})
19006 Specify a directory to search for library files (@file{.ALI} files) and
19007 source files. You can provide several -I switches on the command line,
19008 and the directories will be parsed in the order of the command line.
19011 @cindex @option{-o} (@code{gnathtml})
19012 Specify the output directory for html files. By default, gnathtml will
19013 saved the generated html files in a subdirectory named @file{html/}.
19015 @item -p @var{file}
19016 @cindex @option{-p} (@code{gnathtml})
19017 If you are using Emacs and the most recent Emacs Ada mode, which provides
19018 a full Integrated Development Environment for compiling, checking,
19019 running and debugging applications, you may use @file{.gpr} files
19020 to give the directories where Emacs can find sources and object files.
19022 Using this switch, you can tell gnathtml to use these files. This allows
19023 you to get an html version of your application, even if it is spread
19024 over multiple directories.
19026 @item -sc @var{color}
19027 @cindex @option{-sc} (@code{gnathtml})
19028 This option allows you to change the color used for symbol definitions.
19029 The default value is red. The color argument can be any name accepted by html.
19031 @item -t @var{file}
19032 @cindex @option{-t} (@code{gnathtml})
19033 This switch provides the name of a file. This file contains a list of
19034 file names to be converted, and the effect is exactly as though they had
19035 appeared explicitly on the command line. This
19036 is the recommended way to work around the command line length limit on some
19041 @node Installing gnathtml
19042 @section Installing @code{gnathtml}
19045 @code{Perl} needs to be installed on your machine to run this script.
19046 @code{Perl} is freely available for almost every architecture and
19047 Operating System via the Internet.
19049 On Unix systems, you may want to modify the first line of the script
19050 @code{gnathtml}, to explicitly tell the Operating system where Perl
19051 is. The syntax of this line is :
19053 #!full_path_name_to_perl
19057 Alternatively, you may run the script using the following command line:
19060 $ perl gnathtml.pl [switches] files
19069 The GNAT distribution provides an Ada 95 template for the Digital Language
19070 Sensitive Editor (LSE), a component of DECset. In order to
19071 access it, invoke LSE with the qualifier /ENVIRONMENT=GNU:[LIB]ADA95.ENV.
19078 GNAT supports The Digital Performance Coverage Analyzer (PCA), a component
19079 of DECset. To use it proceed as outlined under ``HELP PCA'', except for running
19080 the collection phase with the /DEBUG qualifier.
19083 $ GNAT MAKE /DEBUG <PROGRAM_NAME>
19084 $ DEFINE LIB$DEBUG PCA$COLLECTOR
19085 $ RUN/DEBUG <PROGRAM_NAME>
19090 @node Running and Debugging Ada Programs
19091 @chapter Running and Debugging Ada Programs
19095 This chapter discusses how to debug Ada programs.
19097 It applies to the Alpha OpenVMS platform;
19098 the debugger for Integrity OpenVMS is scheduled for a subsequent release.
19101 An incorrect Ada program may be handled in three ways by the GNAT compiler:
19105 The illegality may be a violation of the static semantics of Ada. In
19106 that case GNAT diagnoses the constructs in the program that are illegal.
19107 It is then a straightforward matter for the user to modify those parts of
19111 The illegality may be a violation of the dynamic semantics of Ada. In
19112 that case the program compiles and executes, but may generate incorrect
19113 results, or may terminate abnormally with some exception.
19116 When presented with a program that contains convoluted errors, GNAT
19117 itself may terminate abnormally without providing full diagnostics on
19118 the incorrect user program.
19122 * The GNAT Debugger GDB::
19124 * Introduction to GDB Commands::
19125 * Using Ada Expressions::
19126 * Calling User-Defined Subprograms::
19127 * Using the Next Command in a Function::
19130 * Debugging Generic Units::
19131 * GNAT Abnormal Termination or Failure to Terminate::
19132 * Naming Conventions for GNAT Source Files::
19133 * Getting Internal Debugging Information::
19134 * Stack Traceback::
19140 @node The GNAT Debugger GDB
19141 @section The GNAT Debugger GDB
19144 @code{GDB} is a general purpose, platform-independent debugger that
19145 can be used to debug mixed-language programs compiled with @command{gcc},
19146 and in particular is capable of debugging Ada programs compiled with
19147 GNAT. The latest versions of @code{GDB} are Ada-aware and can handle
19148 complex Ada data structures.
19150 The manual @cite{Debugging with GDB}
19152 , located in the GNU:[DOCS] directory,
19154 contains full details on the usage of @code{GDB}, including a section on
19155 its usage on programs. This manual should be consulted for full
19156 details. The section that follows is a brief introduction to the
19157 philosophy and use of @code{GDB}.
19159 When GNAT programs are compiled, the compiler optionally writes debugging
19160 information into the generated object file, including information on
19161 line numbers, and on declared types and variables. This information is
19162 separate from the generated code. It makes the object files considerably
19163 larger, but it does not add to the size of the actual executable that
19164 will be loaded into memory, and has no impact on run-time performance. The
19165 generation of debug information is triggered by the use of the
19166 ^-g^/DEBUG^ switch in the gcc or gnatmake command used to carry out
19167 the compilations. It is important to emphasize that the use of these
19168 options does not change the generated code.
19170 The debugging information is written in standard system formats that
19171 are used by many tools, including debuggers and profilers. The format
19172 of the information is typically designed to describe C types and
19173 semantics, but GNAT implements a translation scheme which allows full
19174 details about Ada types and variables to be encoded into these
19175 standard C formats. Details of this encoding scheme may be found in
19176 the file exp_dbug.ads in the GNAT source distribution. However, the
19177 details of this encoding are, in general, of no interest to a user,
19178 since @code{GDB} automatically performs the necessary decoding.
19180 When a program is bound and linked, the debugging information is
19181 collected from the object files, and stored in the executable image of
19182 the program. Again, this process significantly increases the size of
19183 the generated executable file, but it does not increase the size of
19184 the executable program itself. Furthermore, if this program is run in
19185 the normal manner, it runs exactly as if the debug information were
19186 not present, and takes no more actual memory.
19188 However, if the program is run under control of @code{GDB}, the
19189 debugger is activated. The image of the program is loaded, at which
19190 point it is ready to run. If a run command is given, then the program
19191 will run exactly as it would have if @code{GDB} were not present. This
19192 is a crucial part of the @code{GDB} design philosophy. @code{GDB} is
19193 entirely non-intrusive until a breakpoint is encountered. If no
19194 breakpoint is ever hit, the program will run exactly as it would if no
19195 debugger were present. When a breakpoint is hit, @code{GDB} accesses
19196 the debugging information and can respond to user commands to inspect
19197 variables, and more generally to report on the state of execution.
19201 @section Running GDB
19204 The debugger can be launched directly and simply from @code{glide} or
19205 through its graphical interface: @code{gvd}. It can also be used
19206 directly in text mode. Here is described the basic use of @code{GDB}
19207 in text mode. All the commands described below can be used in the
19208 @code{gvd} console window even though there is usually other more
19209 graphical ways to achieve the same goals.
19213 The command to run the graphical interface of the debugger is
19220 The command to run @code{GDB} in text mode is
19223 $ ^gdb program^$ GDB PROGRAM^
19227 where @code{^program^PROGRAM^} is the name of the executable file. This
19228 activates the debugger and results in a prompt for debugger commands.
19229 The simplest command is simply @code{run}, which causes the program to run
19230 exactly as if the debugger were not present. The following section
19231 describes some of the additional commands that can be given to @code{GDB}.
19233 @c *******************************
19234 @node Introduction to GDB Commands
19235 @section Introduction to GDB Commands
19238 @code{GDB} contains a large repertoire of commands. The manual
19239 @cite{Debugging with GDB}
19241 , located in the GNU:[DOCS] directory,
19243 includes extensive documentation on the use
19244 of these commands, together with examples of their use. Furthermore,
19245 the command @var{help} invoked from within @code{GDB} activates a simple help
19246 facility which summarizes the available commands and their options.
19247 In this section we summarize a few of the most commonly
19248 used commands to give an idea of what @code{GDB} is about. You should create
19249 a simple program with debugging information and experiment with the use of
19250 these @code{GDB} commands on the program as you read through the
19254 @item set args @var{arguments}
19255 The @var{arguments} list above is a list of arguments to be passed to
19256 the program on a subsequent run command, just as though the arguments
19257 had been entered on a normal invocation of the program. The @code{set args}
19258 command is not needed if the program does not require arguments.
19261 The @code{run} command causes execution of the program to start from
19262 the beginning. If the program is already running, that is to say if
19263 you are currently positioned at a breakpoint, then a prompt will ask
19264 for confirmation that you want to abandon the current execution and
19267 @item breakpoint @var{location}
19268 The breakpoint command sets a breakpoint, that is to say a point at which
19269 execution will halt and @code{GDB} will await further
19270 commands. @var{location} is
19271 either a line number within a file, given in the format @code{file:linenumber},
19272 or it is the name of a subprogram. If you request that a breakpoint be set on
19273 a subprogram that is overloaded, a prompt will ask you to specify on which of
19274 those subprograms you want to breakpoint. You can also
19275 specify that all of them should be breakpointed. If the program is run
19276 and execution encounters the breakpoint, then the program
19277 stops and @code{GDB} signals that the breakpoint was encountered by
19278 printing the line of code before which the program is halted.
19280 @item breakpoint exception @var{name}
19281 A special form of the breakpoint command which breakpoints whenever
19282 exception @var{name} is raised.
19283 If @var{name} is omitted,
19284 then a breakpoint will occur when any exception is raised.
19286 @item print @var{expression}
19287 This will print the value of the given expression. Most simple
19288 Ada expression formats are properly handled by @code{GDB}, so the expression
19289 can contain function calls, variables, operators, and attribute references.
19292 Continues execution following a breakpoint, until the next breakpoint or the
19293 termination of the program.
19296 Executes a single line after a breakpoint. If the next statement
19297 is a subprogram call, execution continues into (the first statement of)
19298 the called subprogram.
19301 Executes a single line. If this line is a subprogram call, executes and
19302 returns from the call.
19305 Lists a few lines around the current source location. In practice, it
19306 is usually more convenient to have a separate edit window open with the
19307 relevant source file displayed. Successive applications of this command
19308 print subsequent lines. The command can be given an argument which is a
19309 line number, in which case it displays a few lines around the specified one.
19312 Displays a backtrace of the call chain. This command is typically
19313 used after a breakpoint has occurred, to examine the sequence of calls that
19314 leads to the current breakpoint. The display includes one line for each
19315 activation record (frame) corresponding to an active subprogram.
19318 At a breakpoint, @code{GDB} can display the values of variables local
19319 to the current frame. The command @code{up} can be used to
19320 examine the contents of other active frames, by moving the focus up
19321 the stack, that is to say from callee to caller, one frame at a time.
19324 Moves the focus of @code{GDB} down from the frame currently being
19325 examined to the frame of its callee (the reverse of the previous command),
19327 @item frame @var{n}
19328 Inspect the frame with the given number. The value 0 denotes the frame
19329 of the current breakpoint, that is to say the top of the call stack.
19333 The above list is a very short introduction to the commands that
19334 @code{GDB} provides. Important additional capabilities, including conditional
19335 breakpoints, the ability to execute command sequences on a breakpoint,
19336 the ability to debug at the machine instruction level and many other
19337 features are described in detail in @cite{Debugging with GDB}.
19338 Note that most commands can be abbreviated
19339 (for example, c for continue, bt for backtrace).
19341 @node Using Ada Expressions
19342 @section Using Ada Expressions
19343 @cindex Ada expressions
19346 @code{GDB} supports a fairly large subset of Ada expression syntax, with some
19347 extensions. The philosophy behind the design of this subset is
19351 That @code{GDB} should provide basic literals and access to operations for
19352 arithmetic, dereferencing, field selection, indexing, and subprogram calls,
19353 leaving more sophisticated computations to subprograms written into the
19354 program (which therefore may be called from @code{GDB}).
19357 That type safety and strict adherence to Ada language restrictions
19358 are not particularly important to the @code{GDB} user.
19361 That brevity is important to the @code{GDB} user.
19364 Thus, for brevity, the debugger acts as if there were
19365 implicit @code{with} and @code{use} clauses in effect for all user-written
19366 packages, thus making it unnecessary to fully qualify most names with
19367 their packages, regardless of context. Where this causes ambiguity,
19368 @code{GDB} asks the user's intent.
19370 For details on the supported Ada syntax, see @cite{Debugging with GDB}.
19372 @node Calling User-Defined Subprograms
19373 @section Calling User-Defined Subprograms
19376 An important capability of @code{GDB} is the ability to call user-defined
19377 subprograms while debugging. This is achieved simply by entering
19378 a subprogram call statement in the form:
19381 call subprogram-name (parameters)
19385 The keyword @code{call} can be omitted in the normal case where the
19386 @code{subprogram-name} does not coincide with any of the predefined
19387 @code{GDB} commands.
19389 The effect is to invoke the given subprogram, passing it the
19390 list of parameters that is supplied. The parameters can be expressions and
19391 can include variables from the program being debugged. The
19392 subprogram must be defined
19393 at the library level within your program, and @code{GDB} will call the
19394 subprogram within the environment of your program execution (which
19395 means that the subprogram is free to access or even modify variables
19396 within your program).
19398 The most important use of this facility is in allowing the inclusion of
19399 debugging routines that are tailored to particular data structures
19400 in your program. Such debugging routines can be written to provide a suitably
19401 high-level description of an abstract type, rather than a low-level dump
19402 of its physical layout. After all, the standard
19403 @code{GDB print} command only knows the physical layout of your
19404 types, not their abstract meaning. Debugging routines can provide information
19405 at the desired semantic level and are thus enormously useful.
19407 For example, when debugging GNAT itself, it is crucial to have access to
19408 the contents of the tree nodes used to represent the program internally.
19409 But tree nodes are represented simply by an integer value (which in turn
19410 is an index into a table of nodes).
19411 Using the @code{print} command on a tree node would simply print this integer
19412 value, which is not very useful. But the PN routine (defined in file
19413 treepr.adb in the GNAT sources) takes a tree node as input, and displays
19414 a useful high level representation of the tree node, which includes the
19415 syntactic category of the node, its position in the source, the integers
19416 that denote descendant nodes and parent node, as well as varied
19417 semantic information. To study this example in more detail, you might want to
19418 look at the body of the PN procedure in the stated file.
19420 @node Using the Next Command in a Function
19421 @section Using the Next Command in a Function
19424 When you use the @code{next} command in a function, the current source
19425 location will advance to the next statement as usual. A special case
19426 arises in the case of a @code{return} statement.
19428 Part of the code for a return statement is the ``epilog'' of the function.
19429 This is the code that returns to the caller. There is only one copy of
19430 this epilog code, and it is typically associated with the last return
19431 statement in the function if there is more than one return. In some
19432 implementations, this epilog is associated with the first statement
19435 The result is that if you use the @code{next} command from a return
19436 statement that is not the last return statement of the function you
19437 may see a strange apparent jump to the last return statement or to
19438 the start of the function. You should simply ignore this odd jump.
19439 The value returned is always that from the first return statement
19440 that was stepped through.
19442 @node Ada Exceptions
19443 @section Breaking on Ada Exceptions
19447 You can set breakpoints that trip when your program raises
19448 selected exceptions.
19451 @item break exception
19452 Set a breakpoint that trips whenever (any task in the) program raises
19455 @item break exception @var{name}
19456 Set a breakpoint that trips whenever (any task in the) program raises
19457 the exception @var{name}.
19459 @item break exception unhandled
19460 Set a breakpoint that trips whenever (any task in the) program raises an
19461 exception for which there is no handler.
19463 @item info exceptions
19464 @itemx info exceptions @var{regexp}
19465 The @code{info exceptions} command permits the user to examine all defined
19466 exceptions within Ada programs. With a regular expression, @var{regexp}, as
19467 argument, prints out only those exceptions whose name matches @var{regexp}.
19475 @code{GDB} allows the following task-related commands:
19479 This command shows a list of current Ada tasks, as in the following example:
19486 ID TID P-ID Thread Pri State Name
19487 1 8088000 0 807e000 15 Child Activation Wait main_task
19488 2 80a4000 1 80ae000 15 Accept/Select Wait b
19489 3 809a800 1 80a4800 15 Child Activation Wait a
19490 * 4 80ae800 3 80b8000 15 Running c
19494 In this listing, the asterisk before the first task indicates it to be the
19495 currently running task. The first column lists the task ID that is used
19496 to refer to tasks in the following commands.
19498 @item break @var{linespec} task @var{taskid}
19499 @itemx break @var{linespec} task @var{taskid} if @dots{}
19500 @cindex Breakpoints and tasks
19501 These commands are like the @code{break @dots{} thread @dots{}}.
19502 @var{linespec} specifies source lines.
19504 Use the qualifier @samp{task @var{taskid}} with a breakpoint command
19505 to specify that you only want @code{GDB} to stop the program when a
19506 particular Ada task reaches this breakpoint. @var{taskid} is one of the
19507 numeric task identifiers assigned by @code{GDB}, shown in the first
19508 column of the @samp{info tasks} display.
19510 If you do not specify @samp{task @var{taskid}} when you set a
19511 breakpoint, the breakpoint applies to @emph{all} tasks of your
19514 You can use the @code{task} qualifier on conditional breakpoints as
19515 well; in this case, place @samp{task @var{taskid}} before the
19516 breakpoint condition (before the @code{if}).
19518 @item task @var{taskno}
19519 @cindex Task switching
19521 This command allows to switch to the task referred by @var{taskno}. In
19522 particular, This allows to browse the backtrace of the specified
19523 task. It is advised to switch back to the original task before
19524 continuing execution otherwise the scheduling of the program may be
19529 For more detailed information on the tasking support,
19530 see @cite{Debugging with GDB}.
19532 @node Debugging Generic Units
19533 @section Debugging Generic Units
19534 @cindex Debugging Generic Units
19538 GNAT always uses code expansion for generic instantiation. This means that
19539 each time an instantiation occurs, a complete copy of the original code is
19540 made, with appropriate substitutions of formals by actuals.
19542 It is not possible to refer to the original generic entities in
19543 @code{GDB}, but it is always possible to debug a particular instance of
19544 a generic, by using the appropriate expanded names. For example, if we have
19546 @smallexample @c ada
19551 generic package k is
19552 procedure kp (v1 : in out integer);
19556 procedure kp (v1 : in out integer) is
19562 package k1 is new k;
19563 package k2 is new k;
19565 var : integer := 1;
19578 Then to break on a call to procedure kp in the k2 instance, simply
19582 (gdb) break g.k2.kp
19586 When the breakpoint occurs, you can step through the code of the
19587 instance in the normal manner and examine the values of local variables, as for
19590 @node GNAT Abnormal Termination or Failure to Terminate
19591 @section GNAT Abnormal Termination or Failure to Terminate
19592 @cindex GNAT Abnormal Termination or Failure to Terminate
19595 When presented with programs that contain serious errors in syntax
19597 GNAT may on rare occasions experience problems in operation, such
19599 segmentation fault or illegal memory access, raising an internal
19600 exception, terminating abnormally, or failing to terminate at all.
19601 In such cases, you can activate
19602 various features of GNAT that can help you pinpoint the construct in your
19603 program that is the likely source of the problem.
19605 The following strategies are presented in increasing order of
19606 difficulty, corresponding to your experience in using GNAT and your
19607 familiarity with compiler internals.
19611 Run @command{gcc} with the @option{-gnatf}. This first
19612 switch causes all errors on a given line to be reported. In its absence,
19613 only the first error on a line is displayed.
19615 The @option{-gnatdO} switch causes errors to be displayed as soon as they
19616 are encountered, rather than after compilation is terminated. If GNAT
19617 terminates prematurely or goes into an infinite loop, the last error
19618 message displayed may help to pinpoint the culprit.
19621 Run @command{gcc} with the @option{^-v (verbose)^/VERBOSE^} switch. In this
19622 mode, @command{gcc} produces ongoing information about the progress of the
19623 compilation and provides the name of each procedure as code is
19624 generated. This switch allows you to find which Ada procedure was being
19625 compiled when it encountered a code generation problem.
19628 @cindex @option{-gnatdc} switch
19629 Run @command{gcc} with the @option{-gnatdc} switch. This is a GNAT specific
19630 switch that does for the front-end what @option{^-v^VERBOSE^} does
19631 for the back end. The system prints the name of each unit,
19632 either a compilation unit or nested unit, as it is being analyzed.
19634 Finally, you can start
19635 @code{gdb} directly on the @code{gnat1} executable. @code{gnat1} is the
19636 front-end of GNAT, and can be run independently (normally it is just
19637 called from @command{gcc}). You can use @code{gdb} on @code{gnat1} as you
19638 would on a C program (but @pxref{The GNAT Debugger GDB} for caveats). The
19639 @code{where} command is the first line of attack; the variable
19640 @code{lineno} (seen by @code{print lineno}), used by the second phase of
19641 @code{gnat1} and by the @command{gcc} backend, indicates the source line at
19642 which the execution stopped, and @code{input_file name} indicates the name of
19646 @node Naming Conventions for GNAT Source Files
19647 @section Naming Conventions for GNAT Source Files
19650 In order to examine the workings of the GNAT system, the following
19651 brief description of its organization may be helpful:
19655 Files with prefix @file{^sc^SC^} contain the lexical scanner.
19658 All files prefixed with @file{^par^PAR^} are components of the parser. The
19659 numbers correspond to chapters of the Ada 95 Reference Manual. For example,
19660 parsing of select statements can be found in @file{par-ch9.adb}.
19663 All files prefixed with @file{^sem^SEM^} perform semantic analysis. The
19664 numbers correspond to chapters of the Ada standard. For example, all
19665 issues involving context clauses can be found in @file{sem_ch10.adb}. In
19666 addition, some features of the language require sufficient special processing
19667 to justify their own semantic files: sem_aggr for aggregates, sem_disp for
19668 dynamic dispatching, etc.
19671 All files prefixed with @file{^exp^EXP^} perform normalization and
19672 expansion of the intermediate representation (abstract syntax tree, or AST).
19673 these files use the same numbering scheme as the parser and semantics files.
19674 For example, the construction of record initialization procedures is done in
19675 @file{exp_ch3.adb}.
19678 The files prefixed with @file{^bind^BIND^} implement the binder, which
19679 verifies the consistency of the compilation, determines an order of
19680 elaboration, and generates the bind file.
19683 The files @file{atree.ads} and @file{atree.adb} detail the low-level
19684 data structures used by the front-end.
19687 The files @file{sinfo.ads} and @file{sinfo.adb} detail the structure of
19688 the abstract syntax tree as produced by the parser.
19691 The files @file{einfo.ads} and @file{einfo.adb} detail the attributes of
19692 all entities, computed during semantic analysis.
19695 Library management issues are dealt with in files with prefix
19701 Ada files with the prefix @file{^a-^A-^} are children of @code{Ada}, as
19702 defined in Annex A.
19707 Files with prefix @file{^i-^I-^} are children of @code{Interfaces}, as
19708 defined in Annex B.
19712 Files with prefix @file{^s-^S-^} are children of @code{System}. This includes
19713 both language-defined children and GNAT run-time routines.
19717 Files with prefix @file{^g-^G-^} are children of @code{GNAT}. These are useful
19718 general-purpose packages, fully documented in their specifications. All
19719 the other @file{.c} files are modifications of common @command{gcc} files.
19722 @node Getting Internal Debugging Information
19723 @section Getting Internal Debugging Information
19726 Most compilers have internal debugging switches and modes. GNAT
19727 does also, except GNAT internal debugging switches and modes are not
19728 secret. A summary and full description of all the compiler and binder
19729 debug flags are in the file @file{debug.adb}. You must obtain the
19730 sources of the compiler to see the full detailed effects of these flags.
19732 The switches that print the source of the program (reconstructed from
19733 the internal tree) are of general interest for user programs, as are the
19735 the full internal tree, and the entity table (the symbol table
19736 information). The reconstructed source provides a readable version of the
19737 program after the front-end has completed analysis and expansion,
19738 and is useful when studying the performance of specific constructs.
19739 For example, constraint checks are indicated, complex aggregates
19740 are replaced with loops and assignments, and tasking primitives
19741 are replaced with run-time calls.
19743 @node Stack Traceback
19744 @section Stack Traceback
19746 @cindex stack traceback
19747 @cindex stack unwinding
19750 Traceback is a mechanism to display the sequence of subprogram calls that
19751 leads to a specified execution point in a program. Often (but not always)
19752 the execution point is an instruction at which an exception has been raised.
19753 This mechanism is also known as @i{stack unwinding} because it obtains
19754 its information by scanning the run-time stack and recovering the activation
19755 records of all active subprograms. Stack unwinding is one of the most
19756 important tools for program debugging.
19758 The first entry stored in traceback corresponds to the deepest calling level,
19759 that is to say the subprogram currently executing the instruction
19760 from which we want to obtain the traceback.
19762 Note that there is no runtime performance penalty when stack traceback
19763 is enabled, and no exception is raised during program execution.
19766 * Non-Symbolic Traceback::
19767 * Symbolic Traceback::
19770 @node Non-Symbolic Traceback
19771 @subsection Non-Symbolic Traceback
19772 @cindex traceback, non-symbolic
19775 Note: this feature is not supported on all platforms. See
19776 @file{GNAT.Traceback spec in g-traceb.ads} for a complete list of supported
19780 * Tracebacks From an Unhandled Exception::
19781 * Tracebacks From Exception Occurrences (non-symbolic)::
19782 * Tracebacks From Anywhere in a Program (non-symbolic)::
19785 @node Tracebacks From an Unhandled Exception
19786 @subsubsection Tracebacks From an Unhandled Exception
19789 A runtime non-symbolic traceback is a list of addresses of call instructions.
19790 To enable this feature you must use the @option{-E}
19791 @code{gnatbind}'s option. With this option a stack traceback is stored as part
19792 of exception information. You can retrieve this information using the
19793 @code{addr2line} tool.
19795 Here is a simple example:
19797 @smallexample @c ada
19803 raise Constraint_Error;
19818 $ gnatmake stb -bargs -E
19821 Execution terminated by unhandled exception
19822 Exception name: CONSTRAINT_ERROR
19824 Call stack traceback locations:
19825 0x401373 0x40138b 0x40139c 0x401335 0x4011c4 0x4011f1 0x77e892a4
19829 As we see the traceback lists a sequence of addresses for the unhandled
19830 exception @code{CONSTRAINT_ERROR} raised in procedure P1. It is easy to
19831 guess that this exception come from procedure P1. To translate these
19832 addresses into the source lines where the calls appear, the
19833 @code{addr2line} tool, described below, is invaluable. The use of this tool
19834 requires the program to be compiled with debug information.
19837 $ gnatmake -g stb -bargs -E
19840 Execution terminated by unhandled exception
19841 Exception name: CONSTRAINT_ERROR
19843 Call stack traceback locations:
19844 0x401373 0x40138b 0x40139c 0x401335 0x4011c4 0x4011f1 0x77e892a4
19846 $ addr2line --exe=stb 0x401373 0x40138b 0x40139c 0x401335 0x4011c4
19847 0x4011f1 0x77e892a4
19849 00401373 at d:/stb/stb.adb:5
19850 0040138B at d:/stb/stb.adb:10
19851 0040139C at d:/stb/stb.adb:14
19852 00401335 at d:/stb/b~stb.adb:104
19853 004011C4 at /build/.../crt1.c:200
19854 004011F1 at /build/.../crt1.c:222
19855 77E892A4 in ?? at ??:0
19859 The @code{addr2line} tool has several other useful options:
19863 to get the function name corresponding to any location
19865 @item --demangle=gnat
19866 to use the gnat decoding mode for the function names. Note that
19867 for binutils version 2.9.x the option is simply @option{--demangle}.
19871 $ addr2line --exe=stb --functions --demangle=gnat 0x401373 0x40138b
19872 0x40139c 0x401335 0x4011c4 0x4011f1
19874 00401373 in stb.p1 at d:/stb/stb.adb:5
19875 0040138B in stb.p2 at d:/stb/stb.adb:10
19876 0040139C in stb at d:/stb/stb.adb:14
19877 00401335 in main at d:/stb/b~stb.adb:104
19878 004011C4 in <__mingw_CRTStartup> at /build/.../crt1.c:200
19879 004011F1 in <mainCRTStartup> at /build/.../crt1.c:222
19883 From this traceback we can see that the exception was raised in
19884 @file{stb.adb} at line 5, which was reached from a procedure call in
19885 @file{stb.adb} at line 10, and so on. The @file{b~std.adb} is the binder file,
19886 which contains the call to the main program.
19887 @xref{Running gnatbind}. The remaining entries are assorted runtime routines,
19888 and the output will vary from platform to platform.
19890 It is also possible to use @code{GDB} with these traceback addresses to debug
19891 the program. For example, we can break at a given code location, as reported
19892 in the stack traceback:
19898 Furthermore, this feature is not implemented inside Windows DLL. Only
19899 the non-symbolic traceback is reported in this case.
19902 (gdb) break *0x401373
19903 Breakpoint 1 at 0x401373: file stb.adb, line 5.
19907 It is important to note that the stack traceback addresses
19908 do not change when debug information is included. This is particularly useful
19909 because it makes it possible to release software without debug information (to
19910 minimize object size), get a field report that includes a stack traceback
19911 whenever an internal bug occurs, and then be able to retrieve the sequence
19912 of calls with the same program compiled with debug information.
19914 @node Tracebacks From Exception Occurrences (non-symbolic)
19915 @subsubsection Tracebacks From Exception Occurrences
19918 Non-symbolic tracebacks are obtained by using the @option{-E} binder argument.
19919 The stack traceback is attached to the exception information string, and can
19920 be retrieved in an exception handler within the Ada program, by means of the
19921 Ada95 facilities defined in @code{Ada.Exceptions}. Here is a simple example:
19923 @smallexample @c ada
19925 with Ada.Exceptions;
19930 use Ada.Exceptions;
19938 Text_IO.Put_Line (Exception_Information (E));
19952 This program will output:
19957 Exception name: CONSTRAINT_ERROR
19958 Message: stb.adb:12
19959 Call stack traceback locations:
19960 0x4015e4 0x401633 0x401644 0x401461 0x4011c4 0x4011f1 0x77e892a4
19963 @node Tracebacks From Anywhere in a Program (non-symbolic)
19964 @subsubsection Tracebacks From Anywhere in a Program
19967 It is also possible to retrieve a stack traceback from anywhere in a
19968 program. For this you need to
19969 use the @code{GNAT.Traceback} API. This package includes a procedure called
19970 @code{Call_Chain} that computes a complete stack traceback, as well as useful
19971 display procedures described below. It is not necessary to use the
19972 @option{-E gnatbind} option in this case, because the stack traceback mechanism
19973 is invoked explicitly.
19976 In the following example we compute a traceback at a specific location in
19977 the program, and we display it using @code{GNAT.Debug_Utilities.Image} to
19978 convert addresses to strings:
19980 @smallexample @c ada
19982 with GNAT.Traceback;
19983 with GNAT.Debug_Utilities;
19989 use GNAT.Traceback;
19992 TB : Tracebacks_Array (1 .. 10);
19993 -- We are asking for a maximum of 10 stack frames.
19995 -- Len will receive the actual number of stack frames returned.
19997 Call_Chain (TB, Len);
19999 Text_IO.Put ("In STB.P1 : ");
20001 for K in 1 .. Len loop
20002 Text_IO.Put (Debug_Utilities.Image (TB (K)));
20023 In STB.P1 : 16#0040_F1E4# 16#0040_14F2# 16#0040_170B# 16#0040_171C#
20024 16#0040_1461# 16#0040_11C4# 16#0040_11F1# 16#77E8_92A4#
20028 You can then get further information by invoking the @code{addr2line}
20029 tool as described earlier (note that the hexadecimal addresses
20030 need to be specified in C format, with a leading ``0x'').
20032 @node Symbolic Traceback
20033 @subsection Symbolic Traceback
20034 @cindex traceback, symbolic
20037 A symbolic traceback is a stack traceback in which procedure names are
20038 associated with each code location.
20041 Note that this feature is not supported on all platforms. See
20042 @file{GNAT.Traceback.Symbolic spec in g-trasym.ads} for a complete
20043 list of currently supported platforms.
20046 Note that the symbolic traceback requires that the program be compiled
20047 with debug information. If it is not compiled with debug information
20048 only the non-symbolic information will be valid.
20051 * Tracebacks From Exception Occurrences (symbolic)::
20052 * Tracebacks From Anywhere in a Program (symbolic)::
20055 @node Tracebacks From Exception Occurrences (symbolic)
20056 @subsubsection Tracebacks From Exception Occurrences
20058 @smallexample @c ada
20060 with GNAT.Traceback.Symbolic;
20066 raise Constraint_Error;
20083 Ada.Text_IO.Put_Line (GNAT.Traceback.Symbolic.Symbolic_Traceback (E));
20088 $ gnatmake -g .\stb -bargs -E -largs -lgnat -laddr2line -lintl
20091 0040149F in stb.p1 at stb.adb:8
20092 004014B7 in stb.p2 at stb.adb:13
20093 004014CF in stb.p3 at stb.adb:18
20094 004015DD in ada.stb at stb.adb:22
20095 00401461 in main at b~stb.adb:168
20096 004011C4 in __mingw_CRTStartup at crt1.c:200
20097 004011F1 in mainCRTStartup at crt1.c:222
20098 77E892A4 in ?? at ??:0
20102 In the above example the ``.\'' syntax in the @command{gnatmake} command
20103 is currently required by @command{addr2line} for files that are in
20104 the current working directory.
20105 Moreover, the exact sequence of linker options may vary from platform
20107 The above @option{-largs} section is for Windows platforms. By contrast,
20108 under Unix there is no need for the @option{-largs} section.
20109 Differences across platforms are due to details of linker implementation.
20111 @node Tracebacks From Anywhere in a Program (symbolic)
20112 @subsubsection Tracebacks From Anywhere in a Program
20115 It is possible to get a symbolic stack traceback
20116 from anywhere in a program, just as for non-symbolic tracebacks.
20117 The first step is to obtain a non-symbolic
20118 traceback, and then call @code{Symbolic_Traceback} to compute the symbolic
20119 information. Here is an example:
20121 @smallexample @c ada
20123 with GNAT.Traceback;
20124 with GNAT.Traceback.Symbolic;
20129 use GNAT.Traceback;
20130 use GNAT.Traceback.Symbolic;
20133 TB : Tracebacks_Array (1 .. 10);
20134 -- We are asking for a maximum of 10 stack frames.
20136 -- Len will receive the actual number of stack frames returned.
20138 Call_Chain (TB, Len);
20139 Text_IO.Put_Line (Symbolic_Traceback (TB (1 .. Len)));
20153 @node Compatibility with DEC Ada
20154 @chapter Compatibility with DEC Ada
20155 @cindex Compatibility
20158 This section of the manual compares DEC Ada for OpenVMS Alpha and GNAT
20159 OpenVMS Alpha. GNAT achieves a high level of compatibility
20160 with DEC Ada, and it should generally be straightforward to port code
20161 from the DEC Ada environment to GNAT. However, there are a few language
20162 and implementation differences of which the user must be aware. These
20163 differences are discussed in this section. In
20164 addition, the operating environment and command structure for the
20165 compiler are different, and these differences are also discussed.
20167 Note that this discussion addresses specifically the implementation
20168 of Ada 83 for DIGITAL OpenVMS Alpha Systems. In cases where the implementation
20169 of DEC Ada differs between OpenVMS Alpha Systems and OpenVMS VAX Systems,
20170 GNAT always follows the Alpha implementation.
20173 * Ada 95 Compatibility::
20174 * Differences in the Definition of Package System::
20175 * Language-Related Features::
20176 * The Package STANDARD::
20177 * The Package SYSTEM::
20178 * Tasking and Task-Related Features::
20179 * Implementation of Tasks in DEC Ada for OpenVMS Alpha Systems::
20180 * Pragmas and Pragma-Related Features::
20181 * Library of Predefined Units::
20183 * Main Program Definition::
20184 * Implementation-Defined Attributes::
20185 * Compiler and Run-Time Interfacing::
20186 * Program Compilation and Library Management::
20188 * Implementation Limits::
20192 @node Ada 95 Compatibility
20193 @section Ada 95 Compatibility
20196 GNAT is an Ada 95 compiler, and DEC Ada is an Ada 83
20197 compiler. Ada 95 is almost completely upwards compatible
20198 with Ada 83, and therefore Ada 83 programs will compile
20199 and run under GNAT with
20200 no changes or only minor changes. The Ada 95 Reference
20201 Manual (ANSI/ISO/IEC-8652:1995) provides details on specific
20204 GNAT provides the switch /83 on the GNAT COMPILE command,
20205 as well as the pragma ADA_83, to force the compiler to
20206 operate in Ada 83 mode. This mode does not guarantee complete
20207 conformance to Ada 83, but in practice is sufficient to
20208 eliminate most sources of incompatibilities.
20209 In particular, it eliminates the recognition of the
20210 additional Ada 95 keywords, so that their use as identifiers
20211 in Ada83 program is legal, and handles the cases of packages
20212 with optional bodies, and generics that instantiate unconstrained
20213 types without the use of @code{(<>)}.
20215 @node Differences in the Definition of Package System
20216 @section Differences in the Definition of Package System
20219 Both the Ada 95 and Ada 83 reference manuals permit a compiler to add
20220 implementation-dependent declarations to package System. In normal mode,
20221 GNAT does not take advantage of this permission, and the version of System
20222 provided by GNAT exactly matches that in the Ada 95 Reference Manual.
20224 However, DEC Ada adds an extensive set of declarations to package System,
20225 as fully documented in the DEC Ada manuals. To minimize changes required
20226 for programs that make use of these extensions, GNAT provides the pragma
20227 Extend_System for extending the definition of package System. By using:
20229 @smallexample @c ada
20232 pragma Extend_System (Aux_DEC);
20238 The set of definitions in System is extended to include those in package
20239 @code{System.Aux_DEC}.
20240 These definitions are incorporated directly into package
20241 System, as though they had been declared there in the first place. For a
20242 list of the declarations added, see the specification of this package,
20243 which can be found in the file @code{s-auxdec.ads} in the GNAT library.
20244 The pragma Extend_System is a configuration pragma, which means that
20245 it can be placed in the file @file{gnat.adc}, so that it will automatically
20246 apply to all subsequent compilations. See the section on Configuration
20247 Pragmas for further details.
20249 An alternative approach that avoids the use of the non-standard
20250 Extend_System pragma is to add a context clause to the unit that
20251 references these facilities:
20253 @smallexample @c ada
20256 with System.Aux_DEC;
20257 use System.Aux_DEC;
20263 The effect is not quite semantically identical to incorporating
20264 the declarations directly into package @code{System},
20265 but most programs will not notice a difference
20266 unless they use prefix notation (e.g. @code{System.Integer_8})
20268 entities directly in package @code{System}.
20269 For units containing such references,
20270 the prefixes must either be removed, or the pragma @code{Extend_System}
20273 @node Language-Related Features
20274 @section Language-Related Features
20277 The following sections highlight differences in types,
20278 representations of types, operations, alignment, and
20282 * Integer Types and Representations::
20283 * Floating-Point Types and Representations::
20284 * Pragmas Float_Representation and Long_Float::
20285 * Fixed-Point Types and Representations::
20286 * Record and Array Component Alignment::
20287 * Address Clauses::
20288 * Other Representation Clauses::
20291 @node Integer Types and Representations
20292 @subsection Integer Types and Representations
20295 The set of predefined integer types is identical in DEC Ada and GNAT.
20296 Furthermore the representation of these integer types is also identical,
20297 including the capability of size clauses forcing biased representation.
20300 DEC Ada for OpenVMS Alpha systems has defined the
20301 following additional integer types in package System:
20322 When using GNAT, the first four of these types may be obtained from the
20323 standard Ada 95 package @code{Interfaces}.
20324 Alternatively, by use of the pragma
20325 @code{Extend_System}, identical
20326 declarations can be referenced directly in package @code{System}.
20327 On both GNAT and DEC Ada, the maximum integer size is 64 bits.
20329 @node Floating-Point Types and Representations
20330 @subsection Floating-Point Types and Representations
20331 @cindex Floating-Point types
20334 The set of predefined floating-point types is identical in DEC Ada and GNAT.
20335 Furthermore the representation of these floating-point
20336 types is also identical. One important difference is that the default
20337 representation for DEC Ada is VAX_Float, but the default representation
20340 Specific types may be declared to be VAX_Float or IEEE, using the pragma
20341 @code{Float_Representation} as described in the DEC Ada documentation.
20342 For example, the declarations:
20344 @smallexample @c ada
20347 type F_Float is digits 6;
20348 pragma Float_Representation (VAX_Float, F_Float);
20354 declare a type F_Float that will be represented in VAX_Float format.
20355 This set of declarations actually appears in System.Aux_DEC, which provides
20356 the full set of additional floating-point declarations provided in
20357 the DEC Ada version of package
20358 System. This and similar declarations may be accessed in a user program
20359 by using pragma @code{Extend_System}. The use of this
20360 pragma, and the related pragma @code{Long_Float} is described in further
20361 detail in the following section.
20363 @node Pragmas Float_Representation and Long_Float
20364 @subsection Pragmas Float_Representation and Long_Float
20367 DEC Ada provides the pragma @code{Float_Representation}, which
20368 acts as a program library switch to allow control over
20369 the internal representation chosen for the predefined
20370 floating-point types declared in the package @code{Standard}.
20371 The format of this pragma is as follows:
20376 @b{pragma} @code{Float_Representation}(VAX_Float | IEEE_Float);
20382 This pragma controls the representation of floating-point
20387 @code{VAX_Float} specifies that floating-point
20388 types are represented by default with the VAX hardware types
20389 F-floating, D-floating, G-floating. Note that the H-floating
20390 type is available only on DIGITAL Vax systems, and is not available
20391 in either DEC Ada or GNAT for Alpha systems.
20394 @code{IEEE_Float} specifies that floating-point
20395 types are represented by default with the IEEE single and
20396 double floating-point types.
20400 GNAT provides an identical implementation of the pragma
20401 @code{Float_Representation}, except that it functions as a
20402 configuration pragma, as defined by Ada 95. Note that the
20403 notion of configuration pragma corresponds closely to the
20404 DEC Ada notion of a program library switch.
20406 When no pragma is used in GNAT, the default is IEEE_Float, which is different
20407 from DEC Ada 83, where the default is VAX_Float. In addition, the
20408 predefined libraries in GNAT are built using IEEE_Float, so it is not
20409 advisable to change the format of numbers passed to standard library
20410 routines, and if necessary explicit type conversions may be needed.
20412 The use of IEEE_Float is recommended in GNAT since it is more efficient,
20413 and (given that it conforms to an international standard) potentially more
20414 portable. The situation in which VAX_Float may be useful is in interfacing
20415 to existing code and data that expects the use of VAX_Float. There are
20416 two possibilities here. If the requirement for the use of VAX_Float is
20417 localized, then the best approach is to use the predefined VAX_Float
20418 types in package @code{System}, as extended by
20419 @code{Extend_System}. For example, use @code{System.F_Float}
20420 to specify the 32-bit @code{F-Float} format.
20422 Alternatively, if an entire program depends heavily on the use of
20423 the @code{VAX_Float} and in particular assumes that the types in
20424 package @code{Standard} are in @code{Vax_Float} format, then it
20425 may be desirable to reconfigure GNAT to assume Vax_Float by default.
20426 This is done by using the GNAT LIBRARY command to rebuild the library, and
20427 then using the general form of the @code{Float_Representation}
20428 pragma to ensure that this default format is used throughout.
20429 The form of the GNAT LIBRARY command is:
20432 GNAT LIBRARY /CONFIG=@i{file} /CREATE=@i{directory}
20436 where @i{file} contains the new configuration pragmas
20437 and @i{directory} is the directory to be created to contain
20441 On OpenVMS systems, DEC Ada provides the pragma @code{Long_Float}
20442 to allow control over the internal representation chosen
20443 for the predefined type @code{Long_Float} and for floating-point
20444 type declarations with digits specified in the range 7 .. 15.
20445 The format of this pragma is as follows:
20447 @smallexample @c ada
20449 pragma Long_Float (D_FLOAT | G_FLOAT);
20453 @node Fixed-Point Types and Representations
20454 @subsection Fixed-Point Types and Representations
20457 On DEC Ada for OpenVMS Alpha systems, rounding is
20458 away from zero for both positive and negative numbers.
20459 Therefore, +0.5 rounds to 1 and -0.5 rounds to -1.
20461 On GNAT for OpenVMS Alpha, the results of operations
20462 on fixed-point types are in accordance with the Ada 95
20463 rules. In particular, results of operations on decimal
20464 fixed-point types are truncated.
20466 @node Record and Array Component Alignment
20467 @subsection Record and Array Component Alignment
20470 On DEC Ada for OpenVMS Alpha, all non composite components
20471 are aligned on natural boundaries. For example, 1-byte
20472 components are aligned on byte boundaries, 2-byte
20473 components on 2-byte boundaries, 4-byte components on 4-byte
20474 byte boundaries, and so on. The OpenVMS Alpha hardware
20475 runs more efficiently with naturally aligned data.
20477 ON GNAT for OpenVMS Alpha, alignment rules are compatible
20478 with DEC Ada for OpenVMS Alpha.
20480 @node Address Clauses
20481 @subsection Address Clauses
20484 In DEC Ada and GNAT, address clauses are supported for
20485 objects and imported subprograms.
20486 The predefined type @code{System.Address} is a private type
20487 in both compilers, with the same representation (it is simply
20488 a machine pointer). Addition, subtraction, and comparison
20489 operations are available in the standard Ada 95 package
20490 @code{System.Storage_Elements}, or in package @code{System}
20491 if it is extended to include @code{System.Aux_DEC} using a
20492 pragma @code{Extend_System} as previously described.
20494 Note that code that with's both this extended package @code{System}
20495 and the package @code{System.Storage_Elements} should not @code{use}
20496 both packages, or ambiguities will result. In general it is better
20497 not to mix these two sets of facilities. The Ada 95 package was
20498 designed specifically to provide the kind of features that DEC Ada
20499 adds directly to package @code{System}.
20501 GNAT is compatible with DEC Ada in its handling of address
20502 clauses, except for some limitations in
20503 the form of address clauses for composite objects with
20504 initialization. Such address clauses are easily replaced
20505 by the use of an explicitly-defined constant as described
20506 in the Ada 95 Reference Manual (13.1(22)). For example, the sequence
20509 @smallexample @c ada
20511 X, Y : Integer := Init_Func;
20512 Q : String (X .. Y) := "abc";
20514 for Q'Address use Compute_Address;
20519 will be rejected by GNAT, since the address cannot be computed at the time
20520 that Q is declared. To achieve the intended effect, write instead:
20522 @smallexample @c ada
20525 X, Y : Integer := Init_Func;
20526 Q_Address : constant Address := Compute_Address;
20527 Q : String (X .. Y) := "abc";
20529 for Q'Address use Q_Address;
20535 which will be accepted by GNAT (and other Ada 95 compilers), and is also
20536 backwards compatible with Ada 83. A fuller description of the restrictions
20537 on address specifications is found in the GNAT Reference Manual.
20539 @node Other Representation Clauses
20540 @subsection Other Representation Clauses
20543 GNAT supports in a compatible manner all the representation
20544 clauses supported by DEC Ada. In addition, it
20545 supports representation clause forms that are new in Ada 95
20546 including COMPONENT_SIZE and SIZE clauses for objects.
20548 @node The Package STANDARD
20549 @section The Package STANDARD
20552 The package STANDARD, as implemented by DEC Ada, is fully
20553 described in the Reference Manual for the Ada Programming
20554 Language (ANSI/MIL-STD-1815A-1983) and in the DEC Ada
20555 Language Reference Manual. As implemented by GNAT, the
20556 package STANDARD is described in the Ada 95 Reference
20559 In addition, DEC Ada supports the Latin-1 character set in
20560 the type CHARACTER. GNAT supports the Latin-1 character set
20561 in the type CHARACTER and also Unicode (ISO 10646 BMP) in
20562 the type WIDE_CHARACTER.
20564 The floating-point types supported by GNAT are those
20565 supported by DEC Ada, but defaults are different, and are controlled by
20566 pragmas. See @ref{Floating-Point Types and Representations} for details.
20568 @node The Package SYSTEM
20569 @section The Package SYSTEM
20572 DEC Ada provides a system-specific version of the package
20573 SYSTEM for each platform on which the language ships.
20574 For the complete specification of the package SYSTEM, see
20575 Appendix F of the DEC Ada Language Reference Manual.
20577 On DEC Ada, the package SYSTEM includes the following conversion functions:
20579 @item TO_ADDRESS(INTEGER)
20581 @item TO_ADDRESS(UNSIGNED_LONGWORD)
20583 @item TO_ADDRESS(universal_integer)
20585 @item TO_INTEGER(ADDRESS)
20587 @item TO_UNSIGNED_LONGWORD(ADDRESS)
20589 @item Function IMPORT_VALUE return UNSIGNED_LONGWORD and the
20590 functions IMPORT_ADDRESS and IMPORT_LARGEST_VALUE
20594 By default, GNAT supplies a version of SYSTEM that matches
20595 the definition given in the Ada 95 Reference Manual.
20597 is a subset of the DIGITAL system definitions, which is as
20598 close as possible to the original definitions. The only difference
20599 is that the definition of SYSTEM_NAME is different:
20601 @smallexample @c ada
20604 type Name is (SYSTEM_NAME_GNAT);
20605 System_Name : constant Name := SYSTEM_NAME_GNAT;
20611 Also, GNAT adds the new Ada 95 declarations for
20612 BIT_ORDER and DEFAULT_BIT_ORDER.
20614 However, the use of the following pragma causes GNAT
20615 to extend the definition of package SYSTEM so that it
20616 encompasses the full set of DIGITAL-specific extensions,
20617 including the functions listed above:
20619 @smallexample @c ada
20621 pragma Extend_System (Aux_DEC);
20626 The pragma Extend_System is a configuration pragma that
20627 is most conveniently placed in the @file{gnat.adc} file. See the
20628 GNAT Reference Manual for further details.
20630 DEC Ada does not allow the recompilation of the package
20631 SYSTEM. Instead DEC Ada provides several pragmas (SYSTEM_
20632 NAME, STORAGE_UNIT, and MEMORY_SIZE) to modify values in
20633 the package SYSTEM. On OpenVMS Alpha systems, the pragma
20634 SYSTEM_NAME takes the enumeration literal OPENVMS_AXP as
20635 its single argument.
20637 GNAT does permit the recompilation of package SYSTEM using
20638 a special switch (@option{-gnatg}) and this switch can be used if
20639 it is necessary to modify the definitions in SYSTEM. GNAT does
20640 not permit the specification of SYSTEM_NAME, STORAGE_UNIT
20641 or MEMORY_SIZE by any other means.
20643 On GNAT systems, the pragma SYSTEM_NAME takes the
20644 enumeration literal SYSTEM_NAME_GNAT.
20646 The definitions provided by the use of
20648 @smallexample @c ada
20649 pragma Extend_System (AUX_Dec);
20653 are virtually identical to those provided by the DEC Ada 83 package
20654 System. One important difference is that the name of the TO_ADDRESS
20655 function for type UNSIGNED_LONGWORD is changed to TO_ADDRESS_LONG.
20656 See the GNAT Reference manual for a discussion of why this change was
20660 The version of TO_ADDRESS taking a universal integer argument is in fact
20661 an extension to Ada 83 not strictly compatible with the reference manual.
20662 In GNAT, we are constrained to be exactly compatible with the standard,
20663 and this means we cannot provide this capability. In DEC Ada 83, the
20664 point of this definition is to deal with a call like:
20666 @smallexample @c ada
20667 TO_ADDRESS (16#12777#);
20671 Normally, according to the Ada 83 standard, one would expect this to be
20672 ambiguous, since it matches both the INTEGER and UNSIGNED_LONGWORD forms
20673 of TO_ADDRESS. However, in DEC Ada 83, there is no ambiguity, since the
20674 definition using universal_integer takes precedence.
20676 In GNAT, since the version with universal_integer cannot be supplied, it is
20677 not possible to be 100% compatible. Since there are many programs using
20678 numeric constants for the argument to TO_ADDRESS, the decision in GNAT was
20679 to change the name of the function in the UNSIGNED_LONGWORD case, so the
20680 declarations provided in the GNAT version of AUX_Dec are:
20682 @smallexample @c ada
20683 function To_Address (X : Integer) return Address;
20684 pragma Pure_Function (To_Address);
20686 function To_Address_Long (X : Unsigned_Longword) return Address;
20687 pragma Pure_Function (To_Address_Long);
20691 This means that programs using TO_ADDRESS for UNSIGNED_LONGWORD must
20692 change the name to TO_ADDRESS_LONG.
20694 @node Tasking and Task-Related Features
20695 @section Tasking and Task-Related Features
20698 The concepts relevant to a comparison of tasking on GNAT
20699 and on DEC Ada for OpenVMS Alpha systems are discussed in
20700 the following sections.
20702 For detailed information on concepts related to tasking in
20703 DEC Ada, see the DEC Ada Language Reference Manual and the
20704 relevant run-time reference manual.
20706 @node Implementation of Tasks in DEC Ada for OpenVMS Alpha Systems
20707 @section Implementation of Tasks in DEC Ada for OpenVMS Alpha Systems
20710 On OpenVMS Alpha systems, each Ada task (except a passive
20711 task) is implemented as a single stream of execution
20712 that is created and managed by the kernel. On these
20713 systems, DEC Ada tasking support is based on DECthreads,
20714 an implementation of the POSIX standard for threads.
20716 Although tasks are implemented as threads, all tasks in
20717 an Ada program are part of the same process. As a result,
20718 resources such as open files and virtual memory can be
20719 shared easily among tasks. Having all tasks in one process
20720 allows better integration with the programming environment
20721 (the shell and the debugger, for example).
20723 Also, on OpenVMS Alpha systems, DEC Ada tasks and foreign
20724 code that calls DECthreads routines can be used together.
20725 The interaction between Ada tasks and DECthreads routines
20726 can have some benefits. For example when on OpenVMS Alpha,
20727 DEC Ada can call C code that is already threaded.
20728 GNAT on OpenVMS Alpha uses the facilities of DECthreads,
20729 and Ada tasks are mapped to threads.
20732 * Assigning Task IDs::
20733 * Task IDs and Delays::
20734 * Task-Related Pragmas::
20735 * Scheduling and Task Priority::
20737 * External Interrupts::
20740 @node Assigning Task IDs
20741 @subsection Assigning Task IDs
20744 The DEC Ada Run-Time Library always assigns %TASK 1 to
20745 the environment task that executes the main program. On
20746 OpenVMS Alpha systems, %TASK 0 is often used for tasks
20747 that have been created but are not yet activated.
20749 On OpenVMS Alpha systems, task IDs are assigned at
20750 activation. On GNAT systems, task IDs are also assigned at
20751 task creation but do not have the same form or values as
20752 task ID values in DEC Ada. There is no null task, and the
20753 environment task does not have a specific task ID value.
20755 @node Task IDs and Delays
20756 @subsection Task IDs and Delays
20759 On OpenVMS Alpha systems, tasking delays are implemented
20760 using Timer System Services. The Task ID is used for the
20761 identification of the timer request (the REQIDT parameter).
20762 If Timers are used in the application take care not to use
20763 0 for the identification, because cancelling such a timer
20764 will cancel all timers and may lead to unpredictable results.
20766 @node Task-Related Pragmas
20767 @subsection Task-Related Pragmas
20770 Ada supplies the pragma TASK_STORAGE, which allows
20771 specification of the size of the guard area for a task
20772 stack. (The guard area forms an area of memory that has no
20773 read or write access and thus helps in the detection of
20774 stack overflow.) On OpenVMS Alpha systems, if the pragma
20775 TASK_STORAGE specifies a value of zero, a minimal guard
20776 area is created. In the absence of a pragma TASK_STORAGE, a default guard
20779 GNAT supplies the following task-related pragmas:
20784 This pragma appears within a task definition and
20785 applies to the task in which it appears. The argument
20786 must be of type SYSTEM.TASK_INFO.TASK_INFO_TYPE.
20790 GNAT implements pragma TASK_STORAGE in the same way as
20792 Both DEC Ada and GNAT supply the pragmas PASSIVE,
20793 SUPPRESS, and VOLATILE.
20795 @node Scheduling and Task Priority
20796 @subsection Scheduling and Task Priority
20799 DEC Ada implements the Ada language requirement that
20800 when two tasks are eligible for execution and they have
20801 different priorities, the lower priority task does not
20802 execute while the higher priority task is waiting. The DEC
20803 Ada Run-Time Library keeps a task running until either the
20804 task is suspended or a higher priority task becomes ready.
20806 On OpenVMS Alpha systems, the default strategy is round-
20807 robin with preemption. Tasks of equal priority take turns
20808 at the processor. A task is run for a certain period of
20809 time and then placed at the rear of the ready queue for
20810 its priority level.
20812 DEC Ada provides the implementation-defined pragma TIME_SLICE,
20813 which can be used to enable or disable round-robin
20814 scheduling of tasks with the same priority.
20815 See the relevant DEC Ada run-time reference manual for
20816 information on using the pragmas to control DEC Ada task
20819 GNAT follows the scheduling rules of Annex D (real-time
20820 Annex) of the Ada 95 Reference Manual. In general, this
20821 scheduling strategy is fully compatible with DEC Ada
20822 although it provides some additional constraints (as
20823 fully documented in Annex D).
20824 GNAT implements time slicing control in a manner compatible with
20825 DEC Ada 83, by means of the pragma Time_Slice, whose semantics are identical
20826 to the DEC Ada 83 pragma of the same name.
20827 Note that it is not possible to mix GNAT tasking and
20828 DEC Ada 83 tasking in the same program, since the two run times are
20831 @node The Task Stack
20832 @subsection The Task Stack
20835 In DEC Ada, a task stack is allocated each time a
20836 non passive task is activated. As soon as the task is
20837 terminated, the storage for the task stack is deallocated.
20838 If you specify a size of zero (bytes) with T'STORAGE_SIZE,
20839 a default stack size is used. Also, regardless of the size
20840 specified, some additional space is allocated for task
20841 management purposes. On OpenVMS Alpha systems, at least
20842 one page is allocated.
20844 GNAT handles task stacks in a similar manner. According to
20845 the Ada 95 rules, it provides the pragma STORAGE_SIZE as
20846 an alternative method for controlling the task stack size.
20847 The specification of the attribute T'STORAGE_SIZE is also
20848 supported in a manner compatible with DEC Ada.
20850 @node External Interrupts
20851 @subsection External Interrupts
20854 On DEC Ada, external interrupts can be associated with task entries.
20855 GNAT is compatible with DEC Ada in its handling of external interrupts.
20857 @node Pragmas and Pragma-Related Features
20858 @section Pragmas and Pragma-Related Features
20861 Both DEC Ada and GNAT supply all language-defined pragmas
20862 as specified by the Ada 83 standard. GNAT also supplies all
20863 language-defined pragmas specified in the Ada 95 Reference Manual.
20864 In addition, GNAT implements the implementation-defined pragmas
20870 @item COMMON_OBJECT
20872 @item COMPONENT_ALIGNMENT
20874 @item EXPORT_EXCEPTION
20876 @item EXPORT_FUNCTION
20878 @item EXPORT_OBJECT
20880 @item EXPORT_PROCEDURE
20882 @item EXPORT_VALUED_PROCEDURE
20884 @item FLOAT_REPRESENTATION
20888 @item IMPORT_EXCEPTION
20890 @item IMPORT_FUNCTION
20892 @item IMPORT_OBJECT
20894 @item IMPORT_PROCEDURE
20896 @item IMPORT_VALUED_PROCEDURE
20898 @item INLINE_GENERIC
20900 @item INTERFACE_NAME
20910 @item SHARE_GENERIC
20922 These pragmas are all fully implemented, with the exception of @code{Title},
20923 @code{Passive}, and @code{Share_Generic}, which are
20924 recognized, but which have no
20925 effect in GNAT. The effect of @code{Passive} may be obtained by the
20926 use of protected objects in Ada 95. In GNAT, all generics are inlined.
20928 Unlike DEC Ada, the GNAT 'EXPORT_@i{subprogram}' pragmas require
20929 a separate subprogram specification which must appear before the
20932 GNAT also supplies a number of implementation-defined pragmas as follows:
20934 @item C_PASS_BY_COPY
20936 @item EXTEND_SYSTEM
20938 @item SOURCE_FILE_NAME
20958 @item CPP_CONSTRUCTOR
20960 @item CPP_DESTRUCTOR
20970 @item LINKER_SECTION
20972 @item MACHINE_ATTRIBUTE
20976 @item PURE_FUNCTION
20978 @item SOURCE_REFERENCE
20982 @item UNCHECKED_UNION
20984 @item UNIMPLEMENTED_UNIT
20986 @item UNIVERSAL_DATA
20988 @item WEAK_EXTERNAL
20992 For full details on these GNAT implementation-defined pragmas, see
20993 the GNAT Reference Manual.
20996 * Restrictions on the Pragma INLINE::
20997 * Restrictions on the Pragma INTERFACE::
20998 * Restrictions on the Pragma SYSTEM_NAME::
21001 @node Restrictions on the Pragma INLINE
21002 @subsection Restrictions on the Pragma INLINE
21005 DEC Ada applies the following restrictions to the pragma INLINE:
21007 @item Parameters cannot be a task type.
21009 @item Function results cannot be task types, unconstrained
21010 array types, or unconstrained types with discriminants.
21012 @item Bodies cannot declare the following:
21014 @item Subprogram body or stub (imported subprogram is allowed)
21018 @item Generic declarations
21020 @item Instantiations
21024 @item Access types (types derived from access types allowed)
21026 @item Array or record types
21028 @item Dependent tasks
21030 @item Direct recursive calls of subprogram or containing
21031 subprogram, directly or via a renaming
21037 In GNAT, the only restriction on pragma INLINE is that the
21038 body must occur before the call if both are in the same
21039 unit, and the size must be appropriately small. There are
21040 no other specific restrictions which cause subprograms to
21041 be incapable of being inlined.
21043 @node Restrictions on the Pragma INTERFACE
21044 @subsection Restrictions on the Pragma INTERFACE
21047 The following lists and describes the restrictions on the
21048 pragma INTERFACE on DEC Ada and GNAT:
21050 @item Languages accepted: Ada, Bliss, C, Fortran, Default.
21051 Default is the default on OpenVMS Alpha systems.
21053 @item Parameter passing: Language specifies default
21054 mechanisms but can be overridden with an EXPORT pragma.
21057 @item Ada: Use internal Ada rules.
21059 @item Bliss, C: Parameters must be mode @code{in}; cannot be
21060 record or task type. Result cannot be a string, an
21061 array, or a record.
21063 @item Fortran: Parameters cannot be a task. Result cannot
21064 be a string, an array, or a record.
21069 GNAT is entirely upwards compatible with DEC Ada, and in addition allows
21070 record parameters for all languages.
21072 @node Restrictions on the Pragma SYSTEM_NAME
21073 @subsection Restrictions on the Pragma SYSTEM_NAME
21076 For DEC Ada for OpenVMS Alpha, the enumeration literal
21077 for the type NAME is OPENVMS_AXP. In GNAT, the enumeration
21078 literal for the type NAME is SYSTEM_NAME_GNAT.
21080 @node Library of Predefined Units
21081 @section Library of Predefined Units
21084 A library of predefined units is provided as part of the
21085 DEC Ada and GNAT implementations. DEC Ada does not provide
21086 the package MACHINE_CODE but instead recommends importing
21089 The GNAT versions of the DEC Ada Run-Time Library (ADA$PREDEFINED:)
21090 units are taken from the OpenVMS Alpha version, not the OpenVMS VAX
21091 version. During GNAT installation, the DEC Ada Predefined
21092 Library units are copied into the GNU:[LIB.OPENVMS7_x.2_8_x.DECLIB]
21093 (aka DECLIB) directory and patched to remove Ada 95 incompatibilities
21094 and to make them interoperable with GNAT, @pxref{Changes to DECLIB}
21097 The GNAT RTL is contained in
21098 the GNU:[LIB.OPENVMS7_x.2_8_x.ADALIB] (aka ADALIB) directory and
21099 the default search path is set up to find DECLIB units in preference
21100 to ADALIB units with the same name (TEXT_IO, SEQUENTIAL_IO, and DIRECT_IO,
21103 However, it is possible to change the default so that the
21104 reverse is true, or even to mix them using child package
21105 notation. The DEC Ada 83 units are available as DEC.xxx where xxx
21106 is the package name, and the Ada units are available in the
21107 standard manner defined for Ada 95, that is to say as Ada.xxx. To
21108 change the default, set ADA_INCLUDE_PATH and ADA_OBJECTS_PATH
21109 appropriately. For example, to change the default to use the Ada95
21113 $ DEFINE ADA_INCLUDE_PATH GNU:[LIB.OPENVMS7_1.2_8_1.ADAINCLUDE],-
21114 GNU:[LIB.OPENVMS7_1.2_8_1.DECLIB]
21115 $ DEFINE ADA_OBJECTS_PATH GNU:[LIB.OPENVMS7_1.2_8_1.ADALIB],-
21116 GNU:[LIB.OPENVMS7_1.2_8_1.DECLIB]
21120 * Changes to DECLIB::
21123 @node Changes to DECLIB
21124 @subsection Changes to DECLIB
21127 The changes made to the DEC Ada predefined library for GNAT and Ada 95
21128 compatibility are minor and include the following:
21131 @item Adjusting the location of pragmas and record representation
21132 clauses to obey Ada 95 rules
21134 @item Adding the proper notation to generic formal parameters
21135 that take unconstrained types in instantiation
21137 @item Adding pragma ELABORATE_BODY to package specifications
21138 that have package bodies not otherwise allowed
21140 @item Occurrences of the identifier @code{"PROTECTED"} are renamed to
21142 Currently these are found only in the STARLET package spec.
21146 None of the above changes is visible to users.
21152 On OpenVMS Alpha, DEC Ada provides the following strongly-typed bindings:
21155 @item Command Language Interpreter (CLI interface)
21157 @item DECtalk Run-Time Library (DTK interface)
21159 @item Librarian utility routines (LBR interface)
21161 @item General Purpose Run-Time Library (LIB interface)
21163 @item Math Run-Time Library (MTH interface)
21165 @item National Character Set Run-Time Library (NCS interface)
21167 @item Compiled Code Support Run-Time Library (OTS interface)
21169 @item Parallel Processing Run-Time Library (PPL interface)
21171 @item Screen Management Run-Time Library (SMG interface)
21173 @item Sort Run-Time Library (SOR interface)
21175 @item String Run-Time Library (STR interface)
21177 @item STARLET System Library
21180 @item X Window System Version 11R4 and 11R5 (X, XLIB interface)
21182 @item X Windows Toolkit (XT interface)
21184 @item X/Motif Version 1.1.3 and 1.2 (XM interface)
21188 GNAT provides implementations of these DEC bindings in the DECLIB directory.
21190 The X/Motif bindings used to build DECLIB are whatever versions are in the
21191 DEC Ada @file{ADA$PREDEFINED} directory with extension @file{.ADC}.
21192 The build script will
21193 automatically add a pragma Linker_Options to packages @code{Xm}, @code{Xt},
21195 causing the default X/Motif sharable image libraries to be linked in. This
21196 is done via options files named @file{xm.opt}, @file{xt.opt}, and
21197 @file{x_lib.opt} (also located in the @file{DECLIB} directory).
21199 It may be necessary to edit these options files to update or correct the
21200 library names if, for example, the newer X/Motif bindings from
21201 @file{ADA$EXAMPLES}
21202 had been (previous to installing GNAT) copied and renamed to supersede the
21203 default @file{ADA$PREDEFINED} versions.
21206 * Shared Libraries and Options Files::
21207 * Interfaces to C::
21210 @node Shared Libraries and Options Files
21211 @subsection Shared Libraries and Options Files
21214 When using the DEC Ada
21215 predefined X and Motif bindings, the linking with their sharable images is
21216 done automatically by @command{GNAT LINK}.
21217 When using other X and Motif bindings, you need
21218 to add the corresponding sharable images to the command line for
21219 @code{GNAT LINK}. When linking with shared libraries, or with
21220 @file{.OPT} files, you must
21221 also add them to the command line for @command{GNAT LINK}.
21223 A shared library to be used with GNAT is built in the same way as other
21224 libraries under VMS. The VMS Link command can be used in standard fashion.
21226 @node Interfaces to C
21227 @subsection Interfaces to C
21231 provides the following Ada types and operations:
21234 @item C types package (C_TYPES)
21236 @item C strings (C_TYPES.NULL_TERMINATED)
21238 @item Other_types (SHORT_INT)
21242 Interfacing to C with GNAT, one can use the above approach
21243 described for DEC Ada or the facilities of Annex B of
21244 the Ada 95 Reference Manual (packages INTERFACES.C,
21245 INTERFACES.C.STRINGS and INTERFACES.C.POINTERS). For more
21246 information, see the section ``Interfacing to C'' in the
21247 @cite{GNAT Reference Manual}.
21249 The @option{-gnatF} qualifier forces default and explicit
21250 @code{External_Name} parameters in pragmas Import and Export
21251 to be uppercased for compatibility with the default behavior
21252 of Compaq C. The qualifier has no effect on @code{Link_Name} parameters.
21254 @node Main Program Definition
21255 @section Main Program Definition
21258 The following section discusses differences in the
21259 definition of main programs on DEC Ada and GNAT.
21260 On DEC Ada, main programs are defined to meet the
21261 following conditions:
21263 @item Procedure with no formal parameters (returns 0 upon
21266 @item Procedure with no formal parameters (returns 42 when
21267 unhandled exceptions are raised)
21269 @item Function with no formal parameters whose returned value
21270 is of a discrete type
21272 @item Procedure with one OUT formal of a discrete type for
21273 which a specification of pragma EXPORT_VALUED_PROCEDURE is given.
21278 When declared with the pragma EXPORT_VALUED_PROCEDURE,
21279 a main function or main procedure returns a discrete
21280 value whose size is less than 64 bits (32 on VAX systems),
21281 the value is zero- or sign-extended as appropriate.
21282 On GNAT, main programs are defined as follows:
21284 @item Must be a non-generic, parameter-less subprogram that
21285 is either a procedure or function returning an Ada
21286 STANDARD.INTEGER (the predefined type)
21288 @item Cannot be a generic subprogram or an instantiation of a
21292 @node Implementation-Defined Attributes
21293 @section Implementation-Defined Attributes
21296 GNAT provides all DEC Ada implementation-defined
21299 @node Compiler and Run-Time Interfacing
21300 @section Compiler and Run-Time Interfacing
21303 DEC Ada provides the following ways to pass options to the linker
21306 @item /WAIT and /SUBMIT qualifiers
21308 @item /COMMAND qualifier
21310 @item /[NO]MAP qualifier
21312 @item /OUTPUT=file-spec
21314 @item /[NO]DEBUG and /[NO]TRACEBACK qualifiers
21318 To pass options to the linker, GNAT provides the following
21322 @item @option{/EXECUTABLE=exec-name}
21324 @item @option{/VERBOSE qualifier}
21326 @item @option{/[NO]DEBUG} and @option{/[NO]TRACEBACK} qualifiers
21330 For more information on these switches, see
21331 @ref{Switches for gnatlink}.
21332 In DEC Ada, the command-line switch @option{/OPTIMIZE} is available
21333 to control optimization. DEC Ada also supplies the
21336 @item @code{OPTIMIZE}
21338 @item @code{INLINE}
21340 @item @code{INLINE_GENERIC}
21342 @item @code{SUPPRESS_ALL}
21344 @item @code{PASSIVE}
21348 In GNAT, optimization is controlled strictly by command
21349 line parameters, as described in the corresponding section of this guide.
21350 The DIGITAL pragmas for control of optimization are
21351 recognized but ignored.
21353 Note that in GNAT, the default is optimization off, whereas in DEC Ada 83,
21354 the default is that optimization is turned on.
21356 @node Program Compilation and Library Management
21357 @section Program Compilation and Library Management
21360 DEC Ada and GNAT provide a comparable set of commands to
21361 build programs. DEC Ada also provides a program library,
21362 which is a concept that does not exist on GNAT. Instead,
21363 GNAT provides directories of sources that are compiled as
21366 The following table summarizes
21367 the DEC Ada commands and provides
21368 equivalent GNAT commands. In this table, some GNAT
21369 equivalents reflect the fact that GNAT does not use the
21370 concept of a program library. Instead, it uses a model
21371 in which collections of source and object files are used
21372 in a manner consistent with other languages like C and
21373 Fortran. Therefore, standard system file commands are used
21374 to manipulate these elements. Those GNAT commands are marked with
21376 Note that, unlike DEC Ada, none of the GNAT commands accepts wild cards.
21379 @multitable @columnfractions .35 .65
21381 @item @emph{DEC Ada Command}
21382 @tab @emph{GNAT Equivalent / Description}
21384 @item @command{ADA}
21385 @tab @command{GNAT COMPILE}@*
21386 Invokes the compiler to compile one or more Ada source files.
21388 @item @command{ACS ATTACH}@*
21389 @tab [No equivalent]@*
21390 Switches control of terminal from current process running the program
21393 @item @command{ACS CHECK}
21394 @tab @command{GNAT MAKE /DEPENDENCY_LIST}@*
21395 Forms the execution closure of one
21396 or more compiled units and checks completeness and currency.
21398 @item @command{ACS COMPILE}
21399 @tab @command{GNAT MAKE /ACTIONS=COMPILE}@*
21400 Forms the execution closure of one or
21401 more specified units, checks completeness and currency,
21402 identifies units that have revised source files, compiles same,
21403 and recompiles units that are or will become obsolete.
21404 Also completes incomplete generic instantiations.
21406 @item @command{ACS COPY FOREIGN}
21408 Copies a foreign object file into the program library as a
21411 @item @command{ACS COPY UNIT}
21413 Copies a compiled unit from one program library to another.
21415 @item @command{ACS CREATE LIBRARY}
21416 @tab Create /directory (*)@*
21417 Creates a program library.
21419 @item @command{ACS CREATE SUBLIBRARY}
21420 @tab Create /directory (*)@*
21421 Creates a program sublibrary.
21423 @item @command{ACS DELETE LIBRARY}
21425 Deletes a program library and its contents.
21427 @item @command{ACS DELETE SUBLIBRARY}
21429 Deletes a program sublibrary and its contents.
21431 @item @command{ACS DELETE UNIT}
21432 @tab Delete file (*)@*
21433 On OpenVMS systems, deletes one or more compiled units from
21434 the current program library.
21436 @item @command{ACS DIRECTORY}
21437 @tab Directory (*)@*
21438 On OpenVMS systems, lists units contained in the current
21441 @item @command{ACS ENTER FOREIGN}
21443 Allows the import of a foreign body as an Ada library
21444 specification and enters a reference to a pointer.
21446 @item @command{ACS ENTER UNIT}
21448 Enters a reference (pointer) from the current program library to
21449 a unit compiled into another program library.
21451 @item @command{ACS EXIT}
21452 @tab [No equivalent]@*
21453 Exits from the program library manager.
21455 @item @command{ACS EXPORT}
21457 Creates an object file that contains system-specific object code
21458 for one or more units. With GNAT, object files can simply be copied
21459 into the desired directory.
21461 @item @command{ACS EXTRACT SOURCE}
21463 Allows access to the copied source file for each Ada compilation unit
21465 @item @command{ACS HELP}
21466 @tab @command{HELP GNAT}@*
21467 Provides online help.
21469 @item @command{ACS LINK}
21470 @tab @command{GNAT LINK}@*
21471 Links an object file containing Ada units into an executable file.
21473 @item @command{ACS LOAD}
21475 Loads (partially compiles) Ada units into the program library.
21476 Allows loading a program from a collection of files into a library
21477 without knowing the relationship among units.
21479 @item @command{ACS MERGE}
21481 Merges into the current program library, one or more units from
21482 another library where they were modified.
21484 @item @command{ACS RECOMPILE}
21485 @tab @command{GNAT MAKE /ACTIONS=COMPILE}@*
21486 Recompiles from external or copied source files any obsolete
21487 unit in the closure. Also, completes any incomplete generic
21490 @item @command{ACS REENTER}
21491 @tab @command{GNAT MAKE}@*
21492 Reenters current references to units compiled after last entered
21493 with the @command{ACS ENTER UNIT} command.
21495 @item @command{ACS SET LIBRARY}
21496 @tab Set default (*)@*
21497 Defines a program library to be the compilation context as well
21498 as the target library for compiler output and commands in general.
21500 @item @command{ACS SET PRAGMA}
21501 @tab Edit @file{gnat.adc} (*)@*
21502 Redefines specified values of the library characteristics
21503 @code{LONG_ FLOAT}, @code{MEMORY_SIZE}, @code{SYSTEM_NAME},
21504 and @code{Float_Representation}.
21506 @item @command{ACS SET SOURCE}
21507 @tab Define @code{ADA_INCLUDE_PATH} path (*)@*
21508 Defines the source file search list for the @command{ACS COMPILE} command.
21510 @item @command{ACS SHOW LIBRARY}
21511 @tab Directory (*)@*
21512 Lists information about one or more program libraries.
21514 @item @command{ACS SHOW PROGRAM}
21515 @tab [No equivalent]@*
21516 Lists information about the execution closure of one or
21517 more units in the program library.
21519 @item @command{ACS SHOW SOURCE}
21520 @tab Show logical @code{ADA_INCLUDE_PATH}@*
21521 Shows the source file search used when compiling units.
21523 @item @command{ACS SHOW VERSION}
21524 @tab Compile with @option{VERBOSE} option
21525 Displays the version number of the compiler and program library
21528 @item @command{ACS SPAWN}
21529 @tab [No equivalent]@*
21530 Creates a subprocess of the current process (same as @command{DCL SPAWN}
21533 @item @command{ACS VERIFY}
21534 @tab [No equivalent]@*
21535 Performs a series of consistency checks on a program library to
21536 determine whether the library structure and library files are in
21543 @section Input-Output
21546 On OpenVMS Alpha systems, DEC Ada uses OpenVMS Record
21547 Management Services (RMS) to perform operations on
21551 DEC Ada and GNAT predefine an identical set of input-
21552 output packages. To make the use of the
21553 generic TEXT_IO operations more convenient, DEC Ada
21554 provides predefined library packages that instantiate the
21555 integer and floating-point operations for the predefined
21556 integer and floating-point types as shown in the following table.
21558 @multitable @columnfractions .45 .55
21559 @item @emph{Package Name} @tab Instantiation
21561 @item @code{INTEGER_TEXT_IO}
21562 @tab @code{INTEGER_IO(INTEGER)}
21564 @item @code{SHORT_INTEGER_TEXT_IO}
21565 @tab @code{INTEGER_IO(SHORT_INTEGER)}
21567 @item @code{SHORT_SHORT_INTEGER_TEXT_IO}
21568 @tab @code{INTEGER_IO(SHORT_SHORT_INTEGER)}
21570 @item @code{FLOAT_TEXT_IO}
21571 @tab @code{FLOAT_IO(FLOAT)}
21573 @item @code{LONG_FLOAT_TEXT_IO}
21574 @tab @code{FLOAT_IO(LONG_FLOAT)}
21578 The DEC Ada predefined packages and their operations
21579 are implemented using OpenVMS Alpha files and input-
21580 output facilities. DEC Ada supports asynchronous input-
21581 output on OpenVMS Alpha. Familiarity with the following is
21584 @item RMS file organizations and access methods
21586 @item OpenVMS file specifications and directories
21588 @item OpenVMS File Definition Language (FDL)
21592 GNAT provides I/O facilities that are completely
21593 compatible with DEC Ada. The distribution includes the
21594 standard DEC Ada versions of all I/O packages, operating
21595 in a manner compatible with DEC Ada. In particular, the
21596 following packages are by default the DEC Ada (Ada 83)
21597 versions of these packages rather than the renamings
21598 suggested in annex J of the Ada 95 Reference Manual:
21600 @item @code{TEXT_IO}
21602 @item @code{SEQUENTIAL_IO}
21604 @item @code{DIRECT_IO}
21608 The use of the standard Ada 95 syntax for child packages (for
21609 example, @code{ADA.TEXT_IO}) retrieves the Ada 95 versions of these
21610 packages, as defined in the Ada 95 Reference Manual.
21611 GNAT provides DIGITAL-compatible predefined instantiations
21612 of the @code{TEXT_IO} packages, and also
21613 provides the standard predefined instantiations required
21614 by the Ada 95 Reference Manual.
21616 For further information on how GNAT interfaces to the file
21617 system or how I/O is implemented in programs written in
21618 mixed languages, see the chapter ``Implementation of the
21619 Standard I/O'' in the @cite{GNAT Reference Manual}.
21620 This chapter covers the following:
21622 @item Standard I/O packages
21624 @item @code{FORM} strings
21626 @item @code{ADA.DIRECT_IO}
21628 @item @code{ADA.SEQUENTIAL_IO}
21630 @item @code{ADA.TEXT_IO}
21632 @item Stream pointer positioning
21634 @item Reading and writing non-regular files
21636 @item @code{GET_IMMEDIATE}
21638 @item Treating @code{TEXT_IO} files as streams
21645 @node Implementation Limits
21646 @section Implementation Limits
21649 The following table lists implementation limits for DEC Ada
21651 @multitable @columnfractions .60 .20 .20
21653 @item @emph{Compilation Parameter}
21654 @tab @emph{DEC Ada}
21658 @item In a subprogram or entry declaration, maximum number of
21659 formal parameters that are of an unconstrained record type
21664 @item Maximum identifier length (number of characters)
21669 @item Maximum number of characters in a source line
21674 @item Maximum collection size (number of bytes)
21679 @item Maximum number of discriminants for a record type
21684 @item Maximum number of formal parameters in an entry or
21685 subprogram declaration
21690 @item Maximum number of dimensions in an array type
21695 @item Maximum number of library units and subunits in a compilation.
21700 @item Maximum number of library units and subunits in an execution.
21705 @item Maximum number of objects declared with the pragma @code{COMMON_OBJECT}
21706 or @code{PSECT_OBJECT}
21711 @item Maximum number of enumeration literals in an enumeration type
21717 @item Maximum number of lines in a source file
21722 @item Maximum number of bits in any object
21727 @item Maximum size of the static portion of a stack frame (approximate)
21737 @c **************************************
21738 @node Platform-Specific Information for the Run-Time Libraries
21739 @appendix Platform-Specific Information for the Run-Time Libraries
21740 @cindex Tasking and threads libraries
21741 @cindex Threads libraries and tasking
21742 @cindex Run-time libraries (platform-specific information)
21745 The GNAT run-time implementation may vary with respect to both the
21746 underlying threads library and the exception handling scheme.
21747 For threads support, one or more of the following are supplied:
21749 @item @b{native threads library}, a binding to the thread package from
21750 the underlying operating system
21752 @item @b{pthreads library} (Sparc Solaris only), a binding to the Solaris
21753 POSIX thread package
21757 For exception handling, either or both of two models are supplied:
21759 @item @b{Zero-Cost Exceptions} (``ZCX''),@footnote{
21760 Most programs should experience a substantial speed improvement by
21761 being compiled with a ZCX run-time.
21762 This is especially true for
21763 tasking applications or applications with many exception handlers.}
21764 @cindex Zero-Cost Exceptions
21765 @cindex ZCX (Zero-Cost Exceptions)
21766 which uses binder-generated tables that
21767 are interrogated at run time to locate a handler
21769 @item @b{setjmp / longjmp} (``SJLJ''),
21770 @cindex setjmp/longjmp Exception Model
21771 @cindex SJLJ (setjmp/longjmp Exception Model)
21772 which uses dynamically-set data to establish
21773 the set of handlers
21777 This appendix summarizes which combinations of threads and exception support
21778 are supplied on various GNAT platforms.
21779 It then shows how to select a particular library either
21780 permanently or temporarily,
21781 explains the properties of (and tradeoffs among) the various threads
21782 libraries, and provides some additional
21783 information about several specific platforms.
21786 * Summary of Run-Time Configurations::
21787 * Specifying a Run-Time Library::
21788 * Choosing the Scheduling Policy::
21789 * Solaris-Specific Considerations::
21790 * IRIX-Specific Considerations::
21791 * Linux-Specific Considerations::
21792 * AIX-Specific Considerations::
21795 @node Summary of Run-Time Configurations
21796 @section Summary of Run-Time Configurations
21798 @multitable @columnfractions .30 .70
21799 @item @b{alpha-openvms}
21800 @item @code{@ @ }@i{rts-native (default)}
21801 @item @code{@ @ @ @ }Tasking @tab native VMS threads
21802 @item @code{@ @ @ @ }Exceptions @tab ZCX
21805 @item @code{@ @ }@i{rts-native (default)}
21806 @item @code{@ @ @ @ }Tasking @tab native HP threads library
21807 @item @code{@ @ @ @ }Exceptions @tab ZCX
21809 @item @code{@ @ }@i{rts-sjlj}
21810 @item @code{@ @ @ @ }Tasking @tab native HP threads library
21811 @item @code{@ @ @ @ }Exceptions @tab SJLJ
21813 @item @b{sparc-solaris} @tab
21814 @item @code{@ @ }@i{rts-native (default)}
21815 @item @code{@ @ @ @ }Tasking @tab native Solaris threads library
21816 @item @code{@ @ @ @ }Exceptions @tab ZCX
21818 @item @code{@ @ }@i{rts-m64}
21819 @item @code{@ @ @ @ }Tasking @tab native Solaris threads library
21820 @item @code{@ @ @ @ }Exceptions @tab ZCX
21821 @item @code{@ @ @ @ }Constraints @tab Use only when compiling in 64-bit mode;
21822 @item @tab Use only on Solaris 8 or later.
21823 @item @tab @xref{Building and Debugging 64-bit Applications}, for details.
21825 @item @code{@ @ }@i{rts-pthread}
21826 @item @code{@ @ @ @ }Tasking @tab pthreads library
21827 @item @code{@ @ @ @ }Exceptions @tab ZCX
21829 @item @code{@ @ }@i{rts-sjlj}
21830 @item @code{@ @ @ @ }Tasking @tab native Solaris threads library
21831 @item @code{@ @ @ @ }Exceptions @tab SJLJ
21833 @item @b{x86-linux}
21834 @item @code{@ @ }@i{rts-native (default)}
21835 @item @code{@ @ @ @ }Tasking @tab pthread library
21836 @item @code{@ @ @ @ }Exceptions @tab ZCX
21838 @item @code{@ @ }@i{rts-sjlj}
21839 @item @code{@ @ @ @ }Tasking @tab pthread library
21840 @item @code{@ @ @ @ }Exceptions @tab SJLJ
21842 @item @b{x86-windows}
21843 @item @code{@ @ }@i{rts-native (default)}
21844 @item @code{@ @ @ @ }Tasking @tab native Win32 threads
21845 @item @code{@ @ @ @ }Exceptions @tab SJLJ
21849 @node Specifying a Run-Time Library
21850 @section Specifying a Run-Time Library
21853 The @file{adainclude} subdirectory containing the sources of the GNAT
21854 run-time library, and the @file{adalib} subdirectory containing the
21855 @file{ALI} files and the static and/or shared GNAT library, are located
21856 in the gcc target-dependent area:
21859 target=$prefix/lib/gcc-lib/gcc-@i{dumpmachine}/gcc-@i{dumpversion}/
21863 As indicated above, on some platforms several run-time libraries are supplied.
21864 These libraries are installed in the target dependent area and
21865 contain a complete source and binary subdirectory. The detailed description
21866 below explains the differences between the different libraries in terms of
21867 their thread support.
21869 The default run-time library (when GNAT is installed) is @emph{rts-native}.
21870 This default run time is selected by the means of soft links.
21871 For example on x86-linux:
21877 +--- adainclude----------+
21879 +--- adalib-----------+ |
21881 +--- rts-native | |
21883 | +--- adainclude <---+
21885 | +--- adalib <----+
21896 If the @i{rts-sjlj} library is to be selected on a permanent basis,
21897 these soft links can be modified with the following commands:
21901 $ rm -f adainclude adalib
21902 $ ln -s rts-sjlj/adainclude adainclude
21903 $ ln -s rts-sjlj/adalib adalib
21907 Alternatively, you can specify @file{rts-sjlj/adainclude} in the file
21908 @file{$target/ada_source_path} and @file{rts-sjlj/adalib} in
21909 @file{$target/ada_object_path}.
21911 Selecting another run-time library temporarily can be
21912 achieved by the regular mechanism for GNAT object or source path selection:
21916 Set the environment variables:
21919 $ ADA_INCLUDE_PATH=$target/rts-sjlj/adainclude:$ADA_INCLUDE_PATH
21920 $ ADA_OBJECTS_PATH=$target/rts-sjlj/adalib:$ADA_OBJECTS_PATH
21921 $ export ADA_INCLUDE_PATH ADA_OBJECTS_PATH
21925 Use @option{-aI$target/rts-sjlj/adainclude}
21926 and @option{-aO$target/rts-sjlj/adalib}
21927 on the @command{gnatmake} command line
21930 Use the switch @option{--RTS}; e.g., @option{--RTS=sjlj}
21931 @cindex @option{--RTS} option
21934 @node Choosing the Scheduling Policy
21935 @section Choosing the Scheduling Policy
21938 When using a POSIX threads implementation, you have a choice of several
21939 scheduling policies: @code{SCHED_FIFO},
21940 @cindex @code{SCHED_FIFO} scheduling policy
21942 @cindex @code{SCHED_RR} scheduling policy
21943 and @code{SCHED_OTHER}.
21944 @cindex @code{SCHED_OTHER} scheduling policy
21945 Typically, the default is @code{SCHED_OTHER}, while using @code{SCHED_FIFO}
21946 or @code{SCHED_RR} requires special (e.g., root) privileges.
21948 By default, GNAT uses the @code{SCHED_OTHER} policy. To specify
21950 @cindex @code{SCHED_FIFO} scheduling policy
21951 you can use one of the following:
21955 @code{pragma Time_Slice (0.0)}
21956 @cindex pragma Time_Slice
21958 the corresponding binder option @option{-T0}
21959 @cindex @option{-T0} option
21961 @code{pragma Task_Dispatching_Policy (FIFO_Within_Priorities)}
21962 @cindex pragma Task_Dispatching_Policy
21966 To specify @code{SCHED_RR},
21967 @cindex @code{SCHED_RR} scheduling policy
21968 you should use @code{pragma Time_Slice} with a
21969 value greater than @code{0.0}, or else use the corresponding @option{-T}
21972 @node Solaris-Specific Considerations
21973 @section Solaris-Specific Considerations
21974 @cindex Solaris Sparc threads libraries
21977 This section addresses some topics related to the various threads libraries
21978 on Sparc Solaris and then provides some information on building and
21979 debugging 64-bit applications.
21982 * Solaris Threads Issues::
21983 * Building and Debugging 64-bit Applications::
21986 @node Solaris Threads Issues
21987 @subsection Solaris Threads Issues
21990 GNAT under Solaris comes with an alternate tasking run-time library
21991 based on POSIX threads --- @emph{rts-pthread}.
21992 @cindex rts-pthread threads library
21993 This run-time library has the advantage of being mostly shared across all
21994 POSIX-compliant thread implementations, and it also provides under
21995 @w{Solaris 8} the @code{PTHREAD_PRIO_INHERIT}
21996 @cindex @code{PTHREAD_PRIO_INHERIT} policy (under rts-pthread)
21997 and @code{PTHREAD_PRIO_PROTECT}
21998 @cindex @code{PTHREAD_PRIO_PROTECT} policy (under rts-pthread)
21999 semantics that can be selected using the predefined pragma
22000 @code{Locking_Policy}
22001 @cindex pragma Locking_Policy (under rts-pthread)
22003 @code{Inheritance_Locking} and @code{Ceiling_Locking} as the policy.
22004 @cindex @code{Inheritance_Locking} (under rts-pthread)
22005 @cindex @code{Ceiling_Locking} (under rts-pthread)
22007 As explained above, the native run-time library is based on the Solaris thread
22008 library (@code{libthread}) and is the default library.
22010 When the Solaris threads library is used (this is the default), programs
22011 compiled with GNAT can automatically take advantage of
22012 and can thus execute on multiple processors.
22013 The user can alternatively specify a processor on which the program should run
22014 to emulate a single-processor system. The multiprocessor / uniprocessor choice
22016 setting the environment variable @code{GNAT_PROCESSOR}
22017 @cindex @code{GNAT_PROCESSOR} environment variable (on Sparc Solaris)
22018 to one of the following:
22022 Use the default configuration (run the program on all
22023 available processors) - this is the same as having
22024 @code{GNAT_PROCESSOR} unset
22027 Let the run-time implementation choose one processor and run the program on
22030 @item 0 .. Last_Proc
22031 Run the program on the specified processor.
22032 @code{Last_Proc} is equal to @code{_SC_NPROCESSORS_CONF - 1}
22033 (where @code{_SC_NPROCESSORS_CONF} is a system variable).
22036 @node Building and Debugging 64-bit Applications
22037 @subsection Building and Debugging 64-bit Applications
22040 In a 64-bit application, all the sources involved must be compiled with the
22041 @option{-m64} command-line option, and a specific GNAT library (compiled with
22042 this option) is required.
22043 The easiest way to build a 64bit application is to add
22044 @option{-m64 --RTS=m64} to the @command{gnatmake} flags.
22046 To debug these applications, a special version of gdb called @command{gdb64}
22049 To summarize, building and debugging a ``Hello World'' program in 64-bit mode
22053 $ gnatmake -m64 -g --RTS=m64 hello.adb
22057 In addition, the following capabilities are not supported when using the
22058 @option{-m64} option:
22061 @item -fstack-check does not work together with -m64.
22062 Any application combining these options crashes at startup time.
22064 @item Call-chain backtrace computation does not work with -m64.
22065 Thus the gnatbind switch -E is not supported.
22068 @node IRIX-Specific Considerations
22069 @section IRIX-Specific Considerations
22070 @cindex IRIX thread library
22073 On SGI IRIX, the thread library depends on which compiler is used.
22074 The @emph{o32 ABI} compiler comes with a run-time library based on the
22075 user-level @code{athread}
22076 library. Thus kernel-level capabilities such as nonblocking system
22077 calls or time slicing can only be achieved reliably by specifying different
22078 @code{sprocs} via the pragma @code{Task_Info}
22079 @cindex pragma Task_Info (and IRIX threads)
22081 @code{System.Task_Info} package.
22082 @cindex @code{System.Task_Info} package (and IRIX threads)
22083 See the @cite{GNAT Reference Manual} for further information.
22085 The @emph{n32 ABI} compiler comes with a run-time library based on the
22086 kernel POSIX threads and thus does not have the limitations mentioned above.
22088 @node Linux-Specific Considerations
22089 @section Linux-Specific Considerations
22090 @cindex Linux threads libraries
22093 The default thread library under GNU/Linux has the following disadvantages
22094 compared to other native thread libraries:
22097 @item The size of the task's stack is limited to 2 megabytes.
22098 @item The signal model is not POSIX compliant, which means that to send a
22099 signal to the process, you need to send the signal to all threads,
22100 e.g. by using @code{killpg()}.
22103 @node AIX-Specific Considerations
22104 @section AIX-Specific Considerations
22105 @cindex AIX resolver library
22108 On AIX, the resolver library initializes some internal structure on
22109 the first call to @code{get*by*} functions, which are used to implement
22110 @code{GNAT.Sockets.Get_Host_By_Name} and
22111 @code{GNAT.Sockets.Get_Host_By_Addrss}.
22112 If such initialization occurs within an Ada task, and the stack size for
22113 the task is the default size, a stack overflow may occur.
22115 To avoid this overflow, the user should either ensure that the first call
22116 to @code{GNAT.Sockets.Get_Host_By_Name} or
22117 @code{GNAT.Sockets.Get_Host_By_Addrss}
22118 occurs in the environment task, or use @code{pragma Storage_Size} to
22119 specify a sufficiently large size for the stack of the task that contains
22122 @c *******************************
22123 @node Example of Binder Output File
22124 @appendix Example of Binder Output File
22127 This Appendix displays the source code for @command{gnatbind}'s output
22128 file generated for a simple ``Hello World'' program.
22129 Comments have been added for clarification purposes.
22131 @smallexample @c adanocomment
22135 -- The package is called Ada_Main unless this name is actually used
22136 -- as a unit name in the partition, in which case some other unique
22140 package ada_main is
22142 Elab_Final_Code : Integer;
22143 pragma Import (C, Elab_Final_Code, "__gnat_inside_elab_final_code");
22145 -- The main program saves the parameters (argument count,
22146 -- argument values, environment pointer) in global variables
22147 -- for later access by other units including
22148 -- Ada.Command_Line.
22150 gnat_argc : Integer;
22151 gnat_argv : System.Address;
22152 gnat_envp : System.Address;
22154 -- The actual variables are stored in a library routine. This
22155 -- is useful for some shared library situations, where there
22156 -- are problems if variables are not in the library.
22158 pragma Import (C, gnat_argc);
22159 pragma Import (C, gnat_argv);
22160 pragma Import (C, gnat_envp);
22162 -- The exit status is similarly an external location
22164 gnat_exit_status : Integer;
22165 pragma Import (C, gnat_exit_status);
22167 GNAT_Version : constant String :=
22168 "GNAT Version: 3.15w (20010315)";
22169 pragma Export (C, GNAT_Version, "__gnat_version");
22171 -- This is the generated adafinal routine that performs
22172 -- finalization at the end of execution. In the case where
22173 -- Ada is the main program, this main program makes a call
22174 -- to adafinal at program termination.
22176 procedure adafinal;
22177 pragma Export (C, adafinal, "adafinal");
22179 -- This is the generated adainit routine that performs
22180 -- initialization at the start of execution. In the case
22181 -- where Ada is the main program, this main program makes
22182 -- a call to adainit at program startup.
22185 pragma Export (C, adainit, "adainit");
22187 -- This routine is called at the start of execution. It is
22188 -- a dummy routine that is used by the debugger to breakpoint
22189 -- at the start of execution.
22191 procedure Break_Start;
22192 pragma Import (C, Break_Start, "__gnat_break_start");
22194 -- This is the actual generated main program (it would be
22195 -- suppressed if the no main program switch were used). As
22196 -- required by standard system conventions, this program has
22197 -- the external name main.
22201 argv : System.Address;
22202 envp : System.Address)
22204 pragma Export (C, main, "main");
22206 -- The following set of constants give the version
22207 -- identification values for every unit in the bound
22208 -- partition. This identification is computed from all
22209 -- dependent semantic units, and corresponds to the
22210 -- string that would be returned by use of the
22211 -- Body_Version or Version attributes.
22213 type Version_32 is mod 2 ** 32;
22214 u00001 : constant Version_32 := 16#7880BEB3#;
22215 u00002 : constant Version_32 := 16#0D24CBD0#;
22216 u00003 : constant Version_32 := 16#3283DBEB#;
22217 u00004 : constant Version_32 := 16#2359F9ED#;
22218 u00005 : constant Version_32 := 16#664FB847#;
22219 u00006 : constant Version_32 := 16#68E803DF#;
22220 u00007 : constant Version_32 := 16#5572E604#;
22221 u00008 : constant Version_32 := 16#46B173D8#;
22222 u00009 : constant Version_32 := 16#156A40CF#;
22223 u00010 : constant Version_32 := 16#033DABE0#;
22224 u00011 : constant Version_32 := 16#6AB38FEA#;
22225 u00012 : constant Version_32 := 16#22B6217D#;
22226 u00013 : constant Version_32 := 16#68A22947#;
22227 u00014 : constant Version_32 := 16#18CC4A56#;
22228 u00015 : constant Version_32 := 16#08258E1B#;
22229 u00016 : constant Version_32 := 16#367D5222#;
22230 u00017 : constant Version_32 := 16#20C9ECA4#;
22231 u00018 : constant Version_32 := 16#50D32CB6#;
22232 u00019 : constant Version_32 := 16#39A8BB77#;
22233 u00020 : constant Version_32 := 16#5CF8FA2B#;
22234 u00021 : constant Version_32 := 16#2F1EB794#;
22235 u00022 : constant Version_32 := 16#31AB6444#;
22236 u00023 : constant Version_32 := 16#1574B6E9#;
22237 u00024 : constant Version_32 := 16#5109C189#;
22238 u00025 : constant Version_32 := 16#56D770CD#;
22239 u00026 : constant Version_32 := 16#02F9DE3D#;
22240 u00027 : constant Version_32 := 16#08AB6B2C#;
22241 u00028 : constant Version_32 := 16#3FA37670#;
22242 u00029 : constant Version_32 := 16#476457A0#;
22243 u00030 : constant Version_32 := 16#731E1B6E#;
22244 u00031 : constant Version_32 := 16#23C2E789#;
22245 u00032 : constant Version_32 := 16#0F1BD6A1#;
22246 u00033 : constant Version_32 := 16#7C25DE96#;
22247 u00034 : constant Version_32 := 16#39ADFFA2#;
22248 u00035 : constant Version_32 := 16#571DE3E7#;
22249 u00036 : constant Version_32 := 16#5EB646AB#;
22250 u00037 : constant Version_32 := 16#4249379B#;
22251 u00038 : constant Version_32 := 16#0357E00A#;
22252 u00039 : constant Version_32 := 16#3784FB72#;
22253 u00040 : constant Version_32 := 16#2E723019#;
22254 u00041 : constant Version_32 := 16#623358EA#;
22255 u00042 : constant Version_32 := 16#107F9465#;
22256 u00043 : constant Version_32 := 16#6843F68A#;
22257 u00044 : constant Version_32 := 16#63305874#;
22258 u00045 : constant Version_32 := 16#31E56CE1#;
22259 u00046 : constant Version_32 := 16#02917970#;
22260 u00047 : constant Version_32 := 16#6CCBA70E#;
22261 u00048 : constant Version_32 := 16#41CD4204#;
22262 u00049 : constant Version_32 := 16#572E3F58#;
22263 u00050 : constant Version_32 := 16#20729FF5#;
22264 u00051 : constant Version_32 := 16#1D4F93E8#;
22265 u00052 : constant Version_32 := 16#30B2EC3D#;
22266 u00053 : constant Version_32 := 16#34054F96#;
22267 u00054 : constant Version_32 := 16#5A199860#;
22268 u00055 : constant Version_32 := 16#0E7F912B#;
22269 u00056 : constant Version_32 := 16#5760634A#;
22270 u00057 : constant Version_32 := 16#5D851835#;
22272 -- The following Export pragmas export the version numbers
22273 -- with symbolic names ending in B (for body) or S
22274 -- (for spec) so that they can be located in a link. The
22275 -- information provided here is sufficient to track down
22276 -- the exact versions of units used in a given build.
22278 pragma Export (C, u00001, "helloB");
22279 pragma Export (C, u00002, "system__standard_libraryB");
22280 pragma Export (C, u00003, "system__standard_libraryS");
22281 pragma Export (C, u00004, "adaS");
22282 pragma Export (C, u00005, "ada__text_ioB");
22283 pragma Export (C, u00006, "ada__text_ioS");
22284 pragma Export (C, u00007, "ada__exceptionsB");
22285 pragma Export (C, u00008, "ada__exceptionsS");
22286 pragma Export (C, u00009, "gnatS");
22287 pragma Export (C, u00010, "gnat__heap_sort_aB");
22288 pragma Export (C, u00011, "gnat__heap_sort_aS");
22289 pragma Export (C, u00012, "systemS");
22290 pragma Export (C, u00013, "system__exception_tableB");
22291 pragma Export (C, u00014, "system__exception_tableS");
22292 pragma Export (C, u00015, "gnat__htableB");
22293 pragma Export (C, u00016, "gnat__htableS");
22294 pragma Export (C, u00017, "system__exceptionsS");
22295 pragma Export (C, u00018, "system__machine_state_operationsB");
22296 pragma Export (C, u00019, "system__machine_state_operationsS");
22297 pragma Export (C, u00020, "system__machine_codeS");
22298 pragma Export (C, u00021, "system__storage_elementsB");
22299 pragma Export (C, u00022, "system__storage_elementsS");
22300 pragma Export (C, u00023, "system__secondary_stackB");
22301 pragma Export (C, u00024, "system__secondary_stackS");
22302 pragma Export (C, u00025, "system__parametersB");
22303 pragma Export (C, u00026, "system__parametersS");
22304 pragma Export (C, u00027, "system__soft_linksB");
22305 pragma Export (C, u00028, "system__soft_linksS");
22306 pragma Export (C, u00029, "system__stack_checkingB");
22307 pragma Export (C, u00030, "system__stack_checkingS");
22308 pragma Export (C, u00031, "system__tracebackB");
22309 pragma Export (C, u00032, "system__tracebackS");
22310 pragma Export (C, u00033, "ada__streamsS");
22311 pragma Export (C, u00034, "ada__tagsB");
22312 pragma Export (C, u00035, "ada__tagsS");
22313 pragma Export (C, u00036, "system__string_opsB");
22314 pragma Export (C, u00037, "system__string_opsS");
22315 pragma Export (C, u00038, "interfacesS");
22316 pragma Export (C, u00039, "interfaces__c_streamsB");
22317 pragma Export (C, u00040, "interfaces__c_streamsS");
22318 pragma Export (C, u00041, "system__file_ioB");
22319 pragma Export (C, u00042, "system__file_ioS");
22320 pragma Export (C, u00043, "ada__finalizationB");
22321 pragma Export (C, u00044, "ada__finalizationS");
22322 pragma Export (C, u00045, "system__finalization_rootB");
22323 pragma Export (C, u00046, "system__finalization_rootS");
22324 pragma Export (C, u00047, "system__finalization_implementationB");
22325 pragma Export (C, u00048, "system__finalization_implementationS");
22326 pragma Export (C, u00049, "system__string_ops_concat_3B");
22327 pragma Export (C, u00050, "system__string_ops_concat_3S");
22328 pragma Export (C, u00051, "system__stream_attributesB");
22329 pragma Export (C, u00052, "system__stream_attributesS");
22330 pragma Export (C, u00053, "ada__io_exceptionsS");
22331 pragma Export (C, u00054, "system__unsigned_typesS");
22332 pragma Export (C, u00055, "system__file_control_blockS");
22333 pragma Export (C, u00056, "ada__finalization__list_controllerB");
22334 pragma Export (C, u00057, "ada__finalization__list_controllerS");
22336 -- BEGIN ELABORATION ORDER
22339 -- gnat.heap_sort_a (spec)
22340 -- gnat.heap_sort_a (body)
22341 -- gnat.htable (spec)
22342 -- gnat.htable (body)
22343 -- interfaces (spec)
22345 -- system.machine_code (spec)
22346 -- system.parameters (spec)
22347 -- system.parameters (body)
22348 -- interfaces.c_streams (spec)
22349 -- interfaces.c_streams (body)
22350 -- system.standard_library (spec)
22351 -- ada.exceptions (spec)
22352 -- system.exception_table (spec)
22353 -- system.exception_table (body)
22354 -- ada.io_exceptions (spec)
22355 -- system.exceptions (spec)
22356 -- system.storage_elements (spec)
22357 -- system.storage_elements (body)
22358 -- system.machine_state_operations (spec)
22359 -- system.machine_state_operations (body)
22360 -- system.secondary_stack (spec)
22361 -- system.stack_checking (spec)
22362 -- system.soft_links (spec)
22363 -- system.soft_links (body)
22364 -- system.stack_checking (body)
22365 -- system.secondary_stack (body)
22366 -- system.standard_library (body)
22367 -- system.string_ops (spec)
22368 -- system.string_ops (body)
22371 -- ada.streams (spec)
22372 -- system.finalization_root (spec)
22373 -- system.finalization_root (body)
22374 -- system.string_ops_concat_3 (spec)
22375 -- system.string_ops_concat_3 (body)
22376 -- system.traceback (spec)
22377 -- system.traceback (body)
22378 -- ada.exceptions (body)
22379 -- system.unsigned_types (spec)
22380 -- system.stream_attributes (spec)
22381 -- system.stream_attributes (body)
22382 -- system.finalization_implementation (spec)
22383 -- system.finalization_implementation (body)
22384 -- ada.finalization (spec)
22385 -- ada.finalization (body)
22386 -- ada.finalization.list_controller (spec)
22387 -- ada.finalization.list_controller (body)
22388 -- system.file_control_block (spec)
22389 -- system.file_io (spec)
22390 -- system.file_io (body)
22391 -- ada.text_io (spec)
22392 -- ada.text_io (body)
22394 -- END ELABORATION ORDER
22398 -- The following source file name pragmas allow the generated file
22399 -- names to be unique for different main programs. They are needed
22400 -- since the package name will always be Ada_Main.
22402 pragma Source_File_Name (ada_main, Spec_File_Name => "b~hello.ads");
22403 pragma Source_File_Name (ada_main, Body_File_Name => "b~hello.adb");
22405 -- Generated package body for Ada_Main starts here
22407 package body ada_main is
22409 -- The actual finalization is performed by calling the
22410 -- library routine in System.Standard_Library.Adafinal
22412 procedure Do_Finalize;
22413 pragma Import (C, Do_Finalize, "system__standard_library__adafinal");
22420 procedure adainit is
22422 -- These booleans are set to True once the associated unit has
22423 -- been elaborated. It is also used to avoid elaborating the
22424 -- same unit twice.
22427 pragma Import (Ada, E040, "interfaces__c_streams_E");
22430 pragma Import (Ada, E008, "ada__exceptions_E");
22433 pragma Import (Ada, E014, "system__exception_table_E");
22436 pragma Import (Ada, E053, "ada__io_exceptions_E");
22439 pragma Import (Ada, E017, "system__exceptions_E");
22442 pragma Import (Ada, E024, "system__secondary_stack_E");
22445 pragma Import (Ada, E030, "system__stack_checking_E");
22448 pragma Import (Ada, E028, "system__soft_links_E");
22451 pragma Import (Ada, E035, "ada__tags_E");
22454 pragma Import (Ada, E033, "ada__streams_E");
22457 pragma Import (Ada, E046, "system__finalization_root_E");
22460 pragma Import (Ada, E048, "system__finalization_implementation_E");
22463 pragma Import (Ada, E044, "ada__finalization_E");
22466 pragma Import (Ada, E057, "ada__finalization__list_controller_E");
22469 pragma Import (Ada, E055, "system__file_control_block_E");
22472 pragma Import (Ada, E042, "system__file_io_E");
22475 pragma Import (Ada, E006, "ada__text_io_E");
22477 -- Set_Globals is a library routine that stores away the
22478 -- value of the indicated set of global values in global
22479 -- variables within the library.
22481 procedure Set_Globals
22482 (Main_Priority : Integer;
22483 Time_Slice_Value : Integer;
22484 WC_Encoding : Character;
22485 Locking_Policy : Character;
22486 Queuing_Policy : Character;
22487 Task_Dispatching_Policy : Character;
22488 Adafinal : System.Address;
22489 Unreserve_All_Interrupts : Integer;
22490 Exception_Tracebacks : Integer);
22491 @findex __gnat_set_globals
22492 pragma Import (C, Set_Globals, "__gnat_set_globals");
22494 -- SDP_Table_Build is a library routine used to build the
22495 -- exception tables. See unit Ada.Exceptions in files
22496 -- a-except.ads/adb for full details of how zero cost
22497 -- exception handling works. This procedure, the call to
22498 -- it, and the two following tables are all omitted if the
22499 -- build is in longjmp/setjump exception mode.
22501 @findex SDP_Table_Build
22502 @findex Zero Cost Exceptions
22503 procedure SDP_Table_Build
22504 (SDP_Addresses : System.Address;
22505 SDP_Count : Natural;
22506 Elab_Addresses : System.Address;
22507 Elab_Addr_Count : Natural);
22508 pragma Import (C, SDP_Table_Build, "__gnat_SDP_Table_Build");
22510 -- Table of Unit_Exception_Table addresses. Used for zero
22511 -- cost exception handling to build the top level table.
22513 ST : aliased constant array (1 .. 23) of System.Address := (
22515 Ada.Text_Io'UET_Address,
22516 Ada.Exceptions'UET_Address,
22517 Gnat.Heap_Sort_A'UET_Address,
22518 System.Exception_Table'UET_Address,
22519 System.Machine_State_Operations'UET_Address,
22520 System.Secondary_Stack'UET_Address,
22521 System.Parameters'UET_Address,
22522 System.Soft_Links'UET_Address,
22523 System.Stack_Checking'UET_Address,
22524 System.Traceback'UET_Address,
22525 Ada.Streams'UET_Address,
22526 Ada.Tags'UET_Address,
22527 System.String_Ops'UET_Address,
22528 Interfaces.C_Streams'UET_Address,
22529 System.File_Io'UET_Address,
22530 Ada.Finalization'UET_Address,
22531 System.Finalization_Root'UET_Address,
22532 System.Finalization_Implementation'UET_Address,
22533 System.String_Ops_Concat_3'UET_Address,
22534 System.Stream_Attributes'UET_Address,
22535 System.File_Control_Block'UET_Address,
22536 Ada.Finalization.List_Controller'UET_Address);
22538 -- Table of addresses of elaboration routines. Used for
22539 -- zero cost exception handling to make sure these
22540 -- addresses are included in the top level procedure
22543 EA : aliased constant array (1 .. 23) of System.Address := (
22544 adainit'Code_Address,
22545 Do_Finalize'Code_Address,
22546 Ada.Exceptions'Elab_Spec'Address,
22547 System.Exceptions'Elab_Spec'Address,
22548 Interfaces.C_Streams'Elab_Spec'Address,
22549 System.Exception_Table'Elab_Body'Address,
22550 Ada.Io_Exceptions'Elab_Spec'Address,
22551 System.Stack_Checking'Elab_Spec'Address,
22552 System.Soft_Links'Elab_Body'Address,
22553 System.Secondary_Stack'Elab_Body'Address,
22554 Ada.Tags'Elab_Spec'Address,
22555 Ada.Tags'Elab_Body'Address,
22556 Ada.Streams'Elab_Spec'Address,
22557 System.Finalization_Root'Elab_Spec'Address,
22558 Ada.Exceptions'Elab_Body'Address,
22559 System.Finalization_Implementation'Elab_Spec'Address,
22560 System.Finalization_Implementation'Elab_Body'Address,
22561 Ada.Finalization'Elab_Spec'Address,
22562 Ada.Finalization.List_Controller'Elab_Spec'Address,
22563 System.File_Control_Block'Elab_Spec'Address,
22564 System.File_Io'Elab_Body'Address,
22565 Ada.Text_Io'Elab_Spec'Address,
22566 Ada.Text_Io'Elab_Body'Address);
22568 -- Start of processing for adainit
22572 -- Call SDP_Table_Build to build the top level procedure
22573 -- table for zero cost exception handling (omitted in
22574 -- longjmp/setjump mode).
22576 SDP_Table_Build (ST'Address, 23, EA'Address, 23);
22578 -- Call Set_Globals to record various information for
22579 -- this partition. The values are derived by the binder
22580 -- from information stored in the ali files by the compiler.
22582 @findex __gnat_set_globals
22584 (Main_Priority => -1,
22585 -- Priority of main program, -1 if no pragma Priority used
22587 Time_Slice_Value => -1,
22588 -- Time slice from Time_Slice pragma, -1 if none used
22590 WC_Encoding => 'b',
22591 -- Wide_Character encoding used, default is brackets
22593 Locking_Policy => ' ',
22594 -- Locking_Policy used, default of space means not
22595 -- specified, otherwise it is the first character of
22596 -- the policy name.
22598 Queuing_Policy => ' ',
22599 -- Queuing_Policy used, default of space means not
22600 -- specified, otherwise it is the first character of
22601 -- the policy name.
22603 Task_Dispatching_Policy => ' ',
22604 -- Task_Dispatching_Policy used, default of space means
22605 -- not specified, otherwise first character of the
22608 Adafinal => System.Null_Address,
22609 -- Address of Adafinal routine, not used anymore
22611 Unreserve_All_Interrupts => 0,
22612 -- Set true if pragma Unreserve_All_Interrupts was used
22614 Exception_Tracebacks => 0);
22615 -- Indicates if exception tracebacks are enabled
22617 Elab_Final_Code := 1;
22619 -- Now we have the elaboration calls for all units in the partition.
22620 -- The Elab_Spec and Elab_Body attributes generate references to the
22621 -- implicit elaboration procedures generated by the compiler for
22622 -- each unit that requires elaboration.
22625 Interfaces.C_Streams'Elab_Spec;
22629 Ada.Exceptions'Elab_Spec;
22632 System.Exception_Table'Elab_Body;
22636 Ada.Io_Exceptions'Elab_Spec;
22640 System.Exceptions'Elab_Spec;
22644 System.Stack_Checking'Elab_Spec;
22647 System.Soft_Links'Elab_Body;
22652 System.Secondary_Stack'Elab_Body;
22656 Ada.Tags'Elab_Spec;
22659 Ada.Tags'Elab_Body;
22663 Ada.Streams'Elab_Spec;
22667 System.Finalization_Root'Elab_Spec;
22671 Ada.Exceptions'Elab_Body;
22675 System.Finalization_Implementation'Elab_Spec;
22678 System.Finalization_Implementation'Elab_Body;
22682 Ada.Finalization'Elab_Spec;
22686 Ada.Finalization.List_Controller'Elab_Spec;
22690 System.File_Control_Block'Elab_Spec;
22694 System.File_Io'Elab_Body;
22698 Ada.Text_Io'Elab_Spec;
22701 Ada.Text_Io'Elab_Body;
22705 Elab_Final_Code := 0;
22713 procedure adafinal is
22722 -- main is actually a function, as in the ANSI C standard,
22723 -- defined to return the exit status. The three parameters
22724 -- are the argument count, argument values and environment
22727 @findex Main Program
22730 argv : System.Address;
22731 envp : System.Address)
22734 -- The initialize routine performs low level system
22735 -- initialization using a standard library routine which
22736 -- sets up signal handling and performs any other
22737 -- required setup. The routine can be found in file
22740 @findex __gnat_initialize
22741 procedure initialize;
22742 pragma Import (C, initialize, "__gnat_initialize");
22744 -- The finalize routine performs low level system
22745 -- finalization using a standard library routine. The
22746 -- routine is found in file a-final.c and in the standard
22747 -- distribution is a dummy routine that does nothing, so
22748 -- really this is a hook for special user finalization.
22750 @findex __gnat_finalize
22751 procedure finalize;
22752 pragma Import (C, finalize, "__gnat_finalize");
22754 -- We get to the main program of the partition by using
22755 -- pragma Import because if we try to with the unit and
22756 -- call it Ada style, then not only do we waste time
22757 -- recompiling it, but also, we don't really know the right
22758 -- switches (e.g. identifier character set) to be used
22761 procedure Ada_Main_Program;
22762 pragma Import (Ada, Ada_Main_Program, "_ada_hello");
22764 -- Start of processing for main
22767 -- Save global variables
22773 -- Call low level system initialization
22777 -- Call our generated Ada initialization routine
22781 -- This is the point at which we want the debugger to get
22786 -- Now we call the main program of the partition
22790 -- Perform Ada finalization
22794 -- Perform low level system finalization
22798 -- Return the proper exit status
22799 return (gnat_exit_status);
22802 -- This section is entirely comments, so it has no effect on the
22803 -- compilation of the Ada_Main package. It provides the list of
22804 -- object files and linker options, as well as some standard
22805 -- libraries needed for the link. The gnatlink utility parses
22806 -- this b~hello.adb file to read these comment lines to generate
22807 -- the appropriate command line arguments for the call to the
22808 -- system linker. The BEGIN/END lines are used for sentinels for
22809 -- this parsing operation.
22811 -- The exact file names will of course depend on the environment,
22812 -- host/target and location of files on the host system.
22814 @findex Object file list
22815 -- BEGIN Object file/option list
22818 -- -L/usr/local/gnat/lib/gcc-lib/i686-pc-linux-gnu/2.8.1/adalib/
22819 -- /usr/local/gnat/lib/gcc-lib/i686-pc-linux-gnu/2.8.1/adalib/libgnat.a
22820 -- END Object file/option list
22826 The Ada code in the above example is exactly what is generated by the
22827 binder. We have added comments to more clearly indicate the function
22828 of each part of the generated @code{Ada_Main} package.
22830 The code is standard Ada in all respects, and can be processed by any
22831 tools that handle Ada. In particular, it is possible to use the debugger
22832 in Ada mode to debug the generated @code{Ada_Main} package. For example,
22833 suppose that for reasons that you do not understand, your program is crashing
22834 during elaboration of the body of @code{Ada.Text_IO}. To locate this bug,
22835 you can place a breakpoint on the call:
22837 @smallexample @c ada
22838 Ada.Text_Io'Elab_Body;
22842 and trace the elaboration routine for this package to find out where
22843 the problem might be (more usually of course you would be debugging
22844 elaboration code in your own application).
22846 @node Elaboration Order Handling in GNAT
22847 @appendix Elaboration Order Handling in GNAT
22848 @cindex Order of elaboration
22849 @cindex Elaboration control
22852 * Elaboration Code in Ada 95::
22853 * Checking the Elaboration Order in Ada 95::
22854 * Controlling the Elaboration Order in Ada 95::
22855 * Controlling Elaboration in GNAT - Internal Calls::
22856 * Controlling Elaboration in GNAT - External Calls::
22857 * Default Behavior in GNAT - Ensuring Safety::
22858 * Treatment of Pragma Elaborate::
22859 * Elaboration Issues for Library Tasks::
22860 * Mixing Elaboration Models::
22861 * What to Do If the Default Elaboration Behavior Fails::
22862 * Elaboration for Access-to-Subprogram Values::
22863 * Summary of Procedures for Elaboration Control::
22864 * Other Elaboration Order Considerations::
22868 This chapter describes the handling of elaboration code in Ada 95 and
22869 in GNAT, and discusses how the order of elaboration of program units can
22870 be controlled in GNAT, either automatically or with explicit programming
22873 @node Elaboration Code in Ada 95
22874 @section Elaboration Code in Ada 95
22877 Ada 95 provides rather general mechanisms for executing code at elaboration
22878 time, that is to say before the main program starts executing. Such code arises
22882 @item Initializers for variables.
22883 Variables declared at the library level, in package specs or bodies, can
22884 require initialization that is performed at elaboration time, as in:
22885 @smallexample @c ada
22887 Sqrt_Half : Float := Sqrt (0.5);
22891 @item Package initialization code
22892 Code in a @code{BEGIN-END} section at the outer level of a package body is
22893 executed as part of the package body elaboration code.
22895 @item Library level task allocators
22896 Tasks that are declared using task allocators at the library level
22897 start executing immediately and hence can execute at elaboration time.
22901 Subprogram calls are possible in any of these contexts, which means that
22902 any arbitrary part of the program may be executed as part of the elaboration
22903 code. It is even possible to write a program which does all its work at
22904 elaboration time, with a null main program, although stylistically this
22905 would usually be considered an inappropriate way to structure
22908 An important concern arises in the context of elaboration code:
22909 we have to be sure that it is executed in an appropriate order. What we
22910 have is a series of elaboration code sections, potentially one section
22911 for each unit in the program. It is important that these execute
22912 in the correct order. Correctness here means that, taking the above
22913 example of the declaration of @code{Sqrt_Half},
22914 if some other piece of
22915 elaboration code references @code{Sqrt_Half},
22916 then it must run after the
22917 section of elaboration code that contains the declaration of
22920 There would never be any order of elaboration problem if we made a rule
22921 that whenever you @code{with} a unit, you must elaborate both the spec and body
22922 of that unit before elaborating the unit doing the @code{with}'ing:
22924 @smallexample @c ada
22928 package Unit_2 is ...
22934 would require that both the body and spec of @code{Unit_1} be elaborated
22935 before the spec of @code{Unit_2}. However, a rule like that would be far too
22936 restrictive. In particular, it would make it impossible to have routines
22937 in separate packages that were mutually recursive.
22939 You might think that a clever enough compiler could look at the actual
22940 elaboration code and determine an appropriate correct order of elaboration,
22941 but in the general case, this is not possible. Consider the following
22944 In the body of @code{Unit_1}, we have a procedure @code{Func_1}
22946 the variable @code{Sqrt_1}, which is declared in the elaboration code
22947 of the body of @code{Unit_1}:
22949 @smallexample @c ada
22951 Sqrt_1 : Float := Sqrt (0.1);
22956 The elaboration code of the body of @code{Unit_1} also contains:
22958 @smallexample @c ada
22961 if expression_1 = 1 then
22962 Q := Unit_2.Func_2;
22969 @code{Unit_2} is exactly parallel,
22970 it has a procedure @code{Func_2} that references
22971 the variable @code{Sqrt_2}, which is declared in the elaboration code of
22972 the body @code{Unit_2}:
22974 @smallexample @c ada
22976 Sqrt_2 : Float := Sqrt (0.1);
22981 The elaboration code of the body of @code{Unit_2} also contains:
22983 @smallexample @c ada
22986 if expression_2 = 2 then
22987 Q := Unit_1.Func_1;
22994 Now the question is, which of the following orders of elaboration is
23019 If you carefully analyze the flow here, you will see that you cannot tell
23020 at compile time the answer to this question.
23021 If @code{expression_1} is not equal to 1,
23022 and @code{expression_2} is not equal to 2,
23023 then either order is acceptable, because neither of the function calls is
23024 executed. If both tests evaluate to true, then neither order is acceptable
23025 and in fact there is no correct order.
23027 If one of the two expressions is true, and the other is false, then one
23028 of the above orders is correct, and the other is incorrect. For example,
23029 if @code{expression_1} = 1 and @code{expression_2} /= 2,
23030 then the call to @code{Func_2}
23031 will occur, but not the call to @code{Func_1.}
23032 This means that it is essential
23033 to elaborate the body of @code{Unit_1} before
23034 the body of @code{Unit_2}, so the first
23035 order of elaboration is correct and the second is wrong.
23037 By making @code{expression_1} and @code{expression_2}
23038 depend on input data, or perhaps
23039 the time of day, we can make it impossible for the compiler or binder
23040 to figure out which of these expressions will be true, and hence it
23041 is impossible to guarantee a safe order of elaboration at run time.
23043 @node Checking the Elaboration Order in Ada 95
23044 @section Checking the Elaboration Order in Ada 95
23047 In some languages that involve the same kind of elaboration problems,
23048 e.g. Java and C++, the programmer is expected to worry about these
23049 ordering problems himself, and it is common to
23050 write a program in which an incorrect elaboration order gives
23051 surprising results, because it references variables before they
23053 Ada 95 is designed to be a safe language, and a programmer-beware approach is
23054 clearly not sufficient. Consequently, the language provides three lines
23058 @item Standard rules
23059 Some standard rules restrict the possible choice of elaboration
23060 order. In particular, if you @code{with} a unit, then its spec is always
23061 elaborated before the unit doing the @code{with}. Similarly, a parent
23062 spec is always elaborated before the child spec, and finally
23063 a spec is always elaborated before its corresponding body.
23065 @item Dynamic elaboration checks
23066 @cindex Elaboration checks
23067 @cindex Checks, elaboration
23068 Dynamic checks are made at run time, so that if some entity is accessed
23069 before it is elaborated (typically by means of a subprogram call)
23070 then the exception (@code{Program_Error}) is raised.
23072 @item Elaboration control
23073 Facilities are provided for the programmer to specify the desired order
23077 Let's look at these facilities in more detail. First, the rules for
23078 dynamic checking. One possible rule would be simply to say that the
23079 exception is raised if you access a variable which has not yet been
23080 elaborated. The trouble with this approach is that it could require
23081 expensive checks on every variable reference. Instead Ada 95 has two
23082 rules which are a little more restrictive, but easier to check, and
23086 @item Restrictions on calls
23087 A subprogram can only be called at elaboration time if its body
23088 has been elaborated. The rules for elaboration given above guarantee
23089 that the spec of the subprogram has been elaborated before the
23090 call, but not the body. If this rule is violated, then the
23091 exception @code{Program_Error} is raised.
23093 @item Restrictions on instantiations
23094 A generic unit can only be instantiated if the body of the generic
23095 unit has been elaborated. Again, the rules for elaboration given above
23096 guarantee that the spec of the generic unit has been elaborated
23097 before the instantiation, but not the body. If this rule is
23098 violated, then the exception @code{Program_Error} is raised.
23102 The idea is that if the body has been elaborated, then any variables
23103 it references must have been elaborated; by checking for the body being
23104 elaborated we guarantee that none of its references causes any
23105 trouble. As we noted above, this is a little too restrictive, because a
23106 subprogram that has no non-local references in its body may in fact be safe
23107 to call. However, it really would be unsafe to rely on this, because
23108 it would mean that the caller was aware of details of the implementation
23109 in the body. This goes against the basic tenets of Ada.
23111 A plausible implementation can be described as follows.
23112 A Boolean variable is associated with each subprogram
23113 and each generic unit. This variable is initialized to False, and is set to
23114 True at the point body is elaborated. Every call or instantiation checks the
23115 variable, and raises @code{Program_Error} if the variable is False.
23117 Note that one might think that it would be good enough to have one Boolean
23118 variable for each package, but that would not deal with cases of trying
23119 to call a body in the same package as the call
23120 that has not been elaborated yet.
23121 Of course a compiler may be able to do enough analysis to optimize away
23122 some of the Boolean variables as unnecessary, and @code{GNAT} indeed
23123 does such optimizations, but still the easiest conceptual model is to
23124 think of there being one variable per subprogram.
23126 @node Controlling the Elaboration Order in Ada 95
23127 @section Controlling the Elaboration Order in Ada 95
23130 In the previous section we discussed the rules in Ada 95 which ensure
23131 that @code{Program_Error} is raised if an incorrect elaboration order is
23132 chosen. This prevents erroneous executions, but we need mechanisms to
23133 specify a correct execution and avoid the exception altogether.
23134 To achieve this, Ada 95 provides a number of features for controlling
23135 the order of elaboration. We discuss these features in this section.
23137 First, there are several ways of indicating to the compiler that a given
23138 unit has no elaboration problems:
23141 @item packages that do not require a body
23142 In Ada 95, a library package that does not require a body does not permit
23143 a body. This means that if we have a such a package, as in:
23145 @smallexample @c ada
23148 package Definitions is
23150 type m is new integer;
23152 type a is array (1 .. 10) of m;
23153 type b is array (1 .. 20) of m;
23161 A package that @code{with}'s @code{Definitions} may safely instantiate
23162 @code{Definitions.Subp} because the compiler can determine that there
23163 definitely is no package body to worry about in this case
23166 @cindex pragma Pure
23168 Places sufficient restrictions on a unit to guarantee that
23169 no call to any subprogram in the unit can result in an
23170 elaboration problem. This means that the compiler does not need
23171 to worry about the point of elaboration of such units, and in
23172 particular, does not need to check any calls to any subprograms
23175 @item pragma Preelaborate
23176 @findex Preelaborate
23177 @cindex pragma Preelaborate
23178 This pragma places slightly less stringent restrictions on a unit than
23180 but these restrictions are still sufficient to ensure that there
23181 are no elaboration problems with any calls to the unit.
23183 @item pragma Elaborate_Body
23184 @findex Elaborate_Body
23185 @cindex pragma Elaborate_Body
23186 This pragma requires that the body of a unit be elaborated immediately
23187 after its spec. Suppose a unit @code{A} has such a pragma,
23188 and unit @code{B} does
23189 a @code{with} of unit @code{A}. Recall that the standard rules require
23190 the spec of unit @code{A}
23191 to be elaborated before the @code{with}'ing unit; given the pragma in
23192 @code{A}, we also know that the body of @code{A}
23193 will be elaborated before @code{B}, so
23194 that calls to @code{A} are safe and do not need a check.
23199 unlike pragma @code{Pure} and pragma @code{Preelaborate},
23201 @code{Elaborate_Body} does not guarantee that the program is
23202 free of elaboration problems, because it may not be possible
23203 to satisfy the requested elaboration order.
23204 Let's go back to the example with @code{Unit_1} and @code{Unit_2}.
23206 marks @code{Unit_1} as @code{Elaborate_Body},
23207 and not @code{Unit_2,} then the order of
23208 elaboration will be:
23220 Now that means that the call to @code{Func_1} in @code{Unit_2}
23221 need not be checked,
23222 it must be safe. But the call to @code{Func_2} in
23223 @code{Unit_1} may still fail if
23224 @code{Expression_1} is equal to 1,
23225 and the programmer must still take
23226 responsibility for this not being the case.
23228 If all units carry a pragma @code{Elaborate_Body}, then all problems are
23229 eliminated, except for calls entirely within a body, which are
23230 in any case fully under programmer control. However, using the pragma
23231 everywhere is not always possible.
23232 In particular, for our @code{Unit_1}/@code{Unit_2} example, if
23233 we marked both of them as having pragma @code{Elaborate_Body}, then
23234 clearly there would be no possible elaboration order.
23236 The above pragmas allow a server to guarantee safe use by clients, and
23237 clearly this is the preferable approach. Consequently a good rule in
23238 Ada 95 is to mark units as @code{Pure} or @code{Preelaborate} if possible,
23239 and if this is not possible,
23240 mark them as @code{Elaborate_Body} if possible.
23241 As we have seen, there are situations where neither of these
23242 three pragmas can be used.
23243 So we also provide methods for clients to control the
23244 order of elaboration of the servers on which they depend:
23247 @item pragma Elaborate (unit)
23249 @cindex pragma Elaborate
23250 This pragma is placed in the context clause, after a @code{with} clause,
23251 and it requires that the body of the named unit be elaborated before
23252 the unit in which the pragma occurs. The idea is to use this pragma
23253 if the current unit calls at elaboration time, directly or indirectly,
23254 some subprogram in the named unit.
23256 @item pragma Elaborate_All (unit)
23257 @findex Elaborate_All
23258 @cindex pragma Elaborate_All
23259 This is a stronger version of the Elaborate pragma. Consider the
23263 Unit A @code{with}'s unit B and calls B.Func in elab code
23264 Unit B @code{with}'s unit C, and B.Func calls C.Func
23268 Now if we put a pragma @code{Elaborate (B)}
23269 in unit @code{A}, this ensures that the
23270 body of @code{B} is elaborated before the call, but not the
23271 body of @code{C}, so
23272 the call to @code{C.Func} could still cause @code{Program_Error} to
23275 The effect of a pragma @code{Elaborate_All} is stronger, it requires
23276 not only that the body of the named unit be elaborated before the
23277 unit doing the @code{with}, but also the bodies of all units that the
23278 named unit uses, following @code{with} links transitively. For example,
23279 if we put a pragma @code{Elaborate_All (B)} in unit @code{A},
23281 not only that the body of @code{B} be elaborated before @code{A},
23283 body of @code{C}, because @code{B} @code{with}'s @code{C}.
23287 We are now in a position to give a usage rule in Ada 95 for avoiding
23288 elaboration problems, at least if dynamic dispatching and access to
23289 subprogram values are not used. We will handle these cases separately
23292 The rule is simple. If a unit has elaboration code that can directly or
23293 indirectly make a call to a subprogram in a @code{with}'ed unit, or instantiate
23294 a generic unit in a @code{with}'ed unit,
23295 then if the @code{with}'ed unit does not have
23296 pragma @code{Pure} or @code{Preelaborate}, then the client should have
23297 a pragma @code{Elaborate_All}
23298 for the @code{with}'ed unit. By following this rule a client is
23299 assured that calls can be made without risk of an exception.
23300 If this rule is not followed, then a program may be in one of four
23304 @item No order exists
23305 No order of elaboration exists which follows the rules, taking into
23306 account any @code{Elaborate}, @code{Elaborate_All},
23307 or @code{Elaborate_Body} pragmas. In
23308 this case, an Ada 95 compiler must diagnose the situation at bind
23309 time, and refuse to build an executable program.
23311 @item One or more orders exist, all incorrect
23312 One or more acceptable elaboration orders exists, and all of them
23313 generate an elaboration order problem. In this case, the binder
23314 can build an executable program, but @code{Program_Error} will be raised
23315 when the program is run.
23317 @item Several orders exist, some right, some incorrect
23318 One or more acceptable elaboration orders exists, and some of them
23319 work, and some do not. The programmer has not controlled
23320 the order of elaboration, so the binder may or may not pick one of
23321 the correct orders, and the program may or may not raise an
23322 exception when it is run. This is the worst case, because it means
23323 that the program may fail when moved to another compiler, or even
23324 another version of the same compiler.
23326 @item One or more orders exists, all correct
23327 One ore more acceptable elaboration orders exist, and all of them
23328 work. In this case the program runs successfully. This state of
23329 affairs can be guaranteed by following the rule we gave above, but
23330 may be true even if the rule is not followed.
23334 Note that one additional advantage of following our Elaborate_All rule
23335 is that the program continues to stay in the ideal (all orders OK) state
23336 even if maintenance
23337 changes some bodies of some subprograms. Conversely, if a program that does
23338 not follow this rule happens to be safe at some point, this state of affairs
23339 may deteriorate silently as a result of maintenance changes.
23341 You may have noticed that the above discussion did not mention
23342 the use of @code{Elaborate_Body}. This was a deliberate omission. If you
23343 @code{with} an @code{Elaborate_Body} unit, it still may be the case that
23344 code in the body makes calls to some other unit, so it is still necessary
23345 to use @code{Elaborate_All} on such units.
23347 @node Controlling Elaboration in GNAT - Internal Calls
23348 @section Controlling Elaboration in GNAT - Internal Calls
23351 In the case of internal calls, i.e. calls within a single package, the
23352 programmer has full control over the order of elaboration, and it is up
23353 to the programmer to elaborate declarations in an appropriate order. For
23356 @smallexample @c ada
23359 function One return Float;
23363 function One return Float is
23372 will obviously raise @code{Program_Error} at run time, because function
23373 One will be called before its body is elaborated. In this case GNAT will
23374 generate a warning that the call will raise @code{Program_Error}:
23380 2. function One return Float;
23382 4. Q : Float := One;
23384 >>> warning: cannot call "One" before body is elaborated
23385 >>> warning: Program_Error will be raised at run time
23388 6. function One return Float is
23401 Note that in this particular case, it is likely that the call is safe, because
23402 the function @code{One} does not access any global variables.
23403 Nevertheless in Ada 95, we do not want the validity of the check to depend on
23404 the contents of the body (think about the separate compilation case), so this
23405 is still wrong, as we discussed in the previous sections.
23407 The error is easily corrected by rearranging the declarations so that the
23408 body of One appears before the declaration containing the call
23409 (note that in Ada 95,
23410 declarations can appear in any order, so there is no restriction that
23411 would prevent this reordering, and if we write:
23413 @smallexample @c ada
23416 function One return Float;
23418 function One return Float is
23429 then all is well, no warning is generated, and no
23430 @code{Program_Error} exception
23432 Things are more complicated when a chain of subprograms is executed:
23434 @smallexample @c ada
23437 function A return Integer;
23438 function B return Integer;
23439 function C return Integer;
23441 function B return Integer is begin return A; end;
23442 function C return Integer is begin return B; end;
23446 function A return Integer is begin return 1; end;
23452 Now the call to @code{C}
23453 at elaboration time in the declaration of @code{X} is correct, because
23454 the body of @code{C} is already elaborated,
23455 and the call to @code{B} within the body of
23456 @code{C} is correct, but the call
23457 to @code{A} within the body of @code{B} is incorrect, because the body
23458 of @code{A} has not been elaborated, so @code{Program_Error}
23459 will be raised on the call to @code{A}.
23460 In this case GNAT will generate a
23461 warning that @code{Program_Error} may be
23462 raised at the point of the call. Let's look at the warning:
23468 2. function A return Integer;
23469 3. function B return Integer;
23470 4. function C return Integer;
23472 6. function B return Integer is begin return A; end;
23474 >>> warning: call to "A" before body is elaborated may
23475 raise Program_Error
23476 >>> warning: "B" called at line 7
23477 >>> warning: "C" called at line 9
23479 7. function C return Integer is begin return B; end;
23481 9. X : Integer := C;
23483 11. function A return Integer is begin return 1; end;
23493 Note that the message here says ``may raise'', instead of the direct case,
23494 where the message says ``will be raised''. That's because whether
23496 actually called depends in general on run-time flow of control.
23497 For example, if the body of @code{B} said
23499 @smallexample @c ada
23502 function B return Integer is
23504 if some-condition-depending-on-input-data then
23515 then we could not know until run time whether the incorrect call to A would
23516 actually occur, so @code{Program_Error} might
23517 or might not be raised. It is possible for a compiler to
23518 do a better job of analyzing bodies, to
23519 determine whether or not @code{Program_Error}
23520 might be raised, but it certainly
23521 couldn't do a perfect job (that would require solving the halting problem
23522 and is provably impossible), and because this is a warning anyway, it does
23523 not seem worth the effort to do the analysis. Cases in which it
23524 would be relevant are rare.
23526 In practice, warnings of either of the forms given
23527 above will usually correspond to
23528 real errors, and should be examined carefully and eliminated.
23529 In the rare case where a warning is bogus, it can be suppressed by any of
23530 the following methods:
23534 Compile with the @option{-gnatws} switch set
23537 Suppress @code{Elaboration_Check} for the called subprogram
23540 Use pragma @code{Warnings_Off} to turn warnings off for the call
23544 For the internal elaboration check case,
23545 GNAT by default generates the
23546 necessary run-time checks to ensure
23547 that @code{Program_Error} is raised if any
23548 call fails an elaboration check. Of course this can only happen if a
23549 warning has been issued as described above. The use of pragma
23550 @code{Suppress (Elaboration_Check)} may (but is not guaranteed to) suppress
23551 some of these checks, meaning that it may be possible (but is not
23552 guaranteed) for a program to be able to call a subprogram whose body
23553 is not yet elaborated, without raising a @code{Program_Error} exception.
23555 @node Controlling Elaboration in GNAT - External Calls
23556 @section Controlling Elaboration in GNAT - External Calls
23559 The previous section discussed the case in which the execution of a
23560 particular thread of elaboration code occurred entirely within a
23561 single unit. This is the easy case to handle, because a programmer
23562 has direct and total control over the order of elaboration, and
23563 furthermore, checks need only be generated in cases which are rare
23564 and which the compiler can easily detect.
23565 The situation is more complex when separate compilation is taken into account.
23566 Consider the following:
23568 @smallexample @c ada
23572 function Sqrt (Arg : Float) return Float;
23575 package body Math is
23576 function Sqrt (Arg : Float) return Float is
23585 X : Float := Math.Sqrt (0.5);
23598 where @code{Main} is the main program. When this program is executed, the
23599 elaboration code must first be executed, and one of the jobs of the
23600 binder is to determine the order in which the units of a program are
23601 to be elaborated. In this case we have four units: the spec and body
23603 the spec of @code{Stuff} and the body of @code{Main}).
23604 In what order should the four separate sections of elaboration code
23607 There are some restrictions in the order of elaboration that the binder
23608 can choose. In particular, if unit U has a @code{with}
23609 for a package @code{X}, then you
23610 are assured that the spec of @code{X}
23611 is elaborated before U , but you are
23612 not assured that the body of @code{X}
23613 is elaborated before U.
23614 This means that in the above case, the binder is allowed to choose the
23625 but that's not good, because now the call to @code{Math.Sqrt}
23626 that happens during
23627 the elaboration of the @code{Stuff}
23628 spec happens before the body of @code{Math.Sqrt} is
23629 elaborated, and hence causes @code{Program_Error} exception to be raised.
23630 At first glance, one might say that the binder is misbehaving, because
23631 obviously you want to elaborate the body of something you @code{with}
23633 that is not a general rule that can be followed in all cases. Consider
23635 @smallexample @c ada
23643 package body Y is ...
23646 package body X is ...
23652 This is a common arrangement, and, apart from the order of elaboration
23653 problems that might arise in connection with elaboration code, this works fine.
23654 A rule that says that you must first elaborate the body of anything you
23655 @code{with} cannot work in this case:
23656 the body of @code{X} @code{with}'s @code{Y},
23657 which means you would have to
23658 elaborate the body of @code{Y} first, but that @code{with}'s @code{X},
23660 you have to elaborate the body of @code{X} first, but ... and we have a
23661 loop that cannot be broken.
23663 It is true that the binder can in many cases guess an order of elaboration
23664 that is unlikely to cause a @code{Program_Error}
23665 exception to be raised, and it tries to do so (in the
23666 above example of @code{Math/Stuff/Spec}, the GNAT binder will
23668 elaborate the body of @code{Math} right after its spec, so all will be well).
23670 However, a program that blindly relies on the binder to be helpful can
23671 get into trouble, as we discussed in the previous sections, so
23673 provides a number of facilities for assisting the programmer in
23674 developing programs that are robust with respect to elaboration order.
23676 @node Default Behavior in GNAT - Ensuring Safety
23677 @section Default Behavior in GNAT - Ensuring Safety
23680 The default behavior in GNAT ensures elaboration safety. In its
23681 default mode GNAT implements the
23682 rule we previously described as the right approach. Let's restate it:
23686 @emph{If a unit has elaboration code that can directly or indirectly make a
23687 call to a subprogram in a @code{with}'ed unit, or instantiate a generic unit
23688 in a @code{with}'ed unit, then if the @code{with}'ed unit
23689 does not have pragma @code{Pure} or
23690 @code{Preelaborate}, then the client should have an
23691 @code{Elaborate_All} for the @code{with}'ed unit.}
23695 By following this rule a client is assured that calls and instantiations
23696 can be made without risk of an exception.
23698 In this mode GNAT traces all calls that are potentially made from
23699 elaboration code, and puts in any missing implicit @code{Elaborate_All}
23701 The advantage of this approach is that no elaboration problems
23702 are possible if the binder can find an elaboration order that is
23703 consistent with these implicit @code{Elaborate_All} pragmas. The
23704 disadvantage of this approach is that no such order may exist.
23706 If the binder does not generate any diagnostics, then it means that it
23707 has found an elaboration order that is guaranteed to be safe. However,
23708 the binder may still be relying on implicitly generated
23709 @code{Elaborate_All} pragmas so portability to other compilers than
23710 GNAT is not guaranteed.
23712 If it is important to guarantee portability, then the compilations should
23715 (warn on elaboration problems) switch. This will cause warning messages
23716 to be generated indicating the missing @code{Elaborate_All} pragmas.
23717 Consider the following source program:
23719 @smallexample @c ada
23724 m : integer := k.r;
23731 where it is clear that there
23732 should be a pragma @code{Elaborate_All}
23733 for unit @code{k}. An implicit pragma will be generated, and it is
23734 likely that the binder will be able to honor it. However, if you want
23735 to port this program to some other Ada compiler than GNAT.
23736 it is safer to include the pragma explicitly in the source. If this
23737 unit is compiled with the
23739 switch, then the compiler outputs a warning:
23746 3. m : integer := k.r;
23748 >>> warning: call to "r" may raise Program_Error
23749 >>> warning: missing pragma Elaborate_All for "k"
23757 and these warnings can be used as a guide for supplying manually
23758 the missing pragmas. It is usually a bad idea to use this warning
23759 option during development. That's because it will warn you when
23760 you need to put in a pragma, but cannot warn you when it is time
23761 to take it out. So the use of pragma Elaborate_All may lead to
23762 unnecessary dependencies and even false circularities.
23764 This default mode is more restrictive than the Ada Reference
23765 Manual, and it is possible to construct programs which will compile
23766 using the dynamic model described there, but will run into a
23767 circularity using the safer static model we have described.
23769 Of course any Ada compiler must be able to operate in a mode
23770 consistent with the requirements of the Ada Reference Manual,
23771 and in particular must have the capability of implementing the
23772 standard dynamic model of elaboration with run-time checks.
23774 In GNAT, this standard mode can be achieved either by the use of
23775 the @option{-gnatE} switch on the compiler (@command{gcc} or
23776 @command{gnatmake}) command, or by the use of the configuration pragma:
23778 @smallexample @c ada
23779 pragma Elaboration_Checks (RM);
23783 Either approach will cause the unit affected to be compiled using the
23784 standard dynamic run-time elaboration checks described in the Ada
23785 Reference Manual. The static model is generally preferable, since it
23786 is clearly safer to rely on compile and link time checks rather than
23787 run-time checks. However, in the case of legacy code, it may be
23788 difficult to meet the requirements of the static model. This
23789 issue is further discussed in
23790 @ref{What to Do If the Default Elaboration Behavior Fails}.
23792 Note that the static model provides a strict subset of the allowed
23793 behavior and programs of the Ada Reference Manual, so if you do
23794 adhere to the static model and no circularities exist,
23795 then you are assured that your program will
23796 work using the dynamic model, providing that you remove any
23797 pragma Elaborate statements from the source.
23799 @node Treatment of Pragma Elaborate
23800 @section Treatment of Pragma Elaborate
23801 @cindex Pragma Elaborate
23804 The use of @code{pragma Elaborate}
23805 should generally be avoided in Ada 95 programs.
23806 The reason for this is that there is no guarantee that transitive calls
23807 will be properly handled. Indeed at one point, this pragma was placed
23808 in Annex J (Obsolescent Features), on the grounds that it is never useful.
23810 Now that's a bit restrictive. In practice, the case in which
23811 @code{pragma Elaborate} is useful is when the caller knows that there
23812 are no transitive calls, or that the called unit contains all necessary
23813 transitive @code{pragma Elaborate} statements, and legacy code often
23814 contains such uses.
23816 Strictly speaking the static mode in GNAT should ignore such pragmas,
23817 since there is no assurance at compile time that the necessary safety
23818 conditions are met. In practice, this would cause GNAT to be incompatible
23819 with correctly written Ada 83 code that had all necessary
23820 @code{pragma Elaborate} statements in place. Consequently, we made the
23821 decision that GNAT in its default mode will believe that if it encounters
23822 a @code{pragma Elaborate} then the programmer knows what they are doing,
23823 and it will trust that no elaboration errors can occur.
23825 The result of this decision is two-fold. First to be safe using the
23826 static mode, you should remove all @code{pragma Elaborate} statements.
23827 Second, when fixing circularities in existing code, you can selectively
23828 use @code{pragma Elaborate} statements to convince the static mode of
23829 GNAT that it need not generate an implicit @code{pragma Elaborate_All}
23832 When using the static mode with @option{-gnatwl}, any use of
23833 @code{pragma Elaborate} will generate a warning about possible
23836 @node Elaboration Issues for Library Tasks
23837 @section Elaboration Issues for Library Tasks
23838 @cindex Library tasks, elaboration issues
23839 @cindex Elaboration of library tasks
23842 In this section we examine special elaboration issues that arise for
23843 programs that declare library level tasks.
23845 Generally the model of execution of an Ada program is that all units are
23846 elaborated, and then execution of the program starts. However, the
23847 declaration of library tasks definitely does not fit this model. The
23848 reason for this is that library tasks start as soon as they are declared
23849 (more precisely, as soon as the statement part of the enclosing package
23850 body is reached), that is to say before elaboration
23851 of the program is complete. This means that if such a task calls a
23852 subprogram, or an entry in another task, the callee may or may not be
23853 elaborated yet, and in the standard
23854 Reference Manual model of dynamic elaboration checks, you can even
23855 get timing dependent Program_Error exceptions, since there can be
23856 a race between the elaboration code and the task code.
23858 The static model of elaboration in GNAT seeks to avoid all such
23859 dynamic behavior, by being conservative, and the conservative
23860 approach in this particular case is to assume that all the code
23861 in a task body is potentially executed at elaboration time if
23862 a task is declared at the library level.
23864 This can definitely result in unexpected circularities. Consider
23865 the following example
23867 @smallexample @c ada
23873 type My_Int is new Integer;
23875 function Ident (M : My_Int) return My_Int;
23879 package body Decls is
23880 task body Lib_Task is
23886 function Ident (M : My_Int) return My_Int is
23894 procedure Put_Val (Arg : Decls.My_Int);
23898 package body Utils is
23899 procedure Put_Val (Arg : Decls.My_Int) is
23901 Text_IO.Put_Line (Decls.My_Int'Image (Decls.Ident (Arg)));
23908 Decls.Lib_Task.Start;
23913 If the above example is compiled in the default static elaboration
23914 mode, then a circularity occurs. The circularity comes from the call
23915 @code{Utils.Put_Val} in the task body of @code{Decls.Lib_Task}. Since
23916 this call occurs in elaboration code, we need an implicit pragma
23917 @code{Elaborate_All} for @code{Utils}. This means that not only must
23918 the spec and body of @code{Utils} be elaborated before the body
23919 of @code{Decls}, but also the spec and body of any unit that is
23920 @code{with'ed} by the body of @code{Utils} must also be elaborated before
23921 the body of @code{Decls}. This is the transitive implication of
23922 pragma @code{Elaborate_All} and it makes sense, because in general
23923 the body of @code{Put_Val} might have a call to something in a
23924 @code{with'ed} unit.
23926 In this case, the body of Utils (actually its spec) @code{with's}
23927 @code{Decls}. Unfortunately this means that the body of @code{Decls}
23928 must be elaborated before itself, in case there is a call from the
23929 body of @code{Utils}.
23931 Here is the exact chain of events we are worrying about:
23935 In the body of @code{Decls} a call is made from within the body of a library
23936 task to a subprogram in the package @code{Utils}. Since this call may
23937 occur at elaboration time (given that the task is activated at elaboration
23938 time), we have to assume the worst, i.e. that the
23939 call does happen at elaboration time.
23942 This means that the body and spec of @code{Util} must be elaborated before
23943 the body of @code{Decls} so that this call does not cause an access before
23947 Within the body of @code{Util}, specifically within the body of
23948 @code{Util.Put_Val} there may be calls to any unit @code{with}'ed
23952 One such @code{with}'ed package is package @code{Decls}, so there
23953 might be a call to a subprogram in @code{Decls} in @code{Put_Val}.
23954 In fact there is such a call in this example, but we would have to
23955 assume that there was such a call even if it were not there, since
23956 we are not supposed to write the body of @code{Decls} knowing what
23957 is in the body of @code{Utils}; certainly in the case of the
23958 static elaboration model, the compiler does not know what is in
23959 other bodies and must assume the worst.
23962 This means that the spec and body of @code{Decls} must also be
23963 elaborated before we elaborate the unit containing the call, but
23964 that unit is @code{Decls}! This means that the body of @code{Decls}
23965 must be elaborated before itself, and that's a circularity.
23969 Indeed, if you add an explicit pragma Elaborate_All for @code{Utils} in
23970 the body of @code{Decls} you will get a true Ada Reference Manual
23971 circularity that makes the program illegal.
23973 In practice, we have found that problems with the static model of
23974 elaboration in existing code often arise from library tasks, so
23975 we must address this particular situation.
23977 Note that if we compile and run the program above, using the dynamic model of
23978 elaboration (that is to say use the @option{-gnatE} switch),
23979 then it compiles, binds,
23980 links, and runs, printing the expected result of 2. Therefore in some sense
23981 the circularity here is only apparent, and we need to capture
23982 the properties of this program that distinguish it from other library-level
23983 tasks that have real elaboration problems.
23985 We have four possible answers to this question:
23990 Use the dynamic model of elaboration.
23992 If we use the @option{-gnatE} switch, then as noted above, the program works.
23993 Why is this? If we examine the task body, it is apparent that the task cannot
23995 @code{accept} statement until after elaboration has been completed, because
23996 the corresponding entry call comes from the main program, not earlier.
23997 This is why the dynamic model works here. But that's really giving
23998 up on a precise analysis, and we prefer to take this approach only if we cannot
24000 problem in any other manner. So let us examine two ways to reorganize
24001 the program to avoid the potential elaboration problem.
24004 Split library tasks into separate packages.
24006 Write separate packages, so that library tasks are isolated from
24007 other declarations as much as possible. Let us look at a variation on
24010 @smallexample @c ada
24018 package body Decls1 is
24019 task body Lib_Task is
24027 type My_Int is new Integer;
24028 function Ident (M : My_Int) return My_Int;
24032 package body Decls2 is
24033 function Ident (M : My_Int) return My_Int is
24041 procedure Put_Val (Arg : Decls2.My_Int);
24045 package body Utils is
24046 procedure Put_Val (Arg : Decls2.My_Int) is
24048 Text_IO.Put_Line (Decls2.My_Int'Image (Decls2.Ident (Arg)));
24055 Decls1.Lib_Task.Start;
24060 All we have done is to split @code{Decls} into two packages, one
24061 containing the library task, and one containing everything else. Now
24062 there is no cycle, and the program compiles, binds, links and executes
24063 using the default static model of elaboration.
24066 Declare separate task types.
24068 A significant part of the problem arises because of the use of the
24069 single task declaration form. This means that the elaboration of
24070 the task type, and the elaboration of the task itself (i.e. the
24071 creation of the task) happen at the same time. A good rule
24072 of style in Ada 95 is to always create explicit task types. By
24073 following the additional step of placing task objects in separate
24074 packages from the task type declaration, many elaboration problems
24075 are avoided. Here is another modified example of the example program:
24077 @smallexample @c ada
24079 task type Lib_Task_Type is
24083 type My_Int is new Integer;
24085 function Ident (M : My_Int) return My_Int;
24089 package body Decls is
24090 task body Lib_Task_Type is
24096 function Ident (M : My_Int) return My_Int is
24104 procedure Put_Val (Arg : Decls.My_Int);
24108 package body Utils is
24109 procedure Put_Val (Arg : Decls.My_Int) is
24111 Text_IO.Put_Line (Decls.My_Int'Image (Decls.Ident (Arg)));
24117 Lib_Task : Decls.Lib_Task_Type;
24123 Declst.Lib_Task.Start;
24128 What we have done here is to replace the @code{task} declaration in
24129 package @code{Decls} with a @code{task type} declaration. Then we
24130 introduce a separate package @code{Declst} to contain the actual
24131 task object. This separates the elaboration issues for
24132 the @code{task type}
24133 declaration, which causes no trouble, from the elaboration issues
24134 of the task object, which is also unproblematic, since it is now independent
24135 of the elaboration of @code{Utils}.
24136 This separation of concerns also corresponds to
24137 a generally sound engineering principle of separating declarations
24138 from instances. This version of the program also compiles, binds, links,
24139 and executes, generating the expected output.
24142 Use No_Entry_Calls_In_Elaboration_Code restriction.
24143 @cindex No_Entry_Calls_In_Elaboration_Code
24145 The previous two approaches described how a program can be restructured
24146 to avoid the special problems caused by library task bodies. in practice,
24147 however, such restructuring may be difficult to apply to existing legacy code,
24148 so we must consider solutions that do not require massive rewriting.
24150 Let us consider more carefully why our original sample program works
24151 under the dynamic model of elaboration. The reason is that the code
24152 in the task body blocks immediately on the @code{accept}
24153 statement. Now of course there is nothing to prohibit elaboration
24154 code from making entry calls (for example from another library level task),
24155 so we cannot tell in isolation that
24156 the task will not execute the accept statement during elaboration.
24158 However, in practice it is very unusual to see elaboration code
24159 make any entry calls, and the pattern of tasks starting
24160 at elaboration time and then immediately blocking on @code{accept} or
24161 @code{select} statements is very common. What this means is that
24162 the compiler is being too pessimistic when it analyzes the
24163 whole package body as though it might be executed at elaboration
24166 If we know that the elaboration code contains no entry calls, (a very safe
24167 assumption most of the time, that could almost be made the default
24168 behavior), then we can compile all units of the program under control
24169 of the following configuration pragma:
24172 pragma Restrictions (No_Entry_Calls_In_Elaboration_Code);
24176 This pragma can be placed in the @file{gnat.adc} file in the usual
24177 manner. If we take our original unmodified program and compile it
24178 in the presence of a @file{gnat.adc} containing the above pragma,
24179 then once again, we can compile, bind, link, and execute, obtaining
24180 the expected result. In the presence of this pragma, the compiler does
24181 not trace calls in a task body, that appear after the first @code{accept}
24182 or @code{select} statement, and therefore does not report a potential
24183 circularity in the original program.
24185 The compiler will check to the extent it can that the above
24186 restriction is not violated, but it is not always possible to do a
24187 complete check at compile time, so it is important to use this
24188 pragma only if the stated restriction is in fact met, that is to say
24189 no task receives an entry call before elaboration of all units is completed.
24193 @node Mixing Elaboration Models
24194 @section Mixing Elaboration Models
24196 So far, we have assumed that the entire program is either compiled
24197 using the dynamic model or static model, ensuring consistency. It
24198 is possible to mix the two models, but rules have to be followed
24199 if this mixing is done to ensure that elaboration checks are not
24202 The basic rule is that @emph{a unit compiled with the static model cannot
24203 be @code{with'ed} by a unit compiled with the dynamic model}. The
24204 reason for this is that in the static model, a unit assumes that
24205 its clients guarantee to use (the equivalent of) pragma
24206 @code{Elaborate_All} so that no elaboration checks are required
24207 in inner subprograms, and this assumption is violated if the
24208 client is compiled with dynamic checks.
24210 The precise rule is as follows. A unit that is compiled with dynamic
24211 checks can only @code{with} a unit that meets at least one of the
24212 following criteria:
24217 The @code{with'ed} unit is itself compiled with dynamic elaboration
24218 checks (that is with the @option{-gnatE} switch.
24221 The @code{with'ed} unit is an internal GNAT implementation unit from
24222 the System, Interfaces, Ada, or GNAT hierarchies.
24225 The @code{with'ed} unit has pragma Preelaborate or pragma Pure.
24228 The @code{with'ing} unit (that is the client) has an explicit pragma
24229 @code{Elaborate_All} for the @code{with'ed} unit.
24234 If this rule is violated, that is if a unit with dynamic elaboration
24235 checks @code{with's} a unit that does not meet one of the above four
24236 criteria, then the binder (@code{gnatbind}) will issue a warning
24237 similar to that in the following example:
24240 warning: "x.ads" has dynamic elaboration checks and with's
24241 warning: "y.ads" which has static elaboration checks
24245 These warnings indicate that the rule has been violated, and that as a result
24246 elaboration checks may be missed in the resulting executable file.
24247 This warning may be suppressed using the @option{-ws} binder switch
24248 in the usual manner.
24250 One useful application of this mixing rule is in the case of a subsystem
24251 which does not itself @code{with} units from the remainder of the
24252 application. In this case, the entire subsystem can be compiled with
24253 dynamic checks to resolve a circularity in the subsystem, while
24254 allowing the main application that uses this subsystem to be compiled
24255 using the more reliable default static model.
24257 @node What to Do If the Default Elaboration Behavior Fails
24258 @section What to Do If the Default Elaboration Behavior Fails
24261 If the binder cannot find an acceptable order, it outputs detailed
24262 diagnostics. For example:
24268 error: elaboration circularity detected
24269 info: "proc (body)" must be elaborated before "pack (body)"
24270 info: reason: Elaborate_All probably needed in unit "pack (body)"
24271 info: recompile "pack (body)" with -gnatwl
24272 info: for full details
24273 info: "proc (body)"
24274 info: is needed by its spec:
24275 info: "proc (spec)"
24276 info: which is withed by:
24277 info: "pack (body)"
24278 info: "pack (body)" must be elaborated before "proc (body)"
24279 info: reason: pragma Elaborate in unit "proc (body)"
24285 In this case we have a cycle that the binder cannot break. On the one
24286 hand, there is an explicit pragma Elaborate in @code{proc} for
24287 @code{pack}. This means that the body of @code{pack} must be elaborated
24288 before the body of @code{proc}. On the other hand, there is elaboration
24289 code in @code{pack} that calls a subprogram in @code{proc}. This means
24290 that for maximum safety, there should really be a pragma
24291 Elaborate_All in @code{pack} for @code{proc} which would require that
24292 the body of @code{proc} be elaborated before the body of
24293 @code{pack}. Clearly both requirements cannot be satisfied.
24294 Faced with a circularity of this kind, you have three different options.
24297 @item Fix the program
24298 The most desirable option from the point of view of long-term maintenance
24299 is to rearrange the program so that the elaboration problems are avoided.
24300 One useful technique is to place the elaboration code into separate
24301 child packages. Another is to move some of the initialization code to
24302 explicitly called subprograms, where the program controls the order
24303 of initialization explicitly. Although this is the most desirable option,
24304 it may be impractical and involve too much modification, especially in
24305 the case of complex legacy code.
24307 @item Perform dynamic checks
24308 If the compilations are done using the
24310 (dynamic elaboration check) switch, then GNAT behaves in
24311 a quite different manner. Dynamic checks are generated for all calls
24312 that could possibly result in raising an exception. With this switch,
24313 the compiler does not generate implicit @code{Elaborate_All} pragmas.
24314 The behavior then is exactly as specified in the Ada 95 Reference Manual.
24315 The binder will generate an executable program that may or may not
24316 raise @code{Program_Error}, and then it is the programmer's job to ensure
24317 that it does not raise an exception. Note that it is important to
24318 compile all units with the switch, it cannot be used selectively.
24320 @item Suppress checks
24321 The drawback of dynamic checks is that they generate a
24322 significant overhead at run time, both in space and time. If you
24323 are absolutely sure that your program cannot raise any elaboration
24324 exceptions, and you still want to use the dynamic elaboration model,
24325 then you can use the configuration pragma
24326 @code{Suppress (Elaboration_Check)} to suppress all such checks. For
24327 example this pragma could be placed in the @file{gnat.adc} file.
24329 @item Suppress checks selectively
24330 When you know that certain calls in elaboration code cannot possibly
24331 lead to an elaboration error, and the binder nevertheless generates warnings
24332 on those calls and inserts Elaborate_All pragmas that lead to elaboration
24333 circularities, it is possible to remove those warnings locally and obtain
24334 a program that will bind. Clearly this can be unsafe, and it is the
24335 responsibility of the programmer to make sure that the resulting program has
24336 no elaboration anomalies. The pragma @code{Suppress (Elaboration_Check)} can
24337 be used with different granularity to suppress warnings and break
24338 elaboration circularities:
24342 Place the pragma that names the called subprogram in the declarative part
24343 that contains the call.
24346 Place the pragma in the declarative part, without naming an entity. This
24347 disables warnings on all calls in the corresponding declarative region.
24350 Place the pragma in the package spec that declares the called subprogram,
24351 and name the subprogram. This disables warnings on all elaboration calls to
24355 Place the pragma in the package spec that declares the called subprogram,
24356 without naming any entity. This disables warnings on all elaboration calls to
24357 all subprograms declared in this spec.
24359 @item Use Pragma Elaborate
24360 As previously described in section @xref{Treatment of Pragma Elaborate},
24361 GNAT in static mode assumes that a @code{pragma} Elaborate indicates correctly
24362 that no elaboration checks are required on calls to the designated unit.
24363 There may be cases in which the caller knows that no transitive calls
24364 can occur, so that a @code{pragma Elaborate} will be sufficient in a
24365 case where @code{pragma Elaborate_All} would cause a circularity.
24369 These five cases are listed in order of decreasing safety, and therefore
24370 require increasing programmer care in their application. Consider the
24373 @smallexample @c adanocomment
24375 function F1 return Integer;
24380 function F2 return Integer;
24381 function Pure (x : integer) return integer;
24382 -- pragma Suppress (Elaboration_Check, On => Pure); -- (3)
24383 -- pragma Suppress (Elaboration_Check); -- (4)
24387 package body Pack1 is
24388 function F1 return Integer is
24392 Val : integer := Pack2.Pure (11); -- Elab. call (1)
24395 -- pragma Suppress(Elaboration_Check, Pack2.F2); -- (1)
24396 -- pragma Suppress(Elaboration_Check); -- (2)
24398 X1 := Pack2.F2 + 1; -- Elab. call (2)
24403 package body Pack2 is
24404 function F2 return Integer is
24408 function Pure (x : integer) return integer is
24410 return x ** 3 - 3 * x;
24414 with Pack1, Ada.Text_IO;
24417 Ada.Text_IO.Put_Line(Pack1.X1'Img); -- 101
24420 In the absence of any pragmas, an attempt to bind this program produces
24421 the following diagnostics:
24427 error: elaboration circularity detected
24428 info: "pack1 (body)" must be elaborated before "pack1 (body)"
24429 info: reason: Elaborate_All probably needed in unit "pack1 (body)"
24430 info: recompile "pack1 (body)" with -gnatwl for full details
24431 info: "pack1 (body)"
24432 info: must be elaborated along with its spec:
24433 info: "pack1 (spec)"
24434 info: which is withed by:
24435 info: "pack2 (body)"
24436 info: which must be elaborated along with its spec:
24437 info: "pack2 (spec)"
24438 info: which is withed by:
24439 info: "pack1 (body)"
24442 The sources of the circularity are the two calls to @code{Pack2.Pure} and
24443 @code{Pack2.F2} in the body of @code{Pack1}. We can see that the call to
24444 F2 is safe, even though F2 calls F1, because the call appears after the
24445 elaboration of the body of F1. Therefore the pragma (1) is safe, and will
24446 remove the warning on the call. It is also possible to use pragma (2)
24447 because there are no other potentially unsafe calls in the block.
24450 The call to @code{Pure} is safe because this function does not depend on the
24451 state of @code{Pack2}. Therefore any call to this function is safe, and it
24452 is correct to place pragma (3) in the corresponding package spec.
24455 Finally, we could place pragma (4) in the spec of @code{Pack2} to disable
24456 warnings on all calls to functions declared therein. Note that this is not
24457 necessarily safe, and requires more detailed examination of the subprogram
24458 bodies involved. In particular, a call to @code{F2} requires that @code{F1}
24459 be already elaborated.
24463 It is hard to generalize on which of these four approaches should be
24464 taken. Obviously if it is possible to fix the program so that the default
24465 treatment works, this is preferable, but this may not always be practical.
24466 It is certainly simple enough to use
24468 but the danger in this case is that, even if the GNAT binder
24469 finds a correct elaboration order, it may not always do so,
24470 and certainly a binder from another Ada compiler might not. A
24471 combination of testing and analysis (for which the warnings generated
24474 switch can be useful) must be used to ensure that the program is free
24475 of errors. One switch that is useful in this testing is the
24476 @option{^-p (pessimistic elaboration order)^/PESSIMISTIC_ELABORATION_ORDER^}
24479 Normally the binder tries to find an order that has the best chance of
24480 of avoiding elaboration problems. With this switch, the binder
24481 plays a devil's advocate role, and tries to choose the order that
24482 has the best chance of failing. If your program works even with this
24483 switch, then it has a better chance of being error free, but this is still
24486 For an example of this approach in action, consider the C-tests (executable
24487 tests) from the ACVC suite. If these are compiled and run with the default
24488 treatment, then all but one of them succeed without generating any error
24489 diagnostics from the binder. However, there is one test that fails, and
24490 this is not surprising, because the whole point of this test is to ensure
24491 that the compiler can handle cases where it is impossible to determine
24492 a correct order statically, and it checks that an exception is indeed
24493 raised at run time.
24495 This one test must be compiled and run using the
24497 switch, and then it passes. Alternatively, the entire suite can
24498 be run using this switch. It is never wrong to run with the dynamic
24499 elaboration switch if your code is correct, and we assume that the
24500 C-tests are indeed correct (it is less efficient, but efficiency is
24501 not a factor in running the ACVC tests.)
24503 @node Elaboration for Access-to-Subprogram Values
24504 @section Elaboration for Access-to-Subprogram Values
24505 @cindex Access-to-subprogram
24508 The introduction of access-to-subprogram types in Ada 95 complicates
24509 the handling of elaboration. The trouble is that it becomes
24510 impossible to tell at compile time which procedure
24511 is being called. This means that it is not possible for the binder
24512 to analyze the elaboration requirements in this case.
24514 If at the point at which the access value is created
24515 (i.e., the evaluation of @code{P'Access} for a subprogram @code{P}),
24516 the body of the subprogram is
24517 known to have been elaborated, then the access value is safe, and its use
24518 does not require a check. This may be achieved by appropriate arrangement
24519 of the order of declarations if the subprogram is in the current unit,
24520 or, if the subprogram is in another unit, by using pragma
24521 @code{Pure}, @code{Preelaborate}, or @code{Elaborate_Body}
24522 on the referenced unit.
24524 If the referenced body is not known to have been elaborated at the point
24525 the access value is created, then any use of the access value must do a
24526 dynamic check, and this dynamic check will fail and raise a
24527 @code{Program_Error} exception if the body has not been elaborated yet.
24528 GNAT will generate the necessary checks, and in addition, if the
24530 switch is set, will generate warnings that such checks are required.
24532 The use of dynamic dispatching for tagged types similarly generates
24533 a requirement for dynamic checks, and premature calls to any primitive
24534 operation of a tagged type before the body of the operation has been
24535 elaborated, will result in the raising of @code{Program_Error}.
24537 @node Summary of Procedures for Elaboration Control
24538 @section Summary of Procedures for Elaboration Control
24539 @cindex Elaboration control
24542 First, compile your program with the default options, using none of
24543 the special elaboration control switches. If the binder successfully
24544 binds your program, then you can be confident that, apart from issues
24545 raised by the use of access-to-subprogram types and dynamic dispatching,
24546 the program is free of elaboration errors. If it is important that the
24547 program be portable, then use the
24549 switch to generate warnings about missing @code{Elaborate_All}
24550 pragmas, and supply the missing pragmas.
24552 If the program fails to bind using the default static elaboration
24553 handling, then you can fix the program to eliminate the binder
24554 message, or recompile the entire program with the
24555 @option{-gnatE} switch to generate dynamic elaboration checks,
24556 and, if you are sure there really are no elaboration problems,
24557 use a global pragma @code{Suppress (Elaboration_Check)}.
24559 @node Other Elaboration Order Considerations
24560 @section Other Elaboration Order Considerations
24562 This section has been entirely concerned with the issue of finding a valid
24563 elaboration order, as defined by the Ada Reference Manual. In a case
24564 where several elaboration orders are valid, the task is to find one
24565 of the possible valid elaboration orders (and the static model in GNAT
24566 will ensure that this is achieved).
24568 The purpose of the elaboration rules in the Ada Reference Manual is to
24569 make sure that no entity is accessed before it has been elaborated. For
24570 a subprogram, this means that the spec and body must have been elaborated
24571 before the subprogram is called. For an object, this means that the object
24572 must have been elaborated before its value is read or written. A violation
24573 of either of these two requirements is an access before elaboration order,
24574 and this section has been all about avoiding such errors.
24576 In the case where more than one order of elaboration is possible, in the
24577 sense that access before elaboration errors are avoided, then any one of
24578 the orders is ``correct'' in the sense that it meets the requirements of
24579 the Ada Reference Manual, and no such error occurs.
24581 However, it may be the case for a given program, that there are
24582 constraints on the order of elaboration that come not from consideration
24583 of avoiding elaboration errors, but rather from extra-lingual logic
24584 requirements. Consider this example:
24586 @smallexample @c ada
24587 with Init_Constants;
24588 package Constants is
24593 package Init_Constants is
24594 procedure P; -- require a body
24595 end Init_Constants;
24598 package body Init_Constants is
24599 procedure P is begin null; end;
24603 end Init_Constants;
24607 Z : Integer := Constants.X + Constants.Y;
24611 with Text_IO; use Text_IO;
24614 Put_Line (Calc.Z'Img);
24619 In this example, there is more than one valid order of elaboration. For
24620 example both the following are correct orders:
24623 Init_Constants spec
24626 Init_Constants body
24631 Init_Constants spec
24632 Init_Constants body
24639 There is no language rule to prefer one or the other, both are correct
24640 from an order of elaboration point of view. But the programmatic effects
24641 of the two orders are very different. In the first, the elaboration routine
24642 of @code{Calc} initializes @code{Z} to zero, and then the main program
24643 runs with this value of zero. But in the second order, the elaboration
24644 routine of @code{Calc} runs after the body of Init_Constants has set
24645 @code{X} and @code{Y} and thus @code{Z} is set to 7 before @code{Main}
24648 One could perhaps by applying pretty clever non-artificial intelligence
24649 to the situation guess that it is more likely that the second order of
24650 elaboration is the one desired, but there is no formal linguistic reason
24651 to prefer one over the other. In fact in this particular case, GNAT will
24652 prefer the second order, because of the rule that bodies are elaborated
24653 as soon as possible, but it's just luck that this is what was wanted
24654 (if indeed the second order was preferred).
24656 If the program cares about the order of elaboration routines in a case like
24657 this, it is important to specify the order required. In this particular
24658 case, that could have been achieved by adding to the spec of Calc:
24660 @smallexample @c ada
24661 pragma Elaborate_All (Constants);
24665 which requires that the body (if any) and spec of @code{Constants},
24666 as well as the body and spec of any unit @code{with}'ed by
24667 @code{Constants} be elaborated before @code{Calc} is elaborated.
24669 Clearly no automatic method can always guess which alternative you require,
24670 and if you are working with legacy code that had constraints of this kind
24671 which were not properly specified by adding @code{Elaborate} or
24672 @code{Elaborate_All} pragmas, then indeed it is possible that two different
24673 compilers can choose different orders.
24675 The @code{gnatbind}
24676 @option{^-p^/PESSIMISTIC_ELABORATION^} switch may be useful in smoking
24677 out problems. This switch causes bodies to be elaborated as late as possible
24678 instead of as early as possible. In the example above, it would have forced
24679 the choice of the first elaboration order. If you get different results
24680 when using this switch, and particularly if one set of results is right,
24681 and one is wrong as far as you are concerned, it shows that you have some
24682 missing @code{Elaborate} pragmas. For the example above, we have the
24686 gnatmake -f -q main
24689 gnatmake -f -q main -bargs -p
24695 It is of course quite unlikely that both these results are correct, so
24696 it is up to you in a case like this to investigate the source of the
24697 difference, by looking at the two elaboration orders that are chosen,
24698 and figuring out which is correct, and then adding the necessary
24699 @code{Elaborate_All} pragmas to ensure the desired order.
24701 @node Inline Assembler
24702 @appendix Inline Assembler
24705 If you need to write low-level software that interacts directly
24706 with the hardware, Ada provides two ways to incorporate assembly
24707 language code into your program. First, you can import and invoke
24708 external routines written in assembly language, an Ada feature fully
24709 supported by GNAT. However, for small sections of code it may be simpler
24710 or more efficient to include assembly language statements directly
24711 in your Ada source program, using the facilities of the implementation-defined
24712 package @code{System.Machine_Code}, which incorporates the gcc
24713 Inline Assembler. The Inline Assembler approach offers a number of advantages,
24714 including the following:
24717 @item No need to use non-Ada tools
24718 @item Consistent interface over different targets
24719 @item Automatic usage of the proper calling conventions
24720 @item Access to Ada constants and variables
24721 @item Definition of intrinsic routines
24722 @item Possibility of inlining a subprogram comprising assembler code
24723 @item Code optimizer can take Inline Assembler code into account
24726 This chapter presents a series of examples to show you how to use
24727 the Inline Assembler. Although it focuses on the Intel x86,
24728 the general approach applies also to other processors.
24729 It is assumed that you are familiar with Ada
24730 and with assembly language programming.
24733 * Basic Assembler Syntax::
24734 * A Simple Example of Inline Assembler::
24735 * Output Variables in Inline Assembler::
24736 * Input Variables in Inline Assembler::
24737 * Inlining Inline Assembler Code::
24738 * Other Asm Functionality::
24741 @c ---------------------------------------------------------------------------
24742 @node Basic Assembler Syntax
24743 @section Basic Assembler Syntax
24746 The assembler used by GNAT and gcc is based not on the Intel assembly
24747 language, but rather on a language that descends from the AT&T Unix
24748 assembler @emph{as} (and which is often referred to as ``AT&T syntax'').
24749 The following table summarizes the main features of @emph{as} syntax
24750 and points out the differences from the Intel conventions.
24751 See the gcc @emph{as} and @emph{gas} (an @emph{as} macro
24752 pre-processor) documentation for further information.
24755 @item Register names
24756 gcc / @emph{as}: Prefix with ``%''; for example @code{%eax}
24758 Intel: No extra punctuation; for example @code{eax}
24760 @item Immediate operand
24761 gcc / @emph{as}: Prefix with ``$''; for example @code{$4}
24763 Intel: No extra punctuation; for example @code{4}
24766 gcc / @emph{as}: Prefix with ``$''; for example @code{$loc}
24768 Intel: No extra punctuation; for example @code{loc}
24770 @item Memory contents
24771 gcc / @emph{as}: No extra punctuation; for example @code{loc}
24773 Intel: Square brackets; for example @code{[loc]}
24775 @item Register contents
24776 gcc / @emph{as}: Parentheses; for example @code{(%eax)}
24778 Intel: Square brackets; for example @code{[eax]}
24780 @item Hexadecimal numbers
24781 gcc / @emph{as}: Leading ``0x'' (C language syntax); for example @code{0xA0}
24783 Intel: Trailing ``h''; for example @code{A0h}
24786 gcc / @emph{as}: Explicit in op code; for example @code{movw} to move
24789 Intel: Implicit, deduced by assembler; for example @code{mov}
24791 @item Instruction repetition
24792 gcc / @emph{as}: Split into two lines; for example
24798 Intel: Keep on one line; for example @code{rep stosl}
24800 @item Order of operands
24801 gcc / @emph{as}: Source first; for example @code{movw $4, %eax}
24803 Intel: Destination first; for example @code{mov eax, 4}
24806 @c ---------------------------------------------------------------------------
24807 @node A Simple Example of Inline Assembler
24808 @section A Simple Example of Inline Assembler
24811 The following example will generate a single assembly language statement,
24812 @code{nop}, which does nothing. Despite its lack of run-time effect,
24813 the example will be useful in illustrating the basics of
24814 the Inline Assembler facility.
24816 @smallexample @c ada
24818 with System.Machine_Code; use System.Machine_Code;
24819 procedure Nothing is
24826 @code{Asm} is a procedure declared in package @code{System.Machine_Code};
24827 here it takes one parameter, a @emph{template string} that must be a static
24828 expression and that will form the generated instruction.
24829 @code{Asm} may be regarded as a compile-time procedure that parses
24830 the template string and additional parameters (none here),
24831 from which it generates a sequence of assembly language instructions.
24833 The examples in this chapter will illustrate several of the forms
24834 for invoking @code{Asm}; a complete specification of the syntax
24835 is found in the @cite{GNAT Reference Manual}.
24837 Under the standard GNAT conventions, the @code{Nothing} procedure
24838 should be in a file named @file{nothing.adb}.
24839 You can build the executable in the usual way:
24843 However, the interesting aspect of this example is not its run-time behavior
24844 but rather the generated assembly code.
24845 To see this output, invoke the compiler as follows:
24847 gcc -c -S -fomit-frame-pointer -gnatp @file{nothing.adb}
24849 where the options are:
24853 compile only (no bind or link)
24855 generate assembler listing
24856 @item -fomit-frame-pointer
24857 do not set up separate stack frames
24859 do not add runtime checks
24862 This gives a human-readable assembler version of the code. The resulting
24863 file will have the same name as the Ada source file, but with a @code{.s}
24864 extension. In our example, the file @file{nothing.s} has the following
24869 .file "nothing.adb"
24871 ___gnu_compiled_ada:
24874 .globl __ada_nothing
24886 The assembly code you included is clearly indicated by
24887 the compiler, between the @code{#APP} and @code{#NO_APP}
24888 delimiters. The character before the 'APP' and 'NOAPP'
24889 can differ on different targets. For example, GNU/Linux uses '#APP' while
24890 on NT you will see '/APP'.
24892 If you make a mistake in your assembler code (such as using the
24893 wrong size modifier, or using a wrong operand for the instruction) GNAT
24894 will report this error in a temporary file, which will be deleted when
24895 the compilation is finished. Generating an assembler file will help
24896 in such cases, since you can assemble this file separately using the
24897 @emph{as} assembler that comes with gcc.
24899 Assembling the file using the command
24902 as @file{nothing.s}
24905 will give you error messages whose lines correspond to the assembler
24906 input file, so you can easily find and correct any mistakes you made.
24907 If there are no errors, @emph{as} will generate an object file
24908 @file{nothing.out}.
24910 @c ---------------------------------------------------------------------------
24911 @node Output Variables in Inline Assembler
24912 @section Output Variables in Inline Assembler
24915 The examples in this section, showing how to access the processor flags,
24916 illustrate how to specify the destination operands for assembly language
24919 @smallexample @c ada
24921 with Interfaces; use Interfaces;
24922 with Ada.Text_IO; use Ada.Text_IO;
24923 with System.Machine_Code; use System.Machine_Code;
24924 procedure Get_Flags is
24925 Flags : Unsigned_32;
24928 Asm ("pushfl" & LF & HT & -- push flags on stack
24929 "popl %%eax" & LF & HT & -- load eax with flags
24930 "movl %%eax, %0", -- store flags in variable
24931 Outputs => Unsigned_32'Asm_Output ("=g", Flags));
24932 Put_Line ("Flags register:" & Flags'Img);
24937 In order to have a nicely aligned assembly listing, we have separated
24938 multiple assembler statements in the Asm template string with linefeed
24939 (ASCII.LF) and horizontal tab (ASCII.HT) characters.
24940 The resulting section of the assembly output file is:
24947 movl %eax, -40(%ebp)
24952 It would have been legal to write the Asm invocation as:
24955 Asm ("pushfl popl %%eax movl %%eax, %0")
24958 but in the generated assembler file, this would come out as:
24962 pushfl popl %eax movl %eax, -40(%ebp)
24966 which is not so convenient for the human reader.
24968 We use Ada comments
24969 at the end of each line to explain what the assembler instructions
24970 actually do. This is a useful convention.
24972 When writing Inline Assembler instructions, you need to precede each register
24973 and variable name with a percent sign. Since the assembler already requires
24974 a percent sign at the beginning of a register name, you need two consecutive
24975 percent signs for such names in the Asm template string, thus @code{%%eax}.
24976 In the generated assembly code, one of the percent signs will be stripped off.
24978 Names such as @code{%0}, @code{%1}, @code{%2}, etc., denote input or output
24979 variables: operands you later define using @code{Input} or @code{Output}
24980 parameters to @code{Asm}.
24981 An output variable is illustrated in
24982 the third statement in the Asm template string:
24986 The intent is to store the contents of the eax register in a variable that can
24987 be accessed in Ada. Simply writing @code{movl %%eax, Flags} would not
24988 necessarily work, since the compiler might optimize by using a register
24989 to hold Flags, and the expansion of the @code{movl} instruction would not be
24990 aware of this optimization. The solution is not to store the result directly
24991 but rather to advise the compiler to choose the correct operand form;
24992 that is the purpose of the @code{%0} output variable.
24994 Information about the output variable is supplied in the @code{Outputs}
24995 parameter to @code{Asm}:
24997 Outputs => Unsigned_32'Asm_Output ("=g", Flags));
25000 The output is defined by the @code{Asm_Output} attribute of the target type;
25001 the general format is
25003 Type'Asm_Output (constraint_string, variable_name)
25006 The constraint string directs the compiler how
25007 to store/access the associated variable. In the example
25009 Unsigned_32'Asm_Output ("=m", Flags);
25011 the @code{"m"} (memory) constraint tells the compiler that the variable
25012 @code{Flags} should be stored in a memory variable, thus preventing
25013 the optimizer from keeping it in a register. In contrast,
25015 Unsigned_32'Asm_Output ("=r", Flags);
25017 uses the @code{"r"} (register) constraint, telling the compiler to
25018 store the variable in a register.
25020 If the constraint is preceded by the equal character (@strong{=}), it tells
25021 the compiler that the variable will be used to store data into it.
25023 In the @code{Get_Flags} example, we used the @code{"g"} (global) constraint,
25024 allowing the optimizer to choose whatever it deems best.
25026 There are a fairly large number of constraints, but the ones that are
25027 most useful (for the Intel x86 processor) are the following:
25033 global (i.e. can be stored anywhere)
25051 use one of eax, ebx, ecx or edx
25053 use one of eax, ebx, ecx, edx, esi or edi
25056 The full set of constraints is described in the gcc and @emph{as}
25057 documentation; note that it is possible to combine certain constraints
25058 in one constraint string.
25060 You specify the association of an output variable with an assembler operand
25061 through the @code{%}@emph{n} notation, where @emph{n} is a non-negative
25063 @smallexample @c ada
25065 Asm ("pushfl" & LF & HT & -- push flags on stack
25066 "popl %%eax" & LF & HT & -- load eax with flags
25067 "movl %%eax, %0", -- store flags in variable
25068 Outputs => Unsigned_32'Asm_Output ("=g", Flags));
25072 @code{%0} will be replaced in the expanded code by the appropriate operand,
25074 the compiler decided for the @code{Flags} variable.
25076 In general, you may have any number of output variables:
25079 Count the operands starting at 0; thus @code{%0}, @code{%1}, etc.
25081 Specify the @code{Outputs} parameter as a parenthesized comma-separated list
25082 of @code{Asm_Output} attributes
25086 @smallexample @c ada
25088 Asm ("movl %%eax, %0" & LF & HT &
25089 "movl %%ebx, %1" & LF & HT &
25091 Outputs => (Unsigned_32'Asm_Output ("=g", Var_A), -- %0 = Var_A
25092 Unsigned_32'Asm_Output ("=g", Var_B), -- %1 = Var_B
25093 Unsigned_32'Asm_Output ("=g", Var_C))); -- %2 = Var_C
25097 where @code{Var_A}, @code{Var_B}, and @code{Var_C} are variables
25098 in the Ada program.
25100 As a variation on the @code{Get_Flags} example, we can use the constraints
25101 string to direct the compiler to store the eax register into the @code{Flags}
25102 variable, instead of including the store instruction explicitly in the
25103 @code{Asm} template string:
25105 @smallexample @c ada
25107 with Interfaces; use Interfaces;
25108 with Ada.Text_IO; use Ada.Text_IO;
25109 with System.Machine_Code; use System.Machine_Code;
25110 procedure Get_Flags_2 is
25111 Flags : Unsigned_32;
25114 Asm ("pushfl" & LF & HT & -- push flags on stack
25115 "popl %%eax", -- save flags in eax
25116 Outputs => Unsigned_32'Asm_Output ("=a", Flags));
25117 Put_Line ("Flags register:" & Flags'Img);
25123 The @code{"a"} constraint tells the compiler that the @code{Flags}
25124 variable will come from the eax register. Here is the resulting code:
25132 movl %eax,-40(%ebp)
25137 The compiler generated the store of eax into Flags after
25138 expanding the assembler code.
25140 Actually, there was no need to pop the flags into the eax register;
25141 more simply, we could just pop the flags directly into the program variable:
25143 @smallexample @c ada
25145 with Interfaces; use Interfaces;
25146 with Ada.Text_IO; use Ada.Text_IO;
25147 with System.Machine_Code; use System.Machine_Code;
25148 procedure Get_Flags_3 is
25149 Flags : Unsigned_32;
25152 Asm ("pushfl" & LF & HT & -- push flags on stack
25153 "pop %0", -- save flags in Flags
25154 Outputs => Unsigned_32'Asm_Output ("=g", Flags));
25155 Put_Line ("Flags register:" & Flags'Img);
25160 @c ---------------------------------------------------------------------------
25161 @node Input Variables in Inline Assembler
25162 @section Input Variables in Inline Assembler
25165 The example in this section illustrates how to specify the source operands
25166 for assembly language statements.
25167 The program simply increments its input value by 1:
25169 @smallexample @c ada
25171 with Interfaces; use Interfaces;
25172 with Ada.Text_IO; use Ada.Text_IO;
25173 with System.Machine_Code; use System.Machine_Code;
25174 procedure Increment is
25176 function Incr (Value : Unsigned_32) return Unsigned_32 is
25177 Result : Unsigned_32;
25180 Inputs => Unsigned_32'Asm_Input ("a", Value),
25181 Outputs => Unsigned_32'Asm_Output ("=a", Result));
25185 Value : Unsigned_32;
25189 Put_Line ("Value before is" & Value'Img);
25190 Value := Incr (Value);
25191 Put_Line ("Value after is" & Value'Img);
25196 The @code{Outputs} parameter to @code{Asm} specifies
25197 that the result will be in the eax register and that it is to be stored
25198 in the @code{Result} variable.
25200 The @code{Inputs} parameter looks much like the @code{Outputs} parameter,
25201 but with an @code{Asm_Input} attribute.
25202 The @code{"="} constraint, indicating an output value, is not present.
25204 You can have multiple input variables, in the same way that you can have more
25205 than one output variable.
25207 The parameter count (%0, %1) etc, now starts at the first input
25208 statement, and continues with the output statements.
25209 When both parameters use the same variable, the
25210 compiler will treat them as the same %n operand, which is the case here.
25212 Just as the @code{Outputs} parameter causes the register to be stored into the
25213 target variable after execution of the assembler statements, so does the
25214 @code{Inputs} parameter cause its variable to be loaded into the register
25215 before execution of the assembler statements.
25217 Thus the effect of the @code{Asm} invocation is:
25219 @item load the 32-bit value of @code{Value} into eax
25220 @item execute the @code{incl %eax} instruction
25221 @item store the contents of eax into the @code{Result} variable
25224 The resulting assembler file (with @option{-O2} optimization) contains:
25227 _increment__incr.1:
25240 @c ---------------------------------------------------------------------------
25241 @node Inlining Inline Assembler Code
25242 @section Inlining Inline Assembler Code
25245 For a short subprogram such as the @code{Incr} function in the previous
25246 section, the overhead of the call and return (creating / deleting the stack
25247 frame) can be significant, compared to the amount of code in the subprogram
25248 body. A solution is to apply Ada's @code{Inline} pragma to the subprogram,
25249 which directs the compiler to expand invocations of the subprogram at the
25250 point(s) of call, instead of setting up a stack frame for out-of-line calls.
25251 Here is the resulting program:
25253 @smallexample @c ada
25255 with Interfaces; use Interfaces;
25256 with Ada.Text_IO; use Ada.Text_IO;
25257 with System.Machine_Code; use System.Machine_Code;
25258 procedure Increment_2 is
25260 function Incr (Value : Unsigned_32) return Unsigned_32 is
25261 Result : Unsigned_32;
25264 Inputs => Unsigned_32'Asm_Input ("a", Value),
25265 Outputs => Unsigned_32'Asm_Output ("=a", Result));
25268 pragma Inline (Increment);
25270 Value : Unsigned_32;
25274 Put_Line ("Value before is" & Value'Img);
25275 Value := Increment (Value);
25276 Put_Line ("Value after is" & Value'Img);
25281 Compile the program with both optimization (@option{-O2}) and inlining
25282 enabled (@option{-gnatpn} instead of @option{-gnatp}).
25284 The @code{Incr} function is still compiled as usual, but at the
25285 point in @code{Increment} where our function used to be called:
25290 call _increment__incr.1
25295 the code for the function body directly appears:
25308 thus saving the overhead of stack frame setup and an out-of-line call.
25310 @c ---------------------------------------------------------------------------
25311 @node Other Asm Functionality
25312 @section Other @code{Asm} Functionality
25315 This section describes two important parameters to the @code{Asm}
25316 procedure: @code{Clobber}, which identifies register usage;
25317 and @code{Volatile}, which inhibits unwanted optimizations.
25320 * The Clobber Parameter::
25321 * The Volatile Parameter::
25324 @c ---------------------------------------------------------------------------
25325 @node The Clobber Parameter
25326 @subsection The @code{Clobber} Parameter
25329 One of the dangers of intermixing assembly language and a compiled language
25330 such as Ada is that the compiler needs to be aware of which registers are
25331 being used by the assembly code. In some cases, such as the earlier examples,
25332 the constraint string is sufficient to indicate register usage (e.g.,
25334 the eax register). But more generally, the compiler needs an explicit
25335 identification of the registers that are used by the Inline Assembly
25338 Using a register that the compiler doesn't know about
25339 could be a side effect of an instruction (like @code{mull}
25340 storing its result in both eax and edx).
25341 It can also arise from explicit register usage in your
25342 assembly code; for example:
25345 Asm ("movl %0, %%ebx" & LF & HT &
25347 Inputs => Unsigned_32'Asm_Input ("g", Var_In),
25348 Outputs => Unsigned_32'Asm_Output ("=g", Var_Out));
25352 where the compiler (since it does not analyze the @code{Asm} template string)
25353 does not know you are using the ebx register.
25355 In such cases you need to supply the @code{Clobber} parameter to @code{Asm},
25356 to identify the registers that will be used by your assembly code:
25360 Asm ("movl %0, %%ebx" & LF & HT &
25362 Inputs => Unsigned_32'Asm_Input ("g", Var_In),
25363 Outputs => Unsigned_32'Asm_Output ("=g", Var_Out),
25368 The Clobber parameter is a static string expression specifying the
25369 register(s) you are using. Note that register names are @emph{not} prefixed
25370 by a percent sign. Also, if more than one register is used then their names
25371 are separated by commas; e.g., @code{"eax, ebx"}
25373 The @code{Clobber} parameter has several additional uses:
25375 @item Use ``register'' name @code{cc} to indicate that flags might have changed
25376 @item Use ``register'' name @code{memory} if you changed a memory location
25379 @c ---------------------------------------------------------------------------
25380 @node The Volatile Parameter
25381 @subsection The @code{Volatile} Parameter
25382 @cindex Volatile parameter
25385 Compiler optimizations in the presence of Inline Assembler may sometimes have
25386 unwanted effects. For example, when an @code{Asm} invocation with an input
25387 variable is inside a loop, the compiler might move the loading of the input
25388 variable outside the loop, regarding it as a one-time initialization.
25390 If this effect is not desired, you can disable such optimizations by setting
25391 the @code{Volatile} parameter to @code{True}; for example:
25393 @smallexample @c ada
25395 Asm ("movl %0, %%ebx" & LF & HT &
25397 Inputs => Unsigned_32'Asm_Input ("g", Var_In),
25398 Outputs => Unsigned_32'Asm_Output ("=g", Var_Out),
25404 By default, @code{Volatile} is set to @code{False} unless there is no
25405 @code{Outputs} parameter.
25407 Although setting @code{Volatile} to @code{True} prevents unwanted
25408 optimizations, it will also disable other optimizations that might be
25409 important for efficiency. In general, you should set @code{Volatile}
25410 to @code{True} only if the compiler's optimizations have created
25412 @c END OF INLINE ASSEMBLER CHAPTER
25413 @c ===============================
25415 @c ***********************************
25416 @c * Compatibility and Porting Guide *
25417 @c ***********************************
25418 @node Compatibility and Porting Guide
25419 @appendix Compatibility and Porting Guide
25422 This chapter describes the compatibility issues that may arise between
25423 GNAT and other Ada 83 and Ada 95 compilation systems, and shows how GNAT
25424 can expedite porting
25425 applications developed in other Ada environments.
25428 * Compatibility with Ada 83::
25429 * Implementation-dependent characteristics::
25430 * Compatibility with Other Ada 95 Systems::
25431 * Representation Clauses::
25432 * Compatibility with DEC Ada 83::
25434 * Transitioning from Alpha to Integrity OpenVMS::
25438 @node Compatibility with Ada 83
25439 @section Compatibility with Ada 83
25440 @cindex Compatibility (between Ada 83 and Ada 95)
25443 Ada 95 is designed to be highly upwards compatible with Ada 83. In
25444 particular, the design intention is that the difficulties associated
25445 with moving from Ada 83 to Ada 95 should be no greater than those
25446 that occur when moving from one Ada 83 system to another.
25448 However, there are a number of points at which there are minor
25449 incompatibilities. The @cite{Ada 95 Annotated Reference Manual} contains
25450 full details of these issues,
25451 and should be consulted for a complete treatment.
25453 following subsections treat the most likely issues to be encountered.
25456 * Legal Ada 83 programs that are illegal in Ada 95::
25457 * More deterministic semantics::
25458 * Changed semantics::
25459 * Other language compatibility issues::
25462 @node Legal Ada 83 programs that are illegal in Ada 95
25463 @subsection Legal Ada 83 programs that are illegal in Ada 95
25466 @item Character literals
25467 Some uses of character literals are ambiguous. Since Ada 95 has introduced
25468 @code{Wide_Character} as a new predefined character type, some uses of
25469 character literals that were legal in Ada 83 are illegal in Ada 95.
25471 @smallexample @c ada
25472 for Char in 'A' .. 'Z' loop ... end loop;
25475 The problem is that @code{'A'} and @code{'Z'} could be from either
25476 @code{Character} or @code{Wide_Character}. The simplest correction
25477 is to make the type explicit; e.g.:
25478 @smallexample @c ada
25479 for Char in Character range 'A' .. 'Z' loop ... end loop;
25482 @item New reserved words
25483 The identifiers @code{abstract}, @code{aliased}, @code{protected},
25484 @code{requeue}, @code{tagged}, and @code{until} are reserved in Ada 95.
25485 Existing Ada 83 code using any of these identifiers must be edited to
25486 use some alternative name.
25488 @item Freezing rules
25489 The rules in Ada 95 are slightly different with regard to the point at
25490 which entities are frozen, and representation pragmas and clauses are
25491 not permitted past the freeze point. This shows up most typically in
25492 the form of an error message complaining that a representation item
25493 appears too late, and the appropriate corrective action is to move
25494 the item nearer to the declaration of the entity to which it refers.
25496 A particular case is that representation pragmas
25499 extended DEC Ada 83 compatibility pragmas such as @code{Export_Procedure})
25501 cannot be applied to a subprogram body. If necessary, a separate subprogram
25502 declaration must be introduced to which the pragma can be applied.
25504 @item Optional bodies for library packages
25505 In Ada 83, a package that did not require a package body was nevertheless
25506 allowed to have one. This lead to certain surprises in compiling large
25507 systems (situations in which the body could be unexpectedly ignored by the
25508 binder). In Ada 95, if a package does not require a body then it is not
25509 permitted to have a body. To fix this problem, simply remove a redundant
25510 body if it is empty, or, if it is non-empty, introduce a dummy declaration
25511 into the spec that makes the body required. One approach is to add a private
25512 part to the package declaration (if necessary), and define a parameterless
25513 procedure called @code{Requires_Body}, which must then be given a dummy
25514 procedure body in the package body, which then becomes required.
25515 Another approach (assuming that this does not introduce elaboration
25516 circularities) is to add an @code{Elaborate_Body} pragma to the package spec,
25517 since one effect of this pragma is to require the presence of a package body.
25519 @item @code{Numeric_Error} is now the same as @code{Constraint_Error}
25520 In Ada 95, the exception @code{Numeric_Error} is a renaming of
25521 @code{Constraint_Error}.
25522 This means that it is illegal to have separate exception handlers for
25523 the two exceptions. The fix is simply to remove the handler for the
25524 @code{Numeric_Error} case (since even in Ada 83, a compiler was free to raise
25525 @code{Constraint_Error} in place of @code{Numeric_Error} in all cases).
25527 @item Indefinite subtypes in generics
25528 In Ada 83, it was permissible to pass an indefinite type (e.g.@: @code{String})
25529 as the actual for a generic formal private type, but then the instantiation
25530 would be illegal if there were any instances of declarations of variables
25531 of this type in the generic body. In Ada 95, to avoid this clear violation
25532 of the methodological principle known as the ``contract model'',
25533 the generic declaration explicitly indicates whether
25534 or not such instantiations are permitted. If a generic formal parameter
25535 has explicit unknown discriminants, indicated by using @code{(<>)} after the
25536 type name, then it can be instantiated with indefinite types, but no
25537 stand-alone variables can be declared of this type. Any attempt to declare
25538 such a variable will result in an illegality at the time the generic is
25539 declared. If the @code{(<>)} notation is not used, then it is illegal
25540 to instantiate the generic with an indefinite type.
25541 This is the potential incompatibility issue when porting Ada 83 code to Ada 95.
25542 It will show up as a compile time error, and
25543 the fix is usually simply to add the @code{(<>)} to the generic declaration.
25546 @node More deterministic semantics
25547 @subsection More deterministic semantics
25551 Conversions from real types to integer types round away from 0. In Ada 83
25552 the conversion Integer(2.5) could deliver either 2 or 3 as its value. This
25553 implementation freedom was intended to support unbiased rounding in
25554 statistical applications, but in practice it interfered with portability.
25555 In Ada 95 the conversion semantics are unambiguous, and rounding away from 0
25556 is required. Numeric code may be affected by this change in semantics.
25557 Note, though, that this issue is no worse than already existed in Ada 83
25558 when porting code from one vendor to another.
25561 The Real-Time Annex introduces a set of policies that define the behavior of
25562 features that were implementation dependent in Ada 83, such as the order in
25563 which open select branches are executed.
25566 @node Changed semantics
25567 @subsection Changed semantics
25570 The worst kind of incompatibility is one where a program that is legal in
25571 Ada 83 is also legal in Ada 95 but can have an effect in Ada 95 that was not
25572 possible in Ada 83. Fortunately this is extremely rare, but the one
25573 situation that you should be alert to is the change in the predefined type
25574 @code{Character} from 7-bit ASCII to 8-bit Latin-1.
25577 @item range of @code{Character}
25578 The range of @code{Standard.Character} is now the full 256 characters
25579 of Latin-1, whereas in most Ada 83 implementations it was restricted
25580 to 128 characters. Although some of the effects of
25581 this change will be manifest in compile-time rejection of legal
25582 Ada 83 programs it is possible for a working Ada 83 program to have
25583 a different effect in Ada 95, one that was not permitted in Ada 83.
25584 As an example, the expression
25585 @code{Character'Pos(Character'Last)} returned @code{127} in Ada 83 and now
25586 delivers @code{255} as its value.
25587 In general, you should look at the logic of any
25588 character-processing Ada 83 program and see whether it needs to be adapted
25589 to work correctly with Latin-1. Note that the predefined Ada 95 API has a
25590 character handling package that may be relevant if code needs to be adapted
25591 to account for the additional Latin-1 elements.
25592 The desirable fix is to
25593 modify the program to accommodate the full character set, but in some cases
25594 it may be convenient to define a subtype or derived type of Character that
25595 covers only the restricted range.
25599 @node Other language compatibility issues
25600 @subsection Other language compatibility issues
25602 @item @option{-gnat83 switch}
25603 All implementations of GNAT provide a switch that causes GNAT to operate
25604 in Ada 83 mode. In this mode, some but not all compatibility problems
25605 of the type described above are handled automatically. For example, the
25606 new Ada 95 reserved words are treated simply as identifiers as in Ada 83.
25608 in practice, it is usually advisable to make the necessary modifications
25609 to the program to remove the need for using this switch.
25610 See @ref{Compiling Different Versions of Ada}.
25612 @item Support for removed Ada 83 pragmas and attributes
25613 A number of pragmas and attributes from Ada 83 have been removed from Ada 95,
25614 generally because they have been replaced by other mechanisms. Ada 95
25615 compilers are allowed, but not required, to implement these missing
25616 elements. In contrast with some other Ada 95 compilers, GNAT implements all
25617 such pragmas and attributes, eliminating this compatibility concern. These
25618 include @code{pragma Interface} and the floating point type attributes
25619 (@code{Emax}, @code{Mantissa}, etc.), among other items.
25622 @node Implementation-dependent characteristics
25623 @section Implementation-dependent characteristics
25625 Although the Ada language defines the semantics of each construct as
25626 precisely as practical, in some situations (for example for reasons of
25627 efficiency, or where the effect is heavily dependent on the host or target
25628 platform) the implementation is allowed some freedom. In porting Ada 83
25629 code to GNAT, you need to be aware of whether / how the existing code
25630 exercised such implementation dependencies. Such characteristics fall into
25631 several categories, and GNAT offers specific support in assisting the
25632 transition from certain Ada 83 compilers.
25635 * Implementation-defined pragmas::
25636 * Implementation-defined attributes::
25638 * Elaboration order::
25639 * Target-specific aspects::
25642 @node Implementation-defined pragmas
25643 @subsection Implementation-defined pragmas
25646 Ada compilers are allowed to supplement the language-defined pragmas, and
25647 these are a potential source of non-portability. All GNAT-defined pragmas
25648 are described in the GNAT Reference Manual, and these include several that
25649 are specifically intended to correspond to other vendors' Ada 83 pragmas.
25650 For migrating from VADS, the pragma @code{Use_VADS_Size} may be useful.
25652 compatibility with DEC Ada 83, GNAT supplies the pragmas
25653 @code{Extend_System}, @code{Ident}, @code{Inline_Generic},
25654 @code{Interface_Name}, @code{Passive}, @code{Suppress_All},
25655 and @code{Volatile}.
25656 Other relevant pragmas include @code{External} and @code{Link_With}.
25657 Some vendor-specific
25658 Ada 83 pragmas (@code{Share_Generic}, @code{Subtitle}, and @code{Title}) are
25660 avoiding compiler rejection of units that contain such pragmas; they are not
25661 relevant in a GNAT context and hence are not otherwise implemented.
25663 @node Implementation-defined attributes
25664 @subsection Implementation-defined attributes
25666 Analogous to pragmas, the set of attributes may be extended by an
25667 implementation. All GNAT-defined attributes are described in the
25668 @cite{GNAT Reference Manual}, and these include several that are specifically
25670 to correspond to other vendors' Ada 83 attributes. For migrating from VADS,
25671 the attribute @code{VADS_Size} may be useful. For compatibility with DEC
25672 Ada 83, GNAT supplies the attributes @code{Bit}, @code{Machine_Size} and
25676 @subsection Libraries
25678 Vendors may supply libraries to supplement the standard Ada API. If Ada 83
25679 code uses vendor-specific libraries then there are several ways to manage
25683 If the source code for the libraries (specifications and bodies) are
25684 available, then the libraries can be migrated in the same way as the
25687 If the source code for the specifications but not the bodies are
25688 available, then you can reimplement the bodies.
25690 Some new Ada 95 features obviate the need for library support. For
25691 example most Ada 83 vendors supplied a package for unsigned integers. The
25692 Ada 95 modular type feature is the preferred way to handle this need, so
25693 instead of migrating or reimplementing the unsigned integer package it may
25694 be preferable to retrofit the application using modular types.
25697 @node Elaboration order
25698 @subsection Elaboration order
25700 The implementation can choose any elaboration order consistent with the unit
25701 dependency relationship. This freedom means that some orders can result in
25702 Program_Error being raised due to an ``Access Before Elaboration'': an attempt
25703 to invoke a subprogram its body has been elaborated, or to instantiate a
25704 generic before the generic body has been elaborated. By default GNAT
25705 attempts to choose a safe order (one that will not encounter access before
25706 elaboration problems) by implicitly inserting Elaborate_All pragmas where
25707 needed. However, this can lead to the creation of elaboration circularities
25708 and a resulting rejection of the program by gnatbind. This issue is
25709 thoroughly described in @ref{Elaboration Order Handling in GNAT}.
25710 In brief, there are several
25711 ways to deal with this situation:
25715 Modify the program to eliminate the circularities, e.g. by moving
25716 elaboration-time code into explicitly-invoked procedures
25718 Constrain the elaboration order by including explicit @code{Elaborate_Body} or
25719 @code{Elaborate} pragmas, and then inhibit the generation of implicit
25720 @code{Elaborate_All}
25721 pragmas either globally (as an effect of the @option{-gnatE} switch) or locally
25722 (by selectively suppressing elaboration checks via pragma
25723 @code{Suppress(Elaboration_Check)} when it is safe to do so).
25726 @node Target-specific aspects
25727 @subsection Target-specific aspects
25729 Low-level applications need to deal with machine addresses, data
25730 representations, interfacing with assembler code, and similar issues. If
25731 such an Ada 83 application is being ported to different target hardware (for
25732 example where the byte endianness has changed) then you will need to
25733 carefully examine the program logic; the porting effort will heavily depend
25734 on the robustness of the original design. Moreover, Ada 95 is sometimes
25735 incompatible with typical Ada 83 compiler practices regarding implicit
25736 packing, the meaning of the Size attribute, and the size of access values.
25737 GNAT's approach to these issues is described in @ref{Representation Clauses}.
25739 @node Compatibility with Other Ada 95 Systems
25740 @section Compatibility with Other Ada 95 Systems
25743 Providing that programs avoid the use of implementation dependent and
25744 implementation defined features of Ada 95, as documented in the Ada 95
25745 reference manual, there should be a high degree of portability between
25746 GNAT and other Ada 95 systems. The following are specific items which
25747 have proved troublesome in moving GNAT programs to other Ada 95
25748 compilers, but do not affect porting code to GNAT@.
25751 @item Ada 83 Pragmas and Attributes
25752 Ada 95 compilers are allowed, but not required, to implement the missing
25753 Ada 83 pragmas and attributes that are no longer defined in Ada 95.
25754 GNAT implements all such pragmas and attributes, eliminating this as
25755 a compatibility concern, but some other Ada 95 compilers reject these
25756 pragmas and attributes.
25758 @item Special-needs Annexes
25759 GNAT implements the full set of special needs annexes. At the
25760 current time, it is the only Ada 95 compiler to do so. This means that
25761 programs making use of these features may not be portable to other Ada
25762 95 compilation systems.
25764 @item Representation Clauses
25765 Some other Ada 95 compilers implement only the minimal set of
25766 representation clauses required by the Ada 95 reference manual. GNAT goes
25767 far beyond this minimal set, as described in the next section.
25770 @node Representation Clauses
25771 @section Representation Clauses
25774 The Ada 83 reference manual was quite vague in describing both the minimal
25775 required implementation of representation clauses, and also their precise
25776 effects. The Ada 95 reference manual is much more explicit, but the minimal
25777 set of capabilities required in Ada 95 is quite limited.
25779 GNAT implements the full required set of capabilities described in the
25780 Ada 95 reference manual, but also goes much beyond this, and in particular
25781 an effort has been made to be compatible with existing Ada 83 usage to the
25782 greatest extent possible.
25784 A few cases exist in which Ada 83 compiler behavior is incompatible with
25785 requirements in the Ada 95 reference manual. These are instances of
25786 intentional or accidental dependence on specific implementation dependent
25787 characteristics of these Ada 83 compilers. The following is a list of
25788 the cases most likely to arise in existing legacy Ada 83 code.
25791 @item Implicit Packing
25792 Some Ada 83 compilers allowed a Size specification to cause implicit
25793 packing of an array or record. This could cause expensive implicit
25794 conversions for change of representation in the presence of derived
25795 types, and the Ada design intends to avoid this possibility.
25796 Subsequent AI's were issued to make it clear that such implicit
25797 change of representation in response to a Size clause is inadvisable,
25798 and this recommendation is represented explicitly in the Ada 95 RM
25799 as implementation advice that is followed by GNAT@.
25800 The problem will show up as an error
25801 message rejecting the size clause. The fix is simply to provide
25802 the explicit pragma @code{Pack}, or for more fine tuned control, provide
25803 a Component_Size clause.
25805 @item Meaning of Size Attribute
25806 The Size attribute in Ada 95 for discrete types is defined as being the
25807 minimal number of bits required to hold values of the type. For example,
25808 on a 32-bit machine, the size of Natural will typically be 31 and not
25809 32 (since no sign bit is required). Some Ada 83 compilers gave 31, and
25810 some 32 in this situation. This problem will usually show up as a compile
25811 time error, but not always. It is a good idea to check all uses of the
25812 'Size attribute when porting Ada 83 code. The GNAT specific attribute
25813 Object_Size can provide a useful way of duplicating the behavior of
25814 some Ada 83 compiler systems.
25816 @item Size of Access Types
25817 A common assumption in Ada 83 code is that an access type is in fact a pointer,
25818 and that therefore it will be the same size as a System.Address value. This
25819 assumption is true for GNAT in most cases with one exception. For the case of
25820 a pointer to an unconstrained array type (where the bounds may vary from one
25821 value of the access type to another), the default is to use a ``fat pointer'',
25822 which is represented as two separate pointers, one to the bounds, and one to
25823 the array. This representation has a number of advantages, including improved
25824 efficiency. However, it may cause some difficulties in porting existing Ada 83
25825 code which makes the assumption that, for example, pointers fit in 32 bits on
25826 a machine with 32-bit addressing.
25828 To get around this problem, GNAT also permits the use of ``thin pointers'' for
25829 access types in this case (where the designated type is an unconstrained array
25830 type). These thin pointers are indeed the same size as a System.Address value.
25831 To specify a thin pointer, use a size clause for the type, for example:
25833 @smallexample @c ada
25834 type X is access all String;
25835 for X'Size use Standard'Address_Size;
25839 which will cause the type X to be represented using a single pointer.
25840 When using this representation, the bounds are right behind the array.
25841 This representation is slightly less efficient, and does not allow quite
25842 such flexibility in the use of foreign pointers or in using the
25843 Unrestricted_Access attribute to create pointers to non-aliased objects.
25844 But for any standard portable use of the access type it will work in
25845 a functionally correct manner and allow porting of existing code.
25846 Note that another way of forcing a thin pointer representation
25847 is to use a component size clause for the element size in an array,
25848 or a record representation clause for an access field in a record.
25851 @node Compatibility with DEC Ada 83
25852 @section Compatibility with DEC Ada 83
25855 The VMS version of GNAT fully implements all the pragmas and attributes
25856 provided by DEC Ada 83, as well as providing the standard DEC Ada 83
25857 libraries, including Starlet. In addition, data layouts and parameter
25858 passing conventions are highly compatible. This means that porting
25859 existing DEC Ada 83 code to GNAT in VMS systems should be easier than
25860 most other porting efforts. The following are some of the most
25861 significant differences between GNAT and DEC Ada 83.
25864 @item Default floating-point representation
25865 In GNAT, the default floating-point format is IEEE, whereas in DEC Ada 83,
25866 it is VMS format. GNAT does implement the necessary pragmas
25867 (Long_Float, Float_Representation) for changing this default.
25870 The package System in GNAT exactly corresponds to the definition in the
25871 Ada 95 reference manual, which means that it excludes many of the
25872 DEC Ada 83 extensions. However, a separate package Aux_DEC is provided
25873 that contains the additional definitions, and a special pragma,
25874 Extend_System allows this package to be treated transparently as an
25875 extension of package System.
25878 The definitions provided by Aux_DEC are exactly compatible with those
25879 in the DEC Ada 83 version of System, with one exception.
25880 DEC Ada provides the following declarations:
25882 @smallexample @c ada
25883 TO_ADDRESS (INTEGER)
25884 TO_ADDRESS (UNSIGNED_LONGWORD)
25885 TO_ADDRESS (universal_integer)
25889 The version of TO_ADDRESS taking a universal integer argument is in fact
25890 an extension to Ada 83 not strictly compatible with the reference manual.
25891 In GNAT, we are constrained to be exactly compatible with the standard,
25892 and this means we cannot provide this capability. In DEC Ada 83, the
25893 point of this definition is to deal with a call like:
25895 @smallexample @c ada
25896 TO_ADDRESS (16#12777#);
25900 Normally, according to the Ada 83 standard, one would expect this to be
25901 ambiguous, since it matches both the INTEGER and UNSIGNED_LONGWORD forms
25902 of TO_ADDRESS@. However, in DEC Ada 83, there is no ambiguity, since the
25903 definition using universal_integer takes precedence.
25905 In GNAT, since the version with universal_integer cannot be supplied, it is
25906 not possible to be 100% compatible. Since there are many programs using
25907 numeric constants for the argument to TO_ADDRESS, the decision in GNAT was
25908 to change the name of the function in the UNSIGNED_LONGWORD case, so the
25909 declarations provided in the GNAT version of AUX_Dec are:
25911 @smallexample @c ada
25912 function To_Address (X : Integer) return Address;
25913 pragma Pure_Function (To_Address);
25915 function To_Address_Long (X : Unsigned_Longword)
25917 pragma Pure_Function (To_Address_Long);
25921 This means that programs using TO_ADDRESS for UNSIGNED_LONGWORD must
25922 change the name to TO_ADDRESS_LONG@.
25924 @item Task_Id values
25925 The Task_Id values assigned will be different in the two systems, and GNAT
25926 does not provide a specified value for the Task_Id of the environment task,
25927 which in GNAT is treated like any other declared task.
25930 For full details on these and other less significant compatibility issues,
25931 see appendix E of the Digital publication entitled @cite{DEC Ada, Technical
25932 Overview and Comparison on DIGITAL Platforms}.
25934 For GNAT running on other than VMS systems, all the DEC Ada 83 pragmas and
25935 attributes are recognized, although only a subset of them can sensibly
25936 be implemented. The description of pragmas in this reference manual
25937 indicates whether or not they are applicable to non-VMS systems.
25941 @node Transitioning from Alpha to Integrity OpenVMS
25942 @section Transitioning from Alpha to Integrity OpenVMS
25945 * Introduction to transitioning::
25946 * Migration of 32 bit code::
25947 * Taking advantage of 64 bit addressing::
25948 * Technical details::
25951 @node Introduction to transitioning
25952 @subsection Introduction to transitioning
25955 This guide is meant to assist users of GNAT Pro
25956 for Alpha OpenVMS who are planning to transition to the IA64 architecture.
25957 GNAT Pro for Open VMS Integrity has been designed to meet
25962 Providing a full conforming implementation of the Ada 95 language
25965 Allowing maximum backward compatibility, thus easing migration of existing
25969 Supplying a path for exploiting the full IA64 address range
25973 Ada's strong typing semantics has made it
25974 impractical to have different 32-bit and 64-bit modes. As soon as
25975 one object could possibly be outside the 32-bit address space, this
25976 would make it necessary for the @code{System.Address} type to be 64 bits.
25977 In particular, this would cause inconsistencies if 32-bit code is
25978 called from 64-bit code that raises an exception.
25980 This issue has been resolved by always using 64-bit addressing
25981 at the system level, but allowing for automatic conversions between
25982 32-bit and 64-bit addresses where required. Thus users who
25983 do not currently require 64-bit addressing capabilities, can
25984 recompile their code with only minimal changes (and indeed
25985 if the code is written in portable Ada, with no assumptions about
25986 the size of the @code{Address} type, then no changes at all are necessary).
25988 this approach provides a simple, gradual upgrade path to future
25989 use of larger memories than available for 32-bit systems.
25990 Also, newly written applications or libraries will by default
25991 be fully compatible with future systems exploiting 64-bit
25992 addressing capabilities present in IA64.
25994 @ref{Migration of 32 bit code}, will focus on porting applications
25995 that do not require more than 2 GB of
25996 addressable memory. This code will be referred to as
25997 @emph{32-bit code}.
25998 For applications intending to exploit the full ia64 address space,
25999 @ref{Taking advantage of 64 bit addressing},
26000 will consider further changes that may be required.
26001 Such code is called @emph{64-bit code} in the
26002 remainder of this guide.
26005 @node Migration of 32 bit code
26006 @subsection Migration of 32-bit code
26011 * Unchecked conversions::
26012 * Predefined constants::
26013 * Single source compatibility::
26014 * Experience with source compatibility::
26017 @node Address types
26018 @subsubsection Address types
26021 To solve the problem of mixing 64-bit and 32-bit addressing,
26022 while maintaining maximum backward compatibility, the following
26023 approach has been taken:
26027 @code{System.Address} always has a size of 64 bits
26030 @code{System.Short_Address} is a 32-bit subtype of @code{System.Address}
26035 Since @code{System.Short_Address} is a subtype of @code{System.Address},
26036 a @code{Short_Address}
26037 may be used where an @code{Address} is required, and vice versa, without
26038 needing explicit type conversions.
26039 By virtue of the Open VMS Integrity parameter passing conventions,
26041 and exported subprograms that have 32-bit address parameters are
26042 compatible with those that have 64-bit address parameters.
26043 (See @ref{Making code 64 bit clean} for details.)
26045 The areas that may need attention are those where record types have
26046 been defined that contain components of the type @code{System.Address}, and
26047 where objects of this type are passed to code expecting a record layout with
26050 Different compilers on different platforms cannot be
26051 expected to represent the same type in the same way,
26052 since alignment constraints
26053 and other system-dependent properties affect the compiler's decision.
26054 For that reason, Ada code
26055 generally uses representation clauses to specify the expected
26056 layout where required.
26058 If such a representation clause uses 32 bits for a component having
26059 the type @code{System.Address}, GNAT Pro for OpenVMS Integrity will detect
26060 that error and produce a specific diagnostic message.
26061 The developer should then determine whether the representation
26062 should be 64 bits or not and make either of two changes:
26063 change the size to 64 bits and leave the type as @code{System.Address}, or
26064 leave the size as 32 bits and change the type to @code{System.Short_Address}.
26065 Since @code{Short_Address} is a subtype of @code{Address}, no changes are
26066 required in any code setting or accessing the field; the compiler will
26067 automatically perform any needed conversions between address
26071 @subsubsection Access types
26074 By default, objects designated by access values are always
26075 allocated in the 32-bit
26076 address space. Thus legacy code will never contain
26077 any objects that are not addressable with 32-bit addresses, and
26078 the compiler will never raise exceptions as result of mixing
26079 32-bit and 64-bit addresses.
26081 However, the access values themselves are represented in 64 bits, for optimum
26082 performance and future compatibility with 64-bit code. As was
26083 the case with @code{System.Address}, the compiler will give an error message
26084 if an object or record component has a representation clause that
26085 requires the access value to fit in 32 bits. In such a situation,
26086 an explicit size clause for the access type, specifying 32 bits,
26087 will have the desired effect.
26089 General access types (declared with @code{access all}) can never be
26090 32 bits, as values of such types must be able to refer to any object
26091 of the designated type,
26092 including objects residing outside the 32-bit address range.
26093 Existing Ada 83 code will not contain such type definitions,
26094 however, since general access types were introduced in Ada 95.
26096 @node Unchecked conversions
26097 @subsubsection Unchecked conversions
26100 In the case of an @code{Unchecked_Conversion} where the source type is a
26101 64-bit access type or the type @code{System.Address}, and the target
26102 type is a 32-bit type, the compiler will generate a warning.
26103 Even though the generated code will still perform the required
26104 conversions, it is highly recommended in these cases to use
26105 respectively a 32-bit access type or @code{System.Short_Address}
26106 as the source type.
26108 @node Predefined constants
26109 @subsubsection Predefined constants
26112 The following predefined constants have changed:
26114 @multitable {@code{System.Address_Size}} {2**32} {2**64}
26115 @item @b{Constant} @tab @b{Old} @tab @b{New}
26116 @item @code{System.Word_Size} @tab 32 @tab 64
26117 @item @code{System.Memory_Size} @tab 2**32 @tab 2**64
26118 @item @code{System.Address_Size} @tab 32 @tab 64
26122 If you need to refer to the specific
26123 memory size of a 32-bit implementation, instead of the
26124 actual memory size, use @code{System.Short_Memory_Size}
26125 rather than @code{System.Memory_Size}.
26126 Similarly, references to @code{System.Address_Size} may need
26127 to be replaced by @code{System.Short_Address'Size}.
26128 The program @command{gnatfind} may be useful for locating
26129 references to the above constants, so that you can verify that they
26132 @node Single source compatibility
26133 @subsubsection Single source compatibility
26136 In order to allow the same source code to be compiled on
26137 both Alpha and IA64 platforms, GNAT Pro for Alpha/OpenVMS
26138 defines @code{System.Short_Address} and System.Short_Memory_Size
26139 as aliases of respectively @code{System.Address} and
26140 @code{System.Memory_Size}.
26141 (These aliases also leave the door open for a possible
26142 future ``upgrade'' of OpenVMS Alpha to a 64-bit address space.)
26144 @node Experience with source compatibility
26145 @subsubsection Experience with source compatibility
26148 The Security Server and STARLET provide an interesting ``test case''
26149 for source compatibility issues, since it is in such system code
26150 where assumptions about @code{Address} size might be expected to occur.
26151 Indeed, there were a small number of occasions in the Security Server
26152 file @file{jibdef.ads}
26153 where a representation clause for a record type specified
26154 32 bits for a component of type @code{Address}.
26155 All of these errors were detected by the compiler.
26156 The repair was obvious and immediate; to simply replace @code{Address} by
26157 @code{Short_Address}.
26159 In the case of STARLET, there were several record types that should
26160 have had representation clauses but did not. In these record types
26161 there was an implicit assumption that an @code{Address} value occupied
26163 These compiled without error, but their usage resulted in run-time error
26164 returns from STARLET system calls.
26165 To assist in the compile-time detection of such situations, we
26166 plan to include a switch to generate a warning message when a
26167 record component is of type @code{Address}.
26170 @c ****************************************
26171 @node Taking advantage of 64 bit addressing
26172 @subsection Taking advantage of 64-bit addressing
26175 * Making code 64 bit clean::
26176 * Allocating memory from the 64 bit storage pool::
26177 * Restrictions on use of 64 bit objects::
26178 * Using 64 bit storage pools by default::
26179 * General access types::
26180 * STARLET and other predefined libraries::
26183 @node Making code 64 bit clean
26184 @subsubsection Making code 64-bit clean
26187 In order to prevent problems that may occur when (parts of) a
26188 system start using memory outside the 32-bit address range,
26189 we recommend some additional guidelines:
26193 For imported subprograms that take parameters of the
26194 type @code{System.Address}, ensure that these subprograms can
26195 indeed handle 64-bit addresses. If not, or when in doubt,
26196 change the subprogram declaration to specify
26197 @code{System.Short_Address} instead.
26200 Resolve all warnings related to size mismatches in
26201 unchecked conversions. Failing to do so causes
26202 erroneous execution if the source object is outside
26203 the 32-bit address space.
26206 (optional) Explicitly use the 32-bit storage pool
26207 for access types used in a 32-bit context, or use
26208 generic access types where possible
26209 (@pxref{Restrictions on use of 64 bit objects}).
26213 If these rules are followed, the compiler will automatically insert
26214 any necessary checks to ensure that no addresses or access values
26215 passed to 32-bit code ever refer to objects outside the 32-bit
26217 Any attempt to do this will raise @code{Constraint_Error}.
26219 @node Allocating memory from the 64 bit storage pool
26220 @subsubsection Allocating memory from the 64-bit storage pool
26223 For any access type @code{T} that potentially requires memory allocations
26224 beyond the 32-bit address space,
26225 use the following representation clause:
26227 @smallexample @c ada
26228 for T'Storage_Pool use System.Pool_64;
26232 @node Restrictions on use of 64 bit objects
26233 @subsubsection Restrictions on use of 64-bit objects
26236 Taking the address of an object allocated from a 64-bit storage pool,
26237 and then passing this address to a subprogram expecting
26238 @code{System.Short_Address},
26239 or assigning it to a variable of type @code{Short_Address}, will cause
26240 @code{Constraint_Error} to be raised. In case the code is not 64-bit clean
26241 (@pxref{Making code 64 bit clean}), or checks are suppressed,
26242 no exception is raised and execution
26243 will become erroneous.
26245 @node Using 64 bit storage pools by default
26246 @subsubsection Using 64-bit storage pools by default
26249 In some cases it may be desirable to have the compiler allocate
26250 from 64-bit storage pools by default. This may be the case for
26251 libraries that are 64-bit clean, but may be used in both 32-bit
26252 and 64-bit contexts. For these cases the following configuration
26253 pragma may be specified:
26255 @smallexample @c ada
26256 pragma Pool_64_Default;
26260 Any code compiled in the context of this pragma will by default
26261 use the @code{System.Pool_64} storage pool. This default may be overridden
26262 for a specific access type @code{T} by the representation clause:
26264 @smallexample @c ada
26265 for T'Storage_Pool use System.Pool_32;
26269 Any object whose address may be passed to a subprogram with a
26270 @code{Short_Address} argument, or assigned to a variable of type
26271 @code{Short_Address}, needs to be allocated from this pool.
26273 @node General access types
26274 @subsubsection General access types
26277 Objects designated by access values from a
26278 general access type (declared with @code{access all}) are never allocated
26279 from a 64-bit storage pool. Code that uses general access types will
26280 accept objects allocated in either 32-bit or 64-bit address spaces,
26281 but never allocate objects outside the 32-bit address space.
26282 Using general access types ensures maximum compatibility with both
26283 32-bit and 64-bit code.
26286 @node STARLET and other predefined libraries
26287 @subsubsection STARLET and other predefined libraries
26290 All code that comes as part of GNAT is 64-bit clean, but the
26291 restrictions given in @ref{Restrictions on use of 64 bit objects},
26292 still apply. Look at the package
26293 specifications to see in which contexts objects allocated
26294 in 64-bit address space are acceptable.
26296 @node Technical details
26297 @subsection Technical details
26300 GNAT Pro for Open VMS Integrity takes advantage of the freedom given in the Ada
26301 standard with respect to the type of @code{System.Address}. Previous versions
26302 of GNAT Pro have defined this type as private and implemented it as
26305 In order to allow defining @code{System.Short_Address} as a proper subtype,
26306 and to match the implicit sign extension in parameter passing,
26307 in GNAT Pro for Open VMS Integrity, @code{System.Address} is defined as a
26308 visible (i.e., non-private) integer type.
26309 Standard operations on the type, such as the binary operators ``+'', ``-'',
26310 etc., that take @code{Address} operands and return an @code{Address} result,
26311 have been hidden by declaring these
26312 @code{abstract}, an Ada 95 feature that helps avoid the potential ambiguities
26313 that would otherwise result from overloading.
26314 (Note that, although @code{Address} is a visible integer type,
26315 good programming practice dictates against exploiting the type's
26316 integer properties such as literals, since this will compromise
26319 Defining @code{Address} as a visible integer type helps achieve
26320 maximum compatibility for existing Ada code,
26321 without sacrificing the capabilities of the IA64 architecture.
26325 @c ************************************************
26327 @node Microsoft Windows Topics
26328 @appendix Microsoft Windows Topics
26334 This chapter describes topics that are specific to the Microsoft Windows
26335 platforms (NT, 2000, and XP Professional).
26338 * Using GNAT on Windows::
26339 * Using a network installation of GNAT::
26340 * CONSOLE and WINDOWS subsystems::
26341 * Temporary Files::
26342 * Mixed-Language Programming on Windows::
26343 * Windows Calling Conventions::
26344 * Introduction to Dynamic Link Libraries (DLLs)::
26345 * Using DLLs with GNAT::
26346 * Building DLLs with GNAT::
26347 * Building DLLs with GNAT Project files::
26348 * Building DLLs with gnatdll::
26349 * GNAT and Windows Resources::
26350 * Debugging a DLL::
26351 * GNAT and COM/DCOM Objects::
26354 @node Using GNAT on Windows
26355 @section Using GNAT on Windows
26358 One of the strengths of the GNAT technology is that its tool set
26359 (@command{gcc}, @command{gnatbind}, @command{gnatlink}, @command{gnatmake}, the
26360 @code{gdb} debugger, etc.) is used in the same way regardless of the
26363 On Windows this tool set is complemented by a number of Microsoft-specific
26364 tools that have been provided to facilitate interoperability with Windows
26365 when this is required. With these tools:
26370 You can build applications using the @code{CONSOLE} or @code{WINDOWS}
26374 You can use any Dynamically Linked Library (DLL) in your Ada code (both
26375 relocatable and non-relocatable DLLs are supported).
26378 You can build Ada DLLs for use in other applications. These applications
26379 can be written in a language other than Ada (e.g., C, C++, etc). Again both
26380 relocatable and non-relocatable Ada DLLs are supported.
26383 You can include Windows resources in your Ada application.
26386 You can use or create COM/DCOM objects.
26390 Immediately below are listed all known general GNAT-for-Windows restrictions.
26391 Other restrictions about specific features like Windows Resources and DLLs
26392 are listed in separate sections below.
26397 It is not possible to use @code{GetLastError} and @code{SetLastError}
26398 when tasking, protected records, or exceptions are used. In these
26399 cases, in order to implement Ada semantics, the GNAT run-time system
26400 calls certain Win32 routines that set the last error variable to 0 upon
26401 success. It should be possible to use @code{GetLastError} and
26402 @code{SetLastError} when tasking, protected record, and exception
26403 features are not used, but it is not guaranteed to work.
26406 It is not possible to link against Microsoft libraries except for
26407 import libraries. The library must be built to be compatible with
26408 @file{MSVCRT.LIB} (/MD Microsoft compiler option), @file{LIBC.LIB} and
26409 @file{LIBCMT.LIB} (/ML or /MT Microsoft compiler options) are known to
26410 not be compatible with the GNAT runtime. Even if the library is
26411 compatible with @file{MSVCRT.LIB} it is not guaranteed to work.
26414 When the compilation environment is located on FAT32 drives, users may
26415 experience recompilations of the source files that have not changed if
26416 Daylight Saving Time (DST) state has changed since the last time files
26417 were compiled. NTFS drives do not have this problem.
26420 No components of the GNAT toolset use any entries in the Windows
26421 registry. The only entries that can be created are file associations and
26422 PATH settings, provided the user has chosen to create them at installation
26423 time, as well as some minimal book-keeping information needed to correctly
26424 uninstall or integrate different GNAT products.
26427 @node Using a network installation of GNAT
26428 @section Using a network installation of GNAT
26431 Make sure the system on which GNAT is installed is accessible from the
26432 current machine, i.e. the install location is shared over the network.
26433 Shared resources are accessed on Windows by means of UNC paths, which
26434 have the format @code{\\server\sharename\path}
26436 In order to use such a network installation, simply add the UNC path of the
26437 @file{bin} directory of your GNAT installation in front of your PATH. For
26438 example, if GNAT is installed in @file{\GNAT} directory of a share location
26439 called @file{c-drive} on a machine @file{LOKI}, the following command will
26442 @code{@ @ @ path \\loki\c-drive\gnat\bin;%path%}
26444 Be aware that every compilation using the network installation results in the
26445 transfer of large amounts of data across the network and will likely cause
26446 serious performance penalty.
26448 @node CONSOLE and WINDOWS subsystems
26449 @section CONSOLE and WINDOWS subsystems
26450 @cindex CONSOLE Subsystem
26451 @cindex WINDOWS Subsystem
26455 There are two main subsystems under Windows. The @code{CONSOLE} subsystem
26456 (which is the default subsystem) will always create a console when
26457 launching the application. This is not something desirable when the
26458 application has a Windows GUI. To get rid of this console the
26459 application must be using the @code{WINDOWS} subsystem. To do so
26460 the @option{-mwindows} linker option must be specified.
26463 $ gnatmake winprog -largs -mwindows
26466 @node Temporary Files
26467 @section Temporary Files
26468 @cindex Temporary files
26471 It is possible to control where temporary files gets created by setting
26472 the TMP environment variable. The file will be created:
26475 @item Under the directory pointed to by the TMP environment variable if
26476 this directory exists.
26478 @item Under c:\temp, if the TMP environment variable is not set (or not
26479 pointing to a directory) and if this directory exists.
26481 @item Under the current working directory otherwise.
26485 This allows you to determine exactly where the temporary
26486 file will be created. This is particularly useful in networked
26487 environments where you may not have write access to some
26490 @node Mixed-Language Programming on Windows
26491 @section Mixed-Language Programming on Windows
26494 Developing pure Ada applications on Windows is no different than on
26495 other GNAT-supported platforms. However, when developing or porting an
26496 application that contains a mix of Ada and C/C++, the choice of your
26497 Windows C/C++ development environment conditions your overall
26498 interoperability strategy.
26500 If you use @command{gcc} to compile the non-Ada part of your application,
26501 there are no Windows-specific restrictions that affect the overall
26502 interoperability with your Ada code. If you plan to use
26503 Microsoft tools (e.g. Microsoft Visual C/C++), you should be aware of
26504 the following limitations:
26508 You cannot link your Ada code with an object or library generated with
26509 Microsoft tools if these use the @code{.tls} section (Thread Local
26510 Storage section) since the GNAT linker does not yet support this section.
26513 You cannot link your Ada code with an object or library generated with
26514 Microsoft tools if these use I/O routines other than those provided in
26515 the Microsoft DLL: @code{msvcrt.dll}. This is because the GNAT run time
26516 uses the services of @code{msvcrt.dll} for its I/Os. Use of other I/O
26517 libraries can cause a conflict with @code{msvcrt.dll} services. For
26518 instance Visual C++ I/O stream routines conflict with those in
26523 If you do want to use the Microsoft tools for your non-Ada code and hit one
26524 of the above limitations, you have two choices:
26528 Encapsulate your non Ada code in a DLL to be linked with your Ada
26529 application. In this case, use the Microsoft or whatever environment to
26530 build the DLL and use GNAT to build your executable
26531 (@pxref{Using DLLs with GNAT}).
26534 Or you can encapsulate your Ada code in a DLL to be linked with the
26535 other part of your application. In this case, use GNAT to build the DLL
26536 (@pxref{Building DLLs with GNAT}) and use the Microsoft or whatever
26537 environment to build your executable.
26540 @node Windows Calling Conventions
26541 @section Windows Calling Conventions
26546 * C Calling Convention::
26547 * Stdcall Calling Convention::
26548 * DLL Calling Convention::
26552 When a subprogram @code{F} (caller) calls a subprogram @code{G}
26553 (callee), there are several ways to push @code{G}'s parameters on the
26554 stack and there are several possible scenarios to clean up the stack
26555 upon @code{G}'s return. A calling convention is an agreed upon software
26556 protocol whereby the responsibilities between the caller (@code{F}) and
26557 the callee (@code{G}) are clearly defined. Several calling conventions
26558 are available for Windows:
26562 @code{C} (Microsoft defined)
26565 @code{Stdcall} (Microsoft defined)
26568 @code{DLL} (GNAT specific)
26571 @node C Calling Convention
26572 @subsection @code{C} Calling Convention
26575 This is the default calling convention used when interfacing to C/C++
26576 routines compiled with either @command{gcc} or Microsoft Visual C++.
26578 In the @code{C} calling convention subprogram parameters are pushed on the
26579 stack by the caller from right to left. The caller itself is in charge of
26580 cleaning up the stack after the call. In addition, the name of a routine
26581 with @code{C} calling convention is mangled by adding a leading underscore.
26583 The name to use on the Ada side when importing (or exporting) a routine
26584 with @code{C} calling convention is the name of the routine. For
26585 instance the C function:
26588 int get_val (long);
26592 should be imported from Ada as follows:
26594 @smallexample @c ada
26596 function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
26597 pragma Import (C, Get_Val, External_Name => "get_val");
26602 Note that in this particular case the @code{External_Name} parameter could
26603 have been omitted since, when missing, this parameter is taken to be the
26604 name of the Ada entity in lower case. When the @code{Link_Name} parameter
26605 is missing, as in the above example, this parameter is set to be the
26606 @code{External_Name} with a leading underscore.
26608 When importing a variable defined in C, you should always use the @code{C}
26609 calling convention unless the object containing the variable is part of a
26610 DLL (in which case you should use the @code{DLL} calling convention,
26611 @pxref{DLL Calling Convention}).
26613 @node Stdcall Calling Convention
26614 @subsection @code{Stdcall} Calling Convention
26617 This convention, which was the calling convention used for Pascal
26618 programs, is used by Microsoft for all the routines in the Win32 API for
26619 efficiency reasons. It must be used to import any routine for which this
26620 convention was specified.
26622 In the @code{Stdcall} calling convention subprogram parameters are pushed
26623 on the stack by the caller from right to left. The callee (and not the
26624 caller) is in charge of cleaning the stack on routine exit. In addition,
26625 the name of a routine with @code{Stdcall} calling convention is mangled by
26626 adding a leading underscore (as for the @code{C} calling convention) and a
26627 trailing @code{@@}@code{@i{nn}}, where @i{nn} is the overall size (in
26628 bytes) of the parameters passed to the routine.
26630 The name to use on the Ada side when importing a C routine with a
26631 @code{Stdcall} calling convention is the name of the C routine. The leading
26632 underscore and trailing @code{@@}@code{@i{nn}} are added automatically by
26633 the compiler. For instance the Win32 function:
26636 @b{APIENTRY} int get_val (long);
26640 should be imported from Ada as follows:
26642 @smallexample @c ada
26644 function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
26645 pragma Import (Stdcall, Get_Val);
26646 -- On the x86 a long is 4 bytes, so the Link_Name is "_get_val@@4"
26651 As for the @code{C} calling convention, when the @code{External_Name}
26652 parameter is missing, it is taken to be the name of the Ada entity in lower
26653 case. If instead of writing the above import pragma you write:
26655 @smallexample @c ada
26657 function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
26658 pragma Import (Stdcall, Get_Val, External_Name => "retrieve_val");
26663 then the imported routine is @code{_retrieve_val@@4}. However, if instead
26664 of specifying the @code{External_Name} parameter you specify the
26665 @code{Link_Name} as in the following example:
26667 @smallexample @c ada
26669 function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
26670 pragma Import (Stdcall, Get_Val, Link_Name => "retrieve_val");
26675 then the imported routine is @code{retrieve_val@@4}, that is, there is no
26676 trailing underscore but the appropriate @code{@@}@code{@i{nn}} is always
26677 added at the end of the @code{Link_Name} by the compiler.
26680 Note, that in some special cases a DLL's entry point name lacks a trailing
26681 @code{@@}@code{@i{nn}} while the exported name generated for a call has it.
26682 The @code{gnatdll} tool, which creates the import library for the DLL, is able
26683 to handle those cases (@pxref{Using gnatdll} for the description of
26686 @node DLL Calling Convention
26687 @subsection @code{DLL} Calling Convention
26690 This convention, which is GNAT-specific, must be used when you want to
26691 import in Ada a variables defined in a DLL. For functions and procedures
26692 this convention is equivalent to the @code{Stdcall} convention. As an
26693 example, if a DLL contains a variable defined as:
26700 then, to access this variable from Ada you should write:
26702 @smallexample @c ada
26704 My_Var : Interfaces.C.int;
26705 pragma Import (DLL, My_Var);
26709 The remarks concerning the @code{External_Name} and @code{Link_Name}
26710 parameters given in the previous sections equally apply to the @code{DLL}
26711 calling convention.
26713 @node Introduction to Dynamic Link Libraries (DLLs)
26714 @section Introduction to Dynamic Link Libraries (DLLs)
26718 A Dynamically Linked Library (DLL) is a library that can be shared by
26719 several applications running under Windows. A DLL can contain any number of
26720 routines and variables.
26722 One advantage of DLLs is that you can change and enhance them without
26723 forcing all the applications that depend on them to be relinked or
26724 recompiled. However, you should be aware than all calls to DLL routines are
26725 slower since, as you will understand below, such calls are indirect.
26727 To illustrate the remainder of this section, suppose that an application
26728 wants to use the services of a DLL @file{API.dll}. To use the services
26729 provided by @file{API.dll} you must statically link against the DLL or
26730 an import library which contains a jump table with an entry for each
26731 routine and variable exported by the DLL. In the Microsoft world this
26732 import library is called @file{API.lib}. When using GNAT this import
26733 library is called either @file{libAPI.a} or @file{libapi.a} (names are
26736 After you have linked your application with the DLL or the import library
26737 and you run your application, here is what happens:
26741 Your application is loaded into memory.
26744 The DLL @file{API.dll} is mapped into the address space of your
26745 application. This means that:
26749 The DLL will use the stack of the calling thread.
26752 The DLL will use the virtual address space of the calling process.
26755 The DLL will allocate memory from the virtual address space of the calling
26759 Handles (pointers) can be safely exchanged between routines in the DLL
26760 routines and routines in the application using the DLL.
26764 The entries in the jump table (from the import library @file{libAPI.a}
26765 or @file{API.lib} or automatically created when linking against a DLL)
26766 which is part of your application are initialized with the addresses
26767 of the routines and variables in @file{API.dll}.
26770 If present in @file{API.dll}, routines @code{DllMain} or
26771 @code{DllMainCRTStartup} are invoked. These routines typically contain
26772 the initialization code needed for the well-being of the routines and
26773 variables exported by the DLL.
26777 There is an additional point which is worth mentioning. In the Windows
26778 world there are two kind of DLLs: relocatable and non-relocatable
26779 DLLs. Non-relocatable DLLs can only be loaded at a very specific address
26780 in the target application address space. If the addresses of two
26781 non-relocatable DLLs overlap and these happen to be used by the same
26782 application, a conflict will occur and the application will run
26783 incorrectly. Hence, when possible, it is always preferable to use and
26784 build relocatable DLLs. Both relocatable and non-relocatable DLLs are
26785 supported by GNAT. Note that the @option{-s} linker option (see GNU Linker
26786 User's Guide) removes the debugging symbols from the DLL but the DLL can
26787 still be relocated.
26789 As a side note, an interesting difference between Microsoft DLLs and
26790 Unix shared libraries, is the fact that on most Unix systems all public
26791 routines are exported by default in a Unix shared library, while under
26792 Windows it is possible (but not required) to list exported routines in
26793 a definition file (@pxref{The Definition File}).
26795 @node Using DLLs with GNAT
26796 @section Using DLLs with GNAT
26799 * Creating an Ada Spec for the DLL Services::
26800 * Creating an Import Library::
26804 To use the services of a DLL, say @file{API.dll}, in your Ada application
26809 The Ada spec for the routines and/or variables you want to access in
26810 @file{API.dll}. If not available this Ada spec must be built from the C/C++
26811 header files provided with the DLL.
26814 The import library (@file{libAPI.a} or @file{API.lib}). As previously
26815 mentioned an import library is a statically linked library containing the
26816 import table which will be filled at load time to point to the actual
26817 @file{API.dll} routines. Sometimes you don't have an import library for the
26818 DLL you want to use. The following sections will explain how to build
26819 one. Note that this is optional.
26822 The actual DLL, @file{API.dll}.
26826 Once you have all the above, to compile an Ada application that uses the
26827 services of @file{API.dll} and whose main subprogram is @code{My_Ada_App},
26828 you simply issue the command
26831 $ gnatmake my_ada_app -largs -lAPI
26835 The argument @option{-largs -lAPI} at the end of the @command{gnatmake} command
26836 tells the GNAT linker to look first for a library named @file{API.lib}
26837 (Microsoft-style name) and if not found for a library named @file{libAPI.a}
26838 (GNAT-style name). Note that if the Ada package spec for @file{API.dll}
26839 contains the following pragma
26841 @smallexample @c ada
26842 pragma Linker_Options ("-lAPI");
26846 you do not have to add @option{-largs -lAPI} at the end of the
26847 @command{gnatmake} command.
26849 If any one of the items above is missing you will have to create it
26850 yourself. The following sections explain how to do so using as an
26851 example a fictitious DLL called @file{API.dll}.
26853 @node Creating an Ada Spec for the DLL Services
26854 @subsection Creating an Ada Spec for the DLL Services
26857 A DLL typically comes with a C/C++ header file which provides the
26858 definitions of the routines and variables exported by the DLL. The Ada
26859 equivalent of this header file is a package spec that contains definitions
26860 for the imported entities. If the DLL you intend to use does not come with
26861 an Ada spec you have to generate one such spec yourself. For example if
26862 the header file of @file{API.dll} is a file @file{api.h} containing the
26863 following two definitions:
26875 then the equivalent Ada spec could be:
26877 @smallexample @c ada
26880 with Interfaces.C.Strings;
26885 function Get (Str : C.Strings.Chars_Ptr) return C.int;
26888 pragma Import (C, Get);
26889 pragma Import (DLL, Some_Var);
26896 Note that a variable is @strong{always imported with a DLL convention}. A
26897 function can have @code{C}, @code{Stdcall} or @code{DLL} convention. For
26898 subprograms, the @code{DLL} convention is a synonym of @code{Stdcall}
26899 (@pxref{Windows Calling Conventions}).
26901 @node Creating an Import Library
26902 @subsection Creating an Import Library
26903 @cindex Import library
26906 * The Definition File::
26907 * GNAT-Style Import Library::
26908 * Microsoft-Style Import Library::
26912 If a Microsoft-style import library @file{API.lib} or a GNAT-style
26913 import library @file{libAPI.a} is available with @file{API.dll} you
26914 can skip this section. You can also skip this section if
26915 @file{API.dll} is built with GNU tools as in this case it is possible
26916 to link directly against the DLL. Otherwise read on.
26918 @node The Definition File
26919 @subsubsection The Definition File
26920 @cindex Definition file
26924 As previously mentioned, and unlike Unix systems, the list of symbols
26925 that are exported from a DLL must be provided explicitly in Windows.
26926 The main goal of a definition file is precisely that: list the symbols
26927 exported by a DLL. A definition file (usually a file with a @code{.def}
26928 suffix) has the following structure:
26934 [DESCRIPTION @i{string}]
26944 @item LIBRARY @i{name}
26945 This section, which is optional, gives the name of the DLL.
26947 @item DESCRIPTION @i{string}
26948 This section, which is optional, gives a description string that will be
26949 embedded in the import library.
26952 This section gives the list of exported symbols (procedures, functions or
26953 variables). For instance in the case of @file{API.dll} the @code{EXPORTS}
26954 section of @file{API.def} looks like:
26968 Note that you must specify the correct suffix (@code{@@}@code{@i{nn}})
26969 (@pxref{Windows Calling Conventions}) for a Stdcall
26970 calling convention function in the exported symbols list.
26973 There can actually be other sections in a definition file, but these
26974 sections are not relevant to the discussion at hand.
26976 @node GNAT-Style Import Library
26977 @subsubsection GNAT-Style Import Library
26980 To create a static import library from @file{API.dll} with the GNAT tools
26981 you should proceed as follows:
26985 Create the definition file @file{API.def} (@pxref{The Definition File}).
26986 For that use the @code{dll2def} tool as follows:
26989 $ dll2def API.dll > API.def
26993 @code{dll2def} is a very simple tool: it takes as input a DLL and prints
26994 to standard output the list of entry points in the DLL. Note that if
26995 some routines in the DLL have the @code{Stdcall} convention
26996 (@pxref{Windows Calling Conventions}) with stripped @code{@@}@i{nn}
26997 suffix then you'll have to edit @file{api.def} to add it, and specify
26998 @code{-k} to @code{gnatdll} when creating the import library.
27001 Here are some hints to find the right @code{@@}@i{nn} suffix.
27005 If you have the Microsoft import library (.lib), it is possible to get
27006 the right symbols by using Microsoft @code{dumpbin} tool (see the
27007 corresponding Microsoft documentation for further details).
27010 $ dumpbin /exports api.lib
27014 If you have a message about a missing symbol at link time the compiler
27015 tells you what symbol is expected. You just have to go back to the
27016 definition file and add the right suffix.
27020 Build the import library @code{libAPI.a}, using @code{gnatdll}
27021 (@pxref{Using gnatdll}) as follows:
27024 $ gnatdll -e API.def -d API.dll
27028 @code{gnatdll} takes as input a definition file @file{API.def} and the
27029 name of the DLL containing the services listed in the definition file
27030 @file{API.dll}. The name of the static import library generated is
27031 computed from the name of the definition file as follows: if the
27032 definition file name is @i{xyz}@code{.def}, the import library name will
27033 be @code{lib}@i{xyz}@code{.a}. Note that in the previous example option
27034 @option{-e} could have been removed because the name of the definition
27035 file (before the ``@code{.def}'' suffix) is the same as the name of the
27036 DLL (@pxref{Using gnatdll} for more information about @code{gnatdll}).
27039 @node Microsoft-Style Import Library
27040 @subsubsection Microsoft-Style Import Library
27043 With GNAT you can either use a GNAT-style or Microsoft-style import
27044 library. A Microsoft import library is needed only if you plan to make an
27045 Ada DLL available to applications developed with Microsoft
27046 tools (@pxref{Mixed-Language Programming on Windows}).
27048 To create a Microsoft-style import library for @file{API.dll} you
27049 should proceed as follows:
27053 Create the definition file @file{API.def} from the DLL. For this use either
27054 the @code{dll2def} tool as described above or the Microsoft @code{dumpbin}
27055 tool (see the corresponding Microsoft documentation for further details).
27058 Build the actual import library using Microsoft's @code{lib} utility:
27061 $ lib -machine:IX86 -def:API.def -out:API.lib
27065 If you use the above command the definition file @file{API.def} must
27066 contain a line giving the name of the DLL:
27073 See the Microsoft documentation for further details about the usage of
27077 @node Building DLLs with GNAT
27078 @section Building DLLs with GNAT
27079 @cindex DLLs, building
27082 This section explain how to build DLLs using the GNAT built-in DLL
27083 support. With the following procedure it is straight forward to build
27084 and use DLLs with GNAT.
27088 @item building object files
27090 The first step is to build all objects files that are to be included
27091 into the DLL. This is done by using the standard @command{gnatmake} tool.
27093 @item building the DLL
27095 To build the DLL you must use @command{gcc}'s @code{-shared}
27096 option. It is quite simple to use this method:
27099 $ gcc -shared -o api.dll obj1.o obj2.o ...
27102 It is important to note that in this case all symbols found in the
27103 object files are automatically exported. It is possible to restrict
27104 the set of symbols to export by passing to @command{gcc} a definition
27105 file, @pxref{The Definition File}. For example:
27108 $ gcc -shared -o api.dll api.def obj1.o obj2.o ...
27111 If you use a definition file you must export the elaboration procedures
27112 for every package that required one. Elaboration procedures are named
27113 using the package name followed by "_E".
27115 @item preparing DLL to be used
27117 For the DLL to be used by client programs the bodies must be hidden
27118 from it and the .ali set with read-only attribute. This is very important
27119 otherwise GNAT will recompile all packages and will not actually use
27120 the code in the DLL. For example:
27124 $ copy *.ads *.ali api.dll apilib
27125 $ attrib +R apilib\*.ali
27130 At this point it is possible to use the DLL by directly linking
27131 against it. Note that you must use the GNAT shared runtime when using
27132 GNAT shared libraries. This is achieved by using @code{-shared} binder's
27136 $ gnatmake main -Iapilib -bargs -shared -largs -Lapilib -lAPI
27139 @node Building DLLs with GNAT Project files
27140 @section Building DLLs with GNAT Project files
27141 @cindex DLLs, building
27144 There is nothing specific to Windows in this area. @pxref{Library Projects}.
27146 @node Building DLLs with gnatdll
27147 @section Building DLLs with gnatdll
27148 @cindex DLLs, building
27151 * Limitations When Using Ada DLLs from Ada::
27152 * Exporting Ada Entities::
27153 * Ada DLLs and Elaboration::
27154 * Ada DLLs and Finalization::
27155 * Creating a Spec for Ada DLLs::
27156 * Creating the Definition File::
27161 Note that it is preferred to use the built-in GNAT DLL support
27162 (@pxref{Building DLLs with GNAT}) or GNAT Project files
27163 (@pxref{Building DLLs with GNAT Project files}) to build DLLs.
27165 This section explains how to build DLLs containing Ada code using
27166 @code{gnatdll}. These DLLs will be referred to as Ada DLLs in the
27167 remainder of this section.
27169 The steps required to build an Ada DLL that is to be used by Ada as well as
27170 non-Ada applications are as follows:
27174 You need to mark each Ada @i{entity} exported by the DLL with a @code{C} or
27175 @code{Stdcall} calling convention to avoid any Ada name mangling for the
27176 entities exported by the DLL (@pxref{Exporting Ada Entities}). You can
27177 skip this step if you plan to use the Ada DLL only from Ada applications.
27180 Your Ada code must export an initialization routine which calls the routine
27181 @code{adainit} generated by @command{gnatbind} to perform the elaboration of
27182 the Ada code in the DLL (@pxref{Ada DLLs and Elaboration}). The initialization
27183 routine exported by the Ada DLL must be invoked by the clients of the DLL
27184 to initialize the DLL.
27187 When useful, the DLL should also export a finalization routine which calls
27188 routine @code{adafinal} generated by @command{gnatbind} to perform the
27189 finalization of the Ada code in the DLL (@pxref{Ada DLLs and Finalization}).
27190 The finalization routine exported by the Ada DLL must be invoked by the
27191 clients of the DLL when the DLL services are no further needed.
27194 You must provide a spec for the services exported by the Ada DLL in each
27195 of the programming languages to which you plan to make the DLL available.
27198 You must provide a definition file listing the exported entities
27199 (@pxref{The Definition File}).
27202 Finally you must use @code{gnatdll} to produce the DLL and the import
27203 library (@pxref{Using gnatdll}).
27207 Note that a relocatable DLL stripped using the @code{strip} binutils
27208 tool will not be relocatable anymore. To build a DLL without debug
27209 information pass @code{-largs -s} to @code{gnatdll}.
27211 @node Limitations When Using Ada DLLs from Ada
27212 @subsection Limitations When Using Ada DLLs from Ada
27215 When using Ada DLLs from Ada applications there is a limitation users
27216 should be aware of. Because on Windows the GNAT run time is not in a DLL of
27217 its own, each Ada DLL includes a part of the GNAT run time. Specifically,
27218 each Ada DLL includes the services of the GNAT run time that are necessary
27219 to the Ada code inside the DLL. As a result, when an Ada program uses an
27220 Ada DLL there are two independent GNAT run times: one in the Ada DLL and
27221 one in the main program.
27223 It is therefore not possible to exchange GNAT run-time objects between the
27224 Ada DLL and the main Ada program. Example of GNAT run-time objects are file
27225 handles (e.g. @code{Text_IO.File_Type}), tasks types, protected objects
27228 It is completely safe to exchange plain elementary, array or record types,
27229 Windows object handles, etc.
27231 @node Exporting Ada Entities
27232 @subsection Exporting Ada Entities
27233 @cindex Export table
27236 Building a DLL is a way to encapsulate a set of services usable from any
27237 application. As a result, the Ada entities exported by a DLL should be
27238 exported with the @code{C} or @code{Stdcall} calling conventions to avoid
27239 any Ada name mangling. Please note that the @code{Stdcall} convention
27240 should only be used for subprograms, not for variables. As an example here
27241 is an Ada package @code{API}, spec and body, exporting two procedures, a
27242 function, and a variable:
27244 @smallexample @c ada
27247 with Interfaces.C; use Interfaces;
27249 Count : C.int := 0;
27250 function Factorial (Val : C.int) return C.int;
27252 procedure Initialize_API;
27253 procedure Finalize_API;
27254 -- Initialization & Finalization routines. More in the next section.
27256 pragma Export (C, Initialize_API);
27257 pragma Export (C, Finalize_API);
27258 pragma Export (C, Count);
27259 pragma Export (C, Factorial);
27265 @smallexample @c ada
27268 package body API is
27269 function Factorial (Val : C.int) return C.int is
27272 Count := Count + 1;
27273 for K in 1 .. Val loop
27279 procedure Initialize_API is
27281 pragma Import (C, Adainit);
27284 end Initialize_API;
27286 procedure Finalize_API is
27287 procedure Adafinal;
27288 pragma Import (C, Adafinal);
27298 If the Ada DLL you are building will only be used by Ada applications
27299 you do not have to export Ada entities with a @code{C} or @code{Stdcall}
27300 convention. As an example, the previous package could be written as
27303 @smallexample @c ada
27307 Count : Integer := 0;
27308 function Factorial (Val : Integer) return Integer;
27310 procedure Initialize_API;
27311 procedure Finalize_API;
27312 -- Initialization and Finalization routines.
27318 @smallexample @c ada
27321 package body API is
27322 function Factorial (Val : Integer) return Integer is
27323 Fact : Integer := 1;
27325 Count := Count + 1;
27326 for K in 1 .. Val loop
27333 -- The remainder of this package body is unchanged.
27340 Note that if you do not export the Ada entities with a @code{C} or
27341 @code{Stdcall} convention you will have to provide the mangled Ada names
27342 in the definition file of the Ada DLL
27343 (@pxref{Creating the Definition File}).
27345 @node Ada DLLs and Elaboration
27346 @subsection Ada DLLs and Elaboration
27347 @cindex DLLs and elaboration
27350 The DLL that you are building contains your Ada code as well as all the
27351 routines in the Ada library that are needed by it. The first thing a
27352 user of your DLL must do is elaborate the Ada code
27353 (@pxref{Elaboration Order Handling in GNAT}).
27355 To achieve this you must export an initialization routine
27356 (@code{Initialize_API} in the previous example), which must be invoked
27357 before using any of the DLL services. This elaboration routine must call
27358 the Ada elaboration routine @code{adainit} generated by the GNAT binder
27359 (@pxref{Binding with Non-Ada Main Programs}). See the body of
27360 @code{Initialize_Api} for an example. Note that the GNAT binder is
27361 automatically invoked during the DLL build process by the @code{gnatdll}
27362 tool (@pxref{Using gnatdll}).
27364 When a DLL is loaded, Windows systematically invokes a routine called
27365 @code{DllMain}. It would therefore be possible to call @code{adainit}
27366 directly from @code{DllMain} without having to provide an explicit
27367 initialization routine. Unfortunately, it is not possible to call
27368 @code{adainit} from the @code{DllMain} if your program has library level
27369 tasks because access to the @code{DllMain} entry point is serialized by
27370 the system (that is, only a single thread can execute ``through'' it at a
27371 time), which means that the GNAT run time will deadlock waiting for the
27372 newly created task to complete its initialization.
27374 @node Ada DLLs and Finalization
27375 @subsection Ada DLLs and Finalization
27376 @cindex DLLs and finalization
27379 When the services of an Ada DLL are no longer needed, the client code should
27380 invoke the DLL finalization routine, if available. The DLL finalization
27381 routine is in charge of releasing all resources acquired by the DLL. In the
27382 case of the Ada code contained in the DLL, this is achieved by calling
27383 routine @code{adafinal} generated by the GNAT binder
27384 (@pxref{Binding with Non-Ada Main Programs}).
27385 See the body of @code{Finalize_Api} for an
27386 example. As already pointed out the GNAT binder is automatically invoked
27387 during the DLL build process by the @code{gnatdll} tool
27388 (@pxref{Using gnatdll}).
27390 @node Creating a Spec for Ada DLLs
27391 @subsection Creating a Spec for Ada DLLs
27394 To use the services exported by the Ada DLL from another programming
27395 language (e.g. C), you have to translate the specs of the exported Ada
27396 entities in that language. For instance in the case of @code{API.dll},
27397 the corresponding C header file could look like:
27402 extern int *_imp__count;
27403 #define count (*_imp__count)
27404 int factorial (int);
27410 It is important to understand that when building an Ada DLL to be used by
27411 other Ada applications, you need two different specs for the packages
27412 contained in the DLL: one for building the DLL and the other for using
27413 the DLL. This is because the @code{DLL} calling convention is needed to
27414 use a variable defined in a DLL, but when building the DLL, the variable
27415 must have either the @code{Ada} or @code{C} calling convention. As an
27416 example consider a DLL comprising the following package @code{API}:
27418 @smallexample @c ada
27422 Count : Integer := 0;
27424 -- Remainder of the package omitted.
27431 After producing a DLL containing package @code{API}, the spec that
27432 must be used to import @code{API.Count} from Ada code outside of the
27435 @smallexample @c ada
27440 pragma Import (DLL, Count);
27446 @node Creating the Definition File
27447 @subsection Creating the Definition File
27450 The definition file is the last file needed to build the DLL. It lists
27451 the exported symbols. As an example, the definition file for a DLL
27452 containing only package @code{API} (where all the entities are exported
27453 with a @code{C} calling convention) is:
27468 If the @code{C} calling convention is missing from package @code{API},
27469 then the definition file contains the mangled Ada names of the above
27470 entities, which in this case are:
27479 api__initialize_api
27484 @node Using gnatdll
27485 @subsection Using @code{gnatdll}
27489 * gnatdll Example::
27490 * gnatdll behind the Scenes::
27495 @code{gnatdll} is a tool to automate the DLL build process once all the Ada
27496 and non-Ada sources that make up your DLL have been compiled.
27497 @code{gnatdll} is actually in charge of two distinct tasks: build the
27498 static import library for the DLL and the actual DLL. The form of the
27499 @code{gnatdll} command is
27503 $ gnatdll [@var{switches}] @var{list-of-files} [-largs @var{opts}]
27508 where @i{list-of-files} is a list of ALI and object files. The object
27509 file list must be the exact list of objects corresponding to the non-Ada
27510 sources whose services are to be included in the DLL. The ALI file list
27511 must be the exact list of ALI files for the corresponding Ada sources
27512 whose services are to be included in the DLL. If @i{list-of-files} is
27513 missing, only the static import library is generated.
27516 You may specify any of the following switches to @code{gnatdll}:
27519 @item -a[@var{address}]
27520 @cindex @option{-a} (@code{gnatdll})
27521 Build a non-relocatable DLL at @var{address}. If @var{address} is not
27522 specified the default address @var{0x11000000} will be used. By default,
27523 when this switch is missing, @code{gnatdll} builds relocatable DLL. We
27524 advise the reader to build relocatable DLL.
27526 @item -b @var{address}
27527 @cindex @option{-b} (@code{gnatdll})
27528 Set the relocatable DLL base address. By default the address is
27531 @item -bargs @var{opts}
27532 @cindex @option{-bargs} (@code{gnatdll})
27533 Binder options. Pass @var{opts} to the binder.
27535 @item -d @var{dllfile}
27536 @cindex @option{-d} (@code{gnatdll})
27537 @var{dllfile} is the name of the DLL. This switch must be present for
27538 @code{gnatdll} to do anything. The name of the generated import library is
27539 obtained algorithmically from @var{dllfile} as shown in the following
27540 example: if @var{dllfile} is @code{xyz.dll}, the import library name is
27541 @code{libxyz.a}. The name of the definition file to use (if not specified
27542 by option @option{-e}) is obtained algorithmically from @var{dllfile}
27543 as shown in the following example:
27544 if @var{dllfile} is @code{xyz.dll}, the definition
27545 file used is @code{xyz.def}.
27547 @item -e @var{deffile}
27548 @cindex @option{-e} (@code{gnatdll})
27549 @var{deffile} is the name of the definition file.
27552 @cindex @option{-g} (@code{gnatdll})
27553 Generate debugging information. This information is stored in the object
27554 file and copied from there to the final DLL file by the linker,
27555 where it can be read by the debugger. You must use the
27556 @option{-g} switch if you plan on using the debugger or the symbolic
27560 @cindex @option{-h} (@code{gnatdll})
27561 Help mode. Displays @code{gnatdll} switch usage information.
27564 @cindex @option{-I} (@code{gnatdll})
27565 Direct @code{gnatdll} to search the @var{dir} directory for source and
27566 object files needed to build the DLL.
27567 (@pxref{Search Paths and the Run-Time Library (RTL)}).
27570 @cindex @option{-k} (@code{gnatdll})
27571 Removes the @code{@@}@i{nn} suffix from the import library's exported
27572 names, but keeps them for the link names. You must specify this
27573 option if you want to use a @code{Stdcall} function in a DLL for which
27574 the @code{@@}@i{nn} suffix has been removed. This is the case for most
27575 of the Windows NT DLL for example. This option has no effect when
27576 @option{-n} option is specified.
27578 @item -l @var{file}
27579 @cindex @option{-l} (@code{gnatdll})
27580 The list of ALI and object files used to build the DLL are listed in
27581 @var{file}, instead of being given in the command line. Each line in
27582 @var{file} contains the name of an ALI or object file.
27585 @cindex @option{-n} (@code{gnatdll})
27586 No Import. Do not create the import library.
27589 @cindex @option{-q} (@code{gnatdll})
27590 Quiet mode. Do not display unnecessary messages.
27593 @cindex @option{-v} (@code{gnatdll})
27594 Verbose mode. Display extra information.
27596 @item -largs @var{opts}
27597 @cindex @option{-largs} (@code{gnatdll})
27598 Linker options. Pass @var{opts} to the linker.
27601 @node gnatdll Example
27602 @subsubsection @code{gnatdll} Example
27605 As an example the command to build a relocatable DLL from @file{api.adb}
27606 once @file{api.adb} has been compiled and @file{api.def} created is
27609 $ gnatdll -d api.dll api.ali
27613 The above command creates two files: @file{libapi.a} (the import
27614 library) and @file{api.dll} (the actual DLL). If you want to create
27615 only the DLL, just type:
27618 $ gnatdll -d api.dll -n api.ali
27622 Alternatively if you want to create just the import library, type:
27625 $ gnatdll -d api.dll
27628 @node gnatdll behind the Scenes
27629 @subsubsection @code{gnatdll} behind the Scenes
27632 This section details the steps involved in creating a DLL. @code{gnatdll}
27633 does these steps for you. Unless you are interested in understanding what
27634 goes on behind the scenes, you should skip this section.
27636 We use the previous example of a DLL containing the Ada package @code{API},
27637 to illustrate the steps necessary to build a DLL. The starting point is a
27638 set of objects that will make up the DLL and the corresponding ALI
27639 files. In the case of this example this means that @file{api.o} and
27640 @file{api.ali} are available. To build a relocatable DLL, @code{gnatdll} does
27645 @code{gnatdll} builds the base file (@file{api.base}). A base file gives
27646 the information necessary to generate relocation information for the
27652 $ gnatlink api -o api.jnk -mdll -Wl,--base-file,api.base
27657 In addition to the base file, the @command{gnatlink} command generates an
27658 output file @file{api.jnk} which can be discarded. The @option{-mdll} switch
27659 asks @command{gnatlink} to generate the routines @code{DllMain} and
27660 @code{DllMainCRTStartup} that are called by the Windows loader when the DLL
27661 is loaded into memory.
27664 @code{gnatdll} uses @code{dlltool} (@pxref{Using dlltool}) to build the
27665 export table (@file{api.exp}). The export table contains the relocation
27666 information in a form which can be used during the final link to ensure
27667 that the Windows loader is able to place the DLL anywhere in memory.
27671 $ dlltool --dllname api.dll --def api.def --base-file api.base \
27672 --output-exp api.exp
27677 @code{gnatdll} builds the base file using the new export table. Note that
27678 @command{gnatbind} must be called once again since the binder generated file
27679 has been deleted during the previous call to @command{gnatlink}.
27684 $ gnatlink api -o api.jnk api.exp -mdll
27685 -Wl,--base-file,api.base
27690 @code{gnatdll} builds the new export table using the new base file and
27691 generates the DLL import library @file{libAPI.a}.
27695 $ dlltool --dllname api.dll --def api.def --base-file api.base \
27696 --output-exp api.exp --output-lib libAPI.a
27701 Finally @code{gnatdll} builds the relocatable DLL using the final export
27707 $ gnatlink api api.exp -o api.dll -mdll
27712 @node Using dlltool
27713 @subsubsection Using @code{dlltool}
27716 @code{dlltool} is the low-level tool used by @code{gnatdll} to build
27717 DLLs and static import libraries. This section summarizes the most
27718 common @code{dlltool} switches. The form of the @code{dlltool} command
27722 $ dlltool [@var{switches}]
27726 @code{dlltool} switches include:
27729 @item --base-file @var{basefile}
27730 @cindex @option{--base-file} (@command{dlltool})
27731 Read the base file @var{basefile} generated by the linker. This switch
27732 is used to create a relocatable DLL.
27734 @item --def @var{deffile}
27735 @cindex @option{--def} (@command{dlltool})
27736 Read the definition file.
27738 @item --dllname @var{name}
27739 @cindex @option{--dllname} (@command{dlltool})
27740 Gives the name of the DLL. This switch is used to embed the name of the
27741 DLL in the static import library generated by @code{dlltool} with switch
27742 @option{--output-lib}.
27745 @cindex @option{-k} (@command{dlltool})
27746 Kill @code{@@}@i{nn} from exported names
27747 (@pxref{Windows Calling Conventions}
27748 for a discussion about @code{Stdcall}-style symbols.
27751 @cindex @option{--help} (@command{dlltool})
27752 Prints the @code{dlltool} switches with a concise description.
27754 @item --output-exp @var{exportfile}
27755 @cindex @option{--output-exp} (@command{dlltool})
27756 Generate an export file @var{exportfile}. The export file contains the
27757 export table (list of symbols in the DLL) and is used to create the DLL.
27759 @item --output-lib @i{libfile}
27760 @cindex @option{--output-lib} (@command{dlltool})
27761 Generate a static import library @var{libfile}.
27764 @cindex @option{-v} (@command{dlltool})
27767 @item --as @i{assembler-name}
27768 @cindex @option{--as} (@command{dlltool})
27769 Use @i{assembler-name} as the assembler. The default is @code{as}.
27772 @node GNAT and Windows Resources
27773 @section GNAT and Windows Resources
27774 @cindex Resources, windows
27777 * Building Resources::
27778 * Compiling Resources::
27779 * Using Resources::
27783 Resources are an easy way to add Windows specific objects to your
27784 application. The objects that can be added as resources include:
27813 This section explains how to build, compile and use resources.
27815 @node Building Resources
27816 @subsection Building Resources
27817 @cindex Resources, building
27820 A resource file is an ASCII file. By convention resource files have an
27821 @file{.rc} extension.
27822 The easiest way to build a resource file is to use Microsoft tools
27823 such as @code{imagedit.exe} to build bitmaps, icons and cursors and
27824 @code{dlgedit.exe} to build dialogs.
27825 It is always possible to build an @file{.rc} file yourself by writing a
27828 It is not our objective to explain how to write a resource file. A
27829 complete description of the resource script language can be found in the
27830 Microsoft documentation.
27832 @node Compiling Resources
27833 @subsection Compiling Resources
27836 @cindex Resources, compiling
27839 This section describes how to build a GNAT-compatible (COFF) object file
27840 containing the resources. This is done using the Resource Compiler
27841 @code{windres} as follows:
27844 $ windres -i myres.rc -o myres.o
27848 By default @code{windres} will run @command{gcc} to preprocess the @file{.rc}
27849 file. You can specify an alternate preprocessor (usually named
27850 @file{cpp.exe}) using the @code{windres} @option{--preprocessor}
27851 parameter. A list of all possible options may be obtained by entering
27852 the command @code{windres} @option{--help}.
27854 It is also possible to use the Microsoft resource compiler @code{rc.exe}
27855 to produce a @file{.res} file (binary resource file). See the
27856 corresponding Microsoft documentation for further details. In this case
27857 you need to use @code{windres} to translate the @file{.res} file to a
27858 GNAT-compatible object file as follows:
27861 $ windres -i myres.res -o myres.o
27864 @node Using Resources
27865 @subsection Using Resources
27866 @cindex Resources, using
27869 To include the resource file in your program just add the
27870 GNAT-compatible object file for the resource(s) to the linker
27871 arguments. With @command{gnatmake} this is done by using the @option{-largs}
27875 $ gnatmake myprog -largs myres.o
27878 @node Debugging a DLL
27879 @section Debugging a DLL
27880 @cindex DLL debugging
27883 * Program and DLL Both Built with GCC/GNAT::
27884 * Program Built with Foreign Tools and DLL Built with GCC/GNAT::
27888 Debugging a DLL is similar to debugging a standard program. But
27889 we have to deal with two different executable parts: the DLL and the
27890 program that uses it. We have the following four possibilities:
27894 The program and the DLL are built with @code{GCC/GNAT}.
27896 The program is built with foreign tools and the DLL is built with
27899 The program is built with @code{GCC/GNAT} and the DLL is built with
27905 In this section we address only cases one and two above.
27906 There is no point in trying to debug
27907 a DLL with @code{GNU/GDB}, if there is no GDB-compatible debugging
27908 information in it. To do so you must use a debugger compatible with the
27909 tools suite used to build the DLL.
27911 @node Program and DLL Both Built with GCC/GNAT
27912 @subsection Program and DLL Both Built with GCC/GNAT
27915 This is the simplest case. Both the DLL and the program have @code{GDB}
27916 compatible debugging information. It is then possible to break anywhere in
27917 the process. Let's suppose here that the main procedure is named
27918 @code{ada_main} and that in the DLL there is an entry point named
27922 The DLL (@pxref{Introduction to Dynamic Link Libraries (DLLs)}) and
27923 program must have been built with the debugging information (see GNAT -g
27924 switch). Here are the step-by-step instructions for debugging it:
27927 @item Launch @code{GDB} on the main program.
27933 @item Break on the main procedure and run the program.
27936 (gdb) break ada_main
27941 This step is required to be able to set a breakpoint inside the DLL. As long
27942 as the program is not run, the DLL is not loaded. This has the
27943 consequence that the DLL debugging information is also not loaded, so it is not
27944 possible to set a breakpoint in the DLL.
27946 @item Set a breakpoint inside the DLL
27949 (gdb) break ada_dll
27956 At this stage a breakpoint is set inside the DLL. From there on
27957 you can use the standard approach to debug the whole program
27958 (@pxref{Running and Debugging Ada Programs}).
27960 To break on the @code{DllMain} routine it is not possible to follow
27961 the procedure above. At the time the program stop on @code{ada_main}
27962 the @code{DllMain} routine as already been called. Either you can use
27963 the procedure below @pxref{Debugging the DLL Directly} or this procedure:
27966 @item Launch @code{GDB} on the main program.
27972 @item Load DLL symbols
27975 (gdb) add-sym api.dll
27978 @item Set a breakpoint inside the DLL
27981 (gdb) break ada_dll.adb:45
27984 Note that at this point it is not possible to break using the routine symbol
27985 directly as the program is not yet running. The solution is to break
27986 on the proper line (break in @file{ada_dll.adb} line 45).
27988 @item Start the program
27996 @node Program Built with Foreign Tools and DLL Built with GCC/GNAT
27997 @subsection Program Built with Foreign Tools and DLL Built with GCC/GNAT
28000 * Debugging the DLL Directly::
28001 * Attaching to a Running Process::
28005 In this case things are slightly more complex because it is not possible to
28006 start the main program and then break at the beginning to load the DLL and the
28007 associated DLL debugging information. It is not possible to break at the
28008 beginning of the program because there is no @code{GDB} debugging information,
28009 and therefore there is no direct way of getting initial control. This
28010 section addresses this issue by describing some methods that can be used
28011 to break somewhere in the DLL to debug it.
28014 First suppose that the main procedure is named @code{main} (this is for
28015 example some C code built with Microsoft Visual C) and that there is a
28016 DLL named @code{test.dll} containing an Ada entry point named
28020 The DLL (@pxref{Introduction to Dynamic Link Libraries (DLLs)}) must have
28021 been built with debugging information (see GNAT -g option).
28023 @node Debugging the DLL Directly
28024 @subsubsection Debugging the DLL Directly
28028 Launch the debugger on the DLL.
28034 @item Set a breakpoint on a DLL subroutine.
28037 (gdb) break ada_dll.adb:45
28040 Note that at this point it is not possible to break using the routine symbol
28041 directly as the program is not yet running. The solution is to break
28042 on the proper line (break in @file{ada_dll.adb} line 45).
28045 Specify the executable file to @code{GDB}.
28048 (gdb) exec-file main.exe
28059 This will run the program until it reaches the breakpoint that has been
28060 set. From that point you can use the standard way to debug a program
28061 as described in (@pxref{Running and Debugging Ada Programs}).
28066 It is also possible to debug the DLL by attaching to a running process.
28068 @node Attaching to a Running Process
28069 @subsubsection Attaching to a Running Process
28070 @cindex DLL debugging, attach to process
28073 With @code{GDB} it is always possible to debug a running process by
28074 attaching to it. It is possible to debug a DLL this way. The limitation
28075 of this approach is that the DLL must run long enough to perform the
28076 attach operation. It may be useful for instance to insert a time wasting
28077 loop in the code of the DLL to meet this criterion.
28081 @item Launch the main program @file{main.exe}.
28087 @item Use the Windows @i{Task Manager} to find the process ID. Let's say
28088 that the process PID for @file{main.exe} is 208.
28096 @item Attach to the running process to be debugged.
28102 @item Load the process debugging information.
28105 (gdb) symbol-file main.exe
28108 @item Break somewhere in the DLL.
28111 (gdb) break ada_dll
28114 @item Continue process execution.
28123 This last step will resume the process execution, and stop at
28124 the breakpoint we have set. From there you can use the standard
28125 approach to debug a program as described in
28126 (@pxref{Running and Debugging Ada Programs}).
28128 @node GNAT and COM/DCOM Objects
28129 @section GNAT and COM/DCOM Objects
28134 This section is temporarily left blank.
28138 @c **********************************
28139 @c * GNU Free Documentation License *
28140 @c **********************************
28142 @c GNU Free Documentation License
28144 @node Index,,GNU Free Documentation License, Top
28150 @c Put table of contents at end, otherwise it precedes the "title page" in
28151 @c the .txt version
28152 @c Edit the pdf file to move the contents to the beginning, after the title