unwind.h revision 112586cef341143febbf6b781df6491c07db0e91 
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 __has_include_next(<unwind.h>)
30/* Darwin (from 11.x on) and libunwind 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;
70typedef intptr_t _Unwind_Sword;
71typedef uintptr_t _Unwind_Ptr;
72typedef uintptr_t _Unwind_Internal_Ptr;
73typedef uint64_t _Unwind_Exception_Class;
74
75struct _Unwind_Context;
76struct _Unwind_Exception;
77typedef enum {
78  _URC_NO_REASON = 0,
79  _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
80
81  _URC_FATAL_PHASE2_ERROR = 2,
82  _URC_FATAL_PHASE1_ERROR = 3,
83  _URC_NORMAL_STOP = 4,
84
85  _URC_END_OF_STACK = 5,
86  _URC_HANDLER_FOUND = 6,
87  _URC_INSTALL_CONTEXT = 7,
88  _URC_CONTINUE_UNWIND = 8
89} _Unwind_Reason_Code;
90
91typedef enum {
92  _UA_SEARCH_PHASE = 1,
93  _UA_CLEANUP_PHASE = 2,
94
95  _UA_HANDLER_FRAME = 4,
96  _UA_FORCE_UNWIND = 8,
97  _UA_END_OF_STACK = 16 /* gcc extension to C++ ABI */
98} _Unwind_Action;
99
100typedef void (*_Unwind_Exception_Cleanup_Fn)(_Unwind_Reason_Code,
101                                             struct _Unwind_Exception *);
102
103struct _Unwind_Exception {
104  _Unwind_Exception_Class exception_class;
105  _Unwind_Exception_Cleanup_Fn exception_cleanup;
106  _Unwind_Word private_1;
107  _Unwind_Word private_2;
108  /* The Itanium ABI requires that _Unwind_Exception objects are "double-word
109   * aligned".  GCC has interpreted this to mean "use the maximum useful
110   * alignment for the target"; so do we. */
111} __attribute__((__aligned__));
112
113typedef _Unwind_Reason_Code (*_Unwind_Stop_Fn)(int, _Unwind_Action,
114                                               _Unwind_Exception_Class,
115                                               struct _Unwind_Exception *,
116                                               struct _Unwind_Context *,
117                                               void *);
118
119typedef _Unwind_Reason_Code (*_Unwind_Personality_Fn)(
120    int, _Unwind_Action, _Unwind_Exception_Class, struct _Unwind_Exception *,
121    struct _Unwind_Context *);
122typedef _Unwind_Personality_Fn __personality_routine;
123
124typedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context *,
125                                                void *);
126
127#ifdef __arm__
128
129typedef enum {
130  _UVRSC_CORE = 0,        /* integer register */
131  _UVRSC_VFP = 1,         /* vfp */
132  _UVRSC_WMMXD = 3,       /* Intel WMMX data register */
133  _UVRSC_WMMXC = 4        /* Intel WMMX control register */
134} _Unwind_VRS_RegClass;
135
136typedef enum {
137  _UVRSD_UINT32 = 0,
138  _UVRSD_VFPX = 1,
139  _UVRSD_UINT64 = 3,
140  _UVRSD_FLOAT = 4,
141  _UVRSD_DOUBLE = 5
142} _Unwind_VRS_DataRepresentation;
143
144typedef enum {
145  _UVRSR_OK = 0,
146  _UVRSR_NOT_IMPLEMENTED = 1,
147  _UVRSR_FAILED = 2
148} _Unwind_VRS_Result;
149
150_Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *__context,
151  _Unwind_VRS_RegClass __regclass,
152  uint32_t __regno,
153  _Unwind_VRS_DataRepresentation __representation,
154  void *__valuep);
155
156#endif
157
158_Unwind_Word _Unwind_GetGR(struct _Unwind_Context *, int);
159void _Unwind_SetGR(struct _Unwind_Context *, int, _Unwind_Word);
160
161_Unwind_Word _Unwind_GetIP(struct _Unwind_Context *);
162_Unwind_Word _Unwind_GetIPInfo(struct _Unwind_Context *, int *);
163void _Unwind_SetIP(struct _Unwind_Context *, _Unwind_Word);
164
165_Unwind_Word _Unwind_GetCFA(struct _Unwind_Context *);
166
167void *_Unwind_GetLanguageSpecificData(struct _Unwind_Context *);
168
169_Unwind_Ptr _Unwind_GetRegionStart(struct _Unwind_Context *);
170
171/* DWARF EH functions; currently not available on Darwin/ARM */
172#if !defined(__APPLE__) || !defined(__arm__)
173
174_Unwind_Reason_Code _Unwind_RaiseException(struct _Unwind_Exception *);
175_Unwind_Reason_Code _Unwind_ForcedUnwind(struct _Unwind_Exception *,
176                                         _Unwind_Stop_Fn, void *);
177void _Unwind_DeleteException(struct _Unwind_Exception *);
178void _Unwind_Resume(struct _Unwind_Exception *);
179_Unwind_Reason_Code _Unwind_Resume_or_Rethrow(struct _Unwind_Exception *);
180
181#endif
182
183_Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void *);
184
185/* setjmp(3)/longjmp(3) stuff */
186typedef struct SjLj_Function_Context *_Unwind_FunctionContext_t;
187
188void _Unwind_SjLj_Register(_Unwind_FunctionContext_t);
189void _Unwind_SjLj_Unregister(_Unwind_FunctionContext_t);
190_Unwind_Reason_Code _Unwind_SjLj_RaiseException(struct _Unwind_Exception *);
191_Unwind_Reason_Code _Unwind_SjLj_ForcedUnwind(struct _Unwind_Exception *,
192                                              _Unwind_Stop_Fn, void *);
193void _Unwind_SjLj_Resume(struct _Unwind_Exception *);
194_Unwind_Reason_Code _Unwind_SjLj_Resume_or_Rethrow(struct _Unwind_Exception *);
195
196void *_Unwind_FindEnclosingFunction(void *);
197
198#ifdef __APPLE__
199
200_Unwind_Ptr _Unwind_GetDataRelBase(struct _Unwind_Context *)
201    __attribute__((unavailable));
202_Unwind_Ptr _Unwind_GetTextRelBase(struct _Unwind_Context *)
203    __attribute__((unavailable));
204
205/* Darwin-specific functions */
206void __register_frame(const void *);
207void __deregister_frame(const void *);
208
209struct dwarf_eh_bases {
210  uintptr_t tbase;
211  uintptr_t dbase;
212  uintptr_t func;
213};
214void *_Unwind_Find_FDE(const void *, struct dwarf_eh_bases *);
215
216void __register_frame_info_bases(const void *, void *, void *, void *)
217  __attribute__((unavailable));
218void __register_frame_info(const void *, void *) __attribute__((unavailable));
219void __register_frame_info_table_bases(const void *, void*, void *, void *)
220  __attribute__((unavailable));
221void __register_frame_info_table(const void *, void *)
222  __attribute__((unavailable));
223void __register_frame_table(const void *) __attribute__((unavailable));
224void __deregister_frame_info(const void *) __attribute__((unavailable));
225void __deregister_frame_info_bases(const void *)__attribute__((unavailable));
226
227#else
228
229_Unwind_Ptr _Unwind_GetDataRelBase(struct _Unwind_Context *);
230_Unwind_Ptr _Unwind_GetTextRelBase(struct _Unwind_Context *);
231
232#endif
233
234
235#ifndef HIDE_EXPORTS
236#pragma GCC visibility pop
237#endif
238
239#ifdef __cplusplus
240}
241#endif
242
243#endif
244
245#endif /* __CLANG_UNWIND_H */
246