Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Rust language coloring #211

Merged
merged 6 commits into from
May 6, 2021
Merged
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
2 changes: 1 addition & 1 deletion src/bin/flamegraph.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ struct Opt {
short = "c",
long = "colors",
default_value = defaults::COLORS,
possible_values = &["aqua","blue","green","hot","io","java","js","mem","orange","perl","purple","red","wakeup","yellow"],
possible_values = &["aqua","blue","green","hot","io","java","js","mem","orange","perl","purple","red","rust","wakeup","yellow"],
value_name = "STRING"
)]
colors: Palette,
Expand Down
4 changes: 4 additions & 0 deletions src/flamegraph/color/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ pub enum MultiPalette {
Js,
/// Use Perl semantics to color frames.
Perl,
/// Use Rust semantics to color frames.
Rust,
/// Equivalent to [`BasicPalette::Aqua`] with [`BackgroundColor::Blue`].
Wakeup,
}
Expand Down Expand Up @@ -196,6 +198,7 @@ impl FromStr for Palette {
"java" => Ok(Palette::Multi(MultiPalette::Java)),
"js" => Ok(Palette::Multi(MultiPalette::Js)),
"perl" => Ok(Palette::Multi(MultiPalette::Perl)),
"rust" => Ok(Palette::Multi(MultiPalette::Rust)),
"red" => Ok(Palette::Basic(BasicPalette::Red)),
"green" => Ok(Palette::Basic(BasicPalette::Green)),
"blue" => Ok(Palette::Basic(BasicPalette::Blue)),
Expand Down Expand Up @@ -308,6 +311,7 @@ fn rgb_components_for_palette(palette: Palette, name: &str, v1: f32, v2: f32, v3
Palette::Multi(MultiPalette::Perl) => palettes::perl::resolve(name),
Palette::Multi(MultiPalette::Js) => palettes::js::resolve(name),
Palette::Multi(MultiPalette::Wakeup) => palettes::wakeup::resolve(name),
Palette::Multi(MultiPalette::Rust) => palettes::rust::resolve(name),
};

match basic_palette {
Expand Down
70 changes: 70 additions & 0 deletions src/flamegraph/color/palettes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,32 @@ pub(super) mod wakeup {
}
}

pub(super) mod rust {
use crate::flamegraph::color::BasicPalette;

pub fn resolve(name: &str) -> BasicPalette {
if name.starts_with("core::")
|| name.starts_with("std::")
|| name.starts_with("alloc::")
|| name.starts_with("<core::")
|| name.starts_with("<std::")
|| name.starts_with("<alloc::")
{
// Rust system functions
BasicPalette::Orange
} else if name.contains("::") {
// Rust user functions.
// Although this will generate false positives for e.g. C++ code
// used with Rust, the intention is to color code from user
// crates and dependencies differenly than Rust system code.
BasicPalette::Aqua
} else {
// Non-Rust functions
BasicPalette::Yellow
}
}
}

#[cfg(test)]
mod tests {
use crate::flamegraph::color::BasicPalette;
Expand Down Expand Up @@ -452,4 +478,48 @@ mod tests {
assert_eq!(result, elem.output);
}
}

#[test]
fn rust_returns_correct() {
use super::rust;

let test_names = [
TestData {
input: String::from("some::not_rust_system::mod"),
output: BasicPalette::Aqua,
},
TestData {
input: String::from("core::mod"),
output: BasicPalette::Orange,
},
TestData {
input: String::from("std::mod"),
output: BasicPalette::Orange,
},
TestData {
input: String::from("alloc::mod"),
output: BasicPalette::Orange,
},
TestData {
input: String::from("something_else"),
output: BasicPalette::Yellow,
},
TestData {
input: String::from("<alloc::boxed::Box<F,A> as something::else"),
output: BasicPalette::Orange,
},
TestData {
input: String::from("<core::something as something::else"),
output: BasicPalette::Orange,
},
TestData {
input: String::from("<std::something something::else"),
output: BasicPalette::Orange,
},
];
for elem in test_names.iter() {
let result = rust::resolve(&elem.input);
assert_eq!(result, elem.output);
}
}
}