src/librustc_mir/hair/pattern/_match.rs

   1 /// This file includes the logic for exhaustiveness and usefulness checking for
   2 /// pattern-matching. Specifically, given a list of patterns for a type, we can
   3 /// tell whether:
   4 /// (a) the patterns cover every possible constructor for the type [exhaustiveness]
   5 /// (b) each pattern is necessary [usefulness]
   6 ///
   7 /// The algorithm implemented here is a modified version of the one described in:
   8 /// http://moscova.inria.fr/~maranget/papers/warn/index.html
   9 /// However, to save future implementors from reading the original paper, we
  10 /// summarise the algorithm here to hopefully save time and be a little clearer
  11 /// (without being so rigorous).
  12 ///
  13 /// The core of the algorithm revolves about a "usefulness" check. In particular, we
  14 /// are trying to compute a predicate `U(P, p)` where `P` is a list of patterns (we refer to this as
  15 /// a matrix). `U(P, p)` represents whether, given an existing list of patterns
  16 /// `P_1 ..= P_m`, adding a new pattern `p` will be "useful" (that is, cover previously-
  17 /// uncovered values of the type).
  18 ///
  19 /// If we have this predicate, then we can easily compute both exhaustiveness of an
  20 /// entire set of patterns and the individual usefulness of each one.
  21 /// (a) the set of patterns is exhaustive iff `U(P, _)` is false (i.e., adding a wildcard
  22 /// match doesn't increase the number of values we're matching)
  23 /// (b) a pattern `P_i` is not useful if `U(P[0..=(i-1), P_i)` is false (i.e., adding a
  24 /// pattern to those that have come before it doesn't increase the number of values
  25 /// we're matching).
  26 ///
  27 /// During the course of the algorithm, the rows of the matrix won't just be individual patterns,
  28 /// but rather partially-deconstructed patterns in the form of a list of patterns. The paper
  29 /// calls those pattern-vectors, and we will call them pattern-stacks. The same holds for the
  30 /// new pattern `p`.
  31 ///
  32 /// For example, say we have the following:
  33 /// ```
  34 ///     // x: (Option<bool>, Result<()>)
  35 ///     match x {
  36 ///         (Some(true), _) => {}
  37 ///         (None, Err(())) => {}
  38 ///         (None, Err(_)) => {}
  39 ///     }
  40 /// ```
  41 /// Here, the matrix `P` starts as:
  42 /// [
  43 ///     [(Some(true), _)],
  44 ///     [(None, Err(()))],
  45 ///     [(None, Err(_))],
  46 /// ]
  47 /// We can tell it's not exhaustive, because `U(P, _)` is true (we're not covering
  48 /// `[(Some(false), _)]`, for instance). In addition, row 3 is not useful, because
  49 /// all the values it covers are already covered by row 2.
  50 ///
  51 /// A list of patterns can be thought of as a stack, because we are mainly interested in the top of
  52 /// the stack at any given point, and we can pop or apply constructors to get new pattern-stacks.
  53 /// To match the paper, the top of the stack is at the beginning / on the left.
  54 ///
  55 /// There are two important operations on pattern-stacks necessary to understand the algorithm:
  56 ///     1. We can pop a given constructor off the top of a stack. This operation is called
  57 ///        `specialize`, and is denoted `S(c, p)` where `c` is a constructor (like `Some` or
  58 ///        `None`) and `p` a pattern-stack.
  59 ///        If the pattern on top of the stack can cover `c`, this removes the constructor and
  60 ///        pushes its arguments onto the stack. It also expands OR-patterns into distinct patterns.
  61 ///        Otherwise the pattern-stack is discarded.
  62 ///        This essentially filters those pattern-stacks whose top covers the constructor `c` and
  63 ///        discards the others.
  64 ///
  65 ///        For example, the first pattern above initially gives a stack `[(Some(true), _)]`. If we
  66 ///        pop the tuple constructor, we are left with `[Some(true), _]`, and if we then pop the
  67 ///        `Some` constructor we get `[true, _]`. If we had popped `None` instead, we would get
  68 ///        nothing back.
  69 ///
  70 ///        This returns zero or more new pattern-stacks, as follows. We look at the pattern `p_1`
  71 ///        on top of the stack, and we have four cases:
  72 ///             1.1. `p_1 = c(r_1, .., r_a)`, i.e. the top of the stack has constructor `c`. We
  73 ///                  push onto the stack the arguments of this constructor, and return the result:
  74 ///                     r_1, .., r_a, p_2, .., p_n
  75 ///             1.2. `p_1 = c'(r_1, .., r_a')` where `c ≠ c'`. We discard the current stack and
  76 ///                  return nothing.
  77 ///             1.3. `p_1 = _`. We push onto the stack as many wildcards as the constructor `c` has
  78 ///                  arguments (its arity), and return the resulting stack:
  79 ///                     _, .., _, p_2, .., p_n
  80 ///             1.4. `p_1 = r_1 | r_2`. We expand the OR-pattern and then recurse on each resulting
  81 ///                  stack:
  82 ///                     S(c, (r_1, p_2, .., p_n))
  83 ///                     S(c, (r_2, p_2, .., p_n))
  84 ///
  85 ///     2. We can pop a wildcard off the top of the stack. This is called `D(p)`, where `p` is
  86 ///        a pattern-stack.
  87 ///        This is used when we know there are missing constructor cases, but there might be
  88 ///        existing wildcard patterns, so to check the usefulness of the matrix, we have to check
  89 ///        all its *other* components.
  90 ///
  91 ///        It is computed as follows. We look at the pattern `p_1` on top of the stack,
  92 ///        and we have three cases:
  93 ///             1.1. `p_1 = c(r_1, .., r_a)`. We discard the current stack and return nothing.
  94 ///             1.2. `p_1 = _`. We return the rest of the stack:
  95 ///                     p_2, .., p_n
  96 ///             1.3. `p_1 = r_1 | r_2`. We expand the OR-pattern and then recurse on each resulting
  97 ///               stack.
  98 ///                     D((r_1, p_2, .., p_n))
  99 ///                     D((r_2, p_2, .., p_n))
 100 ///
 101 ///     Note that the OR-patterns are not always used directly in Rust, but are used to derive the
 102 ///     exhaustive integer matching rules, so they're written here for posterity.
 103 ///
 104 /// Both those operations extend straightforwardly to a list or pattern-stacks, i.e. a matrix, by
 105 /// working row-by-row. Popping a constructor ends up keeping only the matrix rows that start with
 106 /// the given constructor, and popping a wildcard keeps those rows that start with a wildcard.
 107 ///
 108 ///
 109 /// The algorithm for computing `U`
 110 /// -------------------------------
 111 /// The algorithm is inductive (on the number of columns: i.e., components of tuple patterns).
 112 /// That means we're going to check the components from left-to-right, so the algorithm
 113 /// operates principally on the first component of the matrix and new pattern-stack `p`.
 114 /// This algorithm is realised in the `is_useful` function.
 115 ///
 116 /// Base case. (`n = 0`, i.e., an empty tuple pattern)
 117 ///     - If `P` already contains an empty pattern (i.e., if the number of patterns `m > 0`),
 118 ///       then `U(P, p)` is false.
 119 ///     - Otherwise, `P` must be empty, so `U(P, p)` is true.
 120 ///
 121 /// Inductive step. (`n > 0`, i.e., whether there's at least one column
 122 ///                  [which may then be expanded into further columns later])
 123 ///     We're going to match on the top of the new pattern-stack, `p_1`.
 124 ///         - If `p_1 == c(r_1, .., r_a)`, i.e. we have a constructor pattern.
 125 ///           Then, the usefulness of `p_1` can be reduced to whether it is useful when
 126 ///           we ignore all the patterns in the first column of `P` that involve other constructors.
 127 ///           This is where `S(c, P)` comes in:
 128 ///           `U(P, p) := U(S(c, P), S(c, p))`
 129 ///           This special case is handled in `is_useful_specialized`.
 130 ///
 131 ///           For example, if `P` is:
 132 ///           [
 133 ///               [Some(true), _],
 134 ///               [None, 0],
 135 ///           ]
 136 ///           and `p` is [Some(false), 0], then we don't care about row 2 since we know `p` only
 137 ///           matches values that row 2 doesn't. For row 1 however, we need to dig into the
 138 ///           arguments of `Some` to know whether some new value is covered. So we compute
 139 ///           `U([[true, _]], [false, 0])`.
 140 ///
 141 ///         - If `p_1 == _`, then we look at the list of constructors that appear in the first
 142 ///               component of the rows of `P`:
 143 ///             + If there are some constructors that aren't present, then we might think that the
 144 ///               wildcard `_` is useful, since it covers those constructors that weren't covered
 145 ///               before.
 146 ///               That's almost correct, but only works if there were no wildcards in those first
 147 ///               components. So we need to check that `p` is useful with respect to the rows that
 148 ///               start with a wildcard, if there are any. This is where `D` comes in:
 149 ///               `U(P, p) := U(D(P), D(p))`
 150 ///
 151 ///               For example, if `P` is:
 152 ///               [
 153 ///                   [_, true, _],
 154 ///                   [None, false, 1],
 155 ///               ]
 156 ///               and `p` is [_, false, _], the `Some` constructor doesn't appear in `P`. So if we
 157 ///               only had row 2, we'd know that `p` is useful. However row 1 starts with a
 158 ///               wildcard, so we need to check whether `U([[true, _]], [false, 1])`.
 159 ///
 160 ///             + Otherwise, all possible constructors (for the relevant type) are present. In this
 161 ///               case we must check whether the wildcard pattern covers any unmatched value. For
 162 ///               that, we can think of the `_` pattern as a big OR-pattern that covers all
 163 ///               possible constructors. For `Option`, that would mean `_ = None | Some(_)` for
 164 ///               example. The wildcard pattern is useful in this case if it is useful when
 165 ///               specialized to one of the possible constructors. So we compute:
 166 ///               `U(P, p) := ∃(k ϵ constructors) U(S(k, P), S(k, p))`
 167 ///
 168 ///               For example, if `P` is:
 169 ///               [
 170 ///                   [Some(true), _],
 171 ///                   [None, false],
 172 ///               ]
 173 ///               and `p` is [_, false], both `None` and `Some` constructors appear in the first
 174 ///               components of `P`. We will therefore try popping both constructors in turn: we
 175 ///               compute U([[true, _]], [_, false]) for the `Some` constructor, and U([[false]],
 176 ///               [false]) for the `None` constructor. The first case returns true, so we know that
 177 ///               `p` is useful for `P`. Indeed, it matches `[Some(false), _]` that wasn't matched
 178 ///               before.
 179 ///
 180 ///         - If `p_1 == r_1 | r_2`, then the usefulness depends on each `r_i` separately:
 181 ///           `U(P, p) := U(P, (r_1, p_2, .., p_n))
 182 ///                    || U(P, (r_2, p_2, .., p_n))`
 183 ///
 184 /// Modifications to the algorithm
 185 /// ------------------------------
 186 /// The algorithm in the paper doesn't cover some of the special cases that arise in Rust, for
 187 /// example uninhabited types and variable-length slice patterns. These are drawn attention to
 188 /// throughout the code below. I'll make a quick note here about how exhaustive integer matching is
 189 /// accounted for, though.
 190 ///
 191 /// Exhaustive integer matching
 192 /// ---------------------------
 193 /// An integer type can be thought of as a (huge) sum type: 1 | 2 | 3 | ...
 194 /// So to support exhaustive integer matching, we can make use of the logic in the paper for
 195 /// OR-patterns. However, we obviously can't just treat ranges x..=y as individual sums, because
 196 /// they are likely gigantic. So we instead treat ranges as constructors of the integers. This means
 197 /// that we have a constructor *of* constructors (the integers themselves). We then need to work
 198 /// through all the inductive step rules above, deriving how the ranges would be treated as
 199 /// OR-patterns, and making sure that they're treated in the same way even when they're ranges.
 200 /// There are really only four special cases here:
 201 /// - When we match on a constructor that's actually a range, we have to treat it as if we would
 202 ///   an OR-pattern.
 203 ///     + It turns out that we can simply extend the case for single-value patterns in
 204 ///      `specialize` to either be *equal* to a value constructor, or *contained within* a range
 205 ///      constructor.
 206 ///     + When the pattern itself is a range, you just want to tell whether any of the values in
 207 ///       the pattern range coincide with values in the constructor range, which is precisely
 208 ///       intersection.
 209 ///   Since when encountering a range pattern for a value constructor, we also use inclusion, it
 210 ///   means that whenever the constructor is a value/range and the pattern is also a value/range,
 211 ///   we can simply use intersection to test usefulness.
 212 /// - When we're testing for usefulness of a pattern and the pattern's first component is a
 213 ///   wildcard.
 214 ///     + If all the constructors appear in the matrix, we have a slight complication. By default,
 215 ///       the behaviour (i.e., a disjunction over specialised matrices for each constructor) is
 216 ///       invalid, because we want a disjunction over every *integer* in each range, not just a
 217 ///       disjunction over every range. This is a bit more tricky to deal with: essentially we need
 218 ///       to form equivalence classes of subranges of the constructor range for which the behaviour
 219 ///       of the matrix `P` and new pattern `p` are the same. This is described in more
 220 ///       detail in `split_grouped_constructors`.
 221 ///     + If some constructors are missing from the matrix, it turns out we don't need to do
 222 ///       anything special (because we know none of the integers are actually wildcards: i.e., we
 223 ///       can't span wildcards using ranges).
 224 use self::Constructor::*;
 225 use self::Usefulness::*;
 226 use self::WitnessPreference::*;
 227
 228 use rustc_data_structures::fx::FxHashMap;
 229 use rustc_index::vec::Idx;
 230
 231 use super::{compare_const_vals, PatternFoldable, PatternFolder};
 232 use super::{FieldPat, Pat, PatKind, PatRange};
 233
 234 use rustc::hir::def_id::DefId;
 235 use rustc::hir::{HirId, RangeEnd};
 236 use rustc::ty::layout::{Integer, IntegerExt, Size, VariantIdx};
 237 use rustc::ty::{self, Const, Ty, TyCtxt, TypeFoldable};
 238
 239 use rustc::lint;
 240 use rustc::mir::interpret::{truncate, AllocId, ConstValue, Pointer, Scalar};
 241 use rustc::mir::Field;
 242 use rustc::util::captures::Captures;
 243 use rustc::util::common::ErrorReported;
 244
 245 use syntax::attr::{SignedInt, UnsignedInt};
 246 use syntax_pos::{Span, DUMMY_SP};
 247
 248 use arena::TypedArena;
 249
 250 use smallvec::{smallvec, SmallVec};
 251 use std::cmp::{self, max, min, Ordering};
 252 use std::convert::TryInto;
 253 use std::fmt;
 254 use std::iter::{FromIterator, IntoIterator};
 255 use std::ops::RangeInclusive;
 256 use std::u128;
 257
 258 pub fn expand_pattern<'a, 'tcx>(cx: &MatchCheckCtxt<'a, 'tcx>, pat: Pat<'tcx>) -> Pat<'tcx> {
 259     LiteralExpander { tcx: cx.tcx }.fold_pattern(&pat)
 260 }
 261
 262 struct LiteralExpander<'tcx> {
 263     tcx: TyCtxt<'tcx>,
 264 }
 265
 266 impl LiteralExpander<'tcx> {
 267     /// Derefs `val` and potentially unsizes the value if `crty` is an array and `rty` a slice.
 268     ///
 269     /// `crty` and `rty` can differ because you can use array constants in the presence of slice
 270     /// patterns. So the pattern may end up being a slice, but the constant is an array. We convert
 271     /// the array to a slice in that case.
 272     fn fold_const_value_deref(
 273         &mut self,
 274         val: ConstValue<'tcx>,
 275         // the pattern's pointee type
 276         rty: Ty<'tcx>,
 277         // the constant's pointee type
 278         crty: Ty<'tcx>,
 279     ) -> ConstValue<'tcx> {
 280         debug!("fold_const_value_deref {:?} {:?} {:?}", val, rty, crty);
 281         match (val, &crty.kind, &rty.kind) {
 282             // the easy case, deref a reference
 283             (ConstValue::Scalar(Scalar::Ptr(p)), x, y) if x == y => {
 284                 let alloc = self.tcx.alloc_map.lock().unwrap_memory(p.alloc_id);
 285                 ConstValue::ByRef { alloc, offset: p.offset }
 286             }
 287             // unsize array to slice if pattern is array but match value or other patterns are slice
 288             (ConstValue::Scalar(Scalar::Ptr(p)), ty::Array(t, n), ty::Slice(u)) => {
 289                 assert_eq!(t, u);
 290                 ConstValue::Slice {
 291                     data: self.tcx.alloc_map.lock().unwrap_memory(p.alloc_id),
 292                     start: p.offset.bytes().try_into().unwrap(),
 293                     end: n.eval_usize(self.tcx, ty::ParamEnv::empty()).try_into().unwrap(),
 294                 }
 295             }
 296             // fat pointers stay the same
 297             (ConstValue::Slice { .. }, _, _)
 298             | (_, ty::Slice(_), ty::Slice(_))
 299             | (_, ty::Str, ty::Str) => val,
 300             // FIXME(oli-obk): this is reachable for `const FOO: &&&u32 = &&&42;` being used
 301             _ => bug!("cannot deref {:#?}, {} -> {}", val, crty, rty),
 302         }
 303     }
 304 }
 305
 306 impl PatternFolder<'tcx> for LiteralExpander<'tcx> {
 307     fn fold_pattern(&mut self, pat: &Pat<'tcx>) -> Pat<'tcx> {
 308         debug!("fold_pattern {:?} {:?} {:?}", pat, pat.ty.kind, pat.kind);
 309         match (&pat.ty.kind, &*pat.kind) {
 310             (
 311                 &ty::Ref(_, rty, _),
 312                 &PatKind::Constant {
 313                     value: Const { val, ty: ty::TyS { kind: ty::Ref(_, crty, _), .. } },
 314                 },
 315             ) => Pat {
 316                 ty: pat.ty,
 317                 span: pat.span,
 318                 kind: box PatKind::Deref {
 319                     subpattern: Pat {
 320                         ty: rty,
 321                         span: pat.span,
 322                         kind: box PatKind::Constant {
 323                             value: self.tcx.mk_const(Const {
 324                                 val: self.fold_const_value_deref(*val, rty, crty),
 325                                 ty: rty,
 326                             }),
 327                         },
 328                     },
 329                 },
 330             },
 331             (_, &PatKind::Binding { subpattern: Some(ref s), .. }) => s.fold_with(self),
 332             _ => pat.super_fold_with(self),
 333         }
 334     }
 335 }
 336
 337 impl<'tcx> Pat<'tcx> {
 338     fn is_wildcard(&self) -> bool {
 339         match *self.kind {
 340             PatKind::Binding { subpattern: None, .. } | PatKind::Wild => true,
 341             _ => false,
 342         }
 343     }
 344 }
 345
 346 /// A row of a matrix. Rows of len 1 are very common, which is why `SmallVec[_; 2]`
 347 /// works well.
 348 #[derive(Debug, Clone)]
 349 pub struct PatStack<'p, 'tcx>(SmallVec<[&'p Pat<'tcx>; 2]>);
 350
 351 impl<'p, 'tcx> PatStack<'p, 'tcx> {
 352     pub fn from_pattern(pat: &'p Pat<'tcx>) -> Self {
 353         PatStack(smallvec![pat])
 354     }
 355
 356     fn from_vec(vec: SmallVec<[&'p Pat<'tcx>; 2]>) -> Self {
 357         PatStack(vec)
 358     }
 359
 360     fn from_slice(s: &[&'p Pat<'tcx>]) -> Self {
 361         PatStack(SmallVec::from_slice(s))
 362     }
 363
 364     fn is_empty(&self) -> bool {
 365         self.0.is_empty()
 366     }
 367
 368     fn len(&self) -> usize {
 369         self.0.len()
 370     }
 371
 372     fn head(&self) -> &'p Pat<'tcx> {
 373         self.0[0]
 374     }
 375
 376     fn to_tail(&self) -> Self {
 377         PatStack::from_slice(&self.0[1..])
 378     }
 379
 380     fn iter(&self) -> impl Iterator<Item = &Pat<'tcx>> {
 381         self.0.iter().map(|p| *p)
 382     }
 383
 384     /// This computes `D(self)`. See top of the file for explanations.
 385     fn specialize_wildcard(&self) -> Option<Self> {
 386         if self.head().is_wildcard() { Some(self.to_tail()) } else { None }
 387     }
 388
 389     /// This computes `S(constructor, self)`. See top of the file for explanations.
 390     fn specialize_constructor<'a, 'q>(
 391         &self,
 392         cx: &mut MatchCheckCtxt<'a, 'tcx>,
 393         constructor: &Constructor<'tcx>,
 394         wild_patterns: &[&'q Pat<'tcx>],
 395     ) -> Option<PatStack<'q, 'tcx>>
 396     where
 397         'a: 'q,
 398         'p: 'q,
 399     {
 400         specialize(cx, self, constructor, wild_patterns)
 401     }
 402 }
 403
 404 impl<'p, 'tcx> Default for PatStack<'p, 'tcx> {
 405     fn default() -> Self {
 406         PatStack(smallvec![])
 407     }
 408 }
 409
 410 impl<'p, 'tcx> FromIterator<&'p Pat<'tcx>> for PatStack<'p, 'tcx> {
 411     fn from_iter<T>(iter: T) -> Self
 412     where
 413         T: IntoIterator<Item = &'p Pat<'tcx>>,
 414     {
 415         PatStack(iter.into_iter().collect())
 416     }
 417 }
 418
 419 /// A 2D matrix.
 420 pub struct Matrix<'p, 'tcx>(Vec<PatStack<'p, 'tcx>>);
 421
 422 impl<'p, 'tcx> Matrix<'p, 'tcx> {
 423     pub fn empty() -> Self {
 424         Matrix(vec![])
 425     }
 426
 427     pub fn push(&mut self, row: PatStack<'p, 'tcx>) {
 428         self.0.push(row)
 429     }
 430
 431     /// Iterate over the first component of each row
 432     fn heads<'a>(&'a self) -> impl Iterator<Item = &'a Pat<'tcx>> + Captures<'p> {
 433         self.0.iter().map(|r| r.head())
 434     }
 435
 436     /// This computes `D(self)`. See top of the file for explanations.
 437     fn specialize_wildcard(&self) -> Self {
 438         self.0.iter().filter_map(|r| r.specialize_wildcard()).collect()
 439     }
 440
 441     /// This computes `S(constructor, self)`. See top of the file for explanations.
 442     fn specialize_constructor<'a, 'q>(
 443         &self,
 444         cx: &mut MatchCheckCtxt<'a, 'tcx>,
 445         constructor: &Constructor<'tcx>,
 446         wild_patterns: &[&'q Pat<'tcx>],
 447     ) -> Matrix<'q, 'tcx>
 448     where
 449         'a: 'q,
 450         'p: 'q,
 451     {
 452         Matrix(
 453             self.0
 454                 .iter()
 455                 .filter_map(|r| r.specialize_constructor(cx, constructor, wild_patterns))
 456                 .collect(),
 457         )
 458     }
 459 }
 460
 461 /// Pretty-printer for matrices of patterns, example:
 462 /// +++++++++++++++++++++++++++++
 463 /// + _     + []                +
 464 /// +++++++++++++++++++++++++++++
 465 /// + true  + [First]           +
 466 /// +++++++++++++++++++++++++++++
 467 /// + true  + [Second(true)]    +
 468 /// +++++++++++++++++++++++++++++
 469 /// + false + [_]               +
 470 /// +++++++++++++++++++++++++++++
 471 /// + _     + [_, _, tail @ ..] +
 472 /// +++++++++++++++++++++++++++++
 473 impl<'p, 'tcx> fmt::Debug for Matrix<'p, 'tcx> {
 474     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 475         write!(f, "\n")?;
 476
 477         let &Matrix(ref m) = self;
 478         let pretty_printed_matrix: Vec<Vec<String>> =
 479             m.iter().map(|row| row.iter().map(|pat| format!("{:?}", pat)).collect()).collect();
 480
 481         let column_count = m.iter().map(|row| row.len()).max().unwrap_or(0);
 482         assert!(m.iter().all(|row| row.len() == column_count));
 483         let column_widths: Vec<usize> = (0..column_count)
 484             .map(|col| pretty_printed_matrix.iter().map(|row| row[col].len()).max().unwrap_or(0))
 485             .collect();
 486
 487         let total_width = column_widths.iter().cloned().sum::<usize>() + column_count * 3 + 1;
 488         let br = "+".repeat(total_width);
 489         write!(f, "{}\n", br)?;
 490         for row in pretty_printed_matrix {
 491             write!(f, "+")?;
 492             for (column, pat_str) in row.into_iter().enumerate() {
 493                 write!(f, " ")?;
 494                 write!(f, "{:1$}", pat_str, column_widths[column])?;
 495                 write!(f, " +")?;
 496             }
 497             write!(f, "\n")?;
 498             write!(f, "{}\n", br)?;
 499         }
 500         Ok(())
 501     }
 502 }
 503
 504 impl<'p, 'tcx> FromIterator<PatStack<'p, 'tcx>> for Matrix<'p, 'tcx> {
 505     fn from_iter<T>(iter: T) -> Self
 506     where
 507         T: IntoIterator<Item = PatStack<'p, 'tcx>>,
 508     {
 509         Matrix(iter.into_iter().collect())
 510     }
 511 }
 512
 513 pub struct MatchCheckCtxt<'a, 'tcx> {
 514     pub tcx: TyCtxt<'tcx>,
 515     /// The module in which the match occurs. This is necessary for
 516     /// checking inhabited-ness of types because whether a type is (visibly)
 517     /// inhabited can depend on whether it was defined in the current module or
 518     /// not. E.g., `struct Foo { _private: ! }` cannot be seen to be empty
 519     /// outside it's module and should not be matchable with an empty match
 520     /// statement.
 521     pub module: DefId,
 522     param_env: ty::ParamEnv<'tcx>,
 523     pub pattern_arena: &'a TypedArena<Pat<'tcx>>,
 524     pub byte_array_map: FxHashMap<*const Pat<'tcx>, Vec<&'a Pat<'tcx>>>,
 525 }
 526
 527 impl<'a, 'tcx> MatchCheckCtxt<'a, 'tcx> {
 528     pub fn create_and_enter<F, R>(
 529         tcx: TyCtxt<'tcx>,
 530         param_env: ty::ParamEnv<'tcx>,
 531         module: DefId,
 532         f: F,
 533     ) -> R
 534     where
 535         F: for<'b> FnOnce(MatchCheckCtxt<'b, 'tcx>) -> R,
 536     {
 537         let pattern_arena = TypedArena::default();
 538
 539         f(MatchCheckCtxt {
 540             tcx,
 541             param_env,
 542             module,
 543             pattern_arena: &pattern_arena,
 544             byte_array_map: FxHashMap::default(),
 545         })
 546     }
 547
 548     fn is_uninhabited(&self, ty: Ty<'tcx>) -> bool {
 549         if self.tcx.features().exhaustive_patterns {
 550             self.tcx.is_ty_uninhabited_from(self.module, ty)
 551         } else {
 552             false
 553         }
 554     }
 555
 556     fn is_non_exhaustive_enum(&self, ty: Ty<'tcx>) -> bool {
 557         match ty.kind {
 558             ty::Adt(adt_def, ..) => adt_def.is_variant_list_non_exhaustive(),
 559             _ => false,
 560         }
 561     }
 562
 563     fn is_local(&self, ty: Ty<'tcx>) -> bool {
 564         match ty.kind {
 565             ty::Adt(adt_def, ..) => adt_def.did.is_local(),
 566             _ => false,
 567         }
 568     }
 569 }
 570
 571 #[derive(Clone, Debug)]
 572 enum Constructor<'tcx> {
 573     /// The constructor of all patterns that don't vary by constructor,
 574     /// e.g., struct patterns and fixed-length arrays.
 575     Single,
 576     /// Enum variants.
 577     Variant(DefId),
 578     /// Literal values.
 579     ConstantValue(&'tcx ty::Const<'tcx>, Span),
 580     /// Ranges of literal values (`2..=5` and `2..5`).
 581     ConstantRange(u128, u128, Ty<'tcx>, RangeEnd, Span),
 582     /// Array patterns of length n.
 583     Slice(u64),
 584 }
 585
 586 // Ignore spans when comparing, they don't carry semantic information as they are only for lints.
 587 impl<'tcx> std::cmp::PartialEq for Constructor<'tcx> {
 588     fn eq(&self, other: &Self) -> bool {
 589         match (self, other) {
 590             (Constructor::Single, Constructor::Single) => true,
 591             (Constructor::Variant(a), Constructor::Variant(b)) => a == b,
 592             (Constructor::ConstantValue(a, _), Constructor::ConstantValue(b, _)) => a == b,
 593             (
 594                 Constructor::ConstantRange(a_start, a_end, a_ty, a_range_end, _),
 595                 Constructor::ConstantRange(b_start, b_end, b_ty, b_range_end, _),
 596             ) => a_start == b_start && a_end == b_end && a_ty == b_ty && a_range_end == b_range_end,
 597             (Constructor::Slice(a), Constructor::Slice(b)) => a == b,
 598             _ => false,
 599         }
 600     }
 601 }
 602
 603 impl<'tcx> Constructor<'tcx> {
 604     fn is_slice(&self) -> bool {
 605         match self {
 606             Slice { .. } => true,
 607             _ => false,
 608         }
 609     }
 610
 611     fn variant_index_for_adt<'a>(
 612         &self,
 613         cx: &MatchCheckCtxt<'a, 'tcx>,
 614         adt: &'tcx ty::AdtDef,
 615     ) -> VariantIdx {
 616         match self {
 617             Variant(id) => adt.variant_index_with_id(*id),
 618             Single => {
 619                 assert!(!adt.is_enum());
 620                 VariantIdx::new(0)
 621             }
 622             ConstantValue(c, _) => crate::const_eval::const_variant_index(cx.tcx, cx.param_env, c),
 623             _ => bug!("bad constructor {:?} for adt {:?}", self, adt),
 624         }
 625     }
 626
 627     fn display(&self, tcx: TyCtxt<'tcx>) -> String {
 628         match self {
 629             Constructor::ConstantValue(val, _) => format!("{}", val),
 630             Constructor::ConstantRange(lo, hi, ty, range_end, _) => {
 631                 // Get the right sign on the output:
 632                 let ty = ty::ParamEnv::empty().and(*ty);
 633                 format!(
 634                     "{}{}{}",
 635                     ty::Const::from_bits(tcx, *lo, ty),
 636                     range_end,
 637                     ty::Const::from_bits(tcx, *hi, ty),
 638                 )
 639             }
 640             Constructor::Slice(val) => format!("[{}]", val),
 641             _ => bug!("bad constructor being displayed: `{:?}", self),
 642         }
 643     }
 644
 645     fn wildcard_subpatterns<'a>(
 646         &self,
 647         cx: &MatchCheckCtxt<'a, 'tcx>,
 648         ty: Ty<'tcx>,
 649     ) -> Vec<Pat<'tcx>> {
 650         constructor_sub_pattern_tys(cx, self, ty)
 651             .into_iter()
 652             .map(|ty| Pat { ty, span: DUMMY_SP, kind: box PatKind::Wild })
 653             .collect()
 654     }
 655
 656     /// This computes the arity of a constructor. The arity of a constructor
 657     /// is how many subpattern patterns of that constructor should be expanded to.
 658     ///
 659     /// For instance, a tuple pattern `(_, 42, Some([]))` has the arity of 3.
 660     /// A struct pattern's arity is the number of fields it contains, etc.
 661     fn arity<'a>(&self, cx: &MatchCheckCtxt<'a, 'tcx>, ty: Ty<'tcx>) -> u64 {
 662         debug!("Constructor::arity({:#?}, {:?})", self, ty);
 663         match ty.kind {
 664             ty::Tuple(ref fs) => fs.len() as u64,
 665             ty::Slice(..) | ty::Array(..) => match *self {
 666                 Slice(length) => length,
 667                 ConstantValue(..) => 0,
 668                 _ => bug!("bad slice pattern {:?} {:?}", self, ty),
 669             },
 670             ty::Ref(..) => 1,
 671             ty::Adt(adt, _) => {
 672                 adt.variants[self.variant_index_for_adt(cx, adt)].fields.len() as u64
 673             }
 674             _ => 0,
 675         }
 676     }
 677 }
 678
 679 #[derive(Clone, Debug)]
 680 pub enum Usefulness<'tcx> {
 681     Useful,
 682     UsefulWithWitness(Vec<Witness<'tcx>>),
 683     NotUseful,
 684 }
 685
 686 impl<'tcx> Usefulness<'tcx> {
 687     fn is_useful(&self) -> bool {
 688         match *self {
 689             NotUseful => false,
 690             _ => true,
 691         }
 692     }
 693 }
 694
 695 #[derive(Copy, Clone, Debug)]
 696 pub enum WitnessPreference {
 697     ConstructWitness,
 698     LeaveOutWitness,
 699 }
 700
 701 #[derive(Copy, Clone, Debug)]
 702 struct PatCtxt<'tcx> {
 703     ty: Ty<'tcx>,
 704     max_slice_length: u64,
 705     span: Span,
 706 }
 707
 708 /// A witness of non-exhaustiveness for error reporting, represented
 709 /// as a list of patterns (in reverse order of construction) with
 710 /// wildcards inside to represent elements that can take any inhabitant
 711 /// of the type as a value.
 712 ///
 713 /// A witness against a list of patterns should have the same types
 714 /// and length as the pattern matched against. Because Rust `match`
 715 /// is always against a single pattern, at the end the witness will
 716 /// have length 1, but in the middle of the algorithm, it can contain
 717 /// multiple patterns.
 718 ///
 719 /// For example, if we are constructing a witness for the match against
 720 /// ```
 721 /// struct Pair(Option<(u32, u32)>, bool);
 722 ///
 723 /// match (p: Pair) {
 724 ///    Pair(None, _) => {}
 725 ///    Pair(_, false) => {}
 726 /// }
 727 /// ```
 728 ///
 729 /// We'll perform the following steps:
 730 /// 1. Start with an empty witness
 731 ///     `Witness(vec![])`
 732 /// 2. Push a witness `Some(_)` against the `None`
 733 ///     `Witness(vec![Some(_)])`
 734 /// 3. Push a witness `true` against the `false`
 735 ///     `Witness(vec![Some(_), true])`
 736 /// 4. Apply the `Pair` constructor to the witnesses
 737 ///     `Witness(vec![Pair(Some(_), true)])`
 738 ///
 739 /// The final `Pair(Some(_), true)` is then the resulting witness.
 740 #[derive(Clone, Debug)]
 741 pub struct Witness<'tcx>(Vec<Pat<'tcx>>);
 742
 743 impl<'tcx> Witness<'tcx> {
 744     pub fn single_pattern(self) -> Pat<'tcx> {
 745         assert_eq!(self.0.len(), 1);
 746         self.0.into_iter().next().unwrap()
 747     }
 748
 749     fn push_wild_constructor<'a>(
 750         mut self,
 751         cx: &MatchCheckCtxt<'a, 'tcx>,
 752         ctor: &Constructor<'tcx>,
 753         ty: Ty<'tcx>,
 754     ) -> Self {
 755         self.0.extend(ctor.wildcard_subpatterns(cx, ty));
 756         self.apply_constructor(cx, ctor, ty)
 757     }
 758
 759     /// Constructs a partial witness for a pattern given a list of
 760     /// patterns expanded by the specialization step.
 761     ///
 762     /// When a pattern P is discovered to be useful, this function is used bottom-up
 763     /// to reconstruct a complete witness, e.g., a pattern P' that covers a subset
 764     /// of values, V, where each value in that set is not covered by any previously
 765     /// used patterns and is covered by the pattern P'. Examples:
 766     ///
 767     /// left_ty: tuple of 3 elements
 768     /// pats: [10, 20, _]           => (10, 20, _)
 769     ///
 770     /// left_ty: struct X { a: (bool, &'static str), b: usize}
 771     /// pats: [(false, "foo"), 42]  => X { a: (false, "foo"), b: 42 }
 772     fn apply_constructor<'a>(
 773         mut self,
 774         cx: &MatchCheckCtxt<'a, 'tcx>,
 775         ctor: &Constructor<'tcx>,
 776         ty: Ty<'tcx>,
 777     ) -> Self {
 778         let arity = ctor.arity(cx, ty);
 779         let pat = {
 780             let len = self.0.len() as u64;
 781             let mut pats = self.0.drain((len - arity) as usize..).rev();
 782
 783             match ty.kind {
 784                 ty::Adt(..) | ty::Tuple(..) => {
 785                     let pats = pats
 786                         .enumerate()
 787                         .map(|(i, p)| FieldPat { field: Field::new(i), pattern: p })
 788                         .collect();
 789
 790                     if let ty::Adt(adt, substs) = ty.kind {
 791                         if adt.is_enum() {
 792                             PatKind::Variant {
 793                                 adt_def: adt,
 794                                 substs,
 795                                 variant_index: ctor.variant_index_for_adt(cx, adt),
 796                                 subpatterns: pats,
 797                             }
 798                         } else {
 799                             PatKind::Leaf { subpatterns: pats }
 800                         }
 801                     } else {
 802                         PatKind::Leaf { subpatterns: pats }
 803                     }
 804                 }
 805
 806                 ty::Ref(..) => PatKind::Deref { subpattern: pats.nth(0).unwrap() },
 807
 808                 ty::Slice(_) | ty::Array(..) => {
 809                     PatKind::Slice { prefix: pats.collect(), slice: None, suffix: vec![] }
 810                 }
 811
 812                 _ => match *ctor {
 813                     ConstantValue(value, _) => PatKind::Constant { value },
 814                     ConstantRange(lo, hi, ty, end, _) => PatKind::Range(PatRange {
 815                         lo: ty::Const::from_bits(cx.tcx, lo, ty::ParamEnv::empty().and(ty)),
 816                         hi: ty::Const::from_bits(cx.tcx, hi, ty::ParamEnv::empty().and(ty)),
 817                         end,
 818                     }),
 819                     _ => PatKind::Wild,
 820                 },
 821             }
 822         };
 823
 824         self.0.push(Pat { ty, span: DUMMY_SP, kind: Box::new(pat) });
 825
 826         self
 827     }
 828 }
 829
 830 /// This determines the set of all possible constructors of a pattern matching
 831 /// values of type `left_ty`. For vectors, this would normally be an infinite set
 832 /// but is instead bounded by the maximum fixed length of slice patterns in
 833 /// the column of patterns being analyzed.
 834 ///
 835 /// We make sure to omit constructors that are statically impossible. E.g., for
 836 /// `Option<!>`, we do not include `Some(_)` in the returned list of constructors.
 837 fn all_constructors<'a, 'tcx>(
 838     cx: &mut MatchCheckCtxt<'a, 'tcx>,
 839     pcx: PatCtxt<'tcx>,
 840 ) -> Vec<Constructor<'tcx>> {
 841     debug!("all_constructors({:?})", pcx.ty);
 842     let ctors = match pcx.ty.kind {
 843         ty::Bool => [true, false]
 844             .iter()
 845             .map(|&b| ConstantValue(ty::Const::from_bool(cx.tcx, b), pcx.span))
 846             .collect(),
 847         ty::Array(ref sub_ty, len) if len.try_eval_usize(cx.tcx, cx.param_env).is_some() => {
 848             let len = len.eval_usize(cx.tcx, cx.param_env);
 849             if len != 0 && cx.is_uninhabited(sub_ty) { vec![] } else { vec![Slice(len)] }
 850         }
 851         // Treat arrays of a constant but unknown length like slices.
 852         ty::Array(ref sub_ty, _) | ty::Slice(ref sub_ty) => {
 853             if cx.is_uninhabited(sub_ty) {
 854                 vec![Slice(0)]
 855             } else {
 856                 (0..pcx.max_slice_length + 1).map(|length| Slice(length)).collect()
 857             }
 858         }
 859         ty::Adt(def, substs) if def.is_enum() => def
 860             .variants
 861             .iter()
 862             .filter(|v| {
 863                 !cx.tcx.features().exhaustive_patterns
 864                     || !v
 865                         .uninhabited_from(cx.tcx, substs, def.adt_kind())
 866                         .contains(cx.tcx, cx.module)
 867             })
 868             .map(|v| Variant(v.def_id))
 869             .collect(),
 870         ty::Char => {
 871             vec![
 872                 // The valid Unicode Scalar Value ranges.
 873                 ConstantRange(
 874                     '\u{0000}' as u128,
 875                     '\u{D7FF}' as u128,
 876                     cx.tcx.types.char,
 877                     RangeEnd::Included,
 878                     pcx.span,
 879                 ),
 880                 ConstantRange(
 881                     '\u{E000}' as u128,
 882                     '\u{10FFFF}' as u128,
 883                     cx.tcx.types.char,
 884                     RangeEnd::Included,
 885                     pcx.span,
 886                 ),
 887             ]
 888         }
 889         ty::Int(ity) => {
 890             let bits = Integer::from_attr(&cx.tcx, SignedInt(ity)).size().bits() as u128;
 891             let min = 1u128 << (bits - 1);
 892             let max = min - 1;
 893             vec![ConstantRange(min, max, pcx.ty, RangeEnd::Included, pcx.span)]
 894         }
 895         ty::Uint(uty) => {
 896             let size = Integer::from_attr(&cx.tcx, UnsignedInt(uty)).size();
 897             let max = truncate(u128::max_value(), size);
 898             vec![ConstantRange(0, max, pcx.ty, RangeEnd::Included, pcx.span)]
 899         }
 900         _ => {
 901             if cx.is_uninhabited(pcx.ty) {
 902                 vec![]
 903             } else {
 904                 vec![Single]
 905             }
 906         }
 907     };
 908     ctors
 909 }
 910
 911 fn max_slice_length<'p, 'a, 'tcx, I>(cx: &mut MatchCheckCtxt<'a, 'tcx>, patterns: I) -> u64
 912 where
 913     I: Iterator<Item = &'p Pat<'tcx>>,
 914     'tcx: 'p,
 915 {
 916     // The exhaustiveness-checking paper does not include any details on
 917     // checking variable-length slice patterns. However, they are matched
 918     // by an infinite collection of fixed-length array patterns.
 919     //
 920     // Checking the infinite set directly would take an infinite amount
 921     // of time. However, it turns out that for each finite set of
 922     // patterns `P`, all sufficiently large array lengths are equivalent:
 923     //
 924     // Each slice `s` with a "sufficiently-large" length `l ≥ L` that applies
 925     // to exactly the subset `Pₜ` of `P` can be transformed to a slice
 926     // `sₘ` for each sufficiently-large length `m` that applies to exactly
 927     // the same subset of `P`.
 928     //
 929     // Because of that, each witness for reachability-checking from one
 930     // of the sufficiently-large lengths can be transformed to an
 931     // equally-valid witness from any other length, so we only have
 932     // to check slice lengths from the "minimal sufficiently-large length"
 933     // and below.
 934     //
 935     // Note that the fact that there is a *single* `sₘ` for each `m`
 936     // not depending on the specific pattern in `P` is important: if
 937     // you look at the pair of patterns
 938     //     `[true, ..]`
 939     //     `[.., false]`
 940     // Then any slice of length ≥1 that matches one of these two
 941     // patterns can be trivially turned to a slice of any
 942     // other length ≥1 that matches them and vice-versa - for
 943     // but the slice from length 2 `[false, true]` that matches neither
 944     // of these patterns can't be turned to a slice from length 1 that
 945     // matches neither of these patterns, so we have to consider
 946     // slices from length 2 there.
 947     //
 948     // Now, to see that that length exists and find it, observe that slice
 949     // patterns are either "fixed-length" patterns (`[_, _, _]`) or
 950     // "variable-length" patterns (`[_, .., _]`).
 951     //
 952     // For fixed-length patterns, all slices with lengths *longer* than
 953     // the pattern's length have the same outcome (of not matching), so
 954     // as long as `L` is greater than the pattern's length we can pick
 955     // any `sₘ` from that length and get the same result.
 956     //
 957     // For variable-length patterns, the situation is more complicated,
 958     // because as seen above the precise value of `sₘ` matters.
 959     //
 960     // However, for each variable-length pattern `p` with a prefix of length
 961     // `plₚ` and suffix of length `slₚ`, only the first `plₚ` and the last
 962     // `slₚ` elements are examined.
 963     //
 964     // Therefore, as long as `L` is positive (to avoid concerns about empty
 965     // types), all elements after the maximum prefix length and before
 966     // the maximum suffix length are not examined by any variable-length
 967     // pattern, and therefore can be added/removed without affecting
 968     // them - creating equivalent patterns from any sufficiently-large
 969     // length.
 970     //
 971     // Of course, if fixed-length patterns exist, we must be sure
 972     // that our length is large enough to miss them all, so
 973     // we can pick `L = max(FIXED_LEN+1 ∪ {max(PREFIX_LEN) + max(SUFFIX_LEN)})`
 974     //
 975     // for example, with the above pair of patterns, all elements
 976     // but the first and last can be added/removed, so any
 977     // witness of length ≥2 (say, `[false, false, true]`) can be
 978     // turned to a witness from any other length ≥2.
 979
 980     let mut max_prefix_len = 0;
 981     let mut max_suffix_len = 0;
 982     let mut max_fixed_len = 0;
 983
 984     for row in patterns {
 985         match *row.kind {
 986             PatKind::Constant { value } => {
 987                 // extract the length of an array/slice from a constant
 988                 match (value.val, &value.ty.kind) {
 989                     (_, ty::Array(_, n)) => {
 990                         max_fixed_len = cmp::max(max_fixed_len, n.eval_usize(cx.tcx, cx.param_env))
 991                     }
 992                     (ConstValue::Slice { start, end, .. }, ty::Slice(_)) => {
 993                         max_fixed_len = cmp::max(max_fixed_len, (end - start) as u64)
 994                     }
 995                     _ => {}
 996                 }
 997             }
 998             PatKind::Slice { ref prefix, slice: None, ref suffix } => {
 999                 let fixed_len = prefix.len() as u64 + suffix.len() as u64;
1000                 max_fixed_len = cmp::max(max_fixed_len, fixed_len);
1001             }
1002             PatKind::Slice { ref prefix, slice: Some(_), ref suffix } => {
1003                 max_prefix_len = cmp::max(max_prefix_len, prefix.len() as u64);
1004                 max_suffix_len = cmp::max(max_suffix_len, suffix.len() as u64);
1005             }
1006             _ => {}
1007         }
1008     }
1009
1010     cmp::max(max_fixed_len + 1, max_prefix_len + max_suffix_len)
1011 }
1012
1013 /// An inclusive interval, used for precise integer exhaustiveness checking.
1014 /// `IntRange`s always store a contiguous range. This means that values are
1015 /// encoded such that `0` encodes the minimum value for the integer,
1016 /// regardless of the signedness.
1017 /// For example, the pattern `-128..=127i8` is encoded as `0..=255`.
1018 /// This makes comparisons and arithmetic on interval endpoints much more
1019 /// straightforward. See `signed_bias` for details.
1020 ///
1021 /// `IntRange` is never used to encode an empty range or a "range" that wraps
1022 /// around the (offset) space: i.e., `range.lo <= range.hi`.
1023 #[derive(Clone, Debug)]
1024 struct IntRange<'tcx> {
1025     pub range: RangeInclusive<u128>,
1026     pub ty: Ty<'tcx>,
1027     pub span: Span,
1028 }
1029
1030 impl<'tcx> IntRange<'tcx> {
1031     #[inline]
1032     fn is_integral(ty: Ty<'_>) -> bool {
1033         match ty.kind {
1034             ty::Char | ty::Int(_) | ty::Uint(_) => true,
1035             _ => false,
1036         }
1037     }
1038
1039     #[inline]
1040     fn integral_size_and_signed_bias(tcx: TyCtxt<'tcx>, ty: Ty<'_>) -> Option<(Size, u128)> {
1041         match ty.kind {
1042             ty::Char => Some((Size::from_bytes(4), 0)),
1043             ty::Int(ity) => {
1044                 let size = Integer::from_attr(&tcx, SignedInt(ity)).size();
1045                 Some((size, 1u128 << (size.bits() as u128 - 1)))
1046             }
1047             ty::Uint(uty) => Some((Integer::from_attr(&tcx, UnsignedInt(uty)).size(), 0)),
1048             _ => None,
1049         }
1050     }
1051
1052     #[inline]
1053     fn from_const(
1054         tcx: TyCtxt<'tcx>,
1055         param_env: ty::ParamEnv<'tcx>,
1056         value: &Const<'tcx>,
1057         span: Span,
1058     ) -> Option<IntRange<'tcx>> {
1059         if let Some((target_size, bias)) = Self::integral_size_and_signed_bias(tcx, value.ty) {
1060             let ty = value.ty;
1061             let val = if let ConstValue::Scalar(Scalar::Raw { data, size }) = value.val {
1062                 // For this specific pattern we can skip a lot of effort and go
1063                 // straight to the result, after doing a bit of checking. (We
1064                 // could remove this branch and just use the next branch, which
1065                 // is more general but much slower.)
1066                 Scalar::<()>::check_raw(data, size, target_size);
1067                 data
1068             } else if let Some(val) = value.try_eval_bits(tcx, param_env, ty) {
1069                 // This is a more general form of the previous branch.
1070                 val
1071             } else {
1072                 return None;
1073             };
1074             let val = val ^ bias;
1075             Some(IntRange { range: val..=val, ty, span })
1076         } else {
1077             None
1078         }
1079     }
1080
1081     #[inline]
1082     fn from_range(
1083         tcx: TyCtxt<'tcx>,
1084         lo: u128,
1085         hi: u128,
1086         ty: Ty<'tcx>,
1087         end: &RangeEnd,
1088         span: Span,
1089     ) -> Option<IntRange<'tcx>> {
1090         if Self::is_integral(ty) {
1091             // Perform a shift if the underlying types are signed,
1092             // which makes the interval arithmetic simpler.
1093             let bias = IntRange::signed_bias(tcx, ty);
1094             let (lo, hi) = (lo ^ bias, hi ^ bias);
1095             // Make sure the interval is well-formed.
1096             if lo > hi || lo == hi && *end == RangeEnd::Excluded {
1097                 None
1098             } else {
1099                 let offset = (*end == RangeEnd::Excluded) as u128;
1100                 Some(IntRange { range: lo..=(hi - offset), ty, span })
1101             }
1102         } else {
1103             None
1104         }
1105     }
1106
1107     fn from_ctor(
1108         tcx: TyCtxt<'tcx>,
1109         param_env: ty::ParamEnv<'tcx>,
1110         ctor: &Constructor<'tcx>,
1111     ) -> Option<IntRange<'tcx>> {
1112         // Floating-point ranges are permitted and we don't want
1113         // to consider them when constructing integer ranges.
1114         match ctor {
1115             ConstantRange(lo, hi, ty, end, span) => Self::from_range(tcx, *lo, *hi, ty, end, *span),
1116             ConstantValue(val, span) => Self::from_const(tcx, param_env, val, *span),
1117             _ => None,
1118         }
1119     }
1120
1121     fn from_pat(
1122         tcx: TyCtxt<'tcx>,
1123         param_env: ty::ParamEnv<'tcx>,
1124         mut pat: &Pat<'tcx>,
1125     ) -> Option<IntRange<'tcx>> {
1126         loop {
1127             match pat.kind {
1128                 box PatKind::Constant { value } => {
1129                     return Self::from_const(tcx, param_env, value, pat.span);
1130                 }
1131                 box PatKind::Range(PatRange { lo, hi, end }) => {
1132                     return Self::from_range(
1133                         tcx,
1134                         lo.eval_bits(tcx, param_env, lo.ty),
1135                         hi.eval_bits(tcx, param_env, hi.ty),
1136                         &lo.ty,
1137                         &end,
1138                         pat.span,
1139                     );
1140                 }
1141                 box PatKind::AscribeUserType { ref subpattern, .. } => {
1142                     pat = subpattern;
1143                 }
1144                 _ => return None,
1145             }
1146         }
1147     }
1148
1149     // The return value of `signed_bias` should be XORed with an endpoint to encode/decode it.
1150     fn signed_bias(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> u128 {
1151         match ty.kind {
1152             ty::Int(ity) => {
1153                 let bits = Integer::from_attr(&tcx, SignedInt(ity)).size().bits() as u128;
1154                 1u128 << (bits - 1)
1155             }
1156             _ => 0,
1157         }
1158     }
1159
1160     /// Converts a `RangeInclusive` to a `ConstantValue` or inclusive `ConstantRange`.
1161     fn range_to_ctor(
1162         tcx: TyCtxt<'tcx>,
1163         ty: Ty<'tcx>,
1164         r: RangeInclusive<u128>,
1165         span: Span,
1166     ) -> Constructor<'tcx> {
1167         let bias = IntRange::signed_bias(tcx, ty);
1168         let (lo, hi) = r.into_inner();
1169         if lo == hi {
1170             let ty = ty::ParamEnv::empty().and(ty);
1171             ConstantValue(ty::Const::from_bits(tcx, lo ^ bias, ty), span)
1172         } else {
1173             ConstantRange(lo ^ bias, hi ^ bias, ty, RangeEnd::Included, span)
1174         }
1175     }
1176
1177     /// Returns a collection of ranges that spans the values covered by `ranges`, subtracted
1178     /// by the values covered by `self`: i.e., `ranges \ self` (in set notation).
1179     fn subtract_from(
1180         self,
1181         tcx: TyCtxt<'tcx>,
1182         param_env: ty::ParamEnv<'tcx>,
1183         ranges: Vec<Constructor<'tcx>>,
1184     ) -> Vec<Constructor<'tcx>> {
1185         let ranges = ranges
1186             .into_iter()
1187             .filter_map(|r| IntRange::from_ctor(tcx, param_env, &r).map(|i| i.range));
1188         let mut remaining_ranges = vec![];
1189         let ty = self.ty;
1190         let (lo, hi) = self.range.into_inner();
1191         for subrange in ranges {
1192             let (subrange_lo, subrange_hi) = subrange.into_inner();
1193             if lo > subrange_hi || subrange_lo > hi {
1194                 // The pattern doesn't intersect with the subrange at all,
1195                 // so the subrange remains untouched.
1196                 remaining_ranges.push(Self::range_to_ctor(
1197                     tcx,
1198                     ty,
1199                     subrange_lo..=subrange_hi,
1200                     self.span,
1201                 ));
1202             } else {
1203                 if lo > subrange_lo {
1204                     // The pattern intersects an upper section of the
1205                     // subrange, so a lower section will remain.
1206                     remaining_ranges.push(Self::range_to_ctor(
1207                         tcx,
1208                         ty,
1209                         subrange_lo..=(lo - 1),
1210                         self.span,
1211                     ));
1212                 }
1213                 if hi < subrange_hi {
1214                     // The pattern intersects a lower section of the
1215                     // subrange, so an upper section will remain.
1216                     remaining_ranges.push(Self::range_to_ctor(
1217                         tcx,
1218                         ty,
1219                         (hi + 1)..=subrange_hi,
1220                         self.span,
1221                     ));
1222                 }
1223             }
1224         }
1225         remaining_ranges
1226     }
1227
1228     fn intersection(&self, other: &Self) -> Option<Self> {
1229         let ty = self.ty;
1230         let (lo, hi) = (*self.range.start(), *self.range.end());
1231         let (other_lo, other_hi) = (*other.range.start(), *other.range.end());
1232         if lo <= other_hi && other_lo <= hi {
1233             let span = other.span;
1234             Some(IntRange { range: max(lo, other_lo)..=min(hi, other_hi), ty, span })
1235         } else {
1236             None
1237         }
1238     }
1239
1240     fn suspicious_intersection(&self, other: &Self) -> bool {
1241         // `false` in the following cases:
1242         // 1     ----      // 1  ----------   // 1 ----        // 1       ----
1243         // 2  ----------   // 2     ----      // 2       ----  // 2 ----
1244         //
1245         // The following are currently `false`, but could be `true` in the future (#64007):
1246         // 1 ---------       // 1     ---------
1247         // 2     ----------  // 2 ----------
1248         //
1249         // `true` in the following cases:
1250         // 1 -------          // 1       -------
1251         // 2       --------   // 2 -------
1252         let (lo, hi) = (*self.range.start(), *self.range.end());
1253         let (other_lo, other_hi) = (*other.range.start(), *other.range.end());
1254         (lo == other_hi || hi == other_lo)
1255     }
1256 }
1257
1258 type MissingConstructors<'a, 'tcx, F> =
1259     std::iter::FlatMap<std::slice::Iter<'a, Constructor<'tcx>>, Vec<Constructor<'tcx>>, F>;
1260 // Compute a set of constructors equivalent to `all_ctors \ used_ctors`. This
1261 // returns an iterator, so that we only construct the whole set if needed.
1262 fn compute_missing_ctors<'a, 'tcx>(
1263     tcx: TyCtxt<'tcx>,
1264     param_env: ty::ParamEnv<'tcx>,
1265     all_ctors: &'a Vec<Constructor<'tcx>>,
1266     used_ctors: &'a Vec<Constructor<'tcx>>,
1267 ) -> MissingConstructors<'a, 'tcx, impl FnMut(&'a Constructor<'tcx>) -> Vec<Constructor<'tcx>>> {
1268     all_ctors.iter().flat_map(move |req_ctor| {
1269         let mut refined_ctors = vec![req_ctor.clone()];
1270         for used_ctor in used_ctors {
1271             if used_ctor == req_ctor {
1272                 // If a constructor appears in a `match` arm, we can
1273                 // eliminate it straight away.
1274                 refined_ctors = vec![]
1275             } else if let Some(interval) = IntRange::from_ctor(tcx, param_env, used_ctor) {
1276                 // Refine the required constructors for the type by subtracting
1277                 // the range defined by the current constructor pattern.
1278                 refined_ctors = interval.subtract_from(tcx, param_env, refined_ctors);
1279             }
1280
1281             // If the constructor patterns that have been considered so far
1282             // already cover the entire range of values, then we know the
1283             // constructor is not missing, and we can move on to the next one.
1284             if refined_ctors.is_empty() {
1285                 break;
1286             }
1287         }
1288
1289         // If a constructor has not been matched, then it is missing.
1290         // We add `refined_ctors` instead of `req_ctor`, because then we can
1291         // provide more detailed error information about precisely which
1292         // ranges have been omitted.
1293         refined_ctors
1294     })
1295 }
1296
1297 /// Algorithm from http://moscova.inria.fr/~maranget/papers/warn/index.html.
1298 /// The algorithm from the paper has been modified to correctly handle empty
1299 /// types. The changes are:
1300 ///   (0) We don't exit early if the pattern matrix has zero rows. We just
1301 ///       continue to recurse over columns.
1302 ///   (1) all_constructors will only return constructors that are statically
1303 ///       possible. E.g., it will only return `Ok` for `Result<T, !>`.
1304 ///
1305 /// This finds whether a (row) vector `v` of patterns is 'useful' in relation
1306 /// to a set of such vectors `m` - this is defined as there being a set of
1307 /// inputs that will match `v` but not any of the sets in `m`.
1308 ///
1309 /// All the patterns at each column of the `matrix ++ v` matrix must
1310 /// have the same type, except that wildcard (PatKind::Wild) patterns
1311 /// with type `TyErr` are also allowed, even if the "type of the column"
1312 /// is not `TyErr`. That is used to represent private fields, as using their
1313 /// real type would assert that they are inhabited.
1314 ///
1315 /// This is used both for reachability checking (if a pattern isn't useful in
1316 /// relation to preceding patterns, it is not reachable) and exhaustiveness
1317 /// checking (if a wildcard pattern is useful in relation to a matrix, the
1318 /// matrix isn't exhaustive).
1319 pub fn is_useful<'p, 'a, 'tcx>(
1320     cx: &mut MatchCheckCtxt<'a, 'tcx>,
1321     matrix: &Matrix<'p, 'tcx>,
1322     v: &PatStack<'_, 'tcx>,
1323     witness: WitnessPreference,
1324     hir_id: HirId,
1325 ) -> Usefulness<'tcx> {
1326     let &Matrix(ref rows) = matrix;
1327     debug!("is_useful({:#?}, {:#?})", matrix, v);
1328
1329     // The base case. We are pattern-matching on () and the return value is
1330     // based on whether our matrix has a row or not.
1331     // NOTE: This could potentially be optimized by checking rows.is_empty()
1332     // first and then, if v is non-empty, the return value is based on whether
1333     // the type of the tuple we're checking is inhabited or not.
1334     if v.is_empty() {
1335         return if rows.is_empty() {
1336             match witness {
1337                 ConstructWitness => UsefulWithWitness(vec![Witness(vec![])]),
1338                 LeaveOutWitness => Useful,
1339             }
1340         } else {
1341             NotUseful
1342         };
1343     };
1344
1345     assert!(rows.iter().all(|r| r.len() == v.len()));
1346
1347     let (ty, span) = matrix
1348         .heads()
1349         .map(|r| (r.ty, r.span))
1350         .find(|(ty, _)| !ty.references_error())
1351         .unwrap_or((v.head().ty, v.head().span));
1352     let pcx = PatCtxt {
1353         // TyErr is used to represent the type of wildcard patterns matching
1354         // against inaccessible (private) fields of structs, so that we won't
1355         // be able to observe whether the types of the struct's fields are
1356         // inhabited.
1357         //
1358         // If the field is truly inaccessible, then all the patterns
1359         // matching against it must be wildcard patterns, so its type
1360         // does not matter.
1361         //
1362         // However, if we are matching against non-wildcard patterns, we
1363         // need to know the real type of the field so we can specialize
1364         // against it. This primarily occurs through constants - they
1365         // can include contents for fields that are inaccessible at the
1366         // location of the match. In that case, the field's type is
1367         // inhabited - by the constant - so we can just use it.
1368         //
1369         // FIXME: this might lead to "unstable" behavior with macro hygiene
1370         // introducing uninhabited patterns for inaccessible fields. We
1371         // need to figure out how to model that.
1372         ty,
1373         max_slice_length: max_slice_length(cx, matrix.heads().chain(Some(v.head()))),
1374         span,
1375     };
1376
1377     debug!("is_useful_expand_first_col: pcx={:#?}, expanding {:#?}", pcx, v.head());
1378
1379     if let Some(constructors) = pat_constructors(cx, v.head(), pcx) {
1380         debug!("is_useful - expanding constructors: {:#?}", constructors);
1381         split_grouped_constructors(
1382             cx.tcx,
1383             cx.param_env,
1384             constructors,
1385             matrix,
1386             pcx.ty,
1387             pcx.span,
1388             Some(hir_id),
1389         )
1390         .into_iter()
1391         .map(|c| is_useful_specialized(cx, matrix, v, c, pcx.ty, witness, hir_id))
1392         .find(|result| result.is_useful())
1393         .unwrap_or(NotUseful)
1394     } else {
1395         debug!("is_useful - expanding wildcard");
1396
1397         let used_ctors: Vec<Constructor<'_>> =
1398             matrix.heads().flat_map(|p| pat_constructors(cx, p, pcx).unwrap_or(vec![])).collect();
1399         debug!("used_ctors = {:#?}", used_ctors);
1400         // `all_ctors` are all the constructors for the given type, which
1401         // should all be represented (or caught with the wild pattern `_`).
1402         let all_ctors = all_constructors(cx, pcx);
1403         debug!("all_ctors = {:#?}", all_ctors);
1404
1405         // `missing_ctors` is the set of constructors from the same type as the
1406         // first column of `matrix` that are matched only by wildcard patterns
1407         // from the first column.
1408         //
1409         // Therefore, if there is some pattern that is unmatched by `matrix`,
1410         // it will still be unmatched if the first constructor is replaced by
1411         // any of the constructors in `missing_ctors`
1412         //
1413         // However, if our scrutinee is *privately* an empty enum, we
1414         // must treat it as though it had an "unknown" constructor (in
1415         // that case, all other patterns obviously can't be variants)
1416         // to avoid exposing its emptyness. See the `match_privately_empty`
1417         // test for details.
1418         //
1419         // FIXME: currently the only way I know of something can
1420         // be a privately-empty enum is when the exhaustive_patterns
1421         // feature flag is not present, so this is only
1422         // needed for that case.
1423
1424         // Missing constructors are those that are not matched by any
1425         // non-wildcard patterns in the current column. To determine if
1426         // the set is empty, we can check that `.peek().is_none()`, so
1427         // we only fully construct them on-demand, because they're rarely used and can be big.
1428         let mut missing_ctors =
1429             compute_missing_ctors(cx.tcx, cx.param_env, &all_ctors, &used_ctors).peekable();
1430
1431         let is_privately_empty = all_ctors.is_empty() && !cx.is_uninhabited(pcx.ty);
1432         let is_declared_nonexhaustive = cx.is_non_exhaustive_enum(pcx.ty) && !cx.is_local(pcx.ty);
1433         debug!(
1434             "missing_ctors.empty()={:#?} is_privately_empty={:#?} is_declared_nonexhaustive={:#?}",
1435             missing_ctors.peek().is_none(),
1436             is_privately_empty,
1437             is_declared_nonexhaustive
1438         );
1439
1440         // For privately empty and non-exhaustive enums, we work as if there were an "extra"
1441         // `_` constructor for the type, so we can never match over all constructors.
1442         let is_non_exhaustive = is_privately_empty
1443             || is_declared_nonexhaustive
1444             || (pcx.ty.is_ptr_sized_integral() && !cx.tcx.features().precise_pointer_size_matching);
1445
1446         if missing_ctors.peek().is_none() && !is_non_exhaustive {
1447             drop(missing_ctors); // It was borrowing `all_ctors`, which we want to move.
1448             split_grouped_constructors(
1449                 cx.tcx,
1450                 cx.param_env,
1451                 all_ctors,
1452                 matrix,
1453                 pcx.ty,
1454                 DUMMY_SP,
1455                 None,
1456             )
1457             .into_iter()
1458             .map(|c| is_useful_specialized(cx, matrix, v, c, pcx.ty, witness, hir_id))
1459             .find(|result| result.is_useful())
1460             .unwrap_or(NotUseful)
1461         } else {
1462             let matrix = matrix.specialize_wildcard();
1463             let v = v.to_tail();
1464             match is_useful(cx, &matrix, &v, witness, hir_id) {
1465                 UsefulWithWitness(pats) => {
1466                     let cx = &*cx;
1467                     // In this case, there's at least one "free"
1468                     // constructor that is only matched against by
1469                     // wildcard patterns.
1470                     //
1471                     // There are 2 ways we can report a witness here.
1472                     // Commonly, we can report all the "free"
1473                     // constructors as witnesses, e.g., if we have:
1474                     //
1475                     // ```
1476                     //     enum Direction { N, S, E, W }
1477                     //     let Direction::N = ...;
1478                     // ```
1479                     //
1480                     // we can report 3 witnesses: `S`, `E`, and `W`.
1481                     //
1482                     // However, there are 2 cases where we don't want
1483                     // to do this and instead report a single `_` witness:
1484                     //
1485                     // 1) If the user is matching against a non-exhaustive
1486                     // enum, there is no point in enumerating all possible
1487                     // variants, because the user can't actually match
1488                     // against them himself, e.g., in an example like:
1489                     // ```
1490                     //     let err: io::ErrorKind = ...;
1491                     //     match err {
1492                     //         io::ErrorKind::NotFound => {},
1493                     //     }
1494                     // ```
1495                     // we don't want to show every possible IO error,
1496                     // but instead have `_` as the witness (this is
1497                     // actually *required* if the user specified *all*
1498                     // IO errors, but is probably what we want in every
1499                     // case).
1500                     //
1501                     // 2) If the user didn't actually specify a constructor
1502                     // in this arm, e.g., in
1503                     // ```
1504                     //     let x: (Direction, Direction, bool) = ...;
1505                     //     let (_, _, false) = x;
1506                     // ```
1507                     // we don't want to show all 16 possible witnesses
1508                     // `(<direction-1>, <direction-2>, true)` - we are
1509                     // satisfied with `(_, _, true)`. In this case,
1510                     // `used_ctors` is empty.
1511                     let new_witnesses = if is_non_exhaustive || used_ctors.is_empty() {
1512                         // All constructors are unused. Add wild patterns
1513                         // rather than each individual constructor.
1514                         pats.into_iter()
1515                             .map(|mut witness| {
1516                                 witness.0.push(Pat {
1517                                     ty: pcx.ty,
1518                                     span: DUMMY_SP,
1519                                     kind: box PatKind::Wild,
1520                                 });
1521                                 witness
1522                             })
1523                             .collect()
1524                     } else {
1525                         let missing_ctors: Vec<_> = missing_ctors.collect();
1526                         pats.into_iter()
1527                             .flat_map(|witness| {
1528                                 missing_ctors.iter().map(move |ctor| {
1529                                     // Extends the witness with a "wild" version of this
1530                                     // constructor, that matches everything that can be built with
1531                                     // it. For example, if `ctor` is a `Constructor::Variant` for
1532                                     // `Option::Some`, this pushes the witness for `Some(_)`.
1533                                     witness.clone().push_wild_constructor(cx, ctor, pcx.ty)
1534                                 })
1535                             })
1536                             .collect()
1537                     };
1538                     UsefulWithWitness(new_witnesses)
1539                 }
1540                 result => result,
1541             }
1542         }
1543     }
1544 }
1545
1546 /// A shorthand for the `U(S(c, P), S(c, q))` operation from the paper. I.e., `is_useful` applied
1547 /// to the specialised version of both the pattern matrix `P` and the new pattern `q`.
1548 fn is_useful_specialized<'p, 'a, 'tcx>(
1549     cx: &mut MatchCheckCtxt<'a, 'tcx>,
1550     matrix: &Matrix<'p, 'tcx>,
1551     v: &PatStack<'_, 'tcx>,
1552     ctor: Constructor<'tcx>,
1553     lty: Ty<'tcx>,
1554     witness: WitnessPreference,
1555     hir_id: HirId,
1556 ) -> Usefulness<'tcx> {
1557     debug!("is_useful_specialized({:#?}, {:#?}, {:?})", v, ctor, lty);
1558
1559     let wild_patterns_owned = ctor.wildcard_subpatterns(cx, lty);
1560     let wild_patterns: Vec<_> = wild_patterns_owned.iter().collect();
1561     let matrix = matrix.specialize_constructor(cx, &ctor, &wild_patterns);
1562     match v.specialize_constructor(cx, &ctor, &wild_patterns) {
1563         Some(v) => match is_useful(cx, &matrix, &v, witness, hir_id) {
1564             UsefulWithWitness(witnesses) => UsefulWithWitness(
1565                 witnesses
1566                     .into_iter()
1567                     .map(|witness| witness.apply_constructor(cx, &ctor, lty))
1568                     .collect(),
1569             ),
1570             result => result,
1571         },
1572         None => NotUseful,
1573     }
1574 }
1575
1576 /// Determines the constructors that the given pattern can be specialized to.
1577 ///
1578 /// In most cases, there's only one constructor that a specific pattern
1579 /// represents, such as a specific enum variant or a specific literal value.
1580 /// Slice patterns, however, can match slices of different lengths. For instance,
1581 /// `[a, b, tail @ ..]` can match a slice of length 2, 3, 4 and so on.
1582 ///
1583 /// Returns `None` in case of a catch-all, which can't be specialized.
1584 fn pat_constructors<'tcx>(
1585     cx: &mut MatchCheckCtxt<'_, 'tcx>,
1586     pat: &Pat<'tcx>,
1587     pcx: PatCtxt<'tcx>,
1588 ) -> Option<Vec<Constructor<'tcx>>> {
1589     match *pat.kind {
1590         PatKind::AscribeUserType { ref subpattern, .. } => pat_constructors(cx, subpattern, pcx),
1591         PatKind::Binding { .. } | PatKind::Wild => None,
1592         PatKind::Leaf { .. } | PatKind::Deref { .. } => Some(vec![Single]),
1593         PatKind::Variant { adt_def, variant_index, .. } => {
1594             Some(vec![Variant(adt_def.variants[variant_index].def_id)])
1595         }
1596         PatKind::Constant { value } => Some(vec![ConstantValue(value, pat.span)]),
1597         PatKind::Range(PatRange { lo, hi, end }) => Some(vec![ConstantRange(
1598             lo.eval_bits(cx.tcx, cx.param_env, lo.ty),
1599             hi.eval_bits(cx.tcx, cx.param_env, hi.ty),
1600             lo.ty,
1601             end,
1602             pat.span,
1603         )]),
1604         PatKind::Array { .. } => match pcx.ty.kind {
1605             ty::Array(_, length) => Some(vec![Slice(length.eval_usize(cx.tcx, cx.param_env))]),
1606             _ => span_bug!(pat.span, "bad ty {:?} for array pattern", pcx.ty),
1607         },
1608         PatKind::Slice { ref prefix, ref slice, ref suffix } => {
1609             let pat_len = prefix.len() as u64 + suffix.len() as u64;
1610             if slice.is_some() {
1611                 Some((pat_len..pcx.max_slice_length + 1).map(Slice).collect())
1612             } else {
1613                 Some(vec![Slice(pat_len)])
1614             }
1615         }
1616         PatKind::Or { .. } => {
1617             bug!("support for or-patterns has not been fully implemented yet.");
1618         }
1619     }
1620 }
1621
1622 /// This computes the types of the sub patterns that a constructor should be
1623 /// expanded to.
1624 ///
1625 /// For instance, a tuple pattern (43u32, 'a') has sub pattern types [u32, char].
1626 fn constructor_sub_pattern_tys<'a, 'tcx>(
1627     cx: &MatchCheckCtxt<'a, 'tcx>,
1628     ctor: &Constructor<'tcx>,
1629     ty: Ty<'tcx>,
1630 ) -> Vec<Ty<'tcx>> {
1631     debug!("constructor_sub_pattern_tys({:#?}, {:?})", ctor, ty);
1632     match ty.kind {
1633         ty::Tuple(ref fs) => fs.into_iter().map(|t| t.expect_ty()).collect(),
1634         ty::Slice(ty) | ty::Array(ty, _) => match *ctor {
1635             Slice(length) => (0..length).map(|_| ty).collect(),
1636             ConstantValue(..) => vec![],
1637             _ => bug!("bad slice pattern {:?} {:?}", ctor, ty),
1638         },
1639         ty::Ref(_, rty, _) => vec![rty],
1640         ty::Adt(adt, substs) => {
1641             if adt.is_box() {
1642                 // Use T as the sub pattern type of Box<T>.
1643                 vec![substs.type_at(0)]
1644             } else {
1645                 let variant = &adt.variants[ctor.variant_index_for_adt(cx, adt)];
1646                 let is_non_exhaustive = variant.is_field_list_non_exhaustive() && !cx.is_local(ty);
1647                 variant
1648                     .fields
1649                     .iter()
1650                     .map(|field| {
1651                         let is_visible =
1652                             adt.is_enum() || field.vis.is_accessible_from(cx.module, cx.tcx);
1653                         let is_uninhabited = cx.is_uninhabited(field.ty(cx.tcx, substs));
1654                         match (is_visible, is_non_exhaustive, is_uninhabited) {
1655                             // Treat all uninhabited types in non-exhaustive variants as `TyErr`.
1656                             (_, true, true) => cx.tcx.types.err,
1657                             // Treat all non-visible fields as `TyErr`. They can't appear in any
1658                             // other pattern from this match (because they are private), so their
1659                             // type does not matter - but we don't want to know they are
1660                             // uninhabited.
1661                             (false, ..) => cx.tcx.types.err,
1662                             (true, ..) => {
1663                                 let ty = field.ty(cx.tcx, substs);
1664                                 match ty.kind {
1665                                     // If the field type returned is an array of an unknown size
1666                                     // return an TyErr.
1667                                     ty::Array(_, len)
1668                                         if len.try_eval_usize(cx.tcx, cx.param_env).is_none() =>
1669                                     {
1670                                         cx.tcx.types.err
1671                                     }
1672                                     _ => ty,
1673                                 }
1674                             }
1675                         }
1676                     })
1677                     .collect()
1678             }
1679         }
1680         _ => vec![],
1681     }
1682 }
1683
1684 // checks whether a constant is equal to a user-written slice pattern. Only supports byte slices,
1685 // meaning all other types will compare unequal and thus equal patterns often do not cause the
1686 // second pattern to lint about unreachable match arms.
1687 fn slice_pat_covered_by_const<'tcx>(
1688     tcx: TyCtxt<'tcx>,
1689     _span: Span,
1690     const_val: &'tcx ty::Const<'tcx>,
1691     prefix: &[Pat<'tcx>],
1692     slice: &Option<Pat<'tcx>>,
1693     suffix: &[Pat<'tcx>],
1694     param_env: ty::ParamEnv<'tcx>,
1695 ) -> Result<bool, ErrorReported> {
1696     let data: &[u8] = match (const_val.val, &const_val.ty.kind) {
1697         (ConstValue::ByRef { offset, alloc, .. }, ty::Array(t, n)) => {
1698             assert_eq!(*t, tcx.types.u8);
1699             let n = n.eval_usize(tcx, param_env);
1700             let ptr = Pointer::new(AllocId(0), offset);
1701             alloc.get_bytes(&tcx, ptr, Size::from_bytes(n)).unwrap()
1702         }
1703         (ConstValue::Slice { data, start, end }, ty::Slice(t)) => {
1704             assert_eq!(*t, tcx.types.u8);
1705             let ptr = Pointer::new(AllocId(0), Size::from_bytes(start as u64));
1706             data.get_bytes(&tcx, ptr, Size::from_bytes((end - start) as u64)).unwrap()
1707         }
1708         // FIXME(oli-obk): create a way to extract fat pointers from ByRef
1709         (_, ty::Slice(_)) => return Ok(false),
1710         _ => bug!(
1711             "slice_pat_covered_by_const: {:#?}, {:#?}, {:#?}, {:#?}",
1712             const_val,
1713             prefix,
1714             slice,
1715             suffix,
1716         ),
1717     };
1718
1719     let pat_len = prefix.len() + suffix.len();
1720     if data.len() < pat_len || (slice.is_none() && data.len() > pat_len) {
1721         return Ok(false);
1722     }
1723
1724     for (ch, pat) in data[..prefix.len()]
1725         .iter()
1726         .zip(prefix)
1727         .chain(data[data.len() - suffix.len()..].iter().zip(suffix))
1728     {
1729         match pat.kind {
1730             box PatKind::Constant { value } => {
1731                 let b = value.eval_bits(tcx, param_env, pat.ty);
1732                 assert_eq!(b as u8 as u128, b);
1733                 if b as u8 != *ch {
1734                     return Ok(false);
1735                 }
1736             }
1737             _ => {}
1738         }
1739     }
1740
1741     Ok(true)
1742 }
1743
1744 // Whether to evaluate a constructor using exhaustive integer matching. This is true if the
1745 // constructor is a range or constant with an integer type.
1746 fn should_treat_range_exhaustively(tcx: TyCtxt<'tcx>, ctor: &Constructor<'tcx>) -> bool {
1747     let ty = match ctor {
1748         ConstantValue(value, _) => value.ty,
1749         ConstantRange(_, _, ty, _, _) => ty,
1750         _ => return false,
1751     };
1752     if let ty::Char | ty::Int(_) | ty::Uint(_) = ty.kind {
1753         !ty.is_ptr_sized_integral() || tcx.features().precise_pointer_size_matching
1754     } else {
1755         false
1756     }
1757 }
1758
1759 /// For exhaustive integer matching, some constructors are grouped within other constructors
1760 /// (namely integer typed values are grouped within ranges). However, when specialising these
1761 /// constructors, we want to be specialising for the underlying constructors (the integers), not
1762 /// the groups (the ranges). Thus we need to split the groups up. Splitting them up naïvely would
1763 /// mean creating a separate constructor for every single value in the range, which is clearly
1764 /// impractical. However, observe that for some ranges of integers, the specialisation will be
1765 /// identical across all values in that range (i.e., there are equivalence classes of ranges of
1766 /// constructors based on their `is_useful_specialized` outcome). These classes are grouped by
1767 /// the patterns that apply to them (in the matrix `P`). We can split the range whenever the
1768 /// patterns that apply to that range (specifically: the patterns that *intersect* with that range)
1769 /// change.
1770 /// Our solution, therefore, is to split the range constructor into subranges at every single point
1771 /// the group of intersecting patterns changes (using the method described below).
1772 /// And voilà! We're testing precisely those ranges that we need to, without any exhaustive matching
1773 /// on actual integers. The nice thing about this is that the number of subranges is linear in the
1774 /// number of rows in the matrix (i.e., the number of cases in the `match` statement), so we don't
1775 /// need to be worried about matching over gargantuan ranges.
1776 ///
1777 /// Essentially, given the first column of a matrix representing ranges, looking like the following:
1778 ///
1779 /// |------|  |----------| |-------|    ||
1780 ///    |-------| |-------|            |----| ||
1781 ///       |---------|
1782 ///
1783 /// We split the ranges up into equivalence classes so the ranges are no longer overlapping:
1784 ///
1785 /// |--|--|||-||||--||---|||-------|  |-|||| ||
1786 ///
1787 /// The logic for determining how to split the ranges is fairly straightforward: we calculate
1788 /// boundaries for each interval range, sort them, then create constructors for each new interval
1789 /// between every pair of boundary points. (This essentially sums up to performing the intuitive
1790 /// merging operation depicted above.)
1791 ///
1792 /// `hir_id` is `None` when we're evaluating the wildcard pattern, do not lint for overlapping in
1793 /// ranges that case.
1794 fn split_grouped_constructors<'p, 'tcx>(
1795     tcx: TyCtxt<'tcx>,
1796     param_env: ty::ParamEnv<'tcx>,
1797     ctors: Vec<Constructor<'tcx>>,
1798     matrix: &Matrix<'p, 'tcx>,
1799     ty: Ty<'tcx>,
1800     span: Span,
1801     hir_id: Option<HirId>,
1802 ) -> Vec<Constructor<'tcx>> {
1803     let mut split_ctors = Vec::with_capacity(ctors.len());
1804
1805     for ctor in ctors.into_iter() {
1806         match ctor {
1807             // For now, only ranges may denote groups of "subconstructors", so we only need to
1808             // special-case constant ranges.
1809             ConstantRange(..) if should_treat_range_exhaustively(tcx, &ctor) => {
1810                 // We only care about finding all the subranges within the range of the constructor
1811                 // range. Anything else is irrelevant, because it is guaranteed to result in
1812                 // `NotUseful`, which is the default case anyway, and can be ignored.
1813                 let ctor_range = IntRange::from_ctor(tcx, param_env, &ctor).unwrap();
1814
1815                 /// Represents a border between 2 integers. Because the intervals spanning borders
1816                 /// must be able to cover every integer, we need to be able to represent
1817                 /// 2^128 + 1 such borders.
1818                 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
1819                 enum Border {
1820                     JustBefore(u128),
1821                     AfterMax,
1822                 }
1823
1824                 // A function for extracting the borders of an integer interval.
1825                 fn range_borders(r: IntRange<'_>) -> impl Iterator<Item = Border> {
1826                     let (lo, hi) = r.range.into_inner();
1827                     let from = Border::JustBefore(lo);
1828                     let to = match hi.checked_add(1) {
1829                         Some(m) => Border::JustBefore(m),
1830                         None => Border::AfterMax,
1831                     };
1832                     vec![from, to].into_iter()
1833                 }
1834
1835                 // Collect the span and range of all the intersecting ranges to lint on likely
1836                 // incorrect range patterns. (#63987)
1837                 let mut overlaps = vec![];
1838                 // `borders` is the set of borders between equivalence classes: each equivalence
1839                 // class lies between 2 borders.
1840                 let row_borders = matrix
1841                     .0
1842                     .iter()
1843                     .flat_map(|row| {
1844                         IntRange::from_pat(tcx, param_env, row.head()).map(|r| (r, row.len()))
1845                     })
1846                     .flat_map(|(range, row_len)| {
1847                         let intersection = ctor_range.intersection(&range);
1848                         let should_lint = ctor_range.suspicious_intersection(&range);
1849                         if let (Some(range), 1, true) = (&intersection, row_len, should_lint) {
1850                             // FIXME: for now, only check for overlapping ranges on simple range
1851                             // patterns. Otherwise with the current logic the following is detected
1852                             // as overlapping:
1853                             //   match (10u8, true) {
1854                             //    (0 ..= 125, false) => {}
1855                             //    (126 ..= 255, false) => {}
1856                             //    (0 ..= 255, true) => {}
1857                             //  }
1858                             overlaps.push(range.clone());
1859                         }
1860                         intersection
1861                     })
1862                     .flat_map(|range| range_borders(range));
1863                 let ctor_borders = range_borders(ctor_range.clone());
1864                 let mut borders: Vec<_> = row_borders.chain(ctor_borders).collect();
1865                 borders.sort_unstable();
1866
1867                 lint_overlapping_patterns(tcx, hir_id, ctor_range, ty, overlaps);
1868
1869                 // We're going to iterate through every pair of borders, making sure that each
1870                 // represents an interval of nonnegative length, and convert each such interval
1871                 // into a constructor.
1872                 for IntRange { range, .. } in
1873                     borders.windows(2).filter_map(|window| match (window[0], window[1]) {
1874                         (Border::JustBefore(n), Border::JustBefore(m)) => {
1875                             if n < m {
1876                                 Some(IntRange { range: n..=(m - 1), ty, span })
1877                             } else {
1878                                 None
1879                             }
1880                         }
1881                         (Border::JustBefore(n), Border::AfterMax) => {
1882                             Some(IntRange { range: n..=u128::MAX, ty, span })
1883                         }
1884                         (Border::AfterMax, _) => None,
1885                     })
1886                 {
1887                     split_ctors.push(IntRange::range_to_ctor(tcx, ty, range, span));
1888                 }
1889             }
1890             // Any other constructor can be used unchanged.
1891             _ => split_ctors.push(ctor),
1892         }
1893     }
1894
1895     split_ctors
1896 }
1897
1898 fn lint_overlapping_patterns(
1899     tcx: TyCtxt<'tcx>,
1900     hir_id: Option<HirId>,
1901     ctor_range: IntRange<'tcx>,
1902     ty: Ty<'tcx>,
1903     overlaps: Vec<IntRange<'tcx>>,
1904 ) {
1905     if let (true, Some(hir_id)) = (!overlaps.is_empty(), hir_id) {
1906         let mut err = tcx.struct_span_lint_hir(
1907             lint::builtin::OVERLAPPING_PATTERNS,
1908             hir_id,
1909             ctor_range.span,
1910             "multiple patterns covering the same range",
1911         );
1912         err.span_label(ctor_range.span, "overlapping patterns");
1913         for int_range in overlaps {
1914             // Use the real type for user display of the ranges:
1915             err.span_label(
1916                 int_range.span,
1917                 &format!(
1918                     "this range overlaps on `{}`",
1919                     IntRange::range_to_ctor(tcx, ty, int_range.range, DUMMY_SP).display(tcx),
1920                 ),
1921             );
1922         }
1923         err.emit();
1924     }
1925 }
1926
1927 fn constructor_covered_by_range<'tcx>(
1928     tcx: TyCtxt<'tcx>,
1929     param_env: ty::ParamEnv<'tcx>,
1930     ctor: &Constructor<'tcx>,
1931     pat: &Pat<'tcx>,
1932 ) -> Result<bool, ErrorReported> {
1933     let (from, to, end, ty) = match pat.kind {
1934         box PatKind::Constant { value } => (value, value, RangeEnd::Included, value.ty),
1935         box PatKind::Range(PatRange { lo, hi, end }) => (lo, hi, end, lo.ty),
1936         _ => bug!("`constructor_covered_by_range` called with {:?}", pat),
1937     };
1938     trace!("constructor_covered_by_range {:#?}, {:#?}, {:#?}, {}", ctor, from, to, ty);
1939     let cmp_from = |c_from| {
1940         compare_const_vals(tcx, c_from, from, param_env, ty).map(|res| res != Ordering::Less)
1941     };
1942     let cmp_to = |c_to| compare_const_vals(tcx, c_to, to, param_env, ty);
1943     macro_rules! some_or_ok {
1944         ($e:expr) => {
1945             match $e {
1946                 Some(to) => to,
1947                 None => return Ok(false), // not char or int
1948             }
1949         };
1950     }
1951     match *ctor {
1952         ConstantValue(value, _) => {
1953             let to = some_or_ok!(cmp_to(value));
1954             let end =
1955                 (to == Ordering::Less) || (end == RangeEnd::Included && to == Ordering::Equal);
1956             Ok(some_or_ok!(cmp_from(value)) && end)
1957         }
1958         ConstantRange(from, to, ty, RangeEnd::Included, _) => {
1959             let to =
1960                 some_or_ok!(cmp_to(ty::Const::from_bits(tcx, to, ty::ParamEnv::empty().and(ty),)));
1961             let end =
1962                 (to == Ordering::Less) || (end == RangeEnd::Included && to == Ordering::Equal);
1963             Ok(some_or_ok!(cmp_from(ty::Const::from_bits(
1964                 tcx,
1965                 from,
1966                 ty::ParamEnv::empty().and(ty),
1967             ))) && end)
1968         }
1969         ConstantRange(from, to, ty, RangeEnd::Excluded, _) => {
1970             let to =
1971                 some_or_ok!(cmp_to(ty::Const::from_bits(tcx, to, ty::ParamEnv::empty().and(ty))));
1972             let end =
1973                 (to == Ordering::Less) || (end == RangeEnd::Excluded && to == Ordering::Equal);
1974             Ok(some_or_ok!(cmp_from(ty::Const::from_bits(
1975                 tcx,
1976                 from,
1977                 ty::ParamEnv::empty().and(ty)
1978             ))) && end)
1979         }
1980         Single => Ok(true),
1981         _ => bug!(),
1982     }
1983 }
1984
1985 fn patterns_for_variant<'p, 'a: 'p, 'tcx>(
1986     cx: &mut MatchCheckCtxt<'a, 'tcx>,
1987     subpatterns: &'p [FieldPat<'tcx>],
1988     wild_patterns: &[&'p Pat<'tcx>],
1989     is_non_exhaustive: bool,
1990 ) -> PatStack<'p, 'tcx> {
1991     let mut result = SmallVec::from_slice(wild_patterns);
1992
1993     for subpat in subpatterns {
1994         if !is_non_exhaustive || !cx.is_uninhabited(subpat.pattern.ty) {
1995             result[subpat.field.index()] = &subpat.pattern;
1996         }
1997     }
1998
1999     debug!("patterns_for_variant({:#?}, {:#?}) = {:#?}", subpatterns, wild_patterns, result);
2000     PatStack::from_vec(result)
2001 }
2002
2003 /// This is the main specialization step. It expands the first pattern in the given row
2004 /// into `arity` patterns based on the constructor. For most patterns, the step is trivial,
2005 /// for instance tuple patterns are flattened and box patterns expand into their inner pattern.
2006 ///
2007 /// OTOH, slice patterns with a subslice pattern (tail @ ..) can be expanded into multiple
2008 /// different patterns.
2009 /// Structure patterns with a partial wild pattern (Foo { a: 42, .. }) have their missing
2010 /// fields filled with wild patterns.
2011 fn specialize<'p, 'a: 'p, 'q: 'p, 'tcx>(
2012     cx: &mut MatchCheckCtxt<'a, 'tcx>,
2013     r: &PatStack<'q, 'tcx>,
2014     constructor: &Constructor<'tcx>,
2015     wild_patterns: &[&'p Pat<'tcx>],
2016 ) -> Option<PatStack<'p, 'tcx>> {
2017     let pat = r.head();
2018
2019     let new_head = match *pat.kind {
2020         PatKind::AscribeUserType { ref subpattern, .. } => {
2021             specialize(cx, &PatStack::from_pattern(subpattern), constructor, wild_patterns)
2022         }
2023
2024         PatKind::Binding { .. } | PatKind::Wild => Some(PatStack::from_slice(wild_patterns)),
2025
2026         PatKind::Variant { adt_def, variant_index, ref subpatterns, .. } => {
2027             let ref variant = adt_def.variants[variant_index];
2028             let is_non_exhaustive = variant.is_field_list_non_exhaustive() && !cx.is_local(pat.ty);
2029             Some(Variant(variant.def_id))
2030                 .filter(|variant_constructor| variant_constructor == constructor)
2031                 .map(|_| patterns_for_variant(cx, subpatterns, wild_patterns, is_non_exhaustive))
2032         }
2033
2034         PatKind::Leaf { ref subpatterns } => {
2035             Some(patterns_for_variant(cx, subpatterns, wild_patterns, false))
2036         }
2037
2038         PatKind::Deref { ref subpattern } => Some(PatStack::from_pattern(subpattern)),
2039
2040         PatKind::Constant { value } if constructor.is_slice() => {
2041             // We extract an `Option` for the pointer because slices of zero
2042             // elements don't necessarily point to memory, they are usually
2043             // just integers. The only time they should be pointing to memory
2044             // is when they are subslices of nonzero slices.
2045             let (alloc, offset, n, ty) = match value.ty.kind {
2046                 ty::Array(t, n) => match value.val {
2047                     ConstValue::ByRef { offset, alloc, .. } => {
2048                         (alloc, offset, n.eval_usize(cx.tcx, cx.param_env), t)
2049                     }
2050                     _ => span_bug!(pat.span, "array pattern is {:?}", value,),
2051                 },
2052                 ty::Slice(t) => {
2053                     match value.val {
2054                         ConstValue::Slice { data, start, end } => {
2055                             (data, Size::from_bytes(start as u64), (end - start) as u64, t)
2056                         }
2057                         ConstValue::ByRef { .. } => {
2058                             // FIXME(oli-obk): implement `deref` for `ConstValue`
2059                             return None;
2060                         }
2061                         _ => span_bug!(
2062                             pat.span,
2063                             "slice pattern constant must be scalar pair but is {:?}",
2064                             value,
2065                         ),
2066                     }
2067                 }
2068                 _ => span_bug!(
2069                     pat.span,
2070                     "unexpected const-val {:?} with ctor {:?}",
2071                     value,
2072                     constructor,
2073                 ),
2074             };
2075             if wild_patterns.len() as u64 == n {
2076                 // convert a constant slice/array pattern to a list of patterns.
2077                 let layout = cx.tcx.layout_of(cx.param_env.and(ty)).ok()?;
2078                 let ptr = Pointer::new(AllocId(0), offset);
2079                 (0..n)
2080                     .map(|i| {
2081                         let ptr = ptr.offset(layout.size * i, &cx.tcx).ok()?;
2082                         let scalar = alloc.read_scalar(&cx.tcx, ptr, layout.size).ok()?;
2083                         let scalar = scalar.not_undef().ok()?;
2084                         let value = ty::Const::from_scalar(cx.tcx, scalar, ty);
2085                         let pattern =
2086                             Pat { ty, span: pat.span, kind: box PatKind::Constant { value } };
2087                         Some(&*cx.pattern_arena.alloc(pattern))
2088                     })
2089                     .collect()
2090             } else {
2091                 None
2092             }
2093         }
2094
2095         PatKind::Constant { .. } | PatKind::Range { .. } => {
2096             // If the constructor is a:
2097             // - Single value: add a row if the pattern contains the constructor.
2098             // - Range: add a row if the constructor intersects the pattern.
2099             if should_treat_range_exhaustively(cx.tcx, constructor) {
2100                 match (
2101                     IntRange::from_ctor(cx.tcx, cx.param_env, constructor),
2102                     IntRange::from_pat(cx.tcx, cx.param_env, pat),
2103                 ) {
2104                     (Some(ctor), Some(pat)) => ctor.intersection(&pat).map(|_| {
2105                         let (pat_lo, pat_hi) = pat.range.into_inner();
2106                         let (ctor_lo, ctor_hi) = ctor.range.into_inner();
2107                         assert!(pat_lo <= ctor_lo && ctor_hi <= pat_hi);
2108                         PatStack::default()
2109                     }),
2110                     _ => None,
2111                 }
2112             } else {
2113                 // Fallback for non-ranges and ranges that involve
2114                 // floating-point numbers, which are not conveniently handled
2115                 // by `IntRange`. For these cases, the constructor may not be a
2116                 // range so intersection actually devolves into being covered
2117                 // by the pattern.
2118                 match constructor_covered_by_range(cx.tcx, cx.param_env, constructor, pat) {
2119                     Ok(true) => Some(PatStack::default()),
2120                     Ok(false) | Err(ErrorReported) => None,
2121                 }
2122             }
2123         }
2124
2125         PatKind::Array { ref prefix, ref slice, ref suffix }
2126         | PatKind::Slice { ref prefix, ref slice, ref suffix } => match *constructor {
2127             Slice(..) => {
2128                 let pat_len = prefix.len() + suffix.len();
2129                 if let Some(slice_count) = wild_patterns.len().checked_sub(pat_len) {
2130                     if slice_count == 0 || slice.is_some() {
2131                         Some(
2132                             prefix
2133                                 .iter()
2134                                 .chain(
2135                                     wild_patterns
2136                                         .iter()
2137                                         .map(|p| *p)
2138                                         .skip(prefix.len())
2139                                         .take(slice_count)
2140                                         .chain(suffix.iter()),
2141                                 )
2142                                 .collect(),
2143                         )
2144                     } else {
2145                         None
2146                     }
2147                 } else {
2148                     None
2149                 }
2150             }
2151             ConstantValue(cv, _) => {
2152                 match slice_pat_covered_by_const(
2153                     cx.tcx,
2154                     pat.span,
2155                     cv,
2156                     prefix,
2157                     slice,
2158                     suffix,
2159                     cx.param_env,
2160                 ) {
2161                     Ok(true) => Some(PatStack::default()),
2162                     Ok(false) => None,
2163                     Err(ErrorReported) => None,
2164                 }
2165             }
2166             _ => span_bug!(pat.span, "unexpected ctor {:?} for slice pat", constructor),
2167         },
2168
2169         PatKind::Or { .. } => {
2170             bug!("support for or-patterns has not been fully implemented yet.");
2171         }
2172     };
2173     debug!("specialize({:#?}, {:#?}) = {:#?}", r.head(), wild_patterns, new_head);
2174
2175     new_head.map(|head| {
2176         let mut head = head.0;
2177         head.extend_from_slice(&r.0[1..]);
2178         PatStack::from_vec(head)
2179     })
2180 }