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