Add RUSTC_PROGRESS env var to show the current queries and their arguments

Author: oli-obk

Cargo.lock

@@ -675,6 +675,19 @@ dependencies = [
  "windows",
 ]
 
+[[package]]
+name = "console"
+version = "0.15.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c926e00cc70edefdc64d3a5ff31cc65bb97a3460097762bd23afb4d8145fccf8"
+dependencies = [
+ "encode_unicode",
+ "lazy_static",
+ "libc",
+ "unicode-width",
+ "windows-sys 0.45.0",
+]
+
 [[package]]
 name = "convert_case"
 version = "0.4.0"
@@ -999,6 +1012,12 @@ dependencies = [
  "log",
 ]
 
+[[package]]
+name = "encode_unicode"
+version = "0.3.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a357d28ed41a50f9c765dbfe56cbc04a64e53e5fc58ba79fbc34c10ef3df831f"
+
 [[package]]
 name = "encoding_rs"
 version = "0.8.32"
@@ -1801,6 +1820,19 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "indicatif"
+version = "0.17.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8ff8cc23a7393a397ed1d7f56e6365cba772aba9f9912ab968b03043c395d057"
+dependencies = [
+ "console",
+ "instant",
+ "number_prefix",
+ "portable-atomic",
+ "unicode-width",
+]
+
 [[package]]
 name = "indoc"
 version = "1.0.9"
@@ -2391,6 +2423,12 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "number_prefix"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830b246a0e5f20af87141b25c173cd1b609bd7779a4617d6ec582abaf90870f3"
+
 [[package]]
 name = "object"
 version = "0.31.1"
@@ -2589,7 +2627,7 @@ dependencies = [
  "libc",
  "redox_syscall 0.3.5",
  "smallvec",
- "windows-targets",
+ "windows-targets 0.48.1",
 ]
 
 [[package]]
@@ -2724,6 +2762,12 @@ dependencies = [
  "rustc-hash",
 ]
 
+[[package]]
+name = "portable-atomic"
+version = "1.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "edc55135a600d700580e406b4de0d59cb9ad25e344a3a091a97ded2622ec4ec6"
+
 [[package]]
 name = "ppv-lite86"
 version = "0.2.17"
@@ -4200,6 +4244,7 @@ dependencies = [
  "atty",
  "bitflags 1.3.2",
  "getopts",
+ "indicatif",
  "libc",
  "rustc_ast",
  "rustc_data_structures",
@@ -5833,7 +5878,7 @@ version = "0.48.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f"
 dependencies = [
- "windows-targets",
+ "windows-targets 0.48.1",
 ]
 
 [[package]]
@@ -5867,13 +5912,37 @@ dependencies = [
  "windows_x86_64_msvc 0.42.2",
 ]
 
+[[package]]
+name = "windows-sys"
+version = "0.45.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0"
+dependencies = [
+ "windows-targets 0.42.2",
+]
+
 [[package]]
 name = "windows-sys"
 version = "0.48.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
 dependencies = [
- "windows-targets",
+ "windows-targets 0.48.1",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071"
+dependencies = [
+ "windows_aarch64_gnullvm 0.42.2",
+ "windows_aarch64_msvc 0.42.2",
+ "windows_i686_gnu 0.42.2",
+ "windows_i686_msvc 0.42.2",
+ "windows_x86_64_gnu 0.42.2",
+ "windows_x86_64_gnullvm 0.42.2",
+ "windows_x86_64_msvc 0.42.2",
 ]
 
 [[package]]

compiler/rustc_query_impl/src/plumbing.rs

@@ -27,6 +27,7 @@ use rustc_query_system::{LayoutOfDepth, QueryOverflow};
 use rustc_serialize::Decodable;
 use rustc_serialize::Encodable;
 use rustc_session::Limit;
+use rustc_session::ProgressBars;
 use rustc_span::def_id::LOCAL_CRATE;
 use std::num::NonZeroU64;
 use thin_vec::ThinVec;
@@ -413,6 +414,24 @@ where
     value
 }
 
+macro_rules! trace_query {
+    ($tcx:expr, $name:ident, $key:ident) => {
+        #[cfg(debug_assertions)]
+        let _guard = tracing::span!(tracing::Level::TRACE, stringify!($name), ?$key).entered();
+        let _spinner = $tcx
+            .sess
+            .progress_bars
+            .as_ref()
+            .map(|bars| $crate::plumbing::update_spinner($tcx, bars, stringify!($name)));
+    };
+}
+
+#[inline(never)]
+#[cold]
+pub fn update_spinner(tcx: TyCtxt<'_>, bars: &ProgressBars, name: &'static str) -> impl Sized {
+    tcx.sess.push_spinner(bars, name)
+}
+
 fn force_from_dep_node<'tcx, Q>(query: Q, tcx: TyCtxt<'tcx>, dep_node: DepNode) -> bool
 where
     Q: QueryConfig<QueryCtxt<'tcx>>,
