]> git.lizzy.rs Git - rust.git/blob - src/librustc/traits/select.rs
7a52a5cbf5acc69713a9dd58c5186e8c0eb63c1b
[rust.git] / src / librustc / traits / select.rs
1 // Copyright 2014 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.
4 //
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.
10
11 //! See [rustc guide] for more info on how this works.
12 //!
13 //! [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html#selection
14
15 use self::SelectionCandidate::*;
16 use self::EvaluationResult::*;
17
18 use super::coherence::{self, Conflict};
19 use super::DerivedObligationCause;
20 use super::{IntercrateMode, TraitQueryMode};
21 use super::project;
22 use super::project::{normalize_with_depth, Normalized, ProjectionCacheKey};
23 use super::{PredicateObligation, TraitObligation, ObligationCause};
24 use super::{ObligationCauseCode, BuiltinDerivedObligation, ImplDerivedObligation};
25 use super::{SelectionError, Unimplemented, OutputTypeParameterMismatch, Overflow};
26 use super::{ObjectCastObligation, Obligation};
27 use super::TraitNotObjectSafe;
28 use super::Selection;
29 use super::SelectionResult;
30 use super::{VtableBuiltin, VtableImpl, VtableParam, VtableClosure, VtableGenerator,
31             VtableFnPointer, VtableObject, VtableAutoImpl};
32 use super::{VtableImplData, VtableObjectData, VtableBuiltinData, VtableGeneratorData,
33             VtableClosureData, VtableAutoImplData, VtableFnPointerData};
34 use super::util;
35
36 use dep_graph::{DepNodeIndex, DepKind};
37 use hir::def_id::DefId;
38 use infer;
39 use infer::{InferCtxt, InferOk, TypeFreshener};
40 use ty::subst::{Subst, Substs};
41 use ty::{self, ToPredicate, ToPolyTraitRef, Ty, TyCtxt, TypeFoldable};
42 use ty::fast_reject;
43 use ty::relate::TypeRelation;
44 use middle::lang_items;
45 use mir::interpret::{GlobalId};
46
47 use rustc_data_structures::sync::Lock;
48 use rustc_data_structures::bitvec::BitVector;
49 use std::iter;
50 use std::cmp;
51 use std::fmt;
52 use std::mem;
53 use std::rc::Rc;
54 use rustc_target::spec::abi::Abi;
55 use hir;
56 use util::nodemap::{FxHashMap, FxHashSet};
57
58
59 pub struct SelectionContext<'cx, 'gcx: 'cx+'tcx, 'tcx: 'cx> {
60     infcx: &'cx InferCtxt<'cx, 'gcx, 'tcx>,
61
62     /// Freshener used specifically for skolemizing entries on the
63     /// obligation stack. This ensures that all entries on the stack
64     /// at one time will have the same set of skolemized entries,
65     /// which is important for checking for trait bounds that
66     /// recursively require themselves.
67     freshener: TypeFreshener<'cx, 'gcx, 'tcx>,
68
69     /// If true, indicates that the evaluation should be conservative
70     /// and consider the possibility of types outside this crate.
71     /// This comes up primarily when resolving ambiguity. Imagine
72     /// there is some trait reference `$0 : Bar` where `$0` is an
73     /// inference variable. If `intercrate` is true, then we can never
74     /// say for sure that this reference is not implemented, even if
75     /// there are *no impls at all for `Bar`*, because `$0` could be
76     /// bound to some type that in a downstream crate that implements
77     /// `Bar`. This is the suitable mode for coherence. Elsewhere,
78     /// though, we set this to false, because we are only interested
79     /// in types that the user could actually have written --- in
80     /// other words, we consider `$0 : Bar` to be unimplemented if
81     /// there is no type that the user could *actually name* that
82     /// would satisfy it. This avoids crippling inference, basically.
83     intercrate: Option<IntercrateMode>,
84
85     intercrate_ambiguity_causes: Option<Vec<IntercrateAmbiguityCause>>,
86
87     /// Controls whether or not to filter out negative impls when selecting.
88     /// This is used in librustdoc to distinguish between the lack of an impl
89     /// and a negative impl
90     allow_negative_impls: bool,
91
92     /// The mode that trait queries run in, which informs our error handling
93     /// policy. In essence, canonicalized queries need their errors propagated
94     /// rather than immediately reported because we do not have accurate spans.
95     query_mode: TraitQueryMode,
96 }
97
98 #[derive(Clone, Debug)]
99 pub enum IntercrateAmbiguityCause {
100     DownstreamCrate {
101         trait_desc: String,
102         self_desc: Option<String>,
103     },
104     UpstreamCrateUpdate {
105         trait_desc: String,
106         self_desc: Option<String>,
107     },
108 }
109
110 impl IntercrateAmbiguityCause {
111     /// Emits notes when the overlap is caused by complex intercrate ambiguities.
112     /// See #23980 for details.
113     pub fn add_intercrate_ambiguity_hint<'a, 'tcx>(&self,
114                                                    err: &mut ::errors::DiagnosticBuilder) {
115         err.note(&self.intercrate_ambiguity_hint());
116     }
117
118     pub fn intercrate_ambiguity_hint(&self) -> String {
119         match self {
120             &IntercrateAmbiguityCause::DownstreamCrate { ref trait_desc, ref self_desc } => {
121                 let self_desc = if let &Some(ref ty) = self_desc {
122                     format!(" for type `{}`", ty)
123                 } else { "".to_string() };
124                 format!("downstream crates may implement trait `{}`{}", trait_desc, self_desc)
125             }
126             &IntercrateAmbiguityCause::UpstreamCrateUpdate { ref trait_desc, ref self_desc } => {
127                 let self_desc = if let &Some(ref ty) = self_desc {
128                     format!(" for type `{}`", ty)
129                 } else { "".to_string() };
130                 format!("upstream crates may add new impl of trait `{}`{} \
131                          in future versions",
132                         trait_desc, self_desc)
133             }
134         }
135     }
136 }
137
138 // A stack that walks back up the stack frame.
139 struct TraitObligationStack<'prev, 'tcx: 'prev> {
140     obligation: &'prev TraitObligation<'tcx>,
141
142     /// Trait ref from `obligation` but skolemized with the
143     /// selection-context's freshener. Used to check for recursion.
144     fresh_trait_ref: ty::PolyTraitRef<'tcx>,
145
146     previous: TraitObligationStackList<'prev, 'tcx>,
147 }
148
149 #[derive(Clone)]
150 pub struct SelectionCache<'tcx> {
151     hashmap: Lock<FxHashMap<ty::TraitRef<'tcx>,
152                                WithDepNode<SelectionResult<'tcx, SelectionCandidate<'tcx>>>>>,
153 }
154
155 /// The selection process begins by considering all impls, where
156 /// clauses, and so forth that might resolve an obligation.  Sometimes
157 /// we'll be able to say definitively that (e.g.) an impl does not
158 /// apply to the obligation: perhaps it is defined for `usize` but the
159 /// obligation is for `int`. In that case, we drop the impl out of the
160 /// list.  But the other cases are considered *candidates*.
161 ///
162 /// For selection to succeed, there must be exactly one matching
163 /// candidate. If the obligation is fully known, this is guaranteed
164 /// by coherence. However, if the obligation contains type parameters
165 /// or variables, there may be multiple such impls.
166 ///
167 /// It is not a real problem if multiple matching impls exist because
168 /// of type variables - it just means the obligation isn't sufficiently
169 /// elaborated. In that case we report an ambiguity, and the caller can
170 /// try again after more type information has been gathered or report a
171 /// "type annotations required" error.
172 ///
173 /// However, with type parameters, this can be a real problem - type
174 /// parameters don't unify with regular types, but they *can* unify
175 /// with variables from blanket impls, and (unless we know its bounds
176 /// will always be satisfied) picking the blanket impl will be wrong
177 /// for at least *some* substitutions. To make this concrete, if we have
178 ///
179 ///    trait AsDebug { type Out : fmt::Debug; fn debug(self) -> Self::Out; }
180 ///    impl<T: fmt::Debug> AsDebug for T {
181 ///        type Out = T;
182 ///        fn debug(self) -> fmt::Debug { self }
183 ///    }
184 ///    fn foo<T: AsDebug>(t: T) { println!("{:?}", <T as AsDebug>::debug(t)); }
185 ///
186 /// we can't just use the impl to resolve the <T as AsDebug> obligation
187 /// - a type from another crate (that doesn't implement fmt::Debug) could
188 /// implement AsDebug.
189 ///
190 /// Because where-clauses match the type exactly, multiple clauses can
191 /// only match if there are unresolved variables, and we can mostly just
192 /// report this ambiguity in that case. This is still a problem - we can't
193 /// *do anything* with ambiguities that involve only regions. This is issue
194 /// #21974.
195 ///
196 /// If a single where-clause matches and there are no inference
197 /// variables left, then it definitely matches and we can just select
198 /// it.
199 ///
200 /// In fact, we even select the where-clause when the obligation contains
201 /// inference variables. The can lead to inference making "leaps of logic",
202 /// for example in this situation:
203 ///
204 ///    pub trait Foo<T> { fn foo(&self) -> T; }
205 ///    impl<T> Foo<()> for T { fn foo(&self) { } }
206 ///    impl Foo<bool> for bool { fn foo(&self) -> bool { *self } }
207 ///
208 ///    pub fn foo<T>(t: T) where T: Foo<bool> {
209 ///       println!("{:?}", <T as Foo<_>>::foo(&t));
210 ///    }
211 ///    fn main() { foo(false); }
212 ///
213 /// Here the obligation <T as Foo<$0>> can be matched by both the blanket
214 /// impl and the where-clause. We select the where-clause and unify $0=bool,
215 /// so the program prints "false". However, if the where-clause is omitted,
216 /// the blanket impl is selected, we unify $0=(), and the program prints
217 /// "()".
218 ///
219 /// Exactly the same issues apply to projection and object candidates, except
220 /// that we can have both a projection candidate and a where-clause candidate
221 /// for the same obligation. In that case either would do (except that
222 /// different "leaps of logic" would occur if inference variables are
223 /// present), and we just pick the where-clause. This is, for example,
224 /// required for associated types to work in default impls, as the bounds
225 /// are visible both as projection bounds and as where-clauses from the
226 /// parameter environment.
227 #[derive(PartialEq,Eq,Debug,Clone)]
228 enum SelectionCandidate<'tcx> {
229     BuiltinCandidate { has_nested: bool },
230     ParamCandidate(ty::PolyTraitRef<'tcx>),
231     ImplCandidate(DefId),
232     AutoImplCandidate(DefId),
233
234     /// This is a trait matching with a projected type as `Self`, and
235     /// we found an applicable bound in the trait definition.
236     ProjectionCandidate,
237
238     /// Implementation of a `Fn`-family trait by one of the anonymous types
239     /// generated for a `||` expression.
240     ClosureCandidate,
241
242     /// Implementation of a `Generator` trait by one of the anonymous types
243     /// generated for a generator.
244     GeneratorCandidate,
245
246     /// Implementation of a `Fn`-family trait by one of the anonymous
247     /// types generated for a fn pointer type (e.g., `fn(int)->int`)
248     FnPointerCandidate,
249
250     ObjectCandidate,
251
252     BuiltinObjectCandidate,
253
254     BuiltinUnsizeCandidate,
255 }
256
257 impl<'a, 'tcx> ty::Lift<'tcx> for SelectionCandidate<'a> {
258     type Lifted = SelectionCandidate<'tcx>;
259     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Self::Lifted> {
260         Some(match *self {
261             BuiltinCandidate { has_nested } => {
262                 BuiltinCandidate {
263                     has_nested,
264                 }
265             }
266             ImplCandidate(def_id) => ImplCandidate(def_id),
267             AutoImplCandidate(def_id) => AutoImplCandidate(def_id),
268             ProjectionCandidate => ProjectionCandidate,
269             FnPointerCandidate => FnPointerCandidate,
270             ObjectCandidate => ObjectCandidate,
271             BuiltinObjectCandidate => BuiltinObjectCandidate,
272             BuiltinUnsizeCandidate => BuiltinUnsizeCandidate,
273             ClosureCandidate => ClosureCandidate,
274             GeneratorCandidate => GeneratorCandidate,
275
276             ParamCandidate(ref trait_ref) => {
277                 return tcx.lift(trait_ref).map(ParamCandidate);
278             }
279         })
280     }
281 }
282
283 struct SelectionCandidateSet<'tcx> {
284     // a list of candidates that definitely apply to the current
285     // obligation (meaning: types unify).
286     vec: Vec<SelectionCandidate<'tcx>>,
287
288     // if this is true, then there were candidates that might or might
289     // not have applied, but we couldn't tell. This occurs when some
290     // of the input types are type variables, in which case there are
291     // various "builtin" rules that might or might not trigger.
292     ambiguous: bool,
293 }
294
295 #[derive(PartialEq,Eq,Debug,Clone)]
296 struct EvaluatedCandidate<'tcx> {
297     candidate: SelectionCandidate<'tcx>,
298     evaluation: EvaluationResult,
299 }
300
301 /// When does the builtin impl for `T: Trait` apply?
302 enum BuiltinImplConditions<'tcx> {
303     /// The impl is conditional on T1,T2,.. : Trait
304     Where(ty::Binder<Vec<Ty<'tcx>>>),
305     /// There is no built-in impl. There may be some other
306     /// candidate (a where-clause or user-defined impl).
307     None,
308     /// It is unknown whether there is an impl.
309     Ambiguous
310 }
311
312 #[derive(Copy, Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
313 /// The result of trait evaluation. The order is important
314 /// here as the evaluation of a list is the maximum of the
315 /// evaluations.
316 ///
317 /// The evaluation results are ordered:
318 ///     - `EvaluatedToOk` implies `EvaluatedToAmbig` implies `EvaluatedToUnknown`
319 ///     - `EvaluatedToErr` implies `EvaluatedToRecur`
320 ///     - the "union" of evaluation results is equal to their maximum -
321 ///     all the "potential success" candidates can potentially succeed,
322 ///     so they are no-ops when unioned with a definite error, and within
323 ///     the categories it's easy to see that the unions are correct.
324 pub enum EvaluationResult {
325     /// Evaluation successful
326     EvaluatedToOk,
327     /// Evaluation is known to be ambiguous - it *might* hold for some
328     /// assignment of inference variables, but it might not.
329     ///
330     /// While this has the same meaning as `EvaluatedToUnknown` - we can't
331     /// know whether this obligation holds or not - it is the result we
332     /// would get with an empty stack, and therefore is cacheable.
333     EvaluatedToAmbig,
334     /// Evaluation failed because of recursion involving inference
335     /// variables. We are somewhat imprecise there, so we don't actually
336     /// know the real result.
337     ///
338     /// This can't be trivially cached for the same reason as `EvaluatedToRecur`.
339     EvaluatedToUnknown,
340     /// Evaluation failed because we encountered an obligation we are already
341     /// trying to prove on this branch.
342     ///
343     /// We know this branch can't be a part of a minimal proof-tree for
344     /// the "root" of our cycle, because then we could cut out the recursion
345     /// and maintain a valid proof tree. However, this does not mean
346     /// that all the obligations on this branch do not hold - it's possible
347     /// that we entered this branch "speculatively", and that there
348     /// might be some other way to prove this obligation that does not
349     /// go through this cycle - so we can't cache this as a failure.
350     ///
351     /// For example, suppose we have this:
352     ///
353     /// ```rust,ignore (pseudo-Rust)
354     ///     pub trait Trait { fn xyz(); }
355     ///     // This impl is "useless", but we can still have
356     ///     // an `impl Trait for SomeUnsizedType` somewhere.
357     ///     impl<T: Trait + Sized> Trait for T { fn xyz() {} }
358     ///
359     ///     pub fn foo<T: Trait + ?Sized>() {
360     ///         <T as Trait>::xyz();
361     ///     }
362     /// ```
363     ///
364     /// When checking `foo`, we have to prove `T: Trait`. This basically
365     /// translates into this:
366     ///
367     /// ```plain,ignore
368     ///     (T: Trait + Sized â†’_\impl T: Trait), T: Trait âŠ¢ T: Trait
369     /// ```
370     ///
371     /// When we try to prove it, we first go the first option, which
372     /// recurses. This shows us that the impl is "useless" - it won't
373     /// tell us that `T: Trait` unless it already implemented `Trait`
374     /// by some other means. However, that does not prevent `T: Trait`
375     /// does not hold, because of the bound (which can indeed be satisfied
376     /// by `SomeUnsizedType` from another crate).
377     ///
378     /// FIXME: when an `EvaluatedToRecur` goes past its parent root, we
379     /// ought to convert it to an `EvaluatedToErr`, because we know
380     /// there definitely isn't a proof tree for that obligation. Not
381     /// doing so is still sound - there isn't any proof tree, so the
382     /// branch still can't be a part of a minimal one - but does not
383     /// re-enable caching.
384     EvaluatedToRecur,
385     /// Evaluation failed
386     EvaluatedToErr,
387 }
388
389 impl EvaluationResult {
390     pub fn may_apply(self) -> bool {
391         match self {
392             EvaluatedToOk |
393             EvaluatedToAmbig |
394             EvaluatedToUnknown => true,
395
396             EvaluatedToErr |
397             EvaluatedToRecur => false
398         }
399     }
400
401     fn is_stack_dependent(self) -> bool {
402         match self {
403             EvaluatedToUnknown |
404             EvaluatedToRecur => true,
405
406             EvaluatedToOk |
407             EvaluatedToAmbig |
408             EvaluatedToErr => false,
409         }
410     }
411 }
412
413 impl_stable_hash_for!(enum self::EvaluationResult {
414     EvaluatedToOk,
415     EvaluatedToAmbig,
416     EvaluatedToUnknown,
417     EvaluatedToRecur,
418     EvaluatedToErr
419 });
420
421 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
422 /// Indicates that trait evaluation caused overflow.
423 pub struct OverflowError;
424
425 impl_stable_hash_for!(struct OverflowError { });
426
427 impl<'tcx> From<OverflowError> for SelectionError<'tcx> {
428     fn from(OverflowError: OverflowError) -> SelectionError<'tcx> {
429         SelectionError::Overflow
430     }
431 }
432
433 #[derive(Clone)]
434 pub struct EvaluationCache<'tcx> {
435     hashmap: Lock<FxHashMap<ty::PolyTraitRef<'tcx>, WithDepNode<EvaluationResult>>>
436 }
437
438 impl<'cx, 'gcx, 'tcx> SelectionContext<'cx, 'gcx, 'tcx> {
439     pub fn new(infcx: &'cx InferCtxt<'cx, 'gcx, 'tcx>) -> SelectionContext<'cx, 'gcx, 'tcx> {
440         SelectionContext {
441             infcx,
442             freshener: infcx.freshener(),
443             intercrate: None,
444             intercrate_ambiguity_causes: None,
445             allow_negative_impls: false,
446             query_mode: TraitQueryMode::Standard,
447         }
448     }
449
450     pub fn intercrate(infcx: &'cx InferCtxt<'cx, 'gcx, 'tcx>,
451                       mode: IntercrateMode) -> SelectionContext<'cx, 'gcx, 'tcx> {
452         debug!("intercrate({:?})", mode);
453         SelectionContext {
454             infcx,
455             freshener: infcx.freshener(),
456             intercrate: Some(mode),
457             intercrate_ambiguity_causes: None,
458             allow_negative_impls: false,
459             query_mode: TraitQueryMode::Standard,
460         }
461     }
462
463     pub fn with_negative(infcx: &'cx InferCtxt<'cx, 'gcx, 'tcx>,
464                          allow_negative_impls: bool) -> SelectionContext<'cx, 'gcx, 'tcx> {
465         debug!("with_negative({:?})", allow_negative_impls);
466         SelectionContext {
467             infcx,
468             freshener: infcx.freshener(),
469             intercrate: None,
470             intercrate_ambiguity_causes: None,
471             allow_negative_impls,
472             query_mode: TraitQueryMode::Standard,
473         }
474     }
475
476     pub fn with_query_mode(infcx: &'cx InferCtxt<'cx, 'gcx, 'tcx>,
477                            query_mode: TraitQueryMode) -> SelectionContext<'cx, 'gcx, 'tcx> {
478         debug!("with_query_mode({:?})", query_mode);
479         SelectionContext {
480             infcx,
481             freshener: infcx.freshener(),
482             intercrate: None,
483             intercrate_ambiguity_causes: None,
484             allow_negative_impls: false,
485             query_mode,
486         }
487     }
488
489     /// Enables tracking of intercrate ambiguity causes. These are
490     /// used in coherence to give improved diagnostics. We don't do
491     /// this until we detect a coherence error because it can lead to
492     /// false overflow results (#47139) and because it costs
493     /// computation time.
494     pub fn enable_tracking_intercrate_ambiguity_causes(&mut self) {
495         assert!(self.intercrate.is_some());
496         assert!(self.intercrate_ambiguity_causes.is_none());
497         self.intercrate_ambiguity_causes = Some(vec![]);
498         debug!("selcx: enable_tracking_intercrate_ambiguity_causes");
499     }
500
501     /// Gets the intercrate ambiguity causes collected since tracking
502     /// was enabled and disables tracking at the same time. If
503     /// tracking is not enabled, just returns an empty vector.
504     pub fn take_intercrate_ambiguity_causes(&mut self) -> Vec<IntercrateAmbiguityCause> {
505         assert!(self.intercrate.is_some());
506         self.intercrate_ambiguity_causes.take().unwrap_or(vec![])
507     }
508
509     pub fn infcx(&self) -> &'cx InferCtxt<'cx, 'gcx, 'tcx> {
510         self.infcx
511     }
512
513     pub fn tcx(&self) -> TyCtxt<'cx, 'gcx, 'tcx> {
514         self.infcx.tcx
515     }
516
517     pub fn closure_typer(&self) -> &'cx InferCtxt<'cx, 'gcx, 'tcx> {
518         self.infcx
519     }
520
521     /// Wraps the inference context's in_snapshot s.t. snapshot handling is only from the selection
522     /// context's self.
523     fn in_snapshot<R, F>(&mut self, f: F) -> R
524         where F: FnOnce(&mut Self, &infer::CombinedSnapshot<'cx, 'tcx>) -> R
525     {
526         self.infcx.in_snapshot(|snapshot| f(self, snapshot))
527     }
528
529     /// Wraps a probe s.t. obligations collected during it are ignored and old obligations are
530     /// retained.
531     fn probe<R, F>(&mut self, f: F) -> R
532         where F: FnOnce(&mut Self, &infer::CombinedSnapshot<'cx, 'tcx>) -> R
533     {
534         self.infcx.probe(|snapshot| f(self, snapshot))
535     }
536
537     /// Wraps a commit_if_ok s.t. obligations collected during it are not returned in selection if
538     /// the transaction fails and s.t. old obligations are retained.
539     fn commit_if_ok<T, E, F>(&mut self, f: F) -> Result<T, E> where
540         F: FnOnce(&mut Self, &infer::CombinedSnapshot) -> Result<T, E>
541     {
542         self.infcx.commit_if_ok(|snapshot| f(self, snapshot))
543     }
544
545
546     ///////////////////////////////////////////////////////////////////////////
547     // Selection
548     //
549     // The selection phase tries to identify *how* an obligation will
550     // be resolved. For example, it will identify which impl or
551     // parameter bound is to be used. The process can be inconclusive
552     // if the self type in the obligation is not fully inferred. Selection
553     // can result in an error in one of two ways:
554     //
555     // 1. If no applicable impl or parameter bound can be found.
556     // 2. If the output type parameters in the obligation do not match
557     //    those specified by the impl/bound. For example, if the obligation
558     //    is `Vec<Foo>:Iterable<Bar>`, but the impl specifies
559     //    `impl<T> Iterable<T> for Vec<T>`, than an error would result.
560
561     /// Attempts to satisfy the obligation. If successful, this will affect the surrounding
562     /// type environment by performing unification.
563     pub fn select(&mut self, obligation: &TraitObligation<'tcx>)
564                   -> SelectionResult<'tcx, Selection<'tcx>> {
565         debug!("select({:?})", obligation);
566         assert!(!obligation.predicate.has_escaping_regions());
567
568         let stack = self.push_stack(TraitObligationStackList::empty(), obligation);
569
570         let candidate = match self.candidate_from_obligation(&stack) {
571             Err(SelectionError::Overflow) => {
572                 // In standard mode, overflow must have been caught and reported
573                 // earlier.
574                 assert!(self.query_mode == TraitQueryMode::Canonical);
575                 return Err(SelectionError::Overflow);
576             },
577             Err(e) => { return Err(e); },
578             Ok(None) => { return Ok(None); },
579             Ok(Some(candidate)) => candidate
580         };
581
582         match self.confirm_candidate(obligation, candidate) {
583             Err(SelectionError::Overflow) => {
584                 assert!(self.query_mode == TraitQueryMode::Canonical);
585                 return Err(SelectionError::Overflow);
586             },
587             Err(e) => Err(e),
588             Ok(candidate) => Ok(Some(candidate))
589         }
590     }
591
592     ///////////////////////////////////////////////////////////////////////////
593     // EVALUATION
594     //
595     // Tests whether an obligation can be selected or whether an impl
596     // can be applied to particular types. It skips the "confirmation"
597     // step and hence completely ignores output type parameters.
598     //
599     // The result is "true" if the obligation *may* hold and "false" if
600     // we can be sure it does not.
601
602     /// Evaluates whether the obligation `obligation` can be satisfied (by any means).
603     pub fn predicate_may_hold_fatal(&mut self,
604                                     obligation: &PredicateObligation<'tcx>)
605                                     -> bool
606     {
607         debug!("predicate_may_hold_fatal({:?})",
608                obligation);
609
610         // This fatal query is a stopgap that should only be used in standard mode,
611         // where we do not expect overflow to be propagated.
612         assert!(self.query_mode == TraitQueryMode::Standard);
613
614         self.evaluate_obligation_recursively(obligation)
615             .expect("Overflow should be caught earlier in standard query mode")
616             .may_apply()
617     }
618
619     /// Evaluates whether the obligation `obligation` can be satisfied and returns
620     /// an `EvaluationResult`.
621     pub fn evaluate_obligation_recursively(&mut self,
622                                            obligation: &PredicateObligation<'tcx>)
623                                            -> Result<EvaluationResult, OverflowError>
624     {
625         self.probe(|this, _| {
626             this.evaluate_predicate_recursively(TraitObligationStackList::empty(), obligation)
627         })
628     }
629
630     /// Evaluates the predicates in `predicates` recursively. Note that
631     /// this applies projections in the predicates, and therefore
632     /// is run within an inference probe.
633     fn evaluate_predicates_recursively<'a,'o,I>(&mut self,
634                                                 stack: TraitObligationStackList<'o, 'tcx>,
635                                                 predicates: I)
636                                                 -> Result<EvaluationResult, OverflowError>
637         where I : IntoIterator<Item=&'a PredicateObligation<'tcx>>, 'tcx:'a
638     {
639         let mut result = EvaluatedToOk;
640         for obligation in predicates {
641             let eval = self.evaluate_predicate_recursively(stack, obligation)?;
642             debug!("evaluate_predicate_recursively({:?}) = {:?}",
643                    obligation, eval);
644             if let EvaluatedToErr = eval {
645                 // fast-path - EvaluatedToErr is the top of the lattice,
646                 // so we don't need to look on the other predicates.
647                 return Ok(EvaluatedToErr);
648             } else {
649                 result = cmp::max(result, eval);
650             }
651         }
652         Ok(result)
653     }
654
655     fn evaluate_predicate_recursively<'o>(&mut self,
656                                           previous_stack: TraitObligationStackList<'o, 'tcx>,
657                                           obligation: &PredicateObligation<'tcx>)
658                                            -> Result<EvaluationResult, OverflowError>
659     {
660         debug!("evaluate_predicate_recursively({:?})",
661                obligation);
662
663         match obligation.predicate {
664             ty::Predicate::Trait(ref t) => {
665                 assert!(!t.has_escaping_regions());
666                 let obligation = obligation.with(t.clone());
667                 self.evaluate_trait_predicate_recursively(previous_stack, obligation)
668             }
669
670             ty::Predicate::Subtype(ref p) => {
671                 // does this code ever run?
672                 match self.infcx.subtype_predicate(&obligation.cause, obligation.param_env, p) {
673                     Some(Ok(InferOk { obligations, .. })) => {
674                         self.evaluate_predicates_recursively(previous_stack, &obligations)
675                     },
676                     Some(Err(_)) => Ok(EvaluatedToErr),
677                     None => Ok(EvaluatedToAmbig),
678                 }
679             }
680
681             ty::Predicate::WellFormed(ty) => {
682                 match ty::wf::obligations(self.infcx,
683                                           obligation.param_env,
684                                           obligation.cause.body_id,
685                                           ty, obligation.cause.span) {
686                     Some(obligations) =>
687                         self.evaluate_predicates_recursively(previous_stack, obligations.iter()),
688                     None =>
689                         Ok(EvaluatedToAmbig),
690                 }
691             }
692
693             ty::Predicate::TypeOutlives(..) | ty::Predicate::RegionOutlives(..) => {
694                 // we do not consider region relationships when
695                 // evaluating trait matches
696                 Ok(EvaluatedToOk)
697             }
698
699             ty::Predicate::ObjectSafe(trait_def_id) => {
700                 if self.tcx().is_object_safe(trait_def_id) {
701                     Ok(EvaluatedToOk)
702                 } else {
703                     Ok(EvaluatedToErr)
704                 }
705             }
706
707             ty::Predicate::Projection(ref data) => {
708                 let project_obligation = obligation.with(data.clone());
709                 match project::poly_project_and_unify_type(self, &project_obligation) {
710                     Ok(Some(subobligations)) => {
711                         let result = self.evaluate_predicates_recursively(previous_stack,
712                                                                           subobligations.iter());
713                         if let Some(key) =
714                             ProjectionCacheKey::from_poly_projection_predicate(self, data)
715                         {
716                             self.infcx.projection_cache.borrow_mut().complete(key);
717                         }
718                         result
719                     }
720                     Ok(None) => {
721                         Ok(EvaluatedToAmbig)
722                     }
723                     Err(_) => {
724                         Ok(EvaluatedToErr)
725                     }
726                 }
727             }
728
729             ty::Predicate::ClosureKind(closure_def_id, closure_substs, kind) => {
730                 match self.infcx.closure_kind(closure_def_id, closure_substs) {
731                     Some(closure_kind) => {
732                         if closure_kind.extends(kind) {
733                             Ok(EvaluatedToOk)
734                         } else {
735                             Ok(EvaluatedToErr)
736                         }
737                     }
738                     None => {
739                         Ok(EvaluatedToAmbig)
740                     }
741                 }
742             }
743
744             ty::Predicate::ConstEvaluatable(def_id, substs) => {
745                 let tcx = self.tcx();
746                 match tcx.lift_to_global(&(obligation.param_env, substs)) {
747                     Some((param_env, substs)) => {
748                         let instance = ty::Instance::resolve(
749                             tcx.global_tcx(),
750                             param_env,
751                             def_id,
752                             substs,
753                         );
754                         if let Some(instance) = instance {
755                             let cid = GlobalId {
756                                 instance,
757                                 promoted: None
758                             };
759                             match self.tcx().const_eval(param_env.and(cid)) {
760                                 Ok(_) => Ok(EvaluatedToOk),
761                                 Err(_) => Ok(EvaluatedToErr)
762                             }
763                         } else {
764                             Ok(EvaluatedToErr)
765                         }
766                     }
767                     None => {
768                         // Inference variables still left in param_env or substs.
769                         Ok(EvaluatedToAmbig)
770                     }
771                 }
772             }
773         }
774     }
775
776     fn evaluate_trait_predicate_recursively<'o>(&mut self,
777                                                 previous_stack: TraitObligationStackList<'o, 'tcx>,
778                                                 mut obligation: TraitObligation<'tcx>)
779                                                 -> Result<EvaluationResult, OverflowError>
780     {
781         debug!("evaluate_trait_predicate_recursively({:?})", obligation);
782
783         if self.intercrate.is_none() && obligation.is_global()
784             && obligation.param_env.caller_bounds.iter().all(|bound| bound.needs_subst()) {
785             // If a param env has no global bounds, global obligations do not
786             // depend on its particular value in order to work, so we can clear
787             // out the param env and get better caching.
788             debug!("evaluate_trait_predicate_recursively({:?}) - in global", obligation);
789             obligation.param_env = obligation.param_env.without_caller_bounds();
790         }
791
792         let stack = self.push_stack(previous_stack, &obligation);
793         let fresh_trait_ref = stack.fresh_trait_ref;
794         if let Some(result) = self.check_evaluation_cache(obligation.param_env, fresh_trait_ref) {
795             debug!("CACHE HIT: EVAL({:?})={:?}",
796                    fresh_trait_ref,
797                    result);
798             return Ok(result);
799         }
800
801         let (result, dep_node) = self.in_task(|this| this.evaluate_stack(&stack));
802         let result = result?;
803
804         debug!("CACHE MISS: EVAL({:?})={:?}",
805                fresh_trait_ref,
806                result);
807         self.insert_evaluation_cache(obligation.param_env, fresh_trait_ref, dep_node, result);
808
809         Ok(result)
810     }
811
812     fn evaluate_stack<'o>(&mut self,
813                           stack: &TraitObligationStack<'o, 'tcx>)
814                           -> Result<EvaluationResult, OverflowError>
815     {
816         // In intercrate mode, whenever any of the types are unbound,
817         // there can always be an impl. Even if there are no impls in
818         // this crate, perhaps the type would be unified with
819         // something from another crate that does provide an impl.
820         //
821         // In intra mode, we must still be conservative. The reason is
822         // that we want to avoid cycles. Imagine an impl like:
823         //
824         //     impl<T:Eq> Eq for Vec<T>
825         //
826         // and a trait reference like `$0 : Eq` where `$0` is an
827         // unbound variable. When we evaluate this trait-reference, we
828         // will unify `$0` with `Vec<$1>` (for some fresh variable
829         // `$1`), on the condition that `$1 : Eq`. We will then wind
830         // up with many candidates (since that are other `Eq` impls
831         // that apply) and try to winnow things down. This results in
832         // a recursive evaluation that `$1 : Eq` -- as you can
833         // imagine, this is just where we started. To avoid that, we
834         // check for unbound variables and return an ambiguous (hence possible)
835         // match if we've seen this trait before.
836         //
837         // This suffices to allow chains like `FnMut` implemented in
838         // terms of `Fn` etc, but we could probably make this more
839         // precise still.
840         let unbound_input_types =
841             stack.fresh_trait_ref.skip_binder().input_types().any(|ty| ty.is_fresh());
842         // this check was an imperfect workaround for a bug n the old
843         // intercrate mode, it should be removed when that goes away.
844         if unbound_input_types &&
845             self.intercrate == Some(IntercrateMode::Issue43355)
846         {
847             debug!("evaluate_stack({:?}) --> unbound argument, intercrate -->  ambiguous",
848                    stack.fresh_trait_ref);
849             // Heuristics: show the diagnostics when there are no candidates in crate.
850             if self.intercrate_ambiguity_causes.is_some() {
851                 debug!("evaluate_stack: intercrate_ambiguity_causes is some");
852                 if let Ok(candidate_set) = self.assemble_candidates(stack) {
853                     if !candidate_set.ambiguous && candidate_set.vec.is_empty() {
854                         let trait_ref = stack.obligation.predicate.skip_binder().trait_ref;
855                         let self_ty = trait_ref.self_ty();
856                         let cause = IntercrateAmbiguityCause::DownstreamCrate {
857                             trait_desc: trait_ref.to_string(),
858                             self_desc: if self_ty.has_concrete_skeleton() {
859                                 Some(self_ty.to_string())
860                             } else {
861                                 None
862                             },
863                         };
864                         debug!("evaluate_stack: pushing cause = {:?}", cause);
865                         self.intercrate_ambiguity_causes.as_mut().unwrap().push(cause);
866                     }
867                 }
868             }
869             return Ok(EvaluatedToAmbig);
870         }
871         if unbound_input_types &&
872               stack.iter().skip(1).any(
873                   |prev| stack.obligation.param_env == prev.obligation.param_env &&
874                       self.match_fresh_trait_refs(&stack.fresh_trait_ref,
875                                                   &prev.fresh_trait_ref))
876         {
877             debug!("evaluate_stack({:?}) --> unbound argument, recursive --> giving up",
878                    stack.fresh_trait_ref);
879             return Ok(EvaluatedToUnknown);
880         }
881
882         // If there is any previous entry on the stack that precisely
883         // matches this obligation, then we can assume that the
884         // obligation is satisfied for now (still all other conditions
885         // must be met of course). One obvious case this comes up is
886         // marker traits like `Send`. Think of a linked list:
887         //
888         //    struct List<T> { data: T, next: Option<Box<List<T>>> {
889         //
890         // `Box<List<T>>` will be `Send` if `T` is `Send` and
891         // `Option<Box<List<T>>>` is `Send`, and in turn
892         // `Option<Box<List<T>>>` is `Send` if `Box<List<T>>` is
893         // `Send`.
894         //
895         // Note that we do this comparison using the `fresh_trait_ref`
896         // fields. Because these have all been skolemized using
897         // `self.freshener`, we can be sure that (a) this will not
898         // affect the inferencer state and (b) that if we see two
899         // skolemized types with the same index, they refer to the
900         // same unbound type variable.
901         if let Some(rec_index) =
902             stack.iter()
903             .skip(1) // skip top-most frame
904             .position(|prev| stack.obligation.param_env == prev.obligation.param_env &&
905                       stack.fresh_trait_ref == prev.fresh_trait_ref)
906         {
907             debug!("evaluate_stack({:?}) --> recursive",
908                    stack.fresh_trait_ref);
909             let cycle = stack.iter().skip(1).take(rec_index+1);
910             let cycle = cycle.map(|stack| ty::Predicate::Trait(stack.obligation.predicate));
911             if self.coinductive_match(cycle) {
912                 debug!("evaluate_stack({:?}) --> recursive, coinductive",
913                        stack.fresh_trait_ref);
914                 return Ok(EvaluatedToOk);
915             } else {
916                 debug!("evaluate_stack({:?}) --> recursive, inductive",
917                        stack.fresh_trait_ref);
918                 return Ok(EvaluatedToRecur);
919             }
920         }
921
922         match self.candidate_from_obligation(stack) {
923             Ok(Some(c)) => self.evaluate_candidate(stack, &c),
924             Ok(None) => Ok(EvaluatedToAmbig),
925             Err(Overflow) => Err(OverflowError),
926             Err(..) => Ok(EvaluatedToErr)
927         }
928     }
929
930     /// For defaulted traits, we use a co-inductive strategy to solve, so
931     /// that recursion is ok. This routine returns true if the top of the
932     /// stack (`cycle[0]`):
933     ///
934     /// - is a defaulted trait, and
935     /// - it also appears in the backtrace at some position `X`; and,
936     /// - all the predicates at positions `X..` between `X` an the top are
937     ///   also defaulted traits.
938     pub fn coinductive_match<I>(&mut self, cycle: I) -> bool
939         where I: Iterator<Item=ty::Predicate<'tcx>>
940     {
941         let mut cycle = cycle;
942         cycle.all(|predicate| self.coinductive_predicate(predicate))
943     }
944
945     fn coinductive_predicate(&self, predicate: ty::Predicate<'tcx>) -> bool {
946         let result = match predicate {
947             ty::Predicate::Trait(ref data) => {
948                 self.tcx().trait_is_auto(data.def_id())
949             }
950             _ => {
951                 false
952             }
953         };
954         debug!("coinductive_predicate({:?}) = {:?}", predicate, result);
955         result
956     }
957
958     /// Further evaluate `candidate` to decide whether all type parameters match and whether nested
959     /// obligations are met. Returns true if `candidate` remains viable after this further
960     /// scrutiny.
961     fn evaluate_candidate<'o>(&mut self,
962                               stack: &TraitObligationStack<'o, 'tcx>,
963                               candidate: &SelectionCandidate<'tcx>)
964                               -> Result<EvaluationResult, OverflowError>
965     {
966         debug!("evaluate_candidate: depth={} candidate={:?}",
967                stack.obligation.recursion_depth, candidate);
968         let result = self.probe(|this, _| {
969             let candidate = (*candidate).clone();
970             match this.confirm_candidate(stack.obligation, candidate) {
971                 Ok(selection) => {
972                     this.evaluate_predicates_recursively(
973                         stack.list(),
974                         selection.nested_obligations().iter())
975                 }
976                 Err(..) => Ok(EvaluatedToErr)
977             }
978         })?;
979         debug!("evaluate_candidate: depth={} result={:?}",
980                stack.obligation.recursion_depth, result);
981         Ok(result)
982     }
983
984     fn check_evaluation_cache(&self,
985                               param_env: ty::ParamEnv<'tcx>,
986                               trait_ref: ty::PolyTraitRef<'tcx>)
987                               -> Option<EvaluationResult>
988     {
989         let tcx = self.tcx();
990         if self.can_use_global_caches(param_env) {
991             let cache = tcx.evaluation_cache.hashmap.borrow();
992             if let Some(cached) = cache.get(&trait_ref) {
993                 return Some(cached.get(tcx));
994             }
995         }
996         self.infcx.evaluation_cache.hashmap
997                                    .borrow()
998                                    .get(&trait_ref)
999                                    .map(|v| v.get(tcx))
1000     }
1001
1002     fn insert_evaluation_cache(&mut self,
1003                                param_env: ty::ParamEnv<'tcx>,
1004                                trait_ref: ty::PolyTraitRef<'tcx>,
1005                                dep_node: DepNodeIndex,
1006                                result: EvaluationResult)
1007     {
1008         // Avoid caching results that depend on more than just the trait-ref
1009         // - the stack can create recursion.
1010         if result.is_stack_dependent() {
1011             return;
1012         }
1013
1014         if self.can_use_global_caches(param_env) {
1015             if let Some(trait_ref) = self.tcx().lift_to_global(&trait_ref) {
1016                 debug!(
1017                     "insert_evaluation_cache(trait_ref={:?}, candidate={:?}) global",
1018                     trait_ref,
1019                     result,
1020                 );
1021                 // This may overwrite the cache with the same value
1022                 // FIXME: Due to #50507 this overwrites the different values
1023                 // This should be changed to use HashMapExt::insert_same
1024                 // when that is fixed
1025                 self.tcx().evaluation_cache
1026                           .hashmap.borrow_mut()
1027                           .insert(trait_ref, WithDepNode::new(dep_node, result));
1028                 return;
1029             }
1030         }
1031
1032         debug!(
1033             "insert_evaluation_cache(trait_ref={:?}, candidate={:?})",
1034             trait_ref,
1035             result,
1036         );
1037         self.infcx.evaluation_cache.hashmap
1038                                    .borrow_mut()
1039                                    .insert(trait_ref, WithDepNode::new(dep_node, result));
1040     }
1041
1042     ///////////////////////////////////////////////////////////////////////////
1043     // CANDIDATE ASSEMBLY
1044     //
1045     // The selection process begins by examining all in-scope impls,
1046     // caller obligations, and so forth and assembling a list of
1047     // candidates. See [rustc guide] for more details.
1048     //
1049     // [rustc guide]:
1050     // https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html#candidate-assembly
1051
1052     fn candidate_from_obligation<'o>(&mut self,
1053                                      stack: &TraitObligationStack<'o, 'tcx>)
1054                                      -> SelectionResult<'tcx, SelectionCandidate<'tcx>>
1055     {
1056         // Watch out for overflow. This intentionally bypasses (and does
1057         // not update) the cache.
1058         let recursion_limit = *self.infcx.tcx.sess.recursion_limit.get();
1059         if stack.obligation.recursion_depth >= recursion_limit {
1060             match self.query_mode {
1061                 TraitQueryMode::Standard => {
1062                     self.infcx().report_overflow_error(&stack.obligation, true);
1063                 },
1064                 TraitQueryMode::Canonical => {
1065                     return Err(Overflow);
1066                 },
1067             }
1068         }
1069
1070         // Check the cache. Note that we skolemize the trait-ref
1071         // separately rather than using `stack.fresh_trait_ref` -- this
1072         // is because we want the unbound variables to be replaced
1073         // with fresh skolemized types starting from index 0.
1074         let cache_fresh_trait_pred =
1075             self.infcx.freshen(stack.obligation.predicate.clone());
1076         debug!("candidate_from_obligation(cache_fresh_trait_pred={:?}, obligation={:?})",
1077                cache_fresh_trait_pred,
1078                stack);
1079         assert!(!stack.obligation.predicate.has_escaping_regions());
1080
1081         if let Some(c) = self.check_candidate_cache(stack.obligation.param_env,
1082                                                     &cache_fresh_trait_pred) {
1083             debug!("CACHE HIT: SELECT({:?})={:?}",
1084                    cache_fresh_trait_pred,
1085                    c);
1086             return c;
1087         }
1088
1089         // If no match, compute result and insert into cache.
1090         let (candidate, dep_node) = self.in_task(|this| {
1091             this.candidate_from_obligation_no_cache(stack)
1092         });
1093
1094         debug!("CACHE MISS: SELECT({:?})={:?}",
1095                cache_fresh_trait_pred, candidate);
1096         self.insert_candidate_cache(stack.obligation.param_env,
1097                                     cache_fresh_trait_pred,
1098                                     dep_node,
1099                                     candidate.clone());
1100         candidate
1101     }
1102
1103     fn in_task<OP, R>(&mut self, op: OP) -> (R, DepNodeIndex)
1104         where OP: FnOnce(&mut Self) -> R
1105     {
1106         let (result, dep_node) = self.tcx().dep_graph.with_anon_task(DepKind::TraitSelect, || {
1107             op(self)
1108         });
1109         self.tcx().dep_graph.read_index(dep_node);
1110         (result, dep_node)
1111     }
1112
1113     // Treat negative impls as unimplemented
1114     fn filter_negative_impls(&self, candidate: SelectionCandidate<'tcx>)
1115                              -> SelectionResult<'tcx, SelectionCandidate<'tcx>> {
1116         if let ImplCandidate(def_id) = candidate {
1117             if !self.allow_negative_impls &&
1118                 self.tcx().impl_polarity(def_id) == hir::ImplPolarity::Negative {
1119                 return Err(Unimplemented)
1120             }
1121         }
1122         Ok(Some(candidate))
1123     }
1124
1125     fn candidate_from_obligation_no_cache<'o>(&mut self,
1126                                               stack: &TraitObligationStack<'o, 'tcx>)
1127                                               -> SelectionResult<'tcx, SelectionCandidate<'tcx>>
1128     {
1129         if stack.obligation.predicate.references_error() {
1130             // If we encounter a `TyError`, we generally prefer the
1131             // most "optimistic" result in response -- that is, the
1132             // one least likely to report downstream errors. But
1133             // because this routine is shared by coherence and by
1134             // trait selection, there isn't an obvious "right" choice
1135             // here in that respect, so we opt to just return
1136             // ambiguity and let the upstream clients sort it out.
1137             return Ok(None);
1138         }
1139
1140         match self.is_knowable(stack) {
1141             None => {}
1142             Some(conflict) => {
1143                 debug!("coherence stage: not knowable");
1144                 if self.intercrate_ambiguity_causes.is_some() {
1145                     debug!("evaluate_stack: intercrate_ambiguity_causes is some");
1146                     // Heuristics: show the diagnostics when there are no candidates in crate.
1147                     if let Ok(candidate_set) = self.assemble_candidates(stack) {
1148                         let no_candidates_apply =
1149                             candidate_set
1150                             .vec
1151                             .iter()
1152                             .map(|c| self.evaluate_candidate(stack, &c))
1153                             .collect::<Result<Vec<_>, OverflowError>>()?
1154                             .iter()
1155                             .all(|r| !r.may_apply());
1156                         if !candidate_set.ambiguous && no_candidates_apply {
1157                             let trait_ref = stack.obligation.predicate.skip_binder().trait_ref;
1158                             let self_ty = trait_ref.self_ty();
1159                             let trait_desc = trait_ref.to_string();
1160                             let self_desc = if self_ty.has_concrete_skeleton() {
1161                                 Some(self_ty.to_string())
1162                             } else {
1163                                 None
1164                             };
1165                             let cause = if let Conflict::Upstream = conflict {
1166                                 IntercrateAmbiguityCause::UpstreamCrateUpdate {
1167                                     trait_desc,
1168                                     self_desc,
1169                                 }
1170                             } else {
1171                                 IntercrateAmbiguityCause::DownstreamCrate { trait_desc, self_desc }
1172                             };
1173                             debug!("evaluate_stack: pushing cause = {:?}", cause);
1174                             self.intercrate_ambiguity_causes.as_mut().unwrap().push(cause);
1175                         }
1176                     }
1177                 }
1178                 return Ok(None);
1179             }
1180         }
1181
1182         let candidate_set = self.assemble_candidates(stack)?;
1183
1184         if candidate_set.ambiguous {
1185             debug!("candidate set contains ambig");
1186             return Ok(None);
1187         }
1188
1189         let mut candidates = candidate_set.vec;
1190
1191         debug!("assembled {} candidates for {:?}: {:?}",
1192                candidates.len(),
1193                stack,
1194                candidates);
1195
1196         // At this point, we know that each of the entries in the
1197         // candidate set is *individually* applicable. Now we have to
1198         // figure out if they contain mutual incompatibilities. This
1199         // frequently arises if we have an unconstrained input type --
1200         // for example, we are looking for $0:Eq where $0 is some
1201         // unconstrained type variable. In that case, we'll get a
1202         // candidate which assumes $0 == int, one that assumes $0 ==
1203         // usize, etc. This spells an ambiguity.
1204
1205         // If there is more than one candidate, first winnow them down
1206         // by considering extra conditions (nested obligations and so
1207         // forth). We don't winnow if there is exactly one
1208         // candidate. This is a relatively minor distinction but it
1209         // can lead to better inference and error-reporting. An
1210         // example would be if there was an impl:
1211         //
1212         //     impl<T:Clone> Vec<T> { fn push_clone(...) { ... } }
1213         //
1214         // and we were to see some code `foo.push_clone()` where `boo`
1215         // is a `Vec<Bar>` and `Bar` does not implement `Clone`.  If
1216         // we were to winnow, we'd wind up with zero candidates.
1217         // Instead, we select the right impl now but report `Bar does
1218         // not implement Clone`.
1219         if candidates.len() == 1 {
1220             return self.filter_negative_impls(candidates.pop().unwrap());
1221         }
1222
1223         // Winnow, but record the exact outcome of evaluation, which
1224         // is needed for specialization. Propagate overflow if it occurs.
1225         let candidates: Result<Vec<Option<EvaluatedCandidate>>, _> = candidates
1226             .into_iter()
1227             .map(|c| match self.evaluate_candidate(stack, &c) {
1228                 Ok(eval) if eval.may_apply() => Ok(Some(EvaluatedCandidate {
1229                     candidate: c,
1230                     evaluation: eval,
1231                 })),
1232                 Ok(_) => Ok(None),
1233                 Err(OverflowError) => Err(Overflow),
1234             })
1235             .collect();
1236
1237         let mut candidates: Vec<EvaluatedCandidate> =
1238             candidates?.into_iter().filter_map(|c| c).collect();
1239
1240         // If there are STILL multiple candidate, we can further
1241         // reduce the list by dropping duplicates -- including
1242         // resolving specializations.
1243         if candidates.len() > 1 {
1244             let mut i = 0;
1245             while i < candidates.len() {
1246                 let is_dup =
1247                     (0..candidates.len())
1248                     .filter(|&j| i != j)
1249                     .any(|j| self.candidate_should_be_dropped_in_favor_of(&candidates[i],
1250                                                                           &candidates[j]));
1251                 if is_dup {
1252                     debug!("Dropping candidate #{}/{}: {:?}",
1253                            i, candidates.len(), candidates[i]);
1254                     candidates.swap_remove(i);
1255                 } else {
1256                     debug!("Retaining candidate #{}/{}: {:?}",
1257                            i, candidates.len(), candidates[i]);
1258                     i += 1;
1259
1260                     // If there are *STILL* multiple candidates, give up
1261                     // and report ambiguity.
1262                     if i > 1 {
1263                         debug!("multiple matches, ambig");
1264                         return Ok(None);
1265                     }
1266                 }
1267             }
1268         }
1269
1270         // If there are *NO* candidates, then there are no impls --
1271         // that we know of, anyway. Note that in the case where there
1272         // are unbound type variables within the obligation, it might
1273         // be the case that you could still satisfy the obligation
1274         // from another crate by instantiating the type variables with
1275         // a type from another crate that does have an impl. This case
1276         // is checked for in `evaluate_stack` (and hence users
1277         // who might care about this case, like coherence, should use
1278         // that function).
1279         if candidates.is_empty() {
1280             return Err(Unimplemented);
1281         }
1282
1283         // Just one candidate left.
1284         self.filter_negative_impls(candidates.pop().unwrap().candidate)
1285     }
1286
1287     fn is_knowable<'o>(&mut self,
1288                        stack: &TraitObligationStack<'o, 'tcx>)
1289                        -> Option<Conflict>
1290     {
1291         debug!("is_knowable(intercrate={:?})", self.intercrate);
1292
1293         if !self.intercrate.is_some() {
1294             return None;
1295         }
1296
1297         let obligation = &stack.obligation;
1298         let predicate = self.infcx().resolve_type_vars_if_possible(&obligation.predicate);
1299
1300         // ok to skip binder because of the nature of the
1301         // trait-ref-is-knowable check, which does not care about
1302         // bound regions
1303         let trait_ref = predicate.skip_binder().trait_ref;
1304
1305         let result = coherence::trait_ref_is_knowable(self.tcx(), trait_ref);
1306         if let (Some(Conflict::Downstream { used_to_be_broken: true }),
1307                 Some(IntercrateMode::Issue43355)) = (result, self.intercrate) {
1308             debug!("is_knowable: IGNORING conflict to be bug-compatible with #43355");
1309             None
1310         } else {
1311             result
1312         }
1313     }
1314
1315     /// Returns true if the global caches can be used.
1316     /// Do note that if the type itself is not in the
1317     /// global tcx, the local caches will be used.
1318     fn can_use_global_caches(&self, param_env: ty::ParamEnv<'tcx>) -> bool {
1319         // If there are any where-clauses in scope, then we always use
1320         // a cache local to this particular scope. Otherwise, we
1321         // switch to a global cache. We used to try and draw
1322         // finer-grained distinctions, but that led to a serious of
1323         // annoying and weird bugs like #22019 and #18290. This simple
1324         // rule seems to be pretty clearly safe and also still retains
1325         // a very high hit rate (~95% when compiling rustc).
1326         if !param_env.caller_bounds.is_empty() {
1327             return false;
1328         }
1329
1330         // Avoid using the master cache during coherence and just rely
1331         // on the local cache. This effectively disables caching
1332         // during coherence. It is really just a simplification to
1333         // avoid us having to fear that coherence results "pollute"
1334         // the master cache. Since coherence executes pretty quickly,
1335         // it's not worth going to more trouble to increase the
1336         // hit-rate I don't think.
1337         if self.intercrate.is_some() {
1338             return false;
1339         }
1340
1341         // Otherwise, we can use the global cache.
1342         true
1343     }
1344
1345     fn check_candidate_cache(&mut self,
1346                              param_env: ty::ParamEnv<'tcx>,
1347                              cache_fresh_trait_pred: &ty::PolyTraitPredicate<'tcx>)
1348                              -> Option<SelectionResult<'tcx, SelectionCandidate<'tcx>>>
1349     {
1350         let tcx = self.tcx();
1351         let trait_ref = &cache_fresh_trait_pred.skip_binder().trait_ref;
1352         if self.can_use_global_caches(param_env) {
1353             let cache = tcx.selection_cache.hashmap.borrow();
1354             if let Some(cached) = cache.get(&trait_ref) {
1355                 return Some(cached.get(tcx));
1356             }
1357         }
1358         self.infcx.selection_cache.hashmap
1359                                   .borrow()
1360                                   .get(trait_ref)
1361                                   .map(|v| v.get(tcx))
1362     }
1363
1364     fn insert_candidate_cache(&mut self,
1365                               param_env: ty::ParamEnv<'tcx>,
1366                               cache_fresh_trait_pred: ty::PolyTraitPredicate<'tcx>,
1367                               dep_node: DepNodeIndex,
1368                               candidate: SelectionResult<'tcx, SelectionCandidate<'tcx>>)
1369     {
1370         let tcx = self.tcx();
1371         let trait_ref = cache_fresh_trait_pred.skip_binder().trait_ref;
1372         if self.can_use_global_caches(param_env) {
1373             if let Some(trait_ref) = tcx.lift_to_global(&trait_ref) {
1374                 if let Some(candidate) = tcx.lift_to_global(&candidate) {
1375                     debug!(
1376                         "insert_candidate_cache(trait_ref={:?}, candidate={:?}) global",
1377                         trait_ref,
1378                         candidate,
1379                     );
1380                     // This may overwrite the cache with the same value
1381                     tcx.selection_cache
1382                        .hashmap.borrow_mut()
1383                        .insert(trait_ref, WithDepNode::new(dep_node, candidate));
1384                     return;
1385                 }
1386             }
1387         }
1388
1389         debug!(
1390             "insert_candidate_cache(trait_ref={:?}, candidate={:?}) local",
1391             trait_ref,
1392             candidate,
1393         );
1394         self.infcx.selection_cache.hashmap
1395                                   .borrow_mut()
1396                                   .insert(trait_ref, WithDepNode::new(dep_node, candidate));
1397     }
1398
1399     fn assemble_candidates<'o>(&mut self,
1400                                stack: &TraitObligationStack<'o, 'tcx>)
1401                                -> Result<SelectionCandidateSet<'tcx>, SelectionError<'tcx>>
1402     {
1403         let TraitObligationStack { obligation, .. } = *stack;
1404         let ref obligation = Obligation {
1405             param_env: obligation.param_env,
1406             cause: obligation.cause.clone(),
1407             recursion_depth: obligation.recursion_depth,
1408             predicate: self.infcx().resolve_type_vars_if_possible(&obligation.predicate)
1409         };
1410
1411         if obligation.predicate.skip_binder().self_ty().is_ty_var() {
1412             // Self is a type variable (e.g. `_: AsRef<str>`).
1413             //
1414             // This is somewhat problematic, as the current scheme can't really
1415             // handle it turning to be a projection. This does end up as truly
1416             // ambiguous in most cases anyway.
1417             //
1418             // Take the fast path out - this also improves
1419             // performance by preventing assemble_candidates_from_impls from
1420             // matching every impl for this trait.
1421             return Ok(SelectionCandidateSet { vec: vec![], ambiguous: true });
1422         }
1423
1424         let mut candidates = SelectionCandidateSet {
1425             vec: Vec::new(),
1426             ambiguous: false
1427         };
1428
1429         // Other bounds. Consider both in-scope bounds from fn decl
1430         // and applicable impls. There is a certain set of precedence rules here.
1431
1432         let def_id = obligation.predicate.def_id();
1433         let lang_items = self.tcx().lang_items();
1434         if lang_items.copy_trait() == Some(def_id) {
1435             debug!("obligation self ty is {:?}",
1436                    obligation.predicate.skip_binder().self_ty());
1437
1438             // User-defined copy impls are permitted, but only for
1439             // structs and enums.
1440             self.assemble_candidates_from_impls(obligation, &mut candidates)?;
1441
1442             // For other types, we'll use the builtin rules.
1443             let copy_conditions = self.copy_clone_conditions(obligation);
1444             self.assemble_builtin_bound_candidates(copy_conditions, &mut candidates)?;
1445         } else if lang_items.sized_trait() == Some(def_id) {
1446             // Sized is never implementable by end-users, it is
1447             // always automatically computed.
1448             let sized_conditions = self.sized_conditions(obligation);
1449             self.assemble_builtin_bound_candidates(sized_conditions,
1450                                                    &mut candidates)?;
1451         } else if lang_items.unsize_trait() == Some(def_id) {
1452             self.assemble_candidates_for_unsizing(obligation, &mut candidates);
1453         } else {
1454             if lang_items.clone_trait() == Some(def_id) {
1455                 // Same builtin conditions as `Copy`, i.e. every type which has builtin support
1456                 // for `Copy` also has builtin support for `Clone`, + tuples and arrays of `Clone`
1457                 // types have builtin support for `Clone`.
1458                 let clone_conditions = self.copy_clone_conditions(obligation);
1459                 self.assemble_builtin_bound_candidates(clone_conditions, &mut candidates)?;
1460             }
1461
1462             self.assemble_generator_candidates(obligation, &mut candidates)?;
1463             self.assemble_closure_candidates(obligation, &mut candidates)?;
1464             self.assemble_fn_pointer_candidates(obligation, &mut candidates)?;
1465             self.assemble_candidates_from_impls(obligation, &mut candidates)?;
1466             self.assemble_candidates_from_object_ty(obligation, &mut candidates);
1467         }
1468
1469         self.assemble_candidates_from_projected_tys(obligation, &mut candidates);
1470         self.assemble_candidates_from_caller_bounds(stack, &mut candidates)?;
1471         // Auto implementations have lower priority, so we only
1472         // consider triggering a default if there is no other impl that can apply.
1473         if candidates.vec.is_empty() {
1474             self.assemble_candidates_from_auto_impls(obligation, &mut candidates)?;
1475         }
1476         debug!("candidate list size: {}", candidates.vec.len());
1477         Ok(candidates)
1478     }
1479
1480     fn assemble_candidates_from_projected_tys(&mut self,
1481                                               obligation: &TraitObligation<'tcx>,
1482                                               candidates: &mut SelectionCandidateSet<'tcx>)
1483     {
1484         debug!("assemble_candidates_for_projected_tys({:?})", obligation);
1485
1486         // before we go into the whole skolemization thing, just
1487         // quickly check if the self-type is a projection at all.
1488         match obligation.predicate.skip_binder().trait_ref.self_ty().sty {
1489             ty::TyProjection(_) | ty::TyAnon(..) => {}
1490             ty::TyInfer(ty::TyVar(_)) => {
1491                 span_bug!(obligation.cause.span,
1492                     "Self=_ should have been handled by assemble_candidates");
1493             }
1494             _ => return
1495         }
1496
1497         let result = self.probe(|this, snapshot| {
1498             this.match_projection_obligation_against_definition_bounds(obligation,
1499                                                                        snapshot)
1500         });
1501
1502         if result {
1503             candidates.vec.push(ProjectionCandidate);
1504         }
1505     }
1506
1507     fn match_projection_obligation_against_definition_bounds(
1508         &mut self,
1509         obligation: &TraitObligation<'tcx>,
1510         snapshot: &infer::CombinedSnapshot<'cx, 'tcx>)
1511         -> bool
1512     {
1513         let poly_trait_predicate =
1514             self.infcx().resolve_type_vars_if_possible(&obligation.predicate);
1515         let (skol_trait_predicate, skol_map) =
1516             self.infcx().skolemize_late_bound_regions(&poly_trait_predicate);
1517         debug!("match_projection_obligation_against_definition_bounds: \
1518                 skol_trait_predicate={:?} skol_map={:?}",
1519                skol_trait_predicate,
1520                skol_map);
1521
1522         let (def_id, substs) = match skol_trait_predicate.trait_ref.self_ty().sty {
1523             ty::TyProjection(ref data) =>
1524                 (data.trait_ref(self.tcx()).def_id, data.substs),
1525             ty::TyAnon(def_id, substs) => (def_id, substs),
1526             _ => {
1527                 span_bug!(
1528                     obligation.cause.span,
1529                     "match_projection_obligation_against_definition_bounds() called \
1530                      but self-ty not a projection: {:?}",
1531                     skol_trait_predicate.trait_ref.self_ty());
1532             }
1533         };
1534         debug!("match_projection_obligation_against_definition_bounds: \
1535                 def_id={:?}, substs={:?}",
1536                def_id, substs);
1537
1538         let predicates_of = self.tcx().predicates_of(def_id);
1539         let bounds = predicates_of.instantiate(self.tcx(), substs);
1540         debug!("match_projection_obligation_against_definition_bounds: \
1541                 bounds={:?}",
1542                bounds);
1543
1544         let matching_bound =
1545             util::elaborate_predicates(self.tcx(), bounds.predicates)
1546             .filter_to_traits()
1547             .find(
1548                 |bound| self.probe(
1549                     |this, _| this.match_projection(obligation,
1550                                                     bound.clone(),
1551                                                     skol_trait_predicate.trait_ref.clone(),
1552                                                     &skol_map,
1553                                                     snapshot)));
1554
1555         debug!("match_projection_obligation_against_definition_bounds: \
1556                 matching_bound={:?}",
1557                matching_bound);
1558         match matching_bound {
1559             None => false,
1560             Some(bound) => {
1561                 // Repeat the successful match, if any, this time outside of a probe.
1562                 let result = self.match_projection(obligation,
1563                                                    bound,
1564                                                    skol_trait_predicate.trait_ref.clone(),
1565                                                    &skol_map,
1566                                                    snapshot);
1567
1568                 self.infcx.pop_skolemized(skol_map, snapshot);
1569
1570                 assert!(result);
1571                 true
1572             }
1573         }
1574     }
1575
1576     fn match_projection(&mut self,
1577                         obligation: &TraitObligation<'tcx>,
1578                         trait_bound: ty::PolyTraitRef<'tcx>,
1579                         skol_trait_ref: ty::TraitRef<'tcx>,
1580                         skol_map: &infer::SkolemizationMap<'tcx>,
1581                         snapshot: &infer::CombinedSnapshot<'cx, 'tcx>)
1582                         -> bool
1583     {
1584         assert!(!skol_trait_ref.has_escaping_regions());
1585         if let Err(_) = self.infcx.at(&obligation.cause, obligation.param_env)
1586                                   .sup(ty::Binder::dummy(skol_trait_ref), trait_bound) {
1587             return false;
1588         }
1589
1590         self.infcx.leak_check(false, obligation.cause.span, skol_map, snapshot).is_ok()
1591     }
1592
1593     /// Given an obligation like `<SomeTrait for T>`, search the obligations that the caller
1594     /// supplied to find out whether it is listed among them.
1595     ///
1596     /// Never affects inference environment.
1597     fn assemble_candidates_from_caller_bounds<'o>(&mut self,
1598                                                   stack: &TraitObligationStack<'o, 'tcx>,
1599                                                   candidates: &mut SelectionCandidateSet<'tcx>)
1600                                                   -> Result<(),SelectionError<'tcx>>
1601     {
1602         debug!("assemble_candidates_from_caller_bounds({:?})",
1603                stack.obligation);
1604
1605         let all_bounds =
1606             stack.obligation.param_env.caller_bounds
1607                                       .iter()
1608                                       .filter_map(|o| o.to_opt_poly_trait_ref());
1609
1610         // micro-optimization: filter out predicates relating to different
1611         // traits.
1612         let matching_bounds =
1613             all_bounds.filter(|p| p.def_id() == stack.obligation.predicate.def_id());
1614
1615         // keep only those bounds which may apply, and propagate overflow if it occurs
1616         let mut param_candidates = vec![];
1617         for bound in matching_bounds {
1618             let wc = self.evaluate_where_clause(stack, bound.clone())?;
1619             if wc.may_apply() {
1620                 param_candidates.push(ParamCandidate(bound));
1621             }
1622         }
1623
1624         candidates.vec.extend(param_candidates);
1625
1626         Ok(())
1627     }
1628
1629     fn evaluate_where_clause<'o>(&mut self,
1630                                  stack: &TraitObligationStack<'o, 'tcx>,
1631                                  where_clause_trait_ref: ty::PolyTraitRef<'tcx>)
1632                                  -> Result<EvaluationResult, OverflowError>
1633     {
1634         self.probe(move |this, _| {
1635             match this.match_where_clause_trait_ref(stack.obligation, where_clause_trait_ref) {
1636                 Ok(obligations) => {
1637                     this.evaluate_predicates_recursively(stack.list(), obligations.iter())
1638                 }
1639                 Err(()) => Ok(EvaluatedToErr)
1640             }
1641         })
1642     }
1643
1644     fn assemble_generator_candidates(&mut self,
1645                                    obligation: &TraitObligation<'tcx>,
1646                                    candidates: &mut SelectionCandidateSet<'tcx>)
1647                                    -> Result<(),SelectionError<'tcx>>
1648     {
1649         if self.tcx().lang_items().gen_trait() != Some(obligation.predicate.def_id()) {
1650             return Ok(());
1651         }
1652
1653         // ok to skip binder because the substs on generator types never
1654         // touch bound regions, they just capture the in-scope
1655         // type/region parameters
1656         let self_ty = *obligation.self_ty().skip_binder();
1657         match self_ty.sty {
1658             ty::TyGenerator(..) => {
1659                 debug!("assemble_generator_candidates: self_ty={:?} obligation={:?}",
1660                        self_ty,
1661                        obligation);
1662
1663                 candidates.vec.push(GeneratorCandidate);
1664                 Ok(())
1665             }
1666             ty::TyInfer(ty::TyVar(_)) => {
1667                 debug!("assemble_generator_candidates: ambiguous self-type");
1668                 candidates.ambiguous = true;
1669                 return Ok(());
1670             }
1671             _ => { return Ok(()); }
1672         }
1673     }
1674
1675     /// Check for the artificial impl that the compiler will create for an obligation like `X :
1676     /// FnMut<..>` where `X` is a closure type.
1677     ///
1678     /// Note: the type parameters on a closure candidate are modeled as *output* type
1679     /// parameters and hence do not affect whether this trait is a match or not. They will be
1680     /// unified during the confirmation step.
1681     fn assemble_closure_candidates(&mut self,
1682                                    obligation: &TraitObligation<'tcx>,
1683                                    candidates: &mut SelectionCandidateSet<'tcx>)
1684                                    -> Result<(),SelectionError<'tcx>>
1685     {
1686         let kind = match self.tcx().lang_items().fn_trait_kind(obligation.predicate.def_id()) {
1687             Some(k) => k,
1688             None => { return Ok(()); }
1689         };
1690
1691         // ok to skip binder because the substs on closure types never
1692         // touch bound regions, they just capture the in-scope
1693         // type/region parameters
1694         match obligation.self_ty().skip_binder().sty {
1695             ty::TyClosure(closure_def_id, closure_substs) => {
1696                 debug!("assemble_unboxed_candidates: kind={:?} obligation={:?}",
1697                        kind, obligation);
1698                 match self.infcx.closure_kind(closure_def_id, closure_substs) {
1699                     Some(closure_kind) => {
1700                         debug!("assemble_unboxed_candidates: closure_kind = {:?}", closure_kind);
1701                         if closure_kind.extends(kind) {
1702                             candidates.vec.push(ClosureCandidate);
1703                         }
1704                     }
1705                     None => {
1706                         debug!("assemble_unboxed_candidates: closure_kind not yet known");
1707                         candidates.vec.push(ClosureCandidate);
1708                     }
1709                 };
1710                 Ok(())
1711             }
1712             ty::TyInfer(ty::TyVar(_)) => {
1713                 debug!("assemble_unboxed_closure_candidates: ambiguous self-type");
1714                 candidates.ambiguous = true;
1715                 return Ok(());
1716             }
1717             _ => { return Ok(()); }
1718         }
1719     }
1720
1721     /// Implement one of the `Fn()` family for a fn pointer.
1722     fn assemble_fn_pointer_candidates(&mut self,
1723                                       obligation: &TraitObligation<'tcx>,
1724                                       candidates: &mut SelectionCandidateSet<'tcx>)
1725                                       -> Result<(),SelectionError<'tcx>>
1726     {
1727         // We provide impl of all fn traits for fn pointers.
1728         if self.tcx().lang_items().fn_trait_kind(obligation.predicate.def_id()).is_none() {
1729             return Ok(());
1730         }
1731
1732         // ok to skip binder because what we are inspecting doesn't involve bound regions
1733         let self_ty = *obligation.self_ty().skip_binder();
1734         match self_ty.sty {
1735             ty::TyInfer(ty::TyVar(_)) => {
1736                 debug!("assemble_fn_pointer_candidates: ambiguous self-type");
1737                 candidates.ambiguous = true; // could wind up being a fn() type
1738             }
1739
1740             // provide an impl, but only for suitable `fn` pointers
1741             ty::TyFnDef(..) | ty::TyFnPtr(_) => {
1742                 if let ty::FnSig {
1743                     unsafety: hir::Unsafety::Normal,
1744                     abi: Abi::Rust,
1745                     variadic: false,
1746                     ..
1747                 } = self_ty.fn_sig(self.tcx()).skip_binder() {
1748                     candidates.vec.push(FnPointerCandidate);
1749                 }
1750             }
1751
1752             _ => { }
1753         }
1754
1755         Ok(())
1756     }
1757
1758     /// Search for impls that might apply to `obligation`.
1759     fn assemble_candidates_from_impls(&mut self,
1760                                       obligation: &TraitObligation<'tcx>,
1761                                       candidates: &mut SelectionCandidateSet<'tcx>)
1762                                       -> Result<(), SelectionError<'tcx>>
1763     {
1764         debug!("assemble_candidates_from_impls(obligation={:?})", obligation);
1765
1766         self.tcx().for_each_relevant_impl(
1767             obligation.predicate.def_id(),
1768             obligation.predicate.skip_binder().trait_ref.self_ty(),
1769             |impl_def_id| {
1770                 self.probe(|this, snapshot| { /* [1] */
1771                     match this.match_impl(impl_def_id, obligation, snapshot) {
1772                         Ok(skol_map) => {
1773                             candidates.vec.push(ImplCandidate(impl_def_id));
1774
1775                             // NB: we can safely drop the skol map
1776                             // since we are in a probe [1]
1777                             mem::drop(skol_map);
1778                         }
1779                         Err(_) => { }
1780                     }
1781                 });
1782             }
1783         );
1784
1785         Ok(())
1786     }
1787
1788     fn assemble_candidates_from_auto_impls(&mut self,
1789                                               obligation: &TraitObligation<'tcx>,
1790                                               candidates: &mut SelectionCandidateSet<'tcx>)
1791                                               -> Result<(), SelectionError<'tcx>>
1792     {
1793         // OK to skip binder here because the tests we do below do not involve bound regions
1794         let self_ty = *obligation.self_ty().skip_binder();
1795         debug!("assemble_candidates_from_auto_impls(self_ty={:?})", self_ty);
1796
1797         let def_id = obligation.predicate.def_id();
1798
1799         if self.tcx().trait_is_auto(def_id) {
1800             match self_ty.sty {
1801                 ty::TyDynamic(..) => {
1802                     // For object types, we don't know what the closed
1803                     // over types are. This means we conservatively
1804                     // say nothing; a candidate may be added by
1805                     // `assemble_candidates_from_object_ty`.
1806                 }
1807                 ty::TyForeign(..) => {
1808                     // Since the contents of foreign types is unknown,
1809                     // we don't add any `..` impl. Default traits could
1810                     // still be provided by a manual implementation for
1811                     // this trait and type.
1812                 }
1813                 ty::TyParam(..) |
1814                 ty::TyProjection(..) => {
1815                     // In these cases, we don't know what the actual
1816                     // type is.  Therefore, we cannot break it down
1817                     // into its constituent types. So we don't
1818                     // consider the `..` impl but instead just add no
1819                     // candidates: this means that typeck will only
1820                     // succeed if there is another reason to believe
1821                     // that this obligation holds. That could be a
1822                     // where-clause or, in the case of an object type,
1823                     // it could be that the object type lists the
1824                     // trait (e.g. `Foo+Send : Send`). See
1825                     // `compile-fail/typeck-default-trait-impl-send-param.rs`
1826                     // for an example of a test case that exercises
1827                     // this path.
1828                 }
1829                 ty::TyInfer(ty::TyVar(_)) => {
1830                     // the auto impl might apply, we don't know
1831                     candidates.ambiguous = true;
1832                 }
1833                 _ => {
1834                     candidates.vec.push(AutoImplCandidate(def_id.clone()))
1835                 }
1836             }
1837         }
1838
1839         Ok(())
1840     }
1841
1842     /// Search for impls that might apply to `obligation`.
1843     fn assemble_candidates_from_object_ty(&mut self,
1844                                           obligation: &TraitObligation<'tcx>,
1845                                           candidates: &mut SelectionCandidateSet<'tcx>)
1846     {
1847         debug!("assemble_candidates_from_object_ty(self_ty={:?})",
1848                obligation.self_ty().skip_binder());
1849
1850         // Object-safety candidates are only applicable to object-safe
1851         // traits. Including this check is useful because it helps
1852         // inference in cases of traits like `BorrowFrom`, which are
1853         // not object-safe, and which rely on being able to infer the
1854         // self-type from one of the other inputs. Without this check,
1855         // these cases wind up being considered ambiguous due to a
1856         // (spurious) ambiguity introduced here.
1857         let predicate_trait_ref = obligation.predicate.to_poly_trait_ref();
1858         if !self.tcx().is_object_safe(predicate_trait_ref.def_id()) {
1859             return;
1860         }
1861
1862         self.probe(|this, _snapshot| {
1863             // the code below doesn't care about regions, and the
1864             // self-ty here doesn't escape this probe, so just erase
1865             // any LBR.
1866             let self_ty = this.tcx().erase_late_bound_regions(&obligation.self_ty());
1867             let poly_trait_ref = match self_ty.sty {
1868                 ty::TyDynamic(ref data, ..) => {
1869                     if data.auto_traits().any(|did| did == obligation.predicate.def_id()) {
1870                         debug!("assemble_candidates_from_object_ty: matched builtin bound, \
1871                                     pushing candidate");
1872                         candidates.vec.push(BuiltinObjectCandidate);
1873                         return;
1874                     }
1875
1876                     match data.principal() {
1877                         Some(p) => p.with_self_ty(this.tcx(), self_ty),
1878                         None => return,
1879                     }
1880                 }
1881                 ty::TyInfer(ty::TyVar(_)) => {
1882                     debug!("assemble_candidates_from_object_ty: ambiguous");
1883                     candidates.ambiguous = true; // could wind up being an object type
1884                     return;
1885                 }
1886                 _ => {
1887                     return;
1888                 }
1889             };
1890
1891             debug!("assemble_candidates_from_object_ty: poly_trait_ref={:?}",
1892                    poly_trait_ref);
1893
1894             // Count only those upcast versions that match the trait-ref
1895             // we are looking for. Specifically, do not only check for the
1896             // correct trait, but also the correct type parameters.
1897             // For example, we may be trying to upcast `Foo` to `Bar<i32>`,
1898             // but `Foo` is declared as `trait Foo : Bar<u32>`.
1899             let upcast_trait_refs =
1900                 util::supertraits(this.tcx(), poly_trait_ref)
1901                 .filter(|upcast_trait_ref| {
1902                     this.probe(|this, _| {
1903                         let upcast_trait_ref = upcast_trait_ref.clone();
1904                         this.match_poly_trait_ref(obligation, upcast_trait_ref).is_ok()
1905                     })
1906                 })
1907                 .count();
1908
1909             if upcast_trait_refs > 1 {
1910                 // can be upcast in many ways; need more type information
1911                 candidates.ambiguous = true;
1912             } else if upcast_trait_refs == 1 {
1913                 candidates.vec.push(ObjectCandidate);
1914             }
1915         })
1916     }
1917
1918     /// Search for unsizing that might apply to `obligation`.
1919     fn assemble_candidates_for_unsizing(&mut self,
1920                                         obligation: &TraitObligation<'tcx>,
1921                                         candidates: &mut SelectionCandidateSet<'tcx>) {
1922         // We currently never consider higher-ranked obligations e.g.
1923         // `for<'a> &'a T: Unsize<Trait+'a>` to be implemented. This is not
1924         // because they are a priori invalid, and we could potentially add support
1925         // for them later, it's just that there isn't really a strong need for it.
1926         // A `T: Unsize<U>` obligation is always used as part of a `T: CoerceUnsize<U>`
1927         // impl, and those are generally applied to concrete types.
1928         //
1929         // That said, one might try to write a fn with a where clause like
1930         //     for<'a> Foo<'a, T>: Unsize<Foo<'a, Trait>>
1931         // where the `'a` is kind of orthogonal to the relevant part of the `Unsize`.
1932         // Still, you'd be more likely to write that where clause as
1933         //     T: Trait
1934         // so it seems ok if we (conservatively) fail to accept that `Unsize`
1935         // obligation above. Should be possible to extend this in the future.
1936         let source = match obligation.self_ty().no_late_bound_regions() {
1937             Some(t) => t,
1938             None => {
1939                 // Don't add any candidates if there are bound regions.
1940                 return;
1941             }
1942         };
1943         let target = obligation.predicate.skip_binder().trait_ref.substs.type_at(1);
1944
1945         debug!("assemble_candidates_for_unsizing(source={:?}, target={:?})",
1946                source, target);
1947
1948         let may_apply = match (&source.sty, &target.sty) {
1949             // Trait+Kx+'a -> Trait+Ky+'b (upcasts).
1950             (&ty::TyDynamic(ref data_a, ..), &ty::TyDynamic(ref data_b, ..)) => {
1951                 // Upcasts permit two things:
1952                 //
1953                 // 1. Dropping builtin bounds, e.g. `Foo+Send` to `Foo`
1954                 // 2. Tightening the region bound, e.g. `Foo+'a` to `Foo+'b` if `'a : 'b`
1955                 //
1956                 // Note that neither of these changes requires any
1957                 // change at runtime.  Eventually this will be
1958                 // generalized.
1959                 //
1960                 // We always upcast when we can because of reason
1961                 // #2 (region bounds).
1962                 match (data_a.principal(), data_b.principal()) {
1963                     (Some(a), Some(b)) => a.def_id() == b.def_id() &&
1964                         data_b.auto_traits()
1965                             // All of a's auto traits need to be in b's auto traits.
1966                             .all(|b| data_a.auto_traits().any(|a| a == b)),
1967                     _ => false
1968                 }
1969             }
1970
1971             // T -> Trait.
1972             (_, &ty::TyDynamic(..)) => true,
1973
1974             // Ambiguous handling is below T -> Trait, because inference
1975             // variables can still implement Unsize<Trait> and nested
1976             // obligations will have the final say (likely deferred).
1977             (&ty::TyInfer(ty::TyVar(_)), _) |
1978             (_, &ty::TyInfer(ty::TyVar(_))) => {
1979                 debug!("assemble_candidates_for_unsizing: ambiguous");
1980                 candidates.ambiguous = true;
1981                 false
1982             }
1983
1984             // [T; n] -> [T].
1985             (&ty::TyArray(..), &ty::TySlice(_)) => true,
1986
1987             // Struct<T> -> Struct<U>.
1988             (&ty::TyAdt(def_id_a, _), &ty::TyAdt(def_id_b, _)) if def_id_a.is_struct() => {
1989                 def_id_a == def_id_b
1990             }
1991
1992             // (.., T) -> (.., U).
1993             (&ty::TyTuple(tys_a), &ty::TyTuple(tys_b)) => {
1994                 tys_a.len() == tys_b.len()
1995             }
1996
1997             _ => false
1998         };
1999
2000         if may_apply {
2001             candidates.vec.push(BuiltinUnsizeCandidate);
2002         }
2003     }
2004
2005     ///////////////////////////////////////////////////////////////////////////
2006     // WINNOW
2007     //
2008     // Winnowing is the process of attempting to resolve ambiguity by
2009     // probing further. During the winnowing process, we unify all
2010     // type variables (ignoring skolemization) and then we also
2011     // attempt to evaluate recursive bounds to see if they are
2012     // satisfied.
2013
2014     /// Returns true if `candidate_i` should be dropped in favor of
2015     /// `candidate_j`.  Generally speaking we will drop duplicate
2016     /// candidates and prefer where-clause candidates.
2017     /// Returns true if `victim` should be dropped in favor of
2018     /// `other`.  Generally speaking we will drop duplicate
2019     /// candidates and prefer where-clause candidates.
2020     ///
2021     /// See the comment for "SelectionCandidate" for more details.
2022     fn candidate_should_be_dropped_in_favor_of<'o>(
2023         &mut self,
2024         victim: &EvaluatedCandidate<'tcx>,
2025         other: &EvaluatedCandidate<'tcx>)
2026         -> bool
2027     {
2028         if victim.candidate == other.candidate {
2029             return true;
2030         }
2031
2032         match other.candidate {
2033             ObjectCandidate |
2034             ParamCandidate(_) | ProjectionCandidate => match victim.candidate {
2035                 AutoImplCandidate(..) => {
2036                     bug!(
2037                         "default implementations shouldn't be recorded \
2038                          when there are other valid candidates");
2039                 }
2040                 ImplCandidate(..) |
2041                 ClosureCandidate |
2042                 GeneratorCandidate |
2043                 FnPointerCandidate |
2044                 BuiltinObjectCandidate |
2045                 BuiltinUnsizeCandidate |
2046                 BuiltinCandidate { .. } => {
2047                     // We have a where-clause so don't go around looking
2048                     // for impls.
2049                     true
2050                 }
2051                 ObjectCandidate |
2052                 ProjectionCandidate => {
2053                     // Arbitrarily give param candidates priority
2054                     // over projection and object candidates.
2055                     true
2056                 },
2057                 ParamCandidate(..) => false,
2058             },
2059             ImplCandidate(other_def) => {
2060                 // See if we can toss out `victim` based on specialization.
2061                 // This requires us to know *for sure* that the `other` impl applies
2062                 // i.e. EvaluatedToOk:
2063                 if other.evaluation == EvaluatedToOk {
2064                     if let ImplCandidate(victim_def) = victim.candidate {
2065                         let tcx = self.tcx().global_tcx();
2066                         return tcx.specializes((other_def, victim_def)) ||
2067                             tcx.impls_are_allowed_to_overlap(other_def, victim_def);
2068                     }
2069                 }
2070
2071                 false
2072             },
2073             _ => false
2074         }
2075     }
2076
2077     ///////////////////////////////////////////////////////////////////////////
2078     // BUILTIN BOUNDS
2079     //
2080     // These cover the traits that are built-in to the language
2081     // itself: `Copy`, `Clone` and `Sized`.
2082
2083     fn assemble_builtin_bound_candidates<'o>(&mut self,
2084                                              conditions: BuiltinImplConditions<'tcx>,
2085                                              candidates: &mut SelectionCandidateSet<'tcx>)
2086                                              -> Result<(),SelectionError<'tcx>>
2087     {
2088         match conditions {
2089             BuiltinImplConditions::Where(nested) => {
2090                 debug!("builtin_bound: nested={:?}", nested);
2091                 candidates.vec.push(BuiltinCandidate {
2092                     has_nested: nested.skip_binder().len() > 0
2093                 });
2094                 Ok(())
2095             }
2096             BuiltinImplConditions::None => { Ok(()) }
2097             BuiltinImplConditions::Ambiguous => {
2098                 debug!("assemble_builtin_bound_candidates: ambiguous builtin");
2099                 Ok(candidates.ambiguous = true)
2100             }
2101         }
2102     }
2103
2104     fn sized_conditions(&mut self, obligation: &TraitObligation<'tcx>)
2105                      -> BuiltinImplConditions<'tcx>
2106     {
2107         use self::BuiltinImplConditions::{Ambiguous, None, Where};
2108
2109         // NOTE: binder moved to (*)
2110         let self_ty = self.infcx.shallow_resolve(
2111             obligation.predicate.skip_binder().self_ty());
2112
2113         match self_ty.sty {
2114             ty::TyInfer(ty::IntVar(_)) | ty::TyInfer(ty::FloatVar(_)) |
2115             ty::TyUint(_) | ty::TyInt(_) | ty::TyBool | ty::TyFloat(_) |
2116             ty::TyFnDef(..) | ty::TyFnPtr(_) | ty::TyRawPtr(..) |
2117             ty::TyChar | ty::TyRef(..) | ty::TyGenerator(..) |
2118             ty::TyGeneratorWitness(..) | ty::TyArray(..) | ty::TyClosure(..) |
2119             ty::TyNever | ty::TyError => {
2120                 // safe for everything
2121                 Where(ty::Binder::dummy(Vec::new()))
2122             }
2123
2124             ty::TyStr | ty::TySlice(_) | ty::TyDynamic(..) | ty::TyForeign(..) => None,
2125
2126             ty::TyTuple(tys) => {
2127                 Where(ty::Binder::bind(tys.last().into_iter().cloned().collect()))
2128             }
2129
2130             ty::TyAdt(def, substs) => {
2131                 let sized_crit = def.sized_constraint(self.tcx());
2132                 // (*) binder moved here
2133                 Where(ty::Binder::bind(
2134                     sized_crit.iter().map(|ty| ty.subst(self.tcx(), substs)).collect()
2135                 ))
2136             }
2137
2138             ty::TyProjection(_) | ty::TyParam(_) | ty::TyAnon(..) => None,
2139             ty::TyInfer(ty::TyVar(_)) => Ambiguous,
2140
2141             ty::TyInfer(ty::CanonicalTy(_)) |
2142             ty::TyInfer(ty::FreshTy(_)) |
2143             ty::TyInfer(ty::FreshIntTy(_)) |
2144             ty::TyInfer(ty::FreshFloatTy(_)) => {
2145                 bug!("asked to assemble builtin bounds of unexpected type: {:?}",
2146                      self_ty);
2147             }
2148         }
2149     }
2150
2151     fn copy_clone_conditions(&mut self, obligation: &TraitObligation<'tcx>)
2152                      -> BuiltinImplConditions<'tcx>
2153     {
2154         // NOTE: binder moved to (*)
2155         let self_ty = self.infcx.shallow_resolve(
2156             obligation.predicate.skip_binder().self_ty());
2157
2158         use self::BuiltinImplConditions::{Ambiguous, None, Where};
2159
2160         match self_ty.sty {
2161             ty::TyInfer(ty::IntVar(_)) | ty::TyInfer(ty::FloatVar(_)) |
2162             ty::TyFnDef(..) | ty::TyFnPtr(_) | ty::TyError => {
2163                 Where(ty::Binder::dummy(Vec::new()))
2164             }
2165
2166             ty::TyUint(_) | ty::TyInt(_) | ty::TyBool | ty::TyFloat(_) |
2167             ty::TyChar | ty::TyRawPtr(..) | ty::TyNever |
2168             ty::TyRef(_, _, hir::MutImmutable) => {
2169                 // Implementations provided in libcore
2170                 None
2171             }
2172
2173             ty::TyDynamic(..) | ty::TyStr | ty::TySlice(..) |
2174             ty::TyGenerator(..) | ty::TyGeneratorWitness(..) | ty::TyForeign(..) |
2175             ty::TyRef(_, _, hir::MutMutable) => {
2176                 None
2177             }
2178
2179             ty::TyArray(element_ty, _) => {
2180                 // (*) binder moved here
2181                 Where(ty::Binder::bind(vec![element_ty]))
2182             }
2183
2184             ty::TyTuple(tys) => {
2185                 // (*) binder moved here
2186                 Where(ty::Binder::bind(tys.to_vec()))
2187             }
2188
2189             ty::TyClosure(def_id, substs) => {
2190                 let trait_id = obligation.predicate.def_id();
2191                 let is_copy_trait = Some(trait_id) == self.tcx().lang_items().copy_trait();
2192                 let is_clone_trait = Some(trait_id) == self.tcx().lang_items().clone_trait();
2193                 if is_copy_trait || is_clone_trait {
2194                     Where(ty::Binder::bind(substs.upvar_tys(def_id, self.tcx()).collect()))
2195                 } else {
2196                     None
2197                 }
2198             }
2199
2200             ty::TyAdt(..) | ty::TyProjection(..) | ty::TyParam(..) | ty::TyAnon(..) => {
2201                 // Fallback to whatever user-defined impls exist in this case.
2202                 None
2203             }
2204
2205             ty::TyInfer(ty::TyVar(_)) => {
2206                 // Unbound type variable. Might or might not have
2207                 // applicable impls and so forth, depending on what
2208                 // those type variables wind up being bound to.
2209                 Ambiguous
2210             }
2211
2212             ty::TyInfer(ty::CanonicalTy(_)) |
2213             ty::TyInfer(ty::FreshTy(_)) |
2214             ty::TyInfer(ty::FreshIntTy(_)) |
2215             ty::TyInfer(ty::FreshFloatTy(_)) => {
2216                 bug!("asked to assemble builtin bounds of unexpected type: {:?}",
2217                      self_ty);
2218             }
2219         }
2220     }
2221
2222     /// For default impls, we need to break apart a type into its
2223     /// "constituent types" -- meaning, the types that it contains.
2224     ///
2225     /// Here are some (simple) examples:
2226     ///
2227     /// ```
2228     /// (i32, u32) -> [i32, u32]
2229     /// Foo where struct Foo { x: i32, y: u32 } -> [i32, u32]
2230     /// Bar<i32> where struct Bar<T> { x: T, y: u32 } -> [i32, u32]
2231     /// Zed<i32> where enum Zed { A(T), B(u32) } -> [i32, u32]
2232     /// ```
2233     fn constituent_types_for_ty(&self, t: Ty<'tcx>) -> Vec<Ty<'tcx>> {
2234         match t.sty {
2235             ty::TyUint(_) |
2236             ty::TyInt(_) |
2237             ty::TyBool |
2238             ty::TyFloat(_) |
2239             ty::TyFnDef(..) |
2240             ty::TyFnPtr(_) |
2241             ty::TyStr |
2242             ty::TyError |
2243             ty::TyInfer(ty::IntVar(_)) |
2244             ty::TyInfer(ty::FloatVar(_)) |
2245             ty::TyNever |
2246             ty::TyChar => {
2247                 Vec::new()
2248             }
2249
2250             ty::TyDynamic(..) |
2251             ty::TyParam(..) |
2252             ty::TyForeign(..) |
2253             ty::TyProjection(..) |
2254             ty::TyInfer(ty::CanonicalTy(_)) |
2255             ty::TyInfer(ty::TyVar(_)) |
2256             ty::TyInfer(ty::FreshTy(_)) |
2257             ty::TyInfer(ty::FreshIntTy(_)) |
2258             ty::TyInfer(ty::FreshFloatTy(_)) => {
2259                 bug!("asked to assemble constituent types of unexpected type: {:?}",
2260                      t);
2261             }
2262
2263             ty::TyRawPtr(ty::TypeAndMut { ty: element_ty, ..}) |
2264             ty::TyRef(_, element_ty, _) => {
2265                 vec![element_ty]
2266             },
2267
2268             ty::TyArray(element_ty, _) | ty::TySlice(element_ty) => {
2269                 vec![element_ty]
2270             }
2271
2272             ty::TyTuple(ref tys) => {
2273                 // (T1, ..., Tn) -- meets any bound that all of T1...Tn meet
2274                 tys.to_vec()
2275             }
2276
2277             ty::TyClosure(def_id, ref substs) => {
2278                 substs.upvar_tys(def_id, self.tcx()).collect()
2279             }
2280
2281             ty::TyGenerator(def_id, ref substs, _) => {
2282                 let witness = substs.witness(def_id, self.tcx());
2283                 substs.upvar_tys(def_id, self.tcx()).chain(iter::once(witness)).collect()
2284             }
2285
2286             ty::TyGeneratorWitness(types) => {
2287                 // This is sound because no regions in the witness can refer to
2288                 // the binder outside the witness. So we'll effectivly reuse
2289                 // the implicit binder around the witness.
2290                 types.skip_binder().to_vec()
2291             }
2292
2293             // for `PhantomData<T>`, we pass `T`
2294             ty::TyAdt(def, substs) if def.is_phantom_data() => {
2295                 substs.types().collect()
2296             }
2297
2298             ty::TyAdt(def, substs) => {
2299                 def.all_fields()
2300                     .map(|f| f.ty(self.tcx(), substs))
2301                     .collect()
2302             }
2303
2304             ty::TyAnon(def_id, substs) => {
2305                 // We can resolve the `impl Trait` to its concrete type,
2306                 // which enforces a DAG between the functions requiring
2307                 // the auto trait bounds in question.
2308                 vec![self.tcx().type_of(def_id).subst(self.tcx(), substs)]
2309             }
2310         }
2311     }
2312
2313     fn collect_predicates_for_types(&mut self,
2314                                     param_env: ty::ParamEnv<'tcx>,
2315                                     cause: ObligationCause<'tcx>,
2316                                     recursion_depth: usize,
2317                                     trait_def_id: DefId,
2318                                     types: ty::Binder<Vec<Ty<'tcx>>>)
2319                                     -> Vec<PredicateObligation<'tcx>>
2320     {
2321         // Because the types were potentially derived from
2322         // higher-ranked obligations they may reference late-bound
2323         // regions. For example, `for<'a> Foo<&'a int> : Copy` would
2324         // yield a type like `for<'a> &'a int`. In general, we
2325         // maintain the invariant that we never manipulate bound
2326         // regions, so we have to process these bound regions somehow.
2327         //
2328         // The strategy is to:
2329         //
2330         // 1. Instantiate those regions to skolemized regions (e.g.,
2331         //    `for<'a> &'a int` becomes `&0 int`.
2332         // 2. Produce something like `&'0 int : Copy`
2333         // 3. Re-bind the regions back to `for<'a> &'a int : Copy`
2334
2335         types.skip_binder().into_iter().flat_map(|ty| { // binder moved -\
2336             let ty: ty::Binder<Ty<'tcx>> = ty::Binder::bind(ty); // <----/
2337
2338             self.in_snapshot(|this, snapshot| {
2339                 let (skol_ty, skol_map) =
2340                     this.infcx().skolemize_late_bound_regions(&ty);
2341                 let Normalized { value: normalized_ty, mut obligations } =
2342                     project::normalize_with_depth(this,
2343                                                   param_env,
2344                                                   cause.clone(),
2345                                                   recursion_depth,
2346                                                   &skol_ty);
2347                 let skol_obligation =
2348                     this.tcx().predicate_for_trait_def(param_env,
2349                                                        cause.clone(),
2350                                                        trait_def_id,
2351                                                        recursion_depth,
2352                                                        normalized_ty,
2353                                                        &[]);
2354                 obligations.push(skol_obligation);
2355                 this.infcx().plug_leaks(skol_map, snapshot, obligations)
2356             })
2357         }).collect()
2358     }
2359
2360     ///////////////////////////////////////////////////////////////////////////
2361     // CONFIRMATION
2362     //
2363     // Confirmation unifies the output type parameters of the trait
2364     // with the values found in the obligation, possibly yielding a
2365     // type error.  See [rustc guide] for more details.
2366     //
2367     // [rustc guide]:
2368     // https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html#confirmation
2369
2370     fn confirm_candidate(&mut self,
2371                          obligation: &TraitObligation<'tcx>,
2372                          candidate: SelectionCandidate<'tcx>)
2373                          -> Result<Selection<'tcx>,SelectionError<'tcx>>
2374     {
2375         debug!("confirm_candidate({:?}, {:?})",
2376                obligation,
2377                candidate);
2378
2379         match candidate {
2380             BuiltinCandidate { has_nested } => {
2381                 let data = self.confirm_builtin_candidate(obligation, has_nested);
2382                 Ok(VtableBuiltin(data))
2383             }
2384
2385             ParamCandidate(param) => {
2386                 let obligations = self.confirm_param_candidate(obligation, param);
2387                 Ok(VtableParam(obligations))
2388             }
2389
2390             AutoImplCandidate(trait_def_id) => {
2391                 let data = self.confirm_auto_impl_candidate(obligation, trait_def_id);
2392                 Ok(VtableAutoImpl(data))
2393             }
2394
2395             ImplCandidate(impl_def_id) => {
2396                 Ok(VtableImpl(self.confirm_impl_candidate(obligation, impl_def_id)))
2397             }
2398
2399             ClosureCandidate => {
2400                 let vtable_closure = self.confirm_closure_candidate(obligation)?;
2401                 Ok(VtableClosure(vtable_closure))
2402             }
2403
2404             GeneratorCandidate => {
2405                 let vtable_generator = self.confirm_generator_candidate(obligation)?;
2406                 Ok(VtableGenerator(vtable_generator))
2407             }
2408
2409             BuiltinObjectCandidate => {
2410                 // This indicates something like `(Trait+Send) :
2411                 // Send`. In this case, we know that this holds
2412                 // because that's what the object type is telling us,
2413                 // and there's really no additional obligations to
2414                 // prove and no types in particular to unify etc.
2415                 Ok(VtableParam(Vec::new()))
2416             }
2417
2418             ObjectCandidate => {
2419                 let data = self.confirm_object_candidate(obligation);
2420                 Ok(VtableObject(data))
2421             }
2422
2423             FnPointerCandidate => {
2424                 let data =
2425                     self.confirm_fn_pointer_candidate(obligation)?;
2426                 Ok(VtableFnPointer(data))
2427             }
2428
2429             ProjectionCandidate => {
2430                 self.confirm_projection_candidate(obligation);
2431                 Ok(VtableParam(Vec::new()))
2432             }
2433
2434             BuiltinUnsizeCandidate => {
2435                 let data = self.confirm_builtin_unsize_candidate(obligation)?;
2436                 Ok(VtableBuiltin(data))
2437             }
2438         }
2439     }
2440
2441     fn confirm_projection_candidate(&mut self,
2442                                     obligation: &TraitObligation<'tcx>)
2443     {
2444         self.in_snapshot(|this, snapshot| {
2445             let result =
2446                 this.match_projection_obligation_against_definition_bounds(obligation,
2447                                                                            snapshot);
2448             assert!(result);
2449         })
2450     }
2451
2452     fn confirm_param_candidate(&mut self,
2453                                obligation: &TraitObligation<'tcx>,
2454                                param: ty::PolyTraitRef<'tcx>)
2455                                -> Vec<PredicateObligation<'tcx>>
2456     {
2457         debug!("confirm_param_candidate({:?},{:?})",
2458                obligation,
2459                param);
2460
2461         // During evaluation, we already checked that this
2462         // where-clause trait-ref could be unified with the obligation
2463         // trait-ref. Repeat that unification now without any
2464         // transactional boundary; it should not fail.
2465         match self.match_where_clause_trait_ref(obligation, param.clone()) {
2466             Ok(obligations) => obligations,
2467             Err(()) => {
2468                 bug!("Where clause `{:?}` was applicable to `{:?}` but now is not",
2469                      param,
2470                      obligation);
2471             }
2472         }
2473     }
2474
2475     fn confirm_builtin_candidate(&mut self,
2476                                  obligation: &TraitObligation<'tcx>,
2477                                  has_nested: bool)
2478                                  -> VtableBuiltinData<PredicateObligation<'tcx>>
2479     {
2480         debug!("confirm_builtin_candidate({:?}, {:?})",
2481                obligation, has_nested);
2482
2483         let lang_items = self.tcx().lang_items();
2484         let obligations = if has_nested {
2485             let trait_def = obligation.predicate.def_id();
2486             let conditions = match trait_def {
2487                 _ if Some(trait_def) == lang_items.sized_trait() => {
2488                     self.sized_conditions(obligation)
2489                 }
2490                 _ if Some(trait_def) == lang_items.copy_trait() => {
2491                     self.copy_clone_conditions(obligation)
2492                 }
2493                 _ if Some(trait_def) == lang_items.clone_trait() => {
2494                     self.copy_clone_conditions(obligation)
2495                 }
2496                 _ => bug!("unexpected builtin trait {:?}", trait_def)
2497             };
2498             let nested = match conditions {
2499                 BuiltinImplConditions::Where(nested) => nested,
2500                 _ => bug!("obligation {:?} had matched a builtin impl but now doesn't",
2501                           obligation)
2502             };
2503
2504             let cause = obligation.derived_cause(BuiltinDerivedObligation);
2505             self.collect_predicates_for_types(obligation.param_env,
2506                                               cause,
2507                                               obligation.recursion_depth+1,
2508                                               trait_def,
2509                                               nested)
2510         } else {
2511             vec![]
2512         };
2513
2514         debug!("confirm_builtin_candidate: obligations={:?}",
2515                obligations);
2516
2517         VtableBuiltinData { nested: obligations }
2518     }
2519
2520     /// This handles the case where a `auto trait Foo` impl is being used.
2521     /// The idea is that the impl applies to `X : Foo` if the following conditions are met:
2522     ///
2523     /// 1. For each constituent type `Y` in `X`, `Y : Foo` holds
2524     /// 2. For each where-clause `C` declared on `Foo`, `[Self => X] C` holds.
2525     fn confirm_auto_impl_candidate(&mut self,
2526                                    obligation: &TraitObligation<'tcx>,
2527                                    trait_def_id: DefId)
2528                                    -> VtableAutoImplData<PredicateObligation<'tcx>>
2529     {
2530         debug!("confirm_auto_impl_candidate({:?}, {:?})",
2531                obligation,
2532                trait_def_id);
2533
2534         let types = obligation.predicate.map_bound(|inner| {
2535             let self_ty = self.infcx.shallow_resolve(inner.self_ty());
2536             self.constituent_types_for_ty(self_ty)
2537         });
2538         self.vtable_auto_impl(obligation, trait_def_id, types)
2539     }
2540
2541     /// See `confirm_auto_impl_candidate`
2542     fn vtable_auto_impl(&mut self,
2543                            obligation: &TraitObligation<'tcx>,
2544                            trait_def_id: DefId,
2545                            nested: ty::Binder<Vec<Ty<'tcx>>>)
2546                            -> VtableAutoImplData<PredicateObligation<'tcx>>
2547     {
2548         debug!("vtable_auto_impl: nested={:?}", nested);
2549
2550         let cause = obligation.derived_cause(BuiltinDerivedObligation);
2551         let mut obligations = self.collect_predicates_for_types(
2552             obligation.param_env,
2553             cause,
2554             obligation.recursion_depth+1,
2555             trait_def_id,
2556             nested);
2557
2558         let trait_obligations = self.in_snapshot(|this, snapshot| {
2559             let poly_trait_ref = obligation.predicate.to_poly_trait_ref();
2560             let (trait_ref, skol_map) =
2561                 this.infcx().skolemize_late_bound_regions(&poly_trait_ref);
2562             let cause = obligation.derived_cause(ImplDerivedObligation);
2563             this.impl_or_trait_obligations(cause,
2564                                            obligation.recursion_depth + 1,
2565                                            obligation.param_env,
2566                                            trait_def_id,
2567                                            &trait_ref.substs,
2568                                            skol_map,
2569                                            snapshot)
2570         });
2571
2572         obligations.extend(trait_obligations);
2573
2574         debug!("vtable_auto_impl: obligations={:?}", obligations);
2575
2576         VtableAutoImplData {
2577             trait_def_id,
2578             nested: obligations
2579         }
2580     }
2581
2582     fn confirm_impl_candidate(&mut self,
2583                               obligation: &TraitObligation<'tcx>,
2584                               impl_def_id: DefId)
2585                               -> VtableImplData<'tcx, PredicateObligation<'tcx>>
2586     {
2587         debug!("confirm_impl_candidate({:?},{:?})",
2588                obligation,
2589                impl_def_id);
2590
2591         // First, create the substitutions by matching the impl again,
2592         // this time not in a probe.
2593         self.in_snapshot(|this, snapshot| {
2594             let (substs, skol_map) =
2595                 this.rematch_impl(impl_def_id, obligation,
2596                                   snapshot);
2597             debug!("confirm_impl_candidate substs={:?}", substs);
2598             let cause = obligation.derived_cause(ImplDerivedObligation);
2599             this.vtable_impl(impl_def_id,
2600                              substs,
2601                              cause,
2602                              obligation.recursion_depth + 1,
2603                              obligation.param_env,
2604                              skol_map,
2605                              snapshot)
2606         })
2607     }
2608
2609     fn vtable_impl(&mut self,
2610                    impl_def_id: DefId,
2611                    mut substs: Normalized<'tcx, &'tcx Substs<'tcx>>,
2612                    cause: ObligationCause<'tcx>,
2613                    recursion_depth: usize,
2614                    param_env: ty::ParamEnv<'tcx>,
2615                    skol_map: infer::SkolemizationMap<'tcx>,
2616                    snapshot: &infer::CombinedSnapshot<'cx, 'tcx>)
2617                    -> VtableImplData<'tcx, PredicateObligation<'tcx>>
2618     {
2619         debug!("vtable_impl(impl_def_id={:?}, substs={:?}, recursion_depth={}, skol_map={:?})",
2620                impl_def_id,
2621                substs,
2622                recursion_depth,
2623                skol_map);
2624
2625         let mut impl_obligations =
2626             self.impl_or_trait_obligations(cause,
2627                                            recursion_depth,
2628                                            param_env,
2629                                            impl_def_id,
2630                                            &substs.value,
2631                                            skol_map,
2632                                            snapshot);
2633
2634         debug!("vtable_impl: impl_def_id={:?} impl_obligations={:?}",
2635                impl_def_id,
2636                impl_obligations);
2637
2638         // Because of RFC447, the impl-trait-ref and obligations
2639         // are sufficient to determine the impl substs, without
2640         // relying on projections in the impl-trait-ref.
2641         //
2642         // e.g. `impl<U: Tr, V: Iterator<Item=U>> Foo<<U as Tr>::T> for V`
2643         impl_obligations.append(&mut substs.obligations);
2644
2645         VtableImplData { impl_def_id,
2646                          substs: substs.value,
2647                          nested: impl_obligations }
2648     }
2649
2650     fn confirm_object_candidate(&mut self,
2651                                 obligation: &TraitObligation<'tcx>)
2652                                 -> VtableObjectData<'tcx, PredicateObligation<'tcx>>
2653     {
2654         debug!("confirm_object_candidate({:?})",
2655                obligation);
2656
2657         // FIXME skipping binder here seems wrong -- we should
2658         // probably flatten the binder from the obligation and the
2659         // binder from the object. Have to try to make a broken test
2660         // case that results. -nmatsakis
2661         let self_ty = self.infcx.shallow_resolve(*obligation.self_ty().skip_binder());
2662         let poly_trait_ref = match self_ty.sty {
2663             ty::TyDynamic(ref data, ..) => {
2664                 data.principal().unwrap().with_self_ty(self.tcx(), self_ty)
2665             }
2666             _ => {
2667                 span_bug!(obligation.cause.span,
2668                           "object candidate with non-object");
2669             }
2670         };
2671
2672         let mut upcast_trait_ref = None;
2673         let mut nested = vec![];
2674         let vtable_base;
2675
2676         {
2677             let tcx = self.tcx();
2678
2679             // We want to find the first supertrait in the list of
2680             // supertraits that we can unify with, and do that
2681             // unification. We know that there is exactly one in the list
2682             // where we can unify because otherwise select would have
2683             // reported an ambiguity. (When we do find a match, also
2684             // record it for later.)
2685             let nonmatching =
2686                 util::supertraits(tcx, poly_trait_ref)
2687                 .take_while(|&t| {
2688                     match
2689                         self.commit_if_ok(
2690                             |this, _| this.match_poly_trait_ref(obligation, t))
2691                     {
2692                         Ok(obligations) => {
2693                             upcast_trait_ref = Some(t);
2694                             nested.extend(obligations);
2695                             false
2696                         }
2697                         Err(_) => { true }
2698                     }
2699                 });
2700
2701             // Additionally, for each of the nonmatching predicates that
2702             // we pass over, we sum up the set of number of vtable
2703             // entries, so that we can compute the offset for the selected
2704             // trait.
2705             vtable_base =
2706                 nonmatching.map(|t| tcx.count_own_vtable_entries(t))
2707                            .sum();
2708
2709         }
2710
2711         VtableObjectData {
2712             upcast_trait_ref: upcast_trait_ref.unwrap(),
2713             vtable_base,
2714             nested,
2715         }
2716     }
2717
2718     fn confirm_fn_pointer_candidate(&mut self, obligation: &TraitObligation<'tcx>)
2719         -> Result<VtableFnPointerData<'tcx, PredicateObligation<'tcx>>, SelectionError<'tcx>>
2720     {
2721         debug!("confirm_fn_pointer_candidate({:?})",
2722                obligation);
2723
2724         // ok to skip binder; it is reintroduced below
2725         let self_ty = self.infcx.shallow_resolve(*obligation.self_ty().skip_binder());
2726         let sig = self_ty.fn_sig(self.tcx());
2727         let trait_ref =
2728             self.tcx().closure_trait_ref_and_return_type(obligation.predicate.def_id(),
2729                                                          self_ty,
2730                                                          sig,
2731                                                          util::TupleArgumentsFlag::Yes)
2732             .map_bound(|(trait_ref, _)| trait_ref);
2733
2734         let Normalized { value: trait_ref, obligations } =
2735             project::normalize_with_depth(self,
2736                                           obligation.param_env,
2737                                           obligation.cause.clone(),
2738                                           obligation.recursion_depth + 1,
2739                                           &trait_ref);
2740
2741         self.confirm_poly_trait_refs(obligation.cause.clone(),
2742                                      obligation.param_env,
2743                                      obligation.predicate.to_poly_trait_ref(),
2744                                      trait_ref)?;
2745         Ok(VtableFnPointerData { fn_ty: self_ty, nested: obligations })
2746     }
2747
2748     fn confirm_generator_candidate(&mut self,
2749                                    obligation: &TraitObligation<'tcx>)
2750                                    -> Result<VtableGeneratorData<'tcx, PredicateObligation<'tcx>>,
2751                                            SelectionError<'tcx>>
2752     {
2753         // ok to skip binder because the substs on generator types never
2754         // touch bound regions, they just capture the in-scope
2755         // type/region parameters
2756         let self_ty = self.infcx.shallow_resolve(obligation.self_ty().skip_binder());
2757         let (generator_def_id, substs) = match self_ty.sty {
2758             ty::TyGenerator(id, substs, _) => (id, substs),
2759             _ => bug!("closure candidate for non-closure {:?}", obligation)
2760         };
2761
2762         debug!("confirm_generator_candidate({:?},{:?},{:?})",
2763                obligation,
2764                generator_def_id,
2765                substs);
2766
2767         let trait_ref =
2768             self.generator_trait_ref_unnormalized(obligation, generator_def_id, substs);
2769         let Normalized {
2770             value: trait_ref,
2771             mut obligations
2772         } = normalize_with_depth(self,
2773                                  obligation.param_env,
2774                                  obligation.cause.clone(),
2775                                  obligation.recursion_depth+1,
2776                                  &trait_ref);
2777
2778         debug!("confirm_generator_candidate(generator_def_id={:?}, \
2779                 trait_ref={:?}, obligations={:?})",
2780                generator_def_id,
2781                trait_ref,
2782                obligations);
2783
2784         obligations.extend(
2785             self.confirm_poly_trait_refs(obligation.cause.clone(),
2786                                         obligation.param_env,
2787                                         obligation.predicate.to_poly_trait_ref(),
2788                                         trait_ref)?);
2789
2790         Ok(VtableGeneratorData {
2791             generator_def_id: generator_def_id,
2792             substs: substs.clone(),
2793             nested: obligations
2794         })
2795     }
2796
2797     fn confirm_closure_candidate(&mut self,
2798                                  obligation: &TraitObligation<'tcx>)
2799                                  -> Result<VtableClosureData<'tcx, PredicateObligation<'tcx>>,
2800                                            SelectionError<'tcx>>
2801     {
2802         debug!("confirm_closure_candidate({:?})", obligation);
2803
2804         let kind = match self.tcx().lang_items().fn_trait_kind(obligation.predicate.def_id()) {
2805             Some(k) => k,
2806             None => bug!("closure candidate for non-fn trait {:?}", obligation)
2807         };
2808
2809         // ok to skip binder because the substs on closure types never
2810         // touch bound regions, they just capture the in-scope
2811         // type/region parameters
2812         let self_ty = self.infcx.shallow_resolve(obligation.self_ty().skip_binder());
2813         let (closure_def_id, substs) = match self_ty.sty {
2814             ty::TyClosure(id, substs) => (id, substs),
2815             _ => bug!("closure candidate for non-closure {:?}", obligation)
2816         };
2817
2818         let trait_ref =
2819             self.closure_trait_ref_unnormalized(obligation, closure_def_id, substs);
2820         let Normalized {
2821             value: trait_ref,
2822             mut obligations
2823         } = normalize_with_depth(self,
2824                                  obligation.param_env,
2825                                  obligation.cause.clone(),
2826                                  obligation.recursion_depth+1,
2827                                  &trait_ref);
2828
2829         debug!("confirm_closure_candidate(closure_def_id={:?}, trait_ref={:?}, obligations={:?})",
2830                closure_def_id,
2831                trait_ref,
2832                obligations);
2833
2834         obligations.extend(
2835             self.confirm_poly_trait_refs(obligation.cause.clone(),
2836                                         obligation.param_env,
2837                                         obligation.predicate.to_poly_trait_ref(),
2838                                         trait_ref)?);
2839
2840         obligations.push(Obligation::new(
2841             obligation.cause.clone(),
2842             obligation.param_env,
2843             ty::Predicate::ClosureKind(closure_def_id, substs, kind)));
2844
2845         Ok(VtableClosureData {
2846             closure_def_id,
2847             substs: substs.clone(),
2848             nested: obligations
2849         })
2850     }
2851
2852     /// In the case of closure types and fn pointers,
2853     /// we currently treat the input type parameters on the trait as
2854     /// outputs. This means that when we have a match we have only
2855     /// considered the self type, so we have to go back and make sure
2856     /// to relate the argument types too.  This is kind of wrong, but
2857     /// since we control the full set of impls, also not that wrong,
2858     /// and it DOES yield better error messages (since we don't report
2859     /// errors as if there is no applicable impl, but rather report
2860     /// errors are about mismatched argument types.
2861     ///
2862     /// Here is an example. Imagine we have a closure expression
2863     /// and we desugared it so that the type of the expression is
2864     /// `Closure`, and `Closure` expects an int as argument. Then it
2865     /// is "as if" the compiler generated this impl:
2866     ///
2867     ///     impl Fn(int) for Closure { ... }
2868     ///
2869     /// Now imagine our obligation is `Fn(usize) for Closure`. So far
2870     /// we have matched the self-type `Closure`. At this point we'll
2871     /// compare the `int` to `usize` and generate an error.
2872     ///
2873     /// Note that this checking occurs *after* the impl has selected,
2874     /// because these output type parameters should not affect the
2875     /// selection of the impl. Therefore, if there is a mismatch, we
2876     /// report an error to the user.
2877     fn confirm_poly_trait_refs(&mut self,
2878                                obligation_cause: ObligationCause<'tcx>,
2879                                obligation_param_env: ty::ParamEnv<'tcx>,
2880                                obligation_trait_ref: ty::PolyTraitRef<'tcx>,
2881                                expected_trait_ref: ty::PolyTraitRef<'tcx>)
2882                                -> Result<Vec<PredicateObligation<'tcx>>, SelectionError<'tcx>>
2883     {
2884         let obligation_trait_ref = obligation_trait_ref.clone();
2885         self.infcx
2886             .at(&obligation_cause, obligation_param_env)
2887             .sup(obligation_trait_ref, expected_trait_ref)
2888             .map(|InferOk { obligations, .. }| obligations)
2889             .map_err(|e| OutputTypeParameterMismatch(expected_trait_ref, obligation_trait_ref, e))
2890     }
2891
2892     fn confirm_builtin_unsize_candidate(&mut self,
2893                                         obligation: &TraitObligation<'tcx>,)
2894         -> Result<VtableBuiltinData<PredicateObligation<'tcx>>, SelectionError<'tcx>>
2895     {
2896         let tcx = self.tcx();
2897
2898         // assemble_candidates_for_unsizing should ensure there are no late bound
2899         // regions here. See the comment there for more details.
2900         let source = self.infcx.shallow_resolve(
2901             obligation.self_ty().no_late_bound_regions().unwrap());
2902         let target = obligation.predicate.skip_binder().trait_ref.substs.type_at(1);
2903         let target = self.infcx.shallow_resolve(target);
2904
2905         debug!("confirm_builtin_unsize_candidate(source={:?}, target={:?})",
2906                source, target);
2907
2908         let mut nested = vec![];
2909         match (&source.sty, &target.sty) {
2910             // Trait+Kx+'a -> Trait+Ky+'b (upcasts).
2911             (&ty::TyDynamic(ref data_a, r_a), &ty::TyDynamic(ref data_b, r_b)) => {
2912                 // See assemble_candidates_for_unsizing for more info.
2913                 let existential_predicates = data_a.map_bound(|data_a| {
2914                     let principal = data_a.principal();
2915                     let iter = principal.into_iter().map(ty::ExistentialPredicate::Trait)
2916                         .chain(data_a.projection_bounds()
2917                             .map(|x| ty::ExistentialPredicate::Projection(x)))
2918                         .chain(data_b.auto_traits().map(ty::ExistentialPredicate::AutoTrait));
2919                     tcx.mk_existential_predicates(iter)
2920                 });
2921                 let new_trait = tcx.mk_dynamic(existential_predicates, r_b);
2922                 let InferOk { obligations, .. } =
2923                     self.infcx.at(&obligation.cause, obligation.param_env)
2924                               .eq(target, new_trait)
2925                               .map_err(|_| Unimplemented)?;
2926                 nested.extend(obligations);
2927
2928                 // Register one obligation for 'a: 'b.
2929                 let cause = ObligationCause::new(obligation.cause.span,
2930                                                  obligation.cause.body_id,
2931                                                  ObjectCastObligation(target));
2932                 let outlives = ty::OutlivesPredicate(r_a, r_b);
2933                 nested.push(Obligation::with_depth(cause,
2934                                                    obligation.recursion_depth + 1,
2935                                                    obligation.param_env,
2936                                                    ty::Binder::bind(outlives).to_predicate()));
2937             }
2938
2939             // T -> Trait.
2940             (_, &ty::TyDynamic(ref data, r)) => {
2941                 let mut object_dids =
2942                     data.auto_traits().chain(data.principal().map(|p| p.def_id()));
2943                 if let Some(did) = object_dids.find(|did| {
2944                     !tcx.is_object_safe(*did)
2945                 }) {
2946                     return Err(TraitNotObjectSafe(did))
2947                 }
2948
2949                 let cause = ObligationCause::new(obligation.cause.span,
2950                                                  obligation.cause.body_id,
2951                                                  ObjectCastObligation(target));
2952                 let mut push = |predicate| {
2953                     nested.push(Obligation::with_depth(cause.clone(),
2954                                                        obligation.recursion_depth + 1,
2955                                                        obligation.param_env,
2956                                                        predicate));
2957                 };
2958
2959                 // Create obligations:
2960                 //  - Casting T to Trait
2961                 //  - For all the various builtin bounds attached to the object cast. (In other
2962                 //  words, if the object type is Foo+Send, this would create an obligation for the
2963                 //  Send check.)
2964                 //  - Projection predicates
2965                 for predicate in data.iter() {
2966                     push(predicate.with_self_ty(tcx, source));
2967                 }
2968
2969                 // We can only make objects from sized types.
2970                 let tr = ty::TraitRef {
2971                     def_id: tcx.require_lang_item(lang_items::SizedTraitLangItem),
2972                     substs: tcx.mk_substs_trait(source, &[]),
2973                 };
2974                 push(tr.to_predicate());
2975
2976                 // If the type is `Foo+'a`, ensures that the type
2977                 // being cast to `Foo+'a` outlives `'a`:
2978                 let outlives = ty::OutlivesPredicate(source, r);
2979                 push(ty::Binder::dummy(outlives).to_predicate());
2980             }
2981
2982             // [T; n] -> [T].
2983             (&ty::TyArray(a, _), &ty::TySlice(b)) => {
2984                 let InferOk { obligations, .. } =
2985                     self.infcx.at(&obligation.cause, obligation.param_env)
2986                               .eq(b, a)
2987                               .map_err(|_| Unimplemented)?;
2988                 nested.extend(obligations);
2989             }
2990
2991             // Struct<T> -> Struct<U>.
2992             (&ty::TyAdt(def, substs_a), &ty::TyAdt(_, substs_b)) => {
2993                 let fields = def
2994                     .all_fields()
2995                     .map(|f| tcx.type_of(f.did))
2996                     .collect::<Vec<_>>();
2997
2998                 // The last field of the structure has to exist and contain type parameters.
2999                 let field = if let Some(&field) = fields.last() {
3000                     field
3001                 } else {
3002                     return Err(Unimplemented);
3003                 };
3004                 let mut ty_params = BitVector::new(substs_a.types().count());
3005                 let mut found = false;
3006                 for ty in field.walk() {
3007                     if let ty::TyParam(p) = ty.sty {
3008                         ty_params.insert(p.idx as usize);
3009                         found = true;
3010                     }
3011                 }
3012                 if !found {
3013                     return Err(Unimplemented);
3014                 }
3015
3016                 // Replace type parameters used in unsizing with
3017                 // TyError and ensure they do not affect any other fields.
3018                 // This could be checked after type collection for any struct
3019                 // with a potentially unsized trailing field.
3020                 let params = substs_a.iter().enumerate().map(|(i, &k)| {
3021                     if ty_params.contains(i) {
3022                         tcx.types.err.into()
3023                     } else {
3024                         k
3025                     }
3026                 });
3027                 let substs = tcx.mk_substs(params);
3028                 for &ty in fields.split_last().unwrap().1 {
3029                     if ty.subst(tcx, substs).references_error() {
3030                         return Err(Unimplemented);
3031                     }
3032                 }
3033
3034                 // Extract Field<T> and Field<U> from Struct<T> and Struct<U>.
3035                 let inner_source = field.subst(tcx, substs_a);
3036                 let inner_target = field.subst(tcx, substs_b);
3037
3038                 // Check that the source struct with the target's
3039                 // unsized parameters is equal to the target.
3040                 let params = substs_a.iter().enumerate().map(|(i, &k)| {
3041                     if ty_params.contains(i) {
3042                         substs_b.type_at(i).into()
3043                     } else {
3044                         k
3045                     }
3046                 });
3047                 let new_struct = tcx.mk_adt(def, tcx.mk_substs(params));
3048                 let InferOk { obligations, .. } =
3049                     self.infcx.at(&obligation.cause, obligation.param_env)
3050                               .eq(target, new_struct)
3051                               .map_err(|_| Unimplemented)?;
3052                 nested.extend(obligations);
3053
3054                 // Construct the nested Field<T>: Unsize<Field<U>> predicate.
3055                 nested.push(tcx.predicate_for_trait_def(
3056                     obligation.param_env,
3057                     obligation.cause.clone(),
3058                     obligation.predicate.def_id(),
3059                     obligation.recursion_depth + 1,
3060                     inner_source,
3061                     &[inner_target.into()]));
3062             }
3063
3064             // (.., T) -> (.., U).
3065             (&ty::TyTuple(tys_a), &ty::TyTuple(tys_b)) => {
3066                 assert_eq!(tys_a.len(), tys_b.len());
3067
3068                 // The last field of the tuple has to exist.
3069                 let (&a_last, a_mid) = if let Some(x) = tys_a.split_last() {
3070                     x
3071                 } else {
3072                     return Err(Unimplemented);
3073                 };
3074                 let &b_last = tys_b.last().unwrap();
3075
3076                 // Check that the source tuple with the target's
3077                 // last element is equal to the target.
3078                 let new_tuple = tcx.mk_tup(a_mid.iter().cloned().chain(iter::once(b_last)));
3079                 let InferOk { obligations, .. } =
3080                     self.infcx.at(&obligation.cause, obligation.param_env)
3081                               .eq(target, new_tuple)
3082                               .map_err(|_| Unimplemented)?;
3083                 nested.extend(obligations);
3084
3085                 // Construct the nested T: Unsize<U> predicate.
3086                 nested.push(tcx.predicate_for_trait_def(
3087                     obligation.param_env,
3088                     obligation.cause.clone(),
3089                     obligation.predicate.def_id(),
3090                     obligation.recursion_depth + 1,
3091                     a_last,
3092                     &[b_last.into()]));
3093             }
3094
3095             _ => bug!()
3096         };
3097
3098         Ok(VtableBuiltinData { nested: nested })
3099     }
3100
3101     ///////////////////////////////////////////////////////////////////////////
3102     // Matching
3103     //
3104     // Matching is a common path used for both evaluation and
3105     // confirmation.  It basically unifies types that appear in impls
3106     // and traits. This does affect the surrounding environment;
3107     // therefore, when used during evaluation, match routines must be
3108     // run inside of a `probe()` so that their side-effects are
3109     // contained.
3110
3111     fn rematch_impl(&mut self,
3112                     impl_def_id: DefId,
3113                     obligation: &TraitObligation<'tcx>,
3114                     snapshot: &infer::CombinedSnapshot<'cx, 'tcx>)
3115                     -> (Normalized<'tcx, &'tcx Substs<'tcx>>,
3116                         infer::SkolemizationMap<'tcx>)
3117     {
3118         match self.match_impl(impl_def_id, obligation, snapshot) {
3119             Ok((substs, skol_map)) => (substs, skol_map),
3120             Err(()) => {
3121                 bug!("Impl {:?} was matchable against {:?} but now is not",
3122                      impl_def_id,
3123                      obligation);
3124             }
3125         }
3126     }
3127
3128     fn match_impl(&mut self,
3129                   impl_def_id: DefId,
3130                   obligation: &TraitObligation<'tcx>,
3131                   snapshot: &infer::CombinedSnapshot<'cx, 'tcx>)
3132                   -> Result<(Normalized<'tcx, &'tcx Substs<'tcx>>,
3133                              infer::SkolemizationMap<'tcx>), ()>
3134     {
3135         let impl_trait_ref = self.tcx().impl_trait_ref(impl_def_id).unwrap();
3136
3137         // Before we create the substitutions and everything, first
3138         // consider a "quick reject". This avoids creating more types
3139         // and so forth that we need to.
3140         if self.fast_reject_trait_refs(obligation, &impl_trait_ref) {
3141             return Err(());
3142         }
3143
3144         let (skol_obligation, skol_map) = self.infcx().skolemize_late_bound_regions(
3145             &obligation.predicate);
3146         let skol_obligation_trait_ref = skol_obligation.trait_ref;
3147
3148         let impl_substs = self.infcx.fresh_substs_for_item(obligation.cause.span,
3149                                                            impl_def_id);
3150
3151         let impl_trait_ref = impl_trait_ref.subst(self.tcx(),
3152                                                   impl_substs);
3153
3154         let Normalized { value: impl_trait_ref, obligations: mut nested_obligations } =
3155             project::normalize_with_depth(self,
3156                                           obligation.param_env,
3157                                           obligation.cause.clone(),
3158                                           obligation.recursion_depth + 1,
3159                                           &impl_trait_ref);
3160
3161         debug!("match_impl(impl_def_id={:?}, obligation={:?}, \
3162                impl_trait_ref={:?}, skol_obligation_trait_ref={:?})",
3163                impl_def_id,
3164                obligation,
3165                impl_trait_ref,
3166                skol_obligation_trait_ref);
3167
3168         let InferOk { obligations, .. } =
3169             self.infcx.at(&obligation.cause, obligation.param_env)
3170                       .eq(skol_obligation_trait_ref, impl_trait_ref)
3171                       .map_err(|e| {
3172                           debug!("match_impl: failed eq_trait_refs due to `{}`", e);
3173                           ()
3174                       })?;
3175         nested_obligations.extend(obligations);
3176
3177         if let Err(e) = self.infcx.leak_check(false,
3178                                               obligation.cause.span,
3179                                               &skol_map,
3180                                               snapshot) {
3181             debug!("match_impl: failed leak check due to `{}`", e);
3182             return Err(());
3183         }
3184
3185         debug!("match_impl: success impl_substs={:?}", impl_substs);
3186         Ok((Normalized {
3187             value: impl_substs,
3188             obligations: nested_obligations
3189         }, skol_map))
3190     }
3191
3192     fn fast_reject_trait_refs(&mut self,
3193                               obligation: &TraitObligation,
3194                               impl_trait_ref: &ty::TraitRef)
3195                               -> bool
3196     {
3197         // We can avoid creating type variables and doing the full
3198         // substitution if we find that any of the input types, when
3199         // simplified, do not match.
3200
3201         obligation.predicate.skip_binder().input_types()
3202             .zip(impl_trait_ref.input_types())
3203             .any(|(obligation_ty, impl_ty)| {
3204                 let simplified_obligation_ty =
3205                     fast_reject::simplify_type(self.tcx(), obligation_ty, true);
3206                 let simplified_impl_ty =
3207                     fast_reject::simplify_type(self.tcx(), impl_ty, false);
3208
3209                 simplified_obligation_ty.is_some() &&
3210                     simplified_impl_ty.is_some() &&
3211                     simplified_obligation_ty != simplified_impl_ty
3212             })
3213     }
3214
3215     /// Normalize `where_clause_trait_ref` and try to match it against
3216     /// `obligation`.  If successful, return any predicates that
3217     /// result from the normalization. Normalization is necessary
3218     /// because where-clauses are stored in the parameter environment
3219     /// unnormalized.
3220     fn match_where_clause_trait_ref(&mut self,
3221                                     obligation: &TraitObligation<'tcx>,
3222                                     where_clause_trait_ref: ty::PolyTraitRef<'tcx>)
3223                                     -> Result<Vec<PredicateObligation<'tcx>>,()>
3224     {
3225         self.match_poly_trait_ref(obligation, where_clause_trait_ref)
3226     }
3227
3228     /// Returns `Ok` if `poly_trait_ref` being true implies that the
3229     /// obligation is satisfied.
3230     fn match_poly_trait_ref(&mut self,
3231                             obligation: &TraitObligation<'tcx>,
3232                             poly_trait_ref: ty::PolyTraitRef<'tcx>)
3233                             -> Result<Vec<PredicateObligation<'tcx>>,()>
3234     {
3235         debug!("match_poly_trait_ref: obligation={:?} poly_trait_ref={:?}",
3236                obligation,
3237                poly_trait_ref);
3238
3239         self.infcx.at(&obligation.cause, obligation.param_env)
3240                   .sup(obligation.predicate.to_poly_trait_ref(), poly_trait_ref)
3241                   .map(|InferOk { obligations, .. }| obligations)
3242                   .map_err(|_| ())
3243     }
3244
3245     ///////////////////////////////////////////////////////////////////////////
3246     // Miscellany
3247
3248     fn match_fresh_trait_refs(&self,
3249                               previous: &ty::PolyTraitRef<'tcx>,
3250                               current: &ty::PolyTraitRef<'tcx>)
3251                               -> bool
3252     {
3253         let mut matcher = ty::_match::Match::new(self.tcx());
3254         matcher.relate(previous, current).is_ok()
3255     }
3256
3257     fn push_stack<'o,'s:'o>(&mut self,
3258                             previous_stack: TraitObligationStackList<'s, 'tcx>,
3259                             obligation: &'o TraitObligation<'tcx>)
3260                             -> TraitObligationStack<'o, 'tcx>
3261     {
3262         let fresh_trait_ref =
3263             obligation.predicate.to_poly_trait_ref().fold_with(&mut self.freshener);
3264
3265         TraitObligationStack {
3266             obligation,
3267             fresh_trait_ref,
3268             previous: previous_stack,
3269         }
3270     }
3271
3272     fn closure_trait_ref_unnormalized(&mut self,
3273                                       obligation: &TraitObligation<'tcx>,
3274                                       closure_def_id: DefId,
3275                                       substs: ty::ClosureSubsts<'tcx>)
3276                                       -> ty::PolyTraitRef<'tcx>
3277     {
3278         let closure_type = self.infcx.closure_sig(closure_def_id, substs);
3279
3280         // (1) Feels icky to skip the binder here, but OTOH we know
3281         // that the self-type is an unboxed closure type and hence is
3282         // in fact unparameterized (or at least does not reference any
3283         // regions bound in the obligation). Still probably some
3284         // refactoring could make this nicer.
3285
3286         self.tcx().closure_trait_ref_and_return_type(obligation.predicate.def_id(),
3287                                                      obligation.predicate
3288                                                          .skip_binder().self_ty(), // (1)
3289                                                      closure_type,
3290                                                      util::TupleArgumentsFlag::No)
3291             .map_bound(|(trait_ref, _)| trait_ref)
3292     }
3293
3294     fn generator_trait_ref_unnormalized(&mut self,
3295                                       obligation: &TraitObligation<'tcx>,
3296                                       closure_def_id: DefId,
3297                                       substs: ty::GeneratorSubsts<'tcx>)
3298                                       -> ty::PolyTraitRef<'tcx>
3299     {
3300         let gen_sig = substs.poly_sig(closure_def_id, self.tcx());
3301
3302         // (1) Feels icky to skip the binder here, but OTOH we know
3303         // that the self-type is an generator type and hence is
3304         // in fact unparameterized (or at least does not reference any
3305         // regions bound in the obligation). Still probably some
3306         // refactoring could make this nicer.
3307
3308         self.tcx().generator_trait_ref_and_outputs(obligation.predicate.def_id(),
3309                                                    obligation.predicate
3310                                                        .skip_binder().self_ty(), // (1)
3311                                                    gen_sig)
3312             .map_bound(|(trait_ref, ..)| trait_ref)
3313     }
3314
3315     /// Returns the obligations that are implied by instantiating an
3316     /// impl or trait. The obligations are substituted and fully
3317     /// normalized. This is used when confirming an impl or default
3318     /// impl.
3319     fn impl_or_trait_obligations(&mut self,
3320                                  cause: ObligationCause<'tcx>,
3321                                  recursion_depth: usize,
3322                                  param_env: ty::ParamEnv<'tcx>,
3323                                  def_id: DefId, // of impl or trait
3324                                  substs: &Substs<'tcx>, // for impl or trait
3325                                  skol_map: infer::SkolemizationMap<'tcx>,
3326                                  snapshot: &infer::CombinedSnapshot<'cx, 'tcx>)
3327                                  -> Vec<PredicateObligation<'tcx>>
3328     {
3329         debug!("impl_or_trait_obligations(def_id={:?})", def_id);
3330         let tcx = self.tcx();
3331
3332         // To allow for one-pass evaluation of the nested obligation,
3333         // each predicate must be preceded by the obligations required
3334         // to normalize it.
3335         // for example, if we have:
3336         //    impl<U: Iterator, V: Iterator<Item=U>> Foo for V where U::Item: Copy
3337         // the impl will have the following predicates:
3338         //    <V as Iterator>::Item = U,
3339         //    U: Iterator, U: Sized,
3340         //    V: Iterator, V: Sized,
3341         //    <U as Iterator>::Item: Copy
3342         // When we substitute, say, `V => IntoIter<u32>, U => $0`, the last
3343         // obligation will normalize to `<$0 as Iterator>::Item = $1` and
3344         // `$1: Copy`, so we must ensure the obligations are emitted in
3345         // that order.
3346         let predicates = tcx.predicates_of(def_id);
3347         assert_eq!(predicates.parent, None);
3348         let mut predicates: Vec<_> = predicates.predicates.iter().flat_map(|predicate| {
3349             let predicate = normalize_with_depth(self, param_env, cause.clone(), recursion_depth,
3350                                                  &predicate.subst(tcx, substs));
3351             predicate.obligations.into_iter().chain(
3352                 Some(Obligation {
3353                     cause: cause.clone(),
3354                     recursion_depth,
3355                     param_env,
3356                     predicate: predicate.value
3357                 }))
3358         }).collect();
3359
3360         // We are performing deduplication here to avoid exponential blowups
3361         // (#38528) from happening, but the real cause of the duplication is
3362         // unknown. What we know is that the deduplication avoids exponential
3363         // amount of predicates being propagated when processing deeply nested
3364         // types.
3365         //
3366         // This code is hot enough that it's worth avoiding the allocation
3367         // required for the FxHashSet when possible. Special-casing lengths 0,
3368         // 1 and 2 covers roughly 75--80% of the cases.
3369         if predicates.len() <= 1 {
3370             // No possibility of duplicates.
3371         } else if predicates.len() == 2 {
3372             // Only two elements. Drop the second if they are equal.
3373             if predicates[0] == predicates[1] {
3374                 predicates.truncate(1);
3375             }
3376         } else {
3377             // Three or more elements. Use a general deduplication process.
3378             let mut seen = FxHashSet();
3379             predicates.retain(|i| seen.insert(i.clone()));
3380         }
3381         self.infcx().plug_leaks(skol_map, snapshot, predicates)
3382     }
3383 }
3384
3385 impl<'tcx> TraitObligation<'tcx> {
3386     #[allow(unused_comparisons)]
3387     pub fn derived_cause(&self,
3388                         variant: fn(DerivedObligationCause<'tcx>) -> ObligationCauseCode<'tcx>)
3389                         -> ObligationCause<'tcx>
3390     {
3391         /*!
3392          * Creates a cause for obligations that are derived from
3393          * `obligation` by a recursive search (e.g., for a builtin
3394          * bound, or eventually a `auto trait Foo`). If `obligation`
3395          * is itself a derived obligation, this is just a clone, but
3396          * otherwise we create a "derived obligation" cause so as to
3397          * keep track of the original root obligation for error
3398          * reporting.
3399          */
3400
3401         let obligation = self;
3402
3403         // NOTE(flaper87): As of now, it keeps track of the whole error
3404         // chain. Ideally, we should have a way to configure this either
3405         // by using -Z verbose or just a CLI argument.
3406         if obligation.recursion_depth >= 0 {
3407             let derived_cause = DerivedObligationCause {
3408                 parent_trait_ref: obligation.predicate.to_poly_trait_ref(),
3409                 parent_code: Rc::new(obligation.cause.code.clone())
3410             };
3411             let derived_code = variant(derived_cause);
3412             ObligationCause::new(obligation.cause.span, obligation.cause.body_id, derived_code)
3413         } else {
3414             obligation.cause.clone()
3415         }
3416     }
3417 }
3418
3419 impl<'tcx> SelectionCache<'tcx> {
3420     pub fn new() -> SelectionCache<'tcx> {
3421         SelectionCache {
3422             hashmap: Lock::new(FxHashMap())
3423         }
3424     }
3425
3426     pub fn clear(&self) {
3427         *self.hashmap.borrow_mut() = FxHashMap()
3428     }
3429 }
3430
3431 impl<'tcx> EvaluationCache<'tcx> {
3432     pub fn new() -> EvaluationCache<'tcx> {
3433         EvaluationCache {
3434             hashmap: Lock::new(FxHashMap())
3435         }
3436     }
3437
3438     pub fn clear(&self) {
3439         *self.hashmap.borrow_mut() = FxHashMap()
3440     }
3441 }
3442
3443 impl<'o,'tcx> TraitObligationStack<'o,'tcx> {
3444     fn list(&'o self) -> TraitObligationStackList<'o,'tcx> {
3445         TraitObligationStackList::with(self)
3446     }
3447
3448     fn iter(&'o self) -> TraitObligationStackList<'o,'tcx> {
3449         self.list()
3450     }
3451 }
3452
3453 #[derive(Copy, Clone)]
3454 struct TraitObligationStackList<'o,'tcx:'o> {
3455     head: Option<&'o TraitObligationStack<'o,'tcx>>
3456 }
3457
3458 impl<'o,'tcx> TraitObligationStackList<'o,'tcx> {
3459     fn empty() -> TraitObligationStackList<'o,'tcx> {
3460         TraitObligationStackList { head: None }
3461     }
3462
3463     fn with(r: &'o TraitObligationStack<'o,'tcx>) -> TraitObligationStackList<'o,'tcx> {
3464         TraitObligationStackList { head: Some(r) }
3465     }
3466 }
3467
3468 impl<'o,'tcx> Iterator for TraitObligationStackList<'o,'tcx>{
3469     type Item = &'o TraitObligationStack<'o,'tcx>;
3470
3471     fn next(&mut self) -> Option<&'o TraitObligationStack<'o,'tcx>> {
3472         match self.head {
3473             Some(o) => {
3474                 *self = o.previous;
3475                 Some(o)
3476             }
3477             None => None
3478         }
3479     }
3480 }
3481
3482 impl<'o,'tcx> fmt::Debug for TraitObligationStack<'o,'tcx> {
3483     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3484         write!(f, "TraitObligationStack({:?})", self.obligation)
3485     }
3486 }
3487
3488 #[derive(Clone, Eq, PartialEq)]
3489 pub struct WithDepNode<T> {
3490     dep_node: DepNodeIndex,
3491     cached_value: T
3492 }
3493
3494 impl<T: Clone> WithDepNode<T> {
3495     pub fn new(dep_node: DepNodeIndex, cached_value: T) -> Self {
3496         WithDepNode { dep_node, cached_value }
3497     }
3498
3499     pub fn get(&self, tcx: TyCtxt) -> T {
3500         tcx.dep_graph.read_index(self.dep_node);
3501         self.cached_value.clone()
3502     }
3503 }