1 use rustc_attr as attr;
3 use rustc_hir::def_id::DefId;
4 use rustc_middle::mir::*;
5 use rustc_middle::ty::subst::GenericArgKind;
6 use rustc_middle::ty::{self, adjustment::PointerCast, Ty, TyCtxt};
7 use rustc_span::symbol::{sym, Symbol};
9 use rustc_target::spec::abi::Abi::RustIntrinsic;
12 type McfResult = Result<(), (Span, Cow<'static, str>)>;
14 pub fn is_min_const_fn(tcx: TyCtxt<'tcx>, def_id: DefId, body: &'a Body<'tcx>) -> McfResult {
15 // Prevent const trait methods from being annotated as `stable`.
16 if tcx.features().staged_api {
17 let hir_id = tcx.hir().as_local_hir_id(def_id.expect_local());
18 if crate::const_eval::is_parent_const_impl_raw(tcx, hir_id) {
19 return Err((body.span, "trait methods cannot be stable const fn".into()));
23 let mut current = def_id;
25 let predicates = tcx.predicates_of(current);
26 for (predicate, _) in predicates.predicates {
27 match predicate.kind() {
28 ty::PredicateKind::RegionOutlives(_)
29 | ty::PredicateKind::TypeOutlives(_)
30 | ty::PredicateKind::WellFormed(_)
31 | ty::PredicateKind::Projection(_)
32 | ty::PredicateKind::ConstEvaluatable(..)
33 | ty::PredicateKind::ConstEquate(..) => continue,
34 ty::PredicateKind::ObjectSafe(_) => {
35 bug!("object safe predicate on function: {:#?}", predicate)
37 ty::PredicateKind::ClosureKind(..) => {
38 bug!("closure kind predicate on function: {:#?}", predicate)
40 ty::PredicateKind::Subtype(_) => {
41 bug!("subtype predicate on function: {:#?}", predicate)
43 &ty::PredicateKind::Trait(pred, constness) => {
44 if Some(pred.def_id()) == tcx.lang_items().sized_trait() {
47 match pred.skip_binder().self_ty().kind {
49 // Allow `T: ?const Trait`
50 if constness == hir::Constness::NotConst
51 && feature_allowed(tcx, def_id, sym::const_trait_bound_opt_out)
56 let generics = tcx.generics_of(current);
57 let def = generics.type_param(p, tcx);
58 let span = tcx.def_span(def.def_id);
61 "trait bounds other than `Sized` \
62 on const fn parameters are unstable"
66 // other kinds of bounds are either tautologies
67 // or cause errors in other passes
73 match predicates.parent {
74 Some(parent) => current = parent,
79 for local in &body.local_decls {
80 check_ty(tcx, local.ty, local.source_info.span, def_id)?;
82 // impl trait is gone in MIR, so check the return type manually
85 tcx.fn_sig(def_id).output().skip_binder(),
86 body.local_decls.iter().next().unwrap().source_info.span,
90 for bb in body.basic_blocks() {
91 check_terminator(tcx, body, def_id, bb.terminator())?;
92 for stmt in &bb.statements {
93 check_statement(tcx, body, def_id, stmt)?;
99 fn check_ty(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, span: Span, fn_def_id: DefId) -> McfResult {
100 for arg in ty.walk() {
101 let ty = match arg.unpack() {
102 GenericArgKind::Type(ty) => ty,
104 // No constraints on lifetimes or constants, except potentially
105 // constants' types, but `walk` will get to them as well.
106 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => continue,
110 ty::Ref(_, _, hir::Mutability::Mut) => {
111 if !feature_allowed(tcx, fn_def_id, sym::const_mut_refs) {
112 return Err((span, "mutable references in const fn are unstable".into()));
115 ty::Opaque(..) => return Err((span, "`impl Trait` in const fn is unstable".into())),
117 if !tcx.const_fn_is_allowed_fn_ptr(fn_def_id) {
118 return Err((span, "function pointers in const fn are unstable".into()));
121 ty::Dynamic(preds, _) => {
122 for pred in preds.iter() {
123 match pred.skip_binder() {
124 ty::ExistentialPredicate::AutoTrait(_)
125 | ty::ExistentialPredicate::Projection(_) => {
128 "trait bounds other than `Sized` \
129 on const fn parameters are unstable"
133 ty::ExistentialPredicate::Trait(trait_ref) => {
134 if Some(trait_ref.def_id) != tcx.lang_items().sized_trait() {
137 "trait bounds other than `Sized` \
138 on const fn parameters are unstable"
156 rvalue: &Rvalue<'tcx>,
160 Rvalue::ThreadLocalRef(_) => {
161 Err((span, "cannot access thread local storage in const fn".into()))
163 Rvalue::Repeat(operand, _) | Rvalue::Use(operand) => {
164 check_operand(tcx, operand, span, def_id, body)
167 | Rvalue::Discriminant(place)
168 | Rvalue::Ref(_, _, place)
169 | Rvalue::AddressOf(_, place) => check_place(tcx, *place, span, def_id, body),
170 Rvalue::Cast(CastKind::Misc, operand, cast_ty) => {
171 use rustc_middle::ty::cast::CastTy;
172 let cast_in = CastTy::from_ty(operand.ty(body, tcx)).expect("bad input type for cast");
173 let cast_out = CastTy::from_ty(cast_ty).expect("bad output type for cast");
174 match (cast_in, cast_out) {
175 (CastTy::Ptr(_) | CastTy::FnPtr, CastTy::Int(_)) => {
176 Err((span, "casting pointers to ints is unstable in const fn".into()))
178 _ => check_operand(tcx, operand, span, def_id, body),
182 CastKind::Pointer(PointerCast::MutToConstPointer | PointerCast::ArrayToPointer),
185 ) => check_operand(tcx, operand, span, def_id, body),
188 PointerCast::UnsafeFnPointer
189 | PointerCast::ClosureFnPointer(_)
190 | PointerCast::ReifyFnPointer,
194 ) => Err((span, "function pointer casts are not allowed in const fn".into())),
195 Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), op, cast_ty) => {
196 let pointee_ty = cast_ty.builtin_deref(true).unwrap().ty;
197 let unsized_ty = tcx.struct_tail_erasing_lifetimes(pointee_ty, tcx.param_env(def_id));
198 if let ty::Slice(_) | ty::Str = unsized_ty.kind {
199 check_operand(tcx, op, span, def_id, body)?;
200 // Casting/coercing things to slices is fine.
203 // We just can't allow trait objects until we have figured out trait method calls.
204 Err((span, "unsizing casts are not allowed in const fn".into()))
207 // binops are fine on integers
208 Rvalue::BinaryOp(_, lhs, rhs) | Rvalue::CheckedBinaryOp(_, lhs, rhs) => {
209 check_operand(tcx, lhs, span, def_id, body)?;
210 check_operand(tcx, rhs, span, def_id, body)?;
211 let ty = lhs.ty(body, tcx);
212 if ty.is_integral() || ty.is_bool() || ty.is_char() {
215 Err((span, "only int, `bool` and `char` operations are stable in const fn".into()))
218 Rvalue::NullaryOp(NullOp::SizeOf, _) => Ok(()),
219 Rvalue::NullaryOp(NullOp::Box, _) => {
220 Err((span, "heap allocations are not allowed in const fn".into()))
222 Rvalue::UnaryOp(_, operand) => {
223 let ty = operand.ty(body, tcx);
224 if ty.is_integral() || ty.is_bool() {
225 check_operand(tcx, operand, span, def_id, body)
227 Err((span, "only int and `bool` operations are stable in const fn".into()))
230 Rvalue::Aggregate(_, operands) => {
231 for operand in operands {
232 check_operand(tcx, operand, span, def_id, body)?;
243 statement: &Statement<'tcx>,
245 let span = statement.source_info.span;
246 match &statement.kind {
247 StatementKind::Assign(box (place, rval)) => {
248 check_place(tcx, *place, span, def_id, body)?;
249 check_rvalue(tcx, body, def_id, rval, span)
252 StatementKind::FakeRead(_, place) => check_place(tcx, **place, span, def_id, body),
254 // just an assignment
255 StatementKind::SetDiscriminant { place, .. } => {
256 check_place(tcx, **place, span, def_id, body)
259 StatementKind::LlvmInlineAsm { .. } => {
260 Err((span, "cannot use inline assembly in const fn".into()))
263 // These are all NOPs
264 StatementKind::StorageLive(_)
265 | StatementKind::StorageDead(_)
266 | StatementKind::Retag { .. }
267 | StatementKind::AscribeUserType(..)
268 | StatementKind::Nop => Ok(()),
274 operand: &Operand<'tcx>,
280 Operand::Move(place) | Operand::Copy(place) => check_place(tcx, *place, span, def_id, body),
281 Operand::Constant(c) => match c.check_static_ptr(tcx) {
282 Some(_) => Err((span, "cannot access `static` items in const fn".into())),
295 let mut cursor = place.projection.as_ref();
296 while let &[ref proj_base @ .., elem] = cursor {
299 ProjectionElem::Field(..) => {
300 let base_ty = Place::ty_from(place.local, &proj_base, body, tcx).ty;
301 if let Some(def) = base_ty.ty_adt_def() {
302 // No union field accesses in `const fn`
304 if !feature_allowed(tcx, def_id, sym::const_fn_union) {
305 return Err((span, "accessing union fields is unstable".into()));
310 ProjectionElem::ConstantIndex { .. }
311 | ProjectionElem::Downcast(..)
312 | ProjectionElem::Subslice { .. }
313 | ProjectionElem::Deref
314 | ProjectionElem::Index(_) => {}
321 /// Returns `true` if the given feature gate is allowed within the function with the given `DefId`.
322 fn feature_allowed(tcx: TyCtxt<'tcx>, def_id: DefId, feature_gate: Symbol) -> bool {
323 // All features require that the corresponding gate be enabled,
324 // even if the function has `#[allow_internal_unstable(the_gate)]`.
325 if !tcx.features().enabled(feature_gate) {
329 // If this crate is not using stability attributes, or this function is not claiming to be a
330 // stable `const fn`, that is all that is required.
331 if !tcx.features().staged_api || tcx.has_attr(def_id, sym::rustc_const_unstable) {
335 // However, we cannot allow stable `const fn`s to use unstable features without an explicit
336 // opt-in via `allow_internal_unstable`.
337 attr::allow_internal_unstable(&tcx.get_attrs(def_id), &tcx.sess.diagnostic())
338 .map_or(false, |mut features| features.any(|name| name == feature_gate))
341 /// Returns `true` if the given library feature gate is allowed within the function with the given `DefId`.
342 pub fn lib_feature_allowed(tcx: TyCtxt<'tcx>, def_id: DefId, feature_gate: Symbol) -> bool {
343 // All features require that the corresponding gate be enabled,
344 // even if the function has `#[allow_internal_unstable(the_gate)]`.
345 if !tcx.features().declared_lib_features.iter().any(|&(sym, _)| sym == feature_gate) {
349 // If this crate is not using stability attributes, or this function is not claiming to be a
350 // stable `const fn`, that is all that is required.
351 if !tcx.features().staged_api || tcx.has_attr(def_id, sym::rustc_const_unstable) {
355 // However, we cannot allow stable `const fn`s to use unstable features without an explicit
356 // opt-in via `allow_internal_unstable`.
357 attr::allow_internal_unstable(&tcx.get_attrs(def_id), &tcx.sess.diagnostic())
358 .map_or(false, |mut features| features.any(|name| name == feature_gate))
363 body: &'a Body<'tcx>,
365 terminator: &Terminator<'tcx>,
367 let span = terminator.source_info.span;
368 match &terminator.kind {
369 TerminatorKind::FalseEdge { .. }
370 | TerminatorKind::FalseUnwind { .. }
371 | TerminatorKind::Goto { .. }
372 | TerminatorKind::Return
373 | TerminatorKind::Resume
374 | TerminatorKind::Unreachable => Ok(()),
376 TerminatorKind::Drop { place, .. } => check_place(tcx, *place, span, def_id, body),
377 TerminatorKind::DropAndReplace { place, value, .. } => {
378 check_place(tcx, *place, span, def_id, body)?;
379 check_operand(tcx, value, span, def_id, body)
382 TerminatorKind::SwitchInt { discr, switch_ty: _, values: _, targets: _ } => {
383 check_operand(tcx, discr, span, def_id, body)
386 TerminatorKind::Abort => Err((span, "abort is not stable in const fn".into())),
387 TerminatorKind::GeneratorDrop | TerminatorKind::Yield { .. } => {
388 Err((span, "const fn generators are unstable".into()))
391 TerminatorKind::Call {
399 let fn_ty = func.ty(body, tcx);
400 if let ty::FnDef(fn_def_id, _) = fn_ty.kind {
401 // Allow unstable const if we opt in by using #[allow_internal_unstable]
402 // on function or macro declaration.
403 if !crate::const_eval::is_min_const_fn(tcx, fn_def_id)
404 && !crate::const_eval::is_unstable_const_fn(tcx, fn_def_id)
406 span.allows_unstable(feature)
407 || lib_feature_allowed(tcx, def_id, feature)
414 "can only call other `const fn` within a `const fn`, \
415 but `{:?}` is not stable as `const fn`",
422 // HACK: This is to "unstabilize" the `transmute` intrinsic
423 // within const fns. `transmute` is allowed in all other const contexts.
424 // This won't really scale to more intrinsics or functions. Let's allow const
425 // transmutes in const fn before we add more hacks to this.
426 if tcx.fn_sig(fn_def_id).abi() == RustIntrinsic
427 && tcx.item_name(fn_def_id) == sym::transmute
428 && !feature_allowed(tcx, def_id, sym::const_fn_transmute)
432 "can only call `transmute` from const items, not `const fn`".into(),
436 check_operand(tcx, func, span, fn_def_id, body)?;
439 check_operand(tcx, arg, span, fn_def_id, body)?;
443 Err((span, "can only call other const fns within const fn".into()))
447 TerminatorKind::Assert { cond, expected: _, msg: _, target: _, cleanup: _ } => {
448 check_operand(tcx, cond, span, def_id, body)
451 TerminatorKind::InlineAsm { .. } => {
452 Err((span, "cannot use inline assembly in const fn".into()))