Centralize CFG_* values in rustc_session crate instead of calling option_env!() from multiple crates

Author: luca-barbieri

src/librustc_ast_passes/feature_gate.rs

@@ -6,6 +6,7 @@ use rustc_errors::{struct_span_err, Handler};
 use rustc_feature::{AttributeGate, BUILTIN_ATTRIBUTE_MAP};
 use rustc_feature::{Features, GateIssue, UnstableFeatures};
 use rustc_session::parse::{feature_err, feature_err_issue, ParseSess};
+use rustc_session::CFG_RELEASE_CHANNEL;
 use rustc_span::source_map::Spanned;
 use rustc_span::symbol::sym;
 use rustc_span::Span;
@@ -657,7 +658,7 @@ fn maybe_stage_features(span_handler: &Handler, krate: &ast::Crate, unstable: Un
                 attr.span,
                 E0554,
                 "`#![feature]` may not be used on the {} release channel",
-                option_env!("CFG_RELEASE_CHANNEL").unwrap_or("(unknown)")
+                CFG_RELEASE_CHANNEL.unwrap_or("(unknown)")
             )
             .emit();
         }

src/librustc_codegen_llvm/debuginfo/metadata.rs

@@ -40,6 +40,7 @@ use rustc_middle::ty::Instance;
 use rustc_middle::ty::{self, AdtKind, ParamEnv, Ty, TyCtxt};
 use rustc_middle::{bug, span_bug};
 use rustc_session::config::{self, DebugInfo};
+use rustc_session::CFG_VERSION;
 use rustc_span::symbol::{Interner, Symbol};
 use rustc_span::{self, SourceFile, SourceFileHash, Span};
 use rustc_target::abi::{Abi, Align, DiscriminantKind, HasDataLayout, Integer, LayoutOf};
@@ -909,8 +910,7 @@ pub fn compile_unit_metadata(
     }
 
     debug!("compile_unit_metadata: {:?}", name_in_debuginfo);
-    let rustc_producer =
-        format!("rustc version {}", option_env!("CFG_VERSION").expect("CFG_VERSION"),);
+    let rustc_producer = format!("rustc version {}", CFG_VERSION.expect("CFG_VERSION"),);
     // FIXME(#41252) Remove "clang LLVM" if we can get GDB and LLVM to play nice.
     let producer = format!("clang LLVM ({})", rustc_producer);
 

src/librustc_codegen_ssa/back/link.rs

