• 1 About This Guide
  • 1.1 What This Guide Contains
  • 1.2 What You Should Know before Reading This Guide
  • 1.3 Related Information
  • 1.4 Conventions
• 2 Getting Started with GNAT
  • 2.1 System Requirements
  • 2.2 Running GNAT
  • 2.3 Running a Simple Ada Program
  • 2.4 Running a Program with Multiple Units
• 3 The GNAT Compilation Model
  • 3.1 Source Representation
  • 3.2 Foreign Language Representation
    • 3.2.1 Latin-1
    • 3.2.2 Other 8-Bit Codes
    • 3.2.3 Wide_Character Encodings
    • 3.2.4 Wide_Wide_Character Encodings
  • 3.3 File Naming Topics and Utilities
    • 3.3.1 File Naming Rules
    • 3.3.2 Using Other File Names
    • 3.3.3 Alternative File Naming Schemes
    • 3.3.4 Handling Arbitrary File Naming Conventions with gnatname
      • 3.3.4.1 Arbitrary File Naming Conventions
      • 3.3.4.2 Running gnatname
      • 3.3.4.3 Switches for gnatname
      • 3.3.4.4 Examples of gnatname Usage
    • 3.3.5 File Name Krunching with gnatkr
      • 3.3.5.1 About gnatkr
      • 3.3.5.2 Using gnatkr
      • 3.3.5.3 Krunching Method
      • 3.3.5.4 Examples of gnatkr Usage
    • 3.3.6 Renaming Files with gnatchop
      • 3.3.6.1 Handling Files with Multiple Units
      • 3.3.6.2 Operating gnatchop in Compilation Mode
      • 3.3.6.3 Command Line for gnatchop
      • 3.3.6.4 Switches for gnatchop
      • 3.3.6.5 Examples of gnatchop Usage
  • 3.4 Configuration Pragmas
    • 3.4.1 Handling of Configuration Pragmas
    • 3.4.2 The Configuration Pragmas Files
  • 3.5 Generating Object Files
  • 3.6 Source Dependencies
  • 3.7 The Ada Library Information Files
  • 3.8 Binding an Ada Program
  • 3.9 GNAT and Libraries
    • 3.9.1 Introduction to Libraries in GNAT
    • 3.9.2 General Ada Libraries
      • 3.9.2.1 Building a library
      • 3.9.2.2 Installing a library
      • 3.9.2.3 Using a library
    • 3.9.3 Stand-alone Ada Libraries
      • 3.9.3.1 Introduction to Stand-alone Libraries
      • 3.9.3.2 Building a Stand-alone Library
      • 3.9.3.3 Creating a Stand-alone Library to be used in a non-Ada context
      • 3.9.3.4 Restrictions in Stand-alone Libraries
    • 3.9.4 Rebuilding the GNAT Run-Time Library
  • 3.10 Conditional Compilation
    • 3.10.1 Modeling Conditional Compilation in Ada
      • 3.10.1.1 Use of Boolean Constants
      • 3.10.1.2 Debugging - A Special Case
      • 3.10.1.3 Conditionalizing Declarations
      • 3.10.1.4 Use of Alternative Implementations
      • 3.10.1.5 Preprocessing
    • 3.10.2 Preprocessing with gnatprep
      • 3.10.2.1 Preprocessing Symbols
      • 3.10.2.2 Using gnatprep
      • 3.10.2.3 Switches for gnatprep
      • 3.10.2.4 Form of Definitions File
      • 3.10.2.5 Form of Input Text for gnatprep
    • 3.10.3 Integrated Preprocessing
  • 3.11 Mixed Language Programming
    • 3.11.1 Interfacing to C
    • 3.11.2 Calling Conventions
    • 3.11.3 Building Mixed Ada and C++ Programs
      • 3.11.3.1 Interfacing to C++
      • 3.11.3.2 Linking a Mixed C++ & Ada Program
      • 3.11.3.3 A Simple Example
      • 3.11.3.4 Interfacing with C++ constructors
      • 3.11.3.5 Interfacing with C++ at the Class Level
    • 3.11.4 Partition-Wide Settings
    • 3.11.5 Generating Ada Bindings for C and C++ headers
      • 3.11.5.1 Running the Binding Generator
      • 3.11.5.2 Generating Bindings for C++ Headers
      • 3.11.5.3 Switches
    • 3.11.6 Generating C Headers for Ada Specifications
      • 3.11.6.1 Running the C Header Generator
  • 3.12 GNAT and Other Compilation Models
    • 3.12.1 Comparison between GNAT and C/C++ Compilation Models
    • 3.12.2 Comparison between GNAT and Conventional Ada Library Models
  • 3.13 Using GNAT Files with External Tools
    • 3.13.1 Using Other Utility Programs with GNAT
    • 3.13.2 The External Symbol Naming Scheme of GNAT
