-- --
-- S p e c --
-- --
--- $Revision$
--- --
--- Copyright (C) 1999-2002 Ada Core Technologies, Inc. --
+-- Copyright (C) 1999-2007, AdaCore --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
-- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
--- MA 02111-1307, USA. --
+-- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
+-- Boston, MA 02110-1301, USA. --
-- --
-- As a special exception, if other files instantiate generics from this --
-- unit, or you link this unit with other files to produce an executable, --
-- however invalidate any other reasons why the executable file might be --
-- covered by the GNU Public License. --
-- --
--- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com). --
+-- GNAT was originally developed by the GNAT team at New York University. --
+-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
-- Run-time symbolic traceback support
--- Note: this is only available on selected targets. Currently it is
--- supported on Sparc/Solaris, GNU/Linux, Windows NT, HP-UX and Tru64.
+-- This capability is currently supported on the following targets:
+
+-- HP-UX
+-- Irix MIPS
+-- GNU/Linux x86
+-- Solaris sparc
+-- Tru64 alpha
+-- OpenVMS/Alpha
+-- Windows NT/XP
-- The routines provided in this package assume that your application has
-- been compiled with debugging information turned on, since this information
-- is used to build a symbolic traceback.
+
+-- If you want to retrieve tracebacks from exception occurrences, it is also
+-- necessary to invoke the binder with -E switch. Please refer to the gnatbind
+-- documentation for more information.
+
+-- Note that it is also possible (and often recommended) to compute symbolic
+-- traceback outside the program execution, which in addition allows you
+-- to distribute the executable with no debug info:
--
+-- - build your executable with debug info
+-- - archive this executable
+-- - strip a copy of the executable and distribute/deploy this version
+-- - at run time, compute absolute traceback (-bargs -E) from your
+-- executable and log it using Ada.Exceptions.Exception_Occurrence
+-- - off line, compute the symbolic traceback using the executable archived
+-- with debug info and addr2line or gdb (using info line *<addr>) on the
+-- absolute addresses logged by your application.
+
-- In order to retrieve symbolic information, functions in this package will
--- read on disk all the debug information of the current executable and load
--- them in memory, causing a significant cpu and memory overhead.
---
--- This package is not intended to be used within a shared library,
--- symbolic tracebacks are only supported for the main executable
--- and not for shared libraries.
---
--- You should consider using off-line symbolic traceback instead, using
--- addr2line or gdb.
+-- read on disk all the debug information of the executable file (found via
+-- Argument (0), so any path information needed to read the executable file
+-- need to be provided when launching the executable), and load then in
+-- memory, causing a significant cpu and memory overhead.
+
+-- On all platforms except VMS, this package is not intended to be used
+-- within a shared library, symbolic tracebacks are only supported for the
+-- main executable and not for shared libraries. You should consider using
+-- gdb to obtain symbolic traceback in such cases.
+
+-- On VMS, there is no restriction on using this facility with shared
+-- libraries. However, the OS should be at least v7.3-1 and OS patch
+-- VMS731_TRACE-V0100 must be applied in order to use this package.
with Ada.Exceptions; use Ada.Exceptions;
package GNAT.Traceback.Symbolic is
-pragma Elaborate_Body (Traceback.Symbolic);
+ pragma Elaborate_Body;
------------------------
-- Symbolic_Traceback --
------------------------
function Symbolic_Traceback (Traceback : Tracebacks_Array) return String;
- -- Build a string containing a symbolic traceback of the given call chain.
+ -- Build a string containing a symbolic traceback of the given call chain
function Symbolic_Traceback (E : Exception_Occurrence) return String;
- -- Build a string containing a symbolic traceback of the given exception
- -- occurrence.
+ -- Build string containing symbolic traceback of given exception occurrence
end GNAT.Traceback.Symbolic;
OSDN Git Service
