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-2012, 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 3,  or (at your option) any later ver- --
14-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
17--                                                                          --
18-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
21--                                                                          --
22-- You should have received a copy of the GNU General Public License and    --
23-- a copy of the GCC Runtime Library Exception along with this program;     --
24-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25-- <http://www.gnu.org/licenses/>.                                          --
26--                                                                          --
27-- GNAT was originally developed  by the GNAT team at  New York University. --
28-- Extensive contributions were provided by Ada Core Technologies Inc.      --
29--                                                                          --
30------------------------------------------------------------------------------
31
32--  Run-time symbolic traceback support
33
34--  The full capability is currently supported on the following targets:
35
36--     HP-UX ia64
37--     GNU/Linux x86, x86_64, ia64
38--     FreeBSD x86, x86_64
39--     Solaris sparc and x86
40--     OpenVMS Alpha and ia64
41--     Windows
42
43--  Note: on targets other than those listed above, a dummy implementation of
44--  the body returns a series of LF separated strings of the form "0x..."
45--  corresponding to the addresses.
46
47--  The routines provided in this package assume that your application has
48--  been compiled with debugging information turned on, since this information
49--  is used to build a symbolic traceback.
50
51--  If you want to retrieve tracebacks from exception occurrences, it is also
52--  necessary to invoke the binder with -E switch. Please refer to the gnatbind
53--  documentation for more information.
54
55--  Note that it is also possible (and often recommended) to compute symbolic
56--  traceback outside the program execution, which in addition allows you
57--  to distribute the executable with no debug info:
58--
59--  - build your executable with debug info
60--  - archive this executable
61--  - strip a copy of the executable and distribute/deploy this version
62--  - at run time, compute absolute traceback (-bargs -E) from your
63--    executable and log it using Ada.Exceptions.Exception_Information
64--  - off line, compute the symbolic traceback using the executable archived
65--    with debug info and addr2line or gdb (using info line *<addr>) on the
66--    absolute addresses logged by your application.
67
68--  In order to retrieve symbolic information, functions in this package will
69--  read on disk all the debug information of the executable file (found via
70--  Argument (0), and looked in the PATH if needed) or shared libraries using
71--  OS facilities, and load them in memory, causing a significant cpu and
72--  memory overhead.
73
74--  Symbolic traceback from shared libraries is only supported for VMS, Windows
75--  and GNU/Linux. On other targets symbolic tracebacks are only supported for
76--  the main executable. You should consider using gdb to obtain symbolic
77--  traceback in such cases.
78
79--  On VMS, there is no restriction on using this facility with shared
80--  libraries. However, the OS should be at least v7.3-1 and OS patch
81--  VMS731_TRACE-V0100 must be applied in order to use this package.
82
83--  On platforms where the full capability is not supported, function
84--  Symbolic_Traceback return a list of addresses expressed as "0x..."
85--  separated by line feed.
86
87with Ada.Exceptions; use Ada.Exceptions;
88
89package GNAT.Traceback.Symbolic is
90   pragma Elaborate_Body;
91
92   function Symbolic_Traceback (Traceback : Tracebacks_Array) return String;
93   --  Build a string containing a symbolic traceback of the given call chain.
94   --  Note: This procedure may be installed by Set_Trace_Decorator, to get a
95   --  symbolic traceback on all exceptions raised (see GNAT.Exception_Traces).
96
97   function Symbolic_Traceback (E : Exception_Occurrence) return String;
98   --  Build string containing symbolic traceback of given exception occurrence
99
100end GNAT.Traceback.Symbolic;
101