• 4 Building Executable Programs with GNAT
  • 4.1 Building with gnatmake
    • 4.1.1 Running gnatmake
    • 4.1.2 Switches for gnatmake
    • 4.1.3 Mode Switches for gnatmake
    • 4.1.4 Notes on the Command Line
    • 4.1.5 How gnatmake Works
    • 4.1.6 Examples of gnatmake Usage
  • 4.2 Compiling with gcc
    • 4.2.1 Compiling Programs
    • 4.2.2 Search Paths and the Run-Time Library (RTL)
    • 4.2.3 Order of Compilation Issues
    • 4.2.4 Examples
  • 4.3 Compiler Switches
    • 4.3.1 Alphabetical List of All Switches
    • 4.3.2 Output and Error Message Control
    • 4.3.3 Warning Message Control
    • 4.3.4 Info message Control
    • 4.3.5 Debugging and Assertion Control
    • 4.3.6 Validity Checking
    • 4.3.7 Style Checking
    • 4.3.8 Run-Time Checks
    • 4.3.9 Using gcc for Syntax Checking
    • 4.3.10 Using gcc for Semantic Checking
    • 4.3.11 Compiling Different Versions of Ada
    • 4.3.12 Character Set Control
    • 4.3.13 File Naming Control
    • 4.3.14 Subprogram Inlining Control
    • 4.3.15 Auxiliary Output Control
    • 4.3.16 Debugging Control
    • 4.3.17 Exception Handling Control
    • 4.3.18 Units to Sources Mapping Files
    • 4.3.19 Code Generation Control
  • 4.4 Linker Switches
  • 4.5 Binding with gnatbind
    • 4.5.1 Running gnatbind
    • 4.5.2 Switches for gnatbind
      • 4.5.2.1 Consistency-Checking Modes
      • 4.5.2.2 Binder Error Message Control
      • 4.5.2.3 Elaboration Control
      • 4.5.2.4 Output Control
      • 4.5.2.5 Dynamic Allocation Control
      • 4.5.2.6 Binding with Non-Ada Main Programs
      • 4.5.2.7 Binding Programs with No Main Subprogram
    • 4.5.3 Command-Line Access
    • 4.5.4 Search Paths for gnatbind
    • 4.5.5 Examples of gnatbind Usage
  • 4.6 Linking with gnatlink
    • 4.6.1 Running gnatlink
    • 4.6.2 Switches for gnatlink
  • 4.7 Using the GNU make Utility
    • 4.7.1 Using gnatmake in a Makefile
    • 4.7.2 Automatically Creating a List of Directories
    • 4.7.3 Generating the Command Line Switches
    • 4.7.4 Overcoming Command Line Length Limits
  • 4.8 GNAT with the LLVM Back End
• 5 GNAT Utility Programs
  • 5.1 The File Cleanup Utility gnatclean
    • 5.1.1 Running gnatclean
    • 5.1.2 Switches for gnatclean
  • 5.2 The GNAT Library Browser gnatls
    • 5.2.1 Running gnatls
    • 5.2.2 Switches for gnatls
    • 5.2.3 Example of gnatls Usage
