2 use rustc_index::vec::Idx;
3 use rustc_infer::infer::{InferCtxt, TyCtxtInferExt};
4 use rustc_middle::mir::{self, Field};
5 use rustc_middle::thir::{FieldPat, Pat, PatKind};
6 use rustc_middle::ty::print::with_no_trimmed_paths;
7 use rustc_middle::ty::{self, AdtDef, Ty, TyCtxt};
8 use rustc_session::lint;
10 use rustc_trait_selection::traits::predicate_for_trait_def;
11 use rustc_trait_selection::traits::query::evaluate_obligation::InferCtxtExt;
12 use rustc_trait_selection::traits::{self, ObligationCause, PredicateObligation};
18 impl<'a, 'tcx> PatCtxt<'a, 'tcx> {
19 /// Converts an evaluated constant to a pattern (if possible).
20 /// This means aggregate values (like structs and enums) are converted
21 /// to a pattern that matches the value (as if you'd compared via structural equality).
22 #[instrument(level = "debug", skip(self), ret)]
23 pub(super) fn const_to_pat(
25 cv: mir::ConstantKind<'tcx>,
28 mir_structural_match_violation: bool,
30 self.tcx.infer_ctxt().enter(|infcx| {
31 let mut convert = ConstToPat::new(self, id, span, infcx);
32 convert.to_pat(cv, mir_structural_match_violation)
37 struct ConstToPat<'a, 'tcx> {
40 param_env: ty::ParamEnv<'tcx>,
42 // This tracks if we emitted some hard error for a given const value, so that
43 // we will not subsequently issue an irrelevant lint for the same const
45 saw_const_match_error: Cell<bool>,
47 // This tracks if we emitted some diagnostic for a given const value, so that
48 // we will not subsequently issue an irrelevant lint for the same const
50 saw_const_match_lint: Cell<bool>,
52 // For backcompat we need to keep allowing non-structurally-eq types behind references.
53 // See also all the `cant-hide-behind` tests.
54 behind_reference: Cell<bool>,
56 // inference context used for checking `T: Structural` bounds.
57 infcx: InferCtxt<'a, 'tcx>,
59 include_lint_checks: bool,
61 treat_byte_string_as_slice: bool,
64 mod fallback_to_const_ref {
66 /// This error type signals that we encountered a non-struct-eq situation behind a reference.
67 /// We bubble this up in order to get back to the reference destructuring and make that emit
68 /// a const pattern instead of a deref pattern. This allows us to simply call `PartialEq::eq`
69 /// on such patterns (since that function takes a reference) and not have to jump through any
70 /// hoops to get a reference to the value.
71 pub(super) struct FallbackToConstRef(());
73 pub(super) fn fallback_to_const_ref<'a, 'tcx>(
74 c2p: &super::ConstToPat<'a, 'tcx>,
75 ) -> FallbackToConstRef {
76 assert!(c2p.behind_reference.get());
77 FallbackToConstRef(())
80 use fallback_to_const_ref::{fallback_to_const_ref, FallbackToConstRef};
82 impl<'a, 'tcx> ConstToPat<'a, 'tcx> {
84 pat_ctxt: &PatCtxt<'_, 'tcx>,
87 infcx: InferCtxt<'a, 'tcx>,
89 trace!(?pat_ctxt.typeck_results.hir_owner);
94 param_env: pat_ctxt.param_env,
95 include_lint_checks: pat_ctxt.include_lint_checks,
96 saw_const_match_error: Cell::new(false),
97 saw_const_match_lint: Cell::new(false),
98 behind_reference: Cell::new(false),
99 treat_byte_string_as_slice: pat_ctxt
101 .treat_byte_string_as_slice
102 .contains(&id.local_id),
106 fn tcx(&self) -> TyCtxt<'tcx> {
110 fn adt_derive_msg(&self, adt_def: AdtDef<'tcx>) -> String {
111 let path = self.tcx().def_path_str(adt_def.did());
113 "to use a constant of type `{}` in a pattern, \
114 `{}` must be annotated with `#[derive(PartialEq, Eq)]`",
119 fn search_for_structural_match_violation(&self, ty: Ty<'tcx>) -> Option<String> {
120 traits::search_for_structural_match_violation(self.span, self.tcx(), ty).map(|non_sm_ty| {
121 with_no_trimmed_paths!(match non_sm_ty.kind() {
122 ty::Adt(adt, _) => self.adt_derive_msg(*adt),
124 "trait objects cannot be used in patterns".to_string()
127 "opaque types cannot be used in patterns".to_string()
130 "closures cannot be used in patterns".to_string()
132 ty::Generator(..) | ty::GeneratorWitness(..) => {
133 "generators cannot be used in patterns".to_string()
136 "floating-point numbers cannot be used in patterns".to_string()
139 "function pointers cannot be used in patterns".to_string()
142 "raw pointers cannot be used in patterns".to_string()
145 bug!("use of a value of `{non_sm_ty}` inside a pattern")
151 fn type_marked_structural(&self, ty: Ty<'tcx>) -> bool {
152 ty.is_structural_eq_shallow(self.infcx.tcx)
157 cv: mir::ConstantKind<'tcx>,
158 mir_structural_match_violation: bool,
159 ) -> Box<Pat<'tcx>> {
160 trace!(self.treat_byte_string_as_slice);
161 // This method is just a wrapper handling a validity check; the heavy lifting is
162 // performed by the recursive `recur` method, which is not meant to be
163 // invoked except by this method.
165 // once indirect_structural_match is a full fledged error, this
166 // level of indirection can be eliminated
168 let inlined_const_as_pat =
169 self.recur(cv, mir_structural_match_violation).unwrap_or_else(|_| {
173 kind: PatKind::Constant { value: cv },
177 if self.include_lint_checks && !self.saw_const_match_error.get() {
178 // If we were able to successfully convert the const to some pat,
179 // double-check that all types in the const implement `Structural`.
181 let structural = self.search_for_structural_match_violation(cv.ty());
183 "search_for_structural_match_violation cv.ty: {:?} returned: {:?}",
188 // This can occur because const qualification treats all associated constants as
189 // opaque, whereas `search_for_structural_match_violation` tries to monomorphize them
192 // FIXME(#73448): Find a way to bring const qualification into parity with
193 // `search_for_structural_match_violation`.
194 if structural.is_none() && mir_structural_match_violation {
195 warn!("MIR const-checker found novel structural match violation. See #73448.");
196 return inlined_const_as_pat;
199 if let Some(msg) = structural {
200 if !self.type_may_have_partial_eq_impl(cv.ty()) {
201 // span_fatal avoids ICE from resolution of non-existent method (rare case).
202 self.tcx().sess.span_fatal(self.span, &msg);
203 } else if mir_structural_match_violation && !self.saw_const_match_lint.get() {
204 self.tcx().struct_span_lint_hir(
205 lint::builtin::INDIRECT_STRUCTURAL_MATCH,
209 lint.build(&msg).emit();
214 "`search_for_structural_match_violation` found one, but `CustomEq` was \
215 not in the qualifs for that `const`"
224 fn type_may_have_partial_eq_impl(&self, ty: Ty<'tcx>) -> bool {
225 // double-check there even *is* a semantic `PartialEq` to dispatch to.
227 // (If there isn't, then we can safely issue a hard
228 // error, because that's never worked, due to compiler
229 // using `PartialEq::eq` in this scenario in the past.)
230 let partial_eq_trait_id =
231 self.tcx().require_lang_item(hir::LangItem::PartialEq, Some(self.span));
232 let obligation: PredicateObligation<'_> = predicate_for_trait_def(
235 ObligationCause::misc(self.span, self.id),
241 // FIXME: should this call a `predicate_must_hold` variant instead?
243 let has_impl = self.infcx.predicate_may_hold(&obligation);
245 // Note: To fix rust-lang/rust#65466, we could just remove this type
246 // walk hack for function pointers, and unconditionally error
247 // if `PartialEq` is not implemented. However, that breaks stable
248 // code at the moment, because types like `for <'a> fn(&'a ())` do
249 // not *yet* implement `PartialEq`. So for now we leave this here.
251 || ty.walk().any(|t| match t.unpack() {
252 ty::subst::GenericArgKind::Lifetime(_) => false,
253 ty::subst::GenericArgKind::Type(t) => t.is_fn_ptr(),
254 ty::subst::GenericArgKind::Const(_) => false,
260 vals: impl Iterator<Item = mir::ConstantKind<'tcx>>,
261 ) -> Result<Vec<FieldPat<'tcx>>, FallbackToConstRef> {
264 let field = Field::new(idx);
265 Ok(FieldPat { field, pattern: self.recur(val, false)? })
270 // Recursive helper for `to_pat`; invoke that (instead of calling this directly).
271 #[instrument(skip(self), level = "debug")]
274 cv: mir::ConstantKind<'tcx>,
275 mir_structural_match_violation: bool,
276 ) -> Result<Box<Pat<'tcx>>, FallbackToConstRef> {
278 let span = self.span;
279 let tcx = self.tcx();
280 let param_env = self.param_env;
282 let kind = match cv.ty().kind() {
284 if self.include_lint_checks {
285 tcx.struct_span_lint_hir(
286 lint::builtin::ILLEGAL_FLOATING_POINT_LITERAL_PATTERN,
290 lint.build("floating-point types cannot be used in patterns").emit();
294 PatKind::Constant { value: cv }
296 ty::Adt(adt_def, _) if adt_def.is_union() => {
297 // Matching on union fields is unsafe, we can't hide it in constants
298 self.saw_const_match_error.set(true);
299 let msg = "cannot use unions in constant patterns";
300 if self.include_lint_checks {
301 tcx.sess.span_err(span, msg);
303 tcx.sess.delay_span_bug(span, msg);
308 if !self.type_may_have_partial_eq_impl(cv.ty())
309 // FIXME(#73448): Find a way to bring const qualification into parity with
310 // `search_for_structural_match_violation` and then remove this condition.
311 && self.search_for_structural_match_violation(cv.ty()).is_some() =>
313 // Obtain the actual type that isn't annotated. If we just looked at `cv.ty` we
314 // could get `Option<NonStructEq>`, even though `Option` is annotated with derive.
315 let msg = self.search_for_structural_match_violation(cv.ty()).unwrap();
316 self.saw_const_match_error.set(true);
317 if self.include_lint_checks {
318 tcx.sess.span_err(self.span, &msg);
320 tcx.sess.delay_span_bug(self.span, &msg);
324 // If the type is not structurally comparable, just emit the constant directly,
325 // causing the pattern match code to treat it opaquely.
326 // FIXME: This code doesn't emit errors itself, the caller emits the errors.
327 // So instead of specific errors, you just get blanket errors about the whole
329 // https://github.com/rust-lang/rust/pull/70743#discussion_r404701963 for
331 // Backwards compatibility hack because we can't cause hard errors on these
332 // types, so we compare them via `PartialEq::eq` at runtime.
333 ty::Adt(..) if !self.type_marked_structural(cv.ty()) && self.behind_reference.get() => {
334 if self.include_lint_checks
335 && !self.saw_const_match_error.get()
336 && !self.saw_const_match_lint.get()
338 self.saw_const_match_lint.set(true);
339 tcx.struct_span_lint_hir(
340 lint::builtin::INDIRECT_STRUCTURAL_MATCH,
345 "to use a constant of type `{}` in a pattern, \
346 `{}` must be annotated with `#[derive(PartialEq, Eq)]`",
350 lint.build(&msg).emit();
354 // Since we are behind a reference, we can just bubble the error up so we get a
355 // constant at reference type, making it easy to let the fallback call
356 // `PartialEq::eq` on it.
357 return Err(fallback_to_const_ref(self));
359 ty::Adt(adt_def, _) if !self.type_marked_structural(cv.ty()) => {
361 "adt_def {:?} has !type_marked_structural for cv.ty: {:?}",
365 let path = tcx.def_path_str(adt_def.did());
367 "to use a constant of type `{}` in a pattern, \
368 `{}` must be annotated with `#[derive(PartialEq, Eq)]`",
371 self.saw_const_match_error.set(true);
372 if self.include_lint_checks {
373 tcx.sess.span_err(span, &msg);
375 tcx.sess.delay_span_bug(span, &msg);
379 ty::Adt(adt_def, substs) if adt_def.is_enum() => {
380 let destructured = tcx.destructure_mir_constant(param_env, cv);
385 variant_index: destructured
387 .expect("destructed const of adt without variant id"),
388 subpatterns: self.field_pats(destructured.fields.iter().copied())?,
391 ty::Tuple(_) | ty::Adt(_, _) => {
392 let destructured = tcx.destructure_mir_constant(param_env, cv);
393 PatKind::Leaf { subpatterns: self.field_pats(destructured.fields.iter().copied())? }
395 ty::Array(..) => PatKind::Array {
397 .destructure_mir_constant(param_env, cv)
400 .map(|val| self.recur(*val, false))
401 .collect::<Result<_, _>>()?,
403 suffix: Box::new([]),
405 ty::Ref(_, pointee_ty, ..) => match *pointee_ty.kind() {
406 // These are not allowed and will error elsewhere anyway.
408 self.saw_const_match_error.set(true);
409 let msg = format!("`{}` cannot be used in patterns", cv.ty());
410 if self.include_lint_checks {
411 tcx.sess.span_err(span, &msg);
413 tcx.sess.delay_span_bug(span, &msg);
417 // `&str` is represented as `ConstValue::Slice`, let's keep using this
418 // optimization for now.
419 ty::Str => PatKind::Constant { value: cv },
420 // `b"foo"` produces a `&[u8; 3]`, but you can't use constants of array type when
421 // matching against references, you can only use byte string literals.
422 // The typechecker has a special case for byte string literals, by treating them
423 // as slices. This means we turn `&[T; N]` constants into slice patterns, which
424 // has no negative effects on pattern matching, even if we're actually matching on
426 ty::Array(..) if !self.treat_byte_string_as_slice => {
427 let old = self.behind_reference.replace(true);
428 let array = tcx.deref_mir_constant(self.param_env.and(cv));
429 let val = PatKind::Deref {
430 subpattern: Box::new(Pat {
431 kind: PatKind::Array {
433 .destructure_mir_constant(param_env, array)
436 .map(|val| self.recur(*val, false))
437 .collect::<Result<_, _>>()?,
439 suffix: Box::new([]),
445 self.behind_reference.set(old);
448 ty::Array(elem_ty, _) |
449 // Cannot merge this with the catch all branch below, because the `const_deref`
450 // changes the type from slice to array, we need to keep the original type in the
452 ty::Slice(elem_ty) => {
453 let old = self.behind_reference.replace(true);
454 let array = tcx.deref_mir_constant(self.param_env.and(cv));
455 let val = PatKind::Deref {
456 subpattern: Box::new(Pat {
457 kind: PatKind::Slice {
459 .destructure_mir_constant(param_env, array)
462 .map(|val| self.recur(*val, false))
463 .collect::<Result<_, _>>()?,
465 suffix: Box::new([]),
468 ty: tcx.mk_slice(elem_ty),
471 self.behind_reference.set(old);
474 // Backwards compatibility hack: support references to non-structural types.
476 // this pattern to a `PartialEq::eq` comparison and `PartialEq::eq` takes a
477 // reference. This makes the rest of the matching logic simpler as it doesn't have
478 // to figure out how to get a reference again.
479 ty::Adt(adt_def, _) if !self.type_marked_structural(*pointee_ty) => {
480 if self.behind_reference.get() {
481 if self.include_lint_checks
482 && !self.saw_const_match_error.get()
483 && !self.saw_const_match_lint.get()
485 self.saw_const_match_lint.set(true);
486 let msg = self.adt_derive_msg(adt_def);
487 self.tcx().struct_span_lint_hir(
488 lint::builtin::INDIRECT_STRUCTURAL_MATCH,
491 |lint| {lint.build(&msg).emit();},
494 PatKind::Constant { value: cv }
496 if !self.saw_const_match_error.get() {
497 self.saw_const_match_error.set(true);
498 let msg = self.adt_derive_msg(adt_def);
499 if self.include_lint_checks {
500 tcx.sess.span_err(span, &msg);
502 tcx.sess.delay_span_bug(span, &msg);
508 // All other references are converted into deref patterns and then recursively
509 // convert the dereferenced constant to a pattern that is the sub-pattern of the
512 if !pointee_ty.is_sized(tcx.at(span), param_env) {
513 // `tcx.deref_mir_constant()` below will ICE with an unsized type
514 // (except slices, which are handled in a separate arm above).
515 let msg = format!("cannot use unsized non-slice type `{}` in constant patterns", pointee_ty);
516 if self.include_lint_checks {
517 tcx.sess.span_err(span, &msg);
519 tcx.sess.delay_span_bug(span, &msg);
523 let old = self.behind_reference.replace(true);
524 // In case there are structural-match violations somewhere in this subpattern,
525 // we fall back to a const pattern. If we do not do this, we may end up with
526 // a !structural-match constant that is not of reference type, which makes it
527 // very hard to invoke `PartialEq::eq` on it as a fallback.
528 let val = match self.recur(tcx.deref_mir_constant(self.param_env.and(cv)), false) {
529 Ok(subpattern) => PatKind::Deref { subpattern },
530 Err(_) => PatKind::Constant { value: cv },
532 self.behind_reference.set(old);
537 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::FnDef(..) => {
538 PatKind::Constant { value: cv }
540 ty::RawPtr(pointee) if pointee.ty.is_sized(tcx.at(span), param_env) => {
541 PatKind::Constant { value: cv }
543 // FIXME: these can have very surprising behaviour where optimization levels or other
544 // compilation choices change the runtime behaviour of the match.
545 // See https://github.com/rust-lang/rust/issues/70861 for examples.
546 ty::FnPtr(..) | ty::RawPtr(..) => {
547 if self.include_lint_checks
548 && !self.saw_const_match_error.get()
549 && !self.saw_const_match_lint.get()
551 self.saw_const_match_lint.set(true);
552 let msg = "function pointers and unsized pointers in patterns behave \
553 unpredictably and should not be relied upon. \
554 See https://github.com/rust-lang/rust/issues/70861 for details.";
555 tcx.struct_span_lint_hir(
556 lint::builtin::POINTER_STRUCTURAL_MATCH,
560 lint.build(msg).emit();
564 PatKind::Constant { value: cv }
567 self.saw_const_match_error.set(true);
568 let msg = format!("`{}` cannot be used in patterns", cv.ty());
569 if self.include_lint_checks {
570 tcx.sess.span_err(span, &msg);
572 tcx.sess.delay_span_bug(span, &msg);
578 if self.include_lint_checks
579 && !self.saw_const_match_error.get()
580 && !self.saw_const_match_lint.get()
581 && mir_structural_match_violation
582 // FIXME(#73448): Find a way to bring const qualification into parity with
583 // `search_for_structural_match_violation` and then remove this condition.
584 && self.search_for_structural_match_violation(cv.ty()).is_some()
586 self.saw_const_match_lint.set(true);
587 // Obtain the actual type that isn't annotated. If we just looked at `cv.ty` we
588 // could get `Option<NonStructEq>`, even though `Option` is annotated with derive.
589 let msg = self.search_for_structural_match_violation(cv.ty()).unwrap().replace(
591 "in a pattern, the constant's initializer must be trivial or",
593 tcx.struct_span_lint_hir(
594 lint::builtin::NONTRIVIAL_STRUCTURAL_MATCH,
598 lint.build(&msg).emit();
603 Ok(Box::new(Pat { span, ty: cv.ty(), kind }))