compiler/rustc_mir_build/src/build/matches/test.rs

   1 // Testing candidates
   2 //
   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.
   7
   8 use crate::build::matches::{Candidate, MatchPair, Test, TestKind};
   9 use crate::build::Builder;
  10 use crate::thir::pattern::compare_const_vals;
  11 use crate::thir::*;
  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::ty::util::IntTypeExt;
  17 use rustc_middle::ty::{self, adjustment::PointerCast, Ty};
  18 use rustc_span::symbol::sym;
  19 use rustc_target::abi::VariantIdx;
  20
  21 use std::cmp::Ordering;
  22
  23 impl<'a, 'tcx> Builder<'a, 'tcx> {
  24     /// Identifies what test is needed to decide if `match_pair` is applicable.
  25     ///
  26     /// It is a bug to call this with a simplifiable pattern.
  27     pub(super) fn test<'pat>(&mut self, match_pair: &MatchPair<'pat, 'tcx>) -> Test<'tcx> {
  28         match *match_pair.pattern.kind {
  29             PatKind::Variant { ref adt_def, substs: _, variant_index: _, subpatterns: _ } => Test {
  30                 span: match_pair.pattern.span,
  31                 kind: TestKind::Switch {
  32                     adt_def,
  33                     variants: BitSet::new_empty(adt_def.variants.len()),
  34                 },
  35             },
  36
  37             PatKind::Constant { .. } if is_switch_ty(match_pair.pattern.ty) => {
  38                 // For integers, we use a `SwitchInt` match, which allows
  39                 // us to handle more cases.
  40                 Test {
  41                     span: match_pair.pattern.span,
  42                     kind: TestKind::SwitchInt {
  43                         switch_ty: match_pair.pattern.ty,
  44
  45                         // these maps are empty to start; cases are
  46                         // added below in add_cases_to_switch
  47                         options: Default::default(),
  48                     },
  49                 }
  50             }
  51
  52             PatKind::Constant { value } => Test {
  53                 span: match_pair.pattern.span,
  54                 kind: TestKind::Eq { value, ty: match_pair.pattern.ty.clone() },
  55             },
  56
  57             PatKind::Range(range) => {
  58                 assert_eq!(range.lo.ty, match_pair.pattern.ty);
  59                 assert_eq!(range.hi.ty, match_pair.pattern.ty);
  60                 Test { span: match_pair.pattern.span, kind: TestKind::Range(range) }
  61             }
  62
  63             PatKind::Slice { ref prefix, ref slice, ref suffix } => {
  64                 let len = prefix.len() + suffix.len();
  65                 let op = if slice.is_some() { BinOp::Ge } else { BinOp::Eq };
  66                 Test { span: match_pair.pattern.span, kind: TestKind::Len { len: len as u64, op } }
  67             }
  68
  69             PatKind::Or { .. } => bug!("or-patterns should have already been handled"),
  70
  71             PatKind::AscribeUserType { .. }
  72             | PatKind::Array { .. }
  73             | PatKind::Wild
  74             | PatKind::Binding { .. }
  75             | PatKind::Leaf { .. }
  76             | PatKind::Deref { .. } => self.error_simplifyable(match_pair),
  77         }
  78     }
  79
  80     pub(super) fn add_cases_to_switch<'pat>(
  81         &mut self,
  82         test_place: &Place<'tcx>,
  83         candidate: &Candidate<'pat, 'tcx>,
  84         switch_ty: Ty<'tcx>,
  85         options: &mut FxIndexMap<&'tcx ty::Const<'tcx>, u128>,
  86     ) -> bool {
  87         let match_pair = match candidate.match_pairs.iter().find(|mp| mp.place == *test_place) {
  88             Some(match_pair) => match_pair,
  89             _ => {
  90                 return false;
  91             }
  92         };
  93
  94         match *match_pair.pattern.kind {
  95             PatKind::Constant { value } => {
  96                 options.entry(value).or_insert_with(|| {
  97                     value.eval_bits(self.hir.tcx(), self.hir.param_env, switch_ty)
  98                 });
  99                 true
 100             }
 101             PatKind::Variant { .. } => {
 102                 panic!("you should have called add_variants_to_switch instead!");
 103             }
 104             PatKind::Range(range) => {
 105                 // Check that none of the switch values are in the range.
 106                 self.values_not_contained_in_range(range, options).unwrap_or(false)
 107             }
 108             PatKind::Slice { .. }
 109             | PatKind::Array { .. }
 110             | PatKind::Wild
 111             | PatKind::Or { .. }
 112             | PatKind::Binding { .. }
 113             | PatKind::AscribeUserType { .. }
 114             | PatKind::Leaf { .. }
 115             | PatKind::Deref { .. } => {
 116                 // don't know how to add these patterns to a switch
 117                 false
 118             }
 119         }
 120     }
 121
 122     pub(super) fn add_variants_to_switch<'pat>(
 123         &mut self,
 124         test_place: &Place<'tcx>,
 125         candidate: &Candidate<'pat, 'tcx>,
 126         variants: &mut BitSet<VariantIdx>,
 127     ) -> bool {
 128         let match_pair = match candidate.match_pairs.iter().find(|mp| mp.place == *test_place) {
 129             Some(match_pair) => match_pair,
 130             _ => {
 131                 return false;
 132             }
 133         };
 134
 135         match *match_pair.pattern.kind {
 136             PatKind::Variant { adt_def: _, variant_index, .. } => {
 137                 // We have a pattern testing for variant `variant_index`
 138                 // set the corresponding index to true
 139                 variants.insert(variant_index);
 140                 true
 141             }
 142             _ => {
 143                 // don't know how to add these patterns to a switch
 144                 false
 145             }
 146         }
 147     }
 148
 149     pub(super) fn perform_test(
 150         &mut self,
 151         block: BasicBlock,
 152         place: Place<'tcx>,
 153         test: &Test<'tcx>,
 154         make_target_blocks: impl FnOnce(&mut Self) -> Vec<BasicBlock>,
 155     ) {
 156         debug!(
 157             "perform_test({:?}, {:?}: {:?}, {:?})",
 158             block,
 159             place,
 160             place.ty(&self.local_decls, self.hir.tcx()),
 161             test
 162         );
 163
 164         let source_info = self.source_info(test.span);
 165         match test.kind {
 166             TestKind::Switch { adt_def, ref variants } => {
 167                 let target_blocks = make_target_blocks(self);
 168                 // Variants is a BitVec of indexes into adt_def.variants.
 169                 let num_enum_variants = adt_def.variants.len();
 170                 debug_assert_eq!(target_blocks.len(), num_enum_variants + 1);
 171                 let otherwise_block = *target_blocks.last().unwrap();
 172                 let tcx = self.hir.tcx();
 173                 let switch_targets = SwitchTargets::new(
 174                     adt_def.discriminants(tcx).filter_map(|(idx, discr)| {
 175                         if variants.contains(idx) {
 176                             debug_assert_ne!(
 177                                 target_blocks[idx.index()],
 178                                 otherwise_block,
 179                                 "no canididates for tested discriminant: {:?}",
 180                                 discr,
 181                             );
 182                             Some((discr.val, target_blocks[idx.index()]))
 183                         } else {
 184                             debug_assert_eq!(
 185                                 target_blocks[idx.index()],
 186                                 otherwise_block,
 187                                 "found canididates for untested discriminant: {:?}",
 188                                 discr,
 189                             );
 190                             None
 191                         }
 192                     }),
 193                     otherwise_block,
 194                 );
 195                 debug!("num_enum_variants: {}, variants: {:?}", num_enum_variants, variants);
 196                 let discr_ty = adt_def.repr.discr_type().to_ty(tcx);
 197                 let discr = self.temp(discr_ty, test.span);
 198                 self.cfg.push_assign(block, source_info, discr, Rvalue::Discriminant(place));
 199                 self.cfg.terminate(
 200                     block,
 201                     source_info,
 202                     TerminatorKind::SwitchInt {
 203                         discr: Operand::Move(discr),
 204                         switch_ty: discr_ty,
 205                         targets: switch_targets,
 206                     },
 207                 );
 208             }
 209
 210             TestKind::SwitchInt { switch_ty, ref options } => {
 211                 let target_blocks = make_target_blocks(self);
 212                 let terminator = if *switch_ty.kind() == ty::Bool {
 213                     assert!(!options.is_empty() && options.len() <= 2);
 214                     if let [first_bb, second_bb] = *target_blocks {
 215                         let (true_bb, false_bb) = match options[0] {
 216                             1 => (first_bb, second_bb),
 217                             0 => (second_bb, first_bb),
 218                             v => span_bug!(test.span, "expected boolean value but got {:?}", v),
 219                         };
 220                         TerminatorKind::if_(self.hir.tcx(), Operand::Copy(place), true_bb, false_bb)
 221                     } else {
 222                         bug!("`TestKind::SwitchInt` on `bool` should have two targets")
 223                     }
 224                 } else {
 225                     // The switch may be inexhaustive so we have a catch all block
 226                     debug_assert_eq!(options.len() + 1, target_blocks.len());
 227                     let otherwise_block = *target_blocks.last().unwrap();
 228                     let switch_targets = SwitchTargets::new(
 229                         options.values().copied().zip(target_blocks),
 230                         otherwise_block,
 231                     );
 232                     TerminatorKind::SwitchInt {
 233                         discr: Operand::Copy(place),
 234                         switch_ty,
 235                         targets: switch_targets,
 236                     }
 237                 };
 238                 self.cfg.terminate(block, source_info, terminator);
 239             }
 240
 241             TestKind::Eq { value, ty } => {
 242                 if !ty.is_scalar() {
 243                     // Use `PartialEq::eq` instead of `BinOp::Eq`
 244                     // (the binop can only handle primitives)
 245                     self.non_scalar_compare(
 246                         block,
 247                         make_target_blocks,
 248                         source_info,
 249                         value,
 250                         place,
 251                         ty,
 252                     );
 253                 } else {
 254                     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);
 259                     } else {
 260                         bug!("`TestKind::Eq` should have two target blocks");
 261                     }
 262                 }
 263             }
 264
 265             TestKind::Range(PatRange { ref lo, ref hi, ref end }) => {
 266                 let lower_bound_success = self.cfg.start_new_block();
 267                 let target_blocks = make_target_blocks(self);
 268
 269                 // Test `val` by computing `lo <= val && val <= hi`, using primitive comparisons.
 270                 let lo = self.literal_operand(test.span, lo);
 271                 let hi = self.literal_operand(test.span, hi);
 272                 let val = Operand::Copy(place);
 273
 274                 if let [success, fail] = *target_blocks {
 275                     self.compare(
 276                         block,
 277                         lower_bound_success,
 278                         fail,
 279                         source_info,
 280                         BinOp::Le,
 281                         lo,
 282                         val.clone(),
 283                     );
 284                     let op = match *end {
 285                         RangeEnd::Included => BinOp::Le,
 286                         RangeEnd::Excluded => BinOp::Lt,
 287                     };
 288                     self.compare(lower_bound_success, success, fail, source_info, op, val, hi);
 289                 } else {
 290                     bug!("`TestKind::Range` should have two target blocks");
 291                 }
 292             }
 293
 294             TestKind::Len { len, op } => {
 295                 let target_blocks = make_target_blocks(self);
 296
 297                 let usize_ty = self.hir.usize_ty();
 298                 let actual = self.temp(usize_ty, test.span);
 299
 300                 // actual = len(place)
 301                 self.cfg.push_assign(block, source_info, actual, Rvalue::Len(place));
 302
 303                 // expected = <N>
 304                 let expected = self.push_usize(block, source_info, len);
 305
 306                 if let [true_bb, false_bb] = *target_blocks {
 307                     // result = actual == expected OR result = actual < expected
 308                     // branch based on result
 309                     self.compare(
 310                         block,
 311                         true_bb,
 312                         false_bb,
 313                         source_info,
 314                         op,
 315                         Operand::Move(actual),
 316                         Operand::Move(expected),
 317                     );
 318                 } else {
 319                     bug!("`TestKind::Len` should have two target blocks");
 320                 }
 321             }
 322         }
 323     }
 324
 325     /// Compare using the provided built-in comparison operator
 326     fn compare(
 327         &mut self,
 328         block: BasicBlock,
 329         success_block: BasicBlock,
 330         fail_block: BasicBlock,
 331         source_info: SourceInfo,
 332         op: BinOp,
 333         left: Operand<'tcx>,
 334         right: Operand<'tcx>,
 335     ) {
 336         let bool_ty = self.hir.bool_ty();
 337         let result = self.temp(bool_ty, source_info.span);
 338
 339         // result = op(left, right)
 340         self.cfg.push_assign(block, source_info, result, Rvalue::BinaryOp(op, left, right));
 341
 342         // branch based on result
 343         self.cfg.terminate(
 344             block,
 345             source_info,
 346             TerminatorKind::if_(self.hir.tcx(), Operand::Move(result), success_block, fail_block),
 347         );
 348     }
 349
 350     /// Compare two `&T` values using `<T as std::compare::PartialEq>::eq`
 351     fn non_scalar_compare(
 352         &mut self,
 353         block: BasicBlock,
 354         make_target_blocks: impl FnOnce(&mut Self) -> Vec<BasicBlock>,
 355         source_info: SourceInfo,
 356         value: &'tcx ty::Const<'tcx>,
 357         place: Place<'tcx>,
 358         mut ty: Ty<'tcx>,
 359     ) {
 360         let mut expect = self.literal_operand(source_info.span, value);
 361         let mut val = Operand::Copy(place);
 362
 363         // If we're using `b"..."` as a pattern, we need to insert an
 364         // unsizing coercion, as the byte string has the type `&[u8; N]`.
 365         //
 366         // We want to do this even when the scrutinee is a reference to an
 367         // array, so we can call `<[u8]>::eq` rather than having to find an
 368         // `<[u8; N]>::eq`.
 369         let unsize = |ty: Ty<'tcx>| match ty.kind() {
 370             ty::Ref(region, rty, _) => match rty.kind() {
 371                 ty::Array(inner_ty, n) => Some((region, inner_ty, n)),
 372                 _ => None,
 373             },
 374             _ => None,
 375         };
 376         let opt_ref_ty = unsize(ty);
 377         let opt_ref_test_ty = unsize(value.ty);
 378         match (opt_ref_ty, opt_ref_test_ty) {
 379             // nothing to do, neither is an array
 380             (None, None) => {}
 381             (Some((region, elem_ty, _)), _) | (None, Some((region, elem_ty, _))) => {
 382                 let tcx = self.hir.tcx();
 383                 // make both a slice
 384                 ty = tcx.mk_imm_ref(region, tcx.mk_slice(elem_ty));
 385                 if opt_ref_ty.is_some() {
 386                     let temp = self.temp(ty, source_info.span);
 387                     self.cfg.push_assign(
 388                         block,
 389                         source_info,
 390                         temp,
 391                         Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), val, ty),
 392                     );
 393                     val = Operand::Move(temp);
 394                 }
 395                 if opt_ref_test_ty.is_some() {
 396                     let slice = self.temp(ty, source_info.span);
 397                     self.cfg.push_assign(
 398                         block,
 399                         source_info,
 400                         slice,
 401                         Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), expect, ty),
 402                     );
 403                     expect = Operand::Move(slice);
 404                 }
 405             }
 406         }
 407
 408         let deref_ty = match *ty.kind() {
 409             ty::Ref(_, deref_ty, _) => deref_ty,
 410             _ => bug!("non_scalar_compare called on non-reference type: {}", ty),
 411         };
 412
 413         let eq_def_id = self.hir.tcx().require_lang_item(LangItem::PartialEq, None);
 414         let method = self.hir.trait_method(eq_def_id, sym::eq, deref_ty, &[deref_ty.into()]);
 415
 416         let bool_ty = self.hir.bool_ty();
 417         let eq_result = self.temp(bool_ty, source_info.span);
 418         let eq_block = self.cfg.start_new_block();
 419         self.cfg.terminate(
 420             block,
 421             source_info,
 422             TerminatorKind::Call {
 423                 func: Operand::Constant(box Constant {
 424                     span: source_info.span,
 425
 426                     // FIXME(#54571): This constant comes from user input (a
 427                     // constant in a pattern).  Are there forms where users can add
 428                     // type annotations here?  For example, an associated constant?
 429                     // Need to experiment.
 430                     user_ty: None,
 431
 432                     literal: method,
 433                 }),
 434                 args: vec![val, expect],
 435                 destination: Some((eq_result, eq_block)),
 436                 cleanup: None,
 437                 from_hir_call: false,
 438                 fn_span: source_info.span,
 439             },
 440         );
 441         self.diverge_from(block);
 442
 443         if let [success_block, fail_block] = *make_target_blocks(self) {
 444             // check the result
 445             self.cfg.terminate(
 446                 eq_block,
 447                 source_info,
 448                 TerminatorKind::if_(
 449                     self.hir.tcx(),
 450                     Operand::Move(eq_result),
 451                     success_block,
 452                     fail_block,
 453                 ),
 454             );
 455         } else {
 456             bug!("`TestKind::Eq` should have two target blocks")
 457         }
 458     }
 459
 460     /// Given that we are performing `test` against `test_place`, this job
 461     /// sorts out what the status of `candidate` will be after the test. See
 462     /// `test_candidates` for the usage of this function. The returned index is
 463     /// the index that this candidate should be placed in the
 464     /// `target_candidates` vec. The candidate may be modified to update its
 465     /// `match_pairs`.
 466     ///
 467     /// So, for example, if this candidate is `x @ Some(P0)` and the `Test` is
 468     /// a variant test, then we would modify the candidate to be `(x as
 469     /// Option).0 @ P0` and return the index corresponding to the variant
 470     /// `Some`.
 471     ///
 472     /// However, in some cases, the test may just not be relevant to candidate.
 473     /// For example, suppose we are testing whether `foo.x == 22`, but in one
 474     /// match arm we have `Foo { x: _, ... }`... in that case, the test for
 475     /// what value `x` has has no particular relevance to this candidate. In
 476     /// such cases, this function just returns None without doing anything.
 477     /// This is used by the overall `match_candidates` algorithm to structure
 478     /// the match as a whole. See `match_candidates` for more details.
 479     ///
 480     /// FIXME(#29623). In some cases, we have some tricky choices to make.  for
 481     /// example, if we are testing that `x == 22`, but the candidate is `x @
 482     /// 13..55`, what should we do? In the event that the test is true, we know
 483     /// that the candidate applies, but in the event of false, we don't know
 484     /// that it *doesn't* apply. For now, we return false, indicate that the
 485     /// test does not apply to this candidate, but it might be we can get
 486     /// tighter match code if we do something a bit different.
 487     pub(super) fn sort_candidate<'pat>(
 488         &mut self,
 489         test_place: &Place<'tcx>,
 490         test: &Test<'tcx>,
 491         candidate: &mut Candidate<'pat, 'tcx>,
 492     ) -> Option<usize> {
 493         // Find the match_pair for this place (if any). At present,
 494         // afaik, there can be at most one. (In the future, if we
 495         // adopted a more general `@` operator, there might be more
 496         // than one, but it'd be very unusual to have two sides that
 497         // both require tests; you'd expect one side to be simplified
 498         // away.)
 499         let (match_pair_index, match_pair) =
 500             candidate.match_pairs.iter().enumerate().find(|&(_, mp)| mp.place == *test_place)?;
 501
 502         match (&test.kind, &*match_pair.pattern.kind) {
 503             // If we are performing a variant switch, then this
 504             // informs variant patterns, but nothing else.
 505             (
 506                 &TestKind::Switch { adt_def: tested_adt_def, .. },
 507                 &PatKind::Variant { adt_def, variant_index, ref subpatterns, .. },
 508             ) => {
 509                 assert_eq!(adt_def, tested_adt_def);
 510                 self.candidate_after_variant_switch(
 511                     match_pair_index,
 512                     adt_def,
 513                     variant_index,
 514                     subpatterns,
 515                     candidate,
 516                 );
 517                 Some(variant_index.as_usize())
 518             }
 519
 520             (&TestKind::Switch { .. }, _) => None,
 521
 522             // If we are performing a switch over integers, then this informs integer
 523             // equality, but nothing else.
 524             //
 525             // FIXME(#29623) we could use PatKind::Range to rule
 526             // things out here, in some cases.
 527             (
 528                 &TestKind::SwitchInt { switch_ty: _, ref options },
 529                 &PatKind::Constant { ref value },
 530             ) if is_switch_ty(match_pair.pattern.ty) => {
 531                 let index = options.get_index_of(value).unwrap();
 532                 self.candidate_without_match_pair(match_pair_index, candidate);
 533                 Some(index)
 534             }
 535
 536             (&TestKind::SwitchInt { switch_ty: _, ref options }, &PatKind::Range(range)) => {
 537                 let not_contained =
 538                     self.values_not_contained_in_range(range, options).unwrap_or(false);
 539
 540                 if not_contained {
 541                     // No switch values are contained in the pattern range,
 542                     // so the pattern can be matched only if this test fails.
 543                     let otherwise = options.len();
 544                     Some(otherwise)
 545                 } else {
 546                     None
 547                 }
 548             }
 549
 550             (&TestKind::SwitchInt { .. }, _) => None,
 551
 552             (
 553                 &TestKind::Len { len: test_len, op: BinOp::Eq },
 554                 &PatKind::Slice { ref prefix, ref slice, ref suffix },
 555             ) => {
 556                 let pat_len = (prefix.len() + suffix.len()) as u64;
 557                 match (test_len.cmp(&pat_len), slice) {
 558                     (Ordering::Equal, &None) => {
 559                         // on true, min_len = len = $actual_length,
 560                         // on false, len != $actual_length
 561                         self.candidate_after_slice_test(
 562                             match_pair_index,
 563                             candidate,
 564                             prefix,
 565                             slice.as_ref(),
 566                             suffix,
 567                         );
 568                         Some(0)
 569                     }
 570                     (Ordering::Less, _) => {
 571                         // test_len < pat_len. If $actual_len = test_len,
 572                         // then $actual_len < pat_len and we don't have
 573                         // enough elements.
 574                         Some(1)
 575                     }
 576                     (Ordering::Equal | Ordering::Greater, &Some(_)) => {
 577                         // This can match both if $actual_len = test_len >= pat_len,
 578                         // and if $actual_len > test_len. We can't advance.
 579                         None
 580                     }
 581                     (Ordering::Greater, &None) => {
 582                         // test_len != pat_len, so if $actual_len = test_len, then
 583                         // $actual_len != pat_len.
 584                         Some(1)
 585                     }
 586                 }
 587             }
 588
 589             (
 590                 &TestKind::Len { len: test_len, op: BinOp::Ge },
 591                 &PatKind::Slice { ref prefix, ref slice, ref suffix },
 592             ) => {
 593                 // the test is `$actual_len >= test_len`
 594                 let pat_len = (prefix.len() + suffix.len()) as u64;
 595                 match (test_len.cmp(&pat_len), slice) {
 596                     (Ordering::Equal, &Some(_)) => {
 597                         // $actual_len >= test_len = pat_len,
 598                         // so we can match.
 599                         self.candidate_after_slice_test(
 600                             match_pair_index,
 601                             candidate,
 602                             prefix,
 603                             slice.as_ref(),
 604                             suffix,
 605                         );
 606                         Some(0)
 607                     }
 608                     (Ordering::Less, _) | (Ordering::Equal, &None) => {
 609                         // test_len <= pat_len. If $actual_len < test_len,
 610                         // then it is also < pat_len, so the test passing is
 611                         // necessary (but insufficient).
 612                         Some(0)
 613                     }
 614                     (Ordering::Greater, &None) => {
 615                         // test_len > pat_len. If $actual_len >= test_len > pat_len,
 616                         // then we know we won't have a match.
 617                         Some(1)
 618                     }
 619                     (Ordering::Greater, &Some(_)) => {
 620                         // test_len < pat_len, and is therefore less
 621                         // strict. This can still go both ways.
 622                         None
 623                     }
 624                 }
 625             }
 626
 627             (&TestKind::Range(test), &PatKind::Range(pat)) => {
 628                 if test == pat {
 629                     self.candidate_without_match_pair(match_pair_index, candidate);
 630                     return Some(0);
 631                 }
 632
 633                 let no_overlap = (|| {
 634                     use rustc_hir::RangeEnd::*;
 635                     use std::cmp::Ordering::*;
 636
 637                     let tcx = self.hir.tcx();
 638
 639                     let test_ty = test.lo.ty;
 640                     let lo = compare_const_vals(tcx, test.lo, pat.hi, self.hir.param_env, test_ty)?;
 641                     let hi = compare_const_vals(tcx, test.hi, pat.lo, self.hir.param_env, test_ty)?;
 642
 643                     match (test.end, pat.end, lo, hi) {
 644                         // pat < test
 645                         (_, _, Greater, _) |
 646                         (_, Excluded, Equal, _) |
 647                         // pat > test
 648                         (_, _, _, Less) |
 649                         (Excluded, _, _, Equal) => Some(true),
 650                         _ => Some(false),
 651                     }
 652                 })();
 653
 654                 if let Some(true) = no_overlap {
 655                     // Testing range does not overlap with pattern range,
 656                     // so the pattern can be matched only if this test fails.
 657                     Some(1)
 658                 } else {
 659                     None
 660                 }
 661             }
 662
 663             (&TestKind::Range(range), &PatKind::Constant { value }) => {
 664                 if let Some(false) = self.const_range_contains(range, value) {
 665                     // `value` is not contained in the testing range,
 666                     // so `value` can be matched only if this test fails.
 667                     Some(1)
 668                 } else {
 669                     None
 670                 }
 671             }
 672
 673             (&TestKind::Range { .. }, _) => None,
 674
 675             (&TestKind::Eq { .. } | &TestKind::Len { .. }, _) => {
 676                 // These are all binary tests.
 677                 //
 678                 // FIXME(#29623) we can be more clever here
 679                 let pattern_test = self.test(&match_pair);
 680                 if pattern_test.kind == test.kind {
 681                     self.candidate_without_match_pair(match_pair_index, candidate);
 682                     Some(0)
 683                 } else {
 684                     None
 685                 }
 686             }
 687         }
 688     }
 689
 690     fn candidate_without_match_pair(
 691         &mut self,
 692         match_pair_index: usize,
 693         candidate: &mut Candidate<'_, 'tcx>,
 694     ) {
 695         candidate.match_pairs.remove(match_pair_index);
 696     }
 697
 698     fn candidate_after_slice_test<'pat>(
 699         &mut self,
 700         match_pair_index: usize,
 701         candidate: &mut Candidate<'pat, 'tcx>,
 702         prefix: &'pat [Pat<'tcx>],
 703         opt_slice: Option<&'pat Pat<'tcx>>,
 704         suffix: &'pat [Pat<'tcx>],
 705     ) {
 706         let removed_place = candidate.match_pairs.remove(match_pair_index).place;
 707         self.prefix_slice_suffix(
 708             &mut candidate.match_pairs,
 709             &removed_place,
 710             prefix,
 711             opt_slice,
 712             suffix,
 713         );
 714     }
 715
 716     fn candidate_after_variant_switch<'pat>(
 717         &mut self,
 718         match_pair_index: usize,
 719         adt_def: &'tcx ty::AdtDef,
 720         variant_index: VariantIdx,
 721         subpatterns: &'pat [FieldPat<'tcx>],
 722         candidate: &mut Candidate<'pat, 'tcx>,
 723     ) {
 724         let match_pair = candidate.match_pairs.remove(match_pair_index);
 725         let tcx = self.hir.tcx();
 726
 727         // So, if we have a match-pattern like `x @ Enum::Variant(P1, P2)`,
 728         // we want to create a set of derived match-patterns like
 729         // `(x as Variant).0 @ P1` and `(x as Variant).1 @ P1`.
 730         let elem = ProjectionElem::Downcast(
 731             Some(adt_def.variants[variant_index].ident.name),
 732             variant_index,
 733         );
 734         let downcast_place = tcx.mk_place_elem(match_pair.place, elem); // `(x as Variant)`
 735         let consequent_match_pairs = subpatterns.iter().map(|subpattern| {
 736             // e.g., `(x as Variant).0`
 737             let place = tcx.mk_place_field(downcast_place, subpattern.field, subpattern.pattern.ty);
 738             // e.g., `(x as Variant).0 @ P1`
 739             MatchPair::new(place, &subpattern.pattern)
 740         });
 741
 742         candidate.match_pairs.extend(consequent_match_pairs);
 743     }
 744
 745     fn error_simplifyable<'pat>(&mut self, match_pair: &MatchPair<'pat, 'tcx>) -> ! {
 746         span_bug!(match_pair.pattern.span, "simplifyable pattern found: {:?}", match_pair.pattern)
 747     }
 748
 749     fn const_range_contains(
 750         &self,
 751         range: PatRange<'tcx>,
 752         value: &'tcx ty::Const<'tcx>,
 753     ) -> Option<bool> {
 754         use std::cmp::Ordering::*;
 755
 756         let tcx = self.hir.tcx();
 757
 758         let a = compare_const_vals(tcx, range.lo, value, self.hir.param_env, range.lo.ty)?;
 759         let b = compare_const_vals(tcx, value, range.hi, self.hir.param_env, range.lo.ty)?;
 760
 761         match (b, range.end) {
 762             (Less, _) | (Equal, RangeEnd::Included) if a != Greater => Some(true),
 763             _ => Some(false),
 764         }
 765     }
 766
 767     fn values_not_contained_in_range(
 768         &self,
 769         range: PatRange<'tcx>,
 770         options: &FxIndexMap<&'tcx ty::Const<'tcx>, u128>,
 771     ) -> Option<bool> {
 772         for &val in options.keys() {
 773             if self.const_range_contains(range, val)? {
 774                 return Some(false);
 775             }
 776         }
 777
 778         Some(true)
 779     }
 780 }
 781
 782 impl Test<'_> {
 783     pub(super) fn targets(&self) -> usize {
 784         match self.kind {
 785             TestKind::Eq { .. } | TestKind::Range(_) | TestKind::Len { .. } => 2,
 786             TestKind::Switch { adt_def, .. } => {
 787                 // While the switch that we generate doesn't test for all
 788                 // variants, we have a target for each variant and the
 789                 // otherwise case, and we make sure that all of the cases not
 790                 // specified have the same block.
 791                 adt_def.variants.len() + 1
 792             }
 793             TestKind::SwitchInt { switch_ty, ref options, .. } => {
 794                 if switch_ty.is_bool() {
 795                     // `bool` is special cased in `perform_test` to always
 796                     // branch to two blocks.
 797                     2
 798                 } else {
 799                     options.len() + 1
 800                 }
 801             }
 802         }
 803     }
 804 }
 805
 806 fn is_switch_ty(ty: Ty<'_>) -> bool {
 807     ty.is_integral() || ty.is_char() || ty.is_bool()
 808 }