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))]
23 pub(super) fn const_to_pat(
25 cv: mir::ConstantKind<'tcx>,
28 mir_structural_match_violation: bool,
30 let pat = 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)
40 struct ConstToPat<'a, 'tcx> {
43 param_env: ty::ParamEnv<'tcx>,
45 // This tracks if we emitted some hard error for a given const value, so that
46 // we will not subsequently issue an irrelevant lint for the same const
48 saw_const_match_error: Cell<bool>,
50 // This tracks if we emitted some diagnostic for a given const value, so that
51 // we will not subsequently issue an irrelevant lint for the same const
53 saw_const_match_lint: Cell<bool>,
55 // For backcompat we need to keep allowing non-structurally-eq types behind references.
56 // See also all the `cant-hide-behind` tests.
57 behind_reference: Cell<bool>,
59 // inference context used for checking `T: Structural` bounds.
60 infcx: InferCtxt<'a, 'tcx>,
62 include_lint_checks: bool,
64 treat_byte_string_as_slice: bool,
67 mod fallback_to_const_ref {
69 /// This error type signals that we encountered a non-struct-eq situation behind a reference.
70 /// We bubble this up in order to get back to the reference destructuring and make that emit
71 /// a const pattern instead of a deref pattern. This allows us to simply call `PartialEq::eq`
72 /// on such patterns (since that function takes a reference) and not have to jump through any
73 /// hoops to get a reference to the value.
74 pub(super) struct FallbackToConstRef(());
76 pub(super) fn fallback_to_const_ref<'a, 'tcx>(
77 c2p: &super::ConstToPat<'a, 'tcx>,
78 ) -> FallbackToConstRef {
79 assert!(c2p.behind_reference.get());
80 FallbackToConstRef(())
83 use fallback_to_const_ref::{fallback_to_const_ref, FallbackToConstRef};
85 impl<'a, 'tcx> ConstToPat<'a, 'tcx> {
87 pat_ctxt: &PatCtxt<'_, 'tcx>,
90 infcx: InferCtxt<'a, 'tcx>,
92 trace!(?pat_ctxt.typeck_results.hir_owner);
97 param_env: pat_ctxt.param_env,
98 include_lint_checks: pat_ctxt.include_lint_checks,
99 saw_const_match_error: Cell::new(false),
100 saw_const_match_lint: Cell::new(false),
101 behind_reference: Cell::new(false),
102 treat_byte_string_as_slice: pat_ctxt
104 .treat_byte_string_as_slice
105 .contains(&id.local_id),
109 fn tcx(&self) -> TyCtxt<'tcx> {
113 fn adt_derive_msg(&self, adt_def: AdtDef<'tcx>) -> String {
114 let path = self.tcx().def_path_str(adt_def.did());
116 "to use a constant of type `{}` in a pattern, \
117 `{}` must be annotated with `#[derive(PartialEq, Eq)]`",
122 fn search_for_structural_match_violation(&self, ty: Ty<'tcx>) -> Option<String> {
123 traits::search_for_structural_match_violation(self.span, self.tcx(), ty).map(|non_sm_ty| {
124 with_no_trimmed_paths!(match non_sm_ty.kind() {
125 ty::Adt(adt, _) => self.adt_derive_msg(*adt),
127 "trait objects cannot be used in patterns".to_string()
130 "opaque types cannot be used in patterns".to_string()
133 "closures cannot be used in patterns".to_string()
135 ty::Generator(..) | ty::GeneratorWitness(..) => {
136 "generators cannot be used in patterns".to_string()
139 "floating-point numbers cannot be used in patterns".to_string()
142 "function pointers cannot be used in patterns".to_string()
145 "raw pointers cannot be used in patterns".to_string()
148 bug!("use of a value of `{non_sm_ty}` inside a pattern")
154 fn type_marked_structural(&self, ty: Ty<'tcx>) -> bool {
155 ty.is_structural_eq_shallow(self.infcx.tcx)
160 cv: mir::ConstantKind<'tcx>,
161 mir_structural_match_violation: bool,
163 trace!(self.treat_byte_string_as_slice);
164 // This method is just a wrapper handling a validity check; the heavy lifting is
165 // performed by the recursive `recur` method, which is not meant to be
166 // invoked except by this method.
168 // once indirect_structural_match is a full fledged error, this
169 // level of indirection can be eliminated
171 let inlined_const_as_pat =
172 self.recur(cv, mir_structural_match_violation).unwrap_or_else(|_| Pat {
175 kind: Box::new(PatKind::Constant { value: cv }),
178 if self.include_lint_checks && !self.saw_const_match_error.get() {
179 // If we were able to successfully convert the const to some pat,
180 // double-check that all types in the const implement `Structural`.
182 let structural = self.search_for_structural_match_violation(cv.ty());
184 "search_for_structural_match_violation cv.ty: {:?} returned: {:?}",
189 // This can occur because const qualification treats all associated constants as
190 // opaque, whereas `search_for_structural_match_violation` tries to monomorphize them
193 // FIXME(#73448): Find a way to bring const qualification into parity with
194 // `search_for_structural_match_violation`.
195 if structural.is_none() && mir_structural_match_violation {
196 warn!("MIR const-checker found novel structural match violation. See #73448.");
197 return inlined_const_as_pat;
200 if let Some(msg) = structural {
201 if !self.type_may_have_partial_eq_impl(cv.ty()) {
202 // span_fatal avoids ICE from resolution of non-existent method (rare case).
203 self.tcx().sess.span_fatal(self.span, &msg);
204 } else if mir_structural_match_violation && !self.saw_const_match_lint.get() {
205 self.tcx().struct_span_lint_hir(
206 lint::builtin::INDIRECT_STRUCTURAL_MATCH,
210 lint.build(&msg).emit();
215 "`search_for_structural_match_violation` found one, but `CustomEq` was \
216 not in the qualifs for that `const`"
225 fn type_may_have_partial_eq_impl(&self, ty: Ty<'tcx>) -> bool {
226 // double-check there even *is* a semantic `PartialEq` to dispatch to.
228 // (If there isn't, then we can safely issue a hard
229 // error, because that's never worked, due to compiler
230 // using `PartialEq::eq` in this scenario in the past.)
231 let partial_eq_trait_id =
232 self.tcx().require_lang_item(hir::LangItem::PartialEq, Some(self.span));
233 let obligation: PredicateObligation<'_> = predicate_for_trait_def(
236 ObligationCause::misc(self.span, self.id),
242 // FIXME: should this call a `predicate_must_hold` variant instead?
244 let has_impl = self.infcx.predicate_may_hold(&obligation);
246 // Note: To fix rust-lang/rust#65466, we could just remove this type
247 // walk hack for function pointers, and unconditionally error
248 // if `PartialEq` is not implemented. However, that breaks stable
249 // code at the moment, because types like `for <'a> fn(&'a ())` do
250 // not *yet* implement `PartialEq`. So for now we leave this here.
252 || ty.walk().any(|t| match t.unpack() {
253 ty::subst::GenericArgKind::Lifetime(_) => false,
254 ty::subst::GenericArgKind::Type(t) => t.is_fn_ptr(),
255 ty::subst::GenericArgKind::Const(_) => false,
261 vals: impl Iterator<Item = mir::ConstantKind<'tcx>>,
262 ) -> Result<Vec<FieldPat<'tcx>>, FallbackToConstRef> {
265 let field = Field::new(idx);
266 Ok(FieldPat { field, pattern: self.recur(val, false)? })
271 // Recursive helper for `to_pat`; invoke that (instead of calling this directly).
272 #[instrument(skip(self), level = "debug")]
275 cv: mir::ConstantKind<'tcx>,
276 mir_structural_match_violation: bool,
277 ) -> Result<Pat<'tcx>, FallbackToConstRef> {
279 let span = self.span;
280 let tcx = self.tcx();
281 let param_env = self.param_env;
283 let kind = match cv.ty().kind() {
285 if self.include_lint_checks {
286 tcx.struct_span_lint_hir(
287 lint::builtin::ILLEGAL_FLOATING_POINT_LITERAL_PATTERN,
291 lint.build("floating-point types cannot be used in patterns").emit();
295 PatKind::Constant { value: cv }
297 ty::Adt(adt_def, _) if adt_def.is_union() => {
298 // Matching on union fields is unsafe, we can't hide it in constants
299 self.saw_const_match_error.set(true);
300 let msg = "cannot use unions in constant patterns";
301 if self.include_lint_checks {
302 tcx.sess.span_err(span, msg);
304 tcx.sess.delay_span_bug(span, msg);
309 if !self.type_may_have_partial_eq_impl(cv.ty())
310 // FIXME(#73448): Find a way to bring const qualification into parity with
311 // `search_for_structural_match_violation` and then remove this condition.
312 && self.search_for_structural_match_violation(cv.ty()).is_some() =>
314 // Obtain the actual type that isn't annotated. If we just looked at `cv.ty` we
315 // could get `Option<NonStructEq>`, even though `Option` is annotated with derive.
316 let msg = self.search_for_structural_match_violation(cv.ty()).unwrap();
317 self.saw_const_match_error.set(true);
318 if self.include_lint_checks {
319 tcx.sess.span_err(self.span, &msg);
321 tcx.sess.delay_span_bug(self.span, &msg);
325 // If the type is not structurally comparable, just emit the constant directly,
326 // causing the pattern match code to treat it opaquely.
327 // FIXME: This code doesn't emit errors itself, the caller emits the errors.
328 // So instead of specific errors, you just get blanket errors about the whole
330 // https://github.com/rust-lang/rust/pull/70743#discussion_r404701963 for
332 // Backwards compatibility hack because we can't cause hard errors on these
333 // types, so we compare them via `PartialEq::eq` at runtime.
334 ty::Adt(..) if !self.type_marked_structural(cv.ty()) && self.behind_reference.get() => {
335 if self.include_lint_checks
336 && !self.saw_const_match_error.get()
337 && !self.saw_const_match_lint.get()
339 self.saw_const_match_lint.set(true);
340 tcx.struct_span_lint_hir(
341 lint::builtin::INDIRECT_STRUCTURAL_MATCH,
346 "to use a constant of type `{}` in a pattern, \
347 `{}` must be annotated with `#[derive(PartialEq, Eq)]`",
351 lint.build(&msg).emit();
355 // Since we are behind a reference, we can just bubble the error up so we get a
356 // constant at reference type, making it easy to let the fallback call
357 // `PartialEq::eq` on it.
358 return Err(fallback_to_const_ref(self));
360 ty::Adt(adt_def, _) if !self.type_marked_structural(cv.ty()) => {
362 "adt_def {:?} has !type_marked_structural for cv.ty: {:?}",
366 let path = tcx.def_path_str(adt_def.did());
368 "to use a constant of type `{}` in a pattern, \
369 `{}` must be annotated with `#[derive(PartialEq, Eq)]`",
372 self.saw_const_match_error.set(true);
373 if self.include_lint_checks {
374 tcx.sess.span_err(span, &msg);
376 tcx.sess.delay_span_bug(span, &msg);
380 ty::Adt(adt_def, substs) if adt_def.is_enum() => {
381 let destructured = tcx.destructure_mir_constant(param_env, cv);
386 variant_index: destructured
388 .expect("destructed const of adt without variant id"),
389 subpatterns: self.field_pats(destructured.fields.iter().copied())?,
392 ty::Tuple(_) | ty::Adt(_, _) => {
393 let destructured = tcx.destructure_mir_constant(param_env, cv);
394 PatKind::Leaf { subpatterns: self.field_pats(destructured.fields.iter().copied())? }
396 ty::Array(..) => PatKind::Array {
398 .destructure_mir_constant(param_env, cv)
401 .map(|val| self.recur(*val, false))
402 .collect::<Result<_, _>>()?,
406 ty::Ref(_, pointee_ty, ..) => match *pointee_ty.kind() {
407 // These are not allowed and will error elsewhere anyway.
409 self.saw_const_match_error.set(true);
410 let msg = format!("`{}` cannot be used in patterns", cv.ty());
411 if self.include_lint_checks {
412 tcx.sess.span_err(span, &msg);
414 tcx.sess.delay_span_bug(span, &msg);
418 // `&str` is represented as `ConstValue::Slice`, let's keep using this
419 // optimization for now.
420 ty::Str => PatKind::Constant { value: cv },
421 // `b"foo"` produces a `&[u8; 3]`, but you can't use constants of array type when
422 // matching against references, you can only use byte string literals.
423 // The typechecker has a special case for byte string literals, by treating them
424 // as slices. This means we turn `&[T; N]` constants into slice patterns, which
425 // has no negative effects on pattern matching, even if we're actually matching on
427 ty::Array(..) if !self.treat_byte_string_as_slice => {
428 let old = self.behind_reference.replace(true);
429 let array = tcx.deref_mir_constant(self.param_env.and(cv));
430 let val = PatKind::Deref {
432 kind: Box::new(PatKind::Array {
434 .destructure_mir_constant(param_env, array)
437 .map(|val| self.recur(*val, false))
438 .collect::<Result<_, _>>()?,
446 self.behind_reference.set(old);
449 ty::Array(elem_ty, _) |
450 // Cannot merge this with the catch all branch below, because the `const_deref`
451 // changes the type from slice to array, we need to keep the original type in the
453 ty::Slice(elem_ty) => {
454 let old = self.behind_reference.replace(true);
455 let array = tcx.deref_mir_constant(self.param_env.and(cv));
456 let val = PatKind::Deref {
458 kind: Box::new(PatKind::Slice {
460 .destructure_mir_constant(param_env, array)
463 .map(|val| self.recur(*val, false))
464 .collect::<Result<_, _>>()?,
469 ty: tcx.mk_slice(elem_ty),
472 self.behind_reference.set(old);
475 // Backwards compatibility hack: support references to non-structural types.
477 // this pattern to a `PartialEq::eq` comparison and `PartialEq::eq` takes a
478 // reference. This makes the rest of the matching logic simpler as it doesn't have
479 // to figure out how to get a reference again.
480 ty::Adt(adt_def, _) if !self.type_marked_structural(*pointee_ty) => {
481 if self.behind_reference.get() {
482 if self.include_lint_checks
483 && !self.saw_const_match_error.get()
484 && !self.saw_const_match_lint.get()
486 self.saw_const_match_lint.set(true);
487 let msg = self.adt_derive_msg(adt_def);
488 self.tcx().struct_span_lint_hir(
489 lint::builtin::INDIRECT_STRUCTURAL_MATCH,
492 |lint| {lint.build(&msg).emit();},
495 PatKind::Constant { value: cv }
497 if !self.saw_const_match_error.get() {
498 self.saw_const_match_error.set(true);
499 let msg = self.adt_derive_msg(adt_def);
500 if self.include_lint_checks {
501 tcx.sess.span_err(span, &msg);
503 tcx.sess.delay_span_bug(span, &msg);
509 // All other references are converted into deref patterns and then recursively
510 // convert the dereferenced constant to a pattern that is the sub-pattern of the
513 if !pointee_ty.is_sized(tcx.at(span), param_env) {
514 // `tcx.deref_mir_constant()` below will ICE with an unsized type
515 // (except slices, which are handled in a separate arm above).
516 let msg = format!("cannot use unsized non-slice type `{}` in constant patterns", pointee_ty);
517 if self.include_lint_checks {
518 tcx.sess.span_err(span, &msg);
520 tcx.sess.delay_span_bug(span, &msg);
524 let old = self.behind_reference.replace(true);
525 // In case there are structural-match violations somewhere in this subpattern,
526 // we fall back to a const pattern. If we do not do this, we may end up with
527 // a !structural-match constant that is not of reference type, which makes it
528 // very hard to invoke `PartialEq::eq` on it as a fallback.
529 let val = match self.recur(tcx.deref_mir_constant(self.param_env.and(cv)), false) {
530 Ok(subpattern) => PatKind::Deref { subpattern },
531 Err(_) => PatKind::Constant { value: cv },
533 self.behind_reference.set(old);
538 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::FnDef(..) => {
539 PatKind::Constant { value: cv }
541 ty::RawPtr(pointee) if pointee.ty.is_sized(tcx.at(span), param_env) => {
542 PatKind::Constant { value: cv }
544 // FIXME: these can have very surprising behaviour where optimization levels or other
545 // compilation choices change the runtime behaviour of the match.
546 // See https://github.com/rust-lang/rust/issues/70861 for examples.
547 ty::FnPtr(..) | ty::RawPtr(..) => {
548 if self.include_lint_checks
549 && !self.saw_const_match_error.get()
550 && !self.saw_const_match_lint.get()
552 self.saw_const_match_lint.set(true);
553 let msg = "function pointers and unsized pointers in patterns behave \
554 unpredictably and should not be relied upon. \
555 See https://github.com/rust-lang/rust/issues/70861 for details.";
556 tcx.struct_span_lint_hir(
557 lint::builtin::POINTER_STRUCTURAL_MATCH,
561 lint.build(msg).emit();
565 PatKind::Constant { value: cv }
568 self.saw_const_match_error.set(true);
569 let msg = format!("`{}` cannot be used in patterns", cv.ty());
570 if self.include_lint_checks {
571 tcx.sess.span_err(span, &msg);
573 tcx.sess.delay_span_bug(span, &msg);
579 if self.include_lint_checks
580 && !self.saw_const_match_error.get()
581 && !self.saw_const_match_lint.get()
582 && mir_structural_match_violation
583 // FIXME(#73448): Find a way to bring const qualification into parity with
584 // `search_for_structural_match_violation` and then remove this condition.
585 && self.search_for_structural_match_violation(cv.ty()).is_some()
587 self.saw_const_match_lint.set(true);
588 // Obtain the actual type that isn't annotated. If we just looked at `cv.ty` we
589 // could get `Option<NonStructEq>`, even though `Option` is annotated with derive.
590 let msg = self.search_for_structural_match_violation(cv.ty()).unwrap().replace(
592 "in a pattern, the constant's initializer must be trivial or",
594 tcx.struct_span_lint_hir(
595 lint::builtin::NONTRIVIAL_STRUCTURAL_MATCH,
599 lint.build(&msg).emit();
604 Ok(Pat { span, ty: cv.ty(), kind: Box::new(kind) })