compiler/rustc_trait_selection/src/traits/object_safety.rs

   1 //! "Object safety" refers to the ability for a trait to be converted
   2 //! to an object. In general, traits may only be converted to an
   3 //! object if all of their methods meet certain criteria. In particular,
   4 //! they must:
   5 //!
   6 //!   - have a suitable receiver from which we can extract a vtable and coerce to a "thin" version
   7 //!     that doesn't contain the vtable;
   8 //!   - not reference the erased type `Self` except for in this receiver;
   9 //!   - not have generic type parameters.
  10
  11 use super::elaborate_predicates;
  12
  13 use crate::infer::TyCtxtInferExt;
  14 use crate::traits::const_evaluatable::{self, AbstractConst};
  15 use crate::traits::query::evaluate_obligation::InferCtxtExt;
  16 use crate::traits::{self, Obligation, ObligationCause};
  17 use rustc_errors::FatalError;
  18 use rustc_hir as hir;
  19 use rustc_hir::def_id::DefId;
  20 use rustc_middle::ty::subst::{GenericArg, InternalSubsts, Subst};
  21 use rustc_middle::ty::{self, Ty, TyCtxt, TypeFoldable, TypeVisitor, WithConstness};
  22 use rustc_middle::ty::{Predicate, ToPredicate};
  23 use rustc_session::lint::builtin::WHERE_CLAUSES_OBJECT_SAFETY;
  24 use rustc_span::symbol::Symbol;
  25 use rustc_span::{MultiSpan, Span};
  26 use smallvec::SmallVec;
  27
  28 use std::array;
  29 use std::iter;
  30 use std::ops::ControlFlow;
  31
  32 pub use crate::traits::{MethodViolationCode, ObjectSafetyViolation};
  33
  34 /// Returns the object safety violations that affect
  35 /// astconv -- currently, `Self` in supertraits. This is needed
  36 /// because `object_safety_violations` can't be used during
  37 /// type collection.
  38 pub fn astconv_object_safety_violations(
  39     tcx: TyCtxt<'_>,
  40     trait_def_id: DefId,
  41 ) -> Vec<ObjectSafetyViolation> {
  42     debug_assert!(tcx.generics_of(trait_def_id).has_self);
  43     let violations = traits::supertrait_def_ids(tcx, trait_def_id)
  44         .map(|def_id| predicates_reference_self(tcx, def_id, true))
  45         .filter(|spans| !spans.is_empty())
  46         .map(ObjectSafetyViolation::SupertraitSelf)
  47         .collect();
  48
  49     debug!("astconv_object_safety_violations(trait_def_id={:?}) = {:?}", trait_def_id, violations);
  50
  51     violations
  52 }
  53
  54 fn object_safety_violations(
  55     tcx: TyCtxt<'tcx>,
  56     trait_def_id: DefId,
  57 ) -> &'tcx [ObjectSafetyViolation] {
  58     debug_assert!(tcx.generics_of(trait_def_id).has_self);
  59     debug!("object_safety_violations: {:?}", trait_def_id);
  60
  61     tcx.arena.alloc_from_iter(
  62         traits::supertrait_def_ids(tcx, trait_def_id)
  63             .flat_map(|def_id| object_safety_violations_for_trait(tcx, def_id)),
  64     )
  65 }
  66
  67 /// We say a method is *vtable safe* if it can be invoked on a trait
  68 /// object. Note that object-safe traits can have some
  69 /// non-vtable-safe methods, so long as they require `Self: Sized` or
  70 /// otherwise ensure that they cannot be used when `Self = Trait`.
  71 pub fn is_vtable_safe_method(tcx: TyCtxt<'_>, trait_def_id: DefId, method: &ty::AssocItem) -> bool {
  72     debug_assert!(tcx.generics_of(trait_def_id).has_self);
  73     debug!("is_vtable_safe_method({:?}, {:?})", trait_def_id, method);
  74     // Any method that has a `Self: Sized` bound cannot be called.
  75     if generics_require_sized_self(tcx, method.def_id) {
  76         return false;
  77     }
  78
  79     match virtual_call_violation_for_method(tcx, trait_def_id, method) {
  80         None | Some(MethodViolationCode::WhereClauseReferencesSelf) => true,
  81         Some(_) => false,
  82     }
  83 }
  84
  85 fn object_safety_violations_for_trait(
  86     tcx: TyCtxt<'_>,
  87     trait_def_id: DefId,
  88 ) -> Vec<ObjectSafetyViolation> {
  89     // Check methods for violations.
  90     let mut violations: Vec<_> = tcx
  91         .associated_items(trait_def_id)
  92         .in_definition_order()
  93         .filter(|item| item.kind == ty::AssocKind::Fn)
  94         .filter_map(|item| {
  95             object_safety_violation_for_method(tcx, trait_def_id, &item)
  96                 .map(|(code, span)| ObjectSafetyViolation::Method(item.ident.name, code, span))
  97         })
  98         .filter(|violation| {
  99             if let ObjectSafetyViolation::Method(
 100                 _,
 101                 MethodViolationCode::WhereClauseReferencesSelf,
 102                 span,
 103             ) = violation
 104             {
 105                 lint_object_unsafe_trait(tcx, *span, trait_def_id, violation);
 106                 false
 107             } else {
 108                 true
 109             }
 110         })
 111         .collect();
 112
 113     // Check the trait itself.
 114     if trait_has_sized_self(tcx, trait_def_id) {
 115         // We don't want to include the requirement from `Sized` itself to be `Sized` in the list.
 116         let spans = get_sized_bounds(tcx, trait_def_id);
 117         violations.push(ObjectSafetyViolation::SizedSelf(spans));
 118     }
 119     let spans = predicates_reference_self(tcx, trait_def_id, false);
 120     if !spans.is_empty() {
 121         violations.push(ObjectSafetyViolation::SupertraitSelf(spans));
 122     }
 123     let spans = bounds_reference_self(tcx, trait_def_id);
 124     if !spans.is_empty() {
 125         violations.push(ObjectSafetyViolation::SupertraitSelf(spans));
 126     }
 127
 128     violations.extend(
 129         tcx.associated_items(trait_def_id)
 130             .in_definition_order()
 131             .filter(|item| item.kind == ty::AssocKind::Const)
 132             .map(|item| ObjectSafetyViolation::AssocConst(item.ident.name, item.ident.span)),
 133     );
 134
 135     violations.extend(
 136         tcx.associated_items(trait_def_id)
 137             .in_definition_order()
 138             .filter(|item| item.kind == ty::AssocKind::Type)
 139             .filter(|item| !tcx.generics_of(item.def_id).params.is_empty())
 140             .map(|item| ObjectSafetyViolation::GAT(item.ident.name, item.ident.span)),
 141     );
 142
 143     debug!(
 144         "object_safety_violations_for_trait(trait_def_id={:?}) = {:?}",
 145         trait_def_id, violations
 146     );
 147
 148     violations
 149 }
 150
 151 /// Lint object-unsafe trait.
 152 fn lint_object_unsafe_trait(
 153     tcx: TyCtxt<'_>,
 154     span: Span,
 155     trait_def_id: DefId,
 156     violation: &ObjectSafetyViolation,
 157 ) {
 158     // Using `CRATE_NODE_ID` is wrong, but it's hard to get a more precise id.
 159     // It's also hard to get a use site span, so we use the method definition span.
 160     tcx.struct_span_lint_hir(WHERE_CLAUSES_OBJECT_SAFETY, hir::CRATE_HIR_ID, span, |lint| {
 161         let mut err = lint.build(&format!(
 162             "the trait `{}` cannot be made into an object",
 163             tcx.def_path_str(trait_def_id)
 164         ));
 165         let node = tcx.hir().get_if_local(trait_def_id);
 166         let mut spans = MultiSpan::from_span(span);
 167         if let Some(hir::Node::Item(item)) = node {
 168             spans.push_span_label(
 169                 item.ident.span,
 170                 "this trait cannot be made into an object...".into(),
 171             );
 172             spans.push_span_label(span, format!("...because {}", violation.error_msg()));
 173         } else {
 174             spans.push_span_label(
 175                 span,
 176                 format!(
 177                     "the trait cannot be made into an object because {}",
 178                     violation.error_msg()
 179                 ),
 180             );
 181         };
 182         err.span_note(
 183             spans,
 184             "for a trait to be \"object safe\" it needs to allow building a vtable to allow the \
 185              call to be resolvable dynamically; for more information visit \
 186              <https://doc.rust-lang.org/reference/items/traits.html#object-safety>",
 187         );
 188         if node.is_some() {
 189             // Only provide the help if its a local trait, otherwise it's not
 190             violation.solution(&mut err);
 191         }
 192         err.emit();
 193     });
 194 }
 195
 196 fn sized_trait_bound_spans<'tcx>(
 197     tcx: TyCtxt<'tcx>,
 198     bounds: hir::GenericBounds<'tcx>,
 199 ) -> impl 'tcx + Iterator<Item = Span> {
 200     bounds.iter().filter_map(move |b| match b {
 201         hir::GenericBound::Trait(trait_ref, hir::TraitBoundModifier::None)
 202             if trait_has_sized_self(
 203                 tcx,
 204                 trait_ref.trait_ref.trait_def_id().unwrap_or_else(|| FatalError.raise()),
 205             ) =>
 206         {
 207             // Fetch spans for supertraits that are `Sized`: `trait T: Super`
 208             Some(trait_ref.span)
 209         }
 210         _ => None,
 211     })
 212 }
 213
 214 fn get_sized_bounds(tcx: TyCtxt<'_>, trait_def_id: DefId) -> SmallVec<[Span; 1]> {
 215     tcx.hir()
 216         .get_if_local(trait_def_id)
 217         .and_then(|node| match node {
 218             hir::Node::Item(hir::Item {
 219                 kind: hir::ItemKind::Trait(.., generics, bounds, _),
 220                 ..
 221             }) => Some(
 222                 generics
 223                     .where_clause
 224                     .predicates
 225                     .iter()
 226                     .filter_map(|pred| {
 227                         match pred {
 228                             hir::WherePredicate::BoundPredicate(pred)
 229                                 if pred.bounded_ty.hir_id.owner.to_def_id() == trait_def_id =>
 230                             {
 231                                 // Fetch spans for trait bounds that are Sized:
 232                                 // `trait T where Self: Pred`
 233                                 Some(sized_trait_bound_spans(tcx, pred.bounds))
 234                             }
 235                             _ => None,
 236                         }
 237                     })
 238                     .flatten()
 239                     // Fetch spans for supertraits that are `Sized`: `trait T: Super`.
 240                     .chain(sized_trait_bound_spans(tcx, bounds))
 241                     .collect::<SmallVec<[Span; 1]>>(),
 242             ),
 243             _ => None,
 244         })
 245         .unwrap_or_else(SmallVec::new)
 246 }
 247
 248 fn predicates_reference_self(
 249     tcx: TyCtxt<'_>,
 250     trait_def_id: DefId,
 251     supertraits_only: bool,
 252 ) -> SmallVec<[Span; 1]> {
 253     let trait_ref = ty::Binder::dummy(ty::TraitRef::identity(tcx, trait_def_id));
 254     let predicates = if supertraits_only {
 255         tcx.super_predicates_of(trait_def_id)
 256     } else {
 257         tcx.predicates_of(trait_def_id)
 258     };
 259     predicates
 260         .predicates
 261         .iter()
 262         .map(|&(predicate, sp)| (predicate.subst_supertrait(tcx, &trait_ref), sp))
 263         .filter_map(|predicate| predicate_references_self(tcx, predicate))
 264         .collect()
 265 }
 266
 267 fn bounds_reference_self(tcx: TyCtxt<'_>, trait_def_id: DefId) -> SmallVec<[Span; 1]> {
 268     tcx.associated_items(trait_def_id)
 269         .in_definition_order()
 270         .filter(|item| item.kind == ty::AssocKind::Type)
 271         .flat_map(|item| tcx.explicit_item_bounds(item.def_id))
 272         .filter_map(|pred_span| predicate_references_self(tcx, *pred_span))
 273         .collect()
 274 }
 275
 276 fn predicate_references_self(
 277     tcx: TyCtxt<'tcx>,
 278     (predicate, sp): (ty::Predicate<'tcx>, Span),
 279 ) -> Option<Span> {
 280     let self_ty = tcx.types.self_param;
 281     let has_self_ty = |arg: &GenericArg<'_>| arg.walk().any(|arg| arg == self_ty.into());
 282     match predicate.kind().skip_binder() {
 283         ty::PredicateKind::Trait(ref data, _) => {
 284             // In the case of a trait predicate, we can skip the "self" type.
 285             if data.trait_ref.substs[1..].iter().any(has_self_ty) { Some(sp) } else { None }
 286         }
 287         ty::PredicateKind::Projection(ref data) => {
 288             // And similarly for projections. This should be redundant with
 289             // the previous check because any projection should have a
 290             // matching `Trait` predicate with the same inputs, but we do
 291             // the check to be safe.
 292             //
 293             // It's also won't be redundant if we allow type-generic associated
 294             // types for trait objects.
 295             //
 296             // Note that we *do* allow projection *outputs* to contain
 297             // `self` (i.e., `trait Foo: Bar<Output=Self::Result> { type Result; }`),
 298             // we just require the user to specify *both* outputs
 299             // in the object type (i.e., `dyn Foo<Output=(), Result=()>`).
 300             //
 301             // This is ALT2 in issue #56288, see that for discussion of the
 302             // possible alternatives.
 303             if data.projection_ty.substs[1..].iter().any(has_self_ty) { Some(sp) } else { None }
 304         }
 305         ty::PredicateKind::WellFormed(..)
 306         | ty::PredicateKind::ObjectSafe(..)
 307         | ty::PredicateKind::TypeOutlives(..)
 308         | ty::PredicateKind::RegionOutlives(..)
 309         | ty::PredicateKind::ClosureKind(..)
 310         | ty::PredicateKind::Subtype(..)
 311         | ty::PredicateKind::ConstEvaluatable(..)
 312         | ty::PredicateKind::ConstEquate(..)
 313         | ty::PredicateKind::TypeWellFormedFromEnv(..) => None,
 314     }
 315 }
 316
 317 fn trait_has_sized_self(tcx: TyCtxt<'_>, trait_def_id: DefId) -> bool {
 318     generics_require_sized_self(tcx, trait_def_id)
 319 }
 320
 321 fn generics_require_sized_self(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
 322     let sized_def_id = match tcx.lang_items().sized_trait() {
 323         Some(def_id) => def_id,
 324         None => {
 325             return false; /* No Sized trait, can't require it! */
 326         }
 327     };
 328
 329     // Search for a predicate like `Self : Sized` amongst the trait bounds.
 330     let predicates = tcx.predicates_of(def_id);
 331     let predicates = predicates.instantiate_identity(tcx).predicates;
 332     elaborate_predicates(tcx, predicates.into_iter()).any(|obligation| {
 333         match obligation.predicate.kind().skip_binder() {
 334             ty::PredicateKind::Trait(ref trait_pred, _) => {
 335                 trait_pred.def_id() == sized_def_id && trait_pred.self_ty().is_param(0)
 336             }
 337             ty::PredicateKind::Projection(..)
 338             | ty::PredicateKind::Subtype(..)
 339             | ty::PredicateKind::RegionOutlives(..)
 340             | ty::PredicateKind::WellFormed(..)
 341             | ty::PredicateKind::ObjectSafe(..)
 342             | ty::PredicateKind::ClosureKind(..)
 343             | ty::PredicateKind::TypeOutlives(..)
 344             | ty::PredicateKind::ConstEvaluatable(..)
 345             | ty::PredicateKind::ConstEquate(..)
 346             | ty::PredicateKind::TypeWellFormedFromEnv(..) => false,
 347         }
 348     })
 349 }
 350
 351 /// Returns `Some(_)` if this method makes the containing trait not object safe.
 352 fn object_safety_violation_for_method(
 353     tcx: TyCtxt<'_>,
 354     trait_def_id: DefId,
 355     method: &ty::AssocItem,
 356 ) -> Option<(MethodViolationCode, Span)> {
 357     debug!("object_safety_violation_for_method({:?}, {:?})", trait_def_id, method);
 358     // Any method that has a `Self : Sized` requisite is otherwise
 359     // exempt from the regulations.
 360     if generics_require_sized_self(tcx, method.def_id) {
 361         return None;
 362     }
 363
 364     let violation = virtual_call_violation_for_method(tcx, trait_def_id, method);
 365     // Get an accurate span depending on the violation.
 366     violation.map(|v| {
 367         let node = tcx.hir().get_if_local(method.def_id);
 368         let span = match (v, node) {
 369             (MethodViolationCode::ReferencesSelfInput(arg), Some(node)) => node
 370                 .fn_decl()
 371                 .and_then(|decl| decl.inputs.get(arg + 1))
 372                 .map_or(method.ident.span, |arg| arg.span),
 373             (MethodViolationCode::UndispatchableReceiver, Some(node)) => node
 374                 .fn_decl()
 375                 .and_then(|decl| decl.inputs.get(0))
 376                 .map_or(method.ident.span, |arg| arg.span),
 377             (MethodViolationCode::ReferencesSelfOutput, Some(node)) => {
 378                 node.fn_decl().map_or(method.ident.span, |decl| decl.output.span())
 379             }
 380             _ => method.ident.span,
 381         };
 382         (v, span)
 383     })
 384 }
 385
 386 /// Returns `Some(_)` if this method cannot be called on a trait
 387 /// object; this does not necessarily imply that the enclosing trait
 388 /// is not object safe, because the method might have a where clause
 389 /// `Self:Sized`.
 390 fn virtual_call_violation_for_method<'tcx>(
 391     tcx: TyCtxt<'tcx>,
 392     trait_def_id: DefId,
 393     method: &ty::AssocItem,
 394 ) -> Option<MethodViolationCode> {
 395     let sig = tcx.fn_sig(method.def_id);
 396
 397     // The method's first parameter must be named `self`
 398     if !method.fn_has_self_parameter {
 399         // We'll attempt to provide a structured suggestion for `Self: Sized`.
 400         let sugg =
 401             tcx.hir().get_if_local(method.def_id).as_ref().and_then(|node| node.generics()).map(
 402                 |generics| match generics.where_clause.predicates {
 403                     [] => (" where Self: Sized", generics.where_clause.span),
 404                     [.., pred] => (", Self: Sized", pred.span().shrink_to_hi()),
 405                 },
 406             );
 407         // Get the span pointing at where the `self` receiver should be.
 408         let sm = tcx.sess.source_map();
 409         let self_span = method.ident.span.to(tcx
 410             .hir()
 411             .span_if_local(method.def_id)
 412             .unwrap_or_else(|| sm.next_point(method.ident.span))
 413             .shrink_to_hi());
 414         let self_span = sm.span_through_char(self_span, '(').shrink_to_hi();
 415         return Some(MethodViolationCode::StaticMethod(
 416             sugg,
 417             self_span,
 418             !sig.inputs().skip_binder().is_empty(),
 419         ));
 420     }
 421
 422     for (i, &input_ty) in sig.skip_binder().inputs()[1..].iter().enumerate() {
 423         if contains_illegal_self_type_reference(tcx, trait_def_id, sig.rebind(input_ty)) {
 424             return Some(MethodViolationCode::ReferencesSelfInput(i));
 425         }
 426     }
 427     if contains_illegal_self_type_reference(tcx, trait_def_id, sig.output()) {
 428         return Some(MethodViolationCode::ReferencesSelfOutput);
 429     }
 430
 431     // We can't monomorphize things like `fn foo<A>(...)`.
 432     let own_counts = tcx.generics_of(method.def_id).own_counts();
 433     if own_counts.types + own_counts.consts != 0 {
 434         return Some(MethodViolationCode::Generic);
 435     }
 436
 437     if tcx
 438         .predicates_of(method.def_id)
 439         .predicates
 440         .iter()
 441         // A trait object can't claim to live more than the concrete type,
 442         // so outlives predicates will always hold.
 443         .cloned()
 444         .filter(|(p, _)| p.to_opt_type_outlives().is_none())
 445         .any(|pred| contains_illegal_self_type_reference(tcx, trait_def_id, pred))
 446     {
 447         return Some(MethodViolationCode::WhereClauseReferencesSelf);
 448     }
 449
 450     let receiver_ty = tcx.liberate_late_bound_regions(method.def_id, sig.input(0));
 451
 452     // Until `unsized_locals` is fully implemented, `self: Self` can't be dispatched on.
 453     // However, this is already considered object-safe. We allow it as a special case here.
 454     // FIXME(mikeyhew) get rid of this `if` statement once `receiver_is_dispatchable` allows
 455     // `Receiver: Unsize<Receiver[Self => dyn Trait]>`.
 456     if receiver_ty != tcx.types.self_param {
 457         if !receiver_is_dispatchable(tcx, method, receiver_ty) {
 458             return Some(MethodViolationCode::UndispatchableReceiver);
 459         } else {
 460             // Do sanity check to make sure the receiver actually has the layout of a pointer.
 461
 462             use rustc_target::abi::Abi;
 463
 464             let param_env = tcx.param_env(method.def_id);
 465
 466             let abi_of_ty = |ty: Ty<'tcx>| -> Option<&Abi> {
 467                 match tcx.layout_of(param_env.and(ty)) {
 468                     Ok(layout) => Some(&layout.abi),
 469                     Err(err) => {
 470                         // #78372
 471                         tcx.sess.delay_span_bug(
 472                             tcx.def_span(method.def_id),
 473                             &format!("error: {}\n while computing layout for type {:?}", err, ty),
 474                         );
 475                         None
 476                     }
 477                 }
 478             };
 479
 480             // e.g., `Rc<()>`
 481             let unit_receiver_ty =
 482                 receiver_for_self_ty(tcx, receiver_ty, tcx.mk_unit(), method.def_id);
 483
 484             match abi_of_ty(unit_receiver_ty) {
 485                 Some(Abi::Scalar(..)) => (),
 486                 abi => {
 487                     tcx.sess.delay_span_bug(
 488                         tcx.def_span(method.def_id),
 489                         &format!(
 490                             "receiver when `Self = ()` should have a Scalar ABI; found {:?}",
 491                             abi
 492                         ),
 493                     );
 494                 }
 495             }
 496
 497             let trait_object_ty =
 498                 object_ty_for_trait(tcx, trait_def_id, tcx.mk_region(ty::ReStatic));
 499
 500             // e.g., `Rc<dyn Trait>`
 501             let trait_object_receiver =
 502                 receiver_for_self_ty(tcx, receiver_ty, trait_object_ty, method.def_id);
 503
 504             match abi_of_ty(trait_object_receiver) {
 505                 Some(Abi::ScalarPair(..)) => (),
 506                 abi => {
 507                     tcx.sess.delay_span_bug(
 508                         tcx.def_span(method.def_id),
 509                         &format!(
 510                             "receiver when `Self = {}` should have a ScalarPair ABI; found {:?}",
 511                             trait_object_ty, abi
 512                         ),
 513                     );
 514                 }
 515             }
 516         }
 517     }
 518
 519     None
 520 }
 521
 522 /// Performs a type substitution to produce the version of `receiver_ty` when `Self = self_ty`.
 523 /// For example, for `receiver_ty = Rc<Self>` and `self_ty = Foo`, returns `Rc<Foo>`.
 524 fn receiver_for_self_ty<'tcx>(
 525     tcx: TyCtxt<'tcx>,
 526     receiver_ty: Ty<'tcx>,
 527     self_ty: Ty<'tcx>,
 528     method_def_id: DefId,
 529 ) -> Ty<'tcx> {
 530     debug!("receiver_for_self_ty({:?}, {:?}, {:?})", receiver_ty, self_ty, method_def_id);
 531     let substs = InternalSubsts::for_item(tcx, method_def_id, |param, _| {
 532         if param.index == 0 { self_ty.into() } else { tcx.mk_param_from_def(param) }
 533     });
 534
 535     let result = receiver_ty.subst(tcx, substs);
 536     debug!(
 537         "receiver_for_self_ty({:?}, {:?}, {:?}) = {:?}",
 538         receiver_ty, self_ty, method_def_id, result
 539     );
 540     result
 541 }
 542
 543 /// Creates the object type for the current trait. For example,
 544 /// if the current trait is `Deref`, then this will be
 545 /// `dyn Deref<Target = Self::Target> + 'static`.
 546 fn object_ty_for_trait<'tcx>(
 547     tcx: TyCtxt<'tcx>,
 548     trait_def_id: DefId,
 549     lifetime: ty::Region<'tcx>,
 550 ) -> Ty<'tcx> {
 551     debug!("object_ty_for_trait: trait_def_id={:?}", trait_def_id);
 552
 553     let trait_ref = ty::TraitRef::identity(tcx, trait_def_id);
 554
 555     let trait_predicate = ty::Binder::dummy(ty::ExistentialPredicate::Trait(
 556         ty::ExistentialTraitRef::erase_self_ty(tcx, trait_ref),
 557     ));
 558
 559     let mut associated_types = traits::supertraits(tcx, ty::Binder::dummy(trait_ref))
 560         .flat_map(|super_trait_ref| {
 561             tcx.associated_items(super_trait_ref.def_id())
 562                 .in_definition_order()
 563                 .map(move |item| (super_trait_ref, item))
 564         })
 565         .filter(|(_, item)| item.kind == ty::AssocKind::Type)
 566         .collect::<Vec<_>>();
 567
 568     // existential predicates need to be in a specific order
 569     associated_types.sort_by_cached_key(|(_, item)| tcx.def_path_hash(item.def_id));
 570
 571     let projection_predicates = associated_types.into_iter().map(|(super_trait_ref, item)| {
 572         // We *can* get bound lifetimes here in cases like
 573         // `trait MyTrait: for<'s> OtherTrait<&'s T, Output=bool>`.
 574         super_trait_ref.map_bound(|super_trait_ref| {
 575             ty::ExistentialPredicate::Projection(ty::ExistentialProjection {
 576                 ty: tcx.mk_projection(item.def_id, super_trait_ref.substs),
 577                 item_def_id: item.def_id,
 578                 substs: super_trait_ref.substs,
 579             })
 580         })
 581     });
 582
 583     let existential_predicates = tcx
 584         .mk_poly_existential_predicates(iter::once(trait_predicate).chain(projection_predicates));
 585
 586     let object_ty = tcx.mk_dynamic(existential_predicates, lifetime);
 587
 588     debug!("object_ty_for_trait: object_ty=`{}`", object_ty);
 589
 590     object_ty
 591 }
 592
 593 /// Checks the method's receiver (the `self` argument) can be dispatched on when `Self` is a
 594 /// trait object. We require that `DispatchableFromDyn` be implemented for the receiver type
 595 /// in the following way:
 596 /// - let `Receiver` be the type of the `self` argument, i.e `Self`, `&Self`, `Rc<Self>`,
 597 /// - require the following bound:
 598 ///
 599 ///   ```
 600 ///   Receiver[Self => T]: DispatchFromDyn<Receiver[Self => dyn Trait]>
 601 ///   ```
 602 ///
 603 ///   where `Foo[X => Y]` means "the same type as `Foo`, but with `X` replaced with `Y`"
 604 ///   (substitution notation).
 605 ///
 606 /// Some examples of receiver types and their required obligation:
 607 /// - `&'a mut self` requires `&'a mut Self: DispatchFromDyn<&'a mut dyn Trait>`,
 608 /// - `self: Rc<Self>` requires `Rc<Self>: DispatchFromDyn<Rc<dyn Trait>>`,
 609 /// - `self: Pin<Box<Self>>` requires `Pin<Box<Self>>: DispatchFromDyn<Pin<Box<dyn Trait>>>`.
 610 ///
 611 /// The only case where the receiver is not dispatchable, but is still a valid receiver
 612 /// type (just not object-safe), is when there is more than one level of pointer indirection.
 613 /// E.g., `self: &&Self`, `self: &Rc<Self>`, `self: Box<Box<Self>>`. In these cases, there
 614 /// is no way, or at least no inexpensive way, to coerce the receiver from the version where
 615 /// `Self = dyn Trait` to the version where `Self = T`, where `T` is the unknown erased type
 616 /// contained by the trait object, because the object that needs to be coerced is behind
 617 /// a pointer.
 618 ///
 619 /// In practice, we cannot use `dyn Trait` explicitly in the obligation because it would result
 620 /// in a new check that `Trait` is object safe, creating a cycle (until object_safe_for_dispatch
 621 /// is stabilized, see tracking issue <https://github.com/rust-lang/rust/issues/43561>).
 622 /// Instead, we fudge a little by introducing a new type parameter `U` such that
 623 /// `Self: Unsize<U>` and `U: Trait + ?Sized`, and use `U` in place of `dyn Trait`.
 624 /// Written as a chalk-style query:
 625 ///
 626 ///     forall (U: Trait + ?Sized) {
 627 ///         if (Self: Unsize<U>) {
 628 ///             Receiver: DispatchFromDyn<Receiver[Self => U]>
 629 ///         }
 630 ///     }
 631 ///
 632 /// for `self: &'a mut Self`, this means `&'a mut Self: DispatchFromDyn<&'a mut U>`
 633 /// for `self: Rc<Self>`, this means `Rc<Self>: DispatchFromDyn<Rc<U>>`
 634 /// for `self: Pin<Box<Self>>`, this means `Pin<Box<Self>>: DispatchFromDyn<Pin<Box<U>>>`
 635 //
 636 // FIXME(mikeyhew) when unsized receivers are implemented as part of unsized rvalues, add this
 637 // fallback query: `Receiver: Unsize<Receiver[Self => U]>` to support receivers like
 638 // `self: Wrapper<Self>`.
 639 #[allow(dead_code)]
 640 fn receiver_is_dispatchable<'tcx>(
 641     tcx: TyCtxt<'tcx>,
 642     method: &ty::AssocItem,
 643     receiver_ty: Ty<'tcx>,
 644 ) -> bool {
 645     debug!("receiver_is_dispatchable: method = {:?}, receiver_ty = {:?}", method, receiver_ty);
 646
 647     let traits = (tcx.lang_items().unsize_trait(), tcx.lang_items().dispatch_from_dyn_trait());
 648     let (unsize_did, dispatch_from_dyn_did) = if let (Some(u), Some(cu)) = traits {
 649         (u, cu)
 650     } else {
 651         debug!("receiver_is_dispatchable: Missing Unsize or DispatchFromDyn traits");
 652         return false;
 653     };
 654
 655     // the type `U` in the query
 656     // use a bogus type parameter to mimic a forall(U) query using u32::MAX for now.
 657     // FIXME(mikeyhew) this is a total hack. Once object_safe_for_dispatch is stabilized, we can
 658     // replace this with `dyn Trait`
 659     let unsized_self_ty: Ty<'tcx> =
 660         tcx.mk_ty_param(u32::MAX, Symbol::intern("RustaceansAreAwesome"));
 661
 662     // `Receiver[Self => U]`
 663     let unsized_receiver_ty =
 664         receiver_for_self_ty(tcx, receiver_ty, unsized_self_ty, method.def_id);
 665
 666     // create a modified param env, with `Self: Unsize<U>` and `U: Trait` added to caller bounds
 667     // `U: ?Sized` is already implied here
 668     let param_env = {
 669         let param_env = tcx.param_env(method.def_id);
 670
 671         // Self: Unsize<U>
 672         let unsize_predicate = ty::TraitRef {
 673             def_id: unsize_did,
 674             substs: tcx.mk_substs_trait(tcx.types.self_param, &[unsized_self_ty.into()]),
 675         }
 676         .without_const()
 677         .to_predicate(tcx);
 678
 679         // U: Trait<Arg1, ..., ArgN>
 680         let trait_predicate = {
 681             let substs =
 682                 InternalSubsts::for_item(tcx, method.container.assert_trait(), |param, _| {
 683                     if param.index == 0 {
 684                         unsized_self_ty.into()
 685                     } else {
 686                         tcx.mk_param_from_def(param)
 687                     }
 688                 });
 689
 690             ty::TraitRef { def_id: unsize_did, substs }.without_const().to_predicate(tcx)
 691         };
 692
 693         let caller_bounds: Vec<Predicate<'tcx>> = param_env
 694             .caller_bounds()
 695             .iter()
 696             .chain(array::IntoIter::new([unsize_predicate, trait_predicate]))
 697             .collect();
 698
 699         ty::ParamEnv::new(tcx.intern_predicates(&caller_bounds), param_env.reveal())
 700     };
 701
 702     // Receiver: DispatchFromDyn<Receiver[Self => U]>
 703     let obligation = {
 704         let predicate = ty::TraitRef {
 705             def_id: dispatch_from_dyn_did,
 706             substs: tcx.mk_substs_trait(receiver_ty, &[unsized_receiver_ty.into()]),
 707         }
 708         .without_const()
 709         .to_predicate(tcx);
 710
 711         Obligation::new(ObligationCause::dummy(), param_env, predicate)
 712     };
 713
 714     tcx.infer_ctxt().enter(|ref infcx| {
 715         // the receiver is dispatchable iff the obligation holds
 716         infcx.predicate_must_hold_modulo_regions(&obligation)
 717     })
 718 }
 719
 720 fn contains_illegal_self_type_reference<'tcx, T: TypeFoldable<'tcx>>(
 721     tcx: TyCtxt<'tcx>,
 722     trait_def_id: DefId,
 723     value: T,
 724 ) -> bool {
 725     // This is somewhat subtle. In general, we want to forbid
 726     // references to `Self` in the argument and return types,
 727     // since the value of `Self` is erased. However, there is one
 728     // exception: it is ok to reference `Self` in order to access
 729     // an associated type of the current trait, since we retain
 730     // the value of those associated types in the object type
 731     // itself.
 732     //
 733     // ```rust
 734     // trait SuperTrait {
 735     //     type X;
 736     // }
 737     //
 738     // trait Trait : SuperTrait {
 739     //     type Y;
 740     //     fn foo(&self, x: Self) // bad
 741     //     fn foo(&self) -> Self // bad
 742     //     fn foo(&self) -> Option<Self> // bad
 743     //     fn foo(&self) -> Self::Y // OK, desugars to next example
 744     //     fn foo(&self) -> <Self as Trait>::Y // OK
 745     //     fn foo(&self) -> Self::X // OK, desugars to next example
 746     //     fn foo(&self) -> <Self as SuperTrait>::X // OK
 747     // }
 748     // ```
 749     //
 750     // However, it is not as simple as allowing `Self` in a projected
 751     // type, because there are illegal ways to use `Self` as well:
 752     //
 753     // ```rust
 754     // trait Trait : SuperTrait {
 755     //     ...
 756     //     fn foo(&self) -> <Self as SomeOtherTrait>::X;
 757     // }
 758     // ```
 759     //
 760     // Here we will not have the type of `X` recorded in the
 761     // object type, and we cannot resolve `Self as SomeOtherTrait`
 762     // without knowing what `Self` is.
 763
 764     struct IllegalSelfTypeVisitor<'tcx> {
 765         tcx: TyCtxt<'tcx>,
 766         trait_def_id: DefId,
 767         supertraits: Option<Vec<DefId>>,
 768     }
 769
 770     impl<'tcx> TypeVisitor<'tcx> for IllegalSelfTypeVisitor<'tcx> {
 771         type BreakTy = ();
 772
 773         fn visit_ty(&mut self, t: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
 774             match t.kind() {
 775                 ty::Param(_) => {
 776                     if t == self.tcx.types.self_param {
 777                         ControlFlow::BREAK
 778                     } else {
 779                         ControlFlow::CONTINUE
 780                     }
 781                 }
 782                 ty::Projection(ref data) => {
 783                     // This is a projected type `<Foo as SomeTrait>::X`.
 784
 785                     // Compute supertraits of current trait lazily.
 786                     if self.supertraits.is_none() {
 787                         let trait_ref =
 788                             ty::Binder::dummy(ty::TraitRef::identity(self.tcx, self.trait_def_id));
 789                         self.supertraits = Some(
 790                             traits::supertraits(self.tcx, trait_ref).map(|t| t.def_id()).collect(),
 791                         );
 792                     }
 793
 794                     // Determine whether the trait reference `Foo as
 795                     // SomeTrait` is in fact a supertrait of the
 796                     // current trait. In that case, this type is
 797                     // legal, because the type `X` will be specified
 798                     // in the object type.  Note that we can just use
 799                     // direct equality here because all of these types
 800                     // are part of the formal parameter listing, and
 801                     // hence there should be no inference variables.
 802                     let is_supertrait_of_current_trait = self
 803                         .supertraits
 804                         .as_ref()
 805                         .unwrap()
 806                         .contains(&data.trait_ref(self.tcx).def_id);
 807
 808                     if is_supertrait_of_current_trait {
 809                         ControlFlow::CONTINUE // do not walk contained types, do not report error, do collect $200
 810                     } else {
 811                         t.super_visit_with(self) // DO walk contained types, POSSIBLY reporting an error
 812                     }
 813                 }
 814                 _ => t.super_visit_with(self), // walk contained types, if any
 815             }
 816         }
 817
 818         fn visit_const(&mut self, ct: &ty::Const<'tcx>) -> ControlFlow<Self::BreakTy> {
 819             // First check if the type of this constant references `Self`.
 820             self.visit_ty(ct.ty)?;
 821
 822             // Constants can only influence object safety if they reference `Self`.
 823             // This is only possible for unevaluated constants, so we walk these here.
 824             //
 825             // If `AbstractConst::new` returned an error we already failed compilation
 826             // so we don't have to emit an additional error here.
 827             //
 828             // We currently recurse into abstract consts here but do not recurse in
 829             // `is_const_evaluatable`. This means that the object safety check is more
 830             // liberal than the const eval check.
 831             //
 832             // This shouldn't really matter though as we can't really use any
 833             // constants which are not considered const evaluatable.
 834             use rustc_middle::mir::abstract_const::Node;
 835             if let Ok(Some(ct)) = AbstractConst::from_const(self.tcx, ct) {
 836                 const_evaluatable::walk_abstract_const(self.tcx, ct, |node| match node.root() {
 837                     Node::Leaf(leaf) => {
 838                         let leaf = leaf.subst(self.tcx, ct.substs);
 839                         self.visit_const(leaf)
 840                     }
 841                     Node::Cast(_, _, ty) => self.visit_ty(ty),
 842                     Node::Binop(..) | Node::UnaryOp(..) | Node::FunctionCall(_, _) => {
 843                         ControlFlow::CONTINUE
 844                     }
 845                 })
 846             } else {
 847                 ControlFlow::CONTINUE
 848             }
 849         }
 850
 851         fn visit_predicate(&mut self, pred: ty::Predicate<'tcx>) -> ControlFlow<Self::BreakTy> {
 852             if let ty::PredicateKind::ConstEvaluatable(def, substs) = pred.kind().skip_binder() {
 853                 // FIXME(const_evaluatable_checked): We should probably deduplicate the logic for
 854                 // `AbstractConst`s here, it might make sense to change `ConstEvaluatable` to
 855                 // take a `ty::Const` instead.
 856                 use rustc_middle::mir::abstract_const::Node;
 857                 if let Ok(Some(ct)) = AbstractConst::new(self.tcx, def, substs) {
 858                     const_evaluatable::walk_abstract_const(self.tcx, ct, |node| match node.root() {
 859                         Node::Leaf(leaf) => {
 860                             let leaf = leaf.subst(self.tcx, ct.substs);
 861                             self.visit_const(leaf)
 862                         }
 863                         Node::Cast(_, _, ty) => self.visit_ty(ty),
 864                         Node::Binop(..) | Node::UnaryOp(..) | Node::FunctionCall(_, _) => {
 865                             ControlFlow::CONTINUE
 866                         }
 867                     })
 868                 } else {
 869                     ControlFlow::CONTINUE
 870                 }
 871             } else {
 872                 pred.super_visit_with(self)
 873             }
 874         }
 875     }
 876
 877     value
 878         .visit_with(&mut IllegalSelfTypeVisitor { tcx, trait_def_id, supertraits: None })
 879         .is_break()
 880 }
 881
 882 pub fn provide(providers: &mut ty::query::Providers) {
 883     *providers = ty::query::Providers { object_safety_violations, ..*providers };
 884 }