src/libpanic_unwind/emcc.rs

   1 //! Unwinding for *emscripten* target.
   2 //!
   3 //! Whereas Rust's usual unwinding implementation for Unix platforms
   4 //! calls into the libunwind APIs directly, on Emscripten we instead
   5 //! call into the C++ unwinding APIs. This is just an expedience since
   6 //! Emscripten's runtime always implements those APIs and does not
   7 //! implement libunwind.
   8
   9 #![allow(private_no_mangle_fns)]
  10
  11 use alloc::boxed::Box;
  12 use core::any::Any;
  13 use core::mem;
  14 use core::ptr;
  15 use libc::{self, c_int};
  16 use unwind as uw;
  17
  18 // This matches the layout of std::type_info in C++
  19 #[repr(C)]
  20 struct TypeInfo {
  21     vtable: *const usize,
  22     name: *const u8,
  23 }
  24 unsafe impl Sync for TypeInfo {}
  25
  26 extern "C" {
  27     // The leading `\x01` byte here is actually a magical signal to LLVM to
  28     // *not* apply any other mangling like prefixing with a `_` character.
  29     //
  30     // This symbol is the vtable used by C++'s `std::type_info`. Objects of type
  31     // `std::type_info`, type descriptors, have a pointer to this table. Type
  32     // descriptors are referenced by the C++ EH structures defined above and
  33     // that we construct below.
  34     //
  35     // Note that the real size is larger than 3 usize, but we only need our
  36     // vtable to point to the third element.
  37     #[link_name = "\x01_ZTVN10__cxxabiv117__class_type_infoE"]
  38     static CLASS_TYPE_INFO_VTABLE: [usize; 3];
  39 }
  40
  41 // std::type_info for a rust_panic class
  42 #[lang = "eh_catch_typeinfo"]
  43 static EXCEPTION_TYPE_INFO: TypeInfo = TypeInfo {
  44     // Normally we would use .as_ptr().add(2) but this doesn't work in a const context.
  45     vtable: unsafe { &CLASS_TYPE_INFO_VTABLE[2] },
  46     // This intentionally doesn't use the normal name mangling scheme because
  47     // we don't want C++ to be able to produce or catch Rust panics.
  48     name: b"rust_panic\0".as_ptr(),
  49 };
  50
  51 pub fn payload() -> *mut u8 {
  52     ptr::null_mut()
  53 }
  54
  55 struct Exception {
  56     // This needs to be an Option because the object's lifetime follows C++
  57     // semantics: when catch_unwind moves the Box out of the exception it must
  58     // still leave the exception object in a valid state because its destructor
  59     // is still going to be called by __cxa_end_catch..
  60     data: Option<Box<dyn Any + Send>>,
  61 }
  62
  63 pub unsafe fn cleanup(ptr: *mut u8) -> Box<dyn Any + Send> {
  64     assert!(!ptr.is_null());
  65     let adjusted_ptr = __cxa_begin_catch(ptr as *mut libc::c_void) as *mut Exception;
  66     let ex = (*adjusted_ptr).data.take();
  67     __cxa_end_catch();
  68     ex.unwrap()
  69 }
  70
  71 pub unsafe fn panic(data: Box<dyn Any + Send>) -> u32 {
  72     let sz = mem::size_of_val(&data);
  73     let exception = __cxa_allocate_exception(sz) as *mut Exception;
  74     if exception.is_null() {
  75         return uw::_URC_FATAL_PHASE1_ERROR as u32;
  76     }
  77     ptr::write(exception, Exception { data: Some(data) });
  78     __cxa_throw(exception as *mut _, &EXCEPTION_TYPE_INFO, exception_cleanup);
  79 }
  80
  81 // On WASM and ARM, the destructor returns the pointer to the object.
  82 cfg_if::cfg_if! {
  83     if #[cfg(any(target_arch = "arm", target_arch = "wasm32"))] {
  84         type DestructorRet = *mut libc::c_void;
  85     } else {
  86         type DestructorRet = ();
  87     }
  88 }
  89 extern "C" fn exception_cleanup(ptr: *mut libc::c_void) -> DestructorRet {
  90     unsafe {
  91         if let Some(b) = (ptr as *mut Exception).read().data {
  92             drop(b);
  93             super::__rust_drop_panic();
  94         }
  95         #[cfg(any(target_arch = "arm", target_arch = "wasm32"))]
  96         ptr
  97     }
  98 }
  99
 100 #[lang = "eh_personality"]
 101 #[no_mangle]
 102 unsafe extern "C" fn rust_eh_personality(
 103     version: c_int,
 104     actions: uw::_Unwind_Action,
 105     exception_class: uw::_Unwind_Exception_Class,
 106     exception_object: *mut uw::_Unwind_Exception,
 107     context: *mut uw::_Unwind_Context,
 108 ) -> uw::_Unwind_Reason_Code {
 109     __gxx_personality_v0(version, actions, exception_class, exception_object, context)
 110 }
 111
 112 extern "C" {
 113     fn __cxa_allocate_exception(thrown_size: libc::size_t) -> *mut libc::c_void;
 114     fn __cxa_begin_catch(thrown_exception: *mut libc::c_void) -> *mut libc::c_void;
 115     fn __cxa_end_catch();
 116     fn __cxa_throw(
 117         thrown_exception: *mut libc::c_void,
 118         tinfo: *const TypeInfo,
 119         dest: extern "C" fn(*mut libc::c_void) -> DestructorRet,
 120     ) -> !;
 121     fn __gxx_personality_v0(
 122         version: c_int,
 123         actions: uw::_Unwind_Action,
 124         exception_class: uw::_Unwind_Exception_Class,
 125         exception_object: *mut uw::_Unwind_Exception,
 126         context: *mut uw::_Unwind_Context,
 127     ) -> uw::_Unwind_Reason_Code;
 128 }