Add support for collapsing PHP Xdebug traces

Cargo.toml

@@ -85,6 +85,11 @@ name = "inferno-collapse-guess"
 path = "src/bin/collapse-guess.rs"
 required-features = ["cli"]
 
+[[bin]]
+name = "inferno-collapse-xdebug"
+path = "src/bin/collapse-xdebug.rs"
+required-features = ["cli"]
+
 [[bin]]
 name = "inferno-flamegraph"
 path = "src/bin/flamegraph.rs"

benches/collapse.rs

@@ -2,13 +2,14 @@ use std::fs::File;
 use std::io::{self, Read};
 
 use criterion::*;
-use inferno::collapse::{dtrace, perf, sample, Collapse};
+use inferno::collapse::{dtrace, perf, sample, xdebug, Collapse};
 use libflate::gzip::Decoder;
 use once_cell::sync::Lazy;
 
 const INFILE_DTRACE: &str = "flamegraph/example-dtrace-stacks.txt";
 const INFILE_PERF: &str = "flamegraph/example-perf-stacks.txt.gz";
 const INFILE_SAMPLE: &str = "tests/data/collapse-sample/large.txt.gz";
+const INFILE_XDEBUG: &str = "tests/data/collapse-xdebug/xdebug.bench.xt";
 const SAMPLE_SIZE: usize = 100;
 
 static NTHREADS: Lazy<usize> = Lazy::new(num_cpus::get);
@@ -98,7 +99,7 @@ macro_rules! benchmark_multi {
 benchmark_multi!(dtrace, "dtrace", INFILE_DTRACE);
 benchmark_multi!(perf, "perf", INFILE_PERF);
 benchmark_single!(sample, "sample", INFILE_SAMPLE);
+benchmark_single!(xdebug, "xdebug", INFILE_XDEBUG);
 
-criterion_group!(benches, dtrace, perf, sample);
-
+criterion_group!(benches, dtrace, perf, sample, xdebug);
 criterion_main!(benches);

src/bin/collapse-xdebug.rs

@@ -0,0 +1,75 @@
+use std::io;
+use std::path::PathBuf;
+
+use clap::Parser;
+use env_logger::Env;
+use inferno::collapse::xdebug::{Folder, Options};
+use inferno::collapse::{Collapse, DEFAULT_NTHREADS};
+use once_cell::sync::Lazy;
+
+static NTHREADS: Lazy<String> = Lazy::new(|| format!("{}", *DEFAULT_NTHREADS));
+
+#[derive(Debug, Parser)]
+#[clap(name = "inferno-collapse-xdebug")]
+struct Opt {
+    /// Silence all log output
+    #[clap(short = 'q', long = "quiet")]
+    quiet: bool,
+
+    /// Verbose logging mode (-v, -vv, -vvv)
+    #[clap(short = 'v', long = "verbose", parse(from_occurrences))]
+    verbose: usize,
+
+    // *************** //
+    // *** OPTIONS *** //
+    // *************** //
+    /// Number of threads to use.
+    #[clap(
+        short = 'n',
+        long = "nthreads",
+        default_value = &NTHREADS,
+        value_name = "UINT"
+    )]
+    nthreads: usize,
+
+    // ************ //
+    // *** ARGS *** //
+    // ************ //
+    #[clap(value_name = "PATH")]
+    /// Xdebug script output file, or STDIN if not specified
+    infile: Option<PathBuf>,
+
+    #[clap(short = 'f')]
+    include_filenames: bool,
+}
+
+impl Opt {
+    fn into_parts(self) -> (Option<PathBuf>, Options) {
+        (
+            self.infile,
+            Options {
+                nthreads: self.nthreads,
+                include_filenames: self.include_filenames,
+            },
+        )
+    }
+}
+
+fn main() -> io::Result<()> {
+    let opt = Opt::parse();
+
+    // Initialize logger
+    if !opt.quiet {
+        env_logger::Builder::from_env(Env::default().default_filter_or(match opt.verbose {
+            0 => "warn",
+            1 => "info",
+            2 => "debug",
+            _ => "trace",
+        }))
+        .format_timestamp(None)
+        .init();
+    }
+
+    let (infile, options) = opt.into_parts();
+    Folder::from(options).collapse_file(infile.as_ref(), io::stdout().lock())
+}

src/collapse/guess.rs

@@ -3,7 +3,7 @@ use std::io::{self, Cursor};
 
 use log::{error, info};
 
-use crate::collapse::{self, dtrace, perf, sample, vsprof, vtune, Collapse};
+use crate::collapse::{self, dtrace, perf, sample, vsprof, vtune, xdebug, Collapse};
 
 const LINES_PER_ITERATION: usize = 10;
 
@@ -70,10 +70,11 @@ impl Collapse for Folder {
         let mut sample = sample::Folder::default();
         let mut vtune = vtune::Folder::default();
         let mut vsprof = vsprof::Folder::default();
+        let mut xdebug = xdebug::Folder::default();
 
         // Each Collapse impl gets its own flag in this array.
         // It gets set to true when the impl has been ruled out.
-        let mut not_applicable = [false; 5];
+        let mut not_applicable = [false; 6];
 
         let mut buffer = String::new();
         loop {
@@ -108,6 +109,7 @@ impl Collapse for Folder {
             try_collapse_impl!(sample, 2);
             try_collapse_impl!(vtune, 3);
             try_collapse_impl!(vsprof, 4);
+            try_collapse_impl!(xdebug, 5);
 
             if eof {
                 break;

src/collapse/mod.rs

@@ -42,6 +42,13 @@ pub mod vtune;
 ///   [crate-level documentation]: ../../index.html
 pub mod vsprof;
 
+/// Stack collapsing for the output of [`Xdebug`](https://xdebug.org/docs/execution_trace).
+///
+/// See the [crate-level documentation] for details.
+///
+///   [crate-level documentation]: ../../index.html
+pub mod xdebug;
+
 // DEFAULT_NTHREADS is public because we use it in the help text of the binaries,
 // but it doesn't need to be exposed to library users, hence #[doc(hidden)].
 #[doc(hidden)]