• 6 GNAT and Program Execution
  • 6.1 Running and Debugging Ada Programs
    • 6.1.1 The GNAT Debugger GDB
    • 6.1.2 Running GDB
    • 6.1.3 Introduction to GDB Commands
    • 6.1.4 Using Ada Expressions
    • 6.1.5 Calling User-Defined Subprograms
    • 6.1.6 Using the ‘next’ Command in a Function
    • 6.1.7 Stopping When Ada Exceptions Are Raised
    • 6.1.8 Ada Tasks
    • 6.1.9 Debugging Generic Units
    • 6.1.10 Remote Debugging with gdbserver
    • 6.1.11 GNAT Abnormal Termination or Failure to Terminate
    • 6.1.12 Naming Conventions for GNAT Source Files
    • 6.1.13 Getting Internal Debugging Information
    • 6.1.14 Stack Traceback
      • 6.1.14.1 Non-Symbolic Traceback
      • 6.1.14.2 Symbolic Traceback
    • 6.1.15 Pretty-Printers for the GNAT runtime
  • 6.2 Profiling
    • 6.2.1 Profiling an Ada Program with gprof
      • 6.2.1.1 Compilation for profiling
      • 6.2.1.2 Program execution
      • 6.2.1.3 Running gprof
      • 6.2.1.4 Interpretation of profiling results
  • 6.3 Improving Performance
    • 6.3.1 Performance Considerations
      • 6.3.1.1 Controlling Run-Time Checks
      • 6.3.1.2 Use of Restrictions
      • 6.3.1.3 Optimization Levels
      • 6.3.1.4 Debugging Optimized Code
      • 6.3.1.5 Inlining of Subprograms
      • 6.3.1.6 Floating Point Operations
      • 6.3.1.7 Vectorization of loops
      • 6.3.1.8 Other Optimization Switches
      • 6.3.1.9 Optimization and Strict Aliasing
      • 6.3.1.10 Aliased Variables and Optimization
      • 6.3.1.11 Atomic Variables and Optimization
      • 6.3.1.12 Passive Task Optimization
    • 6.3.2 Text_IO Suggestions
    • 6.3.3 Reducing Size of Executables with Unused Subprogram/Data Elimination
      • 6.3.3.1 About unused subprogram/data elimination
      • 6.3.3.2 Compilation options
      • 6.3.3.3 Example of unused subprogram/data elimination
  • 6.4 Overflow Check Handling in GNAT
    • 6.4.1 Background
    • 6.4.2 Management of Overflows in GNAT
    • 6.4.3 Specifying the Desired Mode
    • 6.4.4 Default Settings
    • 6.4.5 Implementation Notes
  • 6.5 Performing Dimensionality Analysis in GNAT
  • 6.6 Stack Related Facilities
    • 6.6.1 Stack Overflow Checking
    • 6.6.2 Static Stack Usage Analysis
    • 6.6.3 Dynamic Stack Usage Analysis
  • 6.7 Memory Management Issues
    • 6.7.1 Some Useful Memory Pools
    • 6.7.2 The GNAT Debug Pool Facility
  • 6.8 Sanitizers for Ada
    • 6.8.1 AddressSanitizer
    • 6.8.2 UndefinedBehaviorSanitizer
    • 6.8.3 Sanitizers in mixed-language applications
