src/libunwind/libunwind.rs

   1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #![allow(bad_style)]
  12
  13 macro_rules! cfg_if {
  14     ( $( if #[cfg( $meta:meta )] { $($it1:item)* } else { $($it2:item)* } )* ) =>
  15         ( $( $( #[cfg($meta)] $it1)* $( #[cfg(not($meta))] $it2)* )* )
  16 }
  17
  18 use libc::{c_int, c_void, uintptr_t};
  19
  20 #[repr(C)]
  21 #[derive(Copy, Clone, PartialEq)]
  22 pub enum _Unwind_Reason_Code {
  23     _URC_NO_REASON = 0,
  24     _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
  25     _URC_FATAL_PHASE2_ERROR = 2,
  26     _URC_FATAL_PHASE1_ERROR = 3,
  27     _URC_NORMAL_STOP = 4,
  28     _URC_END_OF_STACK = 5,
  29     _URC_HANDLER_FOUND = 6,
  30     _URC_INSTALL_CONTEXT = 7,
  31     _URC_CONTINUE_UNWIND = 8,
  32     _URC_FAILURE = 9, // used only by ARM EHABI
  33 }
  34 pub use self::_Unwind_Reason_Code::*;
  35
  36 pub type _Unwind_Exception_Class = u64;
  37 pub type _Unwind_Word = uintptr_t;
  38 pub type _Unwind_Ptr = uintptr_t;
  39 pub type _Unwind_Trace_Fn = extern "C" fn(ctx: *mut _Unwind_Context, arg: *mut c_void)
  40                                           -> _Unwind_Reason_Code;
  41 #[cfg(target_arch = "x86")]
  42 pub const unwinder_private_data_size: usize = 5;
  43
  44 #[cfg(target_arch = "x86_64")]
  45 pub const unwinder_private_data_size: usize = 6;
  46
  47 #[cfg(all(target_arch = "arm", not(target_os = "ios")))]
  48 pub const unwinder_private_data_size: usize = 20;
  49
  50 #[cfg(all(target_arch = "arm", target_os = "ios"))]
  51 pub const unwinder_private_data_size: usize = 5;
  52
  53 #[cfg(target_arch = "aarch64")]
  54 pub const unwinder_private_data_size: usize = 2;
  55
  56 #[cfg(target_arch = "mips")]
  57 pub const unwinder_private_data_size: usize = 2;
  58
  59 #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64"))]
  60 pub const unwinder_private_data_size: usize = 2;
  61
  62 #[cfg(target_arch = "asmjs")]
  63 // FIXME: Copied from arm. Need to confirm.
  64 pub const unwinder_private_data_size: usize = 20;
  65
  66 #[repr(C)]
  67 pub struct _Unwind_Exception {
  68     pub exception_class: _Unwind_Exception_Class,
  69     pub exception_cleanup: _Unwind_Exception_Cleanup_Fn,
  70     pub private: [_Unwind_Word; unwinder_private_data_size],
  71 }
  72
  73 pub enum _Unwind_Context {}
  74
  75 pub type _Unwind_Exception_Cleanup_Fn = extern "C" fn(unwind_code: _Unwind_Reason_Code,
  76                                                       exception: *mut _Unwind_Exception);
  77 extern "C" {
  78     #[unwind]
  79     pub fn _Unwind_Resume(exception: *mut _Unwind_Exception) -> !;
  80     pub fn _Unwind_DeleteException(exception: *mut _Unwind_Exception);
  81     pub fn _Unwind_GetLanguageSpecificData(ctx: *mut _Unwind_Context) -> *mut c_void;
  82     pub fn _Unwind_GetRegionStart(ctx: *mut _Unwind_Context) -> _Unwind_Ptr;
  83     pub fn _Unwind_GetTextRelBase(ctx: *mut _Unwind_Context) -> _Unwind_Ptr;
  84     pub fn _Unwind_GetDataRelBase(ctx: *mut _Unwind_Context) -> _Unwind_Ptr;
  85 }
  86
  87 cfg_if! {
  88 if #[cfg(not(any(all(target_os = "android", target_arch = "arm"),
  89                  all(target_os = "linux", target_arch = "arm"))))] {
  90     // Not ARM EHABI
  91     #[repr(C)]
  92     #[derive(Copy, Clone, PartialEq)]
  93     pub enum _Unwind_Action {
  94         _UA_SEARCH_PHASE = 1,
  95         _UA_CLEANUP_PHASE = 2,
  96         _UA_HANDLER_FRAME = 4,
  97         _UA_FORCE_UNWIND = 8,
  98         _UA_END_OF_STACK = 16,
  99     }
 100     pub use self::_Unwind_Action::*;
 101
 102     extern "C" {
 103         pub fn _Unwind_GetGR(ctx: *mut _Unwind_Context, reg_index: c_int) -> _Unwind_Word;
 104         pub fn _Unwind_SetGR(ctx: *mut _Unwind_Context, reg_index: c_int, value: _Unwind_Word);
 105         pub fn _Unwind_GetIP(ctx: *mut _Unwind_Context) -> _Unwind_Word;
 106         pub fn _Unwind_SetIP(ctx: *mut _Unwind_Context, value: _Unwind_Word);
 107         pub fn _Unwind_GetIPInfo(ctx: *mut _Unwind_Context, ip_before_insn: *mut c_int)
 108                                  -> _Unwind_Word;
 109         pub fn _Unwind_FindEnclosingFunction(pc: *mut c_void) -> *mut c_void;
 110     }
 111
 112 } else {
 113     // ARM EHABI
 114     #[repr(C)]
 115     #[derive(Copy, Clone, PartialEq)]
 116     pub enum _Unwind_State {
 117         _US_VIRTUAL_UNWIND_FRAME = 0,
 118         _US_UNWIND_FRAME_STARTING = 1,
 119         _US_UNWIND_FRAME_RESUME = 2,
 120         _US_ACTION_MASK = 3,
 121         _US_FORCE_UNWIND = 8,
 122         _US_END_OF_STACK = 16,
 123     }
 124     pub use self::_Unwind_State::*;
 125
 126     #[repr(C)]
 127     enum _Unwind_VRS_Result {
 128         _UVRSR_OK = 0,
 129         _UVRSR_NOT_IMPLEMENTED = 1,
 130         _UVRSR_FAILED = 2,
 131     }
 132     #[repr(C)]
 133     enum _Unwind_VRS_RegClass {
 134         _UVRSC_CORE = 0,
 135         _UVRSC_VFP = 1,
 136         _UVRSC_FPA = 2,
 137         _UVRSC_WMMXD = 3,
 138         _UVRSC_WMMXC = 4,
 139     }
 140     use self::_Unwind_VRS_RegClass::*;
 141     #[repr(C)]
 142     enum _Unwind_VRS_DataRepresentation {
 143         _UVRSD_UINT32 = 0,
 144         _UVRSD_VFPX = 1,
 145         _UVRSD_FPAX = 2,
 146         _UVRSD_UINT64 = 3,
 147         _UVRSD_FLOAT = 4,
 148         _UVRSD_DOUBLE = 5,
 149     }
 150     use self::_Unwind_VRS_DataRepresentation::*;
 151
 152     pub const UNWIND_POINTER_REG: c_int = 12;
 153     pub const UNWIND_IP_REG: c_int = 15;
 154
 155     extern "C" {
 156         fn _Unwind_VRS_Get(ctx: *mut _Unwind_Context,
 157                            regclass: _Unwind_VRS_RegClass,
 158                            regno: _Unwind_Word,
 159                            repr: _Unwind_VRS_DataRepresentation,
 160                            data: *mut c_void)
 161                            -> _Unwind_VRS_Result;
 162
 163         fn _Unwind_VRS_Set(ctx: *mut _Unwind_Context,
 164                            regclass: _Unwind_VRS_RegClass,
 165                            regno: _Unwind_Word,
 166                            repr: _Unwind_VRS_DataRepresentation,
 167                            data: *mut c_void)
 168                            -> _Unwind_VRS_Result;
 169     }
 170
 171     // On Android or ARM/Linux, these are implemented as macros:
 172
 173     pub unsafe fn _Unwind_GetGR(ctx: *mut _Unwind_Context, reg_index: c_int) -> _Unwind_Word {
 174         let mut val: _Unwind_Word = 0;
 175         _Unwind_VRS_Get(ctx, _UVRSC_CORE, reg_index as _Unwind_Word, _UVRSD_UINT32,
 176                         &mut val as *mut _ as *mut c_void);
 177         val
 178     }
 179
 180     pub unsafe fn _Unwind_SetGR(ctx: *mut _Unwind_Context, reg_index: c_int, value: _Unwind_Word) {
 181         let mut value = value;
 182         _Unwind_VRS_Set(ctx, _UVRSC_CORE, reg_index as _Unwind_Word, _UVRSD_UINT32,
 183                         &mut value as *mut _ as *mut c_void);
 184     }
 185
 186     pub unsafe fn _Unwind_GetIP(ctx: *mut _Unwind_Context)
 187                                 -> _Unwind_Word {
 188         let val = _Unwind_GetGR(ctx, UNWIND_IP_REG);
 189         (val & !1) as _Unwind_Word
 190     }
 191
 192     pub unsafe fn _Unwind_SetIP(ctx: *mut _Unwind_Context,
 193                                 value: _Unwind_Word) {
 194         // Propagate thumb bit to instruction pointer
 195         let thumb_state = _Unwind_GetGR(ctx, UNWIND_IP_REG) & 1;
 196         let value = value | thumb_state;
 197         _Unwind_SetGR(ctx, UNWIND_IP_REG, value);
 198     }
 199
 200     pub unsafe fn _Unwind_GetIPInfo(ctx: *mut _Unwind_Context,
 201                                     ip_before_insn: *mut c_int)
 202                                     -> _Unwind_Word {
 203         *ip_before_insn = 0;
 204         _Unwind_GetIP(ctx)
 205     }
 206
 207     // This function also doesn't exist on Android or ARM/Linux, so make it a no-op
 208     pub unsafe fn _Unwind_FindEnclosingFunction(pc: *mut c_void) -> *mut c_void {
 209         pc
 210     }
 211 }
 212
 213 if #[cfg(not(all(target_os = "ios", target_arch = "arm")))] {
 214     // Not 32-bit iOS
 215     extern "C" {
 216         #[unwind]
 217         pub fn _Unwind_RaiseException(exception: *mut _Unwind_Exception) -> _Unwind_Reason_Code;
 218         pub fn _Unwind_Backtrace(trace: _Unwind_Trace_Fn,
 219                                  trace_argument: *mut c_void)
 220                                  -> _Unwind_Reason_Code;
 221     }
 222 } else {
 223     // 32-bit iOS uses SjLj and does not provide _Unwind_Backtrace()
 224     extern "C" {
 225         #[unwind]
 226         pub fn _Unwind_SjLj_RaiseException(e: *mut _Unwind_Exception) -> _Unwind_Reason_Code;
 227     }
 228
 229     #[inline]
 230     pub unsafe fn _Unwind_RaiseException(exc: *mut _Unwind_Exception) -> _Unwind_Reason_Code {
 231         _Unwind_SjLj_RaiseException(exc)
 232     }
 233 }
 234 } // cfg_if!
 235
 236 #[cfg_attr(any(all(target_os = "linux", not(target_env = "musl")),
 237                target_os = "freebsd",
 238                target_os = "solaris",
 239                all(target_os = "linux",
 240                    target_env = "musl",
 241                    not(target_arch = "x86"),
 242                    not(target_arch = "x86_64"))),
 243            link(name = "gcc_s"))]
 244 #[cfg_attr(all(target_os = "linux",
 245                target_env = "musl",
 246                any(target_arch = "x86", target_arch = "x86_64"),
 247                not(test)),
 248            link(name = "unwind", kind = "static"))]
 249 #[cfg_attr(any(target_os = "android", target_os = "openbsd"),
 250            link(name = "gcc"))]
 251 #[cfg_attr(all(target_os = "netbsd", not(target_vendor = "rumprun")),
 252            link(name = "gcc"))]
 253 #[cfg_attr(all(target_os = "netbsd", target_vendor = "rumprun"),
 254            link(name = "unwind"))]
 255 #[cfg_attr(target_os = "dragonfly",
 256            link(name = "gcc_pic"))]
 257 #[cfg_attr(target_os = "bitrig",
 258            link(name = "c++abi"))]
 259 #[cfg_attr(all(target_os = "windows", target_env = "gnu"),
 260            link(name = "gcc_eh"))]
 261 #[cfg(not(cargobuild))]
 262 extern "C" {}