src/libpanic_unwind/gcc.rs

   1 //! Implementation of panics backed by libgcc/libunwind (in some form).
   2 //!
   3 //! For background on exception handling and stack unwinding please see
   4 //! "Exception Handling in LLVM" (llvm.org/docs/ExceptionHandling.html) and
   5 //! documents linked from it.
   6 //! These are also good reads:
   7 //!     http://mentorembedded.github.io/cxx-abi/abi-eh.html
   8 //!     http://monoinfinito.wordpress.com/series/exception-handling-in-c/
   9 //!     http://www.airs.com/blog/index.php?s=exception+frames
  10 //!
  11 //! ## A brief summary
  12 //!
  13 //! Exception handling happens in two phases: a search phase and a cleanup
  14 //! phase.
  15 //!
  16 //! In both phases the unwinder walks stack frames from top to bottom using
  17 //! information from the stack frame unwind sections of the current process's
  18 //! modules ("module" here refers to an OS module, i.e., an executable or a
  19 //! dynamic library).
  20 //!
  21 //! For each stack frame, it invokes the associated "personality routine", whose
  22 //! address is also stored in the unwind info section.
  23 //!
  24 //! In the search phase, the job of a personality routine is to examine
  25 //! exception object being thrown, and to decide whether it should be caught at
  26 //! that stack frame. Once the handler frame has been identified, cleanup phase
  27 //! begins.
  28 //!
  29 //! In the cleanup phase, the unwinder invokes each personality routine again.
  30 //! This time it decides which (if any) cleanup code needs to be run for
  31 //! the current stack frame. If so, the control is transferred to a special
  32 //! branch in the function body, the "landing pad", which invokes destructors,
  33 //! frees memory, etc. At the end of the landing pad, control is transferred
  34 //! back to the unwinder and unwinding resumes.
  35 //!
  36 //! Once stack has been unwound down to the handler frame level, unwinding stops
  37 //! and the last personality routine transfers control to the catch block.
  38 //!
  39 //! ## `eh_personality` and `eh_unwind_resume`
  40 //!
  41 //! These language items are used by the compiler when generating unwind info.
  42 //! The first one is the personality routine described above. The second one
  43 //! allows compilation target to customize the process of resuming unwind at the
  44 //! end of the landing pads. `eh_unwind_resume` is used only if
  45 //! `custom_unwind_resume` flag in the target options is set.
  46
  47 #![allow(private_no_mangle_fns)]
  48
  49 use alloc::boxed::Box;
  50 use core::any::Any;
  51 use core::ptr;
  52
  53 use crate::dwarf::eh::{self, EHAction, EHContext};
  54 use libc::{c_int, uintptr_t};
  55 use unwind as uw;
  56
  57 #[repr(C)]
  58 struct Exception {
  59     _uwe: uw::_Unwind_Exception,
  60     cause: Option<Box<dyn Any + Send>>,
  61 }
  62
  63 pub unsafe fn panic(data: Box<dyn Any + Send>) -> u32 {
  64     let exception = Box::new(Exception {
  65         _uwe: uw::_Unwind_Exception {
  66             exception_class: rust_exception_class(),
  67             exception_cleanup,
  68             private: [0; uw::unwinder_private_data_size],
  69         },
  70         cause: Some(data),
  71     });
  72     let exception_param = Box::into_raw(exception) as *mut uw::_Unwind_Exception;
  73     return uw::_Unwind_RaiseException(exception_param) as u32;
  74
  75     extern "C" fn exception_cleanup(
  76         _unwind_code: uw::_Unwind_Reason_Code,
  77         exception: *mut uw::_Unwind_Exception,
  78     ) {
  79         unsafe {
  80             let _: Box<Exception> = Box::from_raw(exception as *mut Exception);
  81         }
  82     }
  83 }
  84
  85 pub fn payload() -> *mut u8 {
  86     ptr::null_mut()
  87 }
  88
  89 pub unsafe fn cleanup(ptr: *mut u8) -> Box<dyn Any + Send> {
  90     let my_ep = ptr as *mut Exception;
  91     let cause = (*my_ep).cause.take();
  92     uw::_Unwind_DeleteException(ptr as *mut _);
  93     cause.unwrap()
  94 }
  95
  96 // Rust's exception class identifier.  This is used by personality routines to
  97 // determine whether the exception was thrown by their own runtime.
  98 fn rust_exception_class() -> uw::_Unwind_Exception_Class {
  99     // M O Z \0  R U S T -- vendor, language
 100     0x4d4f5a_00_52555354
 101 }
 102
 103 // Register ids were lifted from LLVM's TargetLowering::getExceptionPointerRegister()
 104 // and TargetLowering::getExceptionSelectorRegister() for each architecture,
 105 // then mapped to DWARF register numbers via register definition tables
 106 // (typically <arch>RegisterInfo.td, search for "DwarfRegNum").
 107 // See also http://llvm.org/docs/WritingAnLLVMBackend.html#defining-a-register.
 108
 109 #[cfg(target_arch = "x86")]
 110 const UNWIND_DATA_REG: (i32, i32) = (0, 2); // EAX, EDX
 111
 112 #[cfg(target_arch = "x86_64")]
 113 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // RAX, RDX
 114
 115 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
 116 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1 / X0, X1
 117
 118 #[cfg(any(target_arch = "mips", target_arch = "mips64"))]
 119 const UNWIND_DATA_REG: (i32, i32) = (4, 5); // A0, A1
 120
 121 #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64"))]
 122 const UNWIND_DATA_REG: (i32, i32) = (3, 4); // R3, R4 / X3, X4
 123
 124 #[cfg(target_arch = "s390x")]
 125 const UNWIND_DATA_REG: (i32, i32) = (6, 7); // R6, R7
 126
 127 #[cfg(target_arch = "sparc64")]
 128 const UNWIND_DATA_REG: (i32, i32) = (24, 25); // I0, I1
 129
 130 #[cfg(target_arch = "hexagon")]
 131 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1
 132
 133 #[cfg(target_arch = "riscv64")]
 134 const UNWIND_DATA_REG: (i32, i32) = (10, 11); // x10, x11
 135
 136 // The following code is based on GCC's C and C++ personality routines.  For reference, see:
 137 // https://github.com/gcc-mirror/gcc/blob/master/libstdc++-v3/libsupc++/eh_personality.cc
 138 // https://github.com/gcc-mirror/gcc/blob/trunk/libgcc/unwind-c.c
 139
 140 cfg_if::cfg_if! {
 141     if #[cfg(all(target_arch = "arm", not(target_os = "ios"), not(target_os = "netbsd")))] {
 142         // ARM EHABI personality routine.
 143         // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0038b/IHI0038B_ehabi.pdf
 144         //
 145         // iOS uses the default routine instead since it uses SjLj unwinding.
 146         #[lang = "eh_personality"]
 147         #[no_mangle]
 148         unsafe extern "C" fn rust_eh_personality(state: uw::_Unwind_State,
 149                                                  exception_object: *mut uw::_Unwind_Exception,
 150                                                  context: *mut uw::_Unwind_Context)
 151                                                  -> uw::_Unwind_Reason_Code {
 152             let state = state as c_int;
 153             let action = state & uw::_US_ACTION_MASK as c_int;
 154             let search_phase = if action == uw::_US_VIRTUAL_UNWIND_FRAME as c_int {
 155                 // Backtraces on ARM will call the personality routine with
 156                 // state == _US_VIRTUAL_UNWIND_FRAME | _US_FORCE_UNWIND. In those cases
 157                 // we want to continue unwinding the stack, otherwise all our backtraces
 158                 // would end at __rust_try
 159                 if state & uw::_US_FORCE_UNWIND as c_int != 0 {
 160                     return continue_unwind(exception_object, context);
 161                 }
 162                 true
 163             } else if action == uw::_US_UNWIND_FRAME_STARTING as c_int {
 164                 false
 165             } else if action == uw::_US_UNWIND_FRAME_RESUME as c_int {
 166                 return continue_unwind(exception_object, context);
 167             } else {
 168                 return uw::_URC_FAILURE;
 169             };
 170
 171             // The DWARF unwinder assumes that _Unwind_Context holds things like the function
 172             // and LSDA pointers, however ARM EHABI places them into the exception object.
 173             // To preserve signatures of functions like _Unwind_GetLanguageSpecificData(), which
 174             // take only the context pointer, GCC personality routines stash a pointer to
 175             // exception_object in the context, using location reserved for ARM's
 176             // "scratch register" (r12).
 177             uw::_Unwind_SetGR(context,
 178                               uw::UNWIND_POINTER_REG,
 179                               exception_object as uw::_Unwind_Ptr);
 180             // ...A more principled approach would be to provide the full definition of ARM's
 181             // _Unwind_Context in our libunwind bindings and fetch the required data from there
 182             // directly, bypassing DWARF compatibility functions.
 183
 184             let exception_class = (*exception_object).exception_class;
 185             let foreign_exception = exception_class != rust_exception_class();
 186             let eh_action = match find_eh_action(context, foreign_exception) {
 187                 Ok(action) => action,
 188                 Err(_) => return uw::_URC_FAILURE,
 189             };
 190             if search_phase {
 191                 match eh_action {
 192                     EHAction::None |
 193                     EHAction::Cleanup(_) => return continue_unwind(exception_object, context),
 194                     EHAction::Catch(_) => {
 195                         // EHABI requires the personality routine to update the
 196                         // SP value in the barrier cache of the exception object.
 197                         (*exception_object).private[5] =
 198                             uw::_Unwind_GetGR(context, uw::UNWIND_SP_REG);
 199                         return uw::_URC_HANDLER_FOUND;
 200                     }
 201                     EHAction::Terminate => return uw::_URC_FAILURE,
 202                 }
 203             } else {
 204                 match eh_action {
 205                     EHAction::None => return continue_unwind(exception_object, context),
 206                     EHAction::Cleanup(lpad) |
 207                     EHAction::Catch(lpad) => {
 208                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0,
 209                                           exception_object as uintptr_t);
 210                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
 211                         uw::_Unwind_SetIP(context, lpad);
 212                         return uw::_URC_INSTALL_CONTEXT;
 213                     }
 214                     EHAction::Terminate => return uw::_URC_FAILURE,
 215                 }
 216             }
 217
 218             // On ARM EHABI the personality routine is responsible for actually
 219             // unwinding a single stack frame before returning (ARM EHABI Sec. 6.1).
 220             unsafe fn continue_unwind(exception_object: *mut uw::_Unwind_Exception,
 221                                       context: *mut uw::_Unwind_Context)
 222                                       -> uw::_Unwind_Reason_Code {
 223                 if __gnu_unwind_frame(exception_object, context) == uw::_URC_NO_REASON {
 224                     uw::_URC_CONTINUE_UNWIND
 225                 } else {
 226                     uw::_URC_FAILURE
 227                 }
 228             }
 229             // defined in libgcc
 230             extern "C" {
 231                 fn __gnu_unwind_frame(exception_object: *mut uw::_Unwind_Exception,
 232                                       context: *mut uw::_Unwind_Context)
 233                                       -> uw::_Unwind_Reason_Code;
 234             }
 235         }
 236     } else {
 237         // Default personality routine, which is used directly on most targets
 238         // and indirectly on Windows x86_64 via SEH.
 239         unsafe extern "C" fn rust_eh_personality_impl(version: c_int,
 240                                                       actions: uw::_Unwind_Action,
 241                                                       exception_class: uw::_Unwind_Exception_Class,
 242                                                       exception_object: *mut uw::_Unwind_Exception,
 243                                                       context: *mut uw::_Unwind_Context)
 244                                                       -> uw::_Unwind_Reason_Code {
 245             if version != 1 {
 246                 return uw::_URC_FATAL_PHASE1_ERROR;
 247             }
 248             let foreign_exception = exception_class != rust_exception_class();
 249             let eh_action = match find_eh_action(context, foreign_exception) {
 250                 Ok(action) => action,
 251                 Err(_) => return uw::_URC_FATAL_PHASE1_ERROR,
 252             };
 253             if actions as i32 & uw::_UA_SEARCH_PHASE as i32 != 0 {
 254                 match eh_action {
 255                     EHAction::None |
 256                     EHAction::Cleanup(_) => uw::_URC_CONTINUE_UNWIND,
 257                     EHAction::Catch(_) => uw::_URC_HANDLER_FOUND,
 258                     EHAction::Terminate => uw::_URC_FATAL_PHASE1_ERROR,
 259                 }
 260             } else {
 261                 match eh_action {
 262                     EHAction::None => uw::_URC_CONTINUE_UNWIND,
 263                     EHAction::Cleanup(lpad) |
 264                     EHAction::Catch(lpad) => {
 265                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0,
 266                             exception_object as uintptr_t);
 267                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
 268                         uw::_Unwind_SetIP(context, lpad);
 269                         uw::_URC_INSTALL_CONTEXT
 270                     }
 271                     EHAction::Terminate => uw::_URC_FATAL_PHASE2_ERROR,
 272                 }
 273             }
 274         }
 275
 276         cfg_if::cfg_if! {
 277             if #[cfg(all(windows, target_arch = "x86_64", target_env = "gnu"))] {
 278                 // On x86_64 MinGW targets, the unwinding mechanism is SEH however the unwind
 279                 // handler data (aka LSDA) uses GCC-compatible encoding.
 280                 #[lang = "eh_personality"]
 281                 #[no_mangle]
 282                 #[allow(nonstandard_style)]
 283                 unsafe extern "C" fn rust_eh_personality(exceptionRecord: *mut uw::EXCEPTION_RECORD,
 284                         establisherFrame: uw::LPVOID,
 285                         contextRecord: *mut uw::CONTEXT,
 286                         dispatcherContext: *mut uw::DISPATCHER_CONTEXT)
 287                         -> uw::EXCEPTION_DISPOSITION {
 288                     uw::_GCC_specific_handler(exceptionRecord,
 289                                              establisherFrame,
 290                                              contextRecord,
 291                                              dispatcherContext,
 292                                              rust_eh_personality_impl)
 293                 }
 294             } else {
 295                 // The personality routine for most of our targets.
 296                 #[lang = "eh_personality"]
 297                 #[no_mangle]
 298                 unsafe extern "C" fn rust_eh_personality(version: c_int,
 299                         actions: uw::_Unwind_Action,
 300                         exception_class: uw::_Unwind_Exception_Class,
 301                         exception_object: *mut uw::_Unwind_Exception,
 302                         context: *mut uw::_Unwind_Context)
 303                         -> uw::_Unwind_Reason_Code {
 304                     rust_eh_personality_impl(version,
 305                                              actions,
 306                                              exception_class,
 307                                              exception_object,
 308                                              context)
 309                 }
 310             }
 311         }
 312     }
 313 }
 314
 315 unsafe fn find_eh_action(
 316     context: *mut uw::_Unwind_Context,
 317     foreign_exception: bool,
 318 ) -> Result<EHAction, ()> {
 319     let lsda = uw::_Unwind_GetLanguageSpecificData(context) as *const u8;
 320     let mut ip_before_instr: c_int = 0;
 321     let ip = uw::_Unwind_GetIPInfo(context, &mut ip_before_instr);
 322     let eh_context = EHContext {
 323         // The return address points 1 byte past the call instruction,
 324         // which could be in the next IP range in LSDA range table.
 325         ip: if ip_before_instr != 0 { ip } else { ip - 1 },
 326         func_start: uw::_Unwind_GetRegionStart(context),
 327         get_text_start: &|| uw::_Unwind_GetTextRelBase(context),
 328         get_data_start: &|| uw::_Unwind_GetDataRelBase(context),
 329     };
 330     eh::find_eh_action(lsda, &eh_context, foreign_exception)
 331 }
 332
 333 // See docs in the `unwind` module.
 334 #[cfg(all(
 335     target_os = "windows",
 336     any(target_arch = "x86", target_arch = "x86_64"),
 337     target_env = "gnu"
 338 ))]
 339 #[lang = "eh_unwind_resume"]
 340 #[unwind(allowed)]
 341 unsafe extern "C" fn rust_eh_unwind_resume(panic_ctx: *mut u8) -> ! {
 342     uw::_Unwind_Resume(panic_ctx as *mut uw::_Unwind_Exception);
 343 }
 344
 345 // Frame unwind info registration
 346 //
 347 // Each module's image contains a frame unwind info section (usually
 348 // ".eh_frame").  When a module is loaded/unloaded into the process, the
 349 // unwinder must be informed about the location of this section in memory. The
 350 // methods of achieving that vary by the platform.  On some (e.g., Linux), the
 351 // unwinder can discover unwind info sections on its own (by dynamically
 352 // enumerating currently loaded modules via the dl_iterate_phdr() API and
 353 // finding their ".eh_frame" sections); Others, like Windows, require modules
 354 // to actively register their unwind info sections via unwinder API.
 355 //
 356 // This module defines two symbols which are referenced and called from
 357 // rsbegin.rs to register our information with the GCC runtime. The
 358 // implementation of stack unwinding is (for now) deferred to libgcc_eh, however
 359 // Rust crates use these Rust-specific entry points to avoid potential clashes
 360 // with any GCC runtime.
 361 #[cfg(all(target_os = "windows", target_arch = "x86", target_env = "gnu"))]
 362 pub mod eh_frame_registry {
 363     extern "C" {
 364         fn __register_frame_info(eh_frame_begin: *const u8, object: *mut u8);
 365         fn __deregister_frame_info(eh_frame_begin: *const u8, object: *mut u8);
 366     }
 367
 368     #[no_mangle]
 369     pub unsafe extern "C" fn rust_eh_register_frames(eh_frame_begin: *const u8, object: *mut u8) {
 370         __register_frame_info(eh_frame_begin, object);
 371     }
 372
 373     #[no_mangle]
 374     pub unsafe extern "C" fn rust_eh_unregister_frames(eh_frame_begin: *const u8, object: *mut u8) {
 375         __deregister_frame_info(eh_frame_begin, object);
 376     }
 377 }