src/librustc/traits/specialize/specialization_graph.rs

   1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use super::{OverlapError, specializes};
  12
  13 use hir::def_id::DefId;
  14 use traits::{self, Reveal};
  15 use ty::{self, TyCtxt, TraitDef, TypeFoldable};
  16 use ty::fast_reject::{self, SimplifiedType};
  17 use syntax::ast::Name;
  18 use util::nodemap::{DefIdMap, FxHashMap};
  19
  20 /// A per-trait graph of impls in specialization order. At the moment, this
  21 /// graph forms a tree rooted with the trait itself, with all other nodes
  22 /// representing impls, and parent-child relationships representing
  23 /// specializations.
  24 ///
  25 /// The graph provides two key services:
  26 ///
  27 /// - Construction, which implicitly checks for overlapping impls (i.e., impls
  28 ///   that overlap but where neither specializes the other -- an artifact of the
  29 ///   simple "chain" rule.
  30 ///
  31 /// - Parent extraction. In particular, the graph can give you the *immediate*
  32 ///   parents of a given specializing impl, which is needed for extracting
  33 ///   default items amongst other thigns. In the simple "chain" rule, every impl
  34 ///   has at most one parent.
  35 pub struct Graph {
  36     // all impls have a parent; the "root" impls have as their parent the def_id
  37     // of the trait
  38     parent: DefIdMap<DefId>,
  39
  40     // the "root" impls are found by looking up the trait's def_id.
  41     children: DefIdMap<Children>,
  42 }
  43
  44 /// Children of a given impl, grouped into blanket/non-blanket varieties as is
  45 /// done in `TraitDef`.
  46 struct Children {
  47     // Impls of a trait (or specializations of a given impl). To allow for
  48     // quicker lookup, the impls are indexed by a simplified version of their
  49     // `Self` type: impls with a simplifiable `Self` are stored in
  50     // `nonblanket_impls` keyed by it, while all other impls are stored in
  51     // `blanket_impls`.
  52     //
  53     // A similar division is used within `TraitDef`, but the lists there collect
  54     // together *all* the impls for a trait, and are populated prior to building
  55     // the specialization graph.
  56
  57     /// Impls of the trait.
  58     nonblanket_impls: FxHashMap<fast_reject::SimplifiedType, Vec<DefId>>,
  59
  60     /// Blanket impls associated with the trait.
  61     blanket_impls: Vec<DefId>,
  62 }
  63
  64 /// The result of attempting to insert an impl into a group of children.
  65 enum Inserted {
  66     /// The impl was inserted as a new child in this group of children.
  67     BecameNewSibling,
  68
  69     /// The impl replaced an existing impl that specializes it.
  70     Replaced(DefId),
  71
  72     /// The impl is a specialization of an existing child.
  73     ShouldRecurseOn(DefId),
  74 }
  75
  76 impl<'a, 'gcx, 'tcx> Children {
  77     fn new() -> Children {
  78         Children {
  79             nonblanket_impls: FxHashMap(),
  80             blanket_impls: vec![],
  81         }
  82     }
  83
  84     /// Insert an impl into this set of children without comparing to any existing impls
  85     fn insert_blindly(&mut self,
  86                       tcx: TyCtxt<'a, 'gcx, 'tcx>,
  87                       impl_def_id: DefId) {
  88         let trait_ref = tcx.impl_trait_ref(impl_def_id).unwrap();
  89         if let Some(sty) = fast_reject::simplify_type(tcx, trait_ref.self_ty(), false) {
  90             self.nonblanket_impls.entry(sty).or_insert(vec![]).push(impl_def_id)
  91         } else {
  92             self.blanket_impls.push(impl_def_id)
  93         }
  94     }
  95
  96     /// Attempt to insert an impl into this set of children, while comparing for
  97     /// specialiation relationships.
  98     fn insert(&mut self,
  99               tcx: TyCtxt<'a, 'gcx, 'tcx>,
 100               impl_def_id: DefId,
 101               simplified_self: Option<SimplifiedType>)
 102               -> Result<Inserted, OverlapError>
 103     {
 104         for slot in match simplified_self {
 105             Some(sty) => self.filtered_mut(sty),
 106             None => self.iter_mut(),
 107         } {
 108             let possible_sibling = *slot;
 109
 110             let tcx = tcx.global_tcx();
 111             let (le, ge) = tcx.infer_ctxt((), Reveal::UserFacing).enter(|infcx| {
 112                 let overlap = traits::overlapping_impls(&infcx,
 113                                                         possible_sibling,
 114                                                         impl_def_id);
 115                 if let Some(impl_header) = overlap {
 116                     if tcx.impls_are_allowed_to_overlap(impl_def_id, possible_sibling) {
 117                         return Ok((false, false));
 118                     }
 119
 120                     let le = specializes(tcx, impl_def_id, possible_sibling);
 121                     let ge = specializes(tcx, possible_sibling, impl_def_id);
 122
 123                     if le == ge {
 124                         // overlap, but no specialization; error out
 125                         let trait_ref = impl_header.trait_ref.unwrap();
 126                         let self_ty = trait_ref.self_ty();
 127                         Err(OverlapError {
 128                             with_impl: possible_sibling,
 129                             trait_desc: trait_ref.to_string(),
 130                             // only report the Self type if it has at least
 131                             // some outer concrete shell; otherwise, it's
 132                             // not adding much information.
 133                             self_desc: if self_ty.has_concrete_skeleton() {
 134                                 Some(self_ty.to_string())
 135                             } else {
 136                                 None
 137                             }
 138                         })
 139                     } else {
 140                         Ok((le, ge))
 141                     }
 142                 } else {
 143                     Ok((false, false))
 144                 }
 145             })?;
 146
 147             if le && !ge {
 148                 debug!("descending as child of TraitRef {:?}",
 149                        tcx.impl_trait_ref(possible_sibling).unwrap());
 150
 151                 // the impl specializes possible_sibling
 152                 return Ok(Inserted::ShouldRecurseOn(possible_sibling));
 153             } else if ge && !le {
 154                 debug!("placing as parent of TraitRef {:?}",
 155                        tcx.impl_trait_ref(possible_sibling).unwrap());
 156
 157                     // possible_sibling specializes the impl
 158                     *slot = impl_def_id;
 159                 return Ok(Inserted::Replaced(possible_sibling));
 160             } else {
 161                 // no overlap (error bailed already via ?)
 162             }
 163         }
 164
 165         // no overlap with any potential siblings, so add as a new sibling
 166         debug!("placing as new sibling");
 167         self.insert_blindly(tcx, impl_def_id);
 168         Ok(Inserted::BecameNewSibling)
 169     }
 170
 171     fn iter_mut(&'a mut self) -> Box<Iterator<Item = &'a mut DefId> + 'a> {
 172         let nonblanket = self.nonblanket_impls.iter_mut().flat_map(|(_, v)| v.iter_mut());
 173         Box::new(self.blanket_impls.iter_mut().chain(nonblanket))
 174     }
 175
 176     fn filtered_mut(&'a mut self, sty: SimplifiedType)
 177                     -> Box<Iterator<Item = &'a mut DefId> + 'a> {
 178         let nonblanket = self.nonblanket_impls.entry(sty).or_insert(vec![]).iter_mut();
 179         Box::new(self.blanket_impls.iter_mut().chain(nonblanket))
 180     }
 181 }
 182
 183 impl<'a, 'gcx, 'tcx> Graph {
 184     pub fn new() -> Graph {
 185         Graph {
 186             parent: Default::default(),
 187             children: Default::default(),
 188         }
 189     }
 190
 191     /// Insert a local impl into the specialization graph. If an existing impl
 192     /// conflicts with it (has overlap, but neither specializes the other),
 193     /// information about the area of overlap is returned in the `Err`.
 194     pub fn insert(&mut self,
 195                   tcx: TyCtxt<'a, 'gcx, 'tcx>,
 196                   impl_def_id: DefId)
 197                   -> Result<(), OverlapError> {
 198         assert!(impl_def_id.is_local());
 199
 200         let trait_ref = tcx.impl_trait_ref(impl_def_id).unwrap();
 201         let trait_def_id = trait_ref.def_id;
 202
 203         debug!("insert({:?}): inserting TraitRef {:?} into specialization graph",
 204                impl_def_id, trait_ref);
 205
 206         // if the reference itself contains an earlier error (e.g., due to a
 207         // resolution failure), then we just insert the impl at the top level of
 208         // the graph and claim that there's no overlap (in order to supress
 209         // bogus errors).
 210         if trait_ref.references_error() {
 211             debug!("insert: inserting dummy node for erroneous TraitRef {:?}, \
 212                     impl_def_id={:?}, trait_def_id={:?}",
 213                    trait_ref, impl_def_id, trait_def_id);
 214
 215             self.parent.insert(impl_def_id, trait_def_id);
 216             self.children.entry(trait_def_id).or_insert(Children::new())
 217                 .insert_blindly(tcx, impl_def_id);
 218             return Ok(());
 219         }
 220
 221         let mut parent = trait_def_id;
 222         let simplified = fast_reject::simplify_type(tcx, trait_ref.self_ty(), false);
 223
 224         // Descend the specialization tree, where `parent` is the current parent node
 225         loop {
 226             use self::Inserted::*;
 227
 228             let insert_result = self.children.entry(parent).or_insert(Children::new())
 229                 .insert(tcx, impl_def_id, simplified)?;
 230
 231             match insert_result {
 232                 BecameNewSibling => {
 233                     break;
 234                 }
 235                 Replaced(new_child) => {
 236                     self.parent.insert(new_child, impl_def_id);
 237                     let mut new_children = Children::new();
 238                     new_children.insert_blindly(tcx, new_child);
 239                     self.children.insert(impl_def_id, new_children);
 240                     break;
 241                 }
 242                 ShouldRecurseOn(new_parent) => {
 243                     parent = new_parent;
 244                 }
 245             }
 246         }
 247
 248         self.parent.insert(impl_def_id, parent);
 249         Ok(())
 250     }
 251
 252     /// Insert cached metadata mapping from a child impl back to its parent.
 253     pub fn record_impl_from_cstore(&mut self,
 254                                    tcx: TyCtxt<'a, 'gcx, 'tcx>,
 255                                    parent: DefId,
 256                                    child: DefId) {
 257         if self.parent.insert(child, parent).is_some() {
 258             bug!("When recording an impl from the crate store, information about its parent \
 259                   was already present.");
 260         }
 261
 262         self.children.entry(parent).or_insert(Children::new()).insert_blindly(tcx, child);
 263     }
 264
 265     /// The parent of a given impl, which is the def id of the trait when the
 266     /// impl is a "specialization root".
 267     pub fn parent(&self, child: DefId) -> DefId {
 268         *self.parent.get(&child).unwrap()
 269     }
 270 }
 271
 272 /// A node in the specialization graph is either an impl or a trait
 273 /// definition; either can serve as a source of item definitions.
 274 /// There is always exactly one trait definition node: the root.
 275 #[derive(Debug, Copy, Clone)]
 276 pub enum Node {
 277     Impl(DefId),
 278     Trait(DefId),
 279 }
 280
 281 impl<'a, 'gcx, 'tcx> Node {
 282     pub fn is_from_trait(&self) -> bool {
 283         match *self {
 284             Node::Trait(..) => true,
 285             _ => false,
 286         }
 287     }
 288
 289     /// Iterate over the items defined directly by the given (impl or trait) node.
 290     #[inline] // FIXME(#35870) Avoid closures being unexported due to impl Trait.
 291     pub fn items(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>)
 292                  -> impl Iterator<Item = ty::AssociatedItem> + 'a {
 293         tcx.associated_items(self.def_id())
 294     }
 295
 296     pub fn def_id(&self) -> DefId {
 297         match *self {
 298             Node::Impl(did) => did,
 299             Node::Trait(did) => did,
 300         }
 301     }
 302 }
 303
 304 pub struct Ancestors<'a> {
 305     trait_def: &'a TraitDef,
 306     current_source: Option<Node>,
 307 }
 308
 309 impl<'a> Iterator for Ancestors<'a> {
 310     type Item = Node;
 311     fn next(&mut self) -> Option<Node> {
 312         let cur = self.current_source.take();
 313         if let Some(Node::Impl(cur_impl)) = cur {
 314             let parent = self.trait_def.specialization_graph.borrow().parent(cur_impl);
 315             if parent == self.trait_def.def_id {
 316                 self.current_source = Some(Node::Trait(parent));
 317             } else {
 318                 self.current_source = Some(Node::Impl(parent));
 319             }
 320         }
 321         cur
 322     }
 323 }
 324
 325 pub struct NodeItem<T> {
 326     pub node: Node,
 327     pub item: T,
 328 }
 329
 330 impl<T> NodeItem<T> {
 331     pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> NodeItem<U> {
 332         NodeItem {
 333             node: self.node,
 334             item: f(self.item),
 335         }
 336     }
 337 }
 338
 339 impl<'a, 'gcx, 'tcx> Ancestors<'a> {
 340     /// Search the items from the given ancestors, returning each definition
 341     /// with the given name and the given kind.
 342     #[inline] // FIXME(#35870) Avoid closures being unexported due to impl Trait.
 343     pub fn defs(self, tcx: TyCtxt<'a, 'gcx, 'tcx>, name: Name, kind: ty::AssociatedKind)
 344                 -> impl Iterator<Item = NodeItem<ty::AssociatedItem>> + 'a {
 345         self.flat_map(move |node| {
 346             node.items(tcx).filter(move |item| item.kind == kind && item.name == name)
 347                            .map(move |item| NodeItem { node: node, item: item })
 348         })
 349     }
 350 }
 351
 352 /// Walk up the specialization ancestors of a given impl, starting with that
 353 /// impl itself.
 354 pub fn ancestors<'a>(trait_def: &'a TraitDef, start_from_impl: DefId) -> Ancestors<'a> {
 355     Ancestors {
 356         trait_def: trait_def,
 357         current_source: Some(Node::Impl(start_from_impl)),
 358     }
 359 }