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