compiler/rustc_codegen_cranelift/src/trap.rs

   1 //! Helpers used to print a message and abort in case of certain panics and some detected UB.
   2
   3 use crate::prelude::*;
   4
   5 fn codegen_print(fx: &mut FunctionCx<'_, '_, '_>, msg: &str) {
   6     let puts = fx
   7         .cx
   8         .module
   9         .declare_function(
  10             "puts",
  11             Linkage::Import,
  12             &Signature {
  13                 call_conv: CallConv::triple_default(fx.triple()),
  14                 params: vec![AbiParam::new(pointer_ty(fx.tcx))],
  15                 returns: vec![AbiParam::new(types::I32)],
  16             },
  17         )
  18         .unwrap();
  19     let puts = fx.cx.module.declare_func_in_func(puts, &mut fx.bcx.func);
  20     #[cfg(debug_assertions)]
  21     {
  22         fx.add_comment(puts, "puts");
  23     }
  24
  25     let symbol_name = fx.tcx.symbol_name(fx.instance);
  26     let real_msg = format!("trap at {:?} ({}): {}\0", fx.instance, symbol_name, msg);
  27     let msg_ptr = fx.anonymous_str("trap", &real_msg);
  28     fx.bcx.ins().call(puts, &[msg_ptr]);
  29 }
  30
  31 /// Trap code: user1
  32 pub(crate) fn trap_abort(fx: &mut FunctionCx<'_, '_, '_>, msg: impl AsRef<str>) {
  33     codegen_print(fx, msg.as_ref());
  34     fx.bcx.ins().trap(TrapCode::User(1));
  35 }
  36
  37 /// Use this for example when a function call should never return. This will fill the current block,
  38 /// so you can **not** add instructions to it afterwards.
  39 ///
  40 /// Trap code: user65535
  41 pub(crate) fn trap_unreachable(fx: &mut FunctionCx<'_, '_, '_>, msg: impl AsRef<str>) {
  42     codegen_print(fx, msg.as_ref());
  43     fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
  44 }
  45
  46 /// Like `trap_unreachable` but returns a fake value of the specified type.
  47 ///
  48 /// Trap code: user65535
  49 pub(crate) fn trap_unreachable_ret_value<'tcx>(
  50     fx: &mut FunctionCx<'_, '_, 'tcx>,
  51     dest_layout: TyAndLayout<'tcx>,
  52     msg: impl AsRef<str>,
  53 ) -> CValue<'tcx> {
  54     codegen_print(fx, msg.as_ref());
  55     let true_ = fx.bcx.ins().iconst(types::I32, 1);
  56     fx.bcx.ins().trapnz(true_, TrapCode::UnreachableCodeReached);
  57     CValue::by_ref(Pointer::const_addr(fx, 0), dest_layout)
  58 }
  59
  60 /// Use this when something is unimplemented, but `libcore` or `libstd` requires it to codegen.
  61 /// Unlike `trap_unreachable` this will not fill the current block, so you **must** add instructions
  62 /// to it afterwards.
  63 ///
  64 /// Trap code: user65535
  65 pub(crate) fn trap_unimplemented(fx: &mut FunctionCx<'_, '_, '_>, msg: impl AsRef<str>) {
  66     codegen_print(fx, msg.as_ref());
  67     let true_ = fx.bcx.ins().iconst(types::I32, 1);
  68     fx.bcx.ins().trapnz(true_, TrapCode::User(!0));
  69 }
  70
  71 /// Like `trap_unimplemented` but returns a fake value of the specified type.
  72 ///
  73 /// Trap code: user65535
  74 pub(crate) fn trap_unimplemented_ret_value<'tcx>(
  75     fx: &mut FunctionCx<'_, '_, 'tcx>,
  76     dest_layout: TyAndLayout<'tcx>,
  77     msg: impl AsRef<str>,
  78 ) -> CValue<'tcx> {
  79     trap_unimplemented(fx, msg);
  80     CValue::by_ref(Pointer::const_addr(fx, 0), dest_layout)
  81 }