src/shims/panic.rs

   1 //! Panic runtime for Miri.
   2 //!
   3 //! The core pieces of the runtime are:
   4 //! - An implementation of `__rust_maybe_catch_panic` that pushes the invoked stack frame with
   5 //!   some extra metadata derived from the panic-catching arguments of `__rust_maybe_catch_panic`.
   6 //! - A hack in `libpanic_unwind` that calls the `miri_start_panic` intrinsic instead of the
   7 //!   target-native panic runtime. (This lives in the rustc repo.)
   8 //! - An implementation of `miri_start_panic` that stores its argument (the panic payload), and then
   9 //!   immediately returns, but on the *unwind* edge (not the normal return edge), thus initiating unwinding.
  10 //! - A hook executed each time a frame is popped, such that if the frame pushed by `__rust_maybe_catch_panic`
  11 //!   gets popped *during unwinding*, we take the panic payload and store it according to the extra
  12 //!   metadata we remembered when pushing said frame.
  13
  14 use log::trace;
  15
  16 use rustc_middle::{mir, ty};
  17 use rustc_target::spec::PanicStrategy;
  18
  19 use crate::*;
  20 use helpers::check_arg_count;
  21
  22 /// Holds all of the relevant data for when unwinding hits a `try` frame.
  23 #[derive(Debug)]
  24 pub struct CatchUnwindData<'tcx> {
  25     /// The `catch_fn` callback to call in case of a panic.
  26     catch_fn: Scalar<Tag>,
  27     /// The `data` argument for that callback.
  28     data: Scalar<Tag>,
  29     /// The return place from the original call to `try`.
  30     dest: PlaceTy<'tcx, Tag>,
  31     /// The return block from the original call to `try`.
  32     ret: mir::BasicBlock,
  33 }
  34
  35 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
  36 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
  37     /// Handles the special `miri_start_panic` intrinsic, which is called
  38     /// by libpanic_unwind to delegate the actual unwinding process to Miri.
  39     fn handle_miri_start_panic(
  40         &mut self,
  41         args: &[OpTy<'tcx, Tag>],
  42         unwind: Option<mir::BasicBlock>,
  43     ) -> InterpResult<'tcx> {
  44         let this = self.eval_context_mut();
  45
  46         trace!("miri_start_panic: {:?}", this.frame().instance);
  47
  48         // Get the raw pointer stored in arg[0] (the panic payload).
  49         let &[payload] = check_arg_count(args)?;
  50         let payload = this.read_scalar(payload)?.check_init()?;
  51         assert!(
  52             this.machine.panic_payload.is_none(),
  53             "the panic runtime should avoid double-panics"
  54         );
  55         this.machine.panic_payload = Some(payload);
  56
  57         // Jump to the unwind block to begin unwinding.
  58         this.unwind_to_block(unwind);
  59         return Ok(());
  60     }
  61
  62     /// Handles the `try` intrinsic, the underlying implementation of `std::panicking::try`.
  63     fn handle_try(
  64         &mut self,
  65         args: &[OpTy<'tcx, Tag>],
  66         dest: PlaceTy<'tcx, Tag>,
  67         ret: mir::BasicBlock,
  68     ) -> InterpResult<'tcx> {
  69         let this = self.eval_context_mut();
  70
  71         // Signature:
  72         //   fn r#try(try_fn: fn(*mut u8), data: *mut u8, catch_fn: fn(*mut u8, *mut u8)) -> i32
  73         // Calls `try_fn` with `data` as argument. If that executes normally, returns 0.
  74         // If that unwinds, calls `catch_fn` with the first argument being `data` and
  75         // then second argument being a target-dependent `payload` (i.e. it is up to us to define
  76         // what that is), and returns 1.
  77         // The `payload` is passed (by libstd) to `__rust_panic_cleanup`, which is then expected to
  78         // return a `Box<dyn Any + Send + 'static>`.
  79         // In Miri, `miri_start_panic` is passed exactly that type, so we make the `payload` simply
  80         // a pointer to `Box<dyn Any + Send + 'static>`.
  81
  82         // Get all the arguments.
  83         let &[try_fn, data, catch_fn] = check_arg_count(args)?;
  84         let try_fn = this.read_scalar(try_fn)?.check_init()?;
  85         let data = this.read_scalar(data)?.check_init()?;
  86         let catch_fn = this.read_scalar(catch_fn)?.check_init()?;
  87
  88         // Now we make a function call, and pass `data` as first and only argument.
  89         let f_instance = this.memory.get_fn(try_fn)?.as_instance()?;
  90         trace!("try_fn: {:?}", f_instance);
  91         let ret_place = MPlaceTy::dangling(this.machine.layouts.unit, this).into();
  92         this.call_function(
  93             f_instance,
  94             &[data.into()],
  95             Some(ret_place),
  96             // Directly return to caller.
  97             StackPopCleanup::Goto { ret: Some(ret), unwind: None },
  98         )?;
  99
 100         // We ourselves will return `0`, eventually (will be overwritten if we catch a panic).
 101         this.write_null(dest)?;
 102
 103         // In unwind mode, we tag this frame with the extra data needed to catch unwinding.
 104         // This lets `handle_stack_pop` (below) know that we should stop unwinding
 105         // when we pop this frame.
 106         if this.tcx.sess.panic_strategy() == PanicStrategy::Unwind {
 107             this.frame_mut().extra.catch_unwind = Some(CatchUnwindData { catch_fn, data, dest, ret });
 108         }
 109
 110         return Ok(());
 111     }
 112
 113     fn handle_stack_pop(
 114         &mut self,
 115         mut extra: FrameData<'tcx>,
 116         unwinding: bool,
 117     ) -> InterpResult<'tcx, StackPopJump> {
 118         let this = self.eval_context_mut();
 119
 120         trace!("handle_stack_pop(extra = {:?}, unwinding = {})", extra, unwinding);
 121         if let Some(stacked_borrows) = &this.memory.extra.stacked_borrows {
 122             stacked_borrows.borrow_mut().end_call(extra.call_id);
 123         }
 124
 125         // We only care about `catch_panic` if we're unwinding - if we're doing a normal
 126         // return, then we don't need to do anything special.
 127         if let (true, Some(catch_unwind)) = (unwinding, extra.catch_unwind.take()) {
 128             // We've just popped a frame that was pushed by `try`,
 129             // and we are unwinding, so we should catch that.
 130             trace!("unwinding: found catch_panic frame during unwinding: {:?}", this.frame().instance);
 131
 132             // We set the return value of `try` to 1, since there was a panic.
 133             this.write_scalar(Scalar::from_i32(1), catch_unwind.dest)?;
 134
 135             // `panic_payload` holds what was passed to `miri_start_panic`.
 136             // This is exactly the second argument we need to pass to `catch_fn`.
 137             let payload = this.machine.panic_payload.take().unwrap();
 138
 139             // Push the `catch_fn` stackframe.
 140             let f_instance = this.memory.get_fn(catch_unwind.catch_fn)?.as_instance()?;
 141             trace!("catch_fn: {:?}", f_instance);
 142             let ret_place = MPlaceTy::dangling(this.machine.layouts.unit, this).into();
 143             this.call_function(
 144                 f_instance,
 145                 &[catch_unwind.data.into(), payload.into()],
 146                 Some(ret_place),
 147                 // Directly return to caller of `try`.
 148                 StackPopCleanup::Goto { ret: Some(catch_unwind.ret), unwind: None },
 149             )?;
 150
 151             // We pushed a new stack frame, the engine should not do any jumping now!
 152             Ok(StackPopJump::NoJump)
 153         } else {
 154             Ok(StackPopJump::Normal)
 155         }
 156     }
 157
 158     /// Starta a panic in the interpreter with the given message as payload.
 159     fn start_panic(
 160         &mut self,
 161         msg: &str,
 162         unwind: Option<mir::BasicBlock>,
 163     ) -> InterpResult<'tcx> {
 164         let this = self.eval_context_mut();
 165
 166         // First arg: message.
 167         let msg = this.allocate_str(msg, MiriMemoryKind::Machine.into());
 168
 169         // Call the lang item.
 170         let panic = this.tcx.lang_items().panic_fn().unwrap();
 171         let panic = ty::Instance::mono(this.tcx.tcx, panic);
 172         this.call_function(
 173             panic,
 174             &[msg.to_ref()],
 175             None,
 176             StackPopCleanup::Goto { ret: None, unwind },
 177         )
 178     }
 179
 180     fn assert_panic(
 181         &mut self,
 182         msg: &mir::AssertMessage<'tcx>,
 183         unwind: Option<mir::BasicBlock>,
 184     ) -> InterpResult<'tcx> {
 185         use rustc_middle::mir::AssertKind::*;
 186         let this = self.eval_context_mut();
 187
 188         match msg {
 189             BoundsCheck { index, len } => {
 190                 // Forward to `panic_bounds_check` lang item.
 191
 192                 // First arg: index.
 193                 let index = this.read_scalar(this.eval_operand(index, None)?)?;
 194                 // Second arg: len.
 195                 let len = this.read_scalar(this.eval_operand(len, None)?)?;
 196
 197                 // Call the lang item.
 198                 let panic_bounds_check = this.tcx.lang_items().panic_bounds_check_fn().unwrap();
 199                 let panic_bounds_check = ty::Instance::mono(this.tcx.tcx, panic_bounds_check);
 200                 this.call_function(
 201                     panic_bounds_check,
 202                     &[index.into(), len.into()],
 203                     None,
 204                     StackPopCleanup::Goto { ret: None, unwind },
 205                 )?;
 206             }
 207             _ => {
 208                 // Forward everything else to `panic` lang item.
 209                 this.start_panic(msg.description(), unwind)?;
 210             }
 211         }
 212         Ok(())
 213     }
 214 }