Skip to content

Commit

Permalink
Change std::panicking::try::Data into a union
Browse files Browse the repository at this point in the history
No longer potentially call `mem::uninitialized::<!>()`

Fixes #39432
  • Loading branch information
whataloadofwhat committed Feb 10, 2017
1 parent f805144 commit ca92c51
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 23 deletions.
1 change: 1 addition & 0 deletions src/libstd/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,7 @@
#![feature(unboxed_closures)]
#![feature(unicode)]
#![feature(unique)]
#![feature(untagged_unions)]
#![feature(unwind_attributes)]
#![feature(vec_push_all)]
#![feature(zero_one)]
Expand Down
36 changes: 13 additions & 23 deletions src/libstd/panicking.rs
Original file line number Diff line number Diff line change
Expand Up @@ -389,48 +389,41 @@ pub use realstd::rt::update_panic_count;

/// Invoke a closure, capturing the cause of an unwinding panic if one occurs.
pub unsafe fn try<R, F: FnOnce() -> R>(f: F) -> Result<R, Box<Any + Send>> {
struct Data<F, R> {
#[allow(unions_with_drop_fields)]
union Data<F, R> {
f: F,
r: R,
}

// We do some sketchy operations with ownership here for the sake of
// performance. The `Data` structure is never actually fully valid, but
// instead it always contains at least one uninitialized field. We can only
// pass pointers down to `__rust_maybe_catch_panic` (can't pass objects by
// value), so we do all the ownership tracking here manully.
// performance. We can only pass pointers down to
// `__rust_maybe_catch_panic` (can't pass objects by value), so we do all
// the ownership tracking here manually using a union.
//
// Note that this is all invalid if any of these functions unwind, but the
// whole point of this function is to prevent that! As a result we go
// through a transition where:
// We go through a transition where:
//
// * First, only the closure we're going to call is initialized. The return
// value is uninitialized.
// * First, we set the data to be the closure that we're going to call.
// * When we make the function call, the `do_call` function below, we take
// ownership of the function pointer, replacing it with uninitialized
// data. At this point the `Data` structure is entirely uninitialized, but
// it won't drop due to an unwind because it's owned on the other side of
// the catch panic.
// ownership of the function pointer. At this point the `Data` union is
// entirely uninitialized.
// * If the closure successfully returns, we write the return value into the
// data's return slot. Note that `ptr::write` is used as it's overwriting
// uninitialized data.
// * Finally, when we come back out of the `__rust_maybe_catch_panic` we're
// in one of two states:
//
// 1. The closure didn't panic, in which case the return value was
// filled in. We have to be careful to `forget` the closure,
// however, as ownership was passed to the `do_call` function.
// filled in. We move it out of `data` and return it.
// 2. The closure panicked, in which case the return value wasn't
// filled in. In this case the entire `data` structure is invalid,
// so we forget the entire thing.
// filled in. In this case the entire `data` union is invalid, so
// there is no need to drop anything.
//
// Once we stack all that together we should have the "most efficient'
// method of calling a catch panic whilst juggling ownership.
let mut any_data = 0;
let mut any_vtable = 0;
let mut data = Data {
f: f,
r: mem::uninitialized(),
};

let r = __rust_maybe_catch_panic(do_call::<F, R>,
Expand All @@ -439,12 +432,9 @@ pub unsafe fn try<R, F: FnOnce() -> R>(f: F) -> Result<R, Box<Any + Send>> {
&mut any_vtable);

return if r == 0 {
let Data { f, r } = data;
mem::forget(f);
debug_assert!(update_panic_count(0) == 0);
Ok(r)
Ok(data.r)
} else {
mem::forget(data);
update_panic_count(-1);
debug_assert!(update_panic_count(0) == 0);
Err(mem::transmute(raw::TraitObject {
Expand Down
17 changes: 17 additions & 0 deletions src/test/run-pass/catch-unwind-bang.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright 2017 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

fn worker() -> ! {
panic!()
}

fn main() {
std::panic::catch_unwind(worker).unwrap_err();
}

0 comments on commit ca92c51

Please sign in to comment.