Home | History | Annotate | Download | only in Headers 
      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 and libunwind provide an unwind.h. If that's available, use
     31  * 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
     59 extern "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 
     69 struct _Unwind_Context;
     70 typedef enum {
     71   _URC_NO_REASON = 0,
     72   _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
     73 
     74   _URC_FATAL_PHASE2_ERROR = 2,
     75   _URC_FATAL_PHASE1_ERROR = 3,
     76   _URC_NORMAL_STOP = 4,
     77 
     78   _URC_END_OF_STACK = 5,
     79   _URC_HANDLER_FOUND = 6,
     80   _URC_INSTALL_CONTEXT = 7,
     81   _URC_CONTINUE_UNWIND = 8
     82 } _Unwind_Reason_Code;
     83 
     84 
     85 #ifdef __arm__
     86 
     87 typedef enum {
     88   _UVRSC_CORE = 0,        /* integer register */
     89   _UVRSC_VFP = 1,         /* vfp */
     90   _UVRSC_WMMXD = 3,       /* Intel WMMX data register */
     91   _UVRSC_WMMXC = 4        /* Intel WMMX control register */
     92 } _Unwind_VRS_RegClass;
     93 
     94 typedef enum {
     95   _UVRSD_UINT32 = 0,
     96   _UVRSD_VFPX = 1,
     97   _UVRSD_UINT64 = 3,
     98   _UVRSD_FLOAT = 4,
     99   _UVRSD_DOUBLE = 5
    100 } _Unwind_VRS_DataRepresentation;
    101 
    102 typedef enum {
    103   _UVRSR_OK = 0,
    104   _UVRSR_NOT_IMPLEMENTED = 1,
    105   _UVRSR_FAILED = 2
    106 } _Unwind_VRS_Result;
    107 
    108 _Unwind_VRS_Result _Unwind_VRS_Get(struct _Unwind_Context *__context,
    109   _Unwind_VRS_RegClass __regclass,
    110   uint32_t __regno,
    111   _Unwind_VRS_DataRepresentation __representation,
    112   void *__valuep);
    113 
    114 #else
    115 
    116 uintptr_t _Unwind_GetIP(struct _Unwind_Context* __context);
    117 
    118 #endif
    119 
    120 typedef _Unwind_Reason_Code (*_Unwind_Trace_Fn)(struct _Unwind_Context*, void*);
    121 _Unwind_Reason_Code _Unwind_Backtrace(_Unwind_Trace_Fn, void*);
    122 
    123 #ifndef HIDE_EXPORTS
    124 #pragma GCC visibility pop
    125 #endif
    126 
    127 #ifdef __cplusplus
    128 }
    129 #endif
    130 
    131 #endif
    132 
    133 #endif /* __CLANG_UNWIND_H */
    134