• 7 Platform-Specific Information
  • 7.1 Run-Time Libraries
    • 7.1.1 Summary of Run-Time Configurations
  • 7.2 Specifying a Run-Time Library
  • 7.3 GNU/Linux Topics
    • 7.3.1 Required Packages on GNU/Linux
    • 7.3.2 Position Independent Executable (PIE) Enabled by Default on Linux
    • 7.3.3 Choosing the Scheduling Policy with GNU/Linux
    • 7.3.4 A GNU/Linux Debug Quirk
  • 7.4 Microsoft Windows Topics
    • 7.4.1 Using GNAT on Windows
    • 7.4.2 Using a network installation of GNAT
    • 7.4.3 CONSOLE and WINDOWS subsystems
    • 7.4.4 Temporary Files
    • 7.4.5 Disabling Command Line Argument Expansion
    • 7.4.6 Choosing the Scheduling Policy with Windows
    • 7.4.7 Windows Socket Timeouts
    • 7.4.8 Mixed-Language Programming on Windows
      • 7.4.8.1 Windows Calling Conventions
      • 7.4.8.2 C Calling Convention
      • 7.4.8.3 Stdcall Calling Convention
      • 7.4.8.4 Win32 Calling Convention
      • 7.4.8.5 DLL Calling Convention
      • 7.4.8.6 Introduction to Dynamic Link Libraries (DLLs)
      • 7.4.8.7 Using DLLs with GNAT
      • 7.4.8.8 Creating an Ada Spec for the DLL Services
      • 7.4.8.9 Creating an Import Library
      • 7.4.8.10 Building DLLs with GNAT Project files
      • 7.4.8.11 Building DLLs with GNAT
      • 7.4.8.12 Building DLLs with gnatdll
      • 7.4.8.13 Limitations When Using Ada DLLs from Ada
      • 7.4.8.14 Exporting Ada Entities
      • 7.4.8.15 Ada DLLs and Elaboration
      • 7.4.8.16 Ada DLLs and Finalization
      • 7.4.8.17 Creating a Spec for Ada DLLs
      • 7.4.8.18 Creating the Definition File
      • 7.4.8.19 Using gnatdll
      • 7.4.8.20 GNAT and Windows Resources
      • 7.4.8.21 Building Resources
      • 7.4.8.22 Compiling Resources
      • 7.4.8.23 Using Resources
      • 7.4.8.24 Using GNAT DLLs from Microsoft Visual Studio Applications
      • 7.4.8.25 Debugging a DLL
      • 7.4.8.26 Program and DLL Both Built with GCC/GNAT
      • 7.4.8.27 Program Built with Foreign Tools and DLL Built with GCC/GNAT
      • 7.4.8.28 Setting Stack Size from gnatlink
      • 7.4.8.29 Setting Heap Size from gnatlink
    • 7.4.9 Windows Specific Add-Ons
      • 7.4.9.1 Win32Ada
      • 7.4.9.2 wPOSIX
  • 7.5 Mac OS Topics
    • 7.5.1 Codesigning the Debugger
• 8 Example of Binder Output File
• 9 Elaboration Order Handling in GNAT
  • 9.1 Elaboration Code
  • 9.2 Elaboration Order
  • 9.3 Checking the Elaboration Order
  • 9.4 Controlling the Elaboration Order in Ada
  • 9.5 Controlling the Elaboration Order in GNAT
  • 9.6 Mixing Elaboration Models
  • 9.7 ABE Diagnostics
  • 9.8 SPARK Diagnostics
  • 9.9 Elaboration Circularities
  • 9.10 Resolving Elaboration Circularities
  • 9.11 Elaboration-related Compiler Switches
  • 9.12 Summary of Procedures for Elaboration Control
  • 9.13 Inspecting the Chosen Elaboration Order
• 10 Inline Assembler
  • 10.1 Basic Assembler Syntax
  • 10.2 A Simple Example of Inline Assembler
  • 10.3 Output Variables in Inline Assembler
  • 10.4 Input Variables in Inline Assembler
  • 10.5 Inlining Inline Assembler Code
  • 10.6 Other Asm Functionality
    • 10.6.1 The Clobber Parameter
    • 10.6.2 The Volatile Parameter
• 11 GNU Free Documentation License
• Index

Next: About This Guide   [Contents][Index]