1 //! Check properties that are required by built-in traits and set
2 //! up data structures required by type-checking/codegen.
4 use crate::errors::{CopyImplOnNonAdt, CopyImplOnTypeWithDtor, DropImplOnWrongItem};
5 use rustc_errors::{struct_span_err, MultiSpan};
7 use rustc_hir::def_id::{DefId, LocalDefId};
8 use rustc_hir::lang_items::LangItem;
9 use rustc_hir::ItemKind;
10 use rustc_infer::infer;
11 use rustc_infer::infer::outlives::env::OutlivesEnvironment;
12 use rustc_infer::infer::{RegionckMode, TyCtxtInferExt};
13 use rustc_middle::ty::adjustment::CoerceUnsizedInfo;
14 use rustc_middle::ty::{self, suggest_constraining_type_params, Ty, TyCtxt, TypeFoldable};
15 use rustc_trait_selection::traits::error_reporting::InferCtxtExt;
16 use rustc_trait_selection::traits::misc::{can_type_implement_copy, CopyImplementationError};
17 use rustc_trait_selection::traits::predicate_for_trait_def;
18 use rustc_trait_selection::traits::{self, ObligationCause, TraitEngine, TraitEngineExt};
19 use std::collections::BTreeMap;
21 pub fn check_trait(tcx: TyCtxt<'_>, trait_def_id: DefId) {
22 let lang_items = tcx.lang_items();
23 Checker { tcx, trait_def_id }
24 .check(lang_items.drop_trait(), visit_implementation_of_drop)
25 .check(lang_items.copy_trait(), visit_implementation_of_copy)
26 .check(lang_items.coerce_unsized_trait(), visit_implementation_of_coerce_unsized)
27 .check(lang_items.dispatch_from_dyn_trait(), visit_implementation_of_dispatch_from_dyn);
30 struct Checker<'tcx> {
35 impl<'tcx> Checker<'tcx> {
36 fn check<F>(&self, trait_def_id: Option<DefId>, mut f: F) -> &Self
38 F: FnMut(TyCtxt<'tcx>, LocalDefId),
40 if Some(self.trait_def_id) == trait_def_id {
41 for &impl_def_id in self.tcx.hir().trait_impls(self.trait_def_id) {
42 f(self.tcx, impl_def_id);
49 fn visit_implementation_of_drop(tcx: TyCtxt<'_>, impl_did: LocalDefId) {
50 // Destructors only work on nominal types.
51 if let ty::Adt(..) | ty::Error(_) = tcx.type_of(impl_did).kind() {
55 let sp = match tcx.hir().expect_item(impl_did).kind {
56 ItemKind::Impl(ref impl_) => impl_.self_ty.span,
57 _ => bug!("expected Drop impl item"),
60 tcx.sess.emit_err(DropImplOnWrongItem { span: sp });
63 fn visit_implementation_of_copy(tcx: TyCtxt<'_>, impl_did: LocalDefId) {
64 debug!("visit_implementation_of_copy: impl_did={:?}", impl_did);
66 let impl_hir_id = tcx.hir().local_def_id_to_hir_id(impl_did);
68 let self_type = tcx.type_of(impl_did);
69 debug!("visit_implementation_of_copy: self_type={:?} (bound)", self_type);
71 let span = tcx.hir().span(impl_hir_id);
72 let param_env = tcx.param_env(impl_did);
73 assert!(!self_type.has_escaping_bound_vars());
75 debug!("visit_implementation_of_copy: self_type={:?} (free)", self_type);
77 let cause = traits::ObligationCause::misc(span, impl_hir_id);
78 match can_type_implement_copy(tcx, param_env, self_type, cause) {
80 Err(CopyImplementationError::InfrigingFields(fields)) => {
81 let item = tcx.hir().expect_item(impl_did);
82 let span = if let ItemKind::Impl(hir::Impl { of_trait: Some(ref tr), .. }) = item.kind {
88 let mut err = struct_span_err!(
92 "the trait `Copy` may not be implemented for this type"
95 // We'll try to suggest constraining type parameters to fulfill the requirements of
96 // their `Copy` implementation.
97 let mut generics = None;
98 if let ty::Adt(def, _substs) = self_type.kind() {
99 let self_def_id = def.did();
100 if let Some(local) = self_def_id.as_local() {
101 let self_item = tcx.hir().expect_item(local);
102 generics = self_item.kind.generics();
105 let mut errors: BTreeMap<_, Vec<_>> = Default::default();
106 let mut bounds = vec![];
108 for (field, ty) in fields {
109 let field_span = tcx.def_span(field.did);
110 err.span_label(field_span, "this field does not implement `Copy`");
111 // Spin up a new FulfillmentContext, so we can get the _precise_ reason
112 // why this field does not implement Copy. This is useful because sometimes
113 // it is not immediately clear why Copy is not implemented for a field, since
114 // all we point at is the field itself.
115 tcx.infer_ctxt().enter(|infcx| {
116 let mut fulfill_cx = traits::FulfillmentContext::new_ignoring_regions();
117 fulfill_cx.register_bound(
121 tcx.lang_items().copy_trait().unwrap(),
122 traits::ObligationCause::dummy_with_span(field_span),
124 for error in fulfill_cx.select_all_or_error(&infcx) {
125 let error_predicate = error.obligation.predicate;
126 // Only note if it's not the root obligation, otherwise it's trivial and
127 // should be self-explanatory (i.e. a field literally doesn't implement Copy).
129 // FIXME: This error could be more descriptive, especially if the error_predicate
130 // contains a foreign type or if it's a deeply nested type...
131 if error_predicate != error.root_obligation.predicate {
133 .entry((ty.to_string(), error_predicate.to_string()))
135 .push(error.obligation.cause.span);
137 if let ty::PredicateKind::Trait(ty::TraitPredicate {
139 polarity: ty::ImplPolarity::Positive,
141 }) = error_predicate.kind().skip_binder()
143 let ty = trait_ref.self_ty();
144 if let ty::Param(_) = ty.kind() {
147 trait_ref.print_only_trait_path().to_string(),
148 Some(trait_ref.def_id),
155 for ((ty, error_predicate), spans) in errors {
156 let span: MultiSpan = spans.into();
159 &format!("the `Copy` impl for `{}` requires that `{}`", ty, error_predicate),
162 if let Some(generics) = generics {
163 suggest_constraining_type_params(
167 bounds.iter().map(|(param, constraint, def_id)| {
168 (param.as_str(), constraint.as_str(), *def_id)
174 Err(CopyImplementationError::NotAnAdt) => {
175 let item = tcx.hir().expect_item(impl_did);
177 if let ItemKind::Impl(ref impl_) = item.kind { impl_.self_ty.span } else { span };
179 tcx.sess.emit_err(CopyImplOnNonAdt { span });
181 Err(CopyImplementationError::HasDestructor) => {
182 tcx.sess.emit_err(CopyImplOnTypeWithDtor { span });
187 fn visit_implementation_of_coerce_unsized<'tcx>(tcx: TyCtxt<'tcx>, impl_did: LocalDefId) {
188 debug!("visit_implementation_of_coerce_unsized: impl_did={:?}", impl_did);
190 // Just compute this for the side-effects, in particular reporting
191 // errors; other parts of the code may demand it for the info of
193 let span = tcx.def_span(impl_did);
194 tcx.at(span).coerce_unsized_info(impl_did);
197 fn visit_implementation_of_dispatch_from_dyn<'tcx>(tcx: TyCtxt<'tcx>, impl_did: LocalDefId) {
198 debug!("visit_implementation_of_dispatch_from_dyn: impl_did={:?}", impl_did);
200 let impl_hir_id = tcx.hir().local_def_id_to_hir_id(impl_did);
201 let span = tcx.hir().span(impl_hir_id);
203 let dispatch_from_dyn_trait = tcx.require_lang_item(LangItem::DispatchFromDyn, Some(span));
205 let source = tcx.type_of(impl_did);
206 assert!(!source.has_escaping_bound_vars());
208 let trait_ref = tcx.impl_trait_ref(impl_did).unwrap();
209 assert_eq!(trait_ref.def_id, dispatch_from_dyn_trait);
211 trait_ref.substs.type_at(1)
214 debug!("visit_implementation_of_dispatch_from_dyn: {:?} -> {:?}", source, target);
216 let param_env = tcx.param_env(impl_did);
218 let create_err = |msg: &str| struct_span_err!(tcx.sess, span, E0378, "{}", msg);
220 tcx.infer_ctxt().enter(|infcx| {
221 let cause = ObligationCause::misc(span, impl_hir_id);
223 use rustc_type_ir::sty::TyKind::*;
224 match (source.kind(), target.kind()) {
225 (&Ref(r_a, _, mutbl_a), Ref(r_b, _, mutbl_b))
226 if infcx.at(&cause, param_env).eq(r_a, *r_b).is_ok() && mutbl_a == *mutbl_b => {}
227 (&RawPtr(tm_a), &RawPtr(tm_b)) if tm_a.mutbl == tm_b.mutbl => (),
228 (&Adt(def_a, substs_a), &Adt(def_b, substs_b))
229 if def_a.is_struct() && def_b.is_struct() =>
232 let source_path = tcx.def_path_str(def_a.did());
233 let target_path = tcx.def_path_str(def_b.did());
236 "the trait `DispatchFromDyn` may only be implemented \
237 for a coercion between structures with the same \
238 definition; expected `{}`, found `{}`",
239 source_path, target_path,
246 if def_a.repr().c() || def_a.repr().packed() {
248 "structs implementing `DispatchFromDyn` may not have \
249 `#[repr(packed)]` or `#[repr(C)]`",
254 let fields = &def_a.non_enum_variant().fields;
256 let coerced_fields = fields
259 let ty_a = field.ty(tcx, substs_a);
260 let ty_b = field.ty(tcx, substs_b);
262 if let Ok(layout) = tcx.layout_of(param_env.and(ty_a)) {
263 if layout.is_zst() && layout.align.abi.bytes() == 1 {
264 // ignore ZST fields with alignment of 1 byte
269 if let Ok(ok) = infcx.at(&cause, param_env).eq(ty_a, ty_b) {
270 if ok.obligations.is_empty() {
272 "the trait `DispatchFromDyn` may only be implemented \
273 for structs containing the field being coerced, \
274 ZST fields with 1 byte alignment, and nothing else",
277 "extra field `{}` of type `{}` is not allowed",
288 .collect::<Vec<_>>();
290 if coerced_fields.is_empty() {
292 "the trait `DispatchFromDyn` may only be implemented \
293 for a coercion between structures with a single field \
294 being coerced, none found",
297 } else if coerced_fields.len() > 1 {
299 "implementing the `DispatchFromDyn` trait requires multiple coercions",
302 "the trait `DispatchFromDyn` may only be implemented \
303 for a coercion between structures with a single field \
307 "currently, {} fields need coercions: {}",
308 coerced_fields.len(),
313 "`{}` (`{}` to `{}`)",
315 field.ty(tcx, substs_a),
316 field.ty(tcx, substs_b),
324 let mut fulfill_cx = <dyn TraitEngine<'_>>::new(infcx.tcx);
326 for field in coerced_fields {
327 let predicate = predicate_for_trait_def(
331 dispatch_from_dyn_trait,
333 field.ty(tcx, substs_a),
334 &[field.ty(tcx, substs_b).into()],
337 fulfill_cx.register_predicate_obligation(&infcx, predicate);
340 // Check that all transitive obligations are satisfied.
341 let errors = fulfill_cx.select_all_or_error(&infcx);
342 if !errors.is_empty() {
343 infcx.report_fulfillment_errors(&errors, None, false);
346 // Finally, resolve all regions.
347 let outlives_env = OutlivesEnvironment::new(param_env);
348 infcx.resolve_regions_and_report_errors(
349 impl_did.to_def_id(),
351 RegionckMode::default(),
357 "the trait `DispatchFromDyn` may only be implemented \
358 for a coercion between structures",
366 pub fn coerce_unsized_info<'tcx>(tcx: TyCtxt<'tcx>, impl_did: DefId) -> CoerceUnsizedInfo {
367 debug!("compute_coerce_unsized_info(impl_did={:?})", impl_did);
369 // this provider should only get invoked for local def-ids
370 let impl_did = impl_did.expect_local();
371 let span = tcx.def_span(impl_did);
373 let coerce_unsized_trait = tcx.require_lang_item(LangItem::CoerceUnsized, Some(span));
375 let unsize_trait = tcx.lang_items().require(LangItem::Unsize).unwrap_or_else(|err| {
376 tcx.sess.fatal(&format!("`CoerceUnsized` implementation {}", err));
379 let source = tcx.type_of(impl_did);
380 let trait_ref = tcx.impl_trait_ref(impl_did).unwrap();
381 assert_eq!(trait_ref.def_id, coerce_unsized_trait);
382 let target = trait_ref.substs.type_at(1);
383 debug!("visit_implementation_of_coerce_unsized: {:?} -> {:?} (bound)", source, target);
385 let param_env = tcx.param_env(impl_did);
386 assert!(!source.has_escaping_bound_vars());
388 let err_info = CoerceUnsizedInfo { custom_kind: None };
390 debug!("visit_implementation_of_coerce_unsized: {:?} -> {:?} (free)", source, target);
392 tcx.infer_ctxt().enter(|infcx| {
393 let impl_hir_id = tcx.hir().local_def_id_to_hir_id(impl_did);
394 let cause = ObligationCause::misc(span, impl_hir_id);
395 let check_mutbl = |mt_a: ty::TypeAndMut<'tcx>,
396 mt_b: ty::TypeAndMut<'tcx>,
397 mk_ptr: &dyn Fn(Ty<'tcx>) -> Ty<'tcx>| {
398 if (mt_a.mutbl, mt_b.mutbl) == (hir::Mutability::Not, hir::Mutability::Mut) {
400 .report_mismatched_types(
404 ty::error::TypeError::Mutability,
408 (mt_a.ty, mt_b.ty, unsize_trait, None)
410 let (source, target, trait_def_id, kind) = match (source.kind(), target.kind()) {
411 (&ty::Ref(r_a, ty_a, mutbl_a), &ty::Ref(r_b, ty_b, mutbl_b)) => {
412 infcx.sub_regions(infer::RelateObjectBound(span), r_b, r_a);
413 let mt_a = ty::TypeAndMut { ty: ty_a, mutbl: mutbl_a };
414 let mt_b = ty::TypeAndMut { ty: ty_b, mutbl: mutbl_b };
415 check_mutbl(mt_a, mt_b, &|ty| tcx.mk_imm_ref(r_b, ty))
418 (&ty::Ref(_, ty_a, mutbl_a), &ty::RawPtr(mt_b)) => {
419 let mt_a = ty::TypeAndMut { ty: ty_a, mutbl: mutbl_a };
420 check_mutbl(mt_a, mt_b, &|ty| tcx.mk_imm_ptr(ty))
423 (&ty::RawPtr(mt_a), &ty::RawPtr(mt_b)) => {
424 check_mutbl(mt_a, mt_b, &|ty| tcx.mk_imm_ptr(ty))
427 (&ty::Adt(def_a, substs_a), &ty::Adt(def_b, substs_b))
428 if def_a.is_struct() && def_b.is_struct() =>
431 let source_path = tcx.def_path_str(def_a.did());
432 let target_path = tcx.def_path_str(def_b.did());
437 "the trait `CoerceUnsized` may only be implemented \
438 for a coercion between structures with the same \
439 definition; expected `{}`, found `{}`",
447 // Here we are considering a case of converting
448 // `S<P0...Pn>` to S<Q0...Qn>`. As an example, let's imagine a struct `Foo<T, U>`,
449 // which acts like a pointer to `U`, but carries along some extra data of type `T`:
451 // struct Foo<T, U> {
456 // We might have an impl that allows (e.g.) `Foo<T, [i32; 3]>` to be unsized
457 // to `Foo<T, [i32]>`. That impl would look like:
459 // impl<T, U: Unsize<V>, V> CoerceUnsized<Foo<T, V>> for Foo<T, U> {}
461 // Here `U = [i32; 3]` and `V = [i32]`. At runtime,
462 // when this coercion occurs, we would be changing the
463 // field `ptr` from a thin pointer of type `*mut [i32;
464 // 3]` to a fat pointer of type `*mut [i32]` (with
465 // extra data `3`). **The purpose of this check is to
466 // make sure that we know how to do this conversion.**
468 // To check if this impl is legal, we would walk down
469 // the fields of `Foo` and consider their types with
470 // both substitutes. We are looking to find that
471 // exactly one (non-phantom) field has changed its
472 // type, which we will expect to be the pointer that
473 // is becoming fat (we could probably generalize this
474 // to multiple thin pointers of the same type becoming
475 // fat, but we don't). In this case:
477 // - `extra` has type `T` before and type `T` after
478 // - `ptr` has type `*mut U` before and type `*mut V` after
480 // Since just one field changed, we would then check
481 // that `*mut U: CoerceUnsized<*mut V>` is implemented
482 // (in other words, that we know how to do this
483 // conversion). This will work out because `U:
484 // Unsize<V>`, and we have a builtin rule that `*mut
485 // U` can be coerced to `*mut V` if `U: Unsize<V>`.
486 let fields = &def_a.non_enum_variant().fields;
487 let diff_fields = fields
490 .filter_map(|(i, f)| {
491 let (a, b) = (f.ty(tcx, substs_a), f.ty(tcx, substs_b));
493 if tcx.type_of(f.did).is_phantom_data() {
494 // Ignore PhantomData fields
498 // Ignore fields that aren't changed; it may
499 // be that we could get away with subtyping or
500 // something more accepting, but we use
501 // equality because we want to be able to
502 // perform this check without computing
503 // variance where possible. (This is because
504 // we may have to evaluate constraint
505 // expressions in the course of execution.)
507 if let Ok(ok) = infcx.at(&cause, param_env).eq(a, b) {
508 if ok.obligations.is_empty() {
513 // Collect up all fields that were significantly changed
514 // i.e., those that contain T in coerce_unsized T -> U
517 .collect::<Vec<_>>();
519 if diff_fields.is_empty() {
524 "the trait `CoerceUnsized` may only be implemented \
525 for a coercion between structures with one field \
526 being coerced, none found"
530 } else if diff_fields.len() > 1 {
531 let item = tcx.hir().expect_item(impl_did);
532 let span = if let ItemKind::Impl(hir::Impl { of_trait: Some(ref t), .. }) =
537 tcx.def_span(impl_did)
544 "implementing the trait \
545 `CoerceUnsized` requires multiple \
549 "`CoerceUnsized` may only be implemented for \
550 a coercion between structures with one field being coerced",
553 "currently, {} fields need coercions: {}",
558 format!("`{}` (`{}` to `{}`)", fields[i].name, a, b)
563 .span_label(span, "requires multiple coercions")
568 let (i, a, b) = diff_fields[0];
569 let kind = ty::adjustment::CustomCoerceUnsized::Struct(i);
570 (a, b, coerce_unsized_trait, Some(kind))
578 "the trait `CoerceUnsized` may only be implemented \
579 for a coercion between structures"
586 let mut fulfill_cx = <dyn TraitEngine<'_>>::new(infcx.tcx);
588 // Register an obligation for `A: Trait<B>`.
589 let cause = traits::ObligationCause::misc(span, impl_hir_id);
590 let predicate = predicate_for_trait_def(
599 fulfill_cx.register_predicate_obligation(&infcx, predicate);
601 // Check that all transitive obligations are satisfied.
602 let errors = fulfill_cx.select_all_or_error(&infcx);
603 if !errors.is_empty() {
604 infcx.report_fulfillment_errors(&errors, None, false);
607 // Finally, resolve all regions.
608 let outlives_env = OutlivesEnvironment::new(param_env);
609 infcx.resolve_regions_and_report_errors(
610 impl_did.to_def_id(),
612 RegionckMode::default(),
615 CoerceUnsizedInfo { custom_kind: kind }