src/librustc/traits/mod.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 //! Trait Resolution. See README.md for an overview of how this works.
  12
  13 pub use self::SelectionError::*;
  14 pub use self::FulfillmentErrorCode::*;
  15 pub use self::Vtable::*;
  16 pub use self::ObligationCauseCode::*;
  17
  18 use hir;
  19 use hir::def_id::DefId;
  20 use middle::free_region::FreeRegionMap;
  21 use ty::subst::Substs;
  22 use ty::{self, Ty, TyCtxt, TypeFoldable, ToPredicate};
  23 use ty::error::{ExpectedFound, TypeError};
  24 use infer::{InferCtxt};
  25
  26 use std::rc::Rc;
  27 use syntax::ast;
  28 use syntax_pos::{Span, DUMMY_SP};
  29
  30 pub use self::error_reporting::TraitErrorKey;
  31 pub use self::coherence::orphan_check;
  32 pub use self::coherence::overlapping_impls;
  33 pub use self::coherence::OrphanCheckErr;
  34 pub use self::fulfill::{FulfillmentContext, GlobalFulfilledPredicates, RegionObligation};
  35 pub use self::project::MismatchedProjectionTypes;
  36 pub use self::project::{normalize, normalize_projection_type, Normalized};
  37 pub use self::project::{ProjectionCache, ProjectionCacheSnapshot, Reveal};
  38 pub use self::object_safety::ObjectSafetyViolation;
  39 pub use self::object_safety::MethodViolationCode;
  40 pub use self::select::{EvaluationCache, SelectionContext, SelectionCache};
  41 pub use self::specialize::{OverlapError, specialization_graph, specializes, translate_substs};
  42 pub use self::specialize::{SpecializesCache, find_associated_item};
  43 pub use self::util::elaborate_predicates;
  44 pub use self::util::supertraits;
  45 pub use self::util::Supertraits;
  46 pub use self::util::supertrait_def_ids;
  47 pub use self::util::SupertraitDefIds;
  48 pub use self::util::transitive_bounds;
  49
  50 mod coherence;
  51 mod error_reporting;
  52 mod fulfill;
  53 mod project;
  54 mod object_safety;
  55 mod select;
  56 mod specialize;
  57 mod structural_impls;
  58 pub mod trans;
  59 mod util;
  60
  61 /// An `Obligation` represents some trait reference (e.g. `int:Eq`) for
  62 /// which the vtable must be found.  The process of finding a vtable is
  63 /// called "resolving" the `Obligation`. This process consists of
  64 /// either identifying an `impl` (e.g., `impl Eq for int`) that
  65 /// provides the required vtable, or else finding a bound that is in
  66 /// scope. The eventual result is usually a `Selection` (defined below).
  67 #[derive(Clone, PartialEq, Eq)]
  68 pub struct Obligation<'tcx, T> {
  69     pub cause: ObligationCause<'tcx>,
  70     pub recursion_depth: usize,
  71     pub predicate: T,
  72 }
  73
  74 pub type PredicateObligation<'tcx> = Obligation<'tcx, ty::Predicate<'tcx>>;
  75 pub type TraitObligation<'tcx> = Obligation<'tcx, ty::PolyTraitPredicate<'tcx>>;
  76
  77 /// Why did we incur this obligation? Used for error reporting.
  78 #[derive(Clone, Debug, PartialEq, Eq)]
  79 pub struct ObligationCause<'tcx> {
  80     pub span: Span,
  81
  82     // The id of the fn body that triggered this obligation. This is
  83     // used for region obligations to determine the precise
  84     // environment in which the region obligation should be evaluated
  85     // (in particular, closures can add new assumptions). See the
  86     // field `region_obligations` of the `FulfillmentContext` for more
  87     // information.
  88     pub body_id: ast::NodeId,
  89
  90     pub code: ObligationCauseCode<'tcx>
  91 }
  92
  93 #[derive(Clone, Debug, PartialEq, Eq)]
  94 pub enum ObligationCauseCode<'tcx> {
  95     /// Not well classified or should be obvious from span.
  96     MiscObligation,
  97
  98     /// A slice or array is WF only if `T: Sized`
  99     SliceOrArrayElem,
 100
 101     /// A tuple is WF only if its middle elements are Sized
 102     TupleElem,
 103
 104     /// This is the trait reference from the given projection
 105     ProjectionWf(ty::ProjectionTy<'tcx>),
 106
 107     /// In an impl of trait X for type Y, type Y must
 108     /// also implement all supertraits of X.
 109     ItemObligation(DefId),
 110
 111     /// A type like `&'a T` is WF only if `T: 'a`.
 112     ReferenceOutlivesReferent(Ty<'tcx>),
 113
 114     /// A type like `Box<Foo<'a> + 'b>` is WF only if `'b: 'a`.
 115     ObjectTypeBound(Ty<'tcx>, &'tcx ty::Region),
 116
 117     /// Obligation incurred due to an object cast.
 118     ObjectCastObligation(/* Object type */ Ty<'tcx>),
 119
 120     /// Various cases where expressions must be sized/copy/etc:
 121     AssignmentLhsSized,        // L = X implies that L is Sized
 122     StructInitializerSized,    // S { ... } must be Sized
 123     VariableType(ast::NodeId), // Type of each variable must be Sized
 124     ReturnType,                // Return type must be Sized
 125     RepeatVec,                 // [T,..n] --> T must be Copy
 126
 127     // Types of fields (other than the last) in a struct must be sized.
 128     FieldSized,
 129
 130     // Constant expressions must be sized.
 131     ConstSized,
 132
 133     // static items must have `Sync` type
 134     SharedStatic,
 135
 136     BuiltinDerivedObligation(DerivedObligationCause<'tcx>),
 137
 138     ImplDerivedObligation(DerivedObligationCause<'tcx>),
 139
 140     // error derived when matching traits/impls; see ObligationCause for more details
 141     CompareImplMethodObligation {
 142         item_name: ast::Name,
 143         impl_item_def_id: DefId,
 144         trait_item_def_id: DefId,
 145         lint_id: Option<ast::NodeId>,
 146     },
 147
 148     // Checking that this expression can be assigned where it needs to be
 149     // FIXME(eddyb) #11161 is the original Expr required?
 150     ExprAssignable,
 151
 152     // Computing common supertype in the arms of a match expression
 153     MatchExpressionArm { arm_span: Span,
 154                          source: hir::MatchSource },
 155
 156     // Computing common supertype in an if expression
 157     IfExpression,
 158
 159     // Computing common supertype of an if expression with no else counter-part
 160     IfExpressionWithNoElse,
 161
 162     // `where a == b`
 163     EquatePredicate,
 164
 165     // `main` has wrong type
 166     MainFunctionType,
 167
 168     // `start` has wrong type
 169     StartFunctionType,
 170
 171     // intrinsic has wrong type
 172     IntrinsicType,
 173
 174     // method receiver
 175     MethodReceiver,
 176
 177     // `return` with no expression
 178     ReturnNoExpression,
 179 }
 180
 181 #[derive(Clone, Debug, PartialEq, Eq)]
 182 pub struct DerivedObligationCause<'tcx> {
 183     /// The trait reference of the parent obligation that led to the
 184     /// current obligation. Note that only trait obligations lead to
 185     /// derived obligations, so we just store the trait reference here
 186     /// directly.
 187     parent_trait_ref: ty::PolyTraitRef<'tcx>,
 188
 189     /// The parent trait had this cause
 190     parent_code: Rc<ObligationCauseCode<'tcx>>
 191 }
 192
 193 pub type Obligations<'tcx, O> = Vec<Obligation<'tcx, O>>;
 194 pub type PredicateObligations<'tcx> = Vec<PredicateObligation<'tcx>>;
 195 pub type TraitObligations<'tcx> = Vec<TraitObligation<'tcx>>;
 196
 197 pub type Selection<'tcx> = Vtable<'tcx, PredicateObligation<'tcx>>;
 198
 199 #[derive(Clone,Debug)]
 200 pub enum SelectionError<'tcx> {
 201     Unimplemented,
 202     OutputTypeParameterMismatch(ty::PolyTraitRef<'tcx>,
 203                                 ty::PolyTraitRef<'tcx>,
 204                                 ty::error::TypeError<'tcx>),
 205     TraitNotObjectSafe(DefId),
 206 }
 207
 208 pub struct FulfillmentError<'tcx> {
 209     pub obligation: PredicateObligation<'tcx>,
 210     pub code: FulfillmentErrorCode<'tcx>
 211 }
 212
 213 #[derive(Clone)]
 214 pub enum FulfillmentErrorCode<'tcx> {
 215     CodeSelectionError(SelectionError<'tcx>),
 216     CodeProjectionError(MismatchedProjectionTypes<'tcx>),
 217     CodeSubtypeError(ExpectedFound<Ty<'tcx>>,
 218                      TypeError<'tcx>), // always comes from a SubtypePredicate
 219     CodeAmbiguity,
 220 }
 221
 222 /// When performing resolution, it is typically the case that there
 223 /// can be one of three outcomes:
 224 ///
 225 /// - `Ok(Some(r))`: success occurred with result `r`
 226 /// - `Ok(None)`: could not definitely determine anything, usually due
 227 ///   to inconclusive type inference.
 228 /// - `Err(e)`: error `e` occurred
 229 pub type SelectionResult<'tcx, T> = Result<Option<T>, SelectionError<'tcx>>;
 230
 231 /// Given the successful resolution of an obligation, the `Vtable`
 232 /// indicates where the vtable comes from. Note that while we call this
 233 /// a "vtable", it does not necessarily indicate dynamic dispatch at
 234 /// runtime. `Vtable` instances just tell the compiler where to find
 235 /// methods, but in generic code those methods are typically statically
 236 /// dispatched -- only when an object is constructed is a `Vtable`
 237 /// instance reified into an actual vtable.
 238 ///
 239 /// For example, the vtable may be tied to a specific impl (case A),
 240 /// or it may be relative to some bound that is in scope (case B).
 241 ///
 242 ///
 243 /// ```
 244 /// impl<T:Clone> Clone<T> for Option<T> { ... } // Impl_1
 245 /// impl<T:Clone> Clone<T> for Box<T> { ... }    // Impl_2
 246 /// impl Clone for int { ... }             // Impl_3
 247 ///
 248 /// fn foo<T:Clone>(concrete: Option<Box<int>>,
 249 ///                 param: T,
 250 ///                 mixed: Option<T>) {
 251 ///
 252 ///    // Case A: Vtable points at a specific impl. Only possible when
 253 ///    // type is concretely known. If the impl itself has bounded
 254 ///    // type parameters, Vtable will carry resolutions for those as well:
 255 ///    concrete.clone(); // Vtable(Impl_1, [Vtable(Impl_2, [Vtable(Impl_3)])])
 256 ///
 257 ///    // Case B: Vtable must be provided by caller. This applies when
 258 ///    // type is a type parameter.
 259 ///    param.clone();    // VtableParam
 260 ///
 261 ///    // Case C: A mix of cases A and B.
 262 ///    mixed.clone();    // Vtable(Impl_1, [VtableParam])
 263 /// }
 264 /// ```
 265 ///
 266 /// ### The type parameter `N`
 267 ///
 268 /// See explanation on `VtableImplData`.
 269 #[derive(Clone)]
 270 pub enum Vtable<'tcx, N> {
 271     /// Vtable identifying a particular impl.
 272     VtableImpl(VtableImplData<'tcx, N>),
 273
 274     /// Vtable for default trait implementations
 275     /// This carries the information and nested obligations with regards
 276     /// to a default implementation for a trait `Trait`. The nested obligations
 277     /// ensure the trait implementation holds for all the constituent types.
 278     VtableDefaultImpl(VtableDefaultImplData<N>),
 279
 280     /// Successful resolution to an obligation provided by the caller
 281     /// for some type parameter. The `Vec<N>` represents the
 282     /// obligations incurred from normalizing the where-clause (if
 283     /// any).
 284     VtableParam(Vec<N>),
 285
 286     /// Virtual calls through an object
 287     VtableObject(VtableObjectData<'tcx, N>),
 288
 289     /// Successful resolution for a builtin trait.
 290     VtableBuiltin(VtableBuiltinData<N>),
 291
 292     /// Vtable automatically generated for a closure. The def ID is the ID
 293     /// of the closure expression. This is a `VtableImpl` in spirit, but the
 294     /// impl is generated by the compiler and does not appear in the source.
 295     VtableClosure(VtableClosureData<'tcx, N>),
 296
 297     /// Same as above, but for a fn pointer type with the given signature.
 298     VtableFnPointer(VtableFnPointerData<'tcx, N>),
 299 }
 300
 301 /// Identifies a particular impl in the source, along with a set of
 302 /// substitutions from the impl's type/lifetime parameters. The
 303 /// `nested` vector corresponds to the nested obligations attached to
 304 /// the impl's type parameters.
 305 ///
 306 /// The type parameter `N` indicates the type used for "nested
 307 /// obligations" that are required by the impl. During type check, this
 308 /// is `Obligation`, as one might expect. During trans, however, this
 309 /// is `()`, because trans only requires a shallow resolution of an
 310 /// impl, and nested obligations are satisfied later.
 311 #[derive(Clone, PartialEq, Eq)]
 312 pub struct VtableImplData<'tcx, N> {
 313     pub impl_def_id: DefId,
 314     pub substs: &'tcx Substs<'tcx>,
 315     pub nested: Vec<N>
 316 }
 317
 318 #[derive(Clone, PartialEq, Eq)]
 319 pub struct VtableClosureData<'tcx, N> {
 320     pub closure_def_id: DefId,
 321     pub substs: ty::ClosureSubsts<'tcx>,
 322     /// Nested obligations. This can be non-empty if the closure
 323     /// signature contains associated types.
 324     pub nested: Vec<N>
 325 }
 326
 327 #[derive(Clone)]
 328 pub struct VtableDefaultImplData<N> {
 329     pub trait_def_id: DefId,
 330     pub nested: Vec<N>
 331 }
 332
 333 #[derive(Clone)]
 334 pub struct VtableBuiltinData<N> {
 335     pub nested: Vec<N>
 336 }
 337
 338 /// A vtable for some object-safe trait `Foo` automatically derived
 339 /// for the object type `Foo`.
 340 #[derive(PartialEq,Eq,Clone)]
 341 pub struct VtableObjectData<'tcx, N> {
 342     /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
 343     pub upcast_trait_ref: ty::PolyTraitRef<'tcx>,
 344
 345     /// The vtable is formed by concatenating together the method lists of
 346     /// the base object trait and all supertraits; this is the start of
 347     /// `upcast_trait_ref`'s methods in that vtable.
 348     pub vtable_base: usize,
 349
 350     pub nested: Vec<N>,
 351 }
 352
 353 #[derive(Clone, PartialEq, Eq)]
 354 pub struct VtableFnPointerData<'tcx, N> {
 355     pub fn_ty: ty::Ty<'tcx>,
 356     pub nested: Vec<N>
 357 }
 358
 359 /// Creates predicate obligations from the generic bounds.
 360 pub fn predicates_for_generics<'tcx>(cause: ObligationCause<'tcx>,
 361                                      generic_bounds: &ty::InstantiatedPredicates<'tcx>)
 362                                      -> PredicateObligations<'tcx>
 363 {
 364     util::predicates_for_generics(cause, 0, generic_bounds)
 365 }
 366
 367 /// Determines whether the type `ty` is known to meet `bound` and
 368 /// returns true if so. Returns false if `ty` either does not meet
 369 /// `bound` or is not known to meet bound (note that this is
 370 /// conservative towards *no impl*, which is the opposite of the
 371 /// `evaluate` methods).
 372 pub fn type_known_to_meet_bound<'a, 'gcx, 'tcx>(infcx: &InferCtxt<'a, 'gcx, 'tcx>,
 373                                                 ty: Ty<'tcx>,
 374                                                 def_id: DefId,
 375                                                 span: Span)
 376 -> bool
 377 {
 378     debug!("type_known_to_meet_bound(ty={:?}, bound={:?})",
 379            ty,
 380            infcx.tcx.item_path_str(def_id));
 381
 382     let trait_ref = ty::TraitRef {
 383         def_id: def_id,
 384         substs: infcx.tcx.mk_substs_trait(ty, &[]),
 385     };
 386     let obligation = Obligation {
 387         cause: ObligationCause::misc(span, ast::DUMMY_NODE_ID),
 388         recursion_depth: 0,
 389         predicate: trait_ref.to_predicate(),
 390     };
 391
 392     let result = SelectionContext::new(infcx)
 393         .evaluate_obligation_conservatively(&obligation);
 394     debug!("type_known_to_meet_ty={:?} bound={} => {:?}",
 395            ty, infcx.tcx.item_path_str(def_id), result);
 396
 397     if result && (ty.has_infer_types() || ty.has_closure_types()) {
 398         // Because of inference "guessing", selection can sometimes claim
 399         // to succeed while the success requires a guess. To ensure
 400         // this function's result remains infallible, we must confirm
 401         // that guess. While imperfect, I believe this is sound.
 402
 403         let mut fulfill_cx = FulfillmentContext::new();
 404
 405         // We can use a dummy node-id here because we won't pay any mind
 406         // to region obligations that arise (there shouldn't really be any
 407         // anyhow).
 408         let cause = ObligationCause::misc(span, ast::DUMMY_NODE_ID);
 409
 410         fulfill_cx.register_bound(infcx, ty, def_id, cause);
 411
 412         // Note: we only assume something is `Copy` if we can
 413         // *definitively* show that it implements `Copy`. Otherwise,
 414         // assume it is move; linear is always ok.
 415         match fulfill_cx.select_all_or_error(infcx) {
 416             Ok(()) => {
 417                 debug!("type_known_to_meet_bound: ty={:?} bound={} success",
 418                        ty,
 419                        infcx.tcx.item_path_str(def_id));
 420                 true
 421             }
 422             Err(e) => {
 423                 debug!("type_known_to_meet_bound: ty={:?} bound={} errors={:?}",
 424                        ty,
 425                        infcx.tcx.item_path_str(def_id),
 426                        e);
 427                 false
 428             }
 429         }
 430     } else {
 431         result
 432     }
 433 }
 434
 435 // FIXME: this is gonna need to be removed ...
 436 /// Normalizes the parameter environment, reporting errors if they occur.
 437 pub fn normalize_param_env_or_error<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 438     unnormalized_env: ty::ParameterEnvironment<'tcx>,
 439     cause: ObligationCause<'tcx>)
 440     -> ty::ParameterEnvironment<'tcx>
 441 {
 442     // I'm not wild about reporting errors here; I'd prefer to
 443     // have the errors get reported at a defined place (e.g.,
 444     // during typeck). Instead I have all parameter
 445     // environments, in effect, going through this function
 446     // and hence potentially reporting errors. This ensurse of
 447     // course that we never forget to normalize (the
 448     // alternative seemed like it would involve a lot of
 449     // manual invocations of this fn -- and then we'd have to
 450     // deal with the errors at each of those sites).
 451     //
 452     // In any case, in practice, typeck constructs all the
 453     // parameter environments once for every fn as it goes,
 454     // and errors will get reported then; so after typeck we
 455     // can be sure that no errors should occur.
 456
 457     let span = cause.span;
 458     let body_id = cause.body_id;
 459
 460     debug!("normalize_param_env_or_error(unnormalized_env={:?})",
 461            unnormalized_env);
 462
 463     let predicates: Vec<_> =
 464         util::elaborate_predicates(tcx, unnormalized_env.caller_bounds.clone())
 465         .filter(|p| !p.is_global()) // (*)
 466         .collect();
 467
 468     // (*) Any predicate like `i32: Trait<u32>` or whatever doesn't
 469     // need to be in the *environment* to be proven, so screen those
 470     // out. This is important for the soundness of inter-fn
 471     // caching. Note though that we should probably check that these
 472     // predicates hold at the point where the environment is
 473     // constructed, but I am not currently doing so out of laziness.
 474     // -nmatsakis
 475
 476     debug!("normalize_param_env_or_error: elaborated-predicates={:?}",
 477            predicates);
 478
 479     let elaborated_env = unnormalized_env.with_caller_bounds(predicates);
 480
 481     tcx.infer_ctxt(elaborated_env, Reveal::UserFacing).enter(|infcx| {
 482         let predicates = match fully_normalize(&infcx, cause,
 483                                                &infcx.parameter_environment.caller_bounds) {
 484             Ok(predicates) => predicates,
 485             Err(errors) => {
 486                 infcx.report_fulfillment_errors(&errors);
 487                 // An unnormalized env is better than nothing.
 488                 return infcx.parameter_environment;
 489             }
 490         };
 491
 492         debug!("normalize_param_env_or_error: normalized predicates={:?}",
 493             predicates);
 494
 495         let free_regions = FreeRegionMap::new();
 496         infcx.resolve_regions_and_report_errors(&free_regions, body_id);
 497         let predicates = match infcx.fully_resolve(&predicates) {
 498             Ok(predicates) => predicates,
 499             Err(fixup_err) => {
 500                 // If we encounter a fixup error, it means that some type
 501                 // variable wound up unconstrained. I actually don't know
 502                 // if this can happen, and I certainly don't expect it to
 503                 // happen often, but if it did happen it probably
 504                 // represents a legitimate failure due to some kind of
 505                 // unconstrained variable, and it seems better not to ICE,
 506                 // all things considered.
 507                 tcx.sess.span_err(span, &fixup_err.to_string());
 508                 // An unnormalized env is better than nothing.
 509                 return infcx.parameter_environment;
 510             }
 511         };
 512
 513         let predicates = match tcx.lift_to_global(&predicates) {
 514             Some(predicates) => predicates,
 515             None => return infcx.parameter_environment
 516         };
 517
 518         debug!("normalize_param_env_or_error: resolved predicates={:?}",
 519             predicates);
 520
 521         infcx.parameter_environment.with_caller_bounds(predicates)
 522     })
 523 }
 524
 525 pub fn fully_normalize<'a, 'gcx, 'tcx, T>(infcx: &InferCtxt<'a, 'gcx, 'tcx>,
 526                                           cause: ObligationCause<'tcx>,
 527                                           value: &T)
 528                                           -> Result<T, Vec<FulfillmentError<'tcx>>>
 529     where T : TypeFoldable<'tcx>
 530 {
 531     debug!("fully_normalize(value={:?})", value);
 532
 533     let mut selcx = &mut SelectionContext::new(infcx);
 534     // FIXME (@jroesch) ISSUE 26721
 535     // I'm not sure if this is a bug or not, needs further investigation.
 536     // It appears that by reusing the fulfillment_cx here we incur more
 537     // obligations and later trip an asssertion on regionck.rs line 337.
 538     //
 539     // The two possibilities I see is:
 540     //      - normalization is not actually fully happening and we
 541     //        have a bug else where
 542     //      - we are adding a duplicate bound into the list causing
 543     //        its size to change.
 544     //
 545     // I think we should probably land this refactor and then come
 546     // back to this is a follow-up patch.
 547     let mut fulfill_cx = FulfillmentContext::new();
 548
 549     let Normalized { value: normalized_value, obligations } =
 550         project::normalize(selcx, cause, value);
 551     debug!("fully_normalize: normalized_value={:?} obligations={:?}",
 552            normalized_value,
 553            obligations);
 554     for obligation in obligations {
 555         fulfill_cx.register_predicate_obligation(selcx.infcx(), obligation);
 556     }
 557
 558     debug!("fully_normalize: select_all_or_error start");
 559     match fulfill_cx.select_all_or_error(infcx) {
 560         Ok(()) => { }
 561         Err(e) => {
 562             debug!("fully_normalize: error={:?}", e);
 563             return Err(e);
 564         }
 565     }
 566     debug!("fully_normalize: select_all_or_error complete");
 567     let resolved_value = infcx.resolve_type_vars_if_possible(&normalized_value);
 568     debug!("fully_normalize: resolved_value={:?}", resolved_value);
 569     Ok(resolved_value)
 570 }
 571
 572 /// Normalizes the predicates and checks whether they hold.  If this
 573 /// returns false, then either normalize encountered an error or one
 574 /// of the predicates did not hold. Used when creating vtables to
 575 /// check for unsatisfiable methods.
 576 pub fn normalize_and_test_predicates<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 577                                                predicates: Vec<ty::Predicate<'tcx>>)
 578                                                -> bool
 579 {
 580     debug!("normalize_and_test_predicates(predicates={:?})",
 581            predicates);
 582
 583     tcx.infer_ctxt((), Reveal::All).enter(|infcx| {
 584         let mut selcx = SelectionContext::new(&infcx);
 585         let mut fulfill_cx = FulfillmentContext::new();
 586         let cause = ObligationCause::dummy();
 587         let Normalized { value: predicates, obligations } =
 588             normalize(&mut selcx, cause.clone(), &predicates);
 589         for obligation in obligations {
 590             fulfill_cx.register_predicate_obligation(&infcx, obligation);
 591         }
 592         for predicate in predicates {
 593             let obligation = Obligation::new(cause.clone(), predicate);
 594             fulfill_cx.register_predicate_obligation(&infcx, obligation);
 595         }
 596
 597         fulfill_cx.select_all_or_error(&infcx).is_ok()
 598     })
 599 }
 600
 601 /// Given a trait `trait_ref`, iterates the vtable entries
 602 /// that come from `trait_ref`, including its supertraits.
 603 #[inline] // FIXME(#35870) Avoid closures being unexported due to impl Trait.
 604 pub fn get_vtable_methods<'a, 'tcx>(
 605     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 606     trait_ref: ty::PolyTraitRef<'tcx>)
 607     -> impl Iterator<Item=Option<(DefId, &'tcx Substs<'tcx>)>> + 'a
 608 {
 609     debug!("get_vtable_methods({:?})", trait_ref);
 610
 611     supertraits(tcx, trait_ref).flat_map(move |trait_ref| {
 612         tcx.populate_implementations_for_trait_if_necessary(trait_ref.def_id());
 613
 614         let trait_methods = tcx.associated_items(trait_ref.def_id())
 615             .filter(|item| item.kind == ty::AssociatedKind::Method);
 616
 617         // Now list each method's DefId and Substs (for within its trait).
 618         // If the method can never be called from this object, produce None.
 619         trait_methods.map(move |trait_method| {
 620             debug!("get_vtable_methods: trait_method={:?}", trait_method);
 621             let def_id = trait_method.def_id;
 622
 623             // Some methods cannot be called on an object; skip those.
 624             if !tcx.is_vtable_safe_method(trait_ref.def_id(), &trait_method) {
 625                 debug!("get_vtable_methods: not vtable safe");
 626                 return None;
 627             }
 628
 629             // the method may have some early-bound lifetimes, add
 630             // regions for those
 631             let substs = Substs::for_item(tcx, def_id,
 632                                           |_, _| tcx.types.re_erased,
 633                                           |def, _| trait_ref.substs().type_for_def(def));
 634
 635             // the trait type may have higher-ranked lifetimes in it;
 636             // so erase them if they appear, so that we get the type
 637             // at some particular call site
 638             let substs = tcx.erase_late_bound_regions_and_normalize(&ty::Binder(substs));
 639
 640             // It's possible that the method relies on where clauses that
 641             // do not hold for this particular set of type parameters.
 642             // Note that this method could then never be called, so we
 643             // do not want to try and trans it, in that case (see #23435).
 644             let predicates = tcx.item_predicates(def_id).instantiate_own(tcx, substs);
 645             if !normalize_and_test_predicates(tcx, predicates.predicates) {
 646                 debug!("get_vtable_methods: predicates do not hold");
 647                 return None;
 648             }
 649
 650             Some((def_id, substs))
 651         })
 652     })
 653 }
 654
 655 impl<'tcx,O> Obligation<'tcx,O> {
 656     pub fn new(cause: ObligationCause<'tcx>,
 657                trait_ref: O)
 658                -> Obligation<'tcx, O>
 659     {
 660         Obligation { cause: cause,
 661                      recursion_depth: 0,
 662                      predicate: trait_ref }
 663     }
 664
 665     fn with_depth(cause: ObligationCause<'tcx>,
 666                   recursion_depth: usize,
 667                   trait_ref: O)
 668                   -> Obligation<'tcx, O>
 669     {
 670         Obligation { cause: cause,
 671                      recursion_depth: recursion_depth,
 672                      predicate: trait_ref }
 673     }
 674
 675     pub fn misc(span: Span, body_id: ast::NodeId, trait_ref: O) -> Obligation<'tcx, O> {
 676         Obligation::new(ObligationCause::misc(span, body_id), trait_ref)
 677     }
 678
 679     pub fn with<P>(&self, value: P) -> Obligation<'tcx,P> {
 680         Obligation { cause: self.cause.clone(),
 681                      recursion_depth: self.recursion_depth,
 682                      predicate: value }
 683     }
 684 }
 685
 686 impl<'tcx> ObligationCause<'tcx> {
 687     pub fn new(span: Span,
 688                body_id: ast::NodeId,
 689                code: ObligationCauseCode<'tcx>)
 690                -> ObligationCause<'tcx> {
 691         ObligationCause { span: span, body_id: body_id, code: code }
 692     }
 693
 694     pub fn misc(span: Span, body_id: ast::NodeId) -> ObligationCause<'tcx> {
 695         ObligationCause { span: span, body_id: body_id, code: MiscObligation }
 696     }
 697
 698     pub fn dummy() -> ObligationCause<'tcx> {
 699         ObligationCause { span: DUMMY_SP, body_id: ast::CRATE_NODE_ID, code: MiscObligation }
 700     }
 701 }
 702
 703 impl<'tcx, N> Vtable<'tcx, N> {
 704     pub fn nested_obligations(self) -> Vec<N> {
 705         match self {
 706             VtableImpl(i) => i.nested,
 707             VtableParam(n) => n,
 708             VtableBuiltin(i) => i.nested,
 709             VtableDefaultImpl(d) => d.nested,
 710             VtableClosure(c) => c.nested,
 711             VtableObject(d) => d.nested,
 712             VtableFnPointer(d) => d.nested,
 713         }
 714     }
 715
 716     fn nested_obligations_mut(&mut self) -> &mut Vec<N> {
 717         match self {
 718             &mut VtableImpl(ref mut i) => &mut i.nested,
 719             &mut VtableParam(ref mut n) => n,
 720             &mut VtableBuiltin(ref mut i) => &mut i.nested,
 721             &mut VtableDefaultImpl(ref mut d) => &mut d.nested,
 722             &mut VtableClosure(ref mut c) => &mut c.nested,
 723             &mut VtableObject(ref mut d) => &mut d.nested,
 724             &mut VtableFnPointer(ref mut d) => &mut d.nested,
 725         }
 726     }
 727
 728     pub fn map<M, F>(self, f: F) -> Vtable<'tcx, M> where F: FnMut(N) -> M {
 729         match self {
 730             VtableImpl(i) => VtableImpl(VtableImplData {
 731                 impl_def_id: i.impl_def_id,
 732                 substs: i.substs,
 733                 nested: i.nested.into_iter().map(f).collect(),
 734             }),
 735             VtableParam(n) => VtableParam(n.into_iter().map(f).collect()),
 736             VtableBuiltin(i) => VtableBuiltin(VtableBuiltinData {
 737                 nested: i.nested.into_iter().map(f).collect(),
 738             }),
 739             VtableObject(o) => VtableObject(VtableObjectData {
 740                 upcast_trait_ref: o.upcast_trait_ref,
 741                 vtable_base: o.vtable_base,
 742                 nested: o.nested.into_iter().map(f).collect(),
 743             }),
 744             VtableDefaultImpl(d) => VtableDefaultImpl(VtableDefaultImplData {
 745                 trait_def_id: d.trait_def_id,
 746                 nested: d.nested.into_iter().map(f).collect(),
 747             }),
 748             VtableFnPointer(p) => VtableFnPointer(VtableFnPointerData {
 749                 fn_ty: p.fn_ty,
 750                 nested: p.nested.into_iter().map(f).collect(),
 751             }),
 752             VtableClosure(c) => VtableClosure(VtableClosureData {
 753                 closure_def_id: c.closure_def_id,
 754                 substs: c.substs,
 755                 nested: c.nested.into_iter().map(f).collect(),
 756             })
 757         }
 758     }
 759 }
 760
 761 impl<'tcx> FulfillmentError<'tcx> {
 762     fn new(obligation: PredicateObligation<'tcx>,
 763            code: FulfillmentErrorCode<'tcx>)
 764            -> FulfillmentError<'tcx>
 765     {
 766         FulfillmentError { obligation: obligation, code: code }
 767     }
 768 }
 769
 770 impl<'tcx> TraitObligation<'tcx> {
 771     fn self_ty(&self) -> ty::Binder<Ty<'tcx>> {
 772         ty::Binder(self.predicate.skip_binder().self_ty())
 773     }
 774 }