Clang Project

clang_source_code/lib/Headers/unwind.h
1/*===---- unwind.h - Stack unwinding ----------------------------------------===
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
9 *
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 * THE SOFTWARE.
20 *
21 *===-----------------------------------------------------------------------===
22 */
23
24/* See "Data Definitions for libgcc_s" in the Linux Standard Base.*/
25
26#ifndef __CLANG_UNWIND_H
27#define __CLANG_UNWIND_H
28
29#if defined(__APPLE__) && __has_include_next(<unwind.h>)
30/* Darwin (from 11.x on) provide an unwind.h. If that's available,
31 * use it. libunwind wraps some of its definitions in #ifdef _GNU_SOURCE,
32 * so define that around the include.*/
33# ifndef _GNU_SOURCE
34#  define _SHOULD_UNDEFINE_GNU_SOURCE
35#  define _GNU_SOURCE
36# endif
37// libunwind's unwind.h reflects the current visibility.  However, Mozilla
38// builds with -fvisibility=hidden and relies on gcc's unwind.h to reset the
39// visibility to default and export its contents.  gcc also allows users to
40// override its override by #defining HIDE_EXPORTS (but note, this only obeys
41// the user's -fvisibility setting; it doesn't hide any exports on its own).  We
42// imitate gcc's header here:
43# ifdef HIDE_EXPORTS
44#  include_next <unwind.h>
45# else
46#  pragma GCC visibility push(default)
47#  include_next <unwind.h>
48#  pragma GCC visibility pop
49# endif
50# ifdef _SHOULD_UNDEFINE_GNU_SOURCE
51#  undef _GNU_SOURCE
52#  undef _SHOULD_UNDEFINE_GNU_SOURCE
53# endif
54#else
55
56#include <stdint.h>
57
58#ifdef __cplusplus
59extern "C" {
60#endif
61
62/* It is a bit strange for a header to play with the visibility of the
63   symbols it declares, but this matches gcc's behavior and some programs
64   depend on it */
65#ifndef HIDE_EXPORTS
66#pragma GCC visibility push(default)
67#endif
68
69typedef uintptr_t _Unwind_Word __attribute__((__mode__(__unwind_word__)));
70typedef intptr_t _Unwind_Sword __attribute__((__mode__(__unwind_word__)));
71typedef uintptr_t _Unwind_Ptr;
72typedef uintptr_t _Unwind_Internal_Ptr;
73typedef uint64_t _Unwind_Exception_Class;
74
75typedef intptr_t _sleb128_t;
76typedef uintptr_t _uleb128_t;
77
78struct _Unwind_Context;
79#if defined(__arm__) && !(defined(__USING_SJLJ_EXCEPTIONS__) || defined(__ARM_DWARF_EH__))
80struct _Unwind_Control_Block;
81typedef struct _Unwind_Control_Block _Unwind_Exception; /* Alias */
82#else
83struct _Unwind_Exception;
84typedef struct _Unwind_Exception _Unwind_Exception;
85#endif
86typedef enum {
87  _URC_NO_REASON = 0,
88#if defined(__arm__) && !defined(__USING_SJLJ_EXCEPTIONS__) && \
89    !defined(__ARM_DWARF_EH__)
90  _URC_OK = 0, /* used by ARM EHABI */
91#endif
92  _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
93
94  _URC_FATAL_PHASE2_ERROR = 2,
95  _URC_FATAL_PHASE1_ERROR = 3,
96  _URC_NORMAL_STOP = 4,
97
98  _URC_END_OF_STACK = 5,
99  _URC_HANDLER_FOUND = 6,
100  _URC_INSTALL_CONTEXT = 7,
101  _URC_CONTINUE_UNWIND = 8,
102#if defined(__arm__) && !defined(__USING_SJLJ_EXCEPTIONS__) && \
103    !defined(__ARM_DWARF_EH__)
104  _URC_FAILURE = 9 /* used by ARM EHABI */
105#endif
106} _Unwind_Reason_Code;
107
108typedef enum {
109  _UA_SEARCH_PHASE = 1,
110  _UA_CLEANUP_PHASE = 2,
111
112  _UA_HANDLER_FRAME = 4,
113  _UA_FORCE_UNWIND = 8,
114  _UA_END_OF_STACK = 16 /* gcc extension to C++ ABI */
115} _Unwind_Action;
116
117typedef void (*_Unwind_Exception_Cleanup_Fn)(_Unwind_Reason_Code,
118                                             _Unwind_Exception *);
119
120#if defined(__arm__) && !(defined(__USING_SJLJ_EXCEPTIONS__) || defined(__ARM_DWARF_EH__))
121typedef struct _Unwind_Control_Block _Unwind_Control_Block;
122typedef uint32_t _Unwind_EHT_Header;
123
124struct _Unwind_Control_Block {
125  uint64_t exception_class;
126  void (*exception_cleanup)(_Unwind_Reason_Code, _Unwind_Control_Block *);
127  /* unwinder cache (private fields for the unwinder's use) */
128  struct {
129    uint32_t reserved1; /* forced unwind stop function, 0 if not forced */
130    uint32_t reserved2; /* personality routine */
131    uint32_t reserved3; /* callsite */
132    uint32_t reserved4; /* forced unwind stop argument */
133    uint32_t reserved5;
134  } unwinder_cache;
135  /* propagation barrier cache (valid after phase 1) */
136  struct {
137    uint32_t sp;
138    uint32_t bitpattern[5];
139  } barrier_cache;
140  /* cleanup cache (preserved over cleanup) */
141  struct {
142    uint32_t bitpattern[4];
143  } cleanup_cache;
144  /* personality cache (for personality's benefit) */
145  struct {
146    uint32_t fnstart;         /* function start address */
147    _Unwind_EHT_Header *ehtp; /* pointer to EHT entry header word */
148    uint32_t additional;      /* additional data */
149    uint32_t reserved1;
150  } pr_cache;
151  long long int : 0; /* force alignment of next item to 8-byte boundary */
152} __attribute__((__aligned__(8)));
153#else
154struct _Unwind_Exception {
155  _Unwind_Exception_Class exception_class;
156  _Unwind_Exception_Cleanup_Fn exception_cleanup;
157#if !defined (__USING_SJLJ_EXCEPTIONS__) && defined (__SEH__)
158  _Unwind_Word private_[6];
159#else
160  _Unwind_Word private_1;
161  _Unwind_Word private_2;
162#endif
163  /* The Itanium ABI requires that _Unwind_Exception objects are "double-word
164   * aligned".  GCC has interpreted this to mean "use the maximum useful
165   * alignment for the target"; so do we. */
166} __attribute__((__aligned__));
167#endif
168
169typedef _Unwind_Reason_Code (*_Unwind_Stop_Fn)(int, _Unwind_Action,
170                                               _Unwind_Exception_Class,
171                                               _Unwind_Exception *,
172                                               struct _Unwind_Context *,
173                                               void *);
174
175typedef _Unwind_Reason_Code (*_Unwind_Personality_Fn)(int, _Unwind_Action,
176                                                      _Unwind_Exception_Class,
177                                                      _Unwind_Exception *,
178                                                      struct _Unwind_Context *);
179typedef _Unwind_Personality_Fn __personality_routine;
180
181typedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context *,
182                                                void *);
183
184#if defined(__arm__) && !(defined(__USING_SJLJ_EXCEPTIONS__) || defined(__ARM_DWARF_EH__))
185typedef enum {
186  _UVRSC_CORE = 0,        /* integer register */
187  _UVRSC_VFP = 1,         /* vfp */
188  _UVRSC_WMMXD = 3,       /* Intel WMMX data register */
189  _UVRSC_WMMXC = 4        /* Intel WMMX control register */
190} _Unwind_VRS_RegClass;
191
192typedef enum {
193  _UVRSD_UINT32 = 0,
194  _UVRSD_VFPX = 1,
195  _UVRSD_UINT64 = 3,
196  _UVRSD_FLOAT = 4,
197  _UVRSD_DOUBLE = 5
198} _Unwind_VRS_DataRepresentation;
199
200typedef enum {
201  _UVRSR_OK = 0,
202  _UVRSR_NOT_IMPLEMENTED = 1,
203  _UVRSR_FAILED = 2
204} _Unwind_VRS_Result;
205
206typedef uint32_t _Unwind_State;
207#define _US_VIRTUAL_UNWIND_FRAME  ((_Unwind_State)0)
208#define _US_UNWIND_FRAME_STARTING ((_Unwind_State)1)
209#define _US_UNWIND_FRAME_RESUME   ((_Unwind_State)2)
210#define _US_ACTION_MASK           ((_Unwind_State)3)
211#define _US_FORCE_UNWIND          ((_Unwind_State)8)
212
213_Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *__context,
214  _Unwind_VRS_RegClass __regclass,
215  uint32_t __regno,
216  _Unwind_VRS_DataRepresentation __representation,
217  void *__valuep);
218
219_Unwind_VRS_Result _Unwind_VRS_Set(struct _Unwind_Context *__context,
220  _Unwind_VRS_RegClass __regclass,
221  uint32_t __regno,
222  _Unwind_VRS_DataRepresentation __representation,
223  void *__valuep);
224
225static __inline__
226_Unwind_Word _Unwind_GetGR(struct _Unwind_Context *__context, int __index) {
227  _Unwind_Word __value;
228  _Unwind_VRS_Get(__context, _UVRSC_CORE, __index, _UVRSD_UINT32, &__value);
229  return __value;
230}
231
232static __inline__
233void _Unwind_SetGR(struct _Unwind_Context *__context, int __index,
234                   _Unwind_Word __value) {
235  _Unwind_VRS_Set(__context, _UVRSC_CORE, __index, _UVRSD_UINT32, &__value);
236}
237
238static __inline__
239_Unwind_Word _Unwind_GetIP(struct _Unwind_Context *__context) {
240  _Unwind_Word __ip = _Unwind_GetGR(__context, 15);
241  return __ip & ~(_Unwind_Word)(0x1); /* Remove thumb mode bit. */
242}
243
244static __inline__
245void _Unwind_SetIP(struct _Unwind_Context *__context, _Unwind_Word __value) {
246  _Unwind_Word __thumb_mode_bit = _Unwind_GetGR(__context, 15) & 0x1;
247  _Unwind_SetGR(__context, 15, __value | __thumb_mode_bit);
248}
249#else
250_Unwind_Word _Unwind_GetGR(struct _Unwind_Context *, int);
251void _Unwind_SetGR(struct _Unwind_Context *, int, _Unwind_Word);
252
253_Unwind_Word _Unwind_GetIP(struct _Unwind_Context *);
254void _Unwind_SetIP(struct _Unwind_Context *, _Unwind_Word);
255#endif
256
257
258_Unwind_Word _Unwind_GetIPInfo(struct _Unwind_Context *, int *);
259
260_Unwind_Word _Unwind_GetCFA(struct _Unwind_Context *);
261
262_Unwind_Word _Unwind_GetBSP(struct _Unwind_Context *);
263
264void *_Unwind_GetLanguageSpecificData(struct _Unwind_Context *);
265
266_Unwind_Ptr _Unwind_GetRegionStart(struct _Unwind_Context *);
267
268/* DWARF EH functions; currently not available on Darwin/ARM */
269#if !defined(__APPLE__) || !defined(__arm__)
270_Unwind_Reason_Code _Unwind_RaiseException(_Unwind_Exception *);
271_Unwind_Reason_Code _Unwind_ForcedUnwind(_Unwind_Exception *, _Unwind_Stop_Fn,
272                                         void *);
273void _Unwind_DeleteException(_Unwind_Exception *);
274void _Unwind_Resume(_Unwind_Exception *);
275_Unwind_Reason_Code _Unwind_Resume_or_Rethrow(_Unwind_Exception *);
276
277#endif
278
279_Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void *);
280
281/* setjmp(3)/longjmp(3) stuff */
282typedef struct SjLj_Function_Context *_Unwind_FunctionContext_t;
283
284void _Unwind_SjLj_Register(_Unwind_FunctionContext_t);
285void _Unwind_SjLj_Unregister(_Unwind_FunctionContext_t);
286_Unwind_Reason_Code _Unwind_SjLj_RaiseException(_Unwind_Exception *);
287_Unwind_Reason_Code _Unwind_SjLj_ForcedUnwind(_Unwind_Exception *,
288                                              _Unwind_Stop_Fn, void *);
289void _Unwind_SjLj_Resume(_Unwind_Exception *);
290_Unwind_Reason_Code _Unwind_SjLj_Resume_or_Rethrow(_Unwind_Exception *);
291
292void *_Unwind_FindEnclosingFunction(void *);
293
294#ifdef __APPLE__
295
296_Unwind_Ptr _Unwind_GetDataRelBase(struct _Unwind_Context *)
297    __attribute__((__unavailable__));
298_Unwind_Ptr _Unwind_GetTextRelBase(struct _Unwind_Context *)
299    __attribute__((__unavailable__));
300
301/* Darwin-specific functions */
302void __register_frame(const void *);
303void __deregister_frame(const void *);
304
305struct dwarf_eh_bases {
306  uintptr_t tbase;
307  uintptr_t dbase;
308  uintptr_t func;
309};
310void *_Unwind_Find_FDE(const void *, struct dwarf_eh_bases *);
311
312void __register_frame_info_bases(const void *, void *, void *, void *)
313  __attribute__((__unavailable__));
314void __register_frame_info(const void *, void *) __attribute__((__unavailable__));
315void __register_frame_info_table_bases(const void *, void*, void *, void *)
316  __attribute__((__unavailable__));
317void __register_frame_info_table(const void *, void *)
318  __attribute__((__unavailable__));
319void __register_frame_table(const void *) __attribute__((__unavailable__));
320void __deregister_frame_info(const void *) __attribute__((__unavailable__));
321void __deregister_frame_info_bases(const void *)__attribute__((__unavailable__));
322
323#else
324
325_Unwind_Ptr _Unwind_GetDataRelBase(struct _Unwind_Context *);
326_Unwind_Ptr _Unwind_GetTextRelBase(struct _Unwind_Context *);
327
328#endif
329
330
331#ifndef HIDE_EXPORTS
332#pragma GCC visibility pop
333#endif
334
335#ifdef __cplusplus
336}
337#endif
338
339#endif
340
341#endif /* __CLANG_UNWIND_H */
342
CodeThinker, Enjoy your reading code