library/unwind/src/libunwind.rs

   1 #![allow(nonstandard_style)]
   2
   3 use libc::{c_int, c_void, uintptr_t};
   4
   5 #[repr(C)]
   6 #[derive(Debug, Copy, Clone, PartialEq)]
   7 pub enum _Unwind_Reason_Code {
   8     _URC_NO_REASON = 0,
   9     _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
  10     _URC_FATAL_PHASE2_ERROR = 2,
  11     _URC_FATAL_PHASE1_ERROR = 3,
  12     _URC_NORMAL_STOP = 4,
  13     _URC_END_OF_STACK = 5,
  14     _URC_HANDLER_FOUND = 6,
  15     _URC_INSTALL_CONTEXT = 7,
  16     _URC_CONTINUE_UNWIND = 8,
  17     _URC_FAILURE = 9, // used only by ARM EHABI
  18 }
  19 pub use _Unwind_Reason_Code::*;
  20
  21 pub type _Unwind_Exception_Class = u64;
  22 pub type _Unwind_Word = uintptr_t;
  23 pub type _Unwind_Ptr = uintptr_t;
  24 pub type _Unwind_Trace_Fn =
  25     extern "C" fn(ctx: *mut _Unwind_Context, arg: *mut c_void) -> _Unwind_Reason_Code;
  26
  27 #[cfg(target_arch = "x86")]
  28 pub const unwinder_private_data_size: usize = 5;
  29
  30 #[cfg(target_arch = "x86_64")]
  31 pub const unwinder_private_data_size: usize = 6;
  32
  33 #[cfg(all(target_arch = "arm", not(target_os = "ios")))]
  34 pub const unwinder_private_data_size: usize = 20;
  35
  36 #[cfg(all(target_arch = "arm", target_os = "ios"))]
  37 pub const unwinder_private_data_size: usize = 5;
  38
  39 #[cfg(all(target_arch = "aarch64", target_pointer_width = "64"))]
  40 pub const unwinder_private_data_size: usize = 2;
  41
  42 #[cfg(all(target_arch = "aarch64", target_pointer_width = "32"))]
  43 pub const unwinder_private_data_size: usize = 5;
  44
  45 #[cfg(target_arch = "mips")]
  46 pub const unwinder_private_data_size: usize = 2;
  47
  48 #[cfg(target_arch = "mips64")]
  49 pub const unwinder_private_data_size: usize = 2;
  50
  51 #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64"))]
  52 pub const unwinder_private_data_size: usize = 2;
  53
  54 #[cfg(target_arch = "s390x")]
  55 pub const unwinder_private_data_size: usize = 2;
  56
  57 #[cfg(any(target_arch = "sparc", target_arch = "sparc64"))]
  58 pub const unwinder_private_data_size: usize = 2;
  59
  60 #[cfg(any(target_arch = "riscv64", target_arch = "riscv32"))]
  61 pub const unwinder_private_data_size: usize = 2;
  62
  63 #[cfg(target_os = "emscripten")]
  64 pub const unwinder_private_data_size: usize = 20;
  65
  66 #[cfg(all(target_arch = "hexagon", target_os = "linux"))]
  67 pub const unwinder_private_data_size: usize = 35;
  68
  69 #[repr(C)]
  70 pub struct _Unwind_Exception {
  71     pub exception_class: _Unwind_Exception_Class,
  72     pub exception_cleanup: _Unwind_Exception_Cleanup_Fn,
  73     pub private: [_Unwind_Word; unwinder_private_data_size],
  74 }
  75
  76 pub enum _Unwind_Context {}
  77
  78 pub type _Unwind_Exception_Cleanup_Fn =
  79     extern "C" fn(unwind_code: _Unwind_Reason_Code, exception: *mut _Unwind_Exception);
  80 #[cfg_attr(
  81     all(feature = "llvm-libunwind", any(target_os = "fuchsia", target_os = "linux")),
  82     link(name = "unwind", kind = "static")
  83 )]
  84 extern "C" {
  85     #[unwind(allowed)]
  86     pub fn _Unwind_Resume(exception: *mut _Unwind_Exception) -> !;
  87     pub fn _Unwind_DeleteException(exception: *mut _Unwind_Exception);
  88     pub fn _Unwind_GetLanguageSpecificData(ctx: *mut _Unwind_Context) -> *mut c_void;
  89     pub fn _Unwind_GetRegionStart(ctx: *mut _Unwind_Context) -> _Unwind_Ptr;
  90     pub fn _Unwind_GetTextRelBase(ctx: *mut _Unwind_Context) -> _Unwind_Ptr;
  91     pub fn _Unwind_GetDataRelBase(ctx: *mut _Unwind_Context) -> _Unwind_Ptr;
  92 }
  93
  94 cfg_if::cfg_if! {
  95 if #[cfg(any(target_os = "ios", target_os = "netbsd", not(target_arch = "arm")))] {
  96     // Not ARM EHABI
  97     #[repr(C)]
  98     #[derive(Copy, Clone, PartialEq)]
  99     pub enum _Unwind_Action {
 100         _UA_SEARCH_PHASE = 1,
 101         _UA_CLEANUP_PHASE = 2,
 102         _UA_HANDLER_FRAME = 4,
 103         _UA_FORCE_UNWIND = 8,
 104         _UA_END_OF_STACK = 16,
 105     }
 106     pub use _Unwind_Action::*;
 107
 108     #[cfg_attr(all(feature = "llvm-libunwind",
 109                    any(target_os = "fuchsia", target_os = "linux")),
 110                link(name = "unwind", kind = "static"))]
 111     extern "C" {
 112         pub fn _Unwind_GetGR(ctx: *mut _Unwind_Context, reg_index: c_int) -> _Unwind_Word;
 113         pub fn _Unwind_SetGR(ctx: *mut _Unwind_Context, reg_index: c_int, value: _Unwind_Word);
 114         pub fn _Unwind_GetIP(ctx: *mut _Unwind_Context) -> _Unwind_Word;
 115         pub fn _Unwind_SetIP(ctx: *mut _Unwind_Context, value: _Unwind_Word);
 116         pub fn _Unwind_GetIPInfo(ctx: *mut _Unwind_Context, ip_before_insn: *mut c_int)
 117                                  -> _Unwind_Word;
 118         pub fn _Unwind_FindEnclosingFunction(pc: *mut c_void) -> *mut c_void;
 119     }
 120
 121 } else {
 122     // ARM EHABI
 123     #[repr(C)]
 124     #[derive(Copy, Clone, PartialEq)]
 125     pub enum _Unwind_State {
 126         _US_VIRTUAL_UNWIND_FRAME = 0,
 127         _US_UNWIND_FRAME_STARTING = 1,
 128         _US_UNWIND_FRAME_RESUME = 2,
 129         _US_ACTION_MASK = 3,
 130         _US_FORCE_UNWIND = 8,
 131         _US_END_OF_STACK = 16,
 132     }
 133     pub use _Unwind_State::*;
 134
 135     #[repr(C)]
 136     enum _Unwind_VRS_Result {
 137         _UVRSR_OK = 0,
 138         _UVRSR_NOT_IMPLEMENTED = 1,
 139         _UVRSR_FAILED = 2,
 140     }
 141     #[repr(C)]
 142     enum _Unwind_VRS_RegClass {
 143         _UVRSC_CORE = 0,
 144         _UVRSC_VFP = 1,
 145         _UVRSC_FPA = 2,
 146         _UVRSC_WMMXD = 3,
 147         _UVRSC_WMMXC = 4,
 148     }
 149     use _Unwind_VRS_RegClass::*;
 150     #[repr(C)]
 151     enum _Unwind_VRS_DataRepresentation {
 152         _UVRSD_UINT32 = 0,
 153         _UVRSD_VFPX = 1,
 154         _UVRSD_FPAX = 2,
 155         _UVRSD_UINT64 = 3,
 156         _UVRSD_FLOAT = 4,
 157         _UVRSD_DOUBLE = 5,
 158     }
 159     use _Unwind_VRS_DataRepresentation::*;
 160
 161     pub const UNWIND_POINTER_REG: c_int = 12;
 162     pub const UNWIND_SP_REG: c_int = 13;
 163     pub const UNWIND_IP_REG: c_int = 15;
 164
 165     #[cfg_attr(all(feature = "llvm-libunwind",
 166                    any(target_os = "fuchsia", target_os = "linux")),
 167                link(name = "unwind", kind = "static"))]
 168     extern "C" {
 169         fn _Unwind_VRS_Get(ctx: *mut _Unwind_Context,
 170                            regclass: _Unwind_VRS_RegClass,
 171                            regno: _Unwind_Word,
 172                            repr: _Unwind_VRS_DataRepresentation,
 173                            data: *mut c_void)
 174                            -> _Unwind_VRS_Result;
 175
 176         fn _Unwind_VRS_Set(ctx: *mut _Unwind_Context,
 177                            regclass: _Unwind_VRS_RegClass,
 178                            regno: _Unwind_Word,
 179                            repr: _Unwind_VRS_DataRepresentation,
 180                            data: *mut c_void)
 181                            -> _Unwind_VRS_Result;
 182     }
 183
 184     // On Android or ARM/Linux, these are implemented as macros:
 185
 186     pub unsafe fn _Unwind_GetGR(ctx: *mut _Unwind_Context, reg_index: c_int) -> _Unwind_Word {
 187         let mut val: _Unwind_Word = 0;
 188         _Unwind_VRS_Get(ctx, _UVRSC_CORE, reg_index as _Unwind_Word, _UVRSD_UINT32,
 189                         &mut val as *mut _ as *mut c_void);
 190         val
 191     }
 192
 193     pub unsafe fn _Unwind_SetGR(ctx: *mut _Unwind_Context, reg_index: c_int, value: _Unwind_Word) {
 194         let mut value = value;
 195         _Unwind_VRS_Set(ctx, _UVRSC_CORE, reg_index as _Unwind_Word, _UVRSD_UINT32,
 196                         &mut value as *mut _ as *mut c_void);
 197     }
 198
 199     pub unsafe fn _Unwind_GetIP(ctx: *mut _Unwind_Context)
 200                                 -> _Unwind_Word {
 201         let val = _Unwind_GetGR(ctx, UNWIND_IP_REG);
 202         (val & !1) as _Unwind_Word
 203     }
 204
 205     pub unsafe fn _Unwind_SetIP(ctx: *mut _Unwind_Context,
 206                                 value: _Unwind_Word) {
 207         // Propagate thumb bit to instruction pointer
 208         let thumb_state = _Unwind_GetGR(ctx, UNWIND_IP_REG) & 1;
 209         let value = value | thumb_state;
 210         _Unwind_SetGR(ctx, UNWIND_IP_REG, value);
 211     }
 212
 213     pub unsafe fn _Unwind_GetIPInfo(ctx: *mut _Unwind_Context,
 214                                     ip_before_insn: *mut c_int)
 215                                     -> _Unwind_Word {
 216         *ip_before_insn = 0;
 217         _Unwind_GetIP(ctx)
 218     }
 219
 220     // This function also doesn't exist on Android or ARM/Linux, so make it a no-op
 221     pub unsafe fn _Unwind_FindEnclosingFunction(pc: *mut c_void) -> *mut c_void {
 222         pc
 223     }
 224 }
 225 } // cfg_if!
 226
 227 cfg_if::cfg_if! {
 228 if #[cfg(not(all(target_os = "ios", target_arch = "arm")))] {
 229     // Not 32-bit iOS
 230     #[cfg_attr(all(feature = "llvm-libunwind",
 231                    any(target_os = "fuchsia", target_os = "linux")),
 232                link(name = "unwind", kind = "static"))]
 233     extern "C" {
 234         #[unwind(allowed)]
 235         pub fn _Unwind_RaiseException(exception: *mut _Unwind_Exception) -> _Unwind_Reason_Code;
 236         pub fn _Unwind_Backtrace(trace: _Unwind_Trace_Fn,
 237                                  trace_argument: *mut c_void)
 238                                  -> _Unwind_Reason_Code;
 239     }
 240 } else {
 241     // 32-bit iOS uses SjLj and does not provide _Unwind_Backtrace()
 242     #[cfg_attr(all(feature = "llvm-libunwind",
 243                    any(target_os = "fuchsia", target_os = "linux")),
 244                link(name = "unwind", kind = "static"))]
 245     extern "C" {
 246         #[unwind(allowed)]
 247         pub fn _Unwind_SjLj_RaiseException(e: *mut _Unwind_Exception) -> _Unwind_Reason_Code;
 248     }
 249
 250     #[inline]
 251     pub unsafe fn _Unwind_RaiseException(exc: *mut _Unwind_Exception) -> _Unwind_Reason_Code {
 252         _Unwind_SjLj_RaiseException(exc)
 253     }
 254 }
 255 } // cfg_if!
 256
 257 cfg_if::cfg_if! {
 258 if #[cfg(all(windows, target_arch = "x86_64", target_env = "gnu"))] {
 259     // We declare these as opaque types. This is fine since you just need to
 260     // pass them to _GCC_specific_handler and forget about them.
 261     pub enum EXCEPTION_RECORD {}
 262     pub type LPVOID = *mut c_void;
 263     pub enum CONTEXT {}
 264     pub enum DISPATCHER_CONTEXT {}
 265     pub type EXCEPTION_DISPOSITION = c_int;
 266     type PersonalityFn = unsafe extern "C" fn(version: c_int,
 267                                               actions: _Unwind_Action,
 268                                               exception_class: _Unwind_Exception_Class,
 269                                               exception_object: *mut _Unwind_Exception,
 270                                               context: *mut _Unwind_Context)
 271                                               -> _Unwind_Reason_Code;
 272
 273     extern "C" {
 274         pub fn _GCC_specific_handler(exceptionRecord: *mut EXCEPTION_RECORD,
 275                                 establisherFrame: LPVOID,
 276                                 contextRecord: *mut CONTEXT,
 277                                 dispatcherContext: *mut DISPATCHER_CONTEXT,
 278                                 personality: PersonalityFn)
 279                                 -> EXCEPTION_DISPOSITION;
 280     }
 281 }
 282 } // cfg_if!