Directly implement native exception raise methods in miri

Windows still needs the old custom ABI as SEH unwinding isn't supported
by miri. Unlike DWARF unwinding it preserves all stack frames until
right after the do_catch function has executed. Because of this
panic_unwind stack allocates the exception object. Miri can't currently
model unwinding without destroying stack frames and as such will report
a use-after-free of the exception object.
This commit is contained in:
bjorn3 2024-02-24 14:27:27 +00:00 committed by Ralf Jung
parent f7520e40f7
commit 42cb1ffa36
5 changed files with 118 additions and 1 deletions

View File

@ -26,7 +26,7 @@ fn call_intrinsic(
args: &[OpTy<'tcx, Provenance>], args: &[OpTy<'tcx, Provenance>],
dest: &MPlaceTy<'tcx, Provenance>, dest: &MPlaceTy<'tcx, Provenance>,
ret: Option<mir::BasicBlock>, ret: Option<mir::BasicBlock>,
_unwind: mir::UnwindAction, unwind: mir::UnwindAction,
) -> InterpResult<'tcx, Option<ty::Instance<'tcx>>> { ) -> InterpResult<'tcx, Option<ty::Instance<'tcx>>> {
let this = self.eval_context_mut(); let this = self.eval_context_mut();
@ -67,6 +67,11 @@ fn call_intrinsic(
this.return_to_block(ret)?; this.return_to_block(ret)?;
Ok(None) Ok(None)
} }
EmulateItemResult::NeedsUnwind => {
// Jump to the unwind block to begin unwinding.
this.unwind_to_block(unwind)?;
Ok(None)
}
EmulateItemResult::AlreadyJumped => Ok(None), EmulateItemResult::AlreadyJumped => Ok(None),
} }
} }

View File

@ -87,6 +87,10 @@ fn emulate_foreign_item(
trace!("{:?}", this.dump_place(&dest.clone().into())); trace!("{:?}", this.dump_place(&dest.clone().into()));
this.return_to_block(ret)?; this.return_to_block(ret)?;
} }
EmulateItemResult::NeedsUnwind => {
// Jump to the unwind block to begin unwinding.
this.unwind_to_block(unwind)?;
}
EmulateItemResult::AlreadyJumped => (), EmulateItemResult::AlreadyJumped => (),
EmulateItemResult::NotSupported => { EmulateItemResult::NotSupported => {
if let Some(body) = this.lookup_exported_symbol(link_name)? { if let Some(body) = this.lookup_exported_symbol(link_name)? {

View File

@ -23,6 +23,8 @@
pub enum EmulateItemResult { pub enum EmulateItemResult {
/// The caller is expected to jump to the return block. /// The caller is expected to jump to the return block.
NeedsJumping, NeedsJumping,
/// The caller is expected to jump to the unwind block.
NeedsUnwind,
/// Jumping has already been taken care of. /// Jumping has already been taken care of.
AlreadyJumped, AlreadyJumped,
/// The item is not supported. /// The item is not supported.

View File

@ -639,6 +639,17 @@ fn emulate_foreign_item_inner(
this.gen_random(ptr, len)?; this.gen_random(ptr, len)?;
this.write_scalar(Scalar::from_target_usize(len, this), dest)?; this.write_scalar(Scalar::from_target_usize(len, this), dest)?;
} }
"_Unwind_RaiseException" => {
trace!("_Unwind_RaiseException: {:?}", this.frame().instance);
// Get the raw pointer stored in arg[0] (the panic payload).
let [payload] = this.check_shim(abi, Abi::C { unwind: true }, link_name, args)?;
let payload = this.read_scalar(payload)?;
let thread = this.active_thread_mut();
thread.panic_payloads.push(payload);
return Ok(EmulateItemResult::NeedsUnwind);
}
// Incomplete shims that we "stub out" just to get pre-main initialization code to work. // Incomplete shims that we "stub out" just to get pre-main initialization code to work.
// These shims are enabled only when the caller is in the standard library. // These shims are enabled only when the caller is in the standard library.

View File

@ -0,0 +1,95 @@
//@only-target-linux
#![feature(core_intrinsics, panic_unwind, rustc_attrs)]
#![allow(internal_features)]
//! Unwinding using `_Unwind_RaiseException`
extern crate unwind as uw;
use std::any::Any;
use std::ptr;
#[repr(C)]
struct Exception {
_uwe: uw::_Unwind_Exception,
cause: Box<dyn Any + Send>,
}
pub fn panic(data: Box<dyn Any + Send>) -> u32 {
let exception = Box::new(Exception {
_uwe: uw::_Unwind_Exception {
exception_class: rust_exception_class(),
exception_cleanup,
private: [core::ptr::null(); uw::unwinder_private_data_size],
},
cause: data,
});
let exception_param = Box::into_raw(exception) as *mut uw::_Unwind_Exception;
return unsafe { uw::_Unwind_RaiseException(exception_param) as u32 };
extern "C" fn exception_cleanup(
_unwind_code: uw::_Unwind_Reason_Code,
_exception: *mut uw::_Unwind_Exception,
) {
std::process::abort();
}
}
pub unsafe fn rust_panic_cleanup(ptr: *mut u8) -> Box<dyn Any + Send> {
let exception = ptr as *mut uw::_Unwind_Exception;
if (*exception).exception_class != rust_exception_class() {
std::process::abort();
}
let exception = exception.cast::<Exception>();
let exception = Box::from_raw(exception as *mut Exception);
exception.cause
}
fn rust_exception_class() -> uw::_Unwind_Exception_Class {
// M O Z \0 R U S T -- vendor, language
0x4d4f5a_00_52555354
}
pub fn catch_unwind<R, F: FnOnce() -> R>(f: F) -> Result<R, Box<dyn Any + Send>> {
struct Data<F, R> {
f: Option<F>,
r: Option<R>,
p: Option<Box<dyn Any + Send>>,
}
let mut data = Data { f: Some(f), r: None, p: None };
let data_ptr = ptr::addr_of_mut!(data) as *mut u8;
unsafe {
return if std::intrinsics::r#try(do_call::<F, R>, data_ptr, do_catch::<F, R>) == 0 {
Ok(data.r.take().unwrap())
} else {
Err(data.p.take().unwrap())
};
}
fn do_call<F: FnOnce() -> R, R>(data: *mut u8) {
unsafe {
let data = &mut *data.cast::<Data<F, R>>();
let f = data.f.take().unwrap();
data.r = Some(f());
}
}
#[rustc_nounwind]
fn do_catch<F: FnOnce() -> R, R>(data: *mut u8, payload: *mut u8) {
unsafe {
let obj = rust_panic_cleanup(payload);
(*data.cast::<Data<F, R>>()).p = Some(obj);
}
}
}
fn main() {
assert_eq!(
catch_unwind(|| panic(Box::new(42))).unwrap_err().downcast::<i32>().unwrap(),
Box::new(42)
);
}