@@ -10,7 +10,7 @@ use rustc_session::output::{check_file_is_writeable, invalid_output_for_target,
 use rustc_session::search_paths::PathKind;
 /// For all the linkers we support, and information they might
 /// need out of the shared crate context before we get rid of it.
-use rustc_session::{filesearch, Session};
+use rustc_session::{filesearch, Session, CFG_PREFIX, CFG_RELEASE_CHANNEL};
 use rustc_span::symbol::Symbol;
 use rustc_target::spec::{LinkerFlavor, PanicStrategy, RelroLevel};
 
@@ -698,9 +698,7 @@ fn link_sanitizer_runtime(sess: &Session, crate_type: config::CrateType, linker:
     let default_sysroot = filesearch::get_or_default_sysroot();
     let default_tlib =
         filesearch::make_target_lib_path(&default_sysroot, sess.opts.target_triple.triple());
-    let channel = option_env!("CFG_RELEASE_CHANNEL")
-        .map(|channel| format!("-{}", channel))
-        .unwrap_or_default();
+    let channel = CFG_RELEASE_CHANNEL.map(|channel| format!("-{}", channel)).unwrap_or_default();
 
     match sess.opts.target_triple.triple() {
         "x86_64-apple-darwin" => {
@@ -1402,7 +1400,7 @@ fn add_rpath_args(
     if sess.opts.cg.rpath {
         let target_triple = sess.opts.target_triple.triple();
         let mut get_install_prefix_lib_path = || {
-            let install_prefix = option_env!("CFG_PREFIX").expect("CFG_PREFIX");
+            let install_prefix = CFG_PREFIX.expect("CFG_PREFIX");
             let tlib = filesearch::relative_target_lib_path(&sess.sysroot, target_triple);
             let mut path = PathBuf::from(install_prefix);
             path.push(&tlib);

src/librustc_driver/lib.rs

@@ -36,7 +36,9 @@ use rustc_session::config::nightly_options;
 use rustc_session::config::{ErrorOutputType, Input, OutputType, PrintRequest};
 use rustc_session::getopts;
 use rustc_session::lint::{Lint, LintId};
-use rustc_session::{config, DiagnosticOutput, Session};
+use rustc_session::{
+    config, DiagnosticOutput, Session, CFG_RELEASE, CFG_VERSION, CFG_VER_DATE, CFG_VER_HASH,
+};
 use rustc_session::{early_error, early_warn};
 use rustc_span::source_map::{FileLoader, FileName};
 use rustc_span::symbol::sym;
@@ -748,24 +750,24 @@ impl RustcDefaultCalls {
 
 /// Returns a version string such as "0.12.0-dev".
 fn release_str() -> Option<&'static str> {
-    option_env!("CFG_RELEASE")
+    CFG_RELEASE
 }
 
 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
 fn commit_hash_str() -> Option<&'static str> {
-    option_env!("CFG_VER_HASH")
+    CFG_VER_HASH
 }
 
 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
 fn commit_date_str() -> Option<&'static str> {
-    option_env!("CFG_VER_DATE")
+    CFG_VER_DATE
 }
 
 /// Prints version information
 pub fn version(binary: &str, matches: &getopts::Matches) {
     let verbose = matches.opt_present("verbose");
 
-    println!("{} {}", binary, option_env!("CFG_VERSION").unwrap_or("unknown version"));
+    println!("{} {}", binary, CFG_VERSION.unwrap_or("unknown version"));
 
     if verbose {
         fn unw(x: Option<&str>) -> &str {
@@ -1196,7 +1198,7 @@ pub fn report_ice(info: &panic::PanicInfo<'_>, bug_report_url: &str) {
         format!("we would appreciate a bug report: {}", bug_report_url).into(),
         format!(
             "rustc {} running on {}",
-            option_env!("CFG_VERSION").unwrap_or("unknown_version"),
+            CFG_VERSION.unwrap_or("unknown_version"),
             config::host_triple()
         )
         .into(),

src/librustc_incremental/persist/file_format.rs

@@ -26,7 +26,7 @@ const HEADER_FORMAT_VERSION: u16 = 0;
 /// A version string that hopefully is always different for compiler versions
 /// with different encodings of incremental compilation artifacts. Contains
 /// the Git commit hash.
-const RUSTC_VERSION: Option<&str> = option_env!("CFG_VERSION");
+use rustc_session::CFG_VERSION as RUSTC_VERSION;
 
 pub fn write_file_header(stream: &mut Encoder) {
     stream.emit_raw_bytes(FILE_MAGIC);

src/librustc_metadata/rmeta/decoder.rs

@@ -31,7 +31,7 @@ use rustc_middle::ty::codec::TyDecoder;
 use rustc_middle::ty::{self, Ty, TyCtxt};
 use rustc_middle::util::common::record_time;
 use rustc_serialize::{opaque, Decodable, Decoder, SpecializedDecoder};
-use rustc_session::Session;
+use rustc_session::{Session, CFG_VIRTUAL_RUST_SOURCE_BASE_DIR};
 use rustc_span::source_map::{respan, Spanned};
 use rustc_span::symbol::{sym, Symbol};
 use rustc_span::{self, hygiene::MacroKind, BytePos, Pos, Span, DUMMY_SP};
@@ -1463,7 +1463,7 @@ impl<'a, 'tcx> CrateMetadataRef<'a> {
     fn imported_source_files(&self, sess: &Session) -> &'a [ImportedSourceFile] {
         // Translate the virtual `/rustc/$hash` prefix back to a real directory
         // that should hold actual sources, where possible.
-        let virtual_rust_source_base_dir = option_env!("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR")
+        let virtual_rust_source_base_dir = CFG_VIRTUAL_RUST_SOURCE_BASE_DIR
             .map(Path::new)
             .filter(|_| {
                 // Only spend time on further checks if we have what to translate *to*.

src/librustc_metadata/rmeta/mod.rs

@@ -18,6 +18,7 @@ use rustc_middle::ty::{self, ReprOptions, Ty};
 use rustc_serialize::opaque::Encoder;
 use rustc_session::config::SymbolManglingVersion;
 use rustc_session::CrateDisambiguator;
+use rustc_session::CFG_VERSION;
 use rustc_span::edition::Edition;
 use rustc_span::symbol::Symbol;
 use rustc_span::{self, Span};
@@ -34,7 +35,7 @@ mod encoder;
 mod table;
 
 crate fn rustc_version() -> String {
-    format!("rustc {}", option_env!("CFG_VERSION").unwrap_or("unknown version"))
+    format!("rustc {}", CFG_VERSION.unwrap_or("unknown version"))
 }
 
 /// Metadata encoding version.

src/librustc_middle/middle/stability.rs

@@ -16,6 +16,7 @@ use rustc_hir::{self, HirId};
 use rustc_session::lint::builtin::{DEPRECATED, DEPRECATED_IN_FUTURE, SOFT_UNSTABLE};
 use rustc_session::lint::{BuiltinLintDiagnostics, Lint, LintBuffer};
 use rustc_session::parse::feature_err_issue;
+use rustc_session::CFG_RELEASE;
 use rustc_session::{DiagnosticMessageId, Session};
 use rustc_span::symbol::{sym, Symbol};
 use rustc_span::{MultiSpan, Span};
@@ -136,7 +137,7 @@ pub fn deprecation_in_effect(since: &str) -> bool {
         ver.split(|c| c == '.' || c == '-').flat_map(|s| s.parse()).collect()
     }
 
-    if let Some(rustc) = option_env!("CFG_RELEASE") {
+    if let Some(rustc) = CFG_RELEASE {
         let since: Vec<u32> = parse_version(since);
         let rustc: Vec<u32> = parse_version(rustc);
         // We simply treat invalid `since` attributes as relating to a previous

src/librustc_session/build.rs

@@ -0,0 +1,12 @@
+fn main() {
+    println!("cargo:rerun-if-changed=build.rs");
+    println!("cargo:rerun-if-env-changed=CFG_RELEASE");
+    println!("cargo:rerun-if-env-changed=CFG_RELEASE_CHANNEL");
+    println!("cargo:rerun-if-env-changed=CFG_VERSION");
+    println!("cargo:rerun-if-env-changed=CFG_VER_DATE");
+    println!("cargo:rerun-if-env-changed=CFG_VER_HASH");
+    println!("cargo:rerun-if-env-changed=CFG_PREFIX");
+    println!("cargo:rerun-if-env-changed=CFG_VIRTUAL_RUST_SOURCE_BASE_DIR");
+    println!("cargo:rerun-if-env-changed=CFG_COMPILER_HOST_TRIPLE");
+    println!("cargo:rerun-if-env-changed=CFG_LIBDIR_RELATIVE");
+}

src/librustc_session/config.rs

@@ -540,7 +540,7 @@ pub fn host_triple() -> &'static str {
     // Instead of grabbing the host triple (for the current host), we grab (at
     // compile time) the target triple that this rustc is built with and
     // calling that (at runtime) the host triple.
-    (option_env!("CFG_COMPILER_HOST_TRIPLE")).expect("CFG_COMPILER_HOST_TRIPLE")
+    option_env!("CFG_COMPILER_HOST_TRIPLE").expect("CFG_COMPILER_HOST_TRIPLE")
 }
 
 impl Default for Options {

src/librustc_session/session.rs

@@ -32,6 +32,16 @@ use std::path::PathBuf;
 use std::sync::Arc;
 use std::time::Duration;
 
+pub static CFG_VERSION: Option<&str> = option_env!("CFG_VERSION");
+pub static CFG_RELEASE: Option<&str> = option_env!("CFG_RELEASE");
+pub static CFG_RELEASE_CHANNEL: Option<&str> = option_env!("CFG_RELEASE_CHANNEL");
+pub static CFG_VER_HASH: Option<&str> = option_env!("CFG_VER_HASH");
+pub static CFG_VER_DATE: Option<&str> = option_env!("CFG_VER_DATE");
+
+pub static CFG_PREFIX: Option<&str> = option_env!("CFG_PREFIX");
+pub static CFG_VIRTUAL_RUST_SOURCE_BASE_DIR: Option<&str> =
+    option_env!("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR");
+
 pub struct OptimizationFuel {
     /// If `-zfuel=crate=n` is specified, initially set to `n`, otherwise `0`.
     remaining: u64,

src/librustc_typeck/check/mod.rs

@@ -128,7 +128,7 @@ use rustc_middle::ty::{
 use rustc_session::config::{self, EntryFnType};
 use rustc_session::lint;
 use rustc_session::parse::feature_err;
-use rustc_session::Session;
+use rustc_session::{Session, CFG_VERSION};
 use rustc_span::hygiene::DesugaringKind;
 use rustc_span::source_map::{original_sp, DUMMY_SP};
 use rustc_span::symbol::{kw, sym, Ident};
@@ -5806,7 +5806,7 @@ fn fatally_break_rust(sess: &Session) {
     );
     handler.note_without_error(&format!(
         "rustc {} running on {}",
-        option_env!("CFG_VERSION").unwrap_or("unknown_version"),
+        CFG_VERSION.unwrap_or("unknown_version"),
         config::host_triple(),
     ));
 }