compiler/rustc_middle/src/ty/trait_def.rs

   1 use crate::traits::specialization_graph;
   2 use crate::ty::fast_reject::{self, SimplifiedType, SimplifyParams, StripReferences};
   3 use crate::ty::fold::TypeFoldable;
   4 use crate::ty::{Ident, Ty, TyCtxt};
   5 use rustc_hir as hir;
   6 use rustc_hir::def_id::DefId;
   7 use rustc_hir::definitions::DefPathHash;
   8
   9 use rustc_data_structures::fx::FxIndexMap;
  10 use rustc_errors::ErrorReported;
  11 use rustc_macros::HashStable;
  12
  13 /// A trait's definition with type information.
  14 #[derive(HashStable)]
  15 pub struct TraitDef {
  16     // We already have the def_path_hash below, no need to hash it twice
  17     #[stable_hasher(ignore)]
  18     pub def_id: DefId,
  19
  20     pub unsafety: hir::Unsafety,
  21
  22     /// If `true`, then this trait had the `#[rustc_paren_sugar]`
  23     /// attribute, indicating that it should be used with `Foo()`
  24     /// sugar. This is a temporary thing -- eventually any trait will
  25     /// be usable with the sugar (or without it).
  26     pub paren_sugar: bool,
  27
  28     pub has_auto_impl: bool,
  29
  30     /// If `true`, then this trait has the `#[marker]` attribute, indicating
  31     /// that all its associated items have defaults that cannot be overridden,
  32     /// and thus `impl`s of it are allowed to overlap.
  33     pub is_marker: bool,
  34
  35     /// If `true`, then this trait has the `#[rustc_skip_array_during_method_dispatch]`
  36     /// attribute, indicating that editions before 2021 should not consider this trait
  37     /// during method dispatch if the receiver is an array.
  38     pub skip_array_during_method_dispatch: bool,
  39
  40     /// Used to determine whether the standard library is allowed to specialize
  41     /// on this trait.
  42     pub specialization_kind: TraitSpecializationKind,
  43
  44     /// The ICH of this trait's DefPath, cached here so it doesn't have to be
  45     /// recomputed all the time.
  46     pub def_path_hash: DefPathHash,
  47
  48     /// List of functions from `#[rustc_must_implement_one_of]` attribute one of which
  49     /// must be implemented.
  50     pub must_implement_one_of: Option<Box<[Ident]>>,
  51 }
  52
  53 /// Whether this trait is treated specially by the standard library
  54 /// specialization lint.
  55 #[derive(HashStable, PartialEq, Clone, Copy, TyEncodable, TyDecodable)]
  56 pub enum TraitSpecializationKind {
  57     /// The default. Specializing on this trait is not allowed.
  58     None,
  59     /// Specializing on this trait is allowed because it doesn't have any
  60     /// methods. For example `Sized` or `FusedIterator`.
  61     /// Applies to traits with the `rustc_unsafe_specialization_marker`
  62     /// attribute.
  63     Marker,
  64     /// Specializing on this trait is allowed because all of the impls of this
  65     /// trait are "always applicable". Always applicable means that if
  66     /// `X<'x>: T<'y>` for any lifetimes, then `for<'a, 'b> X<'a>: T<'b>`.
  67     /// Applies to traits with the `rustc_specialization_trait` attribute.
  68     AlwaysApplicable,
  69 }
  70
  71 #[derive(Default, Debug, HashStable)]
  72 pub struct TraitImpls {
  73     blanket_impls: Vec<DefId>,
  74     /// Impls indexed by their simplified self type, for fast lookup.
  75     non_blanket_impls: FxIndexMap<SimplifiedType, Vec<DefId>>,
  76 }
  77
  78 impl TraitImpls {
  79     pub fn blanket_impls(&self) -> &[DefId] {
  80         self.blanket_impls.as_slice()
  81     }
  82 }
  83
  84 impl<'tcx> TraitDef {
  85     pub fn new(
  86         def_id: DefId,
  87         unsafety: hir::Unsafety,
  88         paren_sugar: bool,
  89         has_auto_impl: bool,
  90         is_marker: bool,
  91         skip_array_during_method_dispatch: bool,
  92         specialization_kind: TraitSpecializationKind,
  93         def_path_hash: DefPathHash,
  94         must_implement_one_of: Option<Box<[Ident]>>,
  95     ) -> TraitDef {
  96         TraitDef {
  97             def_id,
  98             unsafety,
  99             paren_sugar,
 100             has_auto_impl,
 101             is_marker,
 102             skip_array_during_method_dispatch,
 103             specialization_kind,
 104             def_path_hash,
 105             must_implement_one_of,
 106         }
 107     }
 108
 109     pub fn ancestors(
 110         &self,
 111         tcx: TyCtxt<'tcx>,
 112         of_impl: DefId,
 113     ) -> Result<specialization_graph::Ancestors<'tcx>, ErrorReported> {
 114         specialization_graph::ancestors(tcx, self.def_id, of_impl)
 115     }
 116 }
 117
 118 impl<'tcx> TyCtxt<'tcx> {
 119     pub fn for_each_impl<F: FnMut(DefId)>(self, def_id: DefId, mut f: F) {
 120         let impls = self.trait_impls_of(def_id);
 121
 122         for &impl_def_id in impls.blanket_impls.iter() {
 123             f(impl_def_id);
 124         }
 125
 126         for v in impls.non_blanket_impls.values() {
 127             for &impl_def_id in v {
 128                 f(impl_def_id);
 129             }
 130         }
 131     }
 132
 133     /// Iterate over every impl that could possibly match the
 134     /// self type `self_ty`.
 135     pub fn for_each_relevant_impl<F: FnMut(DefId)>(
 136         self,
 137         def_id: DefId,
 138         self_ty: Ty<'tcx>,
 139         mut f: F,
 140     ) {
 141         let _: Option<()> = self.find_map_relevant_impl(def_id, self_ty, |did| {
 142             f(did);
 143             None
 144         });
 145     }
 146
 147     /// Applies function to every impl that could possibly match the self type `self_ty` and returns
 148     /// the first non-none value.
 149     pub fn find_map_relevant_impl<T, F: FnMut(DefId) -> Option<T>>(
 150         self,
 151         def_id: DefId,
 152         self_ty: Ty<'tcx>,
 153         mut f: F,
 154     ) -> Option<T> {
 155         // FIXME: This depends on the set of all impls for the trait. That is
 156         // unfortunate wrt. incremental compilation.
 157         //
 158         // If we want to be faster, we could have separate queries for
 159         // blanket and non-blanket impls, and compare them separately.
 160         let impls = self.trait_impls_of(def_id);
 161
 162         for &impl_def_id in impls.blanket_impls.iter() {
 163             if let result @ Some(_) = f(impl_def_id) {
 164                 return result;
 165             }
 166         }
 167
 168         // Note that we're using `SimplifyParams::Yes` to query `non_blanket_impls` while using
 169         // `SimplifyParams::No` while actually adding them.
 170         //
 171         // This way, when searching for some impl for `T: Trait`, we do not look at any impls
 172         // whose outer level is not a parameter or projection. Especially for things like
 173         // `T: Clone` this is incredibly useful as we would otherwise look at all the impls
 174         // of `Clone` for `Option<T>`, `Vec<T>`, `ConcreteType` and so on.
 175         if let Some(simp) =
 176             fast_reject::simplify_type(self, self_ty, SimplifyParams::Yes, StripReferences::No)
 177         {
 178             if let Some(impls) = impls.non_blanket_impls.get(&simp) {
 179                 for &impl_def_id in impls {
 180                     if let result @ Some(_) = f(impl_def_id) {
 181                         return result;
 182                     }
 183                 }
 184             }
 185         } else {
 186             for &impl_def_id in impls.non_blanket_impls.values().flatten() {
 187                 if let result @ Some(_) = f(impl_def_id) {
 188                     return result;
 189                 }
 190             }
 191         }
 192
 193         None
 194     }
 195
 196     /// Returns an iterator containing all impls
 197     pub fn all_impls(self, def_id: DefId) -> impl Iterator<Item = DefId> + 'tcx {
 198         let TraitImpls { blanket_impls, non_blanket_impls } = self.trait_impls_of(def_id);
 199
 200         blanket_impls.iter().chain(non_blanket_impls.iter().map(|(_, v)| v).flatten()).cloned()
 201     }
 202 }
 203
 204 // Query provider for `trait_impls_of`.
 205 pub(super) fn trait_impls_of_provider(tcx: TyCtxt<'_>, trait_id: DefId) -> TraitImpls {
 206     let mut impls = TraitImpls::default();
 207
 208     // Traits defined in the current crate can't have impls in upstream
 209     // crates, so we don't bother querying the cstore.
 210     if !trait_id.is_local() {
 211         for &cnum in tcx.crates(()).iter() {
 212             for &(impl_def_id, simplified_self_ty) in
 213                 tcx.implementations_of_trait((cnum, trait_id)).iter()
 214             {
 215                 if let Some(simplified_self_ty) = simplified_self_ty {
 216                     impls
 217                         .non_blanket_impls
 218                         .entry(simplified_self_ty)
 219                         .or_default()
 220                         .push(impl_def_id);
 221                 } else {
 222                     impls.blanket_impls.push(impl_def_id);
 223                 }
 224             }
 225         }
 226     }
 227
 228     for &impl_def_id in tcx.hir().trait_impls(trait_id) {
 229         let impl_def_id = impl_def_id.to_def_id();
 230
 231         let impl_self_ty = tcx.type_of(impl_def_id);
 232         if impl_self_ty.references_error() {
 233             continue;
 234         }
 235
 236         if let Some(simplified_self_ty) =
 237             fast_reject::simplify_type(tcx, impl_self_ty, SimplifyParams::No, StripReferences::No)
 238         {
 239             impls.non_blanket_impls.entry(simplified_self_ty).or_default().push(impl_def_id);
 240         } else {
 241             impls.blanket_impls.push(impl_def_id);
 242         }
 243     }
 244
 245     impls
 246 }