src/librustc_incremental/assert_module_sources.rs

   1 //! This pass is only used for UNIT TESTS related to incremental
   2 //! compilation. It tests whether a particular `.o` file will be re-used
   3 //! from a previous compilation or whether it must be regenerated.
   4 //!
   5 //! The user adds annotations to the crate of the following form:
   6 //!
   7 //! ```
   8 //! #![rustc_partition_reused(module="spike", cfg="rpass2")]
   9 //! #![rustc_partition_codegened(module="spike-x", cfg="rpass2")]
  10 //! ```
  11 //!
  12 //! The first indicates (in the cfg `rpass2`) that `spike.o` will be
  13 //! reused, the second that `spike-x.o` will be recreated. If these
  14 //! annotations are inaccurate, errors are reported.
  15 //!
  16 //! The reason that we use `cfg=...` and not `#[cfg_attr]` is so that
  17 //! the HIR doesn't change as a result of the annotations, which might
  18 //! perturb the reuse results.
  19 //!
  20 //! `#![rustc_expected_cgu_reuse(module="spike", cfg="rpass2", kind="post-lto")]
  21 //! allows for doing a more fine-grained check to see if pre- or post-lto data
  22 //! was re-used.
  23
  24 use rustc::mir::mono::CodegenUnitNameBuilder;
  25 use rustc::ty::TyCtxt;
  26 use rustc_ast::ast;
  27 use rustc_hir::def_id::LOCAL_CRATE;
  28 use rustc_session::cgu_reuse_tracker::*;
  29 use rustc_span::symbol::{sym, Symbol};
  30 use std::collections::BTreeSet;
  31
  32 pub fn assert_module_sources(tcx: TyCtxt<'_>) {
  33     tcx.dep_graph.with_ignore(|| {
  34         if tcx.sess.opts.incremental.is_none() {
  35             return;
  36         }
  37
  38         let available_cgus = tcx
  39             .collect_and_partition_mono_items(LOCAL_CRATE)
  40             .1
  41             .iter()
  42             .map(|cgu| cgu.name())
  43             .collect::<BTreeSet<Symbol>>();
  44
  45         let ams = AssertModuleSource { tcx, available_cgus };
  46
  47         for attr in tcx.hir().krate().attrs {
  48             ams.check_attr(attr);
  49         }
  50     })
  51 }
  52
  53 struct AssertModuleSource<'tcx> {
  54     tcx: TyCtxt<'tcx>,
  55     available_cgus: BTreeSet<Symbol>,
  56 }
  57
  58 impl AssertModuleSource<'tcx> {
  59     fn check_attr(&self, attr: &ast::Attribute) {
  60         let (expected_reuse, comp_kind) = if attr.check_name(sym::rustc_partition_reused) {
  61             (CguReuse::PreLto, ComparisonKind::AtLeast)
  62         } else if attr.check_name(sym::rustc_partition_codegened) {
  63             (CguReuse::No, ComparisonKind::Exact)
  64         } else if attr.check_name(sym::rustc_expected_cgu_reuse) {
  65             match &*self.field(attr, sym::kind).as_str() {
  66                 "no" => (CguReuse::No, ComparisonKind::Exact),
  67                 "pre-lto" => (CguReuse::PreLto, ComparisonKind::Exact),
  68                 "post-lto" => (CguReuse::PostLto, ComparisonKind::Exact),
  69                 "any" => (CguReuse::PreLto, ComparisonKind::AtLeast),
  70                 other => {
  71                     self.tcx.sess.span_fatal(
  72                         attr.span,
  73                         &format!("unknown cgu-reuse-kind `{}` specified", other),
  74                     );
  75                 }
  76             }
  77         } else {
  78             return;
  79         };
  80
  81         if !self.tcx.sess.opts.debugging_opts.query_dep_graph {
  82             self.tcx.sess.span_fatal(
  83                 attr.span,
  84                 "found CGU-reuse attribute but `-Zquery-dep-graph` was not specified",
  85             );
  86         }
  87
  88         if !self.check_config(attr) {
  89             debug!("check_attr: config does not match, ignoring attr");
  90             return;
  91         }
  92
  93         let user_path = self.field(attr, sym::module).to_string();
  94         let crate_name = self.tcx.crate_name(LOCAL_CRATE).to_string();
  95
  96         if !user_path.starts_with(&crate_name) {
  97             let msg = format!(
  98                 "Found malformed codegen unit name `{}`. \
  99                 Codegen units names must always start with the name of the \
 100                 crate (`{}` in this case).",
 101                 user_path, crate_name
 102             );
 103             self.tcx.sess.span_fatal(attr.span, &msg);
 104         }
 105
 106         // Split of the "special suffix" if there is one.
 107         let (user_path, cgu_special_suffix) = if let Some(index) = user_path.rfind('.') {
 108             (&user_path[..index], Some(&user_path[index + 1..]))
 109         } else {
 110             (&user_path[..], None)
 111         };
 112
 113         let mut cgu_path_components = user_path.split('-').collect::<Vec<_>>();
 114
 115         // Remove the crate name
 116         assert_eq!(cgu_path_components.remove(0), crate_name);
 117
 118         let cgu_name_builder = &mut CodegenUnitNameBuilder::new(self.tcx);
 119         let cgu_name =
 120             cgu_name_builder.build_cgu_name(LOCAL_CRATE, cgu_path_components, cgu_special_suffix);
 121
 122         debug!("mapping '{}' to cgu name '{}'", self.field(attr, sym::module), cgu_name);
 123
 124         if !self.available_cgus.contains(&cgu_name) {
 125             self.tcx.sess.span_err(
 126                 attr.span,
 127                 &format!(
 128                     "no module named `{}` (mangled: {}). \
 129                           Available modules: {}",
 130                     user_path,
 131                     cgu_name,
 132                     self.available_cgus
 133                         .iter()
 134                         .map(|cgu| cgu.to_string())
 135                         .collect::<Vec<_>>()
 136                         .join(", ")
 137                 ),
 138             );
 139         }
 140
 141         self.tcx.sess.cgu_reuse_tracker.set_expectation(
 142             &cgu_name.as_str(),
 143             &user_path,
 144             attr.span,
 145             expected_reuse,
 146             comp_kind,
 147         );
 148     }
 149
 150     fn field(&self, attr: &ast::Attribute, name: Symbol) -> ast::Name {
 151         for item in attr.meta_item_list().unwrap_or_else(Vec::new) {
 152             if item.check_name(name) {
 153                 if let Some(value) = item.value_str() {
 154                     return value;
 155                 } else {
 156                     self.tcx.sess.span_fatal(
 157                         item.span(),
 158                         &format!("associated value expected for `{}`", name),
 159                     );
 160                 }
 161             }
 162         }
 163
 164         self.tcx.sess.span_fatal(attr.span, &format!("no field `{}`", name));
 165     }
 166
 167     /// Scan for a `cfg="foo"` attribute and check whether we have a
 168     /// cfg flag called `foo`.
 169     fn check_config(&self, attr: &ast::Attribute) -> bool {
 170         let config = &self.tcx.sess.parse_sess.config;
 171         let value = self.field(attr, sym::cfg);
 172         debug!("check_config(config={:?}, value={:?})", config, value);
 173         if config.iter().any(|&(name, _)| name == value) {
 174             debug!("check_config: matched");
 175             return true;
 176         }
 177         debug!("check_config: no match found");
 178         return false;
 179     }
 180 }