1 /// Note: most tests relevant to this file can be found (at the time of writing)
2 /// in src/tests/ui/pattern/usefulness.
4 /// This file includes the logic for exhaustiveness and usefulness checking for
5 /// pattern-matching. Specifically, given a list of patterns for a type, we can
7 /// (a) the patterns cover every possible constructor for the type [exhaustiveness]
8 /// (b) each pattern is necessary [usefulness]
10 /// The algorithm implemented here is a modified version of the one described in:
11 /// http://moscova.inria.fr/~maranget/papers/warn/index.html
12 /// However, to save future implementors from reading the original paper, we
13 /// summarise the algorithm here to hopefully save time and be a little clearer
14 /// (without being so rigorous).
16 /// The core of the algorithm revolves about a "usefulness" check. In particular, we
17 /// are trying to compute a predicate `U(P, p)` where `P` is a list of patterns (we refer to this as
18 /// a matrix). `U(P, p)` represents whether, given an existing list of patterns
19 /// `P_1 ..= P_m`, adding a new pattern `p` will be "useful" (that is, cover previously-
20 /// uncovered values of the type).
22 /// If we have this predicate, then we can easily compute both exhaustiveness of an
23 /// entire set of patterns and the individual usefulness of each one.
24 /// (a) the set of patterns is exhaustive iff `U(P, _)` is false (i.e., adding a wildcard
25 /// match doesn't increase the number of values we're matching)
26 /// (b) a pattern `P_i` is not useful if `U(P[0..=(i-1), P_i)` is false (i.e., adding a
27 /// pattern to those that have come before it doesn't increase the number of values
30 /// During the course of the algorithm, the rows of the matrix won't just be individual patterns,
31 /// but rather partially-deconstructed patterns in the form of a list of patterns. The paper
32 /// calls those pattern-vectors, and we will call them pattern-stacks. The same holds for the
35 /// For example, say we have the following:
37 /// // x: (Option<bool>, Result<()>)
39 /// (Some(true), _) => {}
40 /// (None, Err(())) => {}
41 /// (None, Err(_)) => {}
44 /// Here, the matrix `P` starts as:
46 /// [(Some(true), _)],
47 /// [(None, Err(()))],
50 /// We can tell it's not exhaustive, because `U(P, _)` is true (we're not covering
51 /// `[(Some(false), _)]`, for instance). In addition, row 3 is not useful, because
52 /// all the values it covers are already covered by row 2.
54 /// A list of patterns can be thought of as a stack, because we are mainly interested in the top of
55 /// the stack at any given point, and we can pop or apply constructors to get new pattern-stacks.
56 /// To match the paper, the top of the stack is at the beginning / on the left.
58 /// There are two important operations on pattern-stacks necessary to understand the algorithm:
59 /// 1. We can pop a given constructor off the top of a stack. This operation is called
60 /// `specialize`, and is denoted `S(c, p)` where `c` is a constructor (like `Some` or
61 /// `None`) and `p` a pattern-stack.
62 /// If the pattern on top of the stack can cover `c`, this removes the constructor and
63 /// pushes its arguments onto the stack. It also expands OR-patterns into distinct patterns.
64 /// Otherwise the pattern-stack is discarded.
65 /// This essentially filters those pattern-stacks whose top covers the constructor `c` and
66 /// discards the others.
68 /// For example, the first pattern above initially gives a stack `[(Some(true), _)]`. If we
69 /// pop the tuple constructor, we are left with `[Some(true), _]`, and if we then pop the
70 /// `Some` constructor we get `[true, _]`. If we had popped `None` instead, we would get
73 /// This returns zero or more new pattern-stacks, as follows. We look at the pattern `p_1`
74 /// on top of the stack, and we have four cases:
75 /// 1.1. `p_1 = c(r_1, .., r_a)`, i.e. the top of the stack has constructor `c`. We
76 /// push onto the stack the arguments of this constructor, and return the result:
77 /// r_1, .., r_a, p_2, .., p_n
78 /// 1.2. `p_1 = c'(r_1, .., r_a')` where `c ≠ c'`. We discard the current stack and
80 /// 1.3. `p_1 = _`. We push onto the stack as many wildcards as the constructor `c` has
81 /// arguments (its arity), and return the resulting stack:
82 /// _, .., _, p_2, .., p_n
83 /// 1.4. `p_1 = r_1 | r_2`. We expand the OR-pattern and then recurse on each resulting
85 /// S(c, (r_1, p_2, .., p_n))
86 /// S(c, (r_2, p_2, .., p_n))
88 /// 2. We can pop a wildcard off the top of the stack. This is called `D(p)`, where `p` is
90 /// This is used when we know there are missing constructor cases, but there might be
91 /// existing wildcard patterns, so to check the usefulness of the matrix, we have to check
92 /// all its *other* components.
94 /// It is computed as follows. We look at the pattern `p_1` on top of the stack,
95 /// and we have three cases:
96 /// 1.1. `p_1 = c(r_1, .., r_a)`. We discard the current stack and return nothing.
97 /// 1.2. `p_1 = _`. We return the rest of the stack:
99 /// 1.3. `p_1 = r_1 | r_2`. We expand the OR-pattern and then recurse on each resulting
101 /// D((r_1, p_2, .., p_n))
102 /// D((r_2, p_2, .., p_n))
104 /// Note that the OR-patterns are not always used directly in Rust, but are used to derive the
105 /// exhaustive integer matching rules, so they're written here for posterity.
107 /// Both those operations extend straightforwardly to a list or pattern-stacks, i.e. a matrix, by
108 /// working row-by-row. Popping a constructor ends up keeping only the matrix rows that start with
109 /// the given constructor, and popping a wildcard keeps those rows that start with a wildcard.
112 /// The algorithm for computing `U`
113 /// -------------------------------
114 /// The algorithm is inductive (on the number of columns: i.e., components of tuple patterns).
115 /// That means we're going to check the components from left-to-right, so the algorithm
116 /// operates principally on the first component of the matrix and new pattern-stack `p`.
117 /// This algorithm is realised in the `is_useful` function.
119 /// Base case. (`n = 0`, i.e., an empty tuple pattern)
120 /// - If `P` already contains an empty pattern (i.e., if the number of patterns `m > 0`),
121 /// then `U(P, p)` is false.
122 /// - Otherwise, `P` must be empty, so `U(P, p)` is true.
124 /// Inductive step. (`n > 0`, i.e., whether there's at least one column
125 /// [which may then be expanded into further columns later])
126 /// We're going to match on the top of the new pattern-stack, `p_1`.
127 /// - If `p_1 == c(r_1, .., r_a)`, i.e. we have a constructor pattern.
128 /// Then, the usefulness of `p_1` can be reduced to whether it is useful when
129 /// we ignore all the patterns in the first column of `P` that involve other constructors.
130 /// This is where `S(c, P)` comes in:
131 /// `U(P, p) := U(S(c, P), S(c, p))`
132 /// This special case is handled in `is_useful_specialized`.
134 /// For example, if `P` is:
139 /// and `p` is [Some(false), 0], then we don't care about row 2 since we know `p` only
140 /// matches values that row 2 doesn't. For row 1 however, we need to dig into the
141 /// arguments of `Some` to know whether some new value is covered. So we compute
142 /// `U([[true, _]], [false, 0])`.
144 /// - If `p_1 == _`, then we look at the list of constructors that appear in the first
145 /// component of the rows of `P`:
146 /// + If there are some constructors that aren't present, then we might think that the
147 /// wildcard `_` is useful, since it covers those constructors that weren't covered
149 /// That's almost correct, but only works if there were no wildcards in those first
150 /// components. So we need to check that `p` is useful with respect to the rows that
151 /// start with a wildcard, if there are any. This is where `D` comes in:
152 /// `U(P, p) := U(D(P), D(p))`
154 /// For example, if `P` is:
157 /// [None, false, 1],
159 /// and `p` is [_, false, _], the `Some` constructor doesn't appear in `P`. So if we
160 /// only had row 2, we'd know that `p` is useful. However row 1 starts with a
161 /// wildcard, so we need to check whether `U([[true, _]], [false, 1])`.
163 /// + Otherwise, all possible constructors (for the relevant type) are present. In this
164 /// case we must check whether the wildcard pattern covers any unmatched value. For
165 /// that, we can think of the `_` pattern as a big OR-pattern that covers all
166 /// possible constructors. For `Option`, that would mean `_ = None | Some(_)` for
167 /// example. The wildcard pattern is useful in this case if it is useful when
168 /// specialized to one of the possible constructors. So we compute:
169 /// `U(P, p) := ∃(k ϵ constructors) U(S(k, P), S(k, p))`
171 /// For example, if `P` is:
176 /// and `p` is [_, false], both `None` and `Some` constructors appear in the first
177 /// components of `P`. We will therefore try popping both constructors in turn: we
178 /// compute U([[true, _]], [_, false]) for the `Some` constructor, and U([[false]],
179 /// [false]) for the `None` constructor. The first case returns true, so we know that
180 /// `p` is useful for `P`. Indeed, it matches `[Some(false), _]` that wasn't matched
183 /// - If `p_1 == r_1 | r_2`, then the usefulness depends on each `r_i` separately:
184 /// `U(P, p) := U(P, (r_1, p_2, .., p_n))
185 /// || U(P, (r_2, p_2, .., p_n))`
187 /// Modifications to the algorithm
188 /// ------------------------------
189 /// The algorithm in the paper doesn't cover some of the special cases that arise in Rust, for
190 /// example uninhabited types and variable-length slice patterns. These are drawn attention to
191 /// throughout the code below. I'll make a quick note here about how exhaustive integer matching is
192 /// accounted for, though.
194 /// Exhaustive integer matching
195 /// ---------------------------
196 /// An integer type can be thought of as a (huge) sum type: 1 | 2 | 3 | ...
197 /// So to support exhaustive integer matching, we can make use of the logic in the paper for
198 /// OR-patterns. However, we obviously can't just treat ranges x..=y as individual sums, because
199 /// they are likely gigantic. So we instead treat ranges as constructors of the integers. This means
200 /// that we have a constructor *of* constructors (the integers themselves). We then need to work
201 /// through all the inductive step rules above, deriving how the ranges would be treated as
202 /// OR-patterns, and making sure that they're treated in the same way even when they're ranges.
203 /// There are really only four special cases here:
204 /// - When we match on a constructor that's actually a range, we have to treat it as if we would
206 /// + It turns out that we can simply extend the case for single-value patterns in
207 /// `specialize` to either be *equal* to a value constructor, or *contained within* a range
209 /// + When the pattern itself is a range, you just want to tell whether any of the values in
210 /// the pattern range coincide with values in the constructor range, which is precisely
212 /// Since when encountering a range pattern for a value constructor, we also use inclusion, it
213 /// means that whenever the constructor is a value/range and the pattern is also a value/range,
214 /// we can simply use intersection to test usefulness.
215 /// - When we're testing for usefulness of a pattern and the pattern's first component is a
217 /// + If all the constructors appear in the matrix, we have a slight complication. By default,
218 /// the behaviour (i.e., a disjunction over specialised matrices for each constructor) is
219 /// invalid, because we want a disjunction over every *integer* in each range, not just a
220 /// disjunction over every range. This is a bit more tricky to deal with: essentially we need
221 /// to form equivalence classes of subranges of the constructor range for which the behaviour
222 /// of the matrix `P` and new pattern `p` are the same. This is described in more
223 /// detail in `split_grouped_constructors`.
224 /// + If some constructors are missing from the matrix, it turns out we don't need to do
225 /// anything special (because we know none of the integers are actually wildcards: i.e., we
226 /// can't span wildcards using ranges).
227 use self::Constructor::*;
228 use self::SliceKind::*;
229 use self::Usefulness::*;
230 use self::WitnessPreference::*;
232 use rustc_data_structures::captures::Captures;
233 use rustc_index::vec::Idx;
235 use super::{compare_const_vals, PatternFoldable, PatternFolder};
236 use super::{FieldPat, Pat, PatKind, PatRange};
238 use rustc::ty::layout::{Integer, IntegerExt, Size, VariantIdx};
239 use rustc::ty::{self, Const, Ty, TyCtxt, TypeFoldable, VariantDef};
240 use rustc_hir::def_id::DefId;
241 use rustc_hir::{HirId, RangeEnd};
244 use rustc::mir::interpret::{truncate, AllocId, ConstValue, Pointer, Scalar};
245 use rustc::mir::Field;
246 use rustc::util::common::ErrorReported;
248 use rustc_attr::{SignedInt, UnsignedInt};
249 use rustc_span::{Span, DUMMY_SP};
251 use arena::TypedArena;
253 use smallvec::{smallvec, SmallVec};
254 use std::borrow::Cow;
255 use std::cmp::{self, max, min, Ordering};
256 use std::convert::TryInto;
258 use std::iter::{FromIterator, IntoIterator};
259 use std::ops::RangeInclusive;
262 crate fn expand_pattern<'a, 'tcx>(cx: &MatchCheckCtxt<'a, 'tcx>, pat: Pat<'tcx>) -> Pat<'tcx> {
263 LiteralExpander { tcx: cx.tcx, param_env: cx.param_env }.fold_pattern(&pat)
266 struct LiteralExpander<'tcx> {
268 param_env: ty::ParamEnv<'tcx>,
271 impl<'tcx> LiteralExpander<'tcx> {
272 /// Derefs `val` and potentially unsizes the value if `crty` is an array and `rty` a slice.
274 /// `crty` and `rty` can differ because you can use array constants in the presence of slice
275 /// patterns. So the pattern may end up being a slice, but the constant is an array. We convert
276 /// the array to a slice in that case.
277 fn fold_const_value_deref(
279 val: ConstValue<'tcx>,
280 // the pattern's pointee type
282 // the constant's pointee type
284 ) -> ConstValue<'tcx> {
285 debug!("fold_const_value_deref {:?} {:?} {:?}", val, rty, crty);
286 match (val, &crty.kind, &rty.kind) {
287 // the easy case, deref a reference
288 (ConstValue::Scalar(p), x, y) if x == y => {
291 let alloc = self.tcx.alloc_map.lock().unwrap_memory(p.alloc_id);
292 ConstValue::ByRef { alloc, offset: p.offset }
294 Scalar::Raw { .. } => {
295 let layout = self.tcx.layout_of(self.param_env.and(rty)).unwrap();
297 // Deref of a reference to a ZST is a nop.
298 ConstValue::Scalar(Scalar::zst())
300 // FIXME(oli-obk): this is reachable for `const FOO: &&&u32 = &&&42;`
301 bug!("cannot deref {:#?}, {} -> {}", val, crty, rty);
306 // unsize array to slice if pattern is array but match value or other patterns are slice
307 (ConstValue::Scalar(Scalar::Ptr(p)), ty::Array(t, n), ty::Slice(u)) => {
310 data: self.tcx.alloc_map.lock().unwrap_memory(p.alloc_id),
311 start: p.offset.bytes().try_into().unwrap(),
312 end: n.eval_usize(self.tcx, ty::ParamEnv::empty()).try_into().unwrap(),
315 // fat pointers stay the same
316 (ConstValue::Slice { .. }, _, _)
317 | (_, ty::Slice(_), ty::Slice(_))
318 | (_, ty::Str, ty::Str) => val,
319 // FIXME(oli-obk): this is reachable for `const FOO: &&&u32 = &&&42;` being used
320 _ => bug!("cannot deref {:#?}, {} -> {}", val, crty, rty),
325 impl<'tcx> PatternFolder<'tcx> for LiteralExpander<'tcx> {
326 fn fold_pattern(&mut self, pat: &Pat<'tcx>) -> Pat<'tcx> {
327 debug!("fold_pattern {:?} {:?} {:?}", pat, pat.ty.kind, pat.kind);
328 match (&pat.ty.kind, &*pat.kind) {
334 val: ty::ConstKind::Value(val),
335 ty: ty::TyS { kind: ty::Ref(_, crty, _), .. },
341 kind: box PatKind::Deref {
345 kind: box PatKind::Constant {
346 value: Const::from_value(
348 self.fold_const_value_deref(*val, rty, crty),
359 value: Const { val, ty: ty::TyS { kind: ty::Ref(_, crty, _), .. } },
361 ) => bug!("cannot deref {:#?}, {} -> {}", val, crty, rty),
363 (_, &PatKind::Binding { subpattern: Some(ref s), .. }) => s.fold_with(self),
364 (_, &PatKind::AscribeUserType { subpattern: ref s, .. }) => s.fold_with(self),
365 _ => pat.super_fold_with(self),
370 impl<'tcx> Pat<'tcx> {
371 pub(super) fn is_wildcard(&self) -> bool {
373 PatKind::Binding { subpattern: None, .. } | PatKind::Wild => true,
379 /// A row of a matrix. Rows of len 1 are very common, which is why `SmallVec[_; 2]`
381 #[derive(Debug, Clone)]
382 crate struct PatStack<'p, 'tcx>(SmallVec<[&'p Pat<'tcx>; 2]>);
384 impl<'p, 'tcx> PatStack<'p, 'tcx> {
385 crate fn from_pattern(pat: &'p Pat<'tcx>) -> Self {
386 PatStack(smallvec![pat])
389 fn from_vec(vec: SmallVec<[&'p Pat<'tcx>; 2]>) -> Self {
393 fn from_slice(s: &[&'p Pat<'tcx>]) -> Self {
394 PatStack(SmallVec::from_slice(s))
397 fn is_empty(&self) -> bool {
401 fn len(&self) -> usize {
405 fn head(&self) -> &'p Pat<'tcx> {
409 fn to_tail(&self) -> Self {
410 PatStack::from_slice(&self.0[1..])
413 fn iter(&self) -> impl Iterator<Item = &Pat<'tcx>> {
414 self.0.iter().copied()
417 // If the first pattern is an or-pattern, expand this pattern. Otherwise, return `None`.
418 fn expand_or_pat(&self) -> Option<Vec<Self>> {
421 } else if let PatKind::Or { pats } = &*self.head().kind {
425 let mut new_patstack = PatStack::from_pattern(pat);
426 new_patstack.0.extend_from_slice(&self.0[1..]);
436 /// This computes `D(self)`. See top of the file for explanations.
437 fn specialize_wildcard(&self) -> Option<Self> {
438 if self.head().is_wildcard() { Some(self.to_tail()) } else { None }
441 /// This computes `S(constructor, self)`. See top of the file for explanations.
442 fn specialize_constructor(
444 cx: &mut MatchCheckCtxt<'p, 'tcx>,
445 constructor: &Constructor<'tcx>,
446 ctor_wild_subpatterns: &'p [Pat<'tcx>],
447 ) -> Option<PatStack<'p, 'tcx>> {
448 let new_heads = specialize_one_pattern(cx, self.head(), constructor, ctor_wild_subpatterns);
449 new_heads.map(|mut new_head| {
450 new_head.0.extend_from_slice(&self.0[1..]);
456 impl<'p, 'tcx> Default for PatStack<'p, 'tcx> {
457 fn default() -> Self {
458 PatStack(smallvec![])
462 impl<'p, 'tcx> FromIterator<&'p Pat<'tcx>> for PatStack<'p, 'tcx> {
463 fn from_iter<T>(iter: T) -> Self
465 T: IntoIterator<Item = &'p Pat<'tcx>>,
467 PatStack(iter.into_iter().collect())
473 crate struct Matrix<'p, 'tcx>(Vec<PatStack<'p, 'tcx>>);
475 impl<'p, 'tcx> Matrix<'p, 'tcx> {
476 crate fn empty() -> Self {
480 /// Pushes a new row to the matrix. If the row starts with an or-pattern, this expands it.
481 crate fn push(&mut self, row: PatStack<'p, 'tcx>) {
482 if let Some(rows) = row.expand_or_pat() {
489 /// Iterate over the first component of each row
490 fn heads<'a>(&'a self) -> impl Iterator<Item = &'a Pat<'tcx>> + Captures<'p> {
491 self.0.iter().map(|r| r.head())
494 /// This computes `D(self)`. See top of the file for explanations.
495 fn specialize_wildcard(&self) -> Self {
496 self.0.iter().filter_map(|r| r.specialize_wildcard()).collect()
499 /// This computes `S(constructor, self)`. See top of the file for explanations.
500 fn specialize_constructor(
502 cx: &mut MatchCheckCtxt<'p, 'tcx>,
503 constructor: &Constructor<'tcx>,
504 ctor_wild_subpatterns: &'p [Pat<'tcx>],
505 ) -> Matrix<'p, 'tcx> {
508 .filter_map(|r| r.specialize_constructor(cx, constructor, ctor_wild_subpatterns))
513 /// Pretty-printer for matrices of patterns, example:
514 /// +++++++++++++++++++++++++++++
516 /// +++++++++++++++++++++++++++++
517 /// + true + [First] +
518 /// +++++++++++++++++++++++++++++
519 /// + true + [Second(true)] +
520 /// +++++++++++++++++++++++++++++
522 /// +++++++++++++++++++++++++++++
523 /// + _ + [_, _, tail @ ..] +
524 /// +++++++++++++++++++++++++++++
525 impl<'p, 'tcx> fmt::Debug for Matrix<'p, 'tcx> {
526 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
529 let &Matrix(ref m) = self;
530 let pretty_printed_matrix: Vec<Vec<String>> =
531 m.iter().map(|row| row.iter().map(|pat| format!("{:?}", pat)).collect()).collect();
533 let column_count = m.iter().map(|row| row.len()).max().unwrap_or(0);
534 assert!(m.iter().all(|row| row.len() == column_count));
535 let column_widths: Vec<usize> = (0..column_count)
536 .map(|col| pretty_printed_matrix.iter().map(|row| row[col].len()).max().unwrap_or(0))
539 let total_width = column_widths.iter().cloned().sum::<usize>() + column_count * 3 + 1;
540 let br = "+".repeat(total_width);
541 write!(f, "{}\n", br)?;
542 for row in pretty_printed_matrix {
544 for (column, pat_str) in row.into_iter().enumerate() {
546 write!(f, "{:1$}", pat_str, column_widths[column])?;
550 write!(f, "{}\n", br)?;
556 impl<'p, 'tcx> FromIterator<PatStack<'p, 'tcx>> for Matrix<'p, 'tcx> {
557 fn from_iter<T>(iter: T) -> Self
559 T: IntoIterator<Item = PatStack<'p, 'tcx>>,
561 let mut matrix = Matrix::empty();
563 // Using `push` ensures we correctly expand or-patterns.
570 crate struct MatchCheckCtxt<'a, 'tcx> {
571 crate tcx: TyCtxt<'tcx>,
572 /// The module in which the match occurs. This is necessary for
573 /// checking inhabited-ness of types because whether a type is (visibly)
574 /// inhabited can depend on whether it was defined in the current module or
575 /// not. E.g., `struct Foo { _private: ! }` cannot be seen to be empty
576 /// outside it's module and should not be matchable with an empty match
579 param_env: ty::ParamEnv<'tcx>,
580 crate pattern_arena: &'a TypedArena<Pat<'tcx>>,
583 impl<'a, 'tcx> MatchCheckCtxt<'a, 'tcx> {
584 crate fn create_and_enter<R>(
586 param_env: ty::ParamEnv<'tcx>,
588 f: impl FnOnce(MatchCheckCtxt<'_, 'tcx>) -> R,
590 let pattern_arena = TypedArena::default();
592 f(MatchCheckCtxt { tcx, param_env, module, pattern_arena: &pattern_arena })
595 fn is_uninhabited(&self, ty: Ty<'tcx>) -> bool {
596 if self.tcx.features().exhaustive_patterns {
597 self.tcx.is_ty_uninhabited_from(self.module, ty)
603 // Returns whether the given type is an enum from another crate declared `#[non_exhaustive]`.
604 crate fn is_foreign_non_exhaustive_enum(&self, ty: Ty<'tcx>) -> bool {
606 ty::Adt(def, ..) => {
607 def.is_enum() && def.is_variant_list_non_exhaustive() && !def.did.is_local()
613 // Returns whether the given variant is from another crate and has its fields declared
614 // `#[non_exhaustive]`.
615 fn is_foreign_non_exhaustive_variant(&self, ty: Ty<'tcx>, variant: &VariantDef) -> bool {
617 ty::Adt(def, ..) => variant.is_field_list_non_exhaustive() && !def.did.is_local(),
623 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
625 /// Patterns of length `n` (`[x, y]`).
627 /// Patterns using the `..` notation (`[x, .., y]`).
628 /// Captures any array constructor of `length >= i + j`.
629 /// In the case where `array_len` is `Some(_)`,
630 /// this indicates that we only care about the first `i` and the last `j` values of the array,
631 /// and everything in between is a wildcard `_`.
636 fn arity(self) -> u64 {
638 FixedLen(length) => length,
639 VarLen(prefix, suffix) => prefix + suffix,
643 /// Whether this pattern includes patterns of length `other_len`.
644 fn covers_length(self, other_len: u64) -> bool {
646 FixedLen(len) => len == other_len,
647 VarLen(prefix, suffix) => prefix + suffix <= other_len,
651 /// Returns a collection of slices that spans the values covered by `self`, subtracted by the
652 /// values covered by `other`: i.e., `self \ other` (in set notation).
653 fn subtract(self, other: Self) -> SmallVec<[Self; 1]> {
654 // Remember, `VarLen(i, j)` covers the union of `FixedLen` from `i + j` to infinity.
655 // Naming: we remove the "neg" constructors from the "pos" ones.
657 FixedLen(pos_len) => {
658 if other.covers_length(pos_len) {
664 VarLen(pos_prefix, pos_suffix) => {
665 let pos_len = pos_prefix + pos_suffix;
667 FixedLen(neg_len) => {
668 if neg_len < pos_len {
673 // We know that `neg_len + 1 >= pos_len >= pos_suffix`.
674 .chain(Some(VarLen(neg_len + 1 - pos_suffix, pos_suffix)))
678 VarLen(neg_prefix, neg_suffix) => {
679 let neg_len = neg_prefix + neg_suffix;
680 if neg_len <= pos_len {
683 (pos_len..neg_len).map(FixedLen).collect()
692 /// A constructor for array and slice patterns.
693 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
695 /// `None` if the matched value is a slice, `Some(n)` if it is an array of size `n`.
696 array_len: Option<u64>,
697 /// The kind of pattern it is: fixed-length `[x, y]` or variable length `[x, .., y]`.
702 /// Returns what patterns this constructor covers: either fixed-length patterns or
703 /// variable-length patterns.
704 fn pattern_kind(self) -> SliceKind {
706 Slice { array_len: Some(len), kind: VarLen(prefix, suffix) }
707 if prefix + suffix == len =>
715 /// Returns what values this constructor covers: either values of only one given length, or
716 /// values of length above a given length.
717 /// This is different from `pattern_kind()` because in some cases the pattern only takes into
718 /// account a subset of the entries of the array, but still only captures values of a given
720 fn value_kind(self) -> SliceKind {
722 Slice { array_len: Some(len), kind: VarLen(_, _) } => FixedLen(len),
727 fn arity(self) -> u64 {
728 self.pattern_kind().arity()
732 #[derive(Clone, Debug, PartialEq)]
733 enum Constructor<'tcx> {
734 /// The constructor of all patterns that don't vary by constructor,
735 /// e.g., struct patterns and fixed-length arrays.
740 ConstantValue(&'tcx ty::Const<'tcx>),
741 /// Ranges of integer literal values (`2`, `2..=5` or `2..5`).
742 IntRange(IntRange<'tcx>),
743 /// Ranges of floating-point literal values (`2.0..=5.2`).
744 FloatRange(&'tcx ty::Const<'tcx>, &'tcx ty::Const<'tcx>, RangeEnd),
745 /// Array and slice patterns.
747 /// Fake extra constructor for enums that aren't allowed to be matched exhaustively.
751 impl<'tcx> Constructor<'tcx> {
752 fn is_slice(&self) -> bool {
759 fn variant_index_for_adt<'a>(
761 cx: &MatchCheckCtxt<'a, 'tcx>,
762 adt: &'tcx ty::AdtDef,
765 Variant(id) => adt.variant_index_with_id(id),
767 assert!(!adt.is_enum());
770 ConstantValue(c) => cx.tcx.destructure_const(cx.param_env.and(c)).variant,
771 _ => bug!("bad constructor {:?} for adt {:?}", self, adt),
775 // Returns the set of constructors covered by `self` but not by
776 // anything in `other_ctors`.
777 fn subtract_ctors(&self, other_ctors: &Vec<Constructor<'tcx>>) -> Vec<Constructor<'tcx>> {
778 if other_ctors.is_empty() {
779 return vec![self.clone()];
783 // Those constructors can only match themselves.
784 Single | Variant(_) | ConstantValue(..) | FloatRange(..) => {
785 if other_ctors.iter().any(|c| c == self) { vec![] } else { vec![self.clone()] }
788 let mut other_slices = other_ctors
790 .filter_map(|c: &Constructor<'_>| match c {
791 Slice(slice) => Some(*slice),
792 // FIXME(oli-obk): implement `deref` for `ConstValue`
793 ConstantValue(..) => None,
794 _ => bug!("bad slice pattern constructor {:?}", c),
796 .map(Slice::value_kind);
798 match slice.value_kind() {
799 FixedLen(self_len) => {
800 if other_slices.any(|other_slice| other_slice.covers_length(self_len)) {
806 kind @ VarLen(..) => {
807 let mut remaining_slices = vec![kind];
809 // For each used slice, subtract from the current set of slices.
810 for other_slice in other_slices {
811 remaining_slices = remaining_slices
813 .flat_map(|remaining_slice| remaining_slice.subtract(other_slice))
816 // If the constructors that have been considered so far already cover
817 // the entire range of `self`, no need to look at more constructors.
818 if remaining_slices.is_empty() {
825 .map(|kind| Slice { array_len: slice.array_len, kind })
831 IntRange(self_range) => {
832 let mut remaining_ranges = vec![self_range.clone()];
833 for other_ctor in other_ctors {
834 if let IntRange(other_range) = other_ctor {
835 if other_range == self_range {
836 // If the `self` range appears directly in a `match` arm, we can
837 // eliminate it straight away.
838 remaining_ranges = vec![];
840 // Otherwise explicitly compute the remaining ranges.
841 remaining_ranges = other_range.subtract_from(remaining_ranges);
844 // If the ranges that have been considered so far already cover the entire
845 // range of values, we can return early.
846 if remaining_ranges.is_empty() {
852 // Convert the ranges back into constructors.
853 remaining_ranges.into_iter().map(IntRange).collect()
855 // This constructor is never covered by anything else
856 NonExhaustive => vec![NonExhaustive],
860 /// This returns one wildcard pattern for each argument to this constructor.
862 /// This must be consistent with `apply`, `specialize_one_pattern`, and `arity`.
863 fn wildcard_subpatterns<'a>(
865 cx: &MatchCheckCtxt<'a, 'tcx>,
867 ) -> Vec<Pat<'tcx>> {
868 debug!("wildcard_subpatterns({:#?}, {:?})", self, ty);
871 Single | Variant(_) => match ty.kind {
872 ty::Tuple(ref fs) => {
873 fs.into_iter().map(|t| t.expect_ty()).map(Pat::wildcard_from_ty).collect()
875 ty::Ref(_, rty, _) => vec![Pat::wildcard_from_ty(rty)],
876 ty::Adt(adt, substs) => {
878 // Use T as the sub pattern type of Box<T>.
879 vec![Pat::wildcard_from_ty(substs.type_at(0))]
881 let variant = &adt.variants[self.variant_index_for_adt(cx, adt)];
882 let is_non_exhaustive = cx.is_foreign_non_exhaustive_variant(ty, variant);
887 let is_visible = adt.is_enum()
888 || field.vis.is_accessible_from(cx.module, cx.tcx);
889 let is_uninhabited = cx.is_uninhabited(field.ty(cx.tcx, substs));
890 match (is_visible, is_non_exhaustive, is_uninhabited) {
891 // Treat all uninhabited types in non-exhaustive variants as
893 (_, true, true) => cx.tcx.types.err,
894 // Treat all non-visible fields as `TyErr`. They can't appear
895 // in any other pattern from this match (because they are
896 // private), so their type does not matter - but we don't want
897 // to know they are uninhabited.
898 (false, ..) => cx.tcx.types.err,
900 let ty = field.ty(cx.tcx, substs);
902 // If the field type returned is an array of an unknown
903 // size return an TyErr.
906 .try_eval_usize(cx.tcx, cx.param_env)
916 .map(Pat::wildcard_from_ty)
922 Slice(_) => match ty.kind {
923 ty::Slice(ty) | ty::Array(ty, _) => {
924 let arity = self.arity(cx, ty);
925 (0..arity).map(|_| Pat::wildcard_from_ty(ty)).collect()
927 _ => bug!("bad slice pattern {:?} {:?}", self, ty),
929 ConstantValue(..) | FloatRange(..) | IntRange(..) | NonExhaustive => vec![],
933 /// This computes the arity of a constructor. The arity of a constructor
934 /// is how many subpattern patterns of that constructor should be expanded to.
936 /// For instance, a tuple pattern `(_, 42, Some([]))` has the arity of 3.
937 /// A struct pattern's arity is the number of fields it contains, etc.
939 /// This must be consistent with `wildcard_subpatterns`, `specialize_one_pattern`, and `apply`.
940 fn arity<'a>(&self, cx: &MatchCheckCtxt<'a, 'tcx>, ty: Ty<'tcx>) -> u64 {
941 debug!("Constructor::arity({:#?}, {:?})", self, ty);
943 Single | Variant(_) => match ty.kind {
944 ty::Tuple(ref fs) => fs.len() as u64,
945 ty::Slice(..) | ty::Array(..) => bug!("bad slice pattern {:?} {:?}", self, ty),
948 adt.variants[self.variant_index_for_adt(cx, adt)].fields.len() as u64
952 Slice(slice) => slice.arity(),
953 ConstantValue(..) | FloatRange(..) | IntRange(..) | NonExhaustive => 0,
957 /// Apply a constructor to a list of patterns, yielding a new pattern. `pats`
958 /// must have as many elements as this constructor's arity.
960 /// This must be consistent with `wildcard_subpatterns`, `specialize_one_pattern`, and `arity`.
963 /// `self`: `Constructor::Single`
964 /// `ty`: `(u32, u32, u32)`
965 /// `pats`: `[10, 20, _]`
966 /// returns `(10, 20, _)`
968 /// `self`: `Constructor::Variant(Option::Some)`
969 /// `ty`: `Option<bool>`
970 /// `pats`: `[false]`
971 /// returns `Some(false)`
974 cx: &MatchCheckCtxt<'a, 'tcx>,
976 pats: impl IntoIterator<Item = Pat<'tcx>>,
978 let mut subpatterns = pats.into_iter();
980 let pat = match self {
981 Single | Variant(_) => match ty.kind {
982 ty::Adt(..) | ty::Tuple(..) => {
983 let subpatterns = subpatterns
985 .map(|(i, p)| FieldPat { field: Field::new(i), pattern: p })
988 if let ty::Adt(adt, substs) = ty.kind {
993 variant_index: self.variant_index_for_adt(cx, adt),
997 PatKind::Leaf { subpatterns }
1000 PatKind::Leaf { subpatterns }
1003 ty::Ref(..) => PatKind::Deref { subpattern: subpatterns.next().unwrap() },
1004 ty::Slice(_) | ty::Array(..) => bug!("bad slice pattern {:?} {:?}", self, ty),
1007 Slice(slice) => match slice.pattern_kind() {
1009 PatKind::Slice { prefix: subpatterns.collect(), slice: None, suffix: vec![] }
1011 VarLen(prefix, _) => {
1012 let mut prefix: Vec<_> = subpatterns.by_ref().take(prefix as usize).collect();
1013 if slice.array_len.is_some() {
1014 // Improves diagnostics a bit: if the type is a known-size array, instead
1015 // of reporting `[x, _, .., _, y]`, we prefer to report `[x, .., y]`.
1016 // This is incorrect if the size is not known, since `[_, ..]` captures
1017 // arrays of lengths `>= 1` whereas `[..]` captures any length.
1018 while !prefix.is_empty() && prefix.last().unwrap().is_wildcard() {
1022 let suffix: Vec<_> = if slice.array_len.is_some() {
1024 subpatterns.skip_while(Pat::is_wildcard).collect()
1026 subpatterns.collect()
1028 let wild = Pat::wildcard_from_ty(ty);
1029 PatKind::Slice { prefix, slice: Some(wild), suffix }
1032 &ConstantValue(value) => PatKind::Constant { value },
1033 &FloatRange(lo, hi, end) => PatKind::Range(PatRange { lo, hi, end }),
1034 IntRange(range) => return range.to_pat(cx.tcx),
1035 NonExhaustive => PatKind::Wild,
1038 Pat { ty, span: DUMMY_SP, kind: Box::new(pat) }
1041 /// Like `apply`, but where all the subpatterns are wildcards `_`.
1042 fn apply_wildcards<'a>(&self, cx: &MatchCheckCtxt<'a, 'tcx>, ty: Ty<'tcx>) -> Pat<'tcx> {
1043 let subpatterns = self.wildcard_subpatterns(cx, ty).into_iter().rev();
1044 self.apply(cx, ty, subpatterns)
1048 #[derive(Clone, Debug)]
1049 crate enum Usefulness<'tcx, 'p> {
1050 /// Carries a list of unreachable subpatterns. Used only in the presence of or-patterns.
1051 Useful(Vec<&'p Pat<'tcx>>),
1052 /// Carries a list of witnesses of non-exhaustiveness.
1053 UsefulWithWitness(Vec<Witness<'tcx>>),
1057 impl<'tcx, 'p> Usefulness<'tcx, 'p> {
1058 fn new_useful(preference: WitnessPreference) -> Self {
1060 ConstructWitness => UsefulWithWitness(vec![Witness(vec![])]),
1061 LeaveOutWitness => Useful(vec![]),
1065 fn is_useful(&self) -> bool {
1072 fn apply_constructor(
1074 cx: &MatchCheckCtxt<'_, 'tcx>,
1075 ctor: &Constructor<'tcx>,
1079 UsefulWithWitness(witnesses) => UsefulWithWitness(
1082 .map(|witness| witness.apply_constructor(cx, &ctor, ty))
1089 fn apply_wildcard(self, ty: Ty<'tcx>) -> Self {
1091 UsefulWithWitness(witnesses) => {
1092 let wild = Pat::wildcard_from_ty(ty);
1096 .map(|mut witness| {
1097 witness.0.push(wild.clone());
1107 fn apply_missing_ctors(
1109 cx: &MatchCheckCtxt<'_, 'tcx>,
1111 missing_ctors: &MissingConstructors<'tcx>,
1114 UsefulWithWitness(witnesses) => {
1115 let new_patterns: Vec<_> =
1116 missing_ctors.iter().map(|ctor| ctor.apply_wildcards(cx, ty)).collect();
1117 // Add the new patterns to each witness
1121 .flat_map(|witness| {
1122 new_patterns.iter().map(move |pat| {
1123 let mut witness = witness.clone();
1124 witness.0.push(pat.clone());
1136 #[derive(Copy, Clone, Debug)]
1137 crate enum WitnessPreference {
1142 #[derive(Copy, Clone, Debug)]
1143 struct PatCtxt<'tcx> {
1148 /// A witness of non-exhaustiveness for error reporting, represented
1149 /// as a list of patterns (in reverse order of construction) with
1150 /// wildcards inside to represent elements that can take any inhabitant
1151 /// of the type as a value.
1153 /// A witness against a list of patterns should have the same types
1154 /// and length as the pattern matched against. Because Rust `match`
1155 /// is always against a single pattern, at the end the witness will
1156 /// have length 1, but in the middle of the algorithm, it can contain
1157 /// multiple patterns.
1159 /// For example, if we are constructing a witness for the match against
1161 /// struct Pair(Option<(u32, u32)>, bool);
1163 /// match (p: Pair) {
1164 /// Pair(None, _) => {}
1165 /// Pair(_, false) => {}
1169 /// We'll perform the following steps:
1170 /// 1. Start with an empty witness
1171 /// `Witness(vec![])`
1172 /// 2. Push a witness `Some(_)` against the `None`
1173 /// `Witness(vec![Some(_)])`
1174 /// 3. Push a witness `true` against the `false`
1175 /// `Witness(vec![Some(_), true])`
1176 /// 4. Apply the `Pair` constructor to the witnesses
1177 /// `Witness(vec![Pair(Some(_), true)])`
1179 /// The final `Pair(Some(_), true)` is then the resulting witness.
1180 #[derive(Clone, Debug)]
1181 crate struct Witness<'tcx>(Vec<Pat<'tcx>>);
1183 impl<'tcx> Witness<'tcx> {
1184 crate fn single_pattern(self) -> Pat<'tcx> {
1185 assert_eq!(self.0.len(), 1);
1186 self.0.into_iter().next().unwrap()
1189 /// Constructs a partial witness for a pattern given a list of
1190 /// patterns expanded by the specialization step.
1192 /// When a pattern P is discovered to be useful, this function is used bottom-up
1193 /// to reconstruct a complete witness, e.g., a pattern P' that covers a subset
1194 /// of values, V, where each value in that set is not covered by any previously
1195 /// used patterns and is covered by the pattern P'. Examples:
1197 /// left_ty: tuple of 3 elements
1198 /// pats: [10, 20, _] => (10, 20, _)
1200 /// left_ty: struct X { a: (bool, &'static str), b: usize}
1201 /// pats: [(false, "foo"), 42] => X { a: (false, "foo"), b: 42 }
1202 fn apply_constructor<'a>(
1204 cx: &MatchCheckCtxt<'a, 'tcx>,
1205 ctor: &Constructor<'tcx>,
1208 let arity = ctor.arity(cx, ty);
1210 let len = self.0.len() as u64;
1211 let pats = self.0.drain((len - arity) as usize..).rev();
1212 ctor.apply(cx, ty, pats)
1221 /// This determines the set of all possible constructors of a pattern matching
1222 /// values of type `left_ty`. For vectors, this would normally be an infinite set
1223 /// but is instead bounded by the maximum fixed length of slice patterns in
1224 /// the column of patterns being analyzed.
1226 /// We make sure to omit constructors that are statically impossible. E.g., for
1227 /// `Option<!>`, we do not include `Some(_)` in the returned list of constructors.
1228 /// Invariant: this returns an empty `Vec` if and only if the type is uninhabited (as determined by
1229 /// `cx.is_uninhabited()`).
1230 fn all_constructors<'a, 'tcx>(
1231 cx: &mut MatchCheckCtxt<'a, 'tcx>,
1233 ) -> Vec<Constructor<'tcx>> {
1234 debug!("all_constructors({:?})", pcx.ty);
1235 let make_range = |start, end| {
1237 // `unwrap()` is ok because we know the type is an integer.
1238 IntRange::from_range(cx.tcx, start, end, pcx.ty, &RangeEnd::Included, pcx.span)
1244 [true, false].iter().map(|&b| ConstantValue(ty::Const::from_bool(cx.tcx, b))).collect()
1246 ty::Array(ref sub_ty, len) if len.try_eval_usize(cx.tcx, cx.param_env).is_some() => {
1247 let len = len.eval_usize(cx.tcx, cx.param_env);
1248 if len != 0 && cx.is_uninhabited(sub_ty) {
1251 vec![Slice(Slice { array_len: Some(len), kind: VarLen(0, 0) })]
1254 // Treat arrays of a constant but unknown length like slices.
1255 ty::Array(ref sub_ty, _) | ty::Slice(ref sub_ty) => {
1256 let kind = if cx.is_uninhabited(sub_ty) { FixedLen(0) } else { VarLen(0, 0) };
1257 vec![Slice(Slice { array_len: None, kind })]
1259 ty::Adt(def, substs) if def.is_enum() => {
1260 let ctors: Vec<_> = if cx.tcx.features().exhaustive_patterns {
1261 // If `exhaustive_patterns` is enabled, we exclude variants known to be
1266 !v.uninhabited_from(cx.tcx, substs, def.adt_kind())
1267 .contains(cx.tcx, cx.module)
1269 .map(|v| Variant(v.def_id))
1272 def.variants.iter().map(|v| Variant(v.def_id)).collect()
1275 // If the enum is declared as `#[non_exhaustive]`, we treat it as if it had an
1276 // additional "unknown" constructor.
1277 // There is no point in enumerating all possible variants, because the user can't
1278 // actually match against them all themselves. So we always return only the fictitious
1280 // E.g., in an example like:
1282 // let err: io::ErrorKind = ...;
1284 // io::ErrorKind::NotFound => {},
1287 // we don't want to show every possible IO error, but instead have only `_` as the
1289 let is_declared_nonexhaustive = cx.is_foreign_non_exhaustive_enum(pcx.ty);
1291 // If `exhaustive_patterns` is disabled and our scrutinee is an empty enum, we treat it
1292 // as though it had an "unknown" constructor to avoid exposing its emptyness. Note that
1293 // an empty match will still be considered exhaustive because that case is handled
1294 // separately in `check_match`.
1295 let is_secretly_empty =
1296 def.variants.is_empty() && !cx.tcx.features().exhaustive_patterns;
1298 if is_secretly_empty || is_declared_nonexhaustive { vec![NonExhaustive] } else { ctors }
1302 // The valid Unicode Scalar Value ranges.
1303 make_range('\u{0000}' as u128, '\u{D7FF}' as u128),
1304 make_range('\u{E000}' as u128, '\u{10FFFF}' as u128),
1307 ty::Int(_) | ty::Uint(_)
1308 if pcx.ty.is_ptr_sized_integral()
1309 && !cx.tcx.features().precise_pointer_size_matching =>
1311 // `usize`/`isize` are not allowed to be matched exhaustively unless the
1312 // `precise_pointer_size_matching` feature is enabled. So we treat those types like
1313 // `#[non_exhaustive]` enums by returning a special unmatcheable constructor.
1317 let bits = Integer::from_attr(&cx.tcx, SignedInt(ity)).size().bits() as u128;
1318 let min = 1u128 << (bits - 1);
1320 vec![make_range(min, max)]
1323 let size = Integer::from_attr(&cx.tcx, UnsignedInt(uty)).size();
1324 let max = truncate(u128::max_value(), size);
1325 vec![make_range(0, max)]
1328 if cx.is_uninhabited(pcx.ty) {
1337 /// An inclusive interval, used for precise integer exhaustiveness checking.
1338 /// `IntRange`s always store a contiguous range. This means that values are
1339 /// encoded such that `0` encodes the minimum value for the integer,
1340 /// regardless of the signedness.
1341 /// For example, the pattern `-128..=127i8` is encoded as `0..=255`.
1342 /// This makes comparisons and arithmetic on interval endpoints much more
1343 /// straightforward. See `signed_bias` for details.
1345 /// `IntRange` is never used to encode an empty range or a "range" that wraps
1346 /// around the (offset) space: i.e., `range.lo <= range.hi`.
1347 #[derive(Clone, Debug)]
1348 struct IntRange<'tcx> {
1349 range: RangeInclusive<u128>,
1354 impl<'tcx> IntRange<'tcx> {
1356 fn is_integral(ty: Ty<'_>) -> bool {
1358 ty::Char | ty::Int(_) | ty::Uint(_) => true,
1363 fn is_singleton(&self) -> bool {
1364 self.range.start() == self.range.end()
1367 fn boundaries(&self) -> (u128, u128) {
1368 (*self.range.start(), *self.range.end())
1371 /// Don't treat `usize`/`isize` exhaustively unless the `precise_pointer_size_matching` feature
1373 fn treat_exhaustively(&self, tcx: TyCtxt<'tcx>) -> bool {
1374 !self.ty.is_ptr_sized_integral() || tcx.features().precise_pointer_size_matching
1378 fn integral_size_and_signed_bias(tcx: TyCtxt<'tcx>, ty: Ty<'_>) -> Option<(Size, u128)> {
1380 ty::Char => Some((Size::from_bytes(4), 0)),
1382 let size = Integer::from_attr(&tcx, SignedInt(ity)).size();
1383 Some((size, 1u128 << (size.bits() as u128 - 1)))
1385 ty::Uint(uty) => Some((Integer::from_attr(&tcx, UnsignedInt(uty)).size(), 0)),
1393 param_env: ty::ParamEnv<'tcx>,
1394 value: &Const<'tcx>,
1396 ) -> Option<IntRange<'tcx>> {
1397 if let Some((target_size, bias)) = Self::integral_size_and_signed_bias(tcx, value.ty) {
1400 if let ty::ConstKind::Value(ConstValue::Scalar(scalar)) = value.val {
1401 // For this specific pattern we can skip a lot of effort and go
1402 // straight to the result, after doing a bit of checking. (We
1403 // could remove this branch and just fall through, which
1404 // is more general but much slower.)
1405 if let Ok(bits) = scalar.to_bits_or_ptr(target_size, &tcx) {
1409 // This is a more general form of the previous case.
1410 value.try_eval_bits(tcx, param_env, ty)
1412 let val = val ^ bias;
1413 Some(IntRange { range: val..=val, ty, span })
1427 ) -> Option<IntRange<'tcx>> {
1428 if Self::is_integral(ty) {
1429 // Perform a shift if the underlying types are signed,
1430 // which makes the interval arithmetic simpler.
1431 let bias = IntRange::signed_bias(tcx, ty);
1432 let (lo, hi) = (lo ^ bias, hi ^ bias);
1433 let offset = (*end == RangeEnd::Excluded) as u128;
1434 if lo > hi || (lo == hi && *end == RangeEnd::Excluded) {
1435 // This should have been caught earlier by E0030.
1436 bug!("malformed range pattern: {}..={}", lo, (hi - offset));
1438 Some(IntRange { range: lo..=(hi - offset), ty, span })
1446 param_env: ty::ParamEnv<'tcx>,
1448 ) -> Option<IntRange<'tcx>> {
1449 match pat_constructor(tcx, param_env, pat)? {
1450 IntRange(range) => Some(range),
1455 // The return value of `signed_bias` should be XORed with an endpoint to encode/decode it.
1456 fn signed_bias(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> u128 {
1459 let bits = Integer::from_attr(&tcx, SignedInt(ity)).size().bits() as u128;
1466 /// Returns a collection of ranges that spans the values covered by `ranges`, subtracted
1467 /// by the values covered by `self`: i.e., `ranges \ self` (in set notation).
1468 fn subtract_from(&self, ranges: Vec<IntRange<'tcx>>) -> Vec<IntRange<'tcx>> {
1469 let mut remaining_ranges = vec![];
1471 let span = self.span;
1472 let (lo, hi) = self.boundaries();
1473 for subrange in ranges {
1474 let (subrange_lo, subrange_hi) = subrange.range.into_inner();
1475 if lo > subrange_hi || subrange_lo > hi {
1476 // The pattern doesn't intersect with the subrange at all,
1477 // so the subrange remains untouched.
1478 remaining_ranges.push(IntRange { range: subrange_lo..=subrange_hi, ty, span });
1480 if lo > subrange_lo {
1481 // The pattern intersects an upper section of the
1482 // subrange, so a lower section will remain.
1483 remaining_ranges.push(IntRange { range: subrange_lo..=(lo - 1), ty, span });
1485 if hi < subrange_hi {
1486 // The pattern intersects a lower section of the
1487 // subrange, so an upper section will remain.
1488 remaining_ranges.push(IntRange { range: (hi + 1)..=subrange_hi, ty, span });
1495 fn is_subrange(&self, other: &Self) -> bool {
1496 other.range.start() <= self.range.start() && self.range.end() <= other.range.end()
1499 fn intersection(&self, tcx: TyCtxt<'tcx>, other: &Self) -> Option<Self> {
1501 let (lo, hi) = self.boundaries();
1502 let (other_lo, other_hi) = other.boundaries();
1503 if self.treat_exhaustively(tcx) {
1504 if lo <= other_hi && other_lo <= hi {
1505 let span = other.span;
1506 Some(IntRange { range: max(lo, other_lo)..=min(hi, other_hi), ty, span })
1511 // If the range should not be treated exhaustively, fallback to checking for inclusion.
1512 if self.is_subrange(other) { Some(self.clone()) } else { None }
1516 fn suspicious_intersection(&self, other: &Self) -> bool {
1517 // `false` in the following cases:
1518 // 1 ---- // 1 ---------- // 1 ---- // 1 ----
1519 // 2 ---------- // 2 ---- // 2 ---- // 2 ----
1521 // The following are currently `false`, but could be `true` in the future (#64007):
1522 // 1 --------- // 1 ---------
1523 // 2 ---------- // 2 ----------
1525 // `true` in the following cases:
1526 // 1 ------- // 1 -------
1527 // 2 -------- // 2 -------
1528 let (lo, hi) = self.boundaries();
1529 let (other_lo, other_hi) = other.boundaries();
1530 lo == other_hi || hi == other_lo
1533 fn to_pat(&self, tcx: TyCtxt<'tcx>) -> Pat<'tcx> {
1534 let (lo, hi) = self.boundaries();
1536 let bias = IntRange::signed_bias(tcx, self.ty);
1537 let (lo, hi) = (lo ^ bias, hi ^ bias);
1539 let ty = ty::ParamEnv::empty().and(self.ty);
1540 let lo_const = ty::Const::from_bits(tcx, lo, ty);
1541 let hi_const = ty::Const::from_bits(tcx, hi, ty);
1543 let kind = if lo == hi {
1544 PatKind::Constant { value: lo_const }
1546 PatKind::Range(PatRange { lo: lo_const, hi: hi_const, end: RangeEnd::Included })
1549 // This is a brand new pattern, so we don't reuse `self.span`.
1550 Pat { ty: self.ty, span: DUMMY_SP, kind: Box::new(kind) }
1554 /// Ignore spans when comparing, they don't carry semantic information as they are only for lints.
1555 impl<'tcx> std::cmp::PartialEq for IntRange<'tcx> {
1556 fn eq(&self, other: &Self) -> bool {
1557 self.range == other.range && self.ty == other.ty
1561 // A struct to compute a set of constructors equivalent to `all_ctors \ used_ctors`.
1562 struct MissingConstructors<'tcx> {
1563 all_ctors: Vec<Constructor<'tcx>>,
1564 used_ctors: Vec<Constructor<'tcx>>,
1567 impl<'tcx> MissingConstructors<'tcx> {
1568 fn new(all_ctors: Vec<Constructor<'tcx>>, used_ctors: Vec<Constructor<'tcx>>) -> Self {
1569 MissingConstructors { all_ctors, used_ctors }
1572 fn into_inner(self) -> (Vec<Constructor<'tcx>>, Vec<Constructor<'tcx>>) {
1573 (self.all_ctors, self.used_ctors)
1576 fn is_empty(&self) -> bool {
1577 self.iter().next().is_none()
1579 /// Whether this contains all the constructors for the given type or only a
1581 fn all_ctors_are_missing(&self) -> bool {
1582 self.used_ctors.is_empty()
1585 /// Iterate over all_ctors \ used_ctors
1586 fn iter<'a>(&'a self) -> impl Iterator<Item = Constructor<'tcx>> + Captures<'a> {
1587 self.all_ctors.iter().flat_map(move |req_ctor| req_ctor.subtract_ctors(&self.used_ctors))
1591 impl<'tcx> fmt::Debug for MissingConstructors<'tcx> {
1592 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1593 let ctors: Vec<_> = self.iter().collect();
1594 write!(f, "{:?}", ctors)
1598 /// Algorithm from http://moscova.inria.fr/~maranget/papers/warn/index.html.
1599 /// The algorithm from the paper has been modified to correctly handle empty
1600 /// types. The changes are:
1601 /// (0) We don't exit early if the pattern matrix has zero rows. We just
1602 /// continue to recurse over columns.
1603 /// (1) all_constructors will only return constructors that are statically
1604 /// possible. E.g., it will only return `Ok` for `Result<T, !>`.
1606 /// This finds whether a (row) vector `v` of patterns is 'useful' in relation
1607 /// to a set of such vectors `m` - this is defined as there being a set of
1608 /// inputs that will match `v` but not any of the sets in `m`.
1610 /// All the patterns at each column of the `matrix ++ v` matrix must
1611 /// have the same type, except that wildcard (PatKind::Wild) patterns
1612 /// with type `TyErr` are also allowed, even if the "type of the column"
1613 /// is not `TyErr`. That is used to represent private fields, as using their
1614 /// real type would assert that they are inhabited.
1616 /// This is used both for reachability checking (if a pattern isn't useful in
1617 /// relation to preceding patterns, it is not reachable) and exhaustiveness
1618 /// checking (if a wildcard pattern is useful in relation to a matrix, the
1619 /// matrix isn't exhaustive).
1620 crate fn is_useful<'p, 'tcx>(
1621 cx: &mut MatchCheckCtxt<'p, 'tcx>,
1622 matrix: &Matrix<'p, 'tcx>,
1623 v: &PatStack<'p, 'tcx>,
1624 witness_preference: WitnessPreference,
1627 ) -> Usefulness<'tcx, 'p> {
1628 let &Matrix(ref rows) = matrix;
1629 debug!("is_useful({:#?}, {:#?})", matrix, v);
1631 // The base case. We are pattern-matching on () and the return value is
1632 // based on whether our matrix has a row or not.
1633 // NOTE: This could potentially be optimized by checking rows.is_empty()
1634 // first and then, if v is non-empty, the return value is based on whether
1635 // the type of the tuple we're checking is inhabited or not.
1637 return if rows.is_empty() {
1638 Usefulness::new_useful(witness_preference)
1644 assert!(rows.iter().all(|r| r.len() == v.len()));
1646 // If the first pattern is an or-pattern, expand it.
1647 if let Some(vs) = v.expand_or_pat() {
1648 // We need to push the already-seen patterns into the matrix in order to detect redundant
1649 // branches like `Some(_) | Some(0)`. We also keep track of the unreachable subpatterns.
1650 let mut matrix = matrix.clone();
1651 let mut unreachable_pats = Vec::new();
1652 let mut any_is_useful = false;
1654 let res = is_useful(cx, &matrix, &v, witness_preference, hir_id, false);
1657 any_is_useful = true;
1658 unreachable_pats.extend(pats);
1660 NotUseful => unreachable_pats.push(v.head()),
1661 UsefulWithWitness(_) => {
1662 bug!("Encountered or-pat in `v` during exhaustiveness checking")
1667 return if any_is_useful { Useful(unreachable_pats) } else { NotUseful };
1670 let (ty, span) = matrix
1672 .map(|r| (r.ty, r.span))
1673 .find(|(ty, _)| !ty.references_error())
1674 .unwrap_or((v.head().ty, v.head().span));
1676 // TyErr is used to represent the type of wildcard patterns matching
1677 // against inaccessible (private) fields of structs, so that we won't
1678 // be able to observe whether the types of the struct's fields are
1681 // If the field is truly inaccessible, then all the patterns
1682 // matching against it must be wildcard patterns, so its type
1685 // However, if we are matching against non-wildcard patterns, we
1686 // need to know the real type of the field so we can specialize
1687 // against it. This primarily occurs through constants - they
1688 // can include contents for fields that are inaccessible at the
1689 // location of the match. In that case, the field's type is
1690 // inhabited - by the constant - so we can just use it.
1692 // FIXME: this might lead to "unstable" behavior with macro hygiene
1693 // introducing uninhabited patterns for inaccessible fields. We
1694 // need to figure out how to model that.
1699 debug!("is_useful_expand_first_col: pcx={:#?}, expanding {:#?}", pcx, v.head());
1701 if let Some(constructor) = pat_constructor(cx.tcx, cx.param_env, v.head()) {
1702 debug!("is_useful - expanding constructor: {:#?}", constructor);
1703 split_grouped_constructors(
1713 .map(|c| is_useful_specialized(cx, matrix, v, c, pcx.ty, witness_preference, hir_id))
1714 .find(|result| result.is_useful())
1715 .unwrap_or(NotUseful)
1717 debug!("is_useful - expanding wildcard");
1719 let used_ctors: Vec<Constructor<'_>> =
1720 matrix.heads().filter_map(|p| pat_constructor(cx.tcx, cx.param_env, p)).collect();
1721 debug!("used_ctors = {:#?}", used_ctors);
1722 // `all_ctors` are all the constructors for the given type, which
1723 // should all be represented (or caught with the wild pattern `_`).
1724 let all_ctors = all_constructors(cx, pcx);
1725 debug!("all_ctors = {:#?}", all_ctors);
1727 // `missing_ctors` is the set of constructors from the same type as the
1728 // first column of `matrix` that are matched only by wildcard patterns
1729 // from the first column.
1731 // Therefore, if there is some pattern that is unmatched by `matrix`,
1732 // it will still be unmatched if the first constructor is replaced by
1733 // any of the constructors in `missing_ctors`
1735 // Missing constructors are those that are not matched by any non-wildcard patterns in the
1736 // current column. We only fully construct them on-demand, because they're rarely used and
1738 let missing_ctors = MissingConstructors::new(all_ctors, used_ctors);
1740 debug!("missing_ctors.empty()={:#?}", missing_ctors.is_empty(),);
1742 if missing_ctors.is_empty() {
1743 let (all_ctors, _) = missing_ctors.into_inner();
1744 split_grouped_constructors(cx.tcx, cx.param_env, pcx, all_ctors, matrix, DUMMY_SP, None)
1747 is_useful_specialized(cx, matrix, v, c, pcx.ty, witness_preference, hir_id)
1749 .find(|result| result.is_useful())
1750 .unwrap_or(NotUseful)
1752 let matrix = matrix.specialize_wildcard();
1753 let v = v.to_tail();
1754 let usefulness = is_useful(cx, &matrix, &v, witness_preference, hir_id, false);
1756 // In this case, there's at least one "free"
1757 // constructor that is only matched against by
1758 // wildcard patterns.
1760 // There are 2 ways we can report a witness here.
1761 // Commonly, we can report all the "free"
1762 // constructors as witnesses, e.g., if we have:
1765 // enum Direction { N, S, E, W }
1766 // let Direction::N = ...;
1769 // we can report 3 witnesses: `S`, `E`, and `W`.
1771 // However, there is a case where we don't want
1772 // to do this and instead report a single `_` witness:
1773 // if the user didn't actually specify a constructor
1774 // in this arm, e.g., in
1776 // let x: (Direction, Direction, bool) = ...;
1777 // let (_, _, false) = x;
1779 // we don't want to show all 16 possible witnesses
1780 // `(<direction-1>, <direction-2>, true)` - we are
1781 // satisfied with `(_, _, true)`. In this case,
1782 // `used_ctors` is empty.
1783 // The exception is: if we are at the top-level, for example in an empty match, we
1784 // sometimes prefer reporting the list of constructors instead of just `_`.
1785 let report_ctors_rather_than_wildcard = is_top_level && !IntRange::is_integral(pcx.ty);
1786 if missing_ctors.all_ctors_are_missing() && !report_ctors_rather_than_wildcard {
1787 // All constructors are unused. Add a wild pattern
1788 // rather than each individual constructor.
1789 usefulness.apply_wildcard(pcx.ty)
1791 // Construct for each missing constructor a "wild" version of this
1792 // constructor, that matches everything that can be built with
1793 // it. For example, if `ctor` is a `Constructor::Variant` for
1794 // `Option::Some`, we get the pattern `Some(_)`.
1795 usefulness.apply_missing_ctors(cx, pcx.ty, &missing_ctors)
1801 /// A shorthand for the `U(S(c, P), S(c, q))` operation from the paper. I.e., `is_useful` applied
1802 /// to the specialised version of both the pattern matrix `P` and the new pattern `q`.
1803 fn is_useful_specialized<'p, 'tcx>(
1804 cx: &mut MatchCheckCtxt<'p, 'tcx>,
1805 matrix: &Matrix<'p, 'tcx>,
1806 v: &PatStack<'p, 'tcx>,
1807 ctor: Constructor<'tcx>,
1809 witness_preference: WitnessPreference,
1811 ) -> Usefulness<'tcx, 'p> {
1812 debug!("is_useful_specialized({:#?}, {:#?}, {:?})", v, ctor, lty);
1814 let ctor_wild_subpatterns =
1815 cx.pattern_arena.alloc_from_iter(ctor.wildcard_subpatterns(cx, lty));
1816 let matrix = matrix.specialize_constructor(cx, &ctor, ctor_wild_subpatterns);
1817 v.specialize_constructor(cx, &ctor, ctor_wild_subpatterns)
1818 .map(|v| is_useful(cx, &matrix, &v, witness_preference, hir_id, false))
1819 .map(|u| u.apply_constructor(cx, &ctor, lty))
1820 .unwrap_or(NotUseful)
1823 /// Determines the constructor that the given pattern can be specialized to.
1824 /// Returns `None` in case of a catch-all, which can't be specialized.
1825 fn pat_constructor<'tcx>(
1827 param_env: ty::ParamEnv<'tcx>,
1829 ) -> Option<Constructor<'tcx>> {
1831 PatKind::AscribeUserType { .. } => bug!(), // Handled by `expand_pattern`
1832 PatKind::Binding { .. } | PatKind::Wild => None,
1833 PatKind::Leaf { .. } | PatKind::Deref { .. } => Some(Single),
1834 PatKind::Variant { adt_def, variant_index, .. } => {
1835 Some(Variant(adt_def.variants[variant_index].def_id))
1837 PatKind::Constant { value } => {
1838 if let Some(int_range) = IntRange::from_const(tcx, param_env, value, pat.span) {
1839 Some(IntRange(int_range))
1841 match (value.val, &value.ty.kind) {
1842 (_, ty::Array(_, n)) => {
1843 let len = n.eval_usize(tcx, param_env);
1844 Some(Slice(Slice { array_len: Some(len), kind: FixedLen(len) }))
1846 (ty::ConstKind::Value(ConstValue::Slice { start, end, .. }), ty::Slice(_)) => {
1847 let len = (end - start) as u64;
1848 Some(Slice(Slice { array_len: None, kind: FixedLen(len) }))
1850 // FIXME(oli-obk): implement `deref` for `ConstValue`
1851 // (ty::ConstKind::Value(ConstValue::ByRef { .. }), ty::Slice(_)) => { ... }
1852 _ => Some(ConstantValue(value)),
1856 PatKind::Range(PatRange { lo, hi, end }) => {
1858 if let Some(int_range) = IntRange::from_range(
1860 lo.eval_bits(tcx, param_env, lo.ty),
1861 hi.eval_bits(tcx, param_env, hi.ty),
1866 Some(IntRange(int_range))
1868 Some(FloatRange(lo, hi, end))
1871 PatKind::Array { ref prefix, ref slice, ref suffix }
1872 | PatKind::Slice { ref prefix, ref slice, ref suffix } => {
1873 let array_len = match pat.ty.kind {
1874 ty::Array(_, length) => Some(length.eval_usize(tcx, param_env)),
1875 ty::Slice(_) => None,
1876 _ => span_bug!(pat.span, "bad ty {:?} for slice pattern", pat.ty),
1878 let prefix = prefix.len() as u64;
1879 let suffix = suffix.len() as u64;
1881 if slice.is_some() { VarLen(prefix, suffix) } else { FixedLen(prefix + suffix) };
1882 Some(Slice(Slice { array_len, kind }))
1884 PatKind::Or { .. } => bug!("Or-pattern should have been expanded earlier on."),
1888 // checks whether a constant is equal to a user-written slice pattern. Only supports byte slices,
1889 // meaning all other types will compare unequal and thus equal patterns often do not cause the
1890 // second pattern to lint about unreachable match arms.
1891 fn slice_pat_covered_by_const<'tcx>(
1894 const_val: &'tcx ty::Const<'tcx>,
1895 prefix: &[Pat<'tcx>],
1896 slice: &Option<Pat<'tcx>>,
1897 suffix: &[Pat<'tcx>],
1898 param_env: ty::ParamEnv<'tcx>,
1899 ) -> Result<bool, ErrorReported> {
1900 let const_val_val = if let ty::ConstKind::Value(val) = const_val.val {
1904 "slice_pat_covered_by_const: {:#?}, {:#?}, {:#?}, {:#?}",
1912 let data: &[u8] = match (const_val_val, &const_val.ty.kind) {
1913 (ConstValue::ByRef { offset, alloc, .. }, ty::Array(t, n)) => {
1914 assert_eq!(*t, tcx.types.u8);
1915 let n = n.eval_usize(tcx, param_env);
1916 let ptr = Pointer::new(AllocId(0), offset);
1917 alloc.get_bytes(&tcx, ptr, Size::from_bytes(n)).unwrap()
1919 (ConstValue::Slice { data, start, end }, ty::Slice(t)) => {
1920 assert_eq!(*t, tcx.types.u8);
1921 let ptr = Pointer::new(AllocId(0), Size::from_bytes(start as u64));
1922 data.get_bytes(&tcx, ptr, Size::from_bytes((end - start) as u64)).unwrap()
1924 // FIXME(oli-obk): create a way to extract fat pointers from ByRef
1925 (_, ty::Slice(_)) => return Ok(false),
1927 "slice_pat_covered_by_const: {:#?}, {:#?}, {:#?}, {:#?}",
1935 let pat_len = prefix.len() + suffix.len();
1936 if data.len() < pat_len || (slice.is_none() && data.len() > pat_len) {
1940 for (ch, pat) in data[..prefix.len()]
1943 .chain(data[data.len() - suffix.len()..].iter().zip(suffix))
1946 box PatKind::Constant { value } => {
1947 let b = value.eval_bits(tcx, param_env, pat.ty);
1948 assert_eq!(b as u8 as u128, b);
1960 /// For exhaustive integer matching, some constructors are grouped within other constructors
1961 /// (namely integer typed values are grouped within ranges). However, when specialising these
1962 /// constructors, we want to be specialising for the underlying constructors (the integers), not
1963 /// the groups (the ranges). Thus we need to split the groups up. Splitting them up naïvely would
1964 /// mean creating a separate constructor for every single value in the range, which is clearly
1965 /// impractical. However, observe that for some ranges of integers, the specialisation will be
1966 /// identical across all values in that range (i.e., there are equivalence classes of ranges of
1967 /// constructors based on their `is_useful_specialized` outcome). These classes are grouped by
1968 /// the patterns that apply to them (in the matrix `P`). We can split the range whenever the
1969 /// patterns that apply to that range (specifically: the patterns that *intersect* with that range)
1971 /// Our solution, therefore, is to split the range constructor into subranges at every single point
1972 /// the group of intersecting patterns changes (using the method described below).
1973 /// And voilà! We're testing precisely those ranges that we need to, without any exhaustive matching
1974 /// on actual integers. The nice thing about this is that the number of subranges is linear in the
1975 /// number of rows in the matrix (i.e., the number of cases in the `match` statement), so we don't
1976 /// need to be worried about matching over gargantuan ranges.
1978 /// Essentially, given the first column of a matrix representing ranges, looking like the following:
1980 /// |------| |----------| |-------| ||
1981 /// |-------| |-------| |----| ||
1984 /// We split the ranges up into equivalence classes so the ranges are no longer overlapping:
1986 /// |--|--|||-||||--||---|||-------| |-|||| ||
1988 /// The logic for determining how to split the ranges is fairly straightforward: we calculate
1989 /// boundaries for each interval range, sort them, then create constructors for each new interval
1990 /// between every pair of boundary points. (This essentially sums up to performing the intuitive
1991 /// merging operation depicted above.)
1993 /// `hir_id` is `None` when we're evaluating the wildcard pattern, do not lint for overlapping in
1994 /// ranges that case.
1996 /// This also splits variable-length slices into fixed-length slices.
1997 fn split_grouped_constructors<'p, 'tcx>(
1999 param_env: ty::ParamEnv<'tcx>,
2001 ctors: Vec<Constructor<'tcx>>,
2002 matrix: &Matrix<'p, 'tcx>,
2004 hir_id: Option<HirId>,
2005 ) -> Vec<Constructor<'tcx>> {
2007 let mut split_ctors = Vec::with_capacity(ctors.len());
2008 debug!("split_grouped_constructors({:#?}, {:#?})", matrix, ctors);
2010 for ctor in ctors.into_iter() {
2012 IntRange(ctor_range) if ctor_range.treat_exhaustively(tcx) => {
2013 // Fast-track if the range is trivial. In particular, don't do the overlapping
2015 if ctor_range.is_singleton() {
2016 split_ctors.push(IntRange(ctor_range));
2020 /// Represents a border between 2 integers. Because the intervals spanning borders
2021 /// must be able to cover every integer, we need to be able to represent
2022 /// 2^128 + 1 such borders.
2023 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
2029 // A function for extracting the borders of an integer interval.
2030 fn range_borders(r: IntRange<'_>) -> impl Iterator<Item = Border> {
2031 let (lo, hi) = r.range.into_inner();
2032 let from = Border::JustBefore(lo);
2033 let to = match hi.checked_add(1) {
2034 Some(m) => Border::JustBefore(m),
2035 None => Border::AfterMax,
2037 vec![from, to].into_iter()
2040 // Collect the span and range of all the intersecting ranges to lint on likely
2041 // incorrect range patterns. (#63987)
2042 let mut overlaps = vec![];
2043 // `borders` is the set of borders between equivalence classes: each equivalence
2044 // class lies between 2 borders.
2045 let row_borders = matrix
2049 IntRange::from_pat(tcx, param_env, row.head()).map(|r| (r, row.len()))
2051 .flat_map(|(range, row_len)| {
2052 let intersection = ctor_range.intersection(tcx, &range);
2053 let should_lint = ctor_range.suspicious_intersection(&range);
2054 if let (Some(range), 1, true) = (&intersection, row_len, should_lint) {
2055 // FIXME: for now, only check for overlapping ranges on simple range
2056 // patterns. Otherwise with the current logic the following is detected
2058 // match (10u8, true) {
2059 // (0 ..= 125, false) => {}
2060 // (126 ..= 255, false) => {}
2061 // (0 ..= 255, true) => {}
2063 overlaps.push(range.clone());
2067 .flat_map(|range| range_borders(range));
2068 let ctor_borders = range_borders(ctor_range.clone());
2069 let mut borders: Vec<_> = row_borders.chain(ctor_borders).collect();
2070 borders.sort_unstable();
2072 lint_overlapping_patterns(tcx, hir_id, ctor_range, ty, overlaps);
2074 // We're going to iterate through every adjacent pair of borders, making sure that
2075 // each represents an interval of nonnegative length, and convert each such
2076 // interval into a constructor.
2080 .filter_map(|window| match (window[0], window[1]) {
2081 (Border::JustBefore(n), Border::JustBefore(m)) => {
2083 Some(IntRange { range: n..=(m - 1), ty, span })
2088 (Border::JustBefore(n), Border::AfterMax) => {
2089 Some(IntRange { range: n..=u128::MAX, ty, span })
2091 (Border::AfterMax, _) => None,
2096 Slice(Slice { array_len, kind: VarLen(self_prefix, self_suffix) }) => {
2097 // The exhaustiveness-checking paper does not include any details on
2098 // checking variable-length slice patterns. However, they are matched
2099 // by an infinite collection of fixed-length array patterns.
2101 // Checking the infinite set directly would take an infinite amount
2102 // of time. However, it turns out that for each finite set of
2103 // patterns `P`, all sufficiently large array lengths are equivalent:
2105 // Each slice `s` with a "sufficiently-large" length `l ≥ L` that applies
2106 // to exactly the subset `Pₜ` of `P` can be transformed to a slice
2107 // `sₘ` for each sufficiently-large length `m` that applies to exactly
2108 // the same subset of `P`.
2110 // Because of that, each witness for reachability-checking from one
2111 // of the sufficiently-large lengths can be transformed to an
2112 // equally-valid witness from any other length, so we only have
2113 // to check slice lengths from the "minimal sufficiently-large length"
2116 // Note that the fact that there is a *single* `sₘ` for each `m`
2117 // not depending on the specific pattern in `P` is important: if
2118 // you look at the pair of patterns
2121 // Then any slice of length ≥1 that matches one of these two
2122 // patterns can be trivially turned to a slice of any
2123 // other length ≥1 that matches them and vice-versa - for
2124 // but the slice from length 2 `[false, true]` that matches neither
2125 // of these patterns can't be turned to a slice from length 1 that
2126 // matches neither of these patterns, so we have to consider
2127 // slices from length 2 there.
2129 // Now, to see that that length exists and find it, observe that slice
2130 // patterns are either "fixed-length" patterns (`[_, _, _]`) or
2131 // "variable-length" patterns (`[_, .., _]`).
2133 // For fixed-length patterns, all slices with lengths *longer* than
2134 // the pattern's length have the same outcome (of not matching), so
2135 // as long as `L` is greater than the pattern's length we can pick
2136 // any `sₘ` from that length and get the same result.
2138 // For variable-length patterns, the situation is more complicated,
2139 // because as seen above the precise value of `sₘ` matters.
2141 // However, for each variable-length pattern `p` with a prefix of length
2142 // `plₚ` and suffix of length `slₚ`, only the first `plₚ` and the last
2143 // `slₚ` elements are examined.
2145 // Therefore, as long as `L` is positive (to avoid concerns about empty
2146 // types), all elements after the maximum prefix length and before
2147 // the maximum suffix length are not examined by any variable-length
2148 // pattern, and therefore can be added/removed without affecting
2149 // them - creating equivalent patterns from any sufficiently-large
2152 // Of course, if fixed-length patterns exist, we must be sure
2153 // that our length is large enough to miss them all, so
2154 // we can pick `L = max(max(FIXED_LEN)+1, max(PREFIX_LEN) + max(SUFFIX_LEN))`
2156 // for example, with the above pair of patterns, all elements
2157 // but the first and last can be added/removed, so any
2158 // witness of length ≥2 (say, `[false, false, true]`) can be
2159 // turned to a witness from any other length ≥2.
2161 let mut max_prefix_len = self_prefix;
2162 let mut max_suffix_len = self_suffix;
2163 let mut max_fixed_len = 0;
2166 matrix.heads().filter_map(|pat| pat_constructor(tcx, param_env, pat));
2167 for ctor in head_ctors {
2169 Slice(slice) => match slice.pattern_kind() {
2171 max_fixed_len = cmp::max(max_fixed_len, len);
2173 VarLen(prefix, suffix) => {
2174 max_prefix_len = cmp::max(max_prefix_len, prefix);
2175 max_suffix_len = cmp::max(max_suffix_len, suffix);
2182 // For diagnostics, we keep the prefix and suffix lengths separate, so in the case
2183 // where `max_fixed_len + 1` is the largest, we adapt `max_prefix_len` accordingly,
2184 // so that `L = max_prefix_len + max_suffix_len`.
2185 if max_fixed_len + 1 >= max_prefix_len + max_suffix_len {
2186 // The subtraction can't overflow thanks to the above check.
2187 // The new `max_prefix_len` is also guaranteed to be larger than its previous
2189 max_prefix_len = max_fixed_len + 1 - max_suffix_len;
2194 let kind = if max_prefix_len + max_suffix_len < len {
2195 VarLen(max_prefix_len, max_suffix_len)
2199 split_ctors.push(Slice(Slice { array_len, kind }));
2202 // `ctor` originally covered the range `(self_prefix +
2203 // self_suffix..infinity)`. We now split it into two: lengths smaller than
2204 // `max_prefix_len + max_suffix_len` are treated independently as
2205 // fixed-lengths slices, and lengths above are captured by a final VarLen
2208 (self_prefix + self_suffix..max_prefix_len + max_suffix_len)
2209 .map(|len| Slice(Slice { array_len, kind: FixedLen(len) })),
2211 split_ctors.push(Slice(Slice {
2213 kind: VarLen(max_prefix_len, max_suffix_len),
2218 // Any other constructor can be used unchanged.
2219 _ => split_ctors.push(ctor),
2223 debug!("split_grouped_constructors(..)={:#?}", split_ctors);
2227 fn lint_overlapping_patterns<'tcx>(
2229 hir_id: Option<HirId>,
2230 ctor_range: IntRange<'tcx>,
2232 overlaps: Vec<IntRange<'tcx>>,
2234 if let (true, Some(hir_id)) = (!overlaps.is_empty(), hir_id) {
2235 tcx.struct_span_lint_hir(
2236 lint::builtin::OVERLAPPING_PATTERNS,
2240 let mut err = lint.build("multiple patterns covering the same range");
2241 err.span_label(ctor_range.span, "overlapping patterns");
2242 for int_range in overlaps {
2243 // Use the real type for user display of the ranges:
2247 "this range overlaps on `{}`",
2248 IntRange { range: int_range.range, ty, span: DUMMY_SP }.to_pat(tcx),
2258 fn constructor_covered_by_range<'tcx>(
2260 param_env: ty::ParamEnv<'tcx>,
2261 ctor: &Constructor<'tcx>,
2264 if let Single = ctor {
2268 let (pat_from, pat_to, pat_end, ty) = match *pat.kind {
2269 PatKind::Constant { value } => (value, value, RangeEnd::Included, value.ty),
2270 PatKind::Range(PatRange { lo, hi, end }) => (lo, hi, end, lo.ty),
2271 _ => bug!("`constructor_covered_by_range` called with {:?}", pat),
2273 let (ctor_from, ctor_to, ctor_end) = match *ctor {
2274 ConstantValue(value) => (value, value, RangeEnd::Included),
2275 FloatRange(from, to, ctor_end) => (from, to, ctor_end),
2276 _ => bug!("`constructor_covered_by_range` called with {:?}", ctor),
2278 trace!("constructor_covered_by_range {:#?}, {:#?}, {:#?}, {}", ctor, pat_from, pat_to, ty);
2280 let to = compare_const_vals(tcx, ctor_to, pat_to, param_env, ty)?;
2281 let from = compare_const_vals(tcx, ctor_from, pat_from, param_env, ty)?;
2282 let intersects = (from == Ordering::Greater || from == Ordering::Equal)
2283 && (to == Ordering::Less || (pat_end == ctor_end && to == Ordering::Equal));
2284 if intersects { Some(()) } else { None }
2287 fn patterns_for_variant<'p, 'tcx>(
2288 cx: &mut MatchCheckCtxt<'p, 'tcx>,
2289 subpatterns: &'p [FieldPat<'tcx>],
2290 ctor_wild_subpatterns: &'p [Pat<'tcx>],
2291 is_non_exhaustive: bool,
2292 ) -> PatStack<'p, 'tcx> {
2293 let mut result: SmallVec<_> = ctor_wild_subpatterns.iter().collect();
2295 for subpat in subpatterns {
2296 if !is_non_exhaustive || !cx.is_uninhabited(subpat.pattern.ty) {
2297 result[subpat.field.index()] = &subpat.pattern;
2302 "patterns_for_variant({:#?}, {:#?}) = {:#?}",
2303 subpatterns, ctor_wild_subpatterns, result
2305 PatStack::from_vec(result)
2308 /// This is the main specialization step. It expands the pattern
2309 /// into `arity` patterns based on the constructor. For most patterns, the step is trivial,
2310 /// for instance tuple patterns are flattened and box patterns expand into their inner pattern.
2311 /// Returns `None` if the pattern does not have the given constructor.
2313 /// OTOH, slice patterns with a subslice pattern (tail @ ..) can be expanded into multiple
2314 /// different patterns.
2315 /// Structure patterns with a partial wild pattern (Foo { a: 42, .. }) have their missing
2316 /// fields filled with wild patterns.
2317 fn specialize_one_pattern<'p, 'tcx>(
2318 cx: &mut MatchCheckCtxt<'p, 'tcx>,
2320 constructor: &Constructor<'tcx>,
2321 ctor_wild_subpatterns: &'p [Pat<'tcx>],
2322 ) -> Option<PatStack<'p, 'tcx>> {
2323 if let NonExhaustive = constructor {
2324 // Only a wildcard pattern can match the special extra constructor
2325 return if pat.is_wildcard() { Some(PatStack::default()) } else { None };
2328 let result = match *pat.kind {
2329 PatKind::AscribeUserType { .. } => bug!(), // Handled by `expand_pattern`
2331 PatKind::Binding { .. } | PatKind::Wild => Some(ctor_wild_subpatterns.iter().collect()),
2333 PatKind::Variant { adt_def, variant_index, ref subpatterns, .. } => {
2334 let variant = &adt_def.variants[variant_index];
2335 let is_non_exhaustive = cx.is_foreign_non_exhaustive_variant(pat.ty, variant);
2336 Some(Variant(variant.def_id))
2337 .filter(|variant_constructor| variant_constructor == constructor)
2339 patterns_for_variant(cx, subpatterns, ctor_wild_subpatterns, is_non_exhaustive)
2343 PatKind::Leaf { ref subpatterns } => {
2344 Some(patterns_for_variant(cx, subpatterns, ctor_wild_subpatterns, false))
2347 PatKind::Deref { ref subpattern } => Some(PatStack::from_pattern(subpattern)),
2349 PatKind::Constant { value } if constructor.is_slice() => {
2350 // We extract an `Option` for the pointer because slices of zero
2351 // elements don't necessarily point to memory, they are usually
2352 // just integers. The only time they should be pointing to memory
2353 // is when they are subslices of nonzero slices.
2354 let (alloc, offset, n, ty) = match value.ty.kind {
2355 ty::Array(t, n) => {
2356 let n = n.eval_usize(cx.tcx, cx.param_env);
2357 // Shortcut for `n == 0` where no matter what `alloc` and `offset` we produce,
2358 // the result would be exactly what we early return here.
2360 if ctor_wild_subpatterns.len() as u64 == 0 {
2361 return Some(PatStack::from_slice(&[]));
2367 ty::ConstKind::Value(ConstValue::ByRef { offset, alloc, .. }) => {
2368 (Cow::Borrowed(alloc), offset, n, t)
2370 _ => span_bug!(pat.span, "array pattern is {:?}", value,),
2375 ty::ConstKind::Value(ConstValue::Slice { data, start, end }) => {
2376 let offset = Size::from_bytes(start as u64);
2377 let n = (end - start) as u64;
2378 (Cow::Borrowed(data), offset, n, t)
2380 ty::ConstKind::Value(ConstValue::ByRef { .. }) => {
2381 // FIXME(oli-obk): implement `deref` for `ConstValue`
2386 "slice pattern constant must be scalar pair but is {:?}",
2393 "unexpected const-val {:?} with ctor {:?}",
2398 if ctor_wild_subpatterns.len() as u64 == n {
2399 // convert a constant slice/array pattern to a list of patterns.
2400 let layout = cx.tcx.layout_of(cx.param_env.and(ty)).ok()?;
2401 let ptr = Pointer::new(AllocId(0), offset);
2404 let ptr = ptr.offset(layout.size * i, &cx.tcx).ok()?;
2405 let scalar = alloc.read_scalar(&cx.tcx, ptr, layout.size).ok()?;
2406 let scalar = scalar.not_undef().ok()?;
2407 let value = ty::Const::from_scalar(cx.tcx, scalar, ty);
2409 Pat { ty, span: pat.span, kind: box PatKind::Constant { value } };
2410 Some(&*cx.pattern_arena.alloc(pattern))
2418 PatKind::Constant { .. } | PatKind::Range { .. } => {
2419 // If the constructor is a:
2420 // - Single value: add a row if the pattern contains the constructor.
2421 // - Range: add a row if the constructor intersects the pattern.
2422 if let IntRange(ctor) = constructor {
2423 match IntRange::from_pat(cx.tcx, cx.param_env, pat) {
2424 Some(pat) => ctor.intersection(cx.tcx, &pat).map(|_| {
2425 // Constructor splitting should ensure that all intersections we encounter
2426 // are actually inclusions.
2427 assert!(ctor.is_subrange(&pat));
2433 // Fallback for non-ranges and ranges that involve
2434 // floating-point numbers, which are not conveniently handled
2435 // by `IntRange`. For these cases, the constructor may not be a
2436 // range so intersection actually devolves into being covered
2438 constructor_covered_by_range(cx.tcx, cx.param_env, constructor, pat)
2439 .map(|()| PatStack::default())
2443 PatKind::Array { ref prefix, ref slice, ref suffix }
2444 | PatKind::Slice { ref prefix, ref slice, ref suffix } => match *constructor {
2446 let pat_len = prefix.len() + suffix.len();
2447 if let Some(slice_count) = ctor_wild_subpatterns.len().checked_sub(pat_len) {
2448 if slice_count == 0 || slice.is_some() {
2453 ctor_wild_subpatterns
2457 .chain(suffix.iter()),
2468 ConstantValue(cv) => {
2469 match slice_pat_covered_by_const(
2478 Ok(true) => Some(PatStack::default()),
2480 Err(ErrorReported) => None,
2483 _ => span_bug!(pat.span, "unexpected ctor {:?} for slice pat", constructor),
2486 PatKind::Or { .. } => bug!("Or-pattern should have been expanded earlier on."),
2488 debug!("specialize({:#?}, {:#?}) = {:#?}", pat, ctor_wild_subpatterns, result);