3 // After candidates have been simplified, the only match pairs that
4 // remain are those that require some sort of test. The functions here
5 // identify what tests are needed, perform the tests, and then filter
6 // the candidates based on the result.
8 use crate::build::expr::as_place::PlaceBuilder;
9 use crate::build::matches::{Candidate, MatchPair, Test, TestKind};
10 use crate::build::Builder;
11 use crate::thir::pattern::compare_const_vals;
12 use rustc_data_structures::fx::FxIndexMap;
13 use rustc_hir::{LangItem, RangeEnd};
14 use rustc_index::bit_set::BitSet;
15 use rustc_middle::mir::*;
16 use rustc_middle::thir::*;
17 use rustc_middle::ty::util::IntTypeExt;
18 use rustc_middle::ty::GenericArg;
19 use rustc_middle::ty::{self, adjustment::PointerCast, Ty, TyCtxt};
20 use rustc_span::def_id::DefId;
21 use rustc_span::symbol::{sym, Symbol};
23 use rustc_target::abi::VariantIdx;
25 use std::cmp::Ordering;
27 impl<'a, 'tcx> Builder<'a, 'tcx> {
28 /// Identifies what test is needed to decide if `match_pair` is applicable.
30 /// It is a bug to call this with a not-fully-simplified pattern.
31 pub(super) fn test<'pat>(&mut self, match_pair: &MatchPair<'pat, 'tcx>) -> Test<'tcx> {
32 match match_pair.pattern.kind {
33 PatKind::Variant { adt_def, substs: _, variant_index: _, subpatterns: _ } => Test {
34 span: match_pair.pattern.span,
35 kind: TestKind::Switch {
37 variants: BitSet::new_empty(adt_def.variants().len()),
41 PatKind::Constant { .. } if is_switch_ty(match_pair.pattern.ty) => {
42 // For integers, we use a `SwitchInt` match, which allows
43 // us to handle more cases.
45 span: match_pair.pattern.span,
46 kind: TestKind::SwitchInt {
47 switch_ty: match_pair.pattern.ty,
49 // these maps are empty to start; cases are
50 // added below in add_cases_to_switch
51 options: Default::default(),
56 PatKind::Constant { value } => Test {
57 span: match_pair.pattern.span,
58 kind: TestKind::Eq { value, ty: match_pair.pattern.ty },
61 PatKind::Range(ref range) => {
62 assert_eq!(range.lo.ty(), match_pair.pattern.ty);
63 assert_eq!(range.hi.ty(), match_pair.pattern.ty);
64 Test { span: match_pair.pattern.span, kind: TestKind::Range(range.clone()) }
67 PatKind::Slice { ref prefix, ref slice, ref suffix } => {
68 let len = prefix.len() + suffix.len();
69 let op = if slice.is_some() { BinOp::Ge } else { BinOp::Eq };
70 Test { span: match_pair.pattern.span, kind: TestKind::Len { len: len as u64, op } }
73 PatKind::Or { .. } => bug!("or-patterns should have already been handled"),
75 PatKind::AscribeUserType { .. }
76 | PatKind::Array { .. }
78 | PatKind::Binding { .. }
79 | PatKind::Leaf { .. }
80 | PatKind::Deref { .. } => self.error_simplifyable(match_pair),
84 pub(super) fn add_cases_to_switch<'pat>(
86 test_place: &PlaceBuilder<'tcx>,
87 candidate: &Candidate<'pat, 'tcx>,
89 options: &mut FxIndexMap<ConstantKind<'tcx>, u128>,
91 let Some(match_pair) = candidate.match_pairs.iter().find(|mp| mp.place == *test_place) else {
95 match match_pair.pattern.kind {
96 PatKind::Constant { value } => {
99 .or_insert_with(|| value.eval_bits(self.tcx, self.param_env, switch_ty));
102 PatKind::Variant { .. } => {
103 panic!("you should have called add_variants_to_switch instead!");
105 PatKind::Range(ref range) => {
106 // Check that none of the switch values are in the range.
107 self.values_not_contained_in_range(&*range, options).unwrap_or(false)
109 PatKind::Slice { .. }
110 | PatKind::Array { .. }
113 | PatKind::Binding { .. }
114 | PatKind::AscribeUserType { .. }
115 | PatKind::Leaf { .. }
116 | PatKind::Deref { .. } => {
117 // don't know how to add these patterns to a switch
123 pub(super) fn add_variants_to_switch<'pat>(
125 test_place: &PlaceBuilder<'tcx>,
126 candidate: &Candidate<'pat, 'tcx>,
127 variants: &mut BitSet<VariantIdx>,
129 let Some(match_pair) = candidate.match_pairs.iter().find(|mp| mp.place == *test_place) else {
133 match match_pair.pattern.kind {
134 PatKind::Variant { adt_def: _, variant_index, .. } => {
135 // We have a pattern testing for variant `variant_index`
136 // set the corresponding index to true
137 variants.insert(variant_index);
141 // don't know how to add these patterns to a switch
147 #[instrument(skip(self, make_target_blocks, place_builder), level = "debug")]
148 pub(super) fn perform_test(
150 match_start_span: Span,
151 scrutinee_span: Span,
153 place_builder: PlaceBuilder<'tcx>,
155 make_target_blocks: impl FnOnce(&mut Self) -> Vec<BasicBlock>,
157 let place = place_builder.into_place(self);
158 let place_ty = place.ty(&self.local_decls, self.tcx);
159 debug!(?place, ?place_ty,);
161 let source_info = self.source_info(test.span);
163 TestKind::Switch { adt_def, ref variants } => {
164 let target_blocks = make_target_blocks(self);
165 // Variants is a BitVec of indexes into adt_def.variants.
166 let num_enum_variants = adt_def.variants().len();
167 debug_assert_eq!(target_blocks.len(), num_enum_variants + 1);
168 let otherwise_block = *target_blocks.last().unwrap();
170 let switch_targets = SwitchTargets::new(
171 adt_def.discriminants(tcx).filter_map(|(idx, discr)| {
172 if variants.contains(idx) {
174 target_blocks[idx.index()],
176 "no canididates for tested discriminant: {:?}",
179 Some((discr.val, target_blocks[idx.index()]))
182 target_blocks[idx.index()],
184 "found canididates for untested discriminant: {:?}",
192 debug!("num_enum_variants: {}, variants: {:?}", num_enum_variants, variants);
193 let discr_ty = adt_def.repr().discr_type().to_ty(tcx);
194 let discr = self.temp(discr_ty, test.span);
195 self.cfg.push_assign(
197 self.source_info(scrutinee_span),
199 Rvalue::Discriminant(place),
203 self.source_info(match_start_span),
204 TerminatorKind::SwitchInt {
205 discr: Operand::Move(discr),
207 targets: switch_targets,
212 TestKind::SwitchInt { switch_ty, ref options } => {
213 let target_blocks = make_target_blocks(self);
214 let terminator = if *switch_ty.kind() == ty::Bool {
215 assert!(!options.is_empty() && options.len() <= 2);
216 let [first_bb, second_bb] = *target_blocks else {
217 bug!("`TestKind::SwitchInt` on `bool` should have two targets")
219 let (true_bb, false_bb) = match options[0] {
220 1 => (first_bb, second_bb),
221 0 => (second_bb, first_bb),
222 v => span_bug!(test.span, "expected boolean value but got {:?}", v),
224 TerminatorKind::if_(self.tcx, Operand::Copy(place), true_bb, false_bb)
226 // The switch may be inexhaustive so we have a catch all block
227 debug_assert_eq!(options.len() + 1, target_blocks.len());
228 let otherwise_block = *target_blocks.last().unwrap();
229 let switch_targets = SwitchTargets::new(
230 options.values().copied().zip(target_blocks),
233 TerminatorKind::SwitchInt {
234 discr: Operand::Copy(place),
236 targets: switch_targets,
239 self.cfg.terminate(block, self.source_info(match_start_span), terminator);
242 TestKind::Eq { value, ty } => {
244 // Use `PartialEq::eq` instead of `BinOp::Eq`
245 // (the binop can only handle primitives)
246 self.non_scalar_compare(
254 } else if let [success, fail] = *make_target_blocks(self) {
255 assert_eq!(value.ty(), ty);
256 let expect = self.literal_operand(test.span, value);
257 let val = Operand::Copy(place);
258 self.compare(block, success, fail, source_info, BinOp::Eq, expect, val);
260 bug!("`TestKind::Eq` should have two target blocks");
264 TestKind::Range(box PatRange { lo, hi, ref end }) => {
265 let lower_bound_success = self.cfg.start_new_block();
266 let target_blocks = make_target_blocks(self);
268 // Test `val` by computing `lo <= val && val <= hi`, using primitive comparisons.
269 let lo = self.literal_operand(test.span, lo);
270 let hi = self.literal_operand(test.span, hi);
271 let val = Operand::Copy(place);
273 let [success, fail] = *target_blocks else {
274 bug!("`TestKind::Range` should have two target blocks");
285 let op = match *end {
286 RangeEnd::Included => BinOp::Le,
287 RangeEnd::Excluded => BinOp::Lt,
289 self.compare(lower_bound_success, success, fail, source_info, op, val, hi);
292 TestKind::Len { len, op } => {
293 let target_blocks = make_target_blocks(self);
295 let usize_ty = self.tcx.types.usize;
296 let actual = self.temp(usize_ty, test.span);
298 // actual = len(place)
299 self.cfg.push_assign(block, source_info, actual, Rvalue::Len(place));
302 let expected = self.push_usize(block, source_info, len);
304 let [true_bb, false_bb] = *target_blocks else {
305 bug!("`TestKind::Len` should have two target blocks");
307 // result = actual == expected OR result = actual < expected
308 // branch based on result
315 Operand::Move(actual),
316 Operand::Move(expected),
322 /// Compare using the provided built-in comparison operator
326 success_block: BasicBlock,
327 fail_block: BasicBlock,
328 source_info: SourceInfo,
331 right: Operand<'tcx>,
333 let bool_ty = self.tcx.types.bool;
334 let result = self.temp(bool_ty, source_info.span);
336 // result = op(left, right)
337 self.cfg.push_assign(
341 Rvalue::BinaryOp(op, Box::new((left, right))),
344 // branch based on result
348 TerminatorKind::if_(self.tcx, Operand::Move(result), success_block, fail_block),
352 /// Compare two `&T` values using `<T as std::compare::PartialEq>::eq`
353 fn non_scalar_compare(
356 make_target_blocks: impl FnOnce(&mut Self) -> Vec<BasicBlock>,
357 source_info: SourceInfo,
358 value: ConstantKind<'tcx>,
362 let mut expect = self.literal_operand(source_info.span, value);
363 let mut val = Operand::Copy(place);
365 // If we're using `b"..."` as a pattern, we need to insert an
366 // unsizing coercion, as the byte string has the type `&[u8; N]`.
368 // We want to do this even when the scrutinee is a reference to an
369 // array, so we can call `<[u8]>::eq` rather than having to find an
371 let unsize = |ty: Ty<'tcx>| match ty.kind() {
372 ty::Ref(region, rty, _) => match rty.kind() {
373 ty::Array(inner_ty, n) => Some((region, inner_ty, n)),
378 let opt_ref_ty = unsize(ty);
379 let opt_ref_test_ty = unsize(value.ty());
380 match (opt_ref_ty, opt_ref_test_ty) {
381 // nothing to do, neither is an array
383 (Some((region, elem_ty, _)), _) | (None, Some((region, elem_ty, _))) => {
386 ty = tcx.mk_imm_ref(*region, tcx.mk_slice(*elem_ty));
387 if opt_ref_ty.is_some() {
388 let temp = self.temp(ty, source_info.span);
389 self.cfg.push_assign(
393 Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), val, ty),
395 val = Operand::Move(temp);
397 if opt_ref_test_ty.is_some() {
398 let slice = self.temp(ty, source_info.span);
399 self.cfg.push_assign(
403 Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), expect, ty),
405 expect = Operand::Move(slice);
410 let ty::Ref(_, deref_ty, _) = *ty.kind() else {
411 bug!("non_scalar_compare called on non-reference type: {}", ty);
414 let eq_def_id = self.tcx.require_lang_item(LangItem::PartialEq, None);
415 let method = trait_method(self.tcx, eq_def_id, sym::eq, deref_ty, &[deref_ty.into()]);
417 let bool_ty = self.tcx.types.bool;
418 let eq_result = self.temp(bool_ty, source_info.span);
419 let eq_block = self.cfg.start_new_block();
423 TerminatorKind::Call {
424 func: Operand::Constant(Box::new(Constant {
425 span: source_info.span,
427 // FIXME(#54571): This constant comes from user input (a
428 // constant in a pattern). Are there forms where users can add
429 // type annotations here? For example, an associated constant?
430 // Need to experiment.
435 args: vec![val, expect],
436 destination: eq_result,
437 target: Some(eq_block),
439 from_hir_call: false,
440 fn_span: source_info.span,
443 self.diverge_from(block);
445 let [success_block, fail_block] = *make_target_blocks(self) else {
446 bug!("`TestKind::Eq` should have two target blocks")
452 TerminatorKind::if_(self.tcx, Operand::Move(eq_result), success_block, fail_block),
456 /// Given that we are performing `test` against `test_place`, this job
457 /// sorts out what the status of `candidate` will be after the test. See
458 /// `test_candidates` for the usage of this function. The returned index is
459 /// the index that this candidate should be placed in the
460 /// `target_candidates` vec. The candidate may be modified to update its
463 /// So, for example, if this candidate is `x @ Some(P0)` and the `Test` is
464 /// a variant test, then we would modify the candidate to be `(x as
465 /// Option).0 @ P0` and return the index corresponding to the variant
468 /// However, in some cases, the test may just not be relevant to candidate.
469 /// For example, suppose we are testing whether `foo.x == 22`, but in one
470 /// match arm we have `Foo { x: _, ... }`... in that case, the test for
471 /// what value `x` has has no particular relevance to this candidate. In
472 /// such cases, this function just returns None without doing anything.
473 /// This is used by the overall `match_candidates` algorithm to structure
474 /// the match as a whole. See `match_candidates` for more details.
476 /// FIXME(#29623). In some cases, we have some tricky choices to make. for
477 /// example, if we are testing that `x == 22`, but the candidate is `x @
478 /// 13..55`, what should we do? In the event that the test is true, we know
479 /// that the candidate applies, but in the event of false, we don't know
480 /// that it *doesn't* apply. For now, we return false, indicate that the
481 /// test does not apply to this candidate, but it might be we can get
482 /// tighter match code if we do something a bit different.
483 pub(super) fn sort_candidate<'pat>(
485 test_place: &PlaceBuilder<'tcx>,
487 candidate: &mut Candidate<'pat, 'tcx>,
489 // Find the match_pair for this place (if any). At present,
490 // afaik, there can be at most one. (In the future, if we
491 // adopted a more general `@` operator, there might be more
492 // than one, but it'd be very unusual to have two sides that
493 // both require tests; you'd expect one side to be simplified
495 let (match_pair_index, match_pair) =
496 candidate.match_pairs.iter().enumerate().find(|&(_, mp)| mp.place == *test_place)?;
498 match (&test.kind, &match_pair.pattern.kind) {
499 // If we are performing a variant switch, then this
500 // informs variant patterns, but nothing else.
502 &TestKind::Switch { adt_def: tested_adt_def, .. },
503 &PatKind::Variant { adt_def, variant_index, ref subpatterns, .. },
505 assert_eq!(adt_def, tested_adt_def);
506 self.candidate_after_variant_switch(
513 Some(variant_index.as_usize())
516 (&TestKind::Switch { .. }, _) => None,
518 // If we are performing a switch over integers, then this informs integer
519 // equality, but nothing else.
521 // FIXME(#29623) we could use PatKind::Range to rule
522 // things out here, in some cases.
524 &TestKind::SwitchInt { switch_ty: _, ref options },
525 &PatKind::Constant { ref value },
526 ) if is_switch_ty(match_pair.pattern.ty) => {
527 let index = options.get_index_of(value).unwrap();
528 self.candidate_without_match_pair(match_pair_index, candidate);
532 (&TestKind::SwitchInt { switch_ty: _, ref options }, &PatKind::Range(ref range)) => {
534 self.values_not_contained_in_range(&*range, options).unwrap_or(false);
537 // No switch values are contained in the pattern range,
538 // so the pattern can be matched only if this test fails.
539 let otherwise = options.len();
546 (&TestKind::SwitchInt { .. }, _) => None,
549 &TestKind::Len { len: test_len, op: BinOp::Eq },
550 &PatKind::Slice { ref prefix, ref slice, ref suffix },
552 let pat_len = (prefix.len() + suffix.len()) as u64;
553 match (test_len.cmp(&pat_len), slice) {
554 (Ordering::Equal, &None) => {
555 // on true, min_len = len = $actual_length,
556 // on false, len != $actual_length
557 self.candidate_after_slice_test(
566 (Ordering::Less, _) => {
567 // test_len < pat_len. If $actual_len = test_len,
568 // then $actual_len < pat_len and we don't have
572 (Ordering::Equal | Ordering::Greater, &Some(_)) => {
573 // This can match both if $actual_len = test_len >= pat_len,
574 // and if $actual_len > test_len. We can't advance.
577 (Ordering::Greater, &None) => {
578 // test_len != pat_len, so if $actual_len = test_len, then
579 // $actual_len != pat_len.
586 &TestKind::Len { len: test_len, op: BinOp::Ge },
587 &PatKind::Slice { ref prefix, ref slice, ref suffix },
589 // the test is `$actual_len >= test_len`
590 let pat_len = (prefix.len() + suffix.len()) as u64;
591 match (test_len.cmp(&pat_len), slice) {
592 (Ordering::Equal, &Some(_)) => {
593 // $actual_len >= test_len = pat_len,
595 self.candidate_after_slice_test(
604 (Ordering::Less, _) | (Ordering::Equal, &None) => {
605 // test_len <= pat_len. If $actual_len < test_len,
606 // then it is also < pat_len, so the test passing is
607 // necessary (but insufficient).
610 (Ordering::Greater, &None) => {
611 // test_len > pat_len. If $actual_len >= test_len > pat_len,
612 // then we know we won't have a match.
615 (Ordering::Greater, &Some(_)) => {
616 // test_len < pat_len, and is therefore less
617 // strict. This can still go both ways.
623 (&TestKind::Range(ref test), &PatKind::Range(ref pat)) => {
624 use std::cmp::Ordering::*;
627 self.candidate_without_match_pair(match_pair_index, candidate);
631 // For performance, it's important to only do the second
632 // `compare_const_vals` if necessary.
633 let no_overlap = if matches!(
634 (compare_const_vals(self.tcx, test.hi, pat.lo, self.param_env)?, test.end),
635 (Less, _) | (Equal, RangeEnd::Excluded) // test < pat
637 (compare_const_vals(self.tcx, test.lo, pat.hi, self.param_env)?, pat.end),
638 (Greater, _) | (Equal, RangeEnd::Excluded) // test > pat
645 // If the testing range does not overlap with pattern range,
646 // the pattern can be matched only if this test fails.
650 (&TestKind::Range(ref range), &PatKind::Constant { value }) => {
651 if let Some(false) = self.const_range_contains(&*range, value) {
652 // `value` is not contained in the testing range,
653 // so `value` can be matched only if this test fails.
660 (&TestKind::Range { .. }, _) => None,
662 (&TestKind::Eq { .. } | &TestKind::Len { .. }, _) => {
663 // The call to `self.test(&match_pair)` below is not actually used to generate any
664 // MIR. Instead, we just want to compare with `test` (the parameter of the method)
665 // to see if it is the same.
667 // However, at this point we can still encounter or-patterns that were extracted
668 // from previous calls to `sort_candidate`, so we need to manually address that
669 // case to avoid panicking in `self.test()`.
670 if let PatKind::Or { .. } = &match_pair.pattern.kind {
674 // These are all binary tests.
676 // FIXME(#29623) we can be more clever here
677 let pattern_test = self.test(&match_pair);
678 if pattern_test.kind == test.kind {
679 self.candidate_without_match_pair(match_pair_index, candidate);
688 fn candidate_without_match_pair(
690 match_pair_index: usize,
691 candidate: &mut Candidate<'_, 'tcx>,
693 candidate.match_pairs.remove(match_pair_index);
696 fn candidate_after_slice_test<'pat>(
698 match_pair_index: usize,
699 candidate: &mut Candidate<'pat, 'tcx>,
700 prefix: &'pat [Box<Pat<'tcx>>],
701 opt_slice: &'pat Option<Box<Pat<'tcx>>>,
702 suffix: &'pat [Box<Pat<'tcx>>],
704 let removed_place = candidate.match_pairs.remove(match_pair_index).place;
705 self.prefix_slice_suffix(
706 &mut candidate.match_pairs,
714 fn candidate_after_variant_switch<'pat>(
716 match_pair_index: usize,
717 adt_def: ty::AdtDef<'tcx>,
718 variant_index: VariantIdx,
719 subpatterns: &'pat [FieldPat<'tcx>],
720 candidate: &mut Candidate<'pat, 'tcx>,
722 let match_pair = candidate.match_pairs.remove(match_pair_index);
724 // So, if we have a match-pattern like `x @ Enum::Variant(P1, P2)`,
725 // we want to create a set of derived match-patterns like
726 // `(x as Variant).0 @ P1` and `(x as Variant).1 @ P1`.
727 let downcast_place = match_pair.place.downcast(adt_def, variant_index); // `(x as Variant)`
728 let consequent_match_pairs = subpatterns.iter().map(|subpattern| {
729 // e.g., `(x as Variant).0`
730 let place = downcast_place.clone().field(subpattern.field, subpattern.pattern.ty);
731 // e.g., `(x as Variant).0 @ P1`
732 MatchPair::new(place, &subpattern.pattern, self)
735 candidate.match_pairs.extend(consequent_match_pairs);
738 fn error_simplifyable<'pat>(&mut self, match_pair: &MatchPair<'pat, 'tcx>) -> ! {
739 span_bug!(match_pair.pattern.span, "simplifyable pattern found: {:?}", match_pair.pattern)
742 fn const_range_contains(
744 range: &PatRange<'tcx>,
745 value: ConstantKind<'tcx>,
747 use std::cmp::Ordering::*;
749 // For performance, it's important to only do the second
750 // `compare_const_vals` if necessary.
752 matches!(compare_const_vals(self.tcx, range.lo, value, self.param_env)?, Less | Equal)
754 (compare_const_vals(self.tcx, value, range.hi, self.param_env)?, range.end),
755 (Less, _) | (Equal, RangeEnd::Included)
760 fn values_not_contained_in_range(
762 range: &PatRange<'tcx>,
763 options: &FxIndexMap<ConstantKind<'tcx>, u128>,
765 for &val in options.keys() {
766 if self.const_range_contains(range, val)? {
776 pub(super) fn targets(&self) -> usize {
778 TestKind::Eq { .. } | TestKind::Range(_) | TestKind::Len { .. } => 2,
779 TestKind::Switch { adt_def, .. } => {
780 // While the switch that we generate doesn't test for all
781 // variants, we have a target for each variant and the
782 // otherwise case, and we make sure that all of the cases not
783 // specified have the same block.
784 adt_def.variants().len() + 1
786 TestKind::SwitchInt { switch_ty, ref options, .. } => {
787 if switch_ty.is_bool() {
788 // `bool` is special cased in `perform_test` to always
789 // branch to two blocks.
799 fn is_switch_ty(ty: Ty<'_>) -> bool {
800 ty.is_integral() || ty.is_char() || ty.is_bool()
803 fn trait_method<'tcx>(
808 params: &[GenericArg<'tcx>],
809 ) -> ConstantKind<'tcx> {
810 let substs = tcx.mk_substs_trait(self_ty, params);
812 // The unhygienic comparison here is acceptable because this is only
813 // used on known traits.
815 .associated_items(trait_def_id)
816 .filter_by_name_unhygienic(method_name)
817 .find(|item| item.kind == ty::AssocKind::Fn)
818 .expect("trait method not found");
820 let method_ty = tcx.bound_type_of(item.def_id);
821 let method_ty = method_ty.subst(tcx, substs);
823 ConstantKind::zero_sized(method_ty)