compiler/rustc_middle/src/traits/mod.rs

   1 //! Trait Resolution. See the [rustc dev guide] for more information on how this works.
   2 //!
   3 //! [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/resolution.html
   4
   5 mod chalk;
   6 pub mod query;
   7 pub mod select;
   8 pub mod specialization_graph;
   9 mod structural_impls;
  10 pub mod util;
  11
  12 use crate::infer::canonical::Canonical;
  13 use crate::mir::ConstraintCategory;
  14 use crate::ty::abstract_const::NotConstEvaluatable;
  15 use crate::ty::subst::SubstsRef;
  16 use crate::ty::{self, AdtKind, Ty, TyCtxt};
  17
  18 use rustc_data_structures::sync::Lrc;
  19 use rustc_errors::{Applicability, Diagnostic};
  20 use rustc_hir as hir;
  21 use rustc_hir::def_id::{DefId, LocalDefId};
  22 use rustc_span::symbol::Symbol;
  23 use rustc_span::{Span, DUMMY_SP};
  24 use smallvec::SmallVec;
  25
  26 use std::borrow::Cow;
  27 use std::hash::{Hash, Hasher};
  28
  29 pub use self::select::{EvaluationCache, EvaluationResult, OverflowError, SelectionCache};
  30
  31 pub type CanonicalChalkEnvironmentAndGoal<'tcx> = Canonical<'tcx, ChalkEnvironmentAndGoal<'tcx>>;
  32
  33 pub use self::ObligationCauseCode::*;
  34
  35 pub use self::chalk::{ChalkEnvironmentAndGoal, RustInterner as ChalkRustInterner};
  36
  37 /// Depending on the stage of compilation, we want projection to be
  38 /// more or less conservative.
  39 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, HashStable)]
  40 pub enum Reveal {
  41     /// At type-checking time, we refuse to project any associated
  42     /// type that is marked `default`. Non-`default` ("final") types
  43     /// are always projected. This is necessary in general for
  44     /// soundness of specialization. However, we *could* allow
  45     /// projections in fully-monomorphic cases. We choose not to,
  46     /// because we prefer for `default type` to force the type
  47     /// definition to be treated abstractly by any consumers of the
  48     /// impl. Concretely, that means that the following example will
  49     /// fail to compile:
  50     ///
  51     /// ```compile_fail,E0308
  52     /// #![feature(specialization)]
  53     /// trait Assoc {
  54     ///     type Output;
  55     /// }
  56     ///
  57     /// impl<T> Assoc for T {
  58     ///     default type Output = bool;
  59     /// }
  60     ///
  61     /// fn main() {
  62     ///     let x: <() as Assoc>::Output = true;
  63     /// }
  64     /// ```
  65     ///
  66     /// We also do not reveal the hidden type of opaque types during
  67     /// type-checking.
  68     UserFacing,
  69
  70     /// At codegen time, all monomorphic projections will succeed.
  71     /// Also, `impl Trait` is normalized to the concrete type,
  72     /// which has to be already collected by type-checking.
  73     ///
  74     /// NOTE: as `impl Trait`'s concrete type should *never*
  75     /// be observable directly by the user, `Reveal::All`
  76     /// should not be used by checks which may expose
  77     /// type equality or type contents to the user.
  78     /// There are some exceptions, e.g., around auto traits and
  79     /// transmute-checking, which expose some details, but
  80     /// not the whole concrete type of the `impl Trait`.
  81     All,
  82 }
  83
  84 /// The reason why we incurred this obligation; used for error reporting.
  85 ///
  86 /// Non-misc `ObligationCauseCode`s are stored on the heap. This gives the
  87 /// best trade-off between keeping the type small (which makes copies cheaper)
  88 /// while not doing too many heap allocations.
  89 ///
  90 /// We do not want to intern this as there are a lot of obligation causes which
  91 /// only live for a short period of time.
  92 #[derive(Clone, Debug, PartialEq, Eq, Lift)]
  93 pub struct ObligationCause<'tcx> {
  94     pub span: Span,
  95
  96     /// The ID of the fn body that triggered this obligation. This is
  97     /// used for region obligations to determine the precise
  98     /// environment in which the region obligation should be evaluated
  99     /// (in particular, closures can add new assumptions). See the
 100     /// field `region_obligations` of the `FulfillmentContext` for more
 101     /// information.
 102     pub body_id: hir::HirId,
 103
 104     code: InternedObligationCauseCode<'tcx>,
 105 }
 106
 107 // This custom hash function speeds up hashing for `Obligation` deduplication
 108 // greatly by skipping the `code` field, which can be large and complex. That
 109 // shouldn't affect hash quality much since there are several other fields in
 110 // `Obligation` which should be unique enough, especially the predicate itself
 111 // which is hashed as an interned pointer. See #90996.
 112 impl Hash for ObligationCause<'_> {
 113     fn hash<H: Hasher>(&self, state: &mut H) {
 114         self.body_id.hash(state);
 115         self.span.hash(state);
 116     }
 117 }
 118
 119 impl<'tcx> ObligationCause<'tcx> {
 120     #[inline]
 121     pub fn new(
 122         span: Span,
 123         body_id: hir::HirId,
 124         code: ObligationCauseCode<'tcx>,
 125     ) -> ObligationCause<'tcx> {
 126         ObligationCause { span, body_id, code: code.into() }
 127     }
 128
 129     pub fn misc(span: Span, body_id: hir::HirId) -> ObligationCause<'tcx> {
 130         ObligationCause::new(span, body_id, MiscObligation)
 131     }
 132
 133     #[inline(always)]
 134     pub fn dummy() -> ObligationCause<'tcx> {
 135         ObligationCause::dummy_with_span(DUMMY_SP)
 136     }
 137
 138     #[inline(always)]
 139     pub fn dummy_with_span(span: Span) -> ObligationCause<'tcx> {
 140         ObligationCause { span, body_id: hir::CRATE_HIR_ID, code: Default::default() }
 141     }
 142
 143     pub fn span(&self) -> Span {
 144         match *self.code() {
 145             ObligationCauseCode::MatchExpressionArm(box MatchExpressionArmCause {
 146                 arm_span,
 147                 ..
 148             }) => arm_span,
 149             _ => self.span,
 150         }
 151     }
 152
 153     #[inline]
 154     pub fn code(&self) -> &ObligationCauseCode<'tcx> {
 155         &self.code
 156     }
 157
 158     pub fn map_code(
 159         &mut self,
 160         f: impl FnOnce(InternedObligationCauseCode<'tcx>) -> ObligationCauseCode<'tcx>,
 161     ) {
 162         self.code = f(std::mem::take(&mut self.code)).into();
 163     }
 164
 165     pub fn derived_cause(
 166         mut self,
 167         parent_trait_pred: ty::PolyTraitPredicate<'tcx>,
 168         variant: impl FnOnce(DerivedObligationCause<'tcx>) -> ObligationCauseCode<'tcx>,
 169     ) -> ObligationCause<'tcx> {
 170         /*!
 171          * Creates a cause for obligations that are derived from
 172          * `obligation` by a recursive search (e.g., for a builtin
 173          * bound, or eventually a `auto trait Foo`). If `obligation`
 174          * is itself a derived obligation, this is just a clone, but
 175          * otherwise we create a "derived obligation" cause so as to
 176          * keep track of the original root obligation for error
 177          * reporting.
 178          */
 179
 180         // NOTE(flaper87): As of now, it keeps track of the whole error
 181         // chain. Ideally, we should have a way to configure this either
 182         // by using -Z verbose or just a CLI argument.
 183         self.code =
 184             variant(DerivedObligationCause { parent_trait_pred, parent_code: self.code }).into();
 185         self
 186     }
 187
 188     pub fn to_constraint_category(&self) -> ConstraintCategory<'tcx> {
 189         match self.code() {
 190             MatchImpl(cause, _) => cause.to_constraint_category(),
 191             AscribeUserTypeProvePredicate(predicate_span) => {
 192                 ConstraintCategory::Predicate(*predicate_span)
 193             }
 194             _ => ConstraintCategory::BoringNoLocation,
 195         }
 196     }
 197 }
 198
 199 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 200 pub struct UnifyReceiverContext<'tcx> {
 201     pub assoc_item: ty::AssocItem,
 202     pub param_env: ty::ParamEnv<'tcx>,
 203     pub substs: SubstsRef<'tcx>,
 204 }
 205
 206 #[derive(Clone, PartialEq, Eq, Hash, Lift, Default)]
 207 pub struct InternedObligationCauseCode<'tcx> {
 208     /// `None` for `ObligationCauseCode::MiscObligation` (a common case, occurs ~60% of
 209     /// the time). `Some` otherwise.
 210     code: Option<Lrc<ObligationCauseCode<'tcx>>>,
 211 }
 212
 213 impl<'tcx> std::fmt::Debug for InternedObligationCauseCode<'tcx> {
 214     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 215         let cause: &ObligationCauseCode<'_> = self;
 216         cause.fmt(f)
 217     }
 218 }
 219
 220 impl<'tcx> ObligationCauseCode<'tcx> {
 221     #[inline(always)]
 222     fn into(self) -> InternedObligationCauseCode<'tcx> {
 223         InternedObligationCauseCode {
 224             code: if let ObligationCauseCode::MiscObligation = self {
 225                 None
 226             } else {
 227                 Some(Lrc::new(self))
 228             },
 229         }
 230     }
 231 }
 232
 233 impl<'tcx> std::ops::Deref for InternedObligationCauseCode<'tcx> {
 234     type Target = ObligationCauseCode<'tcx>;
 235
 236     fn deref(&self) -> &Self::Target {
 237         self.code.as_deref().unwrap_or(&ObligationCauseCode::MiscObligation)
 238     }
 239 }
 240
 241 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 242 pub enum ObligationCauseCode<'tcx> {
 243     /// Not well classified or should be obvious from the span.
 244     MiscObligation,
 245
 246     /// A slice or array is WF only if `T: Sized`.
 247     SliceOrArrayElem,
 248
 249     /// A tuple is WF only if its middle elements are `Sized`.
 250     TupleElem,
 251
 252     /// This is the trait reference from the given projection.
 253     ProjectionWf(ty::ProjectionTy<'tcx>),
 254
 255     /// Must satisfy all of the where-clause predicates of the
 256     /// given item.
 257     ItemObligation(DefId),
 258
 259     /// Like `ItemObligation`, but carries the span of the
 260     /// predicate when it can be identified.
 261     BindingObligation(DefId, Span),
 262
 263     /// Like `ItemObligation`, but carries the `HirId` of the
 264     /// expression that caused the obligation, and the `usize`
 265     /// indicates exactly which predicate it is in the list of
 266     /// instantiated predicates.
 267     ExprItemObligation(DefId, rustc_hir::HirId, usize),
 268
 269     /// Combines `ExprItemObligation` and `BindingObligation`.
 270     ExprBindingObligation(DefId, Span, rustc_hir::HirId, usize),
 271
 272     /// A type like `&'a T` is WF only if `T: 'a`.
 273     ReferenceOutlivesReferent(Ty<'tcx>),
 274
 275     /// A type like `Box<Foo<'a> + 'b>` is WF only if `'b: 'a`.
 276     ObjectTypeBound(Ty<'tcx>, ty::Region<'tcx>),
 277
 278     /// Obligation incurred due to an object cast.
 279     ObjectCastObligation(/* Concrete type */ Ty<'tcx>, /* Object type */ Ty<'tcx>),
 280
 281     /// Obligation incurred due to a coercion.
 282     Coercion {
 283         source: Ty<'tcx>,
 284         target: Ty<'tcx>,
 285     },
 286
 287     /// Various cases where expressions must be `Sized` / `Copy` / etc.
 288     /// `L = X` implies that `L` is `Sized`.
 289     AssignmentLhsSized,
 290     /// `(x1, .., xn)` must be `Sized`.
 291     TupleInitializerSized,
 292     /// `S { ... }` must be `Sized`.
 293     StructInitializerSized,
 294     /// Type of each variable must be `Sized`.
 295     VariableType(hir::HirId),
 296     /// Argument type must be `Sized`.
 297     SizedArgumentType(Option<Span>),
 298     /// Return type must be `Sized`.
 299     SizedReturnType,
 300     /// Yield type must be `Sized`.
 301     SizedYieldType,
 302     /// Box expression result type must be `Sized`.
 303     SizedBoxType,
 304     /// Inline asm operand type must be `Sized`.
 305     InlineAsmSized,
 306     /// `[expr; N]` requires `type_of(expr): Copy`.
 307     RepeatElementCopy {
 308         /// If element is a `const fn` we display a help message suggesting to move the
 309         /// function call to a new `const` item while saying that `T` doesn't implement `Copy`.
 310         is_const_fn: bool,
 311     },
 312
 313     /// Types of fields (other than the last, except for packed structs) in a struct must be sized.
 314     FieldSized {
 315         adt_kind: AdtKind,
 316         span: Span,
 317         last: bool,
 318     },
 319
 320     /// Constant expressions must be sized.
 321     ConstSized,
 322
 323     /// `static` items must have `Sync` type.
 324     SharedStatic,
 325
 326     BuiltinDerivedObligation(DerivedObligationCause<'tcx>),
 327
 328     ImplDerivedObligation(Box<ImplDerivedObligationCause<'tcx>>),
 329
 330     DerivedObligation(DerivedObligationCause<'tcx>),
 331
 332     FunctionArgumentObligation {
 333         /// The node of the relevant argument in the function call.
 334         arg_hir_id: hir::HirId,
 335         /// The node of the function call.
 336         call_hir_id: hir::HirId,
 337         /// The obligation introduced by this argument.
 338         parent_code: InternedObligationCauseCode<'tcx>,
 339     },
 340
 341     /// Error derived when matching traits/impls; see ObligationCause for more details
 342     CompareImplItemObligation {
 343         impl_item_def_id: LocalDefId,
 344         trait_item_def_id: DefId,
 345         kind: ty::AssocKind,
 346     },
 347
 348     /// Checking that the bounds of a trait's associated type hold for a given impl
 349     CheckAssociatedTypeBounds {
 350         impl_item_def_id: LocalDefId,
 351         trait_item_def_id: DefId,
 352     },
 353
 354     /// Checking that this expression can be assigned to its target.
 355     ExprAssignable,
 356
 357     /// Computing common supertype in the arms of a match expression
 358     MatchExpressionArm(Box<MatchExpressionArmCause<'tcx>>),
 359
 360     /// Type error arising from type checking a pattern against an expected type.
 361     Pattern {
 362         /// The span of the scrutinee or type expression which caused the `root_ty` type.
 363         span: Option<Span>,
 364         /// The root expected type induced by a scrutinee or type expression.
 365         root_ty: Ty<'tcx>,
 366         /// Whether the `Span` came from an expression or a type expression.
 367         origin_expr: bool,
 368     },
 369
 370     /// Constants in patterns must have `Structural` type.
 371     ConstPatternStructural,
 372
 373     /// Computing common supertype in an if expression
 374     IfExpression(Box<IfExpressionCause<'tcx>>),
 375
 376     /// Computing common supertype of an if expression with no else counter-part
 377     IfExpressionWithNoElse,
 378
 379     /// `main` has wrong type
 380     MainFunctionType,
 381
 382     /// `start` has wrong type
 383     StartFunctionType,
 384
 385     /// Intrinsic has wrong type
 386     IntrinsicType,
 387
 388     /// A let else block does not diverge
 389     LetElse,
 390
 391     /// Method receiver
 392     MethodReceiver,
 393
 394     UnifyReceiver(Box<UnifyReceiverContext<'tcx>>),
 395
 396     /// `return` with no expression
 397     ReturnNoExpression,
 398
 399     /// `return` with an expression
 400     ReturnValue(hir::HirId),
 401
 402     /// Return type of this function
 403     ReturnType,
 404
 405     /// Opaque return type of this function
 406     OpaqueReturnType(Option<(Ty<'tcx>, Span)>),
 407
 408     /// Block implicit return
 409     BlockTailExpression(hir::HirId),
 410
 411     /// #[feature(trivial_bounds)] is not enabled
 412     TrivialBound,
 413
 414     /// If `X` is the concrete type of an opaque type `impl Y`, then `X` must implement `Y`
 415     OpaqueType,
 416
 417     AwaitableExpr(Option<hir::HirId>),
 418
 419     ForLoopIterator,
 420
 421     QuestionMark,
 422
 423     /// Well-formed checking. If a `WellFormedLoc` is provided,
 424     /// then it will be used to perform HIR-based wf checking
 425     /// after an error occurs, in order to generate a more precise error span.
 426     /// This is purely for diagnostic purposes - it is always
 427     /// correct to use `MiscObligation` instead, or to specify
 428     /// `WellFormed(None)`
 429     WellFormed(Option<WellFormedLoc>),
 430
 431     /// From `match_impl`. The cause for us having to match an impl, and the DefId we are matching against.
 432     MatchImpl(ObligationCause<'tcx>, DefId),
 433
 434     BinOp {
 435         rhs_span: Option<Span>,
 436         is_lit: bool,
 437         output_ty: Option<Ty<'tcx>>,
 438     },
 439
 440     AscribeUserTypeProvePredicate(Span),
 441
 442     RustCall,
 443 }
 444
 445 /// The 'location' at which we try to perform HIR-based wf checking.
 446 /// This information is used to obtain an `hir::Ty`, which
 447 /// we can walk in order to obtain precise spans for any
 448 /// 'nested' types (e.g. `Foo` in `Option<Foo>`).
 449 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
 450 pub enum WellFormedLoc {
 451     /// Use the type of the provided definition.
 452     Ty(LocalDefId),
 453     /// Use the type of the parameter of the provided function.
 454     /// We cannot use `hir::Param`, since the function may
 455     /// not have a body (e.g. a trait method definition)
 456     Param {
 457         /// The function to lookup the parameter in
 458         function: LocalDefId,
 459         /// The index of the parameter to use.
 460         /// Parameters are indexed from 0, with the return type
 461         /// being the last 'parameter'
 462         param_idx: u16,
 463     },
 464 }
 465
 466 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 467 pub struct ImplDerivedObligationCause<'tcx> {
 468     pub derived: DerivedObligationCause<'tcx>,
 469     pub impl_def_id: DefId,
 470     pub span: Span,
 471 }
 472
 473 impl<'tcx> ObligationCauseCode<'tcx> {
 474     // Return the base obligation, ignoring derived obligations.
 475     pub fn peel_derives(&self) -> &Self {
 476         let mut base_cause = self;
 477         while let Some((parent_code, _)) = base_cause.parent() {
 478             base_cause = parent_code;
 479         }
 480         base_cause
 481     }
 482
 483     pub fn parent(&self) -> Option<(&Self, Option<ty::PolyTraitPredicate<'tcx>>)> {
 484         match self {
 485             FunctionArgumentObligation { parent_code, .. } => Some((parent_code, None)),
 486             BuiltinDerivedObligation(derived)
 487             | DerivedObligation(derived)
 488             | ImplDerivedObligation(box ImplDerivedObligationCause { derived, .. }) => {
 489                 Some((&derived.parent_code, Some(derived.parent_trait_pred)))
 490             }
 491             _ => None,
 492         }
 493     }
 494
 495     pub fn peel_match_impls(&self) -> &Self {
 496         match self {
 497             MatchImpl(cause, _) => cause.code(),
 498             _ => self,
 499         }
 500     }
 501 }
 502
 503 // `ObligationCauseCode` is used a lot. Make sure it doesn't unintentionally get bigger.
 504 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 505 static_assert_size!(ObligationCauseCode<'_>, 48);
 506
 507 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
 508 pub enum StatementAsExpression {
 509     CorrectType,
 510     NeedsBoxing,
 511 }
 512
 513 impl<'tcx> ty::Lift<'tcx> for StatementAsExpression {
 514     type Lifted = StatementAsExpression;
 515     fn lift_to_tcx(self, _tcx: TyCtxt<'tcx>) -> Option<StatementAsExpression> {
 516         Some(self)
 517     }
 518 }
 519
 520 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 521 pub struct MatchExpressionArmCause<'tcx> {
 522     pub arm_block_id: Option<hir::HirId>,
 523     pub arm_ty: Ty<'tcx>,
 524     pub arm_span: Span,
 525     pub prior_arm_block_id: Option<hir::HirId>,
 526     pub prior_arm_ty: Ty<'tcx>,
 527     pub prior_arm_span: Span,
 528     pub scrut_span: Span,
 529     pub source: hir::MatchSource,
 530     pub prior_arms: Vec<Span>,
 531     pub scrut_hir_id: hir::HirId,
 532     pub opt_suggest_box_span: Option<Span>,
 533 }
 534
 535 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
 536 #[derive(Lift, TypeFoldable, TypeVisitable)]
 537 pub struct IfExpressionCause<'tcx> {
 538     pub then_id: hir::HirId,
 539     pub else_id: hir::HirId,
 540     pub then_ty: Ty<'tcx>,
 541     pub else_ty: Ty<'tcx>,
 542     pub outer_span: Option<Span>,
 543     pub opt_suggest_box_span: Option<Span>,
 544 }
 545
 546 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 547 pub struct DerivedObligationCause<'tcx> {
 548     /// The trait predicate of the parent obligation that led to the
 549     /// current obligation. Note that only trait obligations lead to
 550     /// derived obligations, so we just store the trait predicate here
 551     /// directly.
 552     pub parent_trait_pred: ty::PolyTraitPredicate<'tcx>,
 553
 554     /// The parent trait had this cause.
 555     pub parent_code: InternedObligationCauseCode<'tcx>,
 556 }
 557
 558 #[derive(Clone, Debug, TypeFoldable, TypeVisitable, Lift)]
 559 pub enum SelectionError<'tcx> {
 560     /// The trait is not implemented.
 561     Unimplemented,
 562     /// After a closure impl has selected, its "outputs" were evaluated
 563     /// (which for closures includes the "input" type params) and they
 564     /// didn't resolve. See `confirm_poly_trait_refs` for more.
 565     OutputTypeParameterMismatch(
 566         ty::PolyTraitRef<'tcx>,
 567         ty::PolyTraitRef<'tcx>,
 568         ty::error::TypeError<'tcx>,
 569     ),
 570     /// The trait pointed by `DefId` is not object safe.
 571     TraitNotObjectSafe(DefId),
 572     /// A given constant couldn't be evaluated.
 573     NotConstEvaluatable(NotConstEvaluatable),
 574     /// Exceeded the recursion depth during type projection.
 575     Overflow(OverflowError),
 576     /// Signaling that an error has already been emitted, to avoid
 577     /// multiple errors being shown.
 578     ErrorReporting,
 579 }
 580
 581 /// When performing resolution, it is typically the case that there
 582 /// can be one of three outcomes:
 583 ///
 584 /// - `Ok(Some(r))`: success occurred with result `r`
 585 /// - `Ok(None)`: could not definitely determine anything, usually due
 586 ///   to inconclusive type inference.
 587 /// - `Err(e)`: error `e` occurred
 588 pub type SelectionResult<'tcx, T> = Result<Option<T>, SelectionError<'tcx>>;
 589
 590 /// Given the successful resolution of an obligation, the `ImplSource`
 591 /// indicates where the impl comes from.
 592 ///
 593 /// For example, the obligation may be satisfied by a specific impl (case A),
 594 /// or it may be relative to some bound that is in scope (case B).
 595 ///
 596 /// ```ignore (illustrative)
 597 /// impl<T:Clone> Clone<T> for Option<T> { ... } // Impl_1
 598 /// impl<T:Clone> Clone<T> for Box<T> { ... }    // Impl_2
 599 /// impl Clone for i32 { ... }                   // Impl_3
 600 ///
 601 /// fn foo<T: Clone>(concrete: Option<Box<i32>>, param: T, mixed: Option<T>) {
 602 ///     // Case A: ImplSource points at a specific impl. Only possible when
 603 ///     // type is concretely known. If the impl itself has bounded
 604 ///     // type parameters, ImplSource will carry resolutions for those as well:
 605 ///     concrete.clone(); // ImplSource(Impl_1, [ImplSource(Impl_2, [ImplSource(Impl_3)])])
 606 ///
 607 ///     // Case B: ImplSource must be provided by caller. This applies when
 608 ///     // type is a type parameter.
 609 ///     param.clone();    // ImplSource::Param
 610 ///
 611 ///     // Case C: A mix of cases A and B.
 612 ///     mixed.clone();    // ImplSource(Impl_1, [ImplSource::Param])
 613 /// }
 614 /// ```
 615 ///
 616 /// ### The type parameter `N`
 617 ///
 618 /// See explanation on `ImplSourceUserDefinedData`.
 619 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 620 #[derive(TypeFoldable, TypeVisitable)]
 621 pub enum ImplSource<'tcx, N> {
 622     /// ImplSource identifying a particular impl.
 623     UserDefined(ImplSourceUserDefinedData<'tcx, N>),
 624
 625     /// ImplSource for auto trait implementations.
 626     /// This carries the information and nested obligations with regards
 627     /// to an auto implementation for a trait `Trait`. The nested obligations
 628     /// ensure the trait implementation holds for all the constituent types.
 629     AutoImpl(ImplSourceAutoImplData<N>),
 630
 631     /// Successful resolution to an obligation provided by the caller
 632     /// for some type parameter. The `Vec<N>` represents the
 633     /// obligations incurred from normalizing the where-clause (if
 634     /// any).
 635     Param(Vec<N>, ty::BoundConstness),
 636
 637     /// Virtual calls through an object.
 638     Object(ImplSourceObjectData<'tcx, N>),
 639
 640     /// Successful resolution for a builtin trait.
 641     Builtin(ImplSourceBuiltinData<N>),
 642
 643     /// ImplSource for trait upcasting coercion
 644     TraitUpcasting(ImplSourceTraitUpcastingData<'tcx, N>),
 645
 646     /// ImplSource automatically generated for a closure. The `DefId` is the ID
 647     /// of the closure expression. This is an `ImplSource::UserDefined` in spirit, but the
 648     /// impl is generated by the compiler and does not appear in the source.
 649     Closure(ImplSourceClosureData<'tcx, N>),
 650
 651     /// Same as above, but for a function pointer type with the given signature.
 652     FnPointer(ImplSourceFnPointerData<'tcx, N>),
 653
 654     /// ImplSource for a builtin `DeterminantKind` trait implementation.
 655     DiscriminantKind(ImplSourceDiscriminantKindData),
 656
 657     /// ImplSource for a builtin `Pointee` trait implementation.
 658     Pointee(ImplSourcePointeeData),
 659
 660     /// ImplSource automatically generated for a generator.
 661     Generator(ImplSourceGeneratorData<'tcx, N>),
 662
 663     /// ImplSource automatically generated for a generator backing an async future.
 664     Future(ImplSourceFutureData<'tcx, N>),
 665
 666     /// ImplSource for a trait alias.
 667     TraitAlias(ImplSourceTraitAliasData<'tcx, N>),
 668
 669     /// ImplSource for a `const Drop` implementation.
 670     ConstDestruct(ImplSourceConstDestructData<N>),
 671 }
 672
 673 impl<'tcx, N> ImplSource<'tcx, N> {
 674     pub fn nested_obligations(self) -> Vec<N> {
 675         match self {
 676             ImplSource::UserDefined(i) => i.nested,
 677             ImplSource::Param(n, _) => n,
 678             ImplSource::Builtin(i) => i.nested,
 679             ImplSource::AutoImpl(d) => d.nested,
 680             ImplSource::Closure(c) => c.nested,
 681             ImplSource::Generator(c) => c.nested,
 682             ImplSource::Future(c) => c.nested,
 683             ImplSource::Object(d) => d.nested,
 684             ImplSource::FnPointer(d) => d.nested,
 685             ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData)
 686             | ImplSource::Pointee(ImplSourcePointeeData) => vec![],
 687             ImplSource::TraitAlias(d) => d.nested,
 688             ImplSource::TraitUpcasting(d) => d.nested,
 689             ImplSource::ConstDestruct(i) => i.nested,
 690         }
 691     }
 692
 693     pub fn borrow_nested_obligations(&self) -> &[N] {
 694         match &self {
 695             ImplSource::UserDefined(i) => &i.nested[..],
 696             ImplSource::Param(n, _) => &n,
 697             ImplSource::Builtin(i) => &i.nested,
 698             ImplSource::AutoImpl(d) => &d.nested,
 699             ImplSource::Closure(c) => &c.nested,
 700             ImplSource::Generator(c) => &c.nested,
 701             ImplSource::Future(c) => &c.nested,
 702             ImplSource::Object(d) => &d.nested,
 703             ImplSource::FnPointer(d) => &d.nested,
 704             ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData)
 705             | ImplSource::Pointee(ImplSourcePointeeData) => &[],
 706             ImplSource::TraitAlias(d) => &d.nested,
 707             ImplSource::TraitUpcasting(d) => &d.nested,
 708             ImplSource::ConstDestruct(i) => &i.nested,
 709         }
 710     }
 711
 712     pub fn map<M, F>(self, f: F) -> ImplSource<'tcx, M>
 713     where
 714         F: FnMut(N) -> M,
 715     {
 716         match self {
 717             ImplSource::UserDefined(i) => ImplSource::UserDefined(ImplSourceUserDefinedData {
 718                 impl_def_id: i.impl_def_id,
 719                 substs: i.substs,
 720                 nested: i.nested.into_iter().map(f).collect(),
 721             }),
 722             ImplSource::Param(n, ct) => ImplSource::Param(n.into_iter().map(f).collect(), ct),
 723             ImplSource::Builtin(i) => ImplSource::Builtin(ImplSourceBuiltinData {
 724                 nested: i.nested.into_iter().map(f).collect(),
 725             }),
 726             ImplSource::Object(o) => ImplSource::Object(ImplSourceObjectData {
 727                 upcast_trait_ref: o.upcast_trait_ref,
 728                 vtable_base: o.vtable_base,
 729                 nested: o.nested.into_iter().map(f).collect(),
 730             }),
 731             ImplSource::AutoImpl(d) => ImplSource::AutoImpl(ImplSourceAutoImplData {
 732                 trait_def_id: d.trait_def_id,
 733                 nested: d.nested.into_iter().map(f).collect(),
 734             }),
 735             ImplSource::Closure(c) => ImplSource::Closure(ImplSourceClosureData {
 736                 closure_def_id: c.closure_def_id,
 737                 substs: c.substs,
 738                 nested: c.nested.into_iter().map(f).collect(),
 739             }),
 740             ImplSource::Generator(c) => ImplSource::Generator(ImplSourceGeneratorData {
 741                 generator_def_id: c.generator_def_id,
 742                 substs: c.substs,
 743                 nested: c.nested.into_iter().map(f).collect(),
 744             }),
 745             ImplSource::Future(c) => ImplSource::Future(ImplSourceFutureData {
 746                 generator_def_id: c.generator_def_id,
 747                 substs: c.substs,
 748                 nested: c.nested.into_iter().map(f).collect(),
 749             }),
 750             ImplSource::FnPointer(p) => ImplSource::FnPointer(ImplSourceFnPointerData {
 751                 fn_ty: p.fn_ty,
 752                 nested: p.nested.into_iter().map(f).collect(),
 753             }),
 754             ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => {
 755                 ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData)
 756             }
 757             ImplSource::Pointee(ImplSourcePointeeData) => {
 758                 ImplSource::Pointee(ImplSourcePointeeData)
 759             }
 760             ImplSource::TraitAlias(d) => ImplSource::TraitAlias(ImplSourceTraitAliasData {
 761                 alias_def_id: d.alias_def_id,
 762                 substs: d.substs,
 763                 nested: d.nested.into_iter().map(f).collect(),
 764             }),
 765             ImplSource::TraitUpcasting(d) => {
 766                 ImplSource::TraitUpcasting(ImplSourceTraitUpcastingData {
 767                     upcast_trait_ref: d.upcast_trait_ref,
 768                     vtable_vptr_slot: d.vtable_vptr_slot,
 769                     nested: d.nested.into_iter().map(f).collect(),
 770                 })
 771             }
 772             ImplSource::ConstDestruct(i) => {
 773                 ImplSource::ConstDestruct(ImplSourceConstDestructData {
 774                     nested: i.nested.into_iter().map(f).collect(),
 775                 })
 776             }
 777         }
 778     }
 779 }
 780
 781 /// Identifies a particular impl in the source, along with a set of
 782 /// substitutions from the impl's type/lifetime parameters. The
 783 /// `nested` vector corresponds to the nested obligations attached to
 784 /// the impl's type parameters.
 785 ///
 786 /// The type parameter `N` indicates the type used for "nested
 787 /// obligations" that are required by the impl. During type-check, this
 788 /// is `Obligation`, as one might expect. During codegen, however, this
 789 /// is `()`, because codegen only requires a shallow resolution of an
 790 /// impl, and nested obligations are satisfied later.
 791 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 792 #[derive(TypeFoldable, TypeVisitable)]
 793 pub struct ImplSourceUserDefinedData<'tcx, N> {
 794     pub impl_def_id: DefId,
 795     pub substs: SubstsRef<'tcx>,
 796     pub nested: Vec<N>,
 797 }
 798
 799 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 800 #[derive(TypeFoldable, TypeVisitable)]
 801 pub struct ImplSourceGeneratorData<'tcx, N> {
 802     pub generator_def_id: DefId,
 803     pub substs: SubstsRef<'tcx>,
 804     /// Nested obligations. This can be non-empty if the generator
 805     /// signature contains associated types.
 806     pub nested: Vec<N>,
 807 }
 808
 809 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 810 #[derive(TypeFoldable, TypeVisitable)]
 811 pub struct ImplSourceFutureData<'tcx, N> {
 812     pub generator_def_id: DefId,
 813     pub substs: SubstsRef<'tcx>,
 814     /// Nested obligations. This can be non-empty if the generator
 815     /// signature contains associated types.
 816     pub nested: Vec<N>,
 817 }
 818
 819 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 820 #[derive(TypeFoldable, TypeVisitable)]
 821 pub struct ImplSourceClosureData<'tcx, N> {
 822     pub closure_def_id: DefId,
 823     pub substs: SubstsRef<'tcx>,
 824     /// Nested obligations. This can be non-empty if the closure
 825     /// signature contains associated types.
 826     pub nested: Vec<N>,
 827 }
 828
 829 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 830 #[derive(TypeFoldable, TypeVisitable)]
 831 pub struct ImplSourceAutoImplData<N> {
 832     pub trait_def_id: DefId,
 833     pub nested: Vec<N>,
 834 }
 835
 836 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 837 #[derive(TypeFoldable, TypeVisitable)]
 838 pub struct ImplSourceTraitUpcastingData<'tcx, N> {
 839     /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
 840     pub upcast_trait_ref: ty::PolyTraitRef<'tcx>,
 841
 842     /// The vtable is formed by concatenating together the method lists of
 843     /// the base object trait and all supertraits, pointers to supertrait vtable will
 844     /// be provided when necessary; this is the position of `upcast_trait_ref`'s vtable
 845     /// within that vtable.
 846     pub vtable_vptr_slot: Option<usize>,
 847
 848     pub nested: Vec<N>,
 849 }
 850
 851 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 852 #[derive(TypeFoldable, TypeVisitable)]
 853 pub struct ImplSourceBuiltinData<N> {
 854     pub nested: Vec<N>,
 855 }
 856
 857 #[derive(PartialEq, Eq, Clone, TyEncodable, TyDecodable, HashStable, Lift)]
 858 #[derive(TypeFoldable, TypeVisitable)]
 859 pub struct ImplSourceObjectData<'tcx, N> {
 860     /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
 861     pub upcast_trait_ref: ty::PolyTraitRef<'tcx>,
 862
 863     /// The vtable is formed by concatenating together the method lists of
 864     /// the base object trait and all supertraits, pointers to supertrait vtable will
 865     /// be provided when necessary; this is the start of `upcast_trait_ref`'s methods
 866     /// in that vtable.
 867     pub vtable_base: usize,
 868
 869     pub nested: Vec<N>,
 870 }
 871
 872 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 873 #[derive(TypeFoldable, TypeVisitable)]
 874 pub struct ImplSourceFnPointerData<'tcx, N> {
 875     pub fn_ty: Ty<'tcx>,
 876     pub nested: Vec<N>,
 877 }
 878
 879 // FIXME(@lcnr): This should be  refactored and merged with other builtin vtables.
 880 #[derive(Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
 881 pub struct ImplSourceDiscriminantKindData;
 882
 883 #[derive(Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
 884 pub struct ImplSourcePointeeData;
 885
 886 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 887 #[derive(TypeFoldable, TypeVisitable)]
 888 pub struct ImplSourceConstDestructData<N> {
 889     pub nested: Vec<N>,
 890 }
 891
 892 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, Lift)]
 893 #[derive(TypeFoldable, TypeVisitable)]
 894 pub struct ImplSourceTraitAliasData<'tcx, N> {
 895     pub alias_def_id: DefId,
 896     pub substs: SubstsRef<'tcx>,
 897     pub nested: Vec<N>,
 898 }
 899
 900 #[derive(Clone, Debug, PartialEq, Eq, Hash, HashStable, PartialOrd, Ord)]
 901 pub enum ObjectSafetyViolation {
 902     /// `Self: Sized` declared on the trait.
 903     SizedSelf(SmallVec<[Span; 1]>),
 904
 905     /// Supertrait reference references `Self` an in illegal location
 906     /// (e.g., `trait Foo : Bar<Self>`).
 907     SupertraitSelf(SmallVec<[Span; 1]>),
 908
 909     /// Method has something illegal.
 910     Method(Symbol, MethodViolationCode, Span),
 911
 912     /// Associated const.
 913     AssocConst(Symbol, Span),
 914
 915     /// GAT
 916     GAT(Symbol, Span),
 917 }
 918
 919 impl ObjectSafetyViolation {
 920     pub fn error_msg(&self) -> Cow<'static, str> {
 921         match self {
 922             ObjectSafetyViolation::SizedSelf(_) => "it requires `Self: Sized`".into(),
 923             ObjectSafetyViolation::SupertraitSelf(ref spans) => {
 924                 if spans.iter().any(|sp| *sp != DUMMY_SP) {
 925                     "it uses `Self` as a type parameter".into()
 926                 } else {
 927                     "it cannot use `Self` as a type parameter in a supertrait or `where`-clause"
 928                         .into()
 929                 }
 930             }
 931             ObjectSafetyViolation::Method(name, MethodViolationCode::StaticMethod(_), _) => {
 932                 format!("associated function `{}` has no `self` parameter", name).into()
 933             }
 934             ObjectSafetyViolation::Method(
 935                 name,
 936                 MethodViolationCode::ReferencesSelfInput(_),
 937                 DUMMY_SP,
 938             ) => format!("method `{}` references the `Self` type in its parameters", name).into(),
 939             ObjectSafetyViolation::Method(name, MethodViolationCode::ReferencesSelfInput(_), _) => {
 940                 format!("method `{}` references the `Self` type in this parameter", name).into()
 941             }
 942             ObjectSafetyViolation::Method(name, MethodViolationCode::ReferencesSelfOutput, _) => {
 943                 format!("method `{}` references the `Self` type in its return type", name).into()
 944             }
 945             ObjectSafetyViolation::Method(
 946                 name,
 947                 MethodViolationCode::ReferencesImplTraitInTrait(_),
 948                 _,
 949             ) => format!("method `{}` references an `impl Trait` type in its return type", name)
 950                 .into(),
 951             ObjectSafetyViolation::Method(name, MethodViolationCode::AsyncFn, _) => {
 952                 format!("method `{}` is `async`", name).into()
 953             }
 954             ObjectSafetyViolation::Method(
 955                 name,
 956                 MethodViolationCode::WhereClauseReferencesSelf,
 957                 _,
 958             ) => {
 959                 format!("method `{}` references the `Self` type in its `where` clause", name).into()
 960             }
 961             ObjectSafetyViolation::Method(name, MethodViolationCode::Generic, _) => {
 962                 format!("method `{}` has generic type parameters", name).into()
 963             }
 964             ObjectSafetyViolation::Method(
 965                 name,
 966                 MethodViolationCode::UndispatchableReceiver(_),
 967                 _,
 968             ) => format!("method `{}`'s `self` parameter cannot be dispatched on", name).into(),
 969             ObjectSafetyViolation::AssocConst(name, DUMMY_SP) => {
 970                 format!("it contains associated `const` `{}`", name).into()
 971             }
 972             ObjectSafetyViolation::AssocConst(..) => "it contains this associated `const`".into(),
 973             ObjectSafetyViolation::GAT(name, _) => {
 974                 format!("it contains the generic associated type `{}`", name).into()
 975             }
 976         }
 977     }
 978
 979     pub fn solution(&self, err: &mut Diagnostic) {
 980         match self {
 981             ObjectSafetyViolation::SizedSelf(_) | ObjectSafetyViolation::SupertraitSelf(_) => {}
 982             ObjectSafetyViolation::Method(
 983                 name,
 984                 MethodViolationCode::StaticMethod(Some((add_self_sugg, make_sized_sugg))),
 985                 _,
 986             ) => {
 987                 err.span_suggestion(
 988                     add_self_sugg.1,
 989                     format!(
 990                         "consider turning `{}` into a method by giving it a `&self` argument",
 991                         name
 992                     ),
 993                     add_self_sugg.0.to_string(),
 994                     Applicability::MaybeIncorrect,
 995                 );
 996                 err.span_suggestion(
 997                     make_sized_sugg.1,
 998                     format!(
 999                         "alternatively, consider constraining `{}` so it does not apply to \
1000                              trait objects",
1001                         name
1002                     ),
1003                     make_sized_sugg.0.to_string(),
1004                     Applicability::MaybeIncorrect,
1005                 );
1006             }
1007             ObjectSafetyViolation::Method(
1008                 name,
1009                 MethodViolationCode::UndispatchableReceiver(Some(span)),
1010                 _,
1011             ) => {
1012                 err.span_suggestion(
1013                     *span,
1014                     &format!(
1015                         "consider changing method `{}`'s `self` parameter to be `&self`",
1016                         name
1017                     ),
1018                     "&Self",
1019                     Applicability::MachineApplicable,
1020                 );
1021             }
1022             ObjectSafetyViolation::AssocConst(name, _)
1023             | ObjectSafetyViolation::GAT(name, _)
1024             | ObjectSafetyViolation::Method(name, ..) => {
1025                 err.help(&format!("consider moving `{}` to another trait", name));
1026             }
1027         }
1028     }
1029
1030     pub fn spans(&self) -> SmallVec<[Span; 1]> {
1031         // When `span` comes from a separate crate, it'll be `DUMMY_SP`. Treat it as `None` so
1032         // diagnostics use a `note` instead of a `span_label`.
1033         match self {
1034             ObjectSafetyViolation::SupertraitSelf(spans)
1035             | ObjectSafetyViolation::SizedSelf(spans) => spans.clone(),
1036             ObjectSafetyViolation::AssocConst(_, span)
1037             | ObjectSafetyViolation::GAT(_, span)
1038             | ObjectSafetyViolation::Method(_, _, span)
1039                 if *span != DUMMY_SP =>
1040             {
1041                 smallvec![*span]
1042             }
1043             _ => smallvec![],
1044         }
1045     }
1046 }
1047
1048 /// Reasons a method might not be object-safe.
1049 #[derive(Clone, Debug, PartialEq, Eq, Hash, HashStable, PartialOrd, Ord)]
1050 pub enum MethodViolationCode {
1051     /// e.g., `fn foo()`
1052     StaticMethod(Option<(/* add &self */ (String, Span), /* add Self: Sized */ (String, Span))>),
1053
1054     /// e.g., `fn foo(&self, x: Self)`
1055     ReferencesSelfInput(Option<Span>),
1056
1057     /// e.g., `fn foo(&self) -> Self`
1058     ReferencesSelfOutput,
1059
1060     /// e.g., `fn foo(&self) -> impl Sized`
1061     ReferencesImplTraitInTrait(Span),
1062
1063     /// e.g., `async fn foo(&self)`
1064     AsyncFn,
1065
1066     /// e.g., `fn foo(&self) where Self: Clone`
1067     WhereClauseReferencesSelf,
1068
1069     /// e.g., `fn foo<A>()`
1070     Generic,
1071
1072     /// the method's receiver (`self` argument) can't be dispatched on
1073     UndispatchableReceiver(Option<Span>),
1074 }
1075
1076 /// These are the error cases for `codegen_select_candidate`.
1077 #[derive(Copy, Clone, Debug, Hash, HashStable, Encodable, Decodable)]
1078 pub enum CodegenObligationError {
1079     /// Ambiguity can happen when monomorphizing during trans
1080     /// expands to some humongous type that never occurred
1081     /// statically -- this humongous type can then overflow,
1082     /// leading to an ambiguous result. So report this as an
1083     /// overflow bug, since I believe this is the only case
1084     /// where ambiguity can result.
1085     Ambiguity,
1086     /// This can trigger when we probe for the source of a `'static` lifetime requirement
1087     /// on a trait object: `impl Foo for dyn Trait {}` has an implicit `'static` bound.
1088     /// This can also trigger when we have a global bound that is not actually satisfied,
1089     /// but was included during typeck due to the trivial_bounds feature.
1090     Unimplemented,
1091     FulfillmentError,
1092 }