1 //! Helpers used to print a message and abort in case of certain panics and some detected UB.
5 fn codegen_print(fx: &mut FunctionCx<'_, '_, '_>, msg: &str) {
12 call_conv: CallConv::triple_default(fx.triple()),
13 params: vec![AbiParam::new(pointer_ty(fx.tcx))],
14 returns: vec![AbiParam::new(types::I32)],
18 let puts = fx.module.declare_func_in_func(puts, &mut fx.bcx.func);
19 if fx.clif_comments.enabled() {
20 fx.add_comment(puts, "puts");
23 let real_msg = format!("trap at {:?} ({}): {}\0", fx.instance, fx.symbol_name, msg);
24 let msg_ptr = fx.anonymous_str("trap", &real_msg);
25 fx.bcx.ins().call(puts, &[msg_ptr]);
29 pub(crate) fn trap_abort(fx: &mut FunctionCx<'_, '_, '_>, msg: impl AsRef<str>) {
30 codegen_print(fx, msg.as_ref());
31 fx.bcx.ins().trap(TrapCode::User(1));
34 /// Use this for example when a function call should never return. This will fill the current block,
35 /// so you can **not** add instructions to it afterwards.
37 /// Trap code: user65535
38 pub(crate) fn trap_unreachable(fx: &mut FunctionCx<'_, '_, '_>, msg: impl AsRef<str>) {
39 codegen_print(fx, msg.as_ref());
40 fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
43 /// Like `trap_unreachable` but returns a fake value of the specified type.
45 /// Trap code: user65535
46 pub(crate) fn trap_unreachable_ret_value<'tcx>(
47 fx: &mut FunctionCx<'_, '_, 'tcx>,
48 dest_layout: TyAndLayout<'tcx>,
51 codegen_print(fx, msg.as_ref());
52 let true_ = fx.bcx.ins().iconst(types::I32, 1);
53 fx.bcx.ins().trapnz(true_, TrapCode::UnreachableCodeReached);
54 CValue::by_ref(Pointer::const_addr(fx, 0), dest_layout)
57 /// Use this when something is unimplemented, but `libcore` or `libstd` requires it to codegen.
58 /// Unlike `trap_unreachable` this will not fill the current block, so you **must** add instructions
61 /// Trap code: user65535
62 pub(crate) fn trap_unimplemented(fx: &mut FunctionCx<'_, '_, '_>, msg: impl AsRef<str>) {
63 codegen_print(fx, msg.as_ref());
64 let true_ = fx.bcx.ins().iconst(types::I32, 1);
65 fx.bcx.ins().trapnz(true_, TrapCode::User(!0));
68 /// Like `trap_unimplemented` but returns a fake value of the specified type.
70 /// Trap code: user65535
71 pub(crate) fn trap_unimplemented_ret_value<'tcx>(
72 fx: &mut FunctionCx<'_, '_, 'tcx>,
73 dest_layout: TyAndLayout<'tcx>,
76 trap_unimplemented(fx, msg);
77 CValue::by_ref(Pointer::const_addr(fx, 0), dest_layout)