Add TyCtx::env_var

Author: madsmtm

compiler/rustc_errors/src/diagnostic_impls.rs

@@ -242,6 +242,12 @@ impl IntoDiagArg for std::ffi::CString {
     }
 }
 
+impl IntoDiagArg for std::ffi::OsString {
+    fn into_diag_arg(self) -> DiagArgValue {
+        DiagArgValue::Str(Cow::Owned(self.to_string_lossy().into_owned()))
+    }
+}
+
 impl IntoDiagArg for rustc_data_structures::small_c_str::SmallCStr {
     fn into_diag_arg(self) -> DiagArgValue {
         DiagArgValue::Str(Cow::Owned(self.to_string_lossy().into_owned()))

compiler/rustc_interface/messages.ftl

@@ -4,6 +4,9 @@ interface_cant_emit_mir =
 interface_emoji_identifier =
     identifiers cannot contain emoji: `{$ident}`
 
+interface_env_var_not_unicode =
+    cannot read environment variable "{$key}" with value "{$var}", since it contains non-unicode data
+
 interface_error_writing_dependencies =
     error writing dependencies to `{$path}`: {$error}
 

compiler/rustc_interface/src/errors.rs

@@ -1,3 +1,4 @@
+use std::ffi::OsString;
 use std::io;
 use std::path::Path;
 
@@ -21,6 +22,13 @@ pub struct EmojiIdentifier {
     pub ident: Symbol,
 }
 
+#[derive(Diagnostic)]
+#[diag(interface_env_var_not_unicode)]
+pub struct EnvVarNotUnicode {
+    pub key: Symbol,
+    pub var: OsString,
+}
+
 #[derive(Diagnostic)]
 #[diag(interface_mixed_bin_crate)]
 pub struct MixedBinCrate;

compiler/rustc_interface/src/passes.rs

@@ -1,4 +1,5 @@
 use std::any::Any;
+use std::env::VarError;
 use std::ffi::OsString;
 use std::io::{self, BufWriter, Write};
 use std::path::{Path, PathBuf};
@@ -321,6 +322,24 @@ fn early_lint_checks(tcx: TyCtxt<'_>, (): ()) {
     )
 }
 
+fn env_var(tcx: TyCtxt<'_>, key: Symbol) -> Option<Symbol> {
+    let var = match env::var(key.as_str()) {
+        Ok(var) => Some(Symbol::intern(&var)),
+        Err(VarError::NotPresent) => None,
+        Err(VarError::NotUnicode(var)) => {
+            tcx.dcx().emit_err(errors::EnvVarNotUnicode { key, var });
+            None
+        }
+    };
+    // Also add the variable to Cargo's dependency tracking
+    //
+    // NOTE: This only works for passes run before `write_dep_info`. See that
+    // for extension points for configuring environment variables to be
+    // properly change-tracked.
+    tcx.sess.psess.env_depinfo.borrow_mut().insert((key, var));
+    var
+}
+
 // Returns all the paths that correspond to generated files.
 fn generated_output_paths(
     tcx: TyCtxt<'_>,
@@ -632,6 +651,9 @@ pub fn write_dep_info(tcx: TyCtxt<'_>) {
     // the side-effect of providing a complete set of all
     // accessed files and env vars.
     let _ = tcx.resolver_for_lowering();
+    // Similarly, analysis, codegen and linking should state which environment
+    // variables they depend on here, as those passes are run after this pass,
+    // but we'll need the information when emitting dependency info to Cargo.
 
     let sess = tcx.sess;
     let _timer = sess.timer("write_dep_info");
@@ -685,6 +707,7 @@ pub static DEFAULT_QUERY_PROVIDERS: LazyLock<Providers> = LazyLock::new(|| {
         |tcx, _| tcx.arena.alloc_from_iter(tcx.resolutions(()).stripped_cfg_items.steal());
     providers.resolutions = |tcx, ()| tcx.resolver_for_lowering_raw(()).1;
     providers.early_lint_checks = early_lint_checks;
+    providers.env_var = env_var;
     proc_macro_decls::provide(providers);
     rustc_const_eval::provide(providers);
     rustc_middle::hir::provide(providers);

compiler/rustc_middle/src/query/erase.rs

@@ -255,6 +255,7 @@ trivial! {
     Option<rustc_span::def_id::DefId>,
     Option<rustc_span::def_id::LocalDefId>,
     Option<rustc_span::Span>,
+    Option<rustc_span::Symbol>,
     Option<rustc_abi::FieldIdx>,
     Option<rustc_target::spec::PanicStrategy>,
     Option<usize>,

compiler/rustc_middle/src/query/mod.rs

@@ -121,6 +121,23 @@ rustc_queries! {
         desc { "perform lints prior to macro expansion" }
     }
 
+    /// Tracked access to environment variables.
+    ///
+    /// Useful for the implementation of `std::env!`, `proc-macro`s change
+    /// detection and other changes in the compiler's behaviour that is easier
+    /// to control with an environment variable than a flag.
+    ///
+    /// NOTE: This currently does not work with dependency info in the
+    /// analysis, codegen and linking passes, place extra code at the top of
+    /// `rustc_interface::passes::write_dep_info` to make that work.
+    ///
+    /// Will emit an error and return `None` if the variable is not UTF-8.
+    query env_var(key: Symbol) -> Option<Symbol> {
+        // Environment variables are global state
+        eval_always
+        desc { "get the value of an environment variable" }
+    }
+
     query resolutions(_: ()) -> &'tcx ty::ResolverGlobalCtxt {
         no_hash
         desc { "getting the resolver outputs" }