Add -Zerror-metrics=PATH to save diagnostic metadata to disk

Add nightly only flag to store information about encountered errors
to disk. The information being tracked is:

 - Error code
 - Path to error being emitted
 - Number of subdiagnostics
 - Number of structured suggestions

Author: estebank

compiler/rustc_errors/src/emitter.rs

@@ -30,6 +30,7 @@ use rustc_span::hygiene::{ExpnKind, MacroKind};
 use std::borrow::Cow;
 use std::cmp::{max, min, Reverse};
 use std::error::Report;
+use std::fs::File;
 use std::io::prelude::*;
 use std::io::{self, IsTerminal};
 use std::iter;
@@ -538,7 +539,7 @@ impl Emitter for EmitterWriter {
             &primary_span,
             &children,
             suggestions,
-            self.track_diagnostics.then_some(&diag.emitted_at),
+            &diag.emitted_at,
         );
     }
 
@@ -637,6 +638,7 @@ pub struct EmitterWriter {
 
     macro_backtrace: bool,
     track_diagnostics: bool,
+    metrics: Option<File>,
     terminal_url: TerminalUrl,
 }
 
@@ -666,6 +668,7 @@ impl EmitterWriter {
             diagnostic_width: None,
             macro_backtrace: false,
             track_diagnostics: false,
+            metrics: None,
             terminal_url: TerminalUrl::No,
         }
     }
@@ -2079,15 +2082,27 @@ impl EmitterWriter {
         span: &MultiSpan,
         children: &[SubDiagnostic],
         suggestions: &[CodeSuggestion],
-        emitted_at: Option<&DiagnosticLocation>,
+        emitted_at_location: &DiagnosticLocation,
     ) {
+        let emitted_at = self.track_diagnostics.then_some(emitted_at_location);
         let max_line_num_len = if self.ui_testing {
             ANONYMIZED_LINE_NUM.len()
         } else {
             let n = self.get_max_line_num(span, children);
             num_decimal_digits(n)
         };
 
+        if let Some(ref mut file) = &mut self.metrics {
+            let _ = writeln!(
+                file,
+                "{:?},{:?},{},{}",
+                code,
+                emitted_at_location,
+                children.len(),
+                suggestions.len()
+            );
+        }
+
         match self.emit_messages_default_inner(
             span,
             messages,

compiler/rustc_errors/src/lib.rs

@@ -514,7 +514,7 @@ fn default_track_diagnostic(d: &mut Diagnostic, f: &mut dyn FnMut(&mut Diagnosti
 pub static TRACK_DIAGNOSTICS: AtomicRef<fn(&mut Diagnostic, &mut dyn FnMut(&mut Diagnostic))> =
     AtomicRef::new(&(default_track_diagnostic as _));
 
-#[derive(Copy, Clone, Default)]
+#[derive(Clone, Default)]
 pub struct DiagCtxtFlags {
     /// If false, warning-level lints are suppressed.
     /// (rustc: see `--allow warnings` and `--cap-lints`)
@@ -535,6 +535,8 @@ pub struct DiagCtxtFlags {
     pub deduplicate_diagnostics: bool,
     /// Track where errors are created. Enabled with `-Ztrack-diagnostics`.
     pub track_diagnostics: bool,
+    /// Track whether error metrics are stored. Enabled with `-Zerror-metrics=path`.
+    pub metrics: Option<PathBuf>,
 }
 
 impl Drop for DiagCtxtInner {

compiler/rustc_session/src/config.rs

@@ -1165,6 +1165,7 @@ impl UnstableOptions {
             macro_backtrace: self.macro_backtrace,
             deduplicate_diagnostics: self.deduplicate_diagnostics,
             track_diagnostics: self.track_diagnostics,
+            metrics: self.error_metrics.clone(),
         }
     }
 }

compiler/rustc_session/src/options.rs

@@ -1617,6 +1617,8 @@ options! {
         "enables LTO for dylib crate type"),
     ehcont_guard: bool = (false, parse_bool, [TRACKED],
         "generate Windows EHCont Guard tables"),
+    error_metrics: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
+        "stores metrics about the errors being emitted by rustc to disk"),
     emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
         "emit a section containing stack size metadata (default: no)"),
     emit_thin_lto: bool = (true, parse_bool, [TRACKED],

compiler/rustc_session/src/session.rs

@@ -41,6 +41,7 @@ use std::any::Any;
 use std::cell::{self, RefCell};
 use std::env;
 use std::fmt;
+use std::fs::File;
 use std::ops::{Div, Mul};
 use std::path::{Path, PathBuf};
 use std::str::FromStr;
@@ -1009,6 +1010,12 @@ fn default_emitter(
                 );
                 Box::new(emitter.ui_testing(sopts.unstable_opts.ui_testing))
             } else {
+                let metrics = sopts.unstable_opts.error_metrics.as_ref().and_then(|path| {
+                    let mut path = path.clone();
+                    std::fs::create_dir_all(&path).ok()?;
+                    path.push(format!("error_metrics_{}", std::process::id()));
+                    File::options().create(true).append(true).open(&path).ok()
+                });
                 let emitter = EmitterWriter::stderr(color_config, fallback_bundle)
                     .fluent_bundle(bundle)
                     .sm(Some(source_map))
@@ -1018,6 +1025,7 @@ fn default_emitter(
                     .macro_backtrace(macro_backtrace)
                     .track_diagnostics(track_diagnostics)
                     .terminal_url(terminal_url)
+                    .metrics(metrics)
                     .ignored_directories_in_source_blocks(
                         sopts.unstable_opts.ignore_directory_in_diagnostics_source_blocks.clone(),
                     );