blob: 55ebd54a67ab26fc149c335e763d0fab6015eef9 [file] [log] [blame]
Rafael Espindolad85c1e92011-12-08 05:01:39 +00001/*===---- 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
Jeffrey Yasskinf18a87b2012-02-21 16:20:12 +000026#if __has_include_next(<unwind.h>)
27/* Darwin and libunwind provide an unwind.h. If that's available, use
28 * it. libunwind wraps some of its definitions in #ifdef _GNU_SOURCE,
29 * so define that around the include.*/
30# ifndef _GNU_SOURCE
31# define _SHOULD_UNDEFINE_GNU_SOURCE
32# define _GNU_SOURCE
33# endif
Rafael Espindolabe5ff2f2012-03-29 03:37:17 +000034// libunwind's unwind.h reflects the current visibility. However, Mozilla
35// builds with -fvisibility=hidden and relies on gcc's unwind.h to reset the
36// visibility to default and export its contents. gcc also allows users to
37// override its override by #defining HIDE_EXPORTS (but note, this only obeys
38// the user's -fvisibility setting; it doesn't hide any exports on its own). We
39// imitate gcc's header here:
40# ifdef HIDE_EXPORTS
41# include_next <unwind.h>
42# else
43# pragma GCC visibility push(default)
44# include_next <unwind.h>
45# pragma GCC visibility pop
46# endif
Jeffrey Yasskinf18a87b2012-02-21 16:20:12 +000047# ifdef _SHOULD_UNDEFINE_GNU_SOURCE
48# undef _GNU_SOURCE
49# undef _SHOULD_UNDEFINE_GNU_SOURCE
50# endif
Rafael Espindolad85c1e92011-12-08 05:01:39 +000051#else
52
53#include <stdint.h>
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
Rafael Espindola9b7568d2011-12-09 00:08:01 +000059/* It is a bit strange for a header to play with the visibility of the
60 symbols it declares, but this matches gcc's behavior and some programs
61 depend on it */
62#pragma GCC visibility push(default)
63
Rafael Espindolad85c1e92011-12-08 05:01:39 +000064struct _Unwind_Context;
65typedef enum {
66 _URC_NO_REASON = 0,
67 _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
68
69 _URC_FATAL_PHASE2_ERROR = 2,
70 _URC_FATAL_PHASE1_ERROR = 3,
71 _URC_NORMAL_STOP = 4,
72
73 _URC_END_OF_STACK = 5,
74 _URC_HANDLER_FOUND = 6,
75 _URC_INSTALL_CONTEXT = 7,
76 _URC_CONTINUE_UNWIND = 8
77} _Unwind_Reason_Code;
78
Evgeniy Stepanovf5f18bf2012-01-19 11:39:05 +000079
80#ifdef __arm__
81
Logan Chien38c5d0a2012-11-14 06:33:58 +000082typedef enum {
83 _UVRSC_CORE = 0, /* integer register */
84 _UVRSC_VFP = 1, /* vfp */
85 _UVRSC_WMMXD = 3, /* Intel WMMX data register */
86 _UVRSC_WMMXC = 4 /* Intel WMMX control register */
87} _Unwind_VRS_RegClass;
Evgeniy Stepanovf5f18bf2012-01-19 11:39:05 +000088
Logan Chien38c5d0a2012-11-14 06:33:58 +000089typedef enum {
90 _UVRSD_UINT32 = 0,
91 _UVRSD_VFPX = 1,
92 _UVRSD_UINT64 = 3,
93 _UVRSD_FLOAT = 4,
94 _UVRSD_DOUBLE = 5
95} _Unwind_VRS_DataRepresentation;
Evgeniy Stepanovf5f18bf2012-01-19 11:39:05 +000096
Logan Chien38c5d0a2012-11-14 06:33:58 +000097typedef enum {
98 _UVRSR_OK = 0,
99 _UVRSR_NOT_IMPLEMENTED = 1,
100 _UVRSR_FAILED = 2
101} _Unwind_VRS_Result;
Evgeniy Stepanovf5f18bf2012-01-19 11:39:05 +0000102
Logan Chienc5e3df72012-09-26 06:35:17 +0000103_Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *context,
Evgeniy Stepanovf5f18bf2012-01-19 11:39:05 +0000104 _Unwind_VRS_RegClass regclass,
105 uint32_t regno,
106 _Unwind_VRS_DataRepresentation representation,
107 void *valuep);
108
109#else
110
Rafael Espindolad85c1e92011-12-08 05:01:39 +0000111uintptr_t _Unwind_GetIP(struct _Unwind_Context* context);
Evgeniy Stepanovf5f18bf2012-01-19 11:39:05 +0000112
113#endif
114
Rafael Espindolad85c1e92011-12-08 05:01:39 +0000115typedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context*, void*);
116_Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void*);
117
Rafael Espindola9b7568d2011-12-09 00:08:01 +0000118#pragma GCC visibility pop
119
Rafael Espindolad85c1e92011-12-08 05:01:39 +0000120#ifdef __cplusplus
121}
122#endif
123
124#endif