library/panic_unwind/src/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 use alloc::boxed::Box;
  10 use core::any::Any;
  11 use core::intrinsics;
  12 use core::mem;
  13 use core::ptr;
  14 use core::sync::atomic::{AtomicBool, Ordering};
  15 use unwind as uw;
  16
  17 // This matches the layout of std::type_info in C++
  18 #[repr(C)]
  19 struct TypeInfo {
  20     vtable: *const usize,
  21     name: *const u8,
  22 }
  23 unsafe impl Sync for TypeInfo {}
  24
  25 extern "C" {
  26     // The leading `\x01` byte here is actually a magical signal to LLVM to
  27     // *not* apply any other mangling like prefixing with a `_` character.
  28     //
  29     // This symbol is the vtable used by C++'s `std::type_info`. Objects of type
  30     // `std::type_info`, type descriptors, have a pointer to this table. Type
  31     // descriptors are referenced by the C++ EH structures defined above and
  32     // that we construct below.
  33     //
  34     // Note that the real size is larger than 3 usize, but we only need our
  35     // vtable to point to the third element.
  36     #[link_name = "\x01_ZTVN10__cxxabiv117__class_type_infoE"]
  37     static CLASS_TYPE_INFO_VTABLE: [usize; 3];
  38 }
  39
  40 // std::type_info for a rust_panic class
  41 #[lang = "eh_catch_typeinfo"]
  42 static EXCEPTION_TYPE_INFO: TypeInfo = TypeInfo {
  43     // Normally we would use .as_ptr().add(2) but this doesn't work in a const context.
  44     vtable: unsafe { &CLASS_TYPE_INFO_VTABLE[2] },
  45     // This intentionally doesn't use the normal name mangling scheme because
  46     // we don't want C++ to be able to produce or catch Rust panics.
  47     name: b"rust_panic\0".as_ptr(),
  48 };
  49
  50 struct Exception {
  51     // This is necessary because C++ code can capture our exception with
  52     // std::exception_ptr and rethrow it multiple times, possibly even in
  53     // another thread.
  54     caught: AtomicBool,
  55
  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     // intrinsics::try actually gives us a pointer to this structure.
  65     #[repr(C)]
  66     struct CatchData {
  67         ptr: *mut u8,
  68         is_rust_panic: bool,
  69     }
  70     let catch_data = &*(ptr as *mut CatchData);
  71
  72     let adjusted_ptr = __cxa_begin_catch(catch_data.ptr as *mut libc::c_void) as *mut Exception;
  73     let out = if catch_data.is_rust_panic {
  74         let was_caught = (*adjusted_ptr).caught.swap(true, Ordering::SeqCst);
  75         if was_caught {
  76             // Since cleanup() isn't allowed to panic, we just abort instead.
  77             intrinsics::abort();
  78         }
  79         (*adjusted_ptr).data.take().unwrap()
  80     } else {
  81         super::__rust_foreign_exception();
  82     };
  83     __cxa_end_catch();
  84     out
  85 }
  86
  87 pub unsafe fn panic(data: Box<dyn Any + Send>) -> u32 {
  88     let sz = mem::size_of_val(&data);
  89     let exception = __cxa_allocate_exception(sz) as *mut Exception;
  90     if exception.is_null() {
  91         return uw::_URC_FATAL_PHASE1_ERROR as u32;
  92     }
  93     ptr::write(exception, Exception { caught: AtomicBool::new(false), data: Some(data) });
  94     __cxa_throw(exception as *mut _, &EXCEPTION_TYPE_INFO, exception_cleanup);
  95 }
  96
  97 extern "C" fn exception_cleanup(ptr: *mut libc::c_void) -> *mut libc::c_void {
  98     unsafe {
  99         if let Some(b) = (ptr as *mut Exception).read().data {
 100             drop(b);
 101             super::__rust_drop_panic();
 102         }
 103         ptr
 104     }
 105 }
 106
 107 extern "C" {
 108     fn __cxa_allocate_exception(thrown_size: libc::size_t) -> *mut libc::c_void;
 109     fn __cxa_begin_catch(thrown_exception: *mut libc::c_void) -> *mut libc::c_void;
 110     fn __cxa_end_catch();
 111     fn __cxa_throw(
 112         thrown_exception: *mut libc::c_void,
 113         tinfo: *const TypeInfo,
 114         dest: extern "C" fn(*mut libc::c_void) -> *mut libc::c_void,
 115     ) -> !;
 116 }