compiler/rustc_const_eval/src/const_eval/fn_queries.rs

   1 use rustc_hir as hir;
   2 use rustc_hir::def_id::DefId;
   3 use rustc_middle::hir::map::blocks::FnLikeNode;
   4 use rustc_middle::ty::query::Providers;
   5 use rustc_middle::ty::TyCtxt;
   6 use rustc_span::symbol::Symbol;
   7 use rustc_target::spec::abi::Abi;
   8
   9 /// Whether the `def_id` counts as const fn in your current crate, considering all active
  10 /// feature gates
  11 pub fn is_const_fn(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
  12     tcx.is_const_fn_raw(def_id)
  13         && match is_unstable_const_fn(tcx, def_id) {
  14             Some(feature_name) => {
  15                 // has a `rustc_const_unstable` attribute, check whether the user enabled the
  16                 // corresponding feature gate.
  17                 tcx.features().declared_lib_features.iter().any(|&(sym, _)| sym == feature_name)
  18             }
  19             // functions without const stability are either stable user written
  20             // const fn or the user is using feature gates and we thus don't
  21             // care what they do
  22             None => true,
  23         }
  24 }
  25
  26 /// Whether the `def_id` is an unstable const fn and what feature gate is necessary to enable it
  27 pub fn is_unstable_const_fn(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Symbol> {
  28     if tcx.is_const_fn_raw(def_id) {
  29         let const_stab = tcx.lookup_const_stability(def_id)?;
  30         if const_stab.level.is_unstable() { Some(const_stab.feature) } else { None }
  31     } else {
  32         None
  33     }
  34 }
  35
  36 pub fn is_parent_const_impl_raw(tcx: TyCtxt<'_>, hir_id: hir::HirId) -> bool {
  37     let parent_id = tcx.hir().get_parent_node(hir_id);
  38     matches!(
  39         tcx.hir().get(parent_id),
  40         hir::Node::Item(hir::Item {
  41             kind: hir::ItemKind::Impl(hir::Impl { constness: hir::Constness::Const, .. }),
  42             ..
  43         })
  44     )
  45 }
  46
  47 /// Checks whether the function has a `const` modifier or, in case it is an intrinsic, whether
  48 /// said intrinsic has a `rustc_const_{un,}stable` attribute.
  49 fn is_const_fn_raw(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
  50     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
  51
  52     let node = tcx.hir().get(hir_id);
  53
  54     if let hir::Node::ForeignItem(hir::ForeignItem { kind: hir::ForeignItemKind::Fn(..), .. }) =
  55         node
  56     {
  57         // Intrinsics use `rustc_const_{un,}stable` attributes to indicate constness. All other
  58         // foreign items cannot be evaluated at compile-time.
  59         if let Abi::RustIntrinsic | Abi::PlatformIntrinsic = tcx.hir().get_foreign_abi(hir_id) {
  60             tcx.lookup_const_stability(def_id).is_some()
  61         } else {
  62             false
  63         }
  64     } else if let Some(fn_like) = FnLikeNode::from_node(node) {
  65         if fn_like.constness() == hir::Constness::Const {
  66             return true;
  67         }
  68
  69         // If the function itself is not annotated with `const`, it may still be a `const fn`
  70         // if it resides in a const trait impl.
  71         is_parent_const_impl_raw(tcx, hir_id)
  72     } else if let hir::Node::Ctor(_) = node {
  73         true
  74     } else {
  75         false
  76     }
  77 }
  78
  79 fn is_promotable_const_fn(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
  80     is_const_fn(tcx, def_id)
  81         && match tcx.lookup_const_stability(def_id) {
  82             Some(stab) => {
  83                 if cfg!(debug_assertions) && stab.promotable {
  84                     let sig = tcx.fn_sig(def_id);
  85                     assert_eq!(
  86                         sig.unsafety(),
  87                         hir::Unsafety::Normal,
  88                         "don't mark const unsafe fns as promotable",
  89                         // https://github.com/rust-lang/rust/pull/53851#issuecomment-418760682
  90                     );
  91                 }
  92                 stab.promotable
  93             }
  94             None => false,
  95         }
  96 }
  97
  98 pub fn provide(providers: &mut Providers) {
  99     *providers = Providers { is_const_fn_raw, is_promotable_const_fn, ..*providers };
 100 }