compiler/rustc_hir_analysis/src/coherence/orphan.rs

   1 //! Orphan checker: every impl either implements a trait defined in this
   2 //! crate or pertains to a type defined in this crate.
   3
   4 use rustc_data_structures::fx::FxHashSet;
   5 use rustc_errors::{struct_span_err, DelayDm};
   6 use rustc_errors::{Diagnostic, ErrorGuaranteed};
   7 use rustc_hir as hir;
   8 use rustc_middle::ty::subst::InternalSubsts;
   9 use rustc_middle::ty::util::IgnoreRegions;
  10 use rustc_middle::ty::{
  11     self, ImplPolarity, Ty, TyCtxt, TypeSuperVisitable, TypeVisitable, TypeVisitor,
  12 };
  13 use rustc_session::lint;
  14 use rustc_span::def_id::{DefId, LocalDefId};
  15 use rustc_span::Span;
  16 use rustc_trait_selection::traits;
  17 use std::ops::ControlFlow;
  18
  19 #[instrument(skip(tcx), level = "debug")]
  20 pub(crate) fn orphan_check_impl(
  21     tcx: TyCtxt<'_>,
  22     impl_def_id: LocalDefId,
  23 ) -> Result<(), ErrorGuaranteed> {
  24     let trait_ref = tcx.impl_trait_ref(impl_def_id).unwrap();
  25     trait_ref.error_reported()?;
  26
  27     let ret = do_orphan_check_impl(tcx, trait_ref, impl_def_id);
  28     if tcx.trait_is_auto(trait_ref.def_id) {
  29         lint_auto_trait_impl(tcx, trait_ref, impl_def_id);
  30     }
  31
  32     ret
  33 }
  34
  35 fn do_orphan_check_impl<'tcx>(
  36     tcx: TyCtxt<'tcx>,
  37     trait_ref: ty::TraitRef<'tcx>,
  38     def_id: LocalDefId,
  39 ) -> Result<(), ErrorGuaranteed> {
  40     let trait_def_id = trait_ref.def_id;
  41
  42     let item = tcx.hir().expect_item(def_id);
  43     let hir::ItemKind::Impl(ref impl_) = item.kind else {
  44         bug!("{:?} is not an impl: {:?}", def_id, item);
  45     };
  46     let sp = tcx.def_span(def_id);
  47     let tr = impl_.of_trait.as_ref().unwrap();
  48
  49     match traits::orphan_check(tcx, item.owner_id.to_def_id()) {
  50         Ok(()) => {}
  51         Err(err) => emit_orphan_check_error(
  52             tcx,
  53             sp,
  54             item.span,
  55             tr.path.span,
  56             trait_ref.self_ty(),
  57             impl_.self_ty.span,
  58             &impl_.generics,
  59             err,
  60         )?,
  61     }
  62
  63     // In addition to the above rules, we restrict impls of auto traits
  64     // so that they can only be implemented on nominal types, such as structs,
  65     // enums or foreign types. To see why this restriction exists, consider the
  66     // following example (#22978). Imagine that crate A defines an auto trait
  67     // `Foo` and a fn that operates on pairs of types:
  68     //
  69     // ```
  70     // // Crate A
  71     // auto trait Foo { }
  72     // fn two_foos<A:Foo,B:Foo>(..) {
  73     //     one_foo::<(A,B)>(..)
  74     // }
  75     // fn one_foo<T:Foo>(..) { .. }
  76     // ```
  77     //
  78     // This type-checks fine; in particular the fn
  79     // `two_foos` is able to conclude that `(A,B):Foo`
  80     // because `A:Foo` and `B:Foo`.
  81     //
  82     // Now imagine that crate B comes along and does the following:
  83     //
  84     // ```
  85     // struct A { }
  86     // struct B { }
  87     // impl Foo for A { }
  88     // impl Foo for B { }
  89     // impl !Send for (A, B) { }
  90     // ```
  91     //
  92     // This final impl is legal according to the orphan
  93     // rules, but it invalidates the reasoning from
  94     // `two_foos` above.
  95     debug!(
  96         "trait_ref={:?} trait_def_id={:?} trait_is_auto={}",
  97         trait_ref,
  98         trait_def_id,
  99         tcx.trait_is_auto(trait_def_id)
 100     );
 101
 102     if tcx.trait_is_auto(trait_def_id) && !trait_def_id.is_local() {
 103         let self_ty = trait_ref.self_ty();
 104         let opt_self_def_id = match *self_ty.kind() {
 105             ty::Adt(self_def, _) => Some(self_def.did()),
 106             ty::Foreign(did) => Some(did),
 107             _ => None,
 108         };
 109
 110         let msg = match opt_self_def_id {
 111             // We only want to permit nominal types, but not *all* nominal types.
 112             // They must be local to the current crate, so that people
 113             // can't do `unsafe impl Send for Rc<SomethingLocal>` or
 114             // `impl !Send for Box<SomethingLocalAndSend>`.
 115             Some(self_def_id) => {
 116                 if self_def_id.is_local() {
 117                     None
 118                 } else {
 119                     Some((
 120                         format!(
 121                             "cross-crate traits with a default impl, like `{}`, \
 122                                     can only be implemented for a struct/enum type \
 123                                     defined in the current crate",
 124                             tcx.def_path_str(trait_def_id)
 125                         ),
 126                         "can't implement cross-crate trait for type in another crate",
 127                     ))
 128                 }
 129             }
 130             _ => Some((
 131                 format!(
 132                     "cross-crate traits with a default impl, like `{}`, can \
 133                                 only be implemented for a struct/enum type, not `{}`",
 134                     tcx.def_path_str(trait_def_id),
 135                     self_ty
 136                 ),
 137                 "can't implement cross-crate trait with a default impl for \
 138                         non-struct/enum type",
 139             )),
 140         };
 141
 142         if let Some((msg, label)) = msg {
 143             let reported =
 144                 struct_span_err!(tcx.sess, sp, E0321, "{}", msg).span_label(sp, label).emit();
 145             return Err(reported);
 146         }
 147     }
 148
 149     Ok(())
 150 }
 151
 152 fn emit_orphan_check_error<'tcx>(
 153     tcx: TyCtxt<'tcx>,
 154     sp: Span,
 155     full_impl_span: Span,
 156     trait_span: Span,
 157     self_ty: Ty<'tcx>,
 158     self_ty_span: Span,
 159     generics: &hir::Generics<'tcx>,
 160     err: traits::OrphanCheckErr<'tcx>,
 161 ) -> Result<!, ErrorGuaranteed> {
 162     Err(match err {
 163         traits::OrphanCheckErr::NonLocalInputType(tys) => {
 164             let msg = match self_ty.kind() {
 165                 ty::Adt(..) => "can be implemented for types defined outside of the crate",
 166                 _ if self_ty.is_primitive() => "can be implemented for primitive types",
 167                 _ => "can be implemented for arbitrary types",
 168             };
 169             let mut err = struct_span_err!(
 170                 tcx.sess,
 171                 sp,
 172                 E0117,
 173                 "only traits defined in the current crate {msg}"
 174             );
 175             err.span_label(sp, "impl doesn't use only types from inside the current crate");
 176             for &(mut ty, is_target_ty) in &tys {
 177                 ty = tcx.erase_regions(ty);
 178                 ty = match ty.kind() {
 179                     // Remove the type arguments from the output, as they are not relevant.
 180                     // You can think of this as the reverse of `resolve_vars_if_possible`.
 181                     // That way if we had `Vec<MyType>`, we will properly attribute the
 182                     // problem to `Vec<T>` and avoid confusing the user if they were to see
 183                     // `MyType` in the error.
 184                     ty::Adt(def, _) => tcx.mk_adt(*def, ty::List::empty()),
 185                     _ => ty,
 186                 };
 187                 let msg = |ty: &str, postfix: &str| {
 188                     format!("{ty} is not defined in the current crate{postfix}")
 189                 };
 190                 let this = |name: &str| msg("this", &format!(" because {name} are always foreign"));
 191                 let msg = match &ty.kind() {
 192                     ty::Slice(_) => this("slices"),
 193                     ty::Array(..) => this("arrays"),
 194                     ty::Tuple(..) => this("tuples"),
 195                     ty::Alias(ty::Opaque, ..) => {
 196                         "type alias impl trait is treated as if it were foreign, \
 197                         because its hidden type could be from a foreign crate"
 198                             .to_string()
 199                     }
 200                     ty::RawPtr(ptr_ty) => {
 201                         emit_newtype_suggestion_for_raw_ptr(
 202                             full_impl_span,
 203                             self_ty,
 204                             self_ty_span,
 205                             ptr_ty,
 206                             &mut err,
 207                         );
 208
 209                         msg(&format!("`{ty}`"), " because raw pointers are always foreign")
 210                     }
 211                     _ => msg(&format!("`{ty}`"), ""),
 212                 };
 213
 214                 if is_target_ty {
 215                     // Point at `D<A>` in `impl<A, B> for C<B> in D<A>`
 216                     err.span_label(self_ty_span, &msg);
 217                 } else {
 218                     // Point at `C<B>` in `impl<A, B> for C<B> in D<A>`
 219                     err.span_label(trait_span, &msg);
 220                 }
 221             }
 222             err.note("define and implement a trait or new type instead");
 223             err.emit()
 224         }
 225         traits::OrphanCheckErr::UncoveredTy(param_ty, local_type) => {
 226             let mut sp = sp;
 227             for param in generics.params {
 228                 if param.name.ident().to_string() == param_ty.to_string() {
 229                     sp = param.span;
 230                 }
 231             }
 232
 233             match local_type {
 234                 Some(local_type) => struct_span_err!(
 235                     tcx.sess,
 236                     sp,
 237                     E0210,
 238                     "type parameter `{}` must be covered by another type \
 239                     when it appears before the first local type (`{}`)",
 240                     param_ty,
 241                     local_type
 242                 )
 243                 .span_label(
 244                     sp,
 245                     format!(
 246                         "type parameter `{}` must be covered by another type \
 247                     when it appears before the first local type (`{}`)",
 248                         param_ty, local_type
 249                     ),
 250                 )
 251                 .note(
 252                     "implementing a foreign trait is only possible if at \
 253                         least one of the types for which it is implemented is local, \
 254                         and no uncovered type parameters appear before that first \
 255                         local type",
 256                 )
 257                 .note(
 258                     "in this case, 'before' refers to the following order: \
 259                         `impl<..> ForeignTrait<T1, ..., Tn> for T0`, \
 260                         where `T0` is the first and `Tn` is the last",
 261                 )
 262                 .emit(),
 263                 None => struct_span_err!(
 264                     tcx.sess,
 265                     sp,
 266                     E0210,
 267                     "type parameter `{}` must be used as the type parameter for some \
 268                     local type (e.g., `MyStruct<{}>`)",
 269                     param_ty,
 270                     param_ty
 271                 )
 272                 .span_label(
 273                     sp,
 274                     format!(
 275                         "type parameter `{}` must be used as the type parameter for some \
 276                     local type",
 277                         param_ty,
 278                     ),
 279                 )
 280                 .note(
 281                     "implementing a foreign trait is only possible if at \
 282                         least one of the types for which it is implemented is local",
 283                 )
 284                 .note(
 285                     "only traits defined in the current crate can be \
 286                         implemented for a type parameter",
 287                 )
 288                 .emit(),
 289             }
 290         }
 291     })
 292 }
 293
 294 fn emit_newtype_suggestion_for_raw_ptr(
 295     full_impl_span: Span,
 296     self_ty: Ty<'_>,
 297     self_ty_span: Span,
 298     ptr_ty: &ty::TypeAndMut<'_>,
 299     diag: &mut Diagnostic,
 300 ) {
 301     if !self_ty.needs_subst() {
 302         let mut_key = ptr_ty.mutbl.prefix_str();
 303         let msg_sugg = "consider introducing a new wrapper type".to_owned();
 304         let sugg = vec![
 305             (
 306                 full_impl_span.shrink_to_lo(),
 307                 format!("struct WrapperType(*{}{});\n\n", mut_key, ptr_ty.ty),
 308             ),
 309             (self_ty_span, "WrapperType".to_owned()),
 310         ];
 311         diag.multipart_suggestion(msg_sugg, sugg, rustc_errors::Applicability::MaybeIncorrect);
 312     }
 313 }
 314
 315 /// Lint impls of auto traits if they are likely to have
 316 /// unsound or surprising effects on auto impls.
 317 fn lint_auto_trait_impl<'tcx>(
 318     tcx: TyCtxt<'tcx>,
 319     trait_ref: ty::TraitRef<'tcx>,
 320     impl_def_id: LocalDefId,
 321 ) {
 322     if tcx.impl_polarity(impl_def_id) != ImplPolarity::Positive {
 323         return;
 324     }
 325
 326     assert_eq!(trait_ref.substs.len(), 1);
 327     let self_ty = trait_ref.self_ty();
 328     let (self_type_did, substs) = match self_ty.kind() {
 329         ty::Adt(def, substs) => (def.did(), substs),
 330         _ => {
 331             // FIXME: should also lint for stuff like `&i32` but
 332             // considering that auto traits are unstable, that
 333             // isn't too important for now as this only affects
 334             // crates using `nightly`, and std.
 335             return;
 336         }
 337     };
 338
 339     // Impls which completely cover a given root type are fine as they
 340     // disable auto impls entirely. So only lint if the substs
 341     // are not a permutation of the identity substs.
 342     let Err(arg) = tcx.uses_unique_generic_params(substs, IgnoreRegions::Yes) else {
 343         // ok
 344         return;
 345     };
 346
 347     // Ideally:
 348     //
 349     // - compute the requirements for the auto impl candidate
 350     // - check whether these are implied by the non covering impls
 351     // - if not, emit the lint
 352     //
 353     // What we do here is a bit simpler:
 354     //
 355     // - badly check if an auto impl candidate definitely does not apply
 356     //   for the given simplified type
 357     // - if so, do not lint
 358     if fast_reject_auto_impl(tcx, trait_ref.def_id, self_ty) {
 359         // ok
 360         return;
 361     }
 362
 363     tcx.struct_span_lint_hir(
 364         lint::builtin::SUSPICIOUS_AUTO_TRAIT_IMPLS,
 365         tcx.hir().local_def_id_to_hir_id(impl_def_id),
 366         tcx.def_span(impl_def_id),
 367         DelayDm(|| {
 368             format!(
 369                 "cross-crate traits with a default impl, like `{}`, \
 370                          should not be specialized",
 371                 tcx.def_path_str(trait_ref.def_id),
 372             )
 373         }),
 374         |lint| {
 375             let item_span = tcx.def_span(self_type_did);
 376             let self_descr = tcx.def_kind(self_type_did).descr(self_type_did);
 377             match arg {
 378                 ty::util::NotUniqueParam::DuplicateParam(arg) => {
 379                     lint.note(&format!("`{}` is mentioned multiple times", arg));
 380                 }
 381                 ty::util::NotUniqueParam::NotParam(arg) => {
 382                     lint.note(&format!("`{}` is not a generic parameter", arg));
 383                 }
 384             }
 385             lint.span_note(
 386                 item_span,
 387                 &format!(
 388                     "try using the same sequence of generic parameters as the {} definition",
 389                     self_descr,
 390                 ),
 391             )
 392         },
 393     );
 394 }
 395
 396 fn fast_reject_auto_impl<'tcx>(tcx: TyCtxt<'tcx>, trait_def_id: DefId, self_ty: Ty<'tcx>) -> bool {
 397     struct DisableAutoTraitVisitor<'tcx> {
 398         tcx: TyCtxt<'tcx>,
 399         trait_def_id: DefId,
 400         self_ty_root: Ty<'tcx>,
 401         seen: FxHashSet<DefId>,
 402     }
 403
 404     impl<'tcx> TypeVisitor<'tcx> for DisableAutoTraitVisitor<'tcx> {
 405         type BreakTy = ();
 406         fn visit_ty(&mut self, t: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
 407             let tcx = self.tcx;
 408             if t != self.self_ty_root {
 409                 for impl_def_id in tcx.non_blanket_impls_for_ty(self.trait_def_id, t) {
 410                     match tcx.impl_polarity(impl_def_id) {
 411                         ImplPolarity::Negative => return ControlFlow::BREAK,
 412                         ImplPolarity::Reservation => {}
 413                         // FIXME(@lcnr): That's probably not good enough, idk
 414                         //
 415                         // We might just want to take the rustdoc code and somehow avoid
 416                         // explicit impls for `Self`.
 417                         ImplPolarity::Positive => return ControlFlow::CONTINUE,
 418                     }
 419                 }
 420             }
 421
 422             match t.kind() {
 423                 ty::Adt(def, substs) if def.is_phantom_data() => substs.visit_with(self),
 424                 ty::Adt(def, substs) => {
 425                     // @lcnr: This is the only place where cycles can happen. We avoid this
 426                     // by only visiting each `DefId` once.
 427                     //
 428                     // This will be is incorrect in subtle cases, but I don't care :)
 429                     if self.seen.insert(def.did()) {
 430                         for ty in def.all_fields().map(|field| field.ty(tcx, substs)) {
 431                             ty.visit_with(self)?;
 432                         }
 433                     }
 434
 435                     ControlFlow::CONTINUE
 436                 }
 437                 _ => t.super_visit_with(self),
 438             }
 439         }
 440     }
 441
 442     let self_ty_root = match self_ty.kind() {
 443         ty::Adt(def, _) => tcx.mk_adt(*def, InternalSubsts::identity_for_item(tcx, def.did())),
 444         _ => unimplemented!("unexpected self ty {:?}", self_ty),
 445     };
 446
 447     self_ty_root
 448         .visit_with(&mut DisableAutoTraitVisitor {
 449             tcx,
 450             self_ty_root,
 451             trait_def_id,
 452             seen: FxHashSet::default(),
 453         })
 454         .is_break()
 455 }