unwind.h revision 38c5d0a8f33f11661501760c67398e66e327e501
1d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola/*===---- unwind.h - Stack unwinding ----------------------------------------=== 2d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * 3d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * Permission is hereby granted, free of charge, to any person obtaining a copy 4d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * of this software and associated documentation files (the "Software"), to deal 5d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * in the Software without restriction, including without limitation the rights 6d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * copies of the Software, and to permit persons to whom the Software is 8d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * furnished to do so, subject to the following conditions: 9d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * 10d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * The above copyright notice and this permission notice shall be included in 11d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * all copies or substantial portions of the Software. 12d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * 13d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * THE SOFTWARE. 20d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola * 21d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola *===-----------------------------------------------------------------------=== 22d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola */ 23d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 24d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola/* See "Data Definitions for libgcc_s" in the Linux Standard Base.*/ 25d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 26f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin#if __has_include_next(<unwind.h>) 27f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin/* Darwin and libunwind provide an unwind.h. If that's available, use 28f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin * it. libunwind wraps some of its definitions in #ifdef _GNU_SOURCE, 29f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin * so define that around the include.*/ 30f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# ifndef _GNU_SOURCE 31f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# define _SHOULD_UNDEFINE_GNU_SOURCE 32f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# define _GNU_SOURCE 33f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# endif 34be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// libunwind's unwind.h reflects the current visibility. However, Mozilla 35be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// builds with -fvisibility=hidden and relies on gcc's unwind.h to reset the 36be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// visibility to default and export its contents. gcc also allows users to 37be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// override its override by #defining HIDE_EXPORTS (but note, this only obeys 38be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// the user's -fvisibility setting; it doesn't hide any exports on its own). We 39be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// imitate gcc's header here: 40be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# ifdef HIDE_EXPORTS 41be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# include_next <unwind.h> 42be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# else 43be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# pragma GCC visibility push(default) 44be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# include_next <unwind.h> 45be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# pragma GCC visibility pop 46be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# endif 47f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# ifdef _SHOULD_UNDEFINE_GNU_SOURCE 48f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# undef _GNU_SOURCE 49f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# undef _SHOULD_UNDEFINE_GNU_SOURCE 50f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# endif 51d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#else 52d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 53d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#include <stdint.h> 54d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 55d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#ifdef __cplusplus 56d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolaextern "C" { 57d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#endif 58d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 599b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola/* It is a bit strange for a header to play with the visibility of the 609b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola symbols it declares, but this matches gcc's behavior and some programs 619b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola depend on it */ 629b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola#pragma GCC visibility push(default) 639b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola 64d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolastruct _Unwind_Context; 65d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolatypedef enum { 66d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_NO_REASON = 0, 67d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_FOREIGN_EXCEPTION_CAUGHT = 1, 68d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 69d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_FATAL_PHASE2_ERROR = 2, 70d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_FATAL_PHASE1_ERROR = 3, 71d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_NORMAL_STOP = 4, 72d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 73d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_END_OF_STACK = 5, 74d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_HANDLER_FOUND = 6, 75d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_INSTALL_CONTEXT = 7, 76d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_CONTINUE_UNWIND = 8 77d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola} _Unwind_Reason_Code; 78d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 79f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 80f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov#ifdef __arm__ 81f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 8238c5d0a8f33f11661501760c67398e66e327e501Logan Chientypedef enum { 8338c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_CORE = 0, /* integer register */ 8438c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_VFP = 1, /* vfp */ 8538c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_WMMXD = 3, /* Intel WMMX data register */ 8638c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_WMMXC = 4 /* Intel WMMX control register */ 8738c5d0a8f33f11661501760c67398e66e327e501Logan Chien} _Unwind_VRS_RegClass; 8838c5d0a8f33f11661501760c67398e66e327e501Logan Chien 8938c5d0a8f33f11661501760c67398e66e327e501Logan Chientypedef enum { 9038c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_UINT32 = 0, 9138c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_VFPX = 1, 9238c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_UINT64 = 3, 9338c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_FLOAT = 4, 9438c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_DOUBLE = 5 9538c5d0a8f33f11661501760c67398e66e327e501Logan Chien} _Unwind_VRS_DataRepresentation; 9638c5d0a8f33f11661501760c67398e66e327e501Logan Chien 9738c5d0a8f33f11661501760c67398e66e327e501Logan Chientypedef enum { 9838c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSR_OK = 0, 9938c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSR_NOT_IMPLEMENTED = 1, 10038c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSR_FAILED = 2 10138c5d0a8f33f11661501760c67398e66e327e501Logan Chien} _Unwind_VRS_Result; 102f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 103c5e3df7d9951502fe016445f1c93dc9a3efea4dfLogan Chien_Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *context, 104f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov _Unwind_VRS_RegClass regclass, 105f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov uint32_t regno, 106f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov _Unwind_VRS_DataRepresentation representation, 107f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov void *valuep); 108f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 109f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov#else 110f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 111d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolauintptr_t _Unwind_GetIP(struct _Unwind_Context* context); 112f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 113f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov#endif 114f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 115d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolatypedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context*, void*); 116d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola_Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void*); 117d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 1189b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola#pragma GCC visibility pop 1199b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola 120d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#ifdef __cplusplus 121d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola} 122d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#endif 123d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 124d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#endif 125