src/libpanic_abort/lib.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 //! Implementation of Rust panics via process aborts
  12 //!
  13 //! When compared to the implementation via unwinding, this crate is *much*
  14 //! simpler! That being said, it's not quite as versatile, but here goes!
  15
  16 #![no_std]
  17 #![unstable(feature = "panic_abort", issue = "32837")]
  18 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  19        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  20        html_root_url = "https://doc.rust-lang.org/nightly/",
  21        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")]
  22 #![panic_runtime]
  23 #![allow(unused_features)]
  24
  25 #![feature(core_intrinsics)]
  26 #![feature(libc)]
  27 #![feature(nll)]
  28 #![feature(panic_runtime)]
  29 #![feature(staged_api)]
  30 #![feature(rustc_attrs)]
  31
  32 // Rust's "try" function, but if we're aborting on panics we just call the
  33 // function as there's nothing else we need to do here.
  34 #[rustc_std_internal_symbol]
  35 pub unsafe extern fn __rust_maybe_catch_panic(f: fn(*mut u8),
  36                                               data: *mut u8,
  37                                               _data_ptr: *mut usize,
  38                                               _vtable_ptr: *mut usize) -> u32 {
  39     f(data);
  40     0
  41 }
  42
  43 // "Leak" the payload and shim to the relevant abort on the platform in
  44 // question.
  45 //
  46 // For Unix we just use `abort` from libc as it'll trigger debuggers, core
  47 // dumps, etc, as one might expect. On Windows, however, the best option we have
  48 // is the `__fastfail` intrinsics, but that's unfortunately not defined in LLVM,
  49 // and the `RaiseFailFastException` function isn't available until Windows 7
  50 // which would break compat with XP. For now just use `intrinsics::abort` which
  51 // will kill us with an illegal instruction, which will do a good enough job for
  52 // now hopefully.
  53 #[rustc_std_internal_symbol]
  54 pub unsafe extern fn __rust_start_panic(_payload: usize) -> u32 {
  55     abort();
  56
  57     #[cfg(any(unix, target_os = "cloudabi"))]
  58     unsafe fn abort() -> ! {
  59         extern crate libc;
  60         libc::abort();
  61     }
  62
  63     #[cfg(any(target_os = "redox",
  64               windows,
  65               all(target_arch = "wasm32", not(target_os = "emscripten"))))]
  66     unsafe fn abort() -> ! {
  67         core::intrinsics::abort();
  68     }
  69 }
  70
  71 // This... is a bit of an oddity. The tl;dr; is that this is required to link
  72 // correctly, the longer explanation is below.
  73 //
  74 // Right now the binaries of libcore/libstd that we ship are all compiled with
  75 // `-C panic=unwind`. This is done to ensure that the binaries are maximally
  76 // compatible with as many situations as possible. The compiler, however,
  77 // requires a "personality function" for all functions compiled with `-C
  78 // panic=unwind`. This personality function is hardcoded to the symbol
  79 // `rust_eh_personality` and is defined by the `eh_personality` lang item.
  80 //
  81 // So... why not just define that lang item here? Good question! The way that
  82 // panic runtimes are linked in is actually a little subtle in that they're
  83 // "sort of" in the compiler's crate store, but only actually linked if another
  84 // isn't actually linked. This ends up meaning that both this crate and the
  85 // panic_unwind crate can appear in the compiler's crate store, and if both
  86 // define the `eh_personality` lang item then that'll hit an error.
  87 //
  88 // To handle this the compiler only requires the `eh_personality` is defined if
  89 // the panic runtime being linked in is the unwinding runtime, and otherwise
  90 // it's not required to be defined (rightfully so). In this case, however, this
  91 // library just defines this symbol so there's at least some personality
  92 // somewhere.
  93 //
  94 // Essentially this symbol is just defined to get wired up to libcore/libstd
  95 // binaries, but it should never be called as we don't link in an unwinding
  96 // runtime at all.
  97 pub mod personalities {
  98     #[no_mangle]
  99     #[cfg(not(any(
 100         all(
 101             target_arch = "wasm32",
 102             not(target_os = "emscripten"),
 103         ),
 104         all(
 105             target_os = "windows",
 106             target_env = "gnu",
 107             target_arch = "x86_64",
 108         ),
 109     )))]
 110     pub extern fn rust_eh_personality() {}
 111
 112     // On x86_64-pc-windows-gnu we use our own personality function that needs
 113     // to return `ExceptionContinueSearch` as we're passing on all our frames.
 114     #[no_mangle]
 115     #[cfg(all(target_os = "windows",
 116               target_env = "gnu",
 117               target_arch = "x86_64"))]
 118     pub extern fn rust_eh_personality(_record: usize,
 119                                       _frame: usize,
 120                                       _context: usize,
 121                                       _dispatcher: usize) -> u32 {
 122         1 // `ExceptionContinueSearch`
 123     }
 124
 125     // Similar to above, this corresponds to the `eh_unwind_resume` lang item
 126     // that's only used on Windows currently.
 127     //
 128     // Note that we don't execute landing pads, so this is never called, so it's
 129     // body is empty.
 130     #[no_mangle]
 131     #[cfg(all(target_os = "windows", target_env = "gnu"))]
 132     pub extern fn rust_eh_unwind_resume() {}
 133
 134     // These two are called by our startup objects on i686-pc-windows-gnu, but
 135     // they don't need to do anything so the bodies are nops.
 136     #[no_mangle]
 137     #[cfg(all(target_os = "windows", target_env = "gnu", target_arch = "x86"))]
 138     pub extern fn rust_eh_register_frames() {}
 139     #[no_mangle]
 140     #[cfg(all(target_os = "windows", target_env = "gnu", target_arch = "x86"))]
 141     pub extern fn rust_eh_unregister_frames() {}
 142 }