Add rustc_panic_entrypoint

Author: saethlin

compiler/rustc_codegen_cranelift/src/base.rs

@@ -14,6 +14,7 @@ use rustc_middle::ty::layout::FnAbiOf;
 use rustc_middle::ty::print::with_no_trimmed_paths;
 use rustc_session::config::OutputFilenames;
 use rustc_span::Symbol;
+use rustc_target::spec::PanicStrategy;
 
 use crate::constant::ConstantCx;
 use crate::debuginfo::{FunctionDebugContext, TypeDebugContext};
@@ -384,6 +385,11 @@ fn codegen_fn_body(fx: &mut FunctionCx<'_, '_, '_>, start_block: Block) {
                 fx.bcx.switch_to_block(failure);
                 fx.bcx.ins().nop();
 
+                if fx.tcx.sess.panic_strategy() == PanicStrategy::ImmediateAbort {
+                    fx.bcx.ins().trap(TrapCode::user(1 /* unreachable */).unwrap());
+                    continue;
+                }
+
                 match &**msg {
                     AssertKind::BoundsCheck { len, index } => {
                         let len = codegen_operand(fx, len).load_scalar(fx);
@@ -1052,6 +1058,10 @@ pub(crate) fn codegen_panic_nounwind<'tcx>(
     msg_str: &str,
     span: Span,
 ) {
+    if fx.tcx.sess.panic_strategy() == PanicStrategy::ImmediateAbort {
+        fx.bcx.ins().trap(TrapCode::user(1 /* unreachable */).unwrap());
+    }
+
     let msg_ptr = crate::constant::pointer_for_anonymous_str(fx, msg_str);
     let msg_len = fx.bcx.ins().iconst(fx.pointer_type, i64::try_from(msg_str.len()).unwrap());
     let args = [msg_ptr, msg_len];

compiler/rustc_codegen_ssa/src/codegen_attrs.rs

@@ -4,7 +4,7 @@ use rustc_abi::{Align, ExternAbi};
 use rustc_ast::expand::autodiff_attrs::{AutoDiffAttrs, DiffActivity, DiffMode};
 use rustc_ast::{LitKind, MetaItem, MetaItemInner};
 use rustc_hir::attrs::{
-    AttributeKind, EiiImplResolution, InlineAttr, Linkage, RtsanSetting, UsedBy,
+    AttributeKind, EiiImplResolution, InlineAttr, Linkage, OptimizeAttr, RtsanSetting, UsedBy,
 };
 use rustc_hir::def::DefKind;
 use rustc_hir::def_id::{DefId, LOCAL_CRATE, LocalDefId};
@@ -19,7 +19,7 @@ use rustc_middle::ty::{self as ty, TyCtxt};
 use rustc_session::lint;
 use rustc_session::parse::feature_err;
 use rustc_span::{Span, sym};
-use rustc_target::spec::Os;
+use rustc_target::spec::{Os, PanicStrategy};
 
 use crate::errors;
 use crate::target_features::{
@@ -391,6 +391,24 @@ fn apply_overrides(tcx: TyCtxt<'_>, did: LocalDefId, codegen_fn_attrs: &mut Code
             codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
         }
     }
+
+    if tcx.is_panic_entrypoint(did) {
+        // Panic entrypoints are always cold.
+        //
+        // If we have immediate-abort enabled, we want them to be inlined.
+        // They shouldn't be called, but on the off-chance that they are, they should be inlined.
+        //
+        // When the panic strategies that support panic messages are enabled, we want panic
+        // entrypoints outlined and optimized for size.
+        // Most panic entrypoints want #[track_caller] but not all, so we do not add it.
+        codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
+        if tcx.sess.panic_strategy() == PanicStrategy::ImmediateAbort {
+            codegen_fn_attrs.inline = InlineAttr::Always;
+        } else {
+            codegen_fn_attrs.inline = InlineAttr::Never;
+            codegen_fn_attrs.optimize = OptimizeAttr::Size;
+        }
+    }
 }
 
 fn check_result(

compiler/rustc_codegen_ssa/src/mir/block.rs

@@ -15,6 +15,7 @@ use rustc_session::config::OptLevel;
 use rustc_span::Span;
 use rustc_span::source_map::Spanned;
 use rustc_target::callconv::{ArgAbi, ArgAttributes, CastTarget, FnAbi, PassMode};
+use rustc_target::spec::PanicStrategy;
 use tracing::{debug, info};
 
 use super::operand::OperandRef;
@@ -737,6 +738,12 @@ impl<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>> FunctionCx<'a, 'tcx, Bx> {
         bx.switch_to_block(panic_block);
         self.set_debug_loc(bx, terminator.source_info);
 
+        if bx.tcx().sess.panic_strategy() == PanicStrategy::ImmediateAbort {
+            bx.abort();
+            bx.unreachable();
+            return MergingSucc::False;
+        }
+
         // Get the location information.
         let location = self.get_caller_location(bx, terminator.source_info).immediate();
 

compiler/rustc_feature/src/builtin_attrs.rs

@@ -1329,6 +1329,10 @@ pub static BUILTIN_ATTRIBUTES: &[BuiltinAttribute] = &[
         "`#[rustc_has_incoherent_inherent_impls]` allows the addition of incoherent inherent impls for \
          the given type by annotating all impl items with `#[rustc_allow_incoherent_impl]`"
     ),
+    rustc_attr!(
+        rustc_panic_entrypoint, Normal, template!(Word), WarnFollowing,
+        EncodeCrossCrate::Yes, "`#[rustc_panic_entrypoint]` makes this function patchable by panic=immediate-abort",
+    ),
 
     BuiltinAttribute {
         name: sym::rustc_diagnostic_item,

compiler/rustc_hir/src/lang_items.rs

@@ -247,6 +247,7 @@ language_item_table! {
     FnMut,                   sym::fn_mut,              fn_mut_trait,               Target::Trait,          GenericRequirement::Exact(1);
     FnOnce,                  sym::fn_once,             fn_once_trait,              Target::Trait,          GenericRequirement::Exact(1);
 
+    AbortIntrinsic,          sym::abort_intrinsic,     abort_intrinsic,            Target::Fn,             GenericRequirement::Exact(0);
     AsyncFn,                 sym::async_fn,            async_fn_trait,             Target::Trait,          GenericRequirement::Exact(1);
     AsyncFnMut,              sym::async_fn_mut,        async_fn_mut_trait,         Target::Trait,          GenericRequirement::Exact(1);
     AsyncFnOnce,             sym::async_fn_once,       async_fn_once_trait,        Target::Trait,          GenericRequirement::Exact(1);

compiler/rustc_lint/messages.ftl

@@ -614,6 +614,8 @@ lint_missing_gpu_kernel_export_name = function with the "gpu-kernel" ABI has a m
     .note = mangled names make it hard to find the kernel, this is usually not intended
     .help = use `unsafe(no_mangle)` or `unsafe(export_name = "<name>")`
 
+lint_missing_panic_entrypoint = "diverging functions should usually have #[inline] or #[rustc_panic_entrypoint]"
+
 lint_mixed_script_confusables =
     the usage of Script Group `{$set}` in this crate consists solely of mixed script confusables
     .includes_note = the usage includes {$includes}

compiler/rustc_lint/src/internal.rs

@@ -1,12 +1,14 @@
 //! Some lints that are only useful in the compiler or crates that use compiler internals, such as
 //! Clippy.
 
-use rustc_hir::attrs::AttributeKind;
+use rustc_hir::attrs::{AttributeKind, InlineAttr};
 use rustc_hir::def::Res;
 use rustc_hir::def_id::DefId;
-use rustc_hir::{Expr, ExprKind, HirId, find_attr};
+use rustc_hir::intravisit::FnKind;
+use rustc_hir::{AttrPath, Body, Expr, ExprKind, FnDecl, HirId, find_attr};
 use rustc_middle::ty::{self, GenericArgsRef, PredicatePolarity};
 use rustc_session::{declare_lint_pass, declare_tool_lint};
+use rustc_span::def_id::LocalDefId;
 use rustc_span::hygiene::{ExpnKind, MacroKind};
 use rustc_span::{Span, sym};
 use {rustc_ast as ast, rustc_hir as hir};
@@ -627,3 +629,84 @@ impl EarlyLintPass for ImplicitSysrootCrateImport {
         }
     }
 }
+
+declare_tool_lint! {
+    /// The `missing_panic_entrypoint` lint detects forgotten use of #[rustc_panic_entrypoint].
+    ///
+    /// This lint is intended to ensure that panic=immediate-abort can function as designed,
+    /// because it uses #[rustc_panic_entrypoint] to locate functions that should be outlined
+    /// for other panic modes, and be deleted entirely when immediate-abort is enabled.
+    pub rustc::MISSING_PANIC_ENTRYPOINT,
+    Allow,
+    "detects missing #[rustc_panic_entrypoint]",
+    report_in_external_macro: true
+}
+
+declare_lint_pass!(MissingPanicEntrypoint => [MISSING_PANIC_ENTRYPOINT]);
+
+fn has_panic_entrypoint(attrs: &[hir::Attribute]) -> bool {
+    attrs.iter().any(|attr| {
+        if let hir::Attribute::Unparsed(box hir::AttrItem {
+            path: AttrPath { segments, .. }, ..
+        }) = attr
+        {
+            if segments[0] == sym::rustc_panic_entrypoint {
+                return true;
+            }
+        }
+        false
+    })
+}
+
+fn has_inline_encouragement(attrs: &[hir::Attribute]) -> bool {
+    attrs.iter().any(|attr| {
+        matches!(
+            attr,
+            hir::Attribute::Parsed(hir::attrs::AttributeKind::Inline(
+                InlineAttr::Hint | InlineAttr::Always | InlineAttr::Force { .. },
+                _
+            ))
+        )
+    })
+}
+
+fn has_rustc_intrinsic(attrs: &[hir::Attribute]) -> bool {
+    attrs.iter().any(|attr| {
+        if let hir::Attribute::Unparsed(box hir::AttrItem {
+            path: AttrPath { segments, .. }, ..
+        }) = attr
+        {
+            if segments[0] == sym::rustc_intrinsic {
+                return true;
+            }
+        }
+        false
+    })
+}
+
+impl<'tcx> LateLintPass<'tcx> for MissingPanicEntrypoint {
+    fn check_fn(
+        &mut self,
+        cx: &LateContext<'tcx>,
+        _: FnKind<'tcx>,
+        fn_decl: &'tcx FnDecl<'tcx>,
+        _: &'tcx Body<'tcx>,
+        span: Span,
+        def_id: LocalDefId,
+    ) {
+        if matches!(fn_decl.output, hir::FnRetTy::Return(hir::Ty { kind: hir::TyKind::Never, .. }))
+        {
+            let attrs = cx.tcx.hir_attrs(cx.tcx.local_def_id_to_hir_id(def_id));
+            if has_rustc_intrinsic(attrs) {
+                return;
+            }
+            if !has_inline_encouragement(attrs) && !has_panic_entrypoint(attrs) {
+                cx.emit_span_lint(
+                    MISSING_PANIC_ENTRYPOINT,
+                    span,
+                    crate::lints::MissingPanicEntrypoint,
+                );
+            }
+        }
+    }
+}

compiler/rustc_lint/src/lib.rs

@@ -240,6 +240,7 @@ late_lint_methods!(
             MapUnitFn: MapUnitFn,
             MissingDebugImplementations: MissingDebugImplementations,
             MissingDoc: MissingDoc,
+            MissingPanicEntrypoint: MissingPanicEntrypoint,
             AsyncClosureUsage: AsyncClosureUsage,
             AsyncFnInTrait: AsyncFnInTrait,
             NonLocalDefinitions: NonLocalDefinitions::default(),

compiler/rustc_lint/src/lints.rs

@@ -3325,3 +3325,7 @@ pub(crate) struct UnknownCrateTypesSuggestion {
     pub span: Span,
     pub snippet: Symbol,
 }
+
+#[derive(LintDiagnostic)]
+#[diag(lint_missing_panic_entrypoint)]
+pub(crate) struct MissingPanicEntrypoint;

compiler/rustc_middle/src/ty/context.rs

@@ -49,7 +49,7 @@ use rustc_session::config::CrateType;
 use rustc_session::cstore::{CrateStoreDyn, Untracked};
 use rustc_session::lint::Lint;
 use rustc_span::def_id::{CRATE_DEF_ID, DefPathHash, StableCrateId};
-use rustc_span::{DUMMY_SP, Ident, Span, Symbol, kw};
+use rustc_span::{DUMMY_SP, Ident, Span, Symbol, kw, sym};
 use rustc_type_ir::TyKind::*;
 use rustc_type_ir::lang_items::{SolverAdtLangItem, SolverLangItem, SolverTraitLangItem};
 pub use rustc_type_ir::lift::Lift;
@@ -3556,6 +3556,10 @@ impl<'tcx> TyCtxt<'tcx> {
         }
         false
     }
+
+    pub fn is_panic_entrypoint(self, def_id: impl Into<DefId>) -> bool {
+        self.has_attr(def_id, sym::rustc_panic_entrypoint)
+    }
 }
 
 pub fn provide(providers: &mut Providers) {