src/librustc_metadata/index_builder.rs

   1 // Copyright 2012-2015 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 //! Builder types for generating the "item data" section of the
  12 //! metadata. This section winds up looking like this:
  13 //!
  14 //! ```
  15 //! <common::data> // big list of item-like things...
  16 //!    <common::data_item> // ...for most def-ids, there is an entry.
  17 //!    </common::data_item>
  18 //! </common::data>
  19 //! ```
  20 //!
  21 //! As we generate this listing, we collect the offset of each
  22 //! `data_item` entry and store it in an index. Then, when we load the
  23 //! metadata, we can skip right to the metadata for a particular item.
  24 //!
  25 //! In addition to the offset, we need to track the data that was used
  26 //! to generate the contents of each `data_item`. This is so that we
  27 //! can figure out which HIR nodes contributed to that data for
  28 //! incremental compilation purposes.
  29 //!
  30 //! The `IndexBuilder` facilitates both of these. It is created
  31 //! with an `EncodingContext` (`ecx`), which it encapsulates.
  32 //! It has one main method, `record()`. You invoke `record`
  33 //! like so to create a new `data_item` element in the list:
  34 //!
  35 //! ```
  36 //! index.record(some_def_id, callback_fn, data)
  37 //! ```
  38 //!
  39 //! What record will do is to (a) record the current offset, (b) emit
  40 //! the `common::data_item` tag, and then call `callback_fn` with the
  41 //! given data as well as the `EncodingContext`. Once `callback_fn`
  42 //! returns, the `common::data_item` tag will be closed.
  43 //!
  44 //! `EncodingContext` does not offer the `record` method, so that we
  45 //! can ensure that `common::data_item` elements are never nested.
  46 //!
  47 //! In addition, while the `callback_fn` is executing, we will push a
  48 //! task `MetaData(some_def_id)`, which can then observe the
  49 //! reads/writes that occur in the task. For this reason, the `data`
  50 //! argument that is given to the `callback_fn` must implement the
  51 //! trait `DepGraphRead`, which indicates how to register reads on the
  52 //! data in this new task (note that many types of data, such as
  53 //! `DefId`, do not currently require any reads to be registered,
  54 //! since they are not derived from a HIR node). This is also why we
  55 //! give a callback fn, rather than taking a closure: it allows us to
  56 //! easily control precisely what data is given to that fn.
  57
  58 use encoder::EncodeContext;
  59 use index::Index;
  60 use schema::*;
  61 use isolated_encoder::IsolatedEncoder;
  62
  63 use rustc::hir;
  64 use rustc::hir::def_id::DefId;
  65 use rustc::middle::cstore::EncodedMetadataHash;
  66 use rustc::ty::TyCtxt;
  67 use syntax::ast;
  68
  69 use std::ops::{Deref, DerefMut};
  70
  71 /// Builder that can encode new items, adding them into the index.
  72 /// Item encoding cannot be nested.
  73 pub struct IndexBuilder<'a, 'b: 'a, 'tcx: 'b> {
  74     items: Index,
  75     pub ecx: &'a mut EncodeContext<'b, 'tcx>,
  76 }
  77
  78 impl<'a, 'b, 'tcx> Deref for IndexBuilder<'a, 'b, 'tcx> {
  79     type Target = EncodeContext<'b, 'tcx>;
  80     fn deref(&self) -> &Self::Target {
  81         self.ecx
  82     }
  83 }
  84
  85 impl<'a, 'b, 'tcx> DerefMut for IndexBuilder<'a, 'b, 'tcx> {
  86     fn deref_mut(&mut self) -> &mut Self::Target {
  87         self.ecx
  88     }
  89 }
  90
  91 impl<'a, 'b, 'tcx> IndexBuilder<'a, 'b, 'tcx> {
  92     pub fn new(ecx: &'a mut EncodeContext<'b, 'tcx>) -> Self {
  93         IndexBuilder {
  94             items: Index::new(ecx.tcx.hir.definitions().def_index_counts_lo_hi()),
  95             ecx: ecx,
  96         }
  97     }
  98
  99     /// Emit the data for a def-id to the metadata. The function to
 100     /// emit the data is `op`, and it will be given `data` as
 101     /// arguments. This `record` function will call `op` to generate
 102     /// the `Entry` (which may point to other encoded information)
 103     /// and will then record the `Lazy<Entry>` for use in the index.
 104     ///
 105     /// In addition, it will setup a dep-graph task to track what data
 106     /// `op` accesses to generate the metadata, which is later used by
 107     /// incremental compilation to compute a hash for the metadata and
 108     /// track changes.
 109     ///
 110     /// The reason that `op` is a function pointer, and not a closure,
 111     /// is that we want to be able to completely track all data it has
 112     /// access to, so that we can be sure that `DATA: DepGraphRead`
 113     /// holds, and that it is therefore not gaining "secret" access to
 114     /// bits of HIR or other state that would not be trackd by the
 115     /// content system.
 116     pub fn record<'x, DATA>(&'x mut self,
 117                             id: DefId,
 118                             op: fn(&mut IsolatedEncoder<'x, 'b, 'tcx>, DATA) -> Entry<'tcx>,
 119                             data: DATA)
 120         where DATA: DepGraphRead
 121     {
 122         assert!(id.is_local());
 123         let tcx: TyCtxt<'b, 'tcx, 'tcx> = self.ecx.tcx;
 124
 125         // We don't track this since we are explicitly computing the incr. comp.
 126         // hashes anyway. In theory we could do some tracking here and use it to
 127         // avoid rehashing things (and instead cache the hashes) but it's
 128         // unclear whether that would be a win since hashing is cheap enough.
 129         let _task = tcx.dep_graph.in_ignore();
 130
 131         let ecx: &'x mut EncodeContext<'b, 'tcx> = &mut *self.ecx;
 132         let mut entry_builder = IsolatedEncoder::new(ecx);
 133         let entry = op(&mut entry_builder, data);
 134         let entry = entry_builder.lazy(&entry);
 135
 136         let (fingerprint, ecx) = entry_builder.finish();
 137         if let Some(hash) = fingerprint {
 138             ecx.metadata_hashes.hashes.push(EncodedMetadataHash {
 139                 def_index: id.index,
 140                 hash: hash,
 141             });
 142         }
 143
 144         self.items.record(id, entry);
 145     }
 146
 147     pub fn into_items(self) -> Index {
 148         self.items
 149     }
 150 }
 151
 152 /// Trait used for data that can be passed from outside a dep-graph
 153 /// task.  The data must either be of some safe type, such as a
 154 /// `DefId` index, or implement the `read` method so that it can add
 155 /// a read of whatever dep-graph nodes are appropriate.
 156 pub trait DepGraphRead {
 157     fn read(&self, tcx: TyCtxt);
 158 }
 159
 160 impl DepGraphRead for DefId {
 161     fn read(&self, _tcx: TyCtxt) {}
 162 }
 163
 164 impl DepGraphRead for ast::NodeId {
 165     fn read(&self, _tcx: TyCtxt) {}
 166 }
 167
 168 impl<T> DepGraphRead for Option<T>
 169     where T: DepGraphRead
 170 {
 171     fn read(&self, tcx: TyCtxt) {
 172         match *self {
 173             Some(ref v) => v.read(tcx),
 174             None => (),
 175         }
 176     }
 177 }
 178
 179 impl<T> DepGraphRead for [T]
 180     where T: DepGraphRead
 181 {
 182     fn read(&self, tcx: TyCtxt) {
 183         for i in self {
 184             i.read(tcx);
 185         }
 186     }
 187 }
 188
 189 macro_rules! read_tuple {
 190     ($($name:ident),*) => {
 191         impl<$($name),*> DepGraphRead for ($($name),*)
 192             where $($name: DepGraphRead),*
 193         {
 194             #[allow(non_snake_case)]
 195             fn read(&self, tcx: TyCtxt) {
 196                 let &($(ref $name),*) = self;
 197                 $($name.read(tcx);)*
 198             }
 199         }
 200     }
 201 }
 202 read_tuple!(A, B);
 203 read_tuple!(A, B, C);
 204
 205 macro_rules! read_hir {
 206     ($t:ty) => {
 207         impl<'tcx> DepGraphRead for &'tcx $t {
 208             fn read(&self, tcx: TyCtxt) {
 209                 tcx.hir.read(self.id);
 210             }
 211         }
 212     }
 213 }
 214 read_hir!(hir::Item);
 215 read_hir!(hir::ImplItem);
 216 read_hir!(hir::TraitItem);
 217 read_hir!(hir::ForeignItem);
 218 read_hir!(hir::MacroDef);
 219
 220 /// Leaks access to a value of type T without any tracking. This is
 221 /// suitable for ambiguous types like `usize`, which *could* represent
 222 /// tracked data (e.g., if you read it out of a HIR node) or might not
 223 /// (e.g., if it's an index). Adding in an `Untracked` is an
 224 /// assertion, essentially, that the data does not need to be tracked
 225 /// (or that read edges will be added by some other way).
 226 ///
 227 /// A good idea is to add to each use of `Untracked` an explanation of
 228 /// why this value is ok.
 229 pub struct Untracked<T>(pub T);
 230
 231 impl<T> DepGraphRead for Untracked<T> {
 232     fn read(&self, _tcx: TyCtxt) {}
 233 }
 234
 235 /// Newtype that can be used to package up misc data extracted from a
 236 /// HIR node that doesn't carry its own id. This will allow an
 237 /// arbitrary `T` to be passed in, but register a read on the given
 238 /// node-id.
 239 pub struct FromId<T>(pub ast::NodeId, pub T);
 240
 241 impl<T> DepGraphRead for FromId<T> {
 242     fn read(&self, tcx: TyCtxt) {
 243         tcx.hir.read(self.0);
 244     }
 245 }