gcc/ada/s-traent.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --              S Y S T E M . T R A C E B A C K _ E N T R I E S             --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2003-2014, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  21 --                                                                          --
  22 -- As a special exception under Section 7 of GPL version 3, you are granted --
  23 -- additional permissions described in the GCC Runtime Library Exception,   --
  24 -- version 3.1, as published by the Free Software Foundation.               --
  25 --                                                                          --
  26 -- You should have received a copy of the GNU General Public License and    --
  27 -- a copy of the GCC Runtime Library Exception along with this program;     --
  28 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  29 -- <http://www.gnu.org/licenses/>.                                          --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  This package offers an abstraction of what is stored in traceback arrays
  37 --  for call-chain computation purposes. By default, as defined in this
  38 --  version of the package, an entry is a mere code location representing the
  39 --  address of a call instruction part of the call-chain.
  40
  41 pragma Polling (Off);
  42 --  We must turn polling off for this unit, because otherwise we get
  43 --  elaboration circularities with Ada.Exceptions.
  44
  45 pragma Compiler_Unit_Warning;
  46
  47 package System.Traceback_Entries is
  48    pragma Preelaborate;
  49
  50    subtype Traceback_Entry is System.Address;
  51    --  This subtype defines what each traceback array entry contains
  52
  53    Null_TB_Entry : constant Traceback_Entry := System.Null_Address;
  54    --  This is the value to be used when initializing an entry
  55
  56    type Tracebacks_Array is array (Positive range <>) of Traceback_Entry;
  57
  58    function PC_For (TB_Entry : Traceback_Entry) return System.Address;
  59    pragma Inline (PC_For);
  60    --  Returns the address of the call instruction associated with the
  61    --  provided entry.
  62
  63    function TB_Entry_For (PC : System.Address) return Traceback_Entry;
  64    pragma Inline (TB_Entry_For);
  65    --  Returns an entry representing a frame for a call instruction at PC
  66
  67 end System.Traceback_Entries;