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