1 // Copyright 2012-2016 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 /// This file includes the logic for exhaustiveness and usefulness checking for
12 /// pattern-matching. Specifically, given a list of patterns for a type, we can
14 /// (a) the patterns cover every possible constructor for the type [exhaustiveness]
15 /// (b) each pattern is necessary [usefulness]
17 /// The algorithm implemented here is a modified version of the one described in:
18 /// http://moscova.inria.fr/~maranget/papers/warn/index.html
19 /// However, to save future implementors from reading the original paper, I'm going
20 /// to summarise the algorithm here to hopefully save time and be a little clearer
21 /// (without being so rigorous).
23 /// The core of the algorithm revolves about a "usefulness" check. In particular, we
24 /// are trying to compute a predicate `U(P, p_{m + 1})` where `P` is a list of patterns
25 /// of length `m` for a compound (product) type with `n` components (we refer to this as
26 /// a matrix). `U(P, p_{m + 1})` represents whether, given an existing list of patterns
27 /// `p_1 ..= p_m`, adding a new pattern will be "useful" (that is, cover previously-
28 /// uncovered values of the type).
30 /// If we have this predicate, then we can easily compute both exhaustiveness of an
31 /// entire set of patterns and the individual usefulness of each one.
32 /// (a) the set of patterns is exhaustive iff `U(P, _)` is false (i.e. adding a wildcard
33 /// match doesn't increase the number of values we're matching)
34 /// (b) a pattern `p_i` is not useful if `U(P[0..=(i-1), p_i)` is false (i.e. adding a
35 /// pattern to those that have come before it doesn't increase the number of values
38 /// For example, say we have the following:
40 /// // x: (Option<bool>, Result<()>)
42 /// (Some(true), _) => {}
43 /// (None, Err(())) => {}
44 /// (None, Err(_)) => {}
47 /// Here, the matrix `P` is 3 x 2 (rows x columns).
53 /// We can tell it's not exhaustive, because `U(P, _)` is true (we're not covering
54 /// `[Some(false), _]`, for instance). In addition, row 3 is not useful, because
55 /// all the values it covers are already covered by row 2.
57 /// To compute `U`, we must have two other concepts.
58 /// 1. `S(c, P)` is a "specialized matrix", where `c` is a constructor (like `Some` or
59 /// `None`). You can think of it as filtering `P` to just the rows whose *first* pattern
60 /// can cover `c` (and expanding OR-patterns into distinct patterns), and then expanding
61 /// the constructor into all of its components.
62 /// The specialization of a row vector is computed by `specialize`.
64 /// It is computed as follows. For each row `p_i` of P, we have four cases:
65 /// 1.1. `p_(i,1) = c(r_1, .., r_a)`. Then `S(c, P)` has a corresponding row:
66 /// r_1, .., r_a, p_(i,2), .., p_(i,n)
67 /// 1.2. `p_(i,1) = c'(r_1, .., r_a')` where `c ≠ c'`. Then `S(c, P)` has no
68 /// corresponding row.
69 /// 1.3. `p_(i,1) = _`. Then `S(c, P)` has a corresponding row:
70 /// _, .., _, p_(i,2), .., p_(i,n)
71 /// 1.4. `p_(i,1) = r_1 | r_2`. Then `S(c, P)` has corresponding rows inlined from:
72 /// S(c, (r_1, p_(i,2), .., p_(i,n)))
73 /// S(c, (r_2, p_(i,2), .., p_(i,n)))
75 /// 2. `D(P)` is a "default matrix". This is used when we know there are missing
76 /// constructor cases, but there might be existing wildcard patterns, so to check the
77 /// usefulness of the matrix, we have to check all its *other* components.
78 /// The default matrix is computed inline in `is_useful`.
80 /// It is computed as follows. For each row `p_i` of P, we have three cases:
81 /// 1.1. `p_(i,1) = c(r_1, .., r_a)`. Then `D(P)` has no corresponding row.
82 /// 1.2. `p_(i,1) = _`. Then `D(P)` has a corresponding row:
83 /// p_(i,2), .., p_(i,n)
84 /// 1.3. `p_(i,1) = r_1 | r_2`. Then `D(P)` has corresponding rows inlined from:
85 /// D((r_1, p_(i,2), .., p_(i,n)))
86 /// D((r_2, p_(i,2), .., p_(i,n)))
88 /// Note that the OR-patterns are not always used directly in Rust, but are used to derive
89 /// the exhaustive integer matching rules, so they're written here for posterity.
91 /// The algorithm for computing `U`
92 /// -------------------------------
93 /// The algorithm is inductive (on the number of columns: i.e. components of tuple patterns).
94 /// That means we're going to check the components from left-to-right, so the algorithm
95 /// operates principally on the first component of the matrix and new pattern `p_{m + 1}`.
96 /// This algorithm is realised in the `is_useful` function.
98 /// Base case. (`n = 0`, i.e. an empty tuple pattern)
99 /// - If `P` already contains an empty pattern (i.e. if the number of patterns `m > 0`),
100 /// then `U(P, p_{m + 1})` is false.
101 /// - Otherwise, `P` must be empty, so `U(P, p_{m + 1})` is true.
103 /// Inductive step. (`n > 0`, i.e. whether there's at least one column
104 /// [which may then be expanded into further columns later])
105 /// We're going to match on the new pattern, `p_{m + 1}`.
106 /// - If `p_{m + 1} == c(r_1, .., r_a)`, then we have a constructor pattern.
107 /// Thus, the usefulness of `p_{m + 1}` can be reduced to whether it is useful when
108 /// we ignore all the patterns in `P` that involve other constructors. This is where
109 /// `S(c, P)` comes in:
110 /// `U(P, p_{m + 1}) := U(S(c, P), S(c, p_{m + 1}))`
111 /// This special case is handled in `is_useful_specialized`.
112 /// - If `p_{m + 1} == _`, then we have two more cases:
113 /// + All the constructors of the first component of the type exist within
114 /// all the rows (after having expanded OR-patterns). In this case:
115 /// `U(P, p_{m + 1}) := ∨(k ϵ constructors) U(S(k, P), S(k, p_{m + 1}))`
116 /// I.e. the pattern `p_{m + 1}` is only useful when all the constructors are
117 /// present *if* its later components are useful for the respective constructors
118 /// covered by `p_{m + 1}` (usually a single constructor, but all in the case of `_`).
119 /// + Some constructors are not present in the existing rows (after having expanded
120 /// OR-patterns). However, there might be wildcard patterns (`_`) present. Thus, we
121 /// are only really concerned with the other patterns leading with wildcards. This is
122 /// where `D` comes in:
123 /// `U(P, p_{m + 1}) := U(D(P), p_({m + 1},2), .., p_({m + 1},n))`
124 /// - If `p_{m + 1} == r_1 | r_2`, then the usefulness depends on each separately:
125 /// `U(P, p_{m + 1}) := U(P, (r_1, p_({m + 1},2), .., p_({m + 1},n)))
126 /// || U(P, (r_2, p_({m + 1},2), .., p_({m + 1},n)))`
128 /// Modifications to the algorithm
129 /// ------------------------------
130 /// The algorithm in the paper doesn't cover some of the special cases that arise in Rust, for
131 /// example uninhabited types and variable-length slice patterns. These are drawn attention to
132 /// throughout the code below. I'll make a quick note here about how exhaustive integer matching
133 /// is accounted for, though.
135 /// Exhaustive integer matching
136 /// ---------------------------
137 /// An integer type can be thought of as a (huge) sum type: 1 | 2 | 3 | ...
138 /// So to support exhaustive integer matching, we can make use of the logic in the paper for
139 /// OR-patterns. However, we obviously can't just treat ranges x..=y as individual sums, because
140 /// they are likely gigantic. So we instead treat ranges as constructors of the integers. This means
141 /// that we have a constructor *of* constructors (the integers themselves). We then need to work
142 /// through all the inductive step rules above, deriving how the ranges would be treated as
143 /// OR-patterns, and making sure that they're treated in the same way even when they're ranges.
144 /// There are really only four special cases here:
145 /// - When we match on a constructor that's actually a range, we have to treat it as if we would
147 /// + It turns out that we can simply extend the case for single-value patterns in
148 /// `specialize` to either be *equal* to a value constructor, or *contained within* a range
150 /// + When the pattern itself is a range, you just want to tell whether any of the values in
151 /// the pattern range coincide with values in the constructor range, which is precisely
153 /// Since when encountering a range pattern for a value constructor, we also use inclusion, it
154 /// means that whenever the constructor is a value/range and the pattern is also a value/range,
155 /// we can simply use intersection to test usefulness.
156 /// - When we're testing for usefulness of a pattern and the pattern's first component is a
158 /// + If all the constructors appear in the matrix, we have a slight complication. By default,
159 /// the behaviour (i.e. a disjunction over specialised matrices for each constructor) is
160 /// invalid, because we want a disjunction over every *integer* in each range, not just a
161 /// disjunction over every range. This is a bit more tricky to deal with: essentially we need
162 /// to form equivalence classes of subranges of the constructor range for which the behaviour
163 /// of the matrix `P` and new pattern `p_{m + 1}` are the same. This is described in more
164 /// detail in `split_grouped_constructors`.
165 /// + If some constructors are missing from the matrix, it turns out we don't need to do
166 /// anything special (because we know none of the integers are actually wildcards: i.e. we
167 /// can't span wildcards using ranges).
169 use self::Constructor::*;
170 use self::Usefulness::*;
171 use self::WitnessPreference::*;
173 use rustc_data_structures::fx::FxHashMap;
174 use rustc_data_structures::indexed_vec::Idx;
176 use super::{FieldPattern, Pattern, PatternKind};
177 use super::{PatternFoldable, PatternFolder, compare_const_vals};
179 use rustc::hir::def_id::DefId;
180 use rustc::hir::RangeEnd;
181 use rustc::ty::{self, Ty, TyCtxt, TypeFoldable};
182 use rustc::ty::layout::{Integer, IntegerExt, VariantIdx};
184 use rustc::mir::Field;
185 use rustc::mir::interpret::ConstValue;
186 use rustc::util::common::ErrorReported;
188 use syntax::attr::{SignedInt, UnsignedInt};
189 use syntax_pos::{Span, DUMMY_SP};
191 use arena::TypedArena;
193 use std::cmp::{self, Ordering, min, max};
195 use std::iter::{FromIterator, IntoIterator};
196 use std::ops::RangeInclusive;
199 pub fn expand_pattern<'a, 'tcx>(cx: &MatchCheckCtxt<'a, 'tcx>, pat: Pattern<'tcx>)
202 cx.pattern_arena.alloc(LiteralExpander.fold_pattern(&pat))
205 struct LiteralExpander;
206 impl<'tcx> PatternFolder<'tcx> for LiteralExpander {
207 fn fold_pattern(&mut self, pat: &Pattern<'tcx>) -> Pattern<'tcx> {
208 match (&pat.ty.sty, &*pat.kind) {
209 (&ty::Ref(_, rty, _), &PatternKind::Constant { ref value }) => {
213 kind: box PatternKind::Deref {
214 subpattern: Pattern {
217 kind: box PatternKind::Constant { value: value.clone() },
222 (_, &PatternKind::Binding { subpattern: Some(ref s), .. }) => {
225 _ => pat.super_fold_with(self)
230 impl<'tcx> Pattern<'tcx> {
231 fn is_wildcard(&self) -> bool {
233 PatternKind::Binding { subpattern: None, .. } | PatternKind::Wild =>
240 pub struct Matrix<'a, 'tcx: 'a>(Vec<Vec<&'a Pattern<'tcx>>>);
242 impl<'a, 'tcx> Matrix<'a, 'tcx> {
243 pub fn empty() -> Self {
247 pub fn push(&mut self, row: Vec<&'a Pattern<'tcx>>) {
252 /// Pretty-printer for matrices of patterns, example:
253 /// ++++++++++++++++++++++++++
255 /// ++++++++++++++++++++++++++
256 /// + true + [First] +
257 /// ++++++++++++++++++++++++++
258 /// + true + [Second(true)] +
259 /// ++++++++++++++++++++++++++
261 /// ++++++++++++++++++++++++++
262 /// + _ + [_, _, ..tail] +
263 /// ++++++++++++++++++++++++++
264 impl<'a, 'tcx> fmt::Debug for Matrix<'a, 'tcx> {
265 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
268 let &Matrix(ref m) = self;
269 let pretty_printed_matrix: Vec<Vec<String>> = m.iter().map(|row| {
270 row.iter().map(|pat| format!("{:?}", pat)).collect()
273 let column_count = m.iter().map(|row| row.len()).max().unwrap_or(0);
274 assert!(m.iter().all(|row| row.len() == column_count));
275 let column_widths: Vec<usize> = (0..column_count).map(|col| {
276 pretty_printed_matrix.iter().map(|row| row[col].len()).max().unwrap_or(0)
279 let total_width = column_widths.iter().cloned().sum::<usize>() + column_count * 3 + 1;
280 let br = "+".repeat(total_width);
281 write!(f, "{}\n", br)?;
282 for row in pretty_printed_matrix {
284 for (column, pat_str) in row.into_iter().enumerate() {
286 write!(f, "{:1$}", pat_str, column_widths[column])?;
290 write!(f, "{}\n", br)?;
296 impl<'a, 'tcx> FromIterator<Vec<&'a Pattern<'tcx>>> for Matrix<'a, 'tcx> {
297 fn from_iter<T: IntoIterator<Item=Vec<&'a Pattern<'tcx>>>>(iter: T) -> Self
299 Matrix(iter.into_iter().collect())
303 pub struct MatchCheckCtxt<'a, 'tcx: 'a> {
304 pub tcx: TyCtxt<'a, 'tcx, 'tcx>,
305 /// The module in which the match occurs. This is necessary for
306 /// checking inhabited-ness of types because whether a type is (visibly)
307 /// inhabited can depend on whether it was defined in the current module or
308 /// not. eg. `struct Foo { _private: ! }` cannot be seen to be empty
309 /// outside it's module and should not be matchable with an empty match
312 param_env: ty::ParamEnv<'tcx>,
313 pub pattern_arena: &'a TypedArena<Pattern<'tcx>>,
314 pub byte_array_map: FxHashMap<*const Pattern<'tcx>, Vec<&'a Pattern<'tcx>>>,
317 impl<'a, 'tcx> MatchCheckCtxt<'a, 'tcx> {
318 pub fn create_and_enter<F, R>(
319 tcx: TyCtxt<'a, 'tcx, 'tcx>,
320 param_env: ty::ParamEnv<'tcx>,
323 where F: for<'b> FnOnce(MatchCheckCtxt<'b, 'tcx>) -> R
325 let pattern_arena = TypedArena::default();
331 pattern_arena: &pattern_arena,
332 byte_array_map: FxHashMap::default(),
336 fn is_uninhabited(&self, ty: Ty<'tcx>) -> bool {
337 if self.tcx.features().exhaustive_patterns {
338 self.tcx.is_ty_uninhabited_from(self.module, ty)
344 fn is_non_exhaustive_enum(&self, ty: Ty<'tcx>) -> bool {
346 ty::Adt(adt_def, ..) => adt_def.is_variant_list_non_exhaustive(),
351 fn is_local(&self, ty: Ty<'tcx>) -> bool {
353 ty::Adt(adt_def, ..) => adt_def.did.is_local(),
358 fn is_variant_uninhabited(&self,
359 variant: &'tcx ty::VariantDef,
360 substs: &'tcx ty::subst::Substs<'tcx>)
363 if self.tcx.features().exhaustive_patterns {
364 self.tcx.is_enum_variant_uninhabited_from(self.module, variant, substs)
371 #[derive(Clone, Debug, PartialEq)]
372 pub enum Constructor<'tcx> {
373 /// The constructor of all patterns that don't vary by constructor,
374 /// e.g. struct patterns and fixed-length arrays.
379 ConstantValue(&'tcx ty::Const<'tcx>),
380 /// Ranges of literal values (`2...5` and `2..5`).
381 ConstantRange(u128, u128, Ty<'tcx>, RangeEnd),
382 /// Array patterns of length n.
386 impl<'tcx> Constructor<'tcx> {
387 fn variant_index_for_adt(&self, adt: &'tcx ty::AdtDef) -> VariantIdx {
389 &Variant(vid) => adt.variant_index_with_id(vid),
391 assert!(!adt.is_enum());
394 _ => bug!("bad constructor {:?} for adt {:?}", self, adt)
399 #[derive(Clone, Debug)]
400 pub enum Usefulness<'tcx> {
402 UsefulWithWitness(Vec<Witness<'tcx>>),
406 impl<'tcx> Usefulness<'tcx> {
407 fn is_useful(&self) -> bool {
415 #[derive(Copy, Clone, Debug)]
416 pub enum WitnessPreference {
421 #[derive(Copy, Clone, Debug)]
422 struct PatternContext<'tcx> {
424 max_slice_length: u64,
427 /// A witness of non-exhaustiveness for error reporting, represented
428 /// as a list of patterns (in reverse order of construction) with
429 /// wildcards inside to represent elements that can take any inhabitant
430 /// of the type as a value.
432 /// A witness against a list of patterns should have the same types
433 /// and length as the pattern matched against. Because Rust `match`
434 /// is always against a single pattern, at the end the witness will
435 /// have length 1, but in the middle of the algorithm, it can contain
436 /// multiple patterns.
438 /// For example, if we are constructing a witness for the match against
440 /// struct Pair(Option<(u32, u32)>, bool);
442 /// match (p: Pair) {
443 /// Pair(None, _) => {}
444 /// Pair(_, false) => {}
448 /// We'll perform the following steps:
449 /// 1. Start with an empty witness
450 /// `Witness(vec![])`
451 /// 2. Push a witness `Some(_)` against the `None`
452 /// `Witness(vec![Some(_)])`
453 /// 3. Push a witness `true` against the `false`
454 /// `Witness(vec![Some(_), true])`
455 /// 4. Apply the `Pair` constructor to the witnesses
456 /// `Witness(vec![Pair(Some(_), true)])`
458 /// The final `Pair(Some(_), true)` is then the resulting witness.
459 #[derive(Clone, Debug)]
460 pub struct Witness<'tcx>(Vec<Pattern<'tcx>>);
462 impl<'tcx> Witness<'tcx> {
463 pub fn single_pattern(&self) -> &Pattern<'tcx> {
464 assert_eq!(self.0.len(), 1);
468 fn push_wild_constructor<'a>(
470 cx: &MatchCheckCtxt<'a, 'tcx>,
471 ctor: &Constructor<'tcx>,
475 let sub_pattern_tys = constructor_sub_pattern_tys(cx, ctor, ty);
476 self.0.extend(sub_pattern_tys.into_iter().map(|ty| {
480 kind: box PatternKind::Wild,
483 self.apply_constructor(cx, ctor, ty)
487 /// Constructs a partial witness for a pattern given a list of
488 /// patterns expanded by the specialization step.
490 /// When a pattern P is discovered to be useful, this function is used bottom-up
491 /// to reconstruct a complete witness, e.g. a pattern P' that covers a subset
492 /// of values, V, where each value in that set is not covered by any previously
493 /// used patterns and is covered by the pattern P'. Examples:
495 /// left_ty: tuple of 3 elements
496 /// pats: [10, 20, _] => (10, 20, _)
498 /// left_ty: struct X { a: (bool, &'static str), b: usize}
499 /// pats: [(false, "foo"), 42] => X { a: (false, "foo"), b: 42 }
500 fn apply_constructor<'a>(
502 cx: &MatchCheckCtxt<'a,'tcx>,
503 ctor: &Constructor<'tcx>,
507 let arity = constructor_arity(cx, ctor, ty);
509 let len = self.0.len() as u64;
510 let mut pats = self.0.drain((len - arity) as usize..).rev();
515 let pats = pats.enumerate().map(|(i, p)| {
517 field: Field::new(i),
522 if let ty::Adt(adt, substs) = ty.sty {
524 PatternKind::Variant {
527 variant_index: ctor.variant_index_for_adt(adt),
531 PatternKind::Leaf { subpatterns: pats }
534 PatternKind::Leaf { subpatterns: pats }
539 PatternKind::Deref { subpattern: pats.nth(0).unwrap() }
542 ty::Slice(_) | ty::Array(..) => {
544 prefix: pats.collect(),
552 ConstantValue(value) => PatternKind::Constant { value },
553 ConstantRange(lo, hi, ty, end) => PatternKind::Range {
554 lo: ty::Const::from_bits(cx.tcx, lo, ty::ParamEnv::empty().and(ty)),
555 hi: ty::Const::from_bits(cx.tcx, hi, ty::ParamEnv::empty().and(ty)),
559 _ => PatternKind::Wild,
565 self.0.push(Pattern {
575 /// This determines the set of all possible constructors of a pattern matching
576 /// values of type `left_ty`. For vectors, this would normally be an infinite set
577 /// but is instead bounded by the maximum fixed length of slice patterns in
578 /// the column of patterns being analyzed.
580 /// We make sure to omit constructors that are statically impossible. eg for
581 /// Option<!> we do not include Some(_) in the returned list of constructors.
582 fn all_constructors<'a, 'tcx: 'a>(cx: &mut MatchCheckCtxt<'a, 'tcx>,
583 pcx: PatternContext<'tcx>)
584 -> Vec<Constructor<'tcx>>
586 debug!("all_constructors({:?})", pcx.ty);
587 let exhaustive_integer_patterns = cx.tcx.features().exhaustive_integer_patterns;
588 let ctors = match pcx.ty.sty {
590 [true, false].iter().map(|&b| {
591 ConstantValue(ty::Const::from_bool(cx.tcx, b))
594 ty::Array(ref sub_ty, len) if len.assert_usize(cx.tcx).is_some() => {
595 let len = len.unwrap_usize(cx.tcx);
596 if len != 0 && cx.is_uninhabited(sub_ty) {
602 // Treat arrays of a constant but unknown length like slices.
603 ty::Array(ref sub_ty, _) |
604 ty::Slice(ref sub_ty) => {
605 if cx.is_uninhabited(sub_ty) {
608 (0..pcx.max_slice_length+1).map(|length| Slice(length)).collect()
611 ty::Adt(def, substs) if def.is_enum() => {
613 .filter(|v| !cx.is_variant_uninhabited(v, substs))
614 .map(|v| Variant(v.did))
617 ty::Char if exhaustive_integer_patterns => {
619 // The valid Unicode Scalar Value ranges.
620 ConstantRange('\u{0000}' as u128,
625 ConstantRange('\u{E000}' as u128,
626 '\u{10FFFF}' as u128,
632 ty::Int(ity) if exhaustive_integer_patterns => {
633 // FIXME(49937): refactor these bit manipulations into interpret.
634 let bits = Integer::from_attr(&cx.tcx, SignedInt(ity)).size().bits() as u128;
635 let min = 1u128 << (bits - 1);
636 let max = (1u128 << (bits - 1)) - 1;
637 vec![ConstantRange(min, max, pcx.ty, RangeEnd::Included)]
639 ty::Uint(uty) if exhaustive_integer_patterns => {
640 // FIXME(49937): refactor these bit manipulations into interpret.
641 let bits = Integer::from_attr(&cx.tcx, UnsignedInt(uty)).size().bits() as u128;
642 let max = !0u128 >> (128 - bits);
643 vec![ConstantRange(0, max, pcx.ty, RangeEnd::Included)]
646 if cx.is_uninhabited(pcx.ty) {
656 fn max_slice_length<'p, 'a: 'p, 'tcx: 'a, I>(
657 cx: &mut MatchCheckCtxt<'a, 'tcx>,
659 where I: Iterator<Item=&'p Pattern<'tcx>>
661 // The exhaustiveness-checking paper does not include any details on
662 // checking variable-length slice patterns. However, they are matched
663 // by an infinite collection of fixed-length array patterns.
665 // Checking the infinite set directly would take an infinite amount
666 // of time. However, it turns out that for each finite set of
667 // patterns `P`, all sufficiently large array lengths are equivalent:
669 // Each slice `s` with a "sufficiently-large" length `l ≥ L` that applies
670 // to exactly the subset `Pₜ` of `P` can be transformed to a slice
671 // `sₘ` for each sufficiently-large length `m` that applies to exactly
672 // the same subset of `P`.
674 // Because of that, each witness for reachability-checking from one
675 // of the sufficiently-large lengths can be transformed to an
676 // equally-valid witness from any other length, so we only have
677 // to check slice lengths from the "minimal sufficiently-large length"
680 // Note that the fact that there is a *single* `sₘ` for each `m`
681 // not depending on the specific pattern in `P` is important: if
682 // you look at the pair of patterns
685 // Then any slice of length ≥1 that matches one of these two
686 // patterns can be trivially turned to a slice of any
687 // other length ≥1 that matches them and vice-versa - for
688 // but the slice from length 2 `[false, true]` that matches neither
689 // of these patterns can't be turned to a slice from length 1 that
690 // matches neither of these patterns, so we have to consider
691 // slices from length 2 there.
693 // Now, to see that that length exists and find it, observe that slice
694 // patterns are either "fixed-length" patterns (`[_, _, _]`) or
695 // "variable-length" patterns (`[_, .., _]`).
697 // For fixed-length patterns, all slices with lengths *longer* than
698 // the pattern's length have the same outcome (of not matching), so
699 // as long as `L` is greater than the pattern's length we can pick
700 // any `sₘ` from that length and get the same result.
702 // For variable-length patterns, the situation is more complicated,
703 // because as seen above the precise value of `sₘ` matters.
705 // However, for each variable-length pattern `p` with a prefix of length
706 // `plₚ` and suffix of length `slₚ`, only the first `plₚ` and the last
707 // `slₚ` elements are examined.
709 // Therefore, as long as `L` is positive (to avoid concerns about empty
710 // types), all elements after the maximum prefix length and before
711 // the maximum suffix length are not examined by any variable-length
712 // pattern, and therefore can be added/removed without affecting
713 // them - creating equivalent patterns from any sufficiently-large
716 // Of course, if fixed-length patterns exist, we must be sure
717 // that our length is large enough to miss them all, so
718 // we can pick `L = max(FIXED_LEN+1 ∪ {max(PREFIX_LEN) + max(SUFFIX_LEN)})`
720 // for example, with the above pair of patterns, all elements
721 // but the first and last can be added/removed, so any
722 // witness of length ≥2 (say, `[false, false, true]`) can be
723 // turned to a witness from any other length ≥2.
725 let mut max_prefix_len = 0;
726 let mut max_suffix_len = 0;
727 let mut max_fixed_len = 0;
729 for row in patterns {
731 PatternKind::Constant { value } => {
732 if let Some(ptr) = value.to_ptr() {
733 let is_array_ptr = value.ty
735 .and_then(|t| t.ty.builtin_index())
736 .map_or(false, |t| t == cx.tcx.types.u8);
738 let alloc = cx.tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id);
739 max_fixed_len = cmp::max(max_fixed_len, alloc.bytes.len() as u64);
743 PatternKind::Slice { ref prefix, slice: None, ref suffix } => {
744 let fixed_len = prefix.len() as u64 + suffix.len() as u64;
745 max_fixed_len = cmp::max(max_fixed_len, fixed_len);
747 PatternKind::Slice { ref prefix, slice: Some(_), ref suffix } => {
748 max_prefix_len = cmp::max(max_prefix_len, prefix.len() as u64);
749 max_suffix_len = cmp::max(max_suffix_len, suffix.len() as u64);
755 cmp::max(max_fixed_len + 1, max_prefix_len + max_suffix_len)
758 /// An inclusive interval, used for precise integer exhaustiveness checking.
759 /// `IntRange`s always store a contiguous range. This means that values are
760 /// encoded such that `0` encodes the minimum value for the integer,
761 /// regardless of the signedness.
762 /// For example, the pattern `-128...127i8` is encoded as `0..=255`.
763 /// This makes comparisons and arithmetic on interval endpoints much more
764 /// straightforward. See `signed_bias` for details.
766 /// `IntRange` is never used to encode an empty range or a "range" that wraps
767 /// around the (offset) space: i.e. `range.lo <= range.hi`.
769 struct IntRange<'tcx> {
770 pub range: RangeInclusive<u128>,
774 impl<'tcx> IntRange<'tcx> {
775 fn from_ctor(tcx: TyCtxt<'_, 'tcx, 'tcx>,
776 ctor: &Constructor<'tcx>)
777 -> Option<IntRange<'tcx>> {
779 ConstantRange(lo, hi, ty, end) => {
780 // Perform a shift if the underlying types are signed,
781 // which makes the interval arithmetic simpler.
782 let bias = IntRange::signed_bias(tcx, ty);
783 let (lo, hi) = (lo ^ bias, hi ^ bias);
784 // Make sure the interval is well-formed.
785 if lo > hi || lo == hi && *end == RangeEnd::Excluded {
788 let offset = (*end == RangeEnd::Excluded) as u128;
789 Some(IntRange { range: lo..=(hi - offset), ty })
792 ConstantValue(val) => {
794 if let Some(val) = val.assert_bits(tcx, ty::ParamEnv::empty().and(ty)) {
795 let bias = IntRange::signed_bias(tcx, ty);
796 let val = val ^ bias;
797 Some(IntRange { range: val..=val, ty })
802 Single | Variant(_) | Slice(_) => {
808 fn from_pat(tcx: TyCtxt<'_, 'tcx, 'tcx>,
810 -> Option<IntRange<'tcx>> {
811 Self::from_ctor(tcx, &match pat.kind {
812 box PatternKind::Constant { value } => ConstantValue(value),
813 box PatternKind::Range { lo, hi, ty, end } => ConstantRange(
814 lo.to_bits(tcx, ty::ParamEnv::empty().and(ty)).unwrap(),
815 hi.to_bits(tcx, ty::ParamEnv::empty().and(ty)).unwrap(),
823 // The return value of `signed_bias` should be XORed with an endpoint to encode/decode it.
824 fn signed_bias(tcx: TyCtxt<'_, 'tcx, 'tcx>, ty: Ty<'tcx>) -> u128 {
827 let bits = Integer::from_attr(&tcx, SignedInt(ity)).size().bits() as u128;
834 /// Convert a `RangeInclusive` to a `ConstantValue` or inclusive `ConstantRange`.
836 tcx: TyCtxt<'_, 'tcx, 'tcx>,
838 r: RangeInclusive<u128>,
839 ) -> Constructor<'tcx> {
840 let bias = IntRange::signed_bias(tcx, ty);
841 let (lo, hi) = r.into_inner();
843 let ty = ty::ParamEnv::empty().and(ty);
844 ConstantValue(ty::Const::from_bits(tcx, lo ^ bias, ty))
846 ConstantRange(lo ^ bias, hi ^ bias, ty, RangeEnd::Included)
850 /// Return a collection of ranges that spans the values covered by `ranges`, subtracted
851 /// by the values covered by `self`: i.e. `ranges \ self` (in set notation).
852 fn subtract_from(self,
853 tcx: TyCtxt<'_, 'tcx, 'tcx>,
854 ranges: Vec<Constructor<'tcx>>)
855 -> Vec<Constructor<'tcx>> {
856 let ranges = ranges.into_iter().filter_map(|r| {
857 IntRange::from_ctor(tcx, &r).map(|i| i.range)
859 let mut remaining_ranges = vec![];
861 let (lo, hi) = self.range.into_inner();
862 for subrange in ranges {
863 let (subrange_lo, subrange_hi) = subrange.into_inner();
864 if lo > subrange_hi || subrange_lo > hi {
865 // The pattern doesn't intersect with the subrange at all,
866 // so the subrange remains untouched.
867 remaining_ranges.push(Self::range_to_ctor(tcx, ty, subrange_lo..=subrange_hi));
869 if lo > subrange_lo {
870 // The pattern intersects an upper section of the
871 // subrange, so a lower section will remain.
872 remaining_ranges.push(Self::range_to_ctor(tcx, ty, subrange_lo..=(lo - 1)));
874 if hi < subrange_hi {
875 // The pattern intersects a lower section of the
876 // subrange, so an upper section will remain.
877 remaining_ranges.push(Self::range_to_ctor(tcx, ty, (hi + 1)..=subrange_hi));
884 fn intersection(&self, other: &Self) -> Option<Self> {
886 let (lo, hi) = (*self.range.start(), *self.range.end());
887 let (other_lo, other_hi) = (*other.range.start(), *other.range.end());
888 if lo <= other_hi && other_lo <= hi {
889 Some(IntRange { range: max(lo, other_lo)..=min(hi, other_hi), ty })
896 // A request for missing constructor data in terms of either:
897 // - whether or not there any missing constructors; or
898 // - the actual set of missing constructors.
900 enum MissingCtorsInfo {
905 // Used by `compute_missing_ctors`.
906 #[derive(Debug, PartialEq)]
907 enum MissingCtors<'tcx> {
911 // Note that the Vec can be empty.
912 Ctors(Vec<Constructor<'tcx>>),
915 // When `info` is `MissingCtorsInfo::Ctors`, compute a set of constructors
916 // equivalent to `all_ctors \ used_ctors`. When `info` is
917 // `MissingCtorsInfo::Emptiness`, just determines if that set is empty or not.
918 // (The split logic gives a performance win, because we always need to know if
919 // the set is empty, but we rarely need the full set, and it can be expensive
920 // to compute the full set.)
921 fn compute_missing_ctors<'a, 'tcx: 'a>(
922 info: MissingCtorsInfo,
923 tcx: TyCtxt<'a, 'tcx, 'tcx>,
924 all_ctors: &Vec<Constructor<'tcx>>,
925 used_ctors: &Vec<Constructor<'tcx>>,
926 ) -> MissingCtors<'tcx> {
927 let mut missing_ctors = vec![];
929 for req_ctor in all_ctors {
930 let mut refined_ctors = vec![req_ctor.clone()];
931 for used_ctor in used_ctors {
932 if used_ctor == req_ctor {
933 // If a constructor appears in a `match` arm, we can
934 // eliminate it straight away.
935 refined_ctors = vec![]
936 } else if tcx.features().exhaustive_integer_patterns {
937 if let Some(interval) = IntRange::from_ctor(tcx, used_ctor) {
938 // Refine the required constructors for the type by subtracting
939 // the range defined by the current constructor pattern.
940 refined_ctors = interval.subtract_from(tcx, refined_ctors);
944 // If the constructor patterns that have been considered so far
945 // already cover the entire range of values, then we the
946 // constructor is not missing, and we can move on to the next one.
947 if refined_ctors.is_empty() {
951 // If a constructor has not been matched, then it is missing.
952 // We add `refined_ctors` instead of `req_ctor`, because then we can
953 // provide more detailed error information about precisely which
954 // ranges have been omitted.
955 if info == MissingCtorsInfo::Emptiness {
956 if !refined_ctors.is_empty() {
957 // The set is non-empty; return early.
958 return MissingCtors::NonEmpty;
961 missing_ctors.extend(refined_ctors);
965 if info == MissingCtorsInfo::Emptiness {
966 // If we reached here, the set is empty.
969 MissingCtors::Ctors(missing_ctors)
973 /// Algorithm from http://moscova.inria.fr/~maranget/papers/warn/index.html
974 /// The algorithm from the paper has been modified to correctly handle empty
975 /// types. The changes are:
976 /// (0) We don't exit early if the pattern matrix has zero rows. We just
977 /// continue to recurse over columns.
978 /// (1) all_constructors will only return constructors that are statically
979 /// possible. eg. it will only return Ok for Result<T, !>
981 /// This finds whether a (row) vector `v` of patterns is 'useful' in relation
982 /// to a set of such vectors `m` - this is defined as there being a set of
983 /// inputs that will match `v` but not any of the sets in `m`.
985 /// All the patterns at each column of the `matrix ++ v` matrix must
986 /// have the same type, except that wildcard (PatternKind::Wild) patterns
987 /// with type TyErr are also allowed, even if the "type of the column"
988 /// is not TyErr. That is used to represent private fields, as using their
989 /// real type would assert that they are inhabited.
991 /// This is used both for reachability checking (if a pattern isn't useful in
992 /// relation to preceding patterns, it is not reachable) and exhaustiveness
993 /// checking (if a wildcard pattern is useful in relation to a matrix, the
994 /// matrix isn't exhaustive).
995 pub fn is_useful<'p, 'a: 'p, 'tcx: 'a>(cx: &mut MatchCheckCtxt<'a, 'tcx>,
996 matrix: &Matrix<'p, 'tcx>,
997 v: &[&'p Pattern<'tcx>],
998 witness: WitnessPreference)
999 -> Usefulness<'tcx> {
1000 let &Matrix(ref rows) = matrix;
1001 debug!("is_useful({:#?}, {:#?})", matrix, v);
1003 // The base case. We are pattern-matching on () and the return value is
1004 // based on whether our matrix has a row or not.
1005 // NOTE: This could potentially be optimized by checking rows.is_empty()
1006 // first and then, if v is non-empty, the return value is based on whether
1007 // the type of the tuple we're checking is inhabited or not.
1009 return if rows.is_empty() {
1011 ConstructWitness => UsefulWithWitness(vec![Witness(vec![])]),
1012 LeaveOutWitness => Useful,
1019 assert!(rows.iter().all(|r| r.len() == v.len()));
1021 let pcx = PatternContext {
1022 // TyErr is used to represent the type of wildcard patterns matching
1023 // against inaccessible (private) fields of structs, so that we won't
1024 // be able to observe whether the types of the struct's fields are
1027 // If the field is truly inaccessible, then all the patterns
1028 // matching against it must be wildcard patterns, so its type
1031 // However, if we are matching against non-wildcard patterns, we
1032 // need to know the real type of the field so we can specialize
1033 // against it. This primarily occurs through constants - they
1034 // can include contents for fields that are inaccessible at the
1035 // location of the match. In that case, the field's type is
1036 // inhabited - by the constant - so we can just use it.
1038 // FIXME: this might lead to "unstable" behavior with macro hygiene
1039 // introducing uninhabited patterns for inaccessible fields. We
1040 // need to figure out how to model that.
1041 ty: rows.iter().map(|r| r[0].ty).find(|ty| !ty.references_error()).unwrap_or(v[0].ty),
1042 max_slice_length: max_slice_length(cx, rows.iter().map(|r| r[0]).chain(Some(v[0])))
1045 debug!("is_useful_expand_first_col: pcx={:#?}, expanding {:#?}", pcx, v[0]);
1047 if let Some(constructors) = pat_constructors(cx, v[0], pcx) {
1048 debug!("is_useful - expanding constructors: {:#?}", constructors);
1049 split_grouped_constructors(cx.tcx, constructors, matrix, pcx.ty).into_iter().map(|c|
1050 is_useful_specialized(cx, matrix, v, c, pcx.ty, witness)
1051 ).find(|result| result.is_useful()).unwrap_or(NotUseful)
1053 debug!("is_useful - expanding wildcard");
1055 let used_ctors: Vec<Constructor> = rows.iter().flat_map(|row| {
1056 pat_constructors(cx, row[0], pcx).unwrap_or(vec![])
1058 debug!("used_ctors = {:#?}", used_ctors);
1059 // `all_ctors` are all the constructors for the given type, which
1060 // should all be represented (or caught with the wild pattern `_`).
1061 let all_ctors = all_constructors(cx, pcx);
1062 debug!("all_ctors = {:#?}", all_ctors);
1064 // `missing_ctors` is the set of constructors from the same type as the
1065 // first column of `matrix` that are matched only by wildcard patterns
1066 // from the first column.
1068 // Therefore, if there is some pattern that is unmatched by `matrix`,
1069 // it will still be unmatched if the first constructor is replaced by
1070 // any of the constructors in `missing_ctors`
1072 // However, if our scrutinee is *privately* an empty enum, we
1073 // must treat it as though it had an "unknown" constructor (in
1074 // that case, all other patterns obviously can't be variants)
1075 // to avoid exposing its emptyness. See the `match_privately_empty`
1076 // test for details.
1078 // FIXME: currently the only way I know of something can
1079 // be a privately-empty enum is when the exhaustive_patterns
1080 // feature flag is not present, so this is only
1081 // needed for that case.
1083 // Missing constructors are those that are not matched by any
1084 // non-wildcard patterns in the current column. We always determine if
1085 // the set is empty, but we only fully construct them on-demand,
1086 // because they're rarely used and can be big.
1087 let cheap_missing_ctors =
1088 compute_missing_ctors(MissingCtorsInfo::Emptiness, cx.tcx, &all_ctors, &used_ctors);
1090 let is_privately_empty = all_ctors.is_empty() && !cx.is_uninhabited(pcx.ty);
1091 let is_declared_nonexhaustive = cx.is_non_exhaustive_enum(pcx.ty) && !cx.is_local(pcx.ty);
1092 debug!("cheap_missing_ctors={:#?} is_privately_empty={:#?} is_declared_nonexhaustive={:#?}",
1093 cheap_missing_ctors, is_privately_empty, is_declared_nonexhaustive);
1095 // For privately empty and non-exhaustive enums, we work as if there were an "extra"
1096 // `_` constructor for the type, so we can never match over all constructors.
1097 let is_non_exhaustive = is_privately_empty || is_declared_nonexhaustive;
1099 if cheap_missing_ctors == MissingCtors::Empty && !is_non_exhaustive {
1100 split_grouped_constructors(cx.tcx, all_ctors, matrix, pcx.ty).into_iter().map(|c| {
1101 is_useful_specialized(cx, matrix, v, c, pcx.ty, witness)
1102 }).find(|result| result.is_useful()).unwrap_or(NotUseful)
1104 let matrix = rows.iter().filter_map(|r| {
1105 if r[0].is_wildcard() {
1106 Some(r[1..].to_vec())
1111 match is_useful(cx, &matrix, &v[1..], witness) {
1112 UsefulWithWitness(pats) => {
1114 // In this case, there's at least one "free"
1115 // constructor that is only matched against by
1116 // wildcard patterns.
1118 // There are 2 ways we can report a witness here.
1119 // Commonly, we can report all the "free"
1120 // constructors as witnesses, e.g. if we have:
1123 // enum Direction { N, S, E, W }
1124 // let Direction::N = ...;
1127 // we can report 3 witnesses: `S`, `E`, and `W`.
1129 // However, there are 2 cases where we don't want
1130 // to do this and instead report a single `_` witness:
1132 // 1) If the user is matching against a non-exhaustive
1133 // enum, there is no point in enumerating all possible
1134 // variants, because the user can't actually match
1135 // against them himself, e.g. in an example like:
1137 // let err: io::ErrorKind = ...;
1139 // io::ErrorKind::NotFound => {},
1142 // we don't want to show every possible IO error,
1143 // but instead have `_` as the witness (this is
1144 // actually *required* if the user specified *all*
1145 // IO errors, but is probably what we want in every
1148 // 2) If the user didn't actually specify a constructor
1149 // in this arm, e.g. in
1151 // let x: (Direction, Direction, bool) = ...;
1152 // let (_, _, false) = x;
1154 // we don't want to show all 16 possible witnesses
1155 // `(<direction-1>, <direction-2>, true)` - we are
1156 // satisfied with `(_, _, true)`. In this case,
1157 // `used_ctors` is empty.
1158 let new_witnesses = if is_non_exhaustive || used_ctors.is_empty() {
1159 // All constructors are unused. Add wild patterns
1160 // rather than each individual constructor.
1161 pats.into_iter().map(|mut witness| {
1162 witness.0.push(Pattern {
1165 kind: box PatternKind::Wild,
1170 let expensive_missing_ctors =
1171 compute_missing_ctors(MissingCtorsInfo::Ctors, cx.tcx, &all_ctors,
1173 if let MissingCtors::Ctors(missing_ctors) = expensive_missing_ctors {
1174 pats.into_iter().flat_map(|witness| {
1175 missing_ctors.iter().map(move |ctor| {
1176 // Extends the witness with a "wild" version of this
1177 // constructor, that matches everything that can be built with
1178 // it. For example, if `ctor` is a `Constructor::Variant` for
1179 // `Option::Some`, this pushes the witness for `Some(_)`.
1180 witness.clone().push_wild_constructor(cx, ctor, pcx.ty)
1184 bug!("cheap missing ctors")
1187 UsefulWithWitness(new_witnesses)
1195 /// A shorthand for the `U(S(c, P), S(c, q))` operation from the paper. I.e. `is_useful` applied
1196 /// to the specialised version of both the pattern matrix `P` and the new pattern `q`.
1197 fn is_useful_specialized<'p, 'a:'p, 'tcx: 'a>(
1198 cx: &mut MatchCheckCtxt<'a, 'tcx>,
1199 &Matrix(ref m): &Matrix<'p, 'tcx>,
1200 v: &[&'p Pattern<'tcx>],
1201 ctor: Constructor<'tcx>,
1203 witness: WitnessPreference,
1204 ) -> Usefulness<'tcx> {
1205 debug!("is_useful_specialized({:#?}, {:#?}, {:?})", v, ctor, lty);
1206 let sub_pat_tys = constructor_sub_pattern_tys(cx, &ctor, lty);
1207 let wild_patterns_owned: Vec<_> = sub_pat_tys.iter().map(|ty| {
1211 kind: box PatternKind::Wild,
1214 let wild_patterns: Vec<_> = wild_patterns_owned.iter().collect();
1215 let matrix = Matrix(m.iter().flat_map(|r| {
1216 specialize(cx, &r, &ctor, &wild_patterns)
1218 match specialize(cx, v, &ctor, &wild_patterns) {
1219 Some(v) => match is_useful(cx, &matrix, &v, witness) {
1220 UsefulWithWitness(witnesses) => UsefulWithWitness(
1221 witnesses.into_iter()
1222 .map(|witness| witness.apply_constructor(cx, &ctor, lty))
1231 /// Determines the constructors that the given pattern can be specialized to.
1233 /// In most cases, there's only one constructor that a specific pattern
1234 /// represents, such as a specific enum variant or a specific literal value.
1235 /// Slice patterns, however, can match slices of different lengths. For instance,
1236 /// `[a, b, ..tail]` can match a slice of length 2, 3, 4 and so on.
1238 /// Returns None in case of a catch-all, which can't be specialized.
1239 fn pat_constructors<'tcx>(cx: &mut MatchCheckCtxt<'_, 'tcx>,
1240 pat: &Pattern<'tcx>,
1241 pcx: PatternContext)
1242 -> Option<Vec<Constructor<'tcx>>>
1245 PatternKind::AscribeUserType { ref subpattern, .. } =>
1246 pat_constructors(cx, subpattern, pcx),
1247 PatternKind::Binding { .. } | PatternKind::Wild => None,
1248 PatternKind::Leaf { .. } | PatternKind::Deref { .. } => Some(vec![Single]),
1249 PatternKind::Variant { adt_def, variant_index, .. } => {
1250 Some(vec![Variant(adt_def.variants[variant_index].did)])
1252 PatternKind::Constant { value } => Some(vec![ConstantValue(value)]),
1253 PatternKind::Range { lo, hi, ty, end } =>
1254 Some(vec![ConstantRange(
1255 lo.to_bits(cx.tcx, ty::ParamEnv::empty().and(ty)).unwrap(),
1256 hi.to_bits(cx.tcx, ty::ParamEnv::empty().and(ty)).unwrap(),
1260 PatternKind::Array { .. } => match pcx.ty.sty {
1261 ty::Array(_, length) => Some(vec![
1262 Slice(length.unwrap_usize(cx.tcx))
1264 _ => span_bug!(pat.span, "bad ty {:?} for array pattern", pcx.ty)
1266 PatternKind::Slice { ref prefix, ref slice, ref suffix } => {
1267 let pat_len = prefix.len() as u64 + suffix.len() as u64;
1268 if slice.is_some() {
1269 Some((pat_len..pcx.max_slice_length+1).map(Slice).collect())
1271 Some(vec![Slice(pat_len)])
1277 /// This computes the arity of a constructor. The arity of a constructor
1278 /// is how many subpattern patterns of that constructor should be expanded to.
1280 /// For instance, a tuple pattern (_, 42, Some([])) has the arity of 3.
1281 /// A struct pattern's arity is the number of fields it contains, etc.
1282 fn constructor_arity(_cx: &MatchCheckCtxt, ctor: &Constructor, ty: Ty) -> u64 {
1283 debug!("constructor_arity({:#?}, {:?})", ctor, ty);
1285 ty::Tuple(ref fs) => fs.len() as u64,
1286 ty::Slice(..) | ty::Array(..) => match *ctor {
1287 Slice(length) => length,
1288 ConstantValue(_) => 0,
1289 _ => bug!("bad slice pattern {:?} {:?}", ctor, ty)
1292 ty::Adt(adt, _) => {
1293 adt.variants[ctor.variant_index_for_adt(adt)].fields.len() as u64
1299 /// This computes the types of the sub patterns that a constructor should be
1302 /// For instance, a tuple pattern (43u32, 'a') has sub pattern types [u32, char].
1303 fn constructor_sub_pattern_tys<'a, 'tcx: 'a>(cx: &MatchCheckCtxt<'a, 'tcx>,
1305 ty: Ty<'tcx>) -> Vec<Ty<'tcx>>
1307 debug!("constructor_sub_pattern_tys({:#?}, {:?})", ctor, ty);
1309 ty::Tuple(ref fs) => fs.into_iter().map(|t| *t).collect(),
1310 ty::Slice(ty) | ty::Array(ty, _) => match *ctor {
1311 Slice(length) => (0..length).map(|_| ty).collect(),
1312 ConstantValue(_) => vec![],
1313 _ => bug!("bad slice pattern {:?} {:?}", ctor, ty)
1315 ty::Ref(_, rty, _) => vec![rty],
1316 ty::Adt(adt, substs) => {
1318 // Use T as the sub pattern type of Box<T>.
1319 vec![substs.type_at(0)]
1321 adt.variants[ctor.variant_index_for_adt(adt)].fields.iter().map(|field| {
1322 let is_visible = adt.is_enum()
1323 || field.vis.is_accessible_from(cx.module, cx.tcx);
1325 field.ty(cx.tcx, substs)
1327 // Treat all non-visible fields as TyErr. They
1328 // can't appear in any other pattern from
1329 // this match (because they are private),
1330 // so their type does not matter - but
1331 // we don't want to know they are
1342 fn slice_pat_covered_by_constructor<'tcx>(
1343 tcx: TyCtxt<'_, 'tcx, '_>,
1346 prefix: &[Pattern<'tcx>],
1347 slice: &Option<Pattern<'tcx>>,
1348 suffix: &[Pattern<'tcx>]
1349 ) -> Result<bool, ErrorReported> {
1350 let data: &[u8] = match *ctor {
1351 ConstantValue(const_val) => {
1352 let val = match const_val.val {
1353 ConstValue::Unevaluated(..) |
1354 ConstValue::ByRef(..) => bug!("unexpected ConstValue: {:?}", const_val),
1355 ConstValue::Scalar(val) | ConstValue::ScalarPair(val, _) => val,
1357 if let Ok(ptr) = val.to_ptr() {
1358 tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id).bytes.as_ref()
1360 bug!("unexpected non-ptr ConstantValue")
1366 let pat_len = prefix.len() + suffix.len();
1367 if data.len() < pat_len || (slice.is_none() && data.len() > pat_len) {
1372 data[..prefix.len()].iter().zip(prefix).chain(
1373 data[data.len()-suffix.len()..].iter().zip(suffix))
1376 box PatternKind::Constant { value } => {
1377 let b = value.unwrap_bits(tcx, ty::ParamEnv::empty().and(pat.ty));
1378 assert_eq!(b as u8 as u128, b);
1390 // Whether to evaluate a constructor using exhaustive integer matching. This is true if the
1391 // constructor is a range or constant with an integer type.
1392 fn should_treat_range_exhaustively(tcx: TyCtxt<'_, 'tcx, 'tcx>, ctor: &Constructor<'tcx>) -> bool {
1393 if tcx.features().exhaustive_integer_patterns {
1394 let ty = match ctor {
1395 ConstantValue(value) => value.ty,
1396 ConstantRange(_, _, ty, _) => ty,
1399 if let ty::Char | ty::Int(_) | ty::Uint(_) = ty.sty {
1406 /// For exhaustive integer matching, some constructors are grouped within other constructors
1407 /// (namely integer typed values are grouped within ranges). However, when specialising these
1408 /// constructors, we want to be specialising for the underlying constructors (the integers), not
1409 /// the groups (the ranges). Thus we need to split the groups up. Splitting them up naïvely would
1410 /// mean creating a separate constructor for every single value in the range, which is clearly
1411 /// impractical. However, observe that for some ranges of integers, the specialisation will be
1412 /// identical across all values in that range (i.e. there are equivalence classes of ranges of
1413 /// constructors based on their `is_useful_specialized` outcome). These classes are grouped by
1414 /// the patterns that apply to them (in the matrix `P`). We can split the range whenever the
1415 /// patterns that apply to that range (specifically: the patterns that *intersect* with that range)
1417 /// Our solution, therefore, is to split the range constructor into subranges at every single point
1418 /// the group of intersecting patterns changes (using the method described below).
1419 /// And voilà! We're testing precisely those ranges that we need to, without any exhaustive matching
1420 /// on actual integers. The nice thing about this is that the number of subranges is linear in the
1421 /// number of rows in the matrix (i.e. the number of cases in the `match` statement), so we don't
1422 /// need to be worried about matching over gargantuan ranges.
1424 /// Essentially, given the first column of a matrix representing ranges, looking like the following:
1426 /// |------| |----------| |-------| ||
1427 /// |-------| |-------| |----| ||
1430 /// We split the ranges up into equivalence classes so the ranges are no longer overlapping:
1432 /// |--|--|||-||||--||---|||-------| |-|||| ||
1434 /// The logic for determining how to split the ranges is fairly straightforward: we calculate
1435 /// boundaries for each interval range, sort them, then create constructors for each new interval
1436 /// between every pair of boundary points. (This essentially sums up to performing the intuitive
1437 /// merging operation depicted above.)
1438 fn split_grouped_constructors<'p, 'a: 'p, 'tcx: 'a>(
1439 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1440 ctors: Vec<Constructor<'tcx>>,
1441 &Matrix(ref m): &Matrix<'p, 'tcx>,
1443 ) -> Vec<Constructor<'tcx>> {
1444 let mut split_ctors = Vec::with_capacity(ctors.len());
1446 for ctor in ctors.into_iter() {
1448 // For now, only ranges may denote groups of "subconstructors", so we only need to
1449 // special-case constant ranges.
1450 ConstantRange(..) if should_treat_range_exhaustively(tcx, &ctor) => {
1451 // We only care about finding all the subranges within the range of the constructor
1452 // range. Anything else is irrelevant, because it is guaranteed to result in
1453 // `NotUseful`, which is the default case anyway, and can be ignored.
1454 let ctor_range = IntRange::from_ctor(tcx, &ctor).unwrap();
1456 /// Represents a border between 2 integers. Because the intervals spanning borders
1457 /// must be able to cover every integer, we need to be able to represent
1458 /// 2^128 + 1 such borders.
1459 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
1465 // A function for extracting the borders of an integer interval.
1466 fn range_borders(r: IntRange<'_>) -> impl Iterator<Item = Border> {
1467 let (lo, hi) = r.range.into_inner();
1468 let from = Border::JustBefore(lo);
1469 let to = match hi.checked_add(1) {
1470 Some(m) => Border::JustBefore(m),
1471 None => Border::AfterMax,
1473 vec![from, to].into_iter()
1476 // `borders` is the set of borders between equivalence classes: each equivalence
1477 // class lies between 2 borders.
1478 let row_borders = m.iter()
1479 .flat_map(|row| IntRange::from_pat(tcx, row[0]))
1480 .flat_map(|range| ctor_range.intersection(&range))
1481 .flat_map(|range| range_borders(range));
1482 let ctor_borders = range_borders(ctor_range.clone());
1483 let mut borders: Vec<_> = row_borders.chain(ctor_borders).collect();
1484 borders.sort_unstable();
1486 // We're going to iterate through every pair of borders, making sure that each
1487 // represents an interval of nonnegative length, and convert each such interval
1488 // into a constructor.
1489 for IntRange { range, .. } in borders.windows(2).filter_map(|window| {
1490 match (window[0], window[1]) {
1491 (Border::JustBefore(n), Border::JustBefore(m)) => {
1493 Some(IntRange { range: n..=(m - 1), ty })
1498 (Border::JustBefore(n), Border::AfterMax) => {
1499 Some(IntRange { range: n..=u128::MAX, ty })
1501 (Border::AfterMax, _) => None,
1504 split_ctors.push(IntRange::range_to_ctor(tcx, ty, range));
1507 // Any other constructor can be used unchanged.
1508 _ => split_ctors.push(ctor),
1515 /// Check whether there exists any shared value in either `ctor` or `pat` by intersecting them.
1516 fn constructor_intersects_pattern<'p, 'a: 'p, 'tcx: 'a>(
1517 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1518 ctor: &Constructor<'tcx>,
1519 pat: &'p Pattern<'tcx>,
1520 ) -> Option<Vec<&'p Pattern<'tcx>>> {
1521 if should_treat_range_exhaustively(tcx, ctor) {
1522 match (IntRange::from_ctor(tcx, ctor), IntRange::from_pat(tcx, pat)) {
1523 (Some(ctor), Some(pat)) => {
1524 ctor.intersection(&pat).map(|_| {
1525 let (pat_lo, pat_hi) = pat.range.into_inner();
1526 let (ctor_lo, ctor_hi) = ctor.range.into_inner();
1527 assert!(pat_lo <= ctor_lo && ctor_hi <= pat_hi);
1534 // Fallback for non-ranges and ranges that involve floating-point numbers, which are not
1535 // conveniently handled by `IntRange`. For these cases, the constructor may not be a range
1536 // so intersection actually devolves into being covered by the pattern.
1537 match constructor_covered_by_range(tcx, ctor, pat) {
1538 Ok(true) => Some(vec![]),
1539 Ok(false) | Err(ErrorReported) => None,
1544 fn constructor_covered_by_range<'a, 'tcx>(
1545 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1546 ctor: &Constructor<'tcx>,
1547 pat: &Pattern<'tcx>,
1548 ) -> Result<bool, ErrorReported> {
1549 let (from, to, end, ty) = match pat.kind {
1550 box PatternKind::Constant { value } => (value, value, RangeEnd::Included, value.ty),
1551 box PatternKind::Range { lo, hi, ty, end } => (lo, hi, end, ty),
1552 _ => bug!("`constructor_covered_by_range` called with {:?}", pat),
1554 trace!("constructor_covered_by_range {:#?}, {:#?}, {:#?}, {}", ctor, from, to, ty);
1555 let cmp_from = |c_from| compare_const_vals(tcx, c_from, from, ty::ParamEnv::empty().and(ty))
1556 .map(|res| res != Ordering::Less);
1557 let cmp_to = |c_to| compare_const_vals(tcx, c_to, to, ty::ParamEnv::empty().and(ty));
1558 macro_rules! some_or_ok {
1562 None => return Ok(false), // not char or int
1567 ConstantValue(value) => {
1568 let to = some_or_ok!(cmp_to(value));
1569 let end = (to == Ordering::Less) ||
1570 (end == RangeEnd::Included && to == Ordering::Equal);
1571 Ok(some_or_ok!(cmp_from(value)) && end)
1573 ConstantRange(from, to, ty, RangeEnd::Included) => {
1574 let to = some_or_ok!(cmp_to(ty::Const::from_bits(
1577 ty::ParamEnv::empty().and(ty),
1579 let end = (to == Ordering::Less) ||
1580 (end == RangeEnd::Included && to == Ordering::Equal);
1581 Ok(some_or_ok!(cmp_from(ty::Const::from_bits(
1584 ty::ParamEnv::empty().and(ty),
1587 ConstantRange(from, to, ty, RangeEnd::Excluded) => {
1588 let to = some_or_ok!(cmp_to(ty::Const::from_bits(
1591 ty::ParamEnv::empty().and(ty)
1593 let end = (to == Ordering::Less) ||
1594 (end == RangeEnd::Excluded && to == Ordering::Equal);
1595 Ok(some_or_ok!(cmp_from(ty::Const::from_bits(
1598 ty::ParamEnv::empty().and(ty)))
1606 fn patterns_for_variant<'p, 'a: 'p, 'tcx: 'a>(
1607 subpatterns: &'p [FieldPattern<'tcx>],
1608 wild_patterns: &[&'p Pattern<'tcx>])
1609 -> Vec<&'p Pattern<'tcx>>
1611 let mut result = wild_patterns.to_owned();
1613 for subpat in subpatterns {
1614 result[subpat.field.index()] = &subpat.pattern;
1617 debug!("patterns_for_variant({:#?}, {:#?}) = {:#?}", subpatterns, wild_patterns, result);
1621 /// This is the main specialization step. It expands the first pattern in the given row
1622 /// into `arity` patterns based on the constructor. For most patterns, the step is trivial,
1623 /// for instance tuple patterns are flattened and box patterns expand into their inner pattern.
1625 /// OTOH, slice patterns with a subslice pattern (..tail) can be expanded into multiple
1626 /// different patterns.
1627 /// Structure patterns with a partial wild pattern (Foo { a: 42, .. }) have their missing
1628 /// fields filled with wild patterns.
1629 fn specialize<'p, 'a: 'p, 'tcx: 'a>(
1630 cx: &mut MatchCheckCtxt<'a, 'tcx>,
1631 r: &[&'p Pattern<'tcx>],
1632 constructor: &Constructor<'tcx>,
1633 wild_patterns: &[&'p Pattern<'tcx>],
1634 ) -> Option<Vec<&'p Pattern<'tcx>>> {
1637 let head: Option<Vec<&Pattern>> = match *pat.kind {
1638 PatternKind::AscribeUserType { ref subpattern, .. } =>
1639 specialize(cx, ::std::slice::from_ref(&subpattern), constructor, wild_patterns),
1641 PatternKind::Binding { .. } | PatternKind::Wild => {
1642 Some(wild_patterns.to_owned())
1645 PatternKind::Variant { adt_def, variant_index, ref subpatterns, .. } => {
1646 let ref variant = adt_def.variants[variant_index];
1647 if *constructor == Variant(variant.did) {
1648 Some(patterns_for_variant(subpatterns, wild_patterns))
1654 PatternKind::Leaf { ref subpatterns } => {
1655 Some(patterns_for_variant(subpatterns, wild_patterns))
1658 PatternKind::Deref { ref subpattern } => {
1659 Some(vec![subpattern])
1662 PatternKind::Constant { value } => {
1663 match *constructor {
1665 // we extract an `Option` for the pointer because slices of zero elements don't
1666 // necessarily point to memory, they are usually just integers. The only time
1667 // they should be pointing to memory is when they are subslices of nonzero
1669 let (opt_ptr, n, ty) = match value.ty.builtin_deref(false).unwrap().ty.sty {
1670 ty::TyKind::Array(t, n) => (value.to_ptr(), n.unwrap_usize(cx.tcx), t),
1671 ty::TyKind::Slice(t) => {
1673 ConstValue::ScalarPair(ptr, n) => (
1675 n.to_bits(cx.tcx.data_layout.pointer_size).unwrap() as u64,
1680 "slice pattern constant must be scalar pair but is {:?}",
1687 "unexpected const-val {:?} with ctor {:?}",
1692 if wild_patterns.len() as u64 == n {
1693 // convert a constant slice/array pattern to a list of patterns.
1694 match (n, opt_ptr) {
1695 (0, _) => Some(Vec::new()),
1697 let alloc = cx.tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id);
1698 let layout = cx.tcx.layout_of(cx.param_env.and(ty)).ok()?;
1700 let ptr = ptr.offset(layout.size * i, &cx.tcx).ok()?;
1701 let scalar = alloc.read_scalar(
1702 &cx.tcx, ptr, layout.size,
1704 let scalar = scalar.not_undef().ok()?;
1705 let value = ty::Const::from_scalar(cx.tcx, scalar, ty);
1706 let pattern = Pattern {
1709 kind: box PatternKind::Constant { value },
1711 Some(&*cx.pattern_arena.alloc(pattern))
1714 (_, None) => span_bug!(
1716 "non zero length slice with const-val {:?}",
1725 // If the constructor is a:
1726 // Single value: add a row if the constructor equals the pattern.
1727 // Range: add a row if the constructor contains the pattern.
1728 constructor_intersects_pattern(cx.tcx, constructor, pat)
1733 PatternKind::Range { .. } => {
1734 // If the constructor is a:
1735 // Single value: add a row if the pattern contains the constructor.
1736 // Range: add a row if the constructor intersects the pattern.
1737 constructor_intersects_pattern(cx.tcx, constructor, pat)
1740 PatternKind::Array { ref prefix, ref slice, ref suffix } |
1741 PatternKind::Slice { ref prefix, ref slice, ref suffix } => {
1742 match *constructor {
1744 let pat_len = prefix.len() + suffix.len();
1745 if let Some(slice_count) = wild_patterns.len().checked_sub(pat_len) {
1746 if slice_count == 0 || slice.is_some() {
1747 Some(prefix.iter().chain(
1748 wild_patterns.iter().map(|p| *p)
1751 .chain(suffix.iter())
1760 ConstantValue(..) => {
1761 match slice_pat_covered_by_constructor(
1762 cx.tcx, pat.span, constructor, prefix, slice, suffix
1764 Ok(true) => Some(vec![]),
1766 Err(ErrorReported) => None
1769 _ => span_bug!(pat.span,
1770 "unexpected ctor {:?} for slice pat", constructor)
1774 debug!("specialize({:#?}, {:#?}) = {:#?}", r[0], wild_patterns, head);
1776 head.map(|mut head| {
1777 head.extend_from_slice(&r[1 ..]);