clippy_utils/
qualify_min_const_fn.rs

1// This code used to be a part of `rustc` but moved to Clippy as a result of
2// https://github.com/rust-lang/rust/issues/76618. Because of that, it contains unused code and some
3// of terminologies might not be relevant in the context of Clippy. Note that its behavior might
4// differ from the time of `rustc` even if the name stays the same.
5
6use crate::msrvs::{self, Msrv};
7use hir::LangItem;
8use rustc_const_eval::check_consts::ConstCx;
9use rustc_hir as hir;
10use rustc_hir::def_id::DefId;
11use rustc_hir::{RustcVersion, StableSince};
12use rustc_infer::infer::TyCtxtInferExt;
13use rustc_infer::traits::Obligation;
14use rustc_lint::LateContext;
15use rustc_middle::mir::{
16    Body, CastKind, NonDivergingIntrinsic, NullOp, Operand, Place, ProjectionElem, Rvalue, Statement, StatementKind,
17    Terminator, TerminatorKind,
18};
19use rustc_middle::traits::{BuiltinImplSource, ImplSource, ObligationCause};
20use rustc_middle::ty::adjustment::PointerCoercion;
21use rustc_middle::ty::{self, GenericArgKind, Instance, TraitRef, Ty, TyCtxt};
22use rustc_span::Span;
23use rustc_span::symbol::sym;
24use rustc_trait_selection::traits::{ObligationCtxt, SelectionContext};
25use std::borrow::Cow;
26
27type McfResult = Result<(), (Span, Cow<'static, str>)>;
28
29pub fn is_min_const_fn<'tcx>(cx: &LateContext<'tcx>, body: &Body<'tcx>, msrv: Msrv) -> McfResult {
30    let def_id = body.source.def_id();
31
32    for local in &body.local_decls {
33        check_ty(cx, local.ty, local.source_info.span, msrv)?;
34    }
35    if !msrv.meets(cx, msrvs::CONST_FN_TRAIT_BOUND)
36        && let Some(sized_did) = cx.tcx.lang_items().sized_trait()
37        && let Some(meta_sized_did) = cx.tcx.lang_items().meta_sized_trait()
38        && cx.tcx.param_env(def_id).caller_bounds().iter().any(|bound| {
39            bound.as_trait_clause().is_some_and(|clause| {
40                let did = clause.def_id();
41                did != sized_did && did != meta_sized_did
42            })
43        })
44    {
45        return Err((
46            body.span,
47            "non-`Sized` trait clause before `const_fn_trait_bound` is stabilized".into(),
48        ));
49    }
50    // impl trait is gone in MIR, so check the return type manually
51    check_ty(
52        cx,
53        cx.tcx.fn_sig(def_id).instantiate_identity().output().skip_binder(),
54        body.local_decls.iter().next().unwrap().source_info.span,
55        msrv,
56    )?;
57
58    for bb in &*body.basic_blocks {
59        // Cleanup blocks are ignored entirely by const eval, so we can too:
60        // https://github.com/rust-lang/rust/blob/1dea922ea6e74f99a0e97de5cdb8174e4dea0444/compiler/rustc_const_eval/src/transform/check_consts/check.rs#L382
61        if !bb.is_cleanup {
62            check_terminator(cx, body, bb.terminator(), msrv)?;
63            for stmt in &bb.statements {
64                check_statement(cx, body, def_id, stmt, msrv)?;
65            }
66        }
67    }
68    Ok(())
69}
70
71fn check_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, span: Span, msrv: Msrv) -> McfResult {
72    for arg in ty.walk() {
73        let ty = match arg.kind() {
74            GenericArgKind::Type(ty) => ty,
75
76            // No constraints on lifetimes or constants, except potentially
77            // constants' types, but `walk` will get to them as well.
78            GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => continue,
79        };
80
81        match ty.kind() {
82            ty::Ref(_, _, hir::Mutability::Mut) if !msrv.meets(cx, msrvs::CONST_MUT_REFS) => {
83                return Err((span, "mutable references in const fn are unstable".into()));
84            },
85            ty::Alias(ty::Opaque, ..) => return Err((span, "`impl Trait` in const fn is unstable".into())),
86            ty::FnPtr(..) => {
87                return Err((span, "function pointers in const fn are unstable".into()));
88            },
89            ty::Dynamic(preds, _) => {
90                for pred in *preds {
91                    match pred.skip_binder() {
92                        ty::ExistentialPredicate::AutoTrait(_) | ty::ExistentialPredicate::Projection(_) => {
93                            return Err((
94                                span,
95                                "trait bounds other than `Sized` \
96                                 on const fn parameters are unstable"
97                                    .into(),
98                            ));
99                        },
100                        ty::ExistentialPredicate::Trait(trait_ref) => {
101                            if Some(trait_ref.def_id) != cx.tcx.lang_items().sized_trait() {
102                                return Err((
103                                    span,
104                                    "trait bounds other than `Sized` \
105                                     on const fn parameters are unstable"
106                                        .into(),
107                                ));
108                            }
109                        },
110                    }
111                }
112            },
113            _ => {},
114        }
115    }
116    Ok(())
117}
118
119fn check_rvalue<'tcx>(
120    cx: &LateContext<'tcx>,
121    body: &Body<'tcx>,
122    def_id: DefId,
123    rvalue: &Rvalue<'tcx>,
124    span: Span,
125    msrv: Msrv,
126) -> McfResult {
127    match rvalue {
128        Rvalue::ThreadLocalRef(_) => Err((span, "cannot access thread local storage in const fn".into())),
129        Rvalue::Discriminant(place) | Rvalue::Ref(_, _, place) | Rvalue::RawPtr(_, place) => {
130            check_place(cx, *place, span, body, msrv)
131        },
132        Rvalue::CopyForDeref(place) => check_place(cx, *place, span, body, msrv),
133        Rvalue::Repeat(operand, _)
134        | Rvalue::Use(operand)
135        | Rvalue::WrapUnsafeBinder(operand, _)
136        | Rvalue::Cast(
137            CastKind::PointerWithExposedProvenance
138            | CastKind::IntToInt
139            | CastKind::FloatToInt
140            | CastKind::IntToFloat
141            | CastKind::FloatToFloat
142            | CastKind::FnPtrToPtr
143            | CastKind::PtrToPtr
144            | CastKind::PointerCoercion(PointerCoercion::MutToConstPointer | PointerCoercion::ArrayToPointer, _)
145            | CastKind::Subtype,
146            operand,
147            _,
148        ) => check_operand(cx, operand, span, body, msrv),
149        Rvalue::Cast(
150            CastKind::PointerCoercion(
151                PointerCoercion::UnsafeFnPointer
152                | PointerCoercion::ClosureFnPointer(_)
153                | PointerCoercion::ReifyFnPointer,
154                _,
155            ),
156            _,
157            _,
158        ) => Err((span, "function pointer casts are not allowed in const fn".into())),
159        Rvalue::Cast(CastKind::PointerCoercion(PointerCoercion::Unsize, _), op, cast_ty) => {
160            let Some(pointee_ty) = cast_ty.builtin_deref(true) else {
161                // We cannot allow this for now.
162                return Err((span, "unsizing casts are only allowed for references right now".into()));
163            };
164            let unsized_ty = cx
165                .tcx
166                .struct_tail_for_codegen(pointee_ty, ty::TypingEnv::post_analysis(cx.tcx, def_id));
167            if let ty::Slice(_) | ty::Str = unsized_ty.kind() {
168                check_operand(cx, op, span, body, msrv)?;
169                // Casting/coercing things to slices is fine.
170                Ok(())
171            } else {
172                // We just can't allow trait objects until we have figured out trait method calls.
173                Err((span, "unsizing casts are not allowed in const fn".into()))
174            }
175        },
176        Rvalue::Cast(CastKind::PointerExposeProvenance, _, _) => {
177            Err((span, "casting pointers to ints is unstable in const fn".into()))
178        },
179        Rvalue::Cast(CastKind::Transmute, _, _) => Err((
180            span,
181            "transmute can attempt to turn pointers into integers, so is unstable in const fn".into(),
182        )),
183        // binops are fine on integers
184        Rvalue::BinaryOp(_, box (lhs, rhs)) => {
185            check_operand(cx, lhs, span, body, msrv)?;
186            check_operand(cx, rhs, span, body, msrv)?;
187            let ty = lhs.ty(body, cx.tcx);
188            if ty.is_integral() || ty.is_bool() || ty.is_char() {
189                Ok(())
190            } else {
191                Err((
192                    span,
193                    "only int, `bool` and `char` operations are stable in const fn".into(),
194                ))
195            }
196        },
197        Rvalue::NullaryOp(NullOp::OffsetOf(_) | NullOp::UbChecks | NullOp::ContractChecks, _)
198        | Rvalue::ShallowInitBox(_, _) => Ok(()),
199        Rvalue::UnaryOp(_, operand) => {
200            let ty = operand.ty(body, cx.tcx);
201            if ty.is_integral() || ty.is_bool() {
202                check_operand(cx, operand, span, body, msrv)
203            } else {
204                Err((span, "only int and `bool` operations are stable in const fn".into()))
205            }
206        },
207        Rvalue::Aggregate(_, operands) => {
208            for operand in operands {
209                check_operand(cx, operand, span, body, msrv)?;
210            }
211            Ok(())
212        },
213    }
214}
215
216fn check_statement<'tcx>(
217    cx: &LateContext<'tcx>,
218    body: &Body<'tcx>,
219    def_id: DefId,
220    statement: &Statement<'tcx>,
221    msrv: Msrv,
222) -> McfResult {
223    let span = statement.source_info.span;
224    match &statement.kind {
225        StatementKind::Assign(box (place, rval)) => {
226            check_place(cx, *place, span, body, msrv)?;
227            check_rvalue(cx, body, def_id, rval, span, msrv)
228        },
229
230        StatementKind::FakeRead(box (_, place)) => check_place(cx, *place, span, body, msrv),
231        // just an assignment
232        StatementKind::SetDiscriminant { place, .. } => check_place(cx, **place, span, body, msrv),
233
234        StatementKind::Intrinsic(box NonDivergingIntrinsic::Assume(op)) => check_operand(cx, op, span, body, msrv),
235
236        StatementKind::Intrinsic(box NonDivergingIntrinsic::CopyNonOverlapping(
237            rustc_middle::mir::CopyNonOverlapping { dst, src, count },
238        )) => {
239            check_operand(cx, dst, span, body, msrv)?;
240            check_operand(cx, src, span, body, msrv)?;
241            check_operand(cx, count, span, body, msrv)
242        },
243        // These are all NOPs
244        StatementKind::StorageLive(_)
245        | StatementKind::StorageDead(_)
246        | StatementKind::Retag { .. }
247        | StatementKind::AscribeUserType(..)
248        | StatementKind::PlaceMention(..)
249        | StatementKind::Coverage(..)
250        | StatementKind::ConstEvalCounter
251        | StatementKind::BackwardIncompatibleDropHint { .. }
252        | StatementKind::Nop => Ok(()),
253    }
254}
255
256fn check_operand<'tcx>(
257    cx: &LateContext<'tcx>,
258    operand: &Operand<'tcx>,
259    span: Span,
260    body: &Body<'tcx>,
261    msrv: Msrv,
262) -> McfResult {
263    match operand {
264        Operand::Move(place) => {
265            if !place.projection.as_ref().is_empty()
266                && !is_ty_const_destruct(cx.tcx, place.ty(&body.local_decls, cx.tcx).ty, body)
267            {
268                return Err((
269                    span,
270                    "cannot drop locals with a non constant destructor in const fn".into(),
271                ));
272            }
273
274            check_place(cx, *place, span, body, msrv)
275        },
276        Operand::Copy(place) => check_place(cx, *place, span, body, msrv),
277        Operand::Constant(c) => match c.check_static_ptr(cx.tcx) {
278            Some(_) => Err((span, "cannot access `static` items in const fn".into())),
279            None => Ok(()),
280        },
281    }
282}
283
284fn check_place<'tcx>(
285    cx: &LateContext<'tcx>,
286    place: Place<'tcx>,
287    span: Span,
288    body: &Body<'tcx>,
289    msrv: Msrv,
290) -> McfResult {
291    for (base, elem) in place.as_ref().iter_projections() {
292        match elem {
293            ProjectionElem::Field(..) => {
294                if base.ty(body, cx.tcx).ty.is_union() && !msrv.meets(cx, msrvs::CONST_FN_UNION) {
295                    return Err((span, "accessing union fields is unstable".into()));
296                }
297            },
298            ProjectionElem::Deref => match base.ty(body, cx.tcx).ty.kind() {
299                ty::RawPtr(_, hir::Mutability::Mut) => {
300                    return Err((span, "dereferencing raw mut pointer in const fn is unstable".into()));
301                },
302                ty::RawPtr(_, hir::Mutability::Not) if !msrv.meets(cx, msrvs::CONST_RAW_PTR_DEREF) => {
303                    return Err((span, "dereferencing raw const pointer in const fn is unstable".into()));
304                },
305                _ => (),
306            },
307            ProjectionElem::ConstantIndex { .. }
308            | ProjectionElem::OpaqueCast(..)
309            | ProjectionElem::Downcast(..)
310            | ProjectionElem::Subslice { .. }
311            | ProjectionElem::Index(_)
312            | ProjectionElem::UnwrapUnsafeBinder(_) => {},
313        }
314    }
315
316    Ok(())
317}
318
319fn check_terminator<'tcx>(
320    cx: &LateContext<'tcx>,
321    body: &Body<'tcx>,
322    terminator: &Terminator<'tcx>,
323    msrv: Msrv,
324) -> McfResult {
325    let span = terminator.source_info.span;
326    match &terminator.kind {
327        TerminatorKind::FalseEdge { .. }
328        | TerminatorKind::FalseUnwind { .. }
329        | TerminatorKind::Goto { .. }
330        | TerminatorKind::Return
331        | TerminatorKind::UnwindResume
332        | TerminatorKind::UnwindTerminate(_)
333        | TerminatorKind::Unreachable => Ok(()),
334        TerminatorKind::Drop { place, .. } => {
335            if !is_ty_const_destruct(cx.tcx, place.ty(&body.local_decls, cx.tcx).ty, body) {
336                return Err((
337                    span,
338                    "cannot drop locals with a non constant destructor in const fn".into(),
339                ));
340            }
341            Ok(())
342        },
343        TerminatorKind::SwitchInt { discr, targets: _ } => check_operand(cx, discr, span, body, msrv),
344        TerminatorKind::CoroutineDrop | TerminatorKind::Yield { .. } => {
345            Err((span, "const fn coroutines are unstable".into()))
346        },
347        TerminatorKind::Call {
348            func,
349            args,
350            call_source: _,
351            destination: _,
352            target: _,
353            unwind: _,
354            fn_span: _,
355        }
356        | TerminatorKind::TailCall { func, args, fn_span: _ } => {
357            let fn_ty = func.ty(body, cx.tcx);
358            if let ty::FnDef(fn_def_id, fn_substs) = fn_ty.kind() {
359                // FIXME: when analyzing a function with generic parameters, we may not have enough information to
360                // resolve to an instance. However, we could check if a host effect predicate can guarantee that
361                // this can be made a `const` call.
362                let fn_def_id = match Instance::try_resolve(cx.tcx, cx.typing_env(), *fn_def_id, fn_substs) {
363                    Ok(Some(fn_inst)) => fn_inst.def_id(),
364                    Ok(None) => return Err((span, format!("cannot resolve instance for {func:?}").into())),
365                    Err(_) => return Err((span, format!("error during instance resolution of {func:?}").into())),
366                };
367                if !is_stable_const_fn(cx, fn_def_id, msrv) {
368                    return Err((
369                        span,
370                        format!(
371                            "can only call other `const fn` within a `const fn`, \
372                             but `{func:?}` is not stable as `const fn`",
373                        )
374                        .into(),
375                    ));
376                }
377
378                // HACK: This is to "unstabilize" the `transmute` intrinsic
379                // within const fns. `transmute` is allowed in all other const contexts.
380                // This won't really scale to more intrinsics or functions. Let's allow const
381                // transmutes in const fn before we add more hacks to this.
382                if cx.tcx.is_intrinsic(fn_def_id, sym::transmute) {
383                    return Err((
384                        span,
385                        "can only call `transmute` from const items, not `const fn`".into(),
386                    ));
387                }
388
389                check_operand(cx, func, span, body, msrv)?;
390
391                for arg in args {
392                    check_operand(cx, &arg.node, span, body, msrv)?;
393                }
394                Ok(())
395            } else {
396                Err((span, "can only call other const fns within const fn".into()))
397            }
398        },
399        TerminatorKind::Assert {
400            cond,
401            expected: _,
402            msg: _,
403            target: _,
404            unwind: _,
405        } => check_operand(cx, cond, span, body, msrv),
406        TerminatorKind::InlineAsm { .. } => Err((span, "cannot use inline assembly in const fn".into())),
407    }
408}
409
410/// Checks if the given `def_id` is a stable const fn, in respect to the given MSRV.
411pub fn is_stable_const_fn(cx: &LateContext<'_>, def_id: DefId, msrv: Msrv) -> bool {
412    cx.tcx.is_const_fn(def_id)
413        && cx
414            .tcx
415            .lookup_const_stability(def_id)
416            .or_else(|| {
417                cx.tcx
418                    .trait_of_assoc(def_id)
419                    .and_then(|trait_def_id| cx.tcx.lookup_const_stability(trait_def_id))
420            })
421            .is_none_or(|const_stab| {
422                if let rustc_hir::StabilityLevel::Stable { since, .. } = const_stab.level {
423                    // Checking MSRV is manually necessary because `rustc` has no such concept. This entire
424                    // function could be removed if `rustc` provided a MSRV-aware version of `is_stable_const_fn`.
425                    // as a part of an unimplemented MSRV check https://github.com/rust-lang/rust/issues/65262.
426
427                    let const_stab_rust_version = match since {
428                        StableSince::Version(version) => version,
429                        StableSince::Current => RustcVersion::CURRENT,
430                        StableSince::Err(_) => return false,
431                    };
432
433                    msrv.meets(cx, const_stab_rust_version)
434                } else {
435                    // Unstable const fn, check if the feature is enabled.
436                    cx.tcx.features().enabled(const_stab.feature) && msrv.current(cx).is_none()
437                }
438            })
439}
440
441fn is_ty_const_destruct<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, body: &Body<'tcx>) -> bool {
442    // FIXME(const_trait_impl, fee1-dead) revert to const destruct once it works again
443    #[expect(unused)]
444    fn is_ty_const_destruct_unused<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, body: &Body<'tcx>) -> bool {
445        // If this doesn't need drop at all, then don't select `[const] Destruct`.
446        if !ty.needs_drop(tcx, body.typing_env(tcx)) {
447            return false;
448        }
449
450        let (infcx, param_env) = tcx.infer_ctxt().build_with_typing_env(body.typing_env(tcx));
451        // FIXME(const_trait_impl) constness
452        let obligation = Obligation::new(
453            tcx,
454            ObligationCause::dummy_with_span(body.span),
455            param_env,
456            TraitRef::new(tcx, tcx.require_lang_item(LangItem::Destruct, body.span), [ty]),
457        );
458
459        let mut selcx = SelectionContext::new(&infcx);
460        let Some(impl_src) = selcx.select(&obligation).ok().flatten() else {
461            return false;
462        };
463
464        if !matches!(
465            impl_src,
466            ImplSource::Builtin(BuiltinImplSource::Misc, _) | ImplSource::Param(_)
467        ) {
468            return false;
469        }
470
471        let ocx = ObligationCtxt::new(&infcx);
472        ocx.register_obligations(impl_src.nested_obligations());
473        ocx.evaluate_obligations_error_on_ambiguity().is_empty()
474    }
475
476    !ty.needs_drop(tcx, ConstCx::new(tcx, body).typing_env)
477}
clippy_utils/qualify_min_const_fn.rs

clippy_utils/
qualify_min_const_fn.rs
