Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ inferno = { version = "0.12.2", default-features = false, features = ["multithre
opener = "0.8.1"
shlex = "1.1.0"
rustc-demangle = { version = "0.1", features = ["std"] }
quick-xml = { version = "0.37", default-features = false }

[target.'cfg(unix)'.dependencies]
signal-hook = "0.4.1"
Expand Down
58 changes: 55 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
use std::{
borrow::Cow,
env,
fs::File,
io::{BufReader, BufWriter, Cursor, Read, Write},
io::{BufRead, BufReader, BufWriter, Cursor, Error, ErrorKind, Read, Write},
path::PathBuf,
process::{exit, Command, ExitStatus, Stdio},
str::FromStr,
Expand All @@ -28,7 +29,7 @@ use clap::{
Args,
};
use inferno::{collapse::Collapse, flamegraph::color::Palette, flamegraph::from_reader};
use rustc_demangle::demangle_stream;
use rustc_demangle::try_demangle;

pub enum Workload {
Command(Vec<String>),
Expand Down Expand Up @@ -490,6 +491,57 @@ fn print_command(cmd: &Command, verbose: bool) {
}
}

fn demangle_stream<R: BufRead, W: Write>(input: &mut R, output: &mut W) -> std::io::Result<()> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should only do this on macOS when the xctrace backend is used.

use quick_xml::events::Event;

let mut reader = quick_xml::Reader::from_reader(input);
let mut writer = quick_xml::Writer::new(output);
let mut buf = Vec::new();

loop {
match reader.read_event_into(&mut buf) {
Ok(Event::Eof) => break,
Ok(Event::Start(el)) => writer.write_event(Event::Start(demangle_element(el)?))?,
Ok(Event::Empty(el)) => writer.write_event(Event::Empty(demangle_element(el)?))?,
Ok(el) => writer.write_event(el)?,
Err(err) => return Err(Error::new(ErrorKind::InvalidData, err)),
}
buf.clear();
}

Ok(())
}

fn demangle_element(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: inline this function.

element: quick_xml::events::BytesStart,
) -> std::io::Result<quick_xml::events::BytesStart> {
let mut new_element = element.clone();
new_element.clear_attributes();

for attr in element.attributes() {
let mut attr = attr.map_err(|err| Error::new(ErrorKind::InvalidData, err))?;
demangle_attribute(&mut attr);
new_element.push_attribute(attr);
}

Ok(new_element)
}

fn demangle_attribute(attribute: &mut quick_xml::events::attributes::Attribute) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: inline this function.

let Ok(mangled) = str::from_utf8(&attribute.value) else {
return;
};

if let Ok(demangled) = try_demangle(mangled) {
let demangled = format!("{:#}", demangled);

attribute.value = match quick_xml::escape::escape(demangled) {
Cow::Borrowed(s) => Cow::Borrowed(s.as_bytes()),
Cow::Owned(s) => Cow::Owned(s.into_bytes()),
};
}
}

pub fn generate_flamegraph_for_workload(workload: Workload, opts: Options) -> anyhow::Result<()> {
// Handle SIGINT with an empty handler. This has the
// implicit effect of allowing the signal to reach the
Expand Down Expand Up @@ -530,7 +582,7 @@ pub fn generate_flamegraph_for_workload(workload: Workload, opts: Options) -> an

let mut demangled_output = vec![];

demangle_stream(&mut Cursor::new(output), &mut demangled_output, false)
demangle_stream(&mut Cursor::new(output), &mut demangled_output)
.context("unable to demangle")?;

let perf_reader = BufReader::new(&*demangled_output);
Expand Down
Loading