@@ -437,7 +456,7 @@ where
 
     if let Some(key) = Q::Key::recover(tcx, &dep_node) {
         #[cfg(debug_assertions)]
-        let _guard = tracing::span!(tracing::Level::TRACE, stringify!($name), ?key).entered();
+        let _guard = tracing::span!(tracing::Level::TRACE, "force", ?dep_node.kind, ?key).entered();
         force_query(query, QueryCtxt::new(tcx), key, dep_node);
         true
     } else {
@@ -531,8 +550,7 @@ macro_rules! define_queries {
                     key: queries::$name::Key<'tcx>,
                     mode: QueryMode,
                 ) -> Option<Erase<queries::$name::Value<'tcx>>> {
-                    #[cfg(debug_assertions)]
-                    let _guard = tracing::span!(tracing::Level::TRACE, stringify!($name), ?key).entered();
+                    trace_query!(tcx, $name, key);
                     get_query_incr(
                         QueryType::config(tcx),
                         QueryCtxt::new(tcx),
@@ -573,8 +591,7 @@ macro_rules! define_queries {
                     cache_on_disk: |tcx, key| ::rustc_middle::query::cached::$name(tcx, key),
                     execute_query: |tcx, key| erase(tcx.$name(key)),
                     compute: |tcx, key| {
-                        #[cfg(debug_assertions)]
-                        let _guard = tracing::span!(tracing::Level::TRACE, stringify!($name), ?key).entered();
+                        trace_query!(tcx, $name, key);
                         __rust_begin_short_backtrace(||
                             queries::$name::provided_to_erased(
                                 tcx,

compiler/rustc_session/Cargo.toml

@@ -22,6 +22,7 @@ rustc_ast = { path = "../rustc_ast" }
 rustc_lint_defs = { path = "../rustc_lint_defs" }
 smallvec = "1.8.1"
 termize = "0.1.1"
+indicatif = "0.17.5"
 
 [target.'cfg(unix)'.dependencies]
 libc = "0.2"

compiler/rustc_session/src/lib.rs

@@ -2,6 +2,7 @@
 #![feature(let_chains)]
 #![feature(min_specialization)]
 #![feature(never_type)]
+#![feature(local_key_cell_methods)]
 #![feature(lazy_cell)]
 #![feature(option_get_or_insert_default)]
 #![feature(rustc_attrs)]
@@ -33,6 +34,8 @@ pub mod config;
 pub mod cstore;
 pub mod filesearch;
 mod options;
+mod progress;
+pub use progress::*;
 pub mod search_paths;
 
 mod session;

compiler/rustc_session/src/progress.rs

@@ -0,0 +1,86 @@
+use std::{
+    cell::RefCell,
+    sync::mpsc::{Sender, TryRecvError},
+    thread::ThreadId,
+    time::Duration,
+};
+
+use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
+use rustc_data_structures::fx::FxHashMap;
+
+use crate::Session;
+
+thread_local! {
+    static CURRENT_SPINNER: RefCell<Option<(ProgressBar, usize)>> = RefCell::new(None);
+}
+
+pub struct ProgressBars {
+    sender: Sender<Msg>,
+}
+
+enum Msg {
+    Pop { thread: ThreadId },
+    Push { thread: ThreadId, name: &'static str },
+}
+
+impl Session {
+    /// Starts up a thread that makes sure all the threads' messages are collected and processed
+    /// in one central location, and thus rendered correctly.
+    pub(crate) fn init_progress_bars() -> ProgressBars {
+        let (sender, receiver) = std::sync::mpsc::channel();
+        std::thread::spawn(move || {
+            let bars = MultiProgress::new();
+            let mut threads: FxHashMap<ThreadId, Vec<_>> = FxHashMap::default();
+            'outer: loop {
+                std::thread::sleep(Duration::from_millis(100));
+                loop {
+                    match receiver.try_recv() {
+                        Ok(val) => match val {
+                            Msg::Pop { thread } => {
+                                threads.get_mut(&thread).unwrap().pop();
+                            }
+                            Msg::Push { thread, name } => {
+                                let stack = threads.entry(thread).or_default();
+
+                                let mut template = String::new();
+                                use std::fmt::Write;
+                                if !stack.is_empty() {
+                                    for _ in 1..stack.len() {
+                                        write!(template, " ").unwrap();
+                                    }
+                                    write!(template, "└").unwrap();
+                                }
+                                write!(template, "{{spinner}} {{msg}}").unwrap();
+
+                                let spinner = ProgressBar::new_spinner()
+                                    .with_message(name)
+                                    .with_style(ProgressStyle::with_template(&template).unwrap());
+                                let spinner = bars.add(spinner);
+                                stack.push(spinner)
+                            }
+                        },
+                        Err(TryRecvError::Disconnected) => break 'outer,
+                        Err(TryRecvError::Empty) => break,
+                    }
+                }
+                for thread in threads.values() {
+                    for spinner in thread {
+                        spinner.tick()
+                    }
+                }
+            }
+        });
+        ProgressBars { sender }
+    }
+    pub fn push_spinner(&self, bars: &ProgressBars, name: &'static str) -> impl Sized {
+        let thread = std::thread::current().id();
+        bars.sender.send(Msg::Push { thread, name }).unwrap();
+        struct Spinner(Sender<Msg>, ThreadId);
+        impl Drop for Spinner {
+            fn drop(&mut self) {
+                self.0.send(Msg::Pop { thread: self.1 }).unwrap();
+            }
+        }
+        Spinner(bars.sender.clone(), thread)
+    }
+}

compiler/rustc_session/src/session.rs

@@ -7,6 +7,7 @@ use crate::config::{
 use crate::config::{ErrorOutputType, Input};
 use crate::errors;
 use crate::parse::{add_feature_diagnostics, ParseSess};
+use crate::progress::ProgressBars;
 use crate::search_paths::{PathKind, SearchPath};
 use crate::{filesearch, lint};
 
@@ -176,6 +177,10 @@ pub struct Session {
     /// Data about code being compiled, gathered during compilation.
     pub code_stats: CodeStats,
 
+    /// The central object where progress information should be displayed in.
+    /// Is `Some` if `RUSTC_PROGRESS` is set.
+    pub progress_bars: Option<ProgressBars>,
+
     /// Tracks fuel info if `-zfuel=crate=n` is specified.
     optimization_fuel: Lock<OptimizationFuel>,
 
@@ -1506,6 +1511,8 @@ pub fn build_session(
     let asm_arch =
         if target_cfg.allow_asm { InlineAsmArch::from_str(&target_cfg.arch).ok() } else { None };
 
+    let progress_bars = std::env::var_os("RUSTC_PROGRESS").map(|_| Session::init_progress_bars());
+
     let sess = Session {
         target: target_cfg,
         host,
@@ -1528,6 +1535,7 @@ pub fn build_session(
             normalize_projection_ty: AtomicUsize::new(0),
         },
         code_stats: Default::default(),
+        progress_bars,
         optimization_fuel,
         print_fuel,
         jobserver: jobserver::client(),

src/tools/tidy/src/deps.rs

@@ -128,6 +128,7 @@ const PERMITTED_RUSTC_DEPENDENCIES: &[&str] = &[
     "cc",
     "cfg-if",
     "compiler_builtins",
+    "console",      // Dependency of indicatif
     "convert_case", // dependency of derive_more
     "cpufeatures",
     "crc32fast",
@@ -146,6 +147,7 @@ const PERMITTED_RUSTC_DEPENDENCIES: &[&str] = &[
     "either",
     "elsa",
     "ena",
+    "encode_unicode", // Dependency of indicatif
     "equivalent",
     "errno",
     "errno-dragonfly",
@@ -171,6 +173,7 @@ const PERMITTED_RUSTC_DEPENDENCIES: &[&str] = &[
     "icu_provider_adapters",
     "icu_provider_macros",
     "indexmap",
+    "indicatif",
     "instant",
     "intl-memoizer",
     "intl_pluralrules",
@@ -194,6 +197,7 @@ const PERMITTED_RUSTC_DEPENDENCIES: &[&str] = &[
     "miniz_oxide",
     "nu-ansi-term",
     "num_cpus",
+    "number_prefix", // Dependency of indicatif
     "object",
     "odht",
     "once_cell",
@@ -204,6 +208,7 @@ const PERMITTED_RUSTC_DEPENDENCIES: &[&str] = &[
     "perf-event-open-sys",
     "pin-project-lite",
     "polonius-engine",
+    "portable-atomic", // Dependency of indicatif
     "ppv-lite86",
     "proc-macro-hack",
     "proc-macro2",