unwind.h revision 4f918aed75d4927e88365541c7200f0b5fe5014b
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 26ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#ifndef __CLANG_UNWIND_H 27ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#define __CLANG_UNWIND_H 28ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer 29f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin#if __has_include_next(<unwind.h>) 30f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin/* Darwin and libunwind provide an unwind.h. If that's available, use 31f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin * it. libunwind wraps some of its definitions in #ifdef _GNU_SOURCE, 32f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin * so define that around the include.*/ 33f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# ifndef _GNU_SOURCE 34f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# define _SHOULD_UNDEFINE_GNU_SOURCE 35f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# define _GNU_SOURCE 36f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# endif 37be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// libunwind's unwind.h reflects the current visibility. However, Mozilla 38be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// builds with -fvisibility=hidden and relies on gcc's unwind.h to reset the 39be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// visibility to default and export its contents. gcc also allows users to 40be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// override its override by #defining HIDE_EXPORTS (but note, this only obeys 41be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// the user's -fvisibility setting; it doesn't hide any exports on its own). We 42be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola// imitate gcc's header here: 43be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# ifdef HIDE_EXPORTS 44be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# include_next <unwind.h> 45be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# else 46be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# pragma GCC visibility push(default) 47be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# include_next <unwind.h> 48be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# pragma GCC visibility pop 49be5ff2f830d1833891051472d29818aa9f783cceRafael Espindola# endif 50f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# ifdef _SHOULD_UNDEFINE_GNU_SOURCE 51f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# undef _GNU_SOURCE 52f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# undef _SHOULD_UNDEFINE_GNU_SOURCE 53f18a87b1ce1be5ccc3b6b3dbd4f15374710e237bJeffrey Yasskin# endif 54d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#else 55d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 56d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#include <stdint.h> 57d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 58d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#ifdef __cplusplus 59d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolaextern "C" { 60d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#endif 61d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 629b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola/* It is a bit strange for a header to play with the visibility of the 639b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola symbols it declares, but this matches gcc's behavior and some programs 649b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola depend on it */ 65ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#ifndef HIDE_EXPORTS 669b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola#pragma GCC visibility push(default) 67ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#endif 689b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola 69d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolastruct _Unwind_Context; 70d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolatypedef enum { 71d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_NO_REASON = 0, 72d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_FOREIGN_EXCEPTION_CAUGHT = 1, 73d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 74d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_FATAL_PHASE2_ERROR = 2, 75d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_FATAL_PHASE1_ERROR = 3, 76d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_NORMAL_STOP = 4, 77d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 78d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_END_OF_STACK = 5, 79d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_HANDLER_FOUND = 6, 80d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_INSTALL_CONTEXT = 7, 81d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola _URC_CONTINUE_UNWIND = 8 82d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola} _Unwind_Reason_Code; 83d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 84f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 85f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov#ifdef __arm__ 86f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 8738c5d0a8f33f11661501760c67398e66e327e501Logan Chientypedef enum { 8838c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_CORE = 0, /* integer register */ 8938c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_VFP = 1, /* vfp */ 9038c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_WMMXD = 3, /* Intel WMMX data register */ 9138c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSC_WMMXC = 4 /* Intel WMMX control register */ 9238c5d0a8f33f11661501760c67398e66e327e501Logan Chien} _Unwind_VRS_RegClass; 9338c5d0a8f33f11661501760c67398e66e327e501Logan Chien 9438c5d0a8f33f11661501760c67398e66e327e501Logan Chientypedef enum { 9538c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_UINT32 = 0, 9638c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_VFPX = 1, 9738c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_UINT64 = 3, 9838c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_FLOAT = 4, 9938c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSD_DOUBLE = 5 10038c5d0a8f33f11661501760c67398e66e327e501Logan Chien} _Unwind_VRS_DataRepresentation; 10138c5d0a8f33f11661501760c67398e66e327e501Logan Chien 10238c5d0a8f33f11661501760c67398e66e327e501Logan Chientypedef enum { 10338c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSR_OK = 0, 10438c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSR_NOT_IMPLEMENTED = 1, 10538c5d0a8f33f11661501760c67398e66e327e501Logan Chien _UVRSR_FAILED = 2 10638c5d0a8f33f11661501760c67398e66e327e501Logan Chien} _Unwind_VRS_Result; 107f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 1084f918aed75d4927e88365541c7200f0b5fe5014bDavid Blaikie_Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *__context, 1094f918aed75d4927e88365541c7200f0b5fe5014bDavid Blaikie _Unwind_VRS_RegClass __regclass, 1104f918aed75d4927e88365541c7200f0b5fe5014bDavid Blaikie uint32_t __regno, 1114f918aed75d4927e88365541c7200f0b5fe5014bDavid Blaikie _Unwind_VRS_DataRepresentation __representation, 1124f918aed75d4927e88365541c7200f0b5fe5014bDavid Blaikie void *__valuep); 113f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 114f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov#else 115f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 1164f918aed75d4927e88365541c7200f0b5fe5014bDavid Blaikieuintptr_t _Unwind_GetIP(struct _Unwind_Context* __context); 117f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 118f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov#endif 119f5f18bfde0e46c154cf0207c895f917d0b50d53fEvgeniy Stepanov 120d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindolatypedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context*, void*); 121d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola_Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void*); 122d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 123ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#ifndef HIDE_EXPORTS 1249b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola#pragma GCC visibility pop 125ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#endif 1269b7568da31b0dc97e15253391cb100e9958d3d78Rafael Espindola 127d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#ifdef __cplusplus 128d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola} 129d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#endif 130d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola 131d85c1e9800213d2a8750215f6980ae67411cac72Rafael Espindola#endif 132ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer 133ccdb2a5e0ab4b0a7fc9d3859c6bb1676182169d5Benjamin Kramer#endif /* __CLANG_UNWIND_H */ 134