gcc/unwind.h

   1 /* Exception handling and frame unwind runtime interface routines.
   2    Copyright (C) 2001, 2003 Free Software Foundation, Inc.
   3
   4    This file is part of GCC.
   5
   6    GCC is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    GCC is distributed in the hope that it will be useful, but WITHOUT
  12    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  14    License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with GCC; see the file COPYING.  If not, write to the Free
  18    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19    02111-1307, USA.  */
  20
  21 /* As a special exception, if you include this header file into source
  22    files compiled by GCC, this header file does not by itself cause
  23    the resulting executable to be covered by the GNU General Public
  24    License.  This exception does not however invalidate any other
  25    reasons why the executable file might be covered by the GNU General
  26    Public License.  */
  27
  28 /* This is derived from the C++ ABI for IA-64.  Where we diverge
  29    for cross-architecture compatibility are noted with "@@@".  */
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /* Level 1: Base ABI  */
  36
  37 /* @@@ The IA-64 ABI uses uint64 throughout.  Most places this is
  38    inefficient for 32-bit and smaller machines.  */
  39 typedef unsigned _Unwind_Word __attribute__((__mode__(__word__)));
  40 typedef signed _Unwind_Sword __attribute__((__mode__(__word__)));
  41 #if defined(__ia64__) && defined(__hpux__)
  42 typedef unsigned _Unwind_Ptr __attribute__((__mode__(__word__)));
  43 #else
  44 typedef unsigned _Unwind_Ptr __attribute__((__mode__(__pointer__)));
  45 #endif
  46 typedef unsigned _Unwind_Internal_Ptr __attribute__((__mode__(__pointer__)));
  47
  48 /* @@@ The IA-64 ABI uses a 64-bit word to identify the producer and
  49    consumer of an exception.  We'll go along with this for now even on
  50    32-bit machines.  We'll need to provide some other option for
  51    16-bit machines and for machines with > 8 bits per byte.  */
  52 typedef unsigned _Unwind_Exception_Class __attribute__((__mode__(__DI__)));
  53
  54 /* The unwind interface uses reason codes in several contexts to
  55    identify the reasons for failures or other actions.  */
  56 typedef enum
  57 {
  58   _URC_NO_REASON = 0,
  59   _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
  60   _URC_FATAL_PHASE2_ERROR = 2,
  61   _URC_FATAL_PHASE1_ERROR = 3,
  62   _URC_NORMAL_STOP = 4,
  63   _URC_END_OF_STACK = 5,
  64   _URC_HANDLER_FOUND = 6,
  65   _URC_INSTALL_CONTEXT = 7,
  66   _URC_CONTINUE_UNWIND = 8
  67 } _Unwind_Reason_Code;
  68
  69
  70 /* The unwind interface uses a pointer to an exception header object
  71    as its representation of an exception being thrown. In general, the
  72    full representation of an exception object is language- and
  73    implementation-specific, but it will be prefixed by a header
  74    understood by the unwind interface.  */
  75
  76 struct _Unwind_Exception;
  77
  78 typedef void (*_Unwind_Exception_Cleanup_Fn) (_Unwind_Reason_Code,
  79                                               struct _Unwind_Exception *);
  80
  81 struct _Unwind_Exception
  82 {
  83   _Unwind_Exception_Class exception_class;
  84   _Unwind_Exception_Cleanup_Fn exception_cleanup;
  85   _Unwind_Word private_1;
  86   _Unwind_Word private_2;
  87
  88   /* @@@ The IA-64 ABI says that this structure must be double-word aligned.
  89      Taking that literally does not make much sense generically.  Instead we
  90      provide the maximum alignment required by any type for the machine.  */
  91 } __attribute__((__aligned__));
  92
  93
  94 /* The ACTIONS argument to the personality routine is a bitwise OR of one
  95    or more of the following constants.  */
  96 typedef int _Unwind_Action;
  97
  98 #define _UA_SEARCH_PHASE        1
  99 #define _UA_CLEANUP_PHASE       2
 100 #define _UA_HANDLER_FRAME       4
 101 #define _UA_FORCE_UNWIND        8
 102 #define _UA_END_OF_STACK        16
 103
 104 /* This is an opaque type used to refer to a system-specific data
 105    structure used by the system unwinder. This context is created and
 106    destroyed by the system, and passed to the personality routine
 107    during unwinding.  */
 108 struct _Unwind_Context;
 109
 110 /* Raise an exception, passing along the given exception object.  */
 111 extern _Unwind_Reason_Code _Unwind_RaiseException (struct _Unwind_Exception *);
 112
 113 /* Raise an exception for forced unwinding.  */
 114
 115 typedef _Unwind_Reason_Code (*_Unwind_Stop_Fn)
 116      (int, _Unwind_Action, _Unwind_Exception_Class,
 117       struct _Unwind_Exception *, struct _Unwind_Context *, void *);
 118
 119 extern _Unwind_Reason_Code _Unwind_ForcedUnwind (struct _Unwind_Exception *,
 120                                                  _Unwind_Stop_Fn,
 121                                                  void *);
 122
 123 /* Helper to invoke the exception_cleanup routine.  */
 124 extern void _Unwind_DeleteException (struct _Unwind_Exception *);
 125
 126 /* Resume propagation of an existing exception.  This is used after
 127    e.g. executing cleanup code, and not to implement rethrowing.  */
 128 extern void _Unwind_Resume (struct _Unwind_Exception *);
 129
 130 /* @@@ Resume propagation of an FORCE_UNWIND exception, or to rethrow
 131    a normal exception that was handled.  */
 132 extern _Unwind_Reason_Code _Unwind_Resume_or_Rethrow (struct _Unwind_Exception *);
 133
 134 /* @@@ Use unwind data to perform a stack backtrace.  The trace callback
 135    is called for every stack frame in the call chain, but no cleanup
 136    actions are performed.  */
 137 typedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)
 138      (struct _Unwind_Context *, void *);
 139
 140 extern _Unwind_Reason_Code _Unwind_Backtrace (_Unwind_Trace_Fn, void *);
 141
 142 /* These functions are used for communicating information about the unwind
 143    context (i.e. the unwind descriptors and the user register state) between
 144    the unwind library and the personality routine and landing pad.  Only
 145    selected registers maybe manipulated.  */
 146
 147 extern _Unwind_Word _Unwind_GetGR (struct _Unwind_Context *, int);
 148 extern void _Unwind_SetGR (struct _Unwind_Context *, int, _Unwind_Word);
 149
 150 extern _Unwind_Ptr _Unwind_GetIP (struct _Unwind_Context *);
 151 extern void _Unwind_SetIP (struct _Unwind_Context *, _Unwind_Ptr);
 152
 153 /* @@@ Retrieve the CFA of the given context.  */
 154 extern _Unwind_Word _Unwind_GetCFA (struct _Unwind_Context *);
 155
 156 extern void *_Unwind_GetLanguageSpecificData (struct _Unwind_Context *);
 157
 158 extern _Unwind_Ptr _Unwind_GetRegionStart (struct _Unwind_Context *);
 159
 160
 161 /* The personality routine is the function in the C++ (or other language)
 162    runtime library which serves as an interface between the system unwind
 163    library and language-specific exception handling semantics.  It is
 164    specific to the code fragment described by an unwind info block, and
 165    it is always referenced via the pointer in the unwind info block, and
 166    hence it has no ABI-specified name.
 167
 168    Note that this implies that two different C++ implementations can
 169    use different names, and have different contents in the language
 170    specific data area.  Moreover, that the language specific data
 171    area contains no version info because name of the function invoked
 172    provides more effective versioning by detecting at link time the
 173    lack of code to handle the different data format.  */
 174
 175 typedef _Unwind_Reason_Code (*_Unwind_Personality_Fn)
 176      (int, _Unwind_Action, _Unwind_Exception_Class,
 177       struct _Unwind_Exception *, struct _Unwind_Context *);
 178
 179 /* @@@ The following alternate entry points are for setjmp/longjmp
 180    based unwinding.  */
 181
 182 struct SjLj_Function_Context;
 183 extern void _Unwind_SjLj_Register (struct SjLj_Function_Context *);
 184 extern void _Unwind_SjLj_Unregister (struct SjLj_Function_Context *);
 185
 186 extern _Unwind_Reason_Code _Unwind_SjLj_RaiseException
 187      (struct _Unwind_Exception *);
 188 extern _Unwind_Reason_Code _Unwind_SjLj_ForcedUnwind
 189      (struct _Unwind_Exception *, _Unwind_Stop_Fn, void *);
 190 extern void _Unwind_SjLj_Resume (struct _Unwind_Exception *);
 191 extern _Unwind_Reason_Code _Unwind_SjLj_Resume_or_Rethrow (struct _Unwind_Exception *);
 192
 193 /* @@@ The following provide access to the base addresses for text
 194    and data-relative addressing in the LDSA.  In order to stay link
 195    compatible with the standard ABI for IA-64, we inline these.  */
 196
 197 #ifdef __ia64__
 198 #include <stdlib.h>
 199
 200 static inline _Unwind_Ptr
 201 _Unwind_GetDataRelBase (struct _Unwind_Context *_C)
 202 {
 203   /* The GP is stored in R1.  */
 204   return _Unwind_GetGR (_C, 1);
 205 }
 206
 207 static inline _Unwind_Ptr
 208 _Unwind_GetTextRelBase (struct _Unwind_Context *_C __attribute__ ((__unused__)))
 209 {
 210   abort ();
 211   return 0;
 212 }
 213
 214 /* @@@ Retrieve the Backing Store Pointer of the given context.  */
 215 extern _Unwind_Word _Unwind_GetBSP (struct _Unwind_Context *);
 216 #else
 217 extern _Unwind_Ptr _Unwind_GetDataRelBase (struct _Unwind_Context *);
 218 extern _Unwind_Ptr _Unwind_GetTextRelBase (struct _Unwind_Context *);
 219 #endif
 220
 221 /* @@@ Given an address, return the entry point of the function that
 222    contains it.  */
 223 extern void * _Unwind_FindEnclosingFunction (void *pc);
 224
 225 #ifdef __cplusplus
 226 }
 227 #endif