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