compiler/rustc_log/src/lib.rs

   1 //! This crate allows tools to enable rust logging without having to magically
   2 //! match rustc's tracing crate version.
   3 //!
   4 //! For example if someone is working on rustc_ast and wants to write some
   5 //! minimal code against it to run in a debugger, with access to the `debug!`
   6 //! logs emitted by rustc_ast, that can be done by writing:
   7 //!
   8 //! ```toml
   9 //! [dependencies]
  10 //! rustc_ast = { path = "../rust/compiler/rustc_ast" }
  11 //! rustc_log = { path = "../rust/compiler/rustc_log" }
  12 //! rustc_span = { path = "../rust/compiler/rustc_span" }
  13 //! ```
  14 //!
  15 //! ```
  16 //! fn main() {
  17 //!     rustc_log::init_rustc_env_logger().unwrap();
  18 //!
  19 //!     let edition = rustc_span::edition::Edition::Edition2021;
  20 //!     rustc_span::create_session_globals_then(edition, || {
  21 //!         /* ... */
  22 //!     });
  23 //! }
  24 //! ```
  25 //!
  26 //! Now `RUSTC_LOG=debug cargo run` will run your minimal main.rs and show
  27 //! rustc's debug logging. In a workflow like this, one might also add
  28 //! `std::env::set_var("RUSTC_LOG", "debug")` to the top of main so that `cargo
  29 //! run` by itself is sufficient to get logs.
  30 //!
  31 //! The reason rustc_log is a tiny separate crate, as opposed to exposing the
  32 //! same things in rustc_driver only, is to enable the above workflow. If you
  33 //! had to depend on rustc_driver in order to turn on rustc's debug logs, that's
  34 //! an enormously bigger dependency tree; every change you make to rustc_ast (or
  35 //! whichever piece of the compiler you are interested in) would involve
  36 //! rebuilding all the rest of rustc up to rustc_driver in order to run your
  37 //! main.rs. Whereas by depending only on rustc_log and the few crates you are
  38 //! debugging, you can make changes inside those crates and quickly run main.rs
  39 //! to read the debug logs.
  40
  41 #![deny(rustc::untranslatable_diagnostic)]
  42 #![deny(rustc::diagnostic_outside_of_impl)]
  43 #![feature(is_terminal)]
  44
  45 use std::env::{self, VarError};
  46 use std::fmt::{self, Display};
  47 use std::io::{self, IsTerminal};
  48 use tracing_core::{Event, Subscriber};
  49 use tracing_subscriber::filter::{Directive, EnvFilter, LevelFilter};
  50 use tracing_subscriber::fmt::{
  51     format::{self, FormatEvent, FormatFields},
  52     FmtContext,
  53 };
  54 use tracing_subscriber::layer::SubscriberExt;
  55
  56 pub fn init_rustc_env_logger() -> Result<(), Error> {
  57     init_env_logger("RUSTC_LOG")
  58 }
  59
  60 /// In contrast to `init_rustc_env_logger` this allows you to choose an env var
  61 /// other than `RUSTC_LOG`.
  62 pub fn init_env_logger(env: &str) -> Result<(), Error> {
  63     let filter = match env::var(env) {
  64         Ok(env) => EnvFilter::new(env),
  65         _ => EnvFilter::default().add_directive(Directive::from(LevelFilter::WARN)),
  66     };
  67
  68     let color_logs = match env::var(String::from(env) + "_COLOR") {
  69         Ok(value) => match value.as_ref() {
  70             "always" => true,
  71             "never" => false,
  72             "auto" => stderr_isatty(),
  73             _ => return Err(Error::InvalidColorValue(value)),
  74         },
  75         Err(VarError::NotPresent) => stderr_isatty(),
  76         Err(VarError::NotUnicode(_value)) => return Err(Error::NonUnicodeColorValue),
  77     };
  78
  79     let verbose_entry_exit = match env::var_os(String::from(env) + "_ENTRY_EXIT") {
  80         None => false,
  81         Some(v) => &v != "0",
  82     };
  83
  84     let layer = tracing_tree::HierarchicalLayer::default()
  85         .with_writer(io::stderr)
  86         .with_indent_lines(true)
  87         .with_ansi(color_logs)
  88         .with_targets(true)
  89         .with_verbose_exit(verbose_entry_exit)
  90         .with_verbose_entry(verbose_entry_exit)
  91         .with_indent_amount(2);
  92     #[cfg(parallel_compiler)]
  93     let layer = layer.with_thread_ids(true).with_thread_names(true);
  94
  95     let subscriber = tracing_subscriber::Registry::default().with(filter).with(layer);
  96     match env::var(format!("{env}_BACKTRACE")) {
  97         Ok(str) => {
  98             let fmt_layer = tracing_subscriber::fmt::layer()
  99                 .with_writer(io::stderr)
 100                 .without_time()
 101                 .event_format(BacktraceFormatter { backtrace_target: str.to_string() });
 102             let subscriber = subscriber.with(fmt_layer);
 103             tracing::subscriber::set_global_default(subscriber).unwrap();
 104         }
 105         Err(_) => {
 106             tracing::subscriber::set_global_default(subscriber).unwrap();
 107         }
 108     };
 109
 110     Ok(())
 111 }
 112
 113 struct BacktraceFormatter {
 114     backtrace_target: String,
 115 }
 116
 117 impl<S, N> FormatEvent<S, N> for BacktraceFormatter
 118 where
 119     S: Subscriber + for<'a> tracing_subscriber::registry::LookupSpan<'a>,
 120     N: for<'a> FormatFields<'a> + 'static,
 121 {
 122     fn format_event(
 123         &self,
 124         _ctx: &FmtContext<'_, S, N>,
 125         mut writer: format::Writer<'_>,
 126         event: &Event<'_>,
 127     ) -> fmt::Result {
 128         let target = event.metadata().target();
 129         if !target.contains(&self.backtrace_target) {
 130             return Ok(());
 131         }
 132         let backtrace = std::backtrace::Backtrace::capture();
 133         writeln!(writer, "stack backtrace: \n{:?}", backtrace)
 134     }
 135 }
 136
 137 pub fn stdout_isatty() -> bool {
 138     io::stdout().is_terminal()
 139 }
 140
 141 pub fn stderr_isatty() -> bool {
 142     io::stderr().is_terminal()
 143 }
 144
 145 #[derive(Debug)]
 146 pub enum Error {
 147     InvalidColorValue(String),
 148     NonUnicodeColorValue,
 149 }
 150
 151 impl std::error::Error for Error {}
 152
 153 impl Display for Error {
 154     fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
 155         match self {
 156             Error::InvalidColorValue(value) => write!(
 157                 formatter,
 158                 "invalid log color value '{value}': expected one of always, never, or auto",
 159             ),
 160             Error::NonUnicodeColorValue => write!(
 161                 formatter,
 162                 "non-Unicode log color value: expected one of always, never, or auto",
 163             ),
 164         }
 165     }
 166 }