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.
5 //! The user adds annotations to the crate of the following form:
8 //! #![rustc_partition_reused(module="spike", cfg="rpass2")]
9 //! #![rustc_partition_codegened(module="spike-x", cfg="rpass2")]
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.
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.
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
24 use rustc::hir::def_id::LOCAL_CRATE;
25 use rustc::dep_graph::cgu_reuse_tracker::*;
26 use rustc::mir::mono::CodegenUnitNameBuilder;
27 use rustc::ty::TyCtxt;
28 use std::collections::BTreeSet;
30 use syntax::symbol::{Symbol, sym};
31 use rustc::ich::{ATTR_PARTITION_REUSED, ATTR_PARTITION_CODEGENED,
32 ATTR_EXPECTED_CGU_REUSE};
34 const MODULE: Symbol = sym::module;
35 const CFG: Symbol = sym::cfg;
36 const KIND: Symbol = sym::kind;
38 pub fn assert_module_sources(tcx: TyCtxt<'_>) {
39 tcx.dep_graph.with_ignore(|| {
40 if tcx.sess.opts.incremental.is_none() {
44 let available_cgus = tcx
45 .collect_and_partition_mono_items(LOCAL_CRATE)
48 .map(|cgu| cgu.name())
49 .collect::<BTreeSet<Symbol>>();
51 let ams = AssertModuleSource {
56 for attr in &tcx.hir().krate().attrs {
62 struct AssertModuleSource<'tcx> {
64 available_cgus: BTreeSet<Symbol>,
67 impl AssertModuleSource<'tcx> {
68 fn check_attr(&self, attr: &ast::Attribute) {
69 let (expected_reuse, comp_kind) = if attr.check_name(ATTR_PARTITION_REUSED) {
70 (CguReuse::PreLto, ComparisonKind::AtLeast)
71 } else if attr.check_name(ATTR_PARTITION_CODEGENED) {
72 (CguReuse::No, ComparisonKind::Exact)
73 } else if attr.check_name(ATTR_EXPECTED_CGU_REUSE) {
74 match &self.field(attr, KIND).as_str()[..] {
75 "no" => (CguReuse::No, ComparisonKind::Exact),
76 "pre-lto" => (CguReuse::PreLto, ComparisonKind::Exact),
77 "post-lto" => (CguReuse::PostLto, ComparisonKind::Exact),
78 "any" => (CguReuse::PreLto, ComparisonKind::AtLeast),
80 self.tcx.sess.span_fatal(
82 &format!("unknown cgu-reuse-kind `{}` specified", other));
89 if !self.tcx.sess.opts.debugging_opts.query_dep_graph {
90 self.tcx.sess.span_fatal(
92 &format!("found CGU-reuse attribute but `-Zquery-dep-graph` \
96 if !self.check_config(attr) {
97 debug!("check_attr: config does not match, ignoring attr");
101 let user_path = self.field(attr, MODULE).as_str().to_string();
102 let crate_name = self.tcx.crate_name(LOCAL_CRATE).as_str().to_string();
104 if !user_path.starts_with(&crate_name) {
105 let msg = format!("Found malformed codegen unit name `{}`. \
106 Codegen units names must always start with the name of the \
107 crate (`{}` in this case).", user_path, crate_name);
108 self.tcx.sess.span_fatal(attr.span, &msg);
111 // Split of the "special suffix" if there is one.
112 let (user_path, cgu_special_suffix) = if let Some(index) = user_path.rfind(".") {
113 (&user_path[..index], Some(&user_path[index + 1 ..]))
115 (&user_path[..], None)
118 let mut cgu_path_components = user_path.split('-').collect::<Vec<_>>();
120 // Remove the crate name
121 assert_eq!(cgu_path_components.remove(0), crate_name);
123 let cgu_name_builder = &mut CodegenUnitNameBuilder::new(self.tcx);
124 let cgu_name = cgu_name_builder.build_cgu_name(LOCAL_CRATE,
128 debug!("mapping '{}' to cgu name '{}'", self.field(attr, MODULE), cgu_name);
130 if !self.available_cgus.contains(&cgu_name) {
131 self.tcx.sess.span_err(attr.span,
132 &format!("no module named `{}` (mangled: {}). \
133 Available modules: {}",
138 .map(|cgu| cgu.as_str().to_string())
143 self.tcx.sess.cgu_reuse_tracker.set_expectation(&cgu_name.as_str(),
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() {
156 self.tcx.sess.span_fatal(
158 &format!("associated value expected for `{}`", name));
163 self.tcx.sess.span_fatal(
165 &format!("no field `{}`", name));
168 /// Scan for a `cfg="foo"` attribute and check whether we have a
169 /// cfg flag called `foo`.
170 fn check_config(&self, attr: &ast::Attribute) -> bool {
171 let config = &self.tcx.sess.parse_sess.config;
172 let value = self.field(attr, CFG);
173 debug!("check_config(config={:?}, value={:?})", config, value);
174 if config.iter().any(|&(name, _)| name == value) {
175 debug!("check_config: matched");
178 debug!("check_config: no match found");