Extend memory analysis to lint command

Summary:
Move the `print_memory_usage` function to the `reporting` module and use it from the `lint` command.

This represents the first step towards a generic argument that can be used by various commands and will be merged with similar options existing for other commands.

Reviewed By: alanz

Differential Revision: D84347271

fbshipit-source-id: 3c19b87e3c48bc8e790e1a96eb40014deddd87ac

Author: robertoaloi

crates/elp/src/bin/args.rs

@@ -323,6 +323,10 @@ pub struct Lint {
     /// than one at a time.
     pub one_shot: bool,
 
+    /// Report system memory usage and other statistics
+    #[bpaf(long("report-system-stats"))]
+    pub report_system_stats: bool,
+
     /// Rest of args are space separated list of apps to ignore
     #[bpaf(positional("IGNORED_APPS"))]
     pub ignore_apps: Vec<String>,

crates/elp/src/bin/elp_parse_cli.rs

@@ -26,7 +26,6 @@ use elp::otp_file_to_ignore;
 use elp::server::file_id_to_url;
 use elp_eqwalizer::Mode;
 use elp_ide::Analysis;
-use elp_ide::AnalysisHost;
 use elp_ide::diagnostics;
 use elp_ide::diagnostics::DiagnosticsConfig;
 use elp_ide::diagnostics::LabeledDiagnostics;
@@ -55,6 +54,7 @@ use vfs::AbsPath;
 
 use crate::args::ParseAllElp;
 use crate::reporting;
+use crate::reporting::print_memory_usage;
 
 #[derive(Debug)]
 struct ParseResult {
@@ -63,27 +63,6 @@ struct ParseResult {
     diagnostics: DiagnosticCollection,
 }
 
-fn print_memory_usage(mut host: AnalysisHost, vfs: Vfs, cli: &mut dyn Cli) -> Result<()> {
-    let mem = host.per_query_memory_usage();
-
-    let before = profile::memory_usage();
-    drop(vfs);
-    let vfs = before.allocated - profile::memory_usage().allocated;
-
-    let before = profile::memory_usage();
-    drop(host);
-    let unaccounted = before.allocated - profile::memory_usage().allocated;
-    let remaining = profile::memory_usage().allocated;
-
-    for (name, bytes, entries) in mem {
-        writeln!(cli, "{bytes:>8} {entries:>6} {name}")?;
-    }
-    writeln!(cli, "{vfs:>8}        VFS")?;
-    writeln!(cli, "{unaccounted:>8}        Unaccounted")?;
-    writeln!(cli, "{remaining:>8}        Remaining")?;
-    Ok(())
-}
-
 pub fn parse_all(
     args: &ParseAllElp,
     cli: &mut dyn Cli,

crates/elp/src/bin/lint_cli.rs

@@ -23,6 +23,7 @@ use elp::build::load;
 use elp::build::types::LoadResult;
 use elp::cli::Cli;
 use elp::convert;
+use elp::memory_usage::MemoryUsage;
 use elp::otp_file_to_ignore;
 use elp::read_lint_config_file;
 use elp_eqwalizer::Mode;
@@ -67,12 +68,15 @@ use rayon::prelude::ParallelIterator;
 
 use crate::args::Lint;
 use crate::reporting;
+use crate::reporting::print_memory_usage;
 
 pub fn run_lint_command(
     args: &Lint,
     cli: &mut dyn Cli,
     query_config: &BuckQueryConfig,
 ) -> Result<()> {
+    let memory_start = MemoryUsage::now();
+
     if let Some(to) = &args.to {
         fs::create_dir_all(to)?
     };
@@ -83,7 +87,18 @@ pub fn run_lint_command(
     // errors. No point wasting time if the config is wrong.
     let mut loaded = load_project(args, cli, query_config)?;
 
-    do_codemod(cli, &mut loaded, &diagnostics_config, args)
+    let result = do_codemod(cli, &mut loaded, &diagnostics_config, args);
+
+    let memory_end = MemoryUsage::now();
+    let memory_used = memory_end - memory_start;
+
+    // Print memory usage at the end if requested and format is normal
+    if args.is_format_normal() && args.report_system_stats {
+        print_memory_usage(loaded.analysis_host, loaded.vfs, cli)?;
+        writeln!(cli, "{}", memory_used)?;
+    }
+
+    result
 }
 
 fn get_and_report_diagnostics_config(args: &Lint, cli: &mut dyn Cli) -> Result<DiagnosticsConfig> {

crates/elp/src/bin/reporting.rs

@@ -29,6 +29,7 @@ use elp::cli::Cli;
 use elp::convert;
 use elp::memory_usage::MemoryUsage;
 use elp_ide::Analysis;
+use elp_ide::AnalysisHost;
 use elp_ide::TextRange;
 use elp_ide::elp_ide_db::EqwalizerDiagnostic;
 use elp_ide::elp_ide_db::elp_base_db::AbsPath;
@@ -38,6 +39,7 @@ use indicatif::ProgressBar;
 use itertools::Itertools;
 use lazy_static::lazy_static;
 use parking_lot::Mutex;
+use vfs::Vfs;
 
 pub trait Reporter {
     fn write_eqwalizer_diagnostics(
@@ -372,3 +374,28 @@ pub(crate) fn add_stat(stat: String) {
     let mut stats = STATS.lock();
     stats.push(stat);
 }
+
+pub(crate) fn print_memory_usage(
+    mut host: AnalysisHost,
+    vfs: Vfs,
+    cli: &mut dyn Cli,
+) -> Result<()> {
+    let mem = host.per_query_memory_usage();
+
+    let before = profile::memory_usage();
+    drop(vfs);
+    let vfs = before.allocated - profile::memory_usage().allocated;
+
+    let before = profile::memory_usage();
+    drop(host);
+    let unaccounted = before.allocated - profile::memory_usage().allocated;
+    let remaining = profile::memory_usage().allocated;
+
+    for (name, bytes, entries) in mem {
+        writeln!(cli, "{bytes:>8} {entries:>6} {name}")?;
+    }
+    writeln!(cli, "{vfs:>8}        VFS")?;
+    writeln!(cli, "{unaccounted:>8}        Unaccounted")?;
+    writeln!(cli, "{remaining:>8}        Remaining")?;
+    Ok(())
+}

crates/elp/src/resources/test/lint_help.stdout

@@ -1,4 +1,4 @@
-Usage: [--project PROJECT] [--module MODULE] [--app APP] [--file FILE] [--rebar] [--as PROFILE] [--include-generated] [--include-tests] [--no-diags] [[--format FORMAT]] [--prefix ARG] [--include-erlc-diagnostics] [--include-ct-diagnostics] [--include-edoc-diagnostics] [--include-eqwalizer-diagnostics] [--include-suppressed] [--use-cli-severity] [--diagnostic-ignore CODE] [--diagnostic-filter CODE] [--experimental] [--read-config] [--config-file CONFIG_FILE] [--apply-fix] [--ignore-fix-only] [--in-place] [--to TO] [--recursive] [--with-check] [--check-eqwalize-all] [--one-shot] <IGNORED_APPS>...
+Usage: [--project PROJECT] [--module MODULE] [--app APP] [--file FILE] [--rebar] [--as PROFILE] [--include-generated] [--include-tests] [--no-diags] [[--format FORMAT]] [--prefix ARG] [--include-erlc-diagnostics] [--include-ct-diagnostics] [--include-edoc-diagnostics] [--include-eqwalizer-diagnostics] [--include-suppressed] [--use-cli-severity] [--diagnostic-ignore CODE] [--diagnostic-filter CODE] [--experimental] [--read-config] [--config-file CONFIG_FILE] [--apply-fix] [--ignore-fix-only] [--in-place] [--to TO] [--recursive] [--with-check] [--check-eqwalize-all] [--one-shot] [--report-system-stats] <IGNORED_APPS>...
 
 Available positional items:
     <IGNORED_APPS>  Rest of args are space separated list of apps to ignore
@@ -37,4 +37,5 @@ Available options:
         --check-eqwalize-all             After applying a fix step, check that all eqwalizer project diagnostics are clear, else roll back
         --one-shot                       Apply to all matching diagnostic occurrences at once, rather
                                          than one at a time.
+        --report-system-stats            Report system memory usage and other statistics
     -h, --help                           Prints help information