gcc/ada/g-trasym.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --             G N A T . T R A C E B A C K . S Y M B O L I C                --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 1999-2006, AdaCore                     --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  Run-time symbolic traceback support
  35
  36 --  Note: this is only available on selected targets. Current targets are:
  37 --  Sparc/Solaris, GNU/Linux, SGI/IRIX, Windows NT, HP-UX, VMS, Tru64.
  38
  39 --  The routines provided in this package assume that your application has
  40 --  been compiled with debugging information turned on, since this information
  41 --  is used to build a symbolic traceback.
  42
  43 --  If you want to retrieve tracebacks from exception occurrences, it is also
  44 --  necessary to invoke the binder with -E switch. Please refer to the gnatbind
  45 --  documentation for more information.
  46
  47 --  Note that it is also possible (and often recommended) to compute symbolic
  48 --  traceback outside the program execution, which in addition allows you
  49 --  to distribute the executable with no debug info:
  50 --
  51 --  - build your executable with debug info
  52 --  - archive this executable
  53 --  - strip a copy of the executable and distribute/deploy this version
  54 --  - at run time, compute absolute traceback (-bargs -E) from your
  55 --    executable and log it using Ada.Exceptions.Exception_Occurrence
  56 --  - off line, compute the symbolic traceback using the executable archived
  57 --    with debug info and addr2line or gdb (using info line *<addr>) on the
  58 --    absolute addresses logged by your application.
  59
  60 --  In order to retrieve symbolic information, functions in this package will
  61 --  read on disk all the debug information of the executable file (found via
  62 --  Argument (0), so any path information needed to read the executable file
  63 --  need to be provided when launching the executable), and load then in
  64 --  memory, causing a significant cpu and memory overhead.
  65
  66 --  On all platforms except VMS, this package is not intended to be used
  67 --  within a shared library, symbolic tracebacks are only supported for the
  68 --  main executable and not for shared libraries. You should consider using
  69 --  gdb to obtain symbolic traceback in such cases.
  70
  71 --  On VMS, there is no restriction on using this facility with shared
  72 --  libraries. However, the OS should be at least v7.3-1 and OS patch
  73 --  VMS731_TRACE-V0100 must be applied in order to use this package.
  74
  75 with Ada.Exceptions; use Ada.Exceptions;
  76
  77 package GNAT.Traceback.Symbolic is
  78    pragma Elaborate_Body;
  79
  80    ------------------------
  81    -- Symbolic_Traceback --
  82    ------------------------
  83
  84    function Symbolic_Traceback (Traceback : Tracebacks_Array) return String;
  85    --  Build a string containing a symbolic traceback of the given call chain
  86
  87    function Symbolic_Traceback (E : Exception_Occurrence) return String;
  88    --  Build string containing symbolic traceback of given exception occurrence
  89
  90 end GNAT.Traceback.Symbolic;