src/libstd/rt/libunwind.rs

   1 // Copyright 2014-2015 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 //! Unwind library interface
  12
  13 #![allow(non_upper_case_globals)]
  14 #![allow(non_camel_case_types)]
  15 #![allow(non_snake_case)]
  16 #![allow(dead_code)] // these are just bindings
  17
  18 #[cfg(any(not(target_arch = "arm"), target_os = "ios"))]
  19 pub use self::_Unwind_Action::*;
  20 #[cfg(target_arch = "arm")]
  21 pub use self::_Unwind_State::*;
  22 pub use self::_Unwind_Reason_Code::*;
  23
  24 use libc;
  25
  26 #[cfg(any(not(target_arch = "arm"), target_os = "ios"))]
  27 #[repr(C)]
  28 #[derive(Copy, Clone)]
  29 pub enum _Unwind_Action {
  30     _UA_SEARCH_PHASE = 1,
  31     _UA_CLEANUP_PHASE = 2,
  32     _UA_HANDLER_FRAME = 4,
  33     _UA_FORCE_UNWIND = 8,
  34     _UA_END_OF_STACK = 16,
  35 }
  36
  37 #[cfg(target_arch = "arm")]
  38 #[repr(C)]
  39 pub enum _Unwind_State {
  40     _US_VIRTUAL_UNWIND_FRAME = 0,
  41     _US_UNWIND_FRAME_STARTING = 1,
  42     _US_UNWIND_FRAME_RESUME = 2,
  43     _US_ACTION_MASK = 3,
  44     _US_FORCE_UNWIND = 8,
  45     _US_END_OF_STACK = 16
  46 }
  47
  48 #[repr(C)]
  49 pub enum _Unwind_Reason_Code {
  50     _URC_NO_REASON = 0,
  51     _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
  52     _URC_FATAL_PHASE2_ERROR = 2,
  53     _URC_FATAL_PHASE1_ERROR = 3,
  54     _URC_NORMAL_STOP = 4,
  55     _URC_END_OF_STACK = 5,
  56     _URC_HANDLER_FOUND = 6,
  57     _URC_INSTALL_CONTEXT = 7,
  58     _URC_CONTINUE_UNWIND = 8,
  59     _URC_FAILURE = 9, // used only by ARM EABI
  60 }
  61
  62 pub type _Unwind_Exception_Class = u64;
  63
  64 pub type _Unwind_Word = libc::uintptr_t;
  65
  66 #[cfg(target_arch = "x86")]
  67 pub const unwinder_private_data_size: usize = 5;
  68
  69 #[cfg(target_arch = "x86_64")]
  70 pub const unwinder_private_data_size: usize = 6;
  71
  72 #[cfg(all(target_arch = "arm", not(target_os = "ios")))]
  73 pub const unwinder_private_data_size: usize = 20;
  74
  75 #[cfg(all(target_arch = "arm", target_os = "ios"))]
  76 pub const unwinder_private_data_size: usize = 5;
  77
  78 #[cfg(target_arch = "aarch64")]
  79 pub const unwinder_private_data_size: usize = 2;
  80
  81 #[cfg(any(target_arch = "mips", target_arch = "mipsel"))]
  82 pub const unwinder_private_data_size: usize = 2;
  83
  84 #[cfg(target_arch = "powerpc")]
  85 pub const unwinder_private_data_size: usize = 2;
  86
  87 #[repr(C)]
  88 pub struct _Unwind_Exception {
  89     pub exception_class: _Unwind_Exception_Class,
  90     pub exception_cleanup: _Unwind_Exception_Cleanup_Fn,
  91     pub private: [_Unwind_Word; unwinder_private_data_size],
  92 }
  93
  94 pub enum _Unwind_Context {}
  95
  96 pub type _Unwind_Exception_Cleanup_Fn =
  97         extern "C" fn(unwind_code: _Unwind_Reason_Code,
  98                       exception: *mut _Unwind_Exception);
  99
 100 #[cfg(any(all(target_os = "linux", not(target_env = "musl")),
 101           target_os = "freebsd"))]
 102 #[link(name = "gcc_s")]
 103 extern {}
 104
 105 #[cfg(all(target_os = "linux", target_env = "musl", not(test)))]
 106 #[link(name = "unwind", kind = "static")]
 107 extern {}
 108
 109 #[cfg(any(target_os = "android", target_os = "openbsd"))]
 110 #[link(name = "gcc")]
 111 extern {}
 112
 113 #[cfg(target_os = "dragonfly")]
 114 #[link(name = "gcc_pic")]
 115 extern {}
 116
 117 #[cfg(target_os = "bitrig")]
 118 #[link(name = "c++abi")]
 119 extern {}
 120
 121 extern "C" {
 122     // iOS on armv7 uses SjLj exceptions and requires to link
 123     // against corresponding routine (..._SjLj_...)
 124     #[cfg(not(all(target_os = "ios", target_arch = "arm")))]
 125     pub fn _Unwind_RaiseException(exception: *mut _Unwind_Exception)
 126                                   -> _Unwind_Reason_Code;
 127
 128     #[cfg(all(target_os = "ios", target_arch = "arm"))]
 129     fn _Unwind_SjLj_RaiseException(e: *mut _Unwind_Exception)
 130                                    -> _Unwind_Reason_Code;
 131
 132     pub fn _Unwind_DeleteException(exception: *mut _Unwind_Exception);
 133 }
 134
 135 // ... and now we just providing access to SjLj counterspart
 136 // through a standard name to hide those details from others
 137 // (see also comment above regarding _Unwind_RaiseException)
 138 #[cfg(all(target_os = "ios", target_arch = "arm"))]
 139 #[inline(always)]
 140 pub unsafe fn _Unwind_RaiseException(exc: *mut _Unwind_Exception)
 141                                      -> _Unwind_Reason_Code {
 142     _Unwind_SjLj_RaiseException(exc)
 143 }