1 /*===---- unwind.h - Stack unwinding ----------------------------------------===
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:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
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
21 *===-----------------------------------------------------------------------===
24 /* See "Data Definitions for libgcc_s" in the Linux Standard Base.*/
26 #ifndef __CLANG_UNWIND_H
27 #define __CLANG_UNWIND_H
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.*/
34 # define _SHOULD_UNDEFINE_GNU_SOURCE
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:
44 # include_next <unwind.h>
46 # pragma GCC visibility push(default)
47 # include_next <unwind.h>
48 # pragma GCC visibility pop
50 # ifdef _SHOULD_UNDEFINE_GNU_SOURCE
52 # undef _SHOULD_UNDEFINE_GNU_SOURCE
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
66 #pragma GCC visibility push(default)
69 typedef uintptr_t _Unwind_Word;
70 typedef intptr_t _Unwind_Sword;
71 typedef uintptr_t _Unwind_Ptr;
72 typedef uintptr_t _Unwind_Internal_Ptr;
73 typedef uint64_t _Unwind_Exception_Class;
75 typedef intptr_t _sleb128_t;
76 typedef uintptr_t _uleb128_t;
78 struct _Unwind_Context;
79 #if defined(__arm__) && !(defined(__USING_SJLJ_EXCEPTIONS__) || defined(__ARM_DWARF_EH__))
80 struct _Unwind_Control_Block;
81 typedef struct _Unwind_Control_Block _Unwind_Exception; /* Alias */
83 struct _Unwind_Exception;
84 typedef struct _Unwind_Exception _Unwind_Exception;
88 #if defined(__arm__) && !defined(__USING_SJLJ_EXCEPTIONS__) && \
89 !defined(__ARM_DWARF_EH__)
90 _URC_OK = 0, /* used by ARM EHABI */
92 _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
94 _URC_FATAL_PHASE2_ERROR = 2,
95 _URC_FATAL_PHASE1_ERROR = 3,
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 */
106 } _Unwind_Reason_Code;
109 _UA_SEARCH_PHASE = 1,
110 _UA_CLEANUP_PHASE = 2,
112 _UA_HANDLER_FRAME = 4,
113 _UA_FORCE_UNWIND = 8,
114 _UA_END_OF_STACK = 16 /* gcc extension to C++ ABI */
117 typedef void (*_Unwind_Exception_Cleanup_Fn)(_Unwind_Reason_Code,
118 _Unwind_Exception *);
120 #if defined(__arm__) && !(defined(__USING_SJLJ_EXCEPTIONS__) || defined(__ARM_DWARF_EH__))
121 typedef struct _Unwind_Control_Block _Unwind_Control_Block;
122 typedef uint32_t _Unwind_EHT_Header;
124 struct _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) */
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 */
135 /* propagation barrier cache (valid after phase 1) */
138 uint32_t bitpattern[5];
140 /* cleanup cache (preserved over cleanup) */
142 uint32_t bitpattern[4];
144 /* personality cache (for personality's benefit) */
146 uint32_t fnstart; /* function start address */
147 _Unwind_EHT_Header *ehtp; /* pointer to EHT entry header word */
148 uint32_t additional; /* additional data */
151 long long int : 0; /* force alignment of next item to 8-byte boundary */
152 } __attribute__((__aligned__(8)));
154 struct _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];
160 _Unwind_Word private_1;
161 _Unwind_Word private_2;
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__));
169 typedef _Unwind_Reason_Code (*_Unwind_Stop_Fn)(int, _Unwind_Action,
170 _Unwind_Exception_Class,
172 struct _Unwind_Context *,
175 typedef _Unwind_Reason_Code (*_Unwind_Personality_Fn)(int, _Unwind_Action,
176 _Unwind_Exception_Class,
178 struct _Unwind_Context *);
179 typedef _Unwind_Personality_Fn __personality_routine;
181 typedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context *,
184 #if defined(__arm__) && !(defined(__USING_SJLJ_EXCEPTIONS__) || defined(__ARM_DWARF_EH__))
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;
198 } _Unwind_VRS_DataRepresentation;
202 _UVRSR_NOT_IMPLEMENTED = 1,
204 } _Unwind_VRS_Result;
206 typedef 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)
213 _Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *__context,
214 _Unwind_VRS_RegClass __regclass,
216 _Unwind_VRS_DataRepresentation __representation,
219 _Unwind_VRS_Result _Unwind_VRS_Set(struct _Unwind_Context *__context,
220 _Unwind_VRS_RegClass __regclass,
222 _Unwind_VRS_DataRepresentation __representation,
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);
233 void _Unwind_SetGR(struct _Unwind_Context *__context, int __index,
234 _Unwind_Word __value) {
235 _Unwind_VRS_Set(__context, _UVRSC_CORE, __index, _UVRSD_UINT32, &__value);
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. */
245 void _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);
250 _Unwind_Word _Unwind_GetGR(struct _Unwind_Context *, int);
251 void _Unwind_SetGR(struct _Unwind_Context *, int, _Unwind_Word);
253 _Unwind_Word _Unwind_GetIP(struct _Unwind_Context *);
254 void _Unwind_SetIP(struct _Unwind_Context *, _Unwind_Word);
258 _Unwind_Word _Unwind_GetIPInfo(struct _Unwind_Context *, int *);
260 _Unwind_Word _Unwind_GetCFA(struct _Unwind_Context *);
262 _Unwind_Word _Unwind_GetBSP(struct _Unwind_Context *);
264 void *_Unwind_GetLanguageSpecificData(struct _Unwind_Context *);
266 _Unwind_Ptr _Unwind_GetRegionStart(struct _Unwind_Context *);
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,
273 void _Unwind_DeleteException(_Unwind_Exception *);
274 void _Unwind_Resume(_Unwind_Exception *);
275 _Unwind_Reason_Code _Unwind_Resume_or_Rethrow(_Unwind_Exception *);
279 _Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void *);
281 /* setjmp(3)/longjmp(3) stuff */
282 typedef struct SjLj_Function_Context *_Unwind_FunctionContext_t;
284 void _Unwind_SjLj_Register(_Unwind_FunctionContext_t);
285 void _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 *);
289 void _Unwind_SjLj_Resume(_Unwind_Exception *);
290 _Unwind_Reason_Code _Unwind_SjLj_Resume_or_Rethrow(_Unwind_Exception *);
292 void *_Unwind_FindEnclosingFunction(void *);
296 _Unwind_Ptr _Unwind_GetDataRelBase(struct _Unwind_Context *)
297 __attribute__((__unavailable__));
298 _Unwind_Ptr _Unwind_GetTextRelBase(struct _Unwind_Context *)
299 __attribute__((__unavailable__));
301 /* Darwin-specific functions */
302 void __register_frame(const void *);
303 void __deregister_frame(const void *);
305 struct dwarf_eh_bases {
310 void *_Unwind_Find_FDE(const void *, struct dwarf_eh_bases *);
312 void __register_frame_info_bases(const void *, void *, void *, void *)
313 __attribute__((__unavailable__));
314 void __register_frame_info(const void *, void *) __attribute__((__unavailable__));
315 void __register_frame_info_table_bases(const void *, void*, void *, void *)
316 __attribute__((__unavailable__));
317 void __register_frame_info_table(const void *, void *)
318 __attribute__((__unavailable__));
319 void __register_frame_table(const void *) __attribute__((__unavailable__));
320 void __deregister_frame_info(const void *) __attribute__((__unavailable__));
321 void __deregister_frame_info_bases(const void *)__attribute__((__unavailable__));
325 _Unwind_Ptr _Unwind_GetDataRelBase(struct _Unwind_Context *);
326 _Unwind_Ptr _Unwind_GetTextRelBase(struct _Unwind_Context *);
332 #pragma GCC visibility pop
341 #endif /* __CLANG_UNWIND_H */