Repository navigation
fix(walltime): infer Go and Java unwinding for both profilers #603
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
Open
not-matthias
wants to merge
2
commits into
cod-3877-expose-stack-sampling-size-in-cli
Choose a base branch
from
cod-3861-support-samply-fp-unwinding
base: cod-3877-expose-stack-sampling-size-in-cli
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| use crate::executor::config::{WalltimeProfiler, WalltimeUnwinding}; | ||
| use crate::executor::helpers::detect_executable::command_has_executable; | ||
| use crate::prelude::*; | ||
|
|
||
| /// Resolve against original commands, before exec-harness serializes them. | ||
| /// A shared recording uses frame pointers if any target needs them. | ||
| pub(crate) fn resolve_unwinding<'a>( | ||
| commands: impl IntoIterator<Item = &'a str>, | ||
| explicit: Option<WalltimeUnwinding>, | ||
| profiler: Option<WalltimeProfiler>, | ||
| ) -> Option<WalltimeUnwinding> { | ||
| // Samply's unwinding controls are Linux-only. | ||
| if !cfg!(target_os = "linux") && profiler != Some(WalltimeProfiler::Perf) { | ||
| return explicit; | ||
| } | ||
|
|
||
| let mut suggested = None; | ||
| for command in commands { | ||
| match suggested_unwinding(command) { | ||
| Some(WalltimeUnwinding::FramePointer) => { | ||
| suggested = Some(WalltimeUnwinding::FramePointer); | ||
| break; | ||
| } | ||
| Some(unwinding) if profiler == Some(WalltimeProfiler::Perf) => { | ||
| suggested = Some(unwinding); | ||
| } | ||
| _ => {} | ||
| } | ||
| } | ||
| if let (Some(explicit), Some(suggested)) = (explicit, suggested) | ||
| && suggested != explicit | ||
| { | ||
| warn!( | ||
| "Overriding suggested unwinding `{suggested}` with `{explicit}`, call stacks may be incomplete" | ||
| ); | ||
| } | ||
| explicit.or(suggested) | ||
| } | ||
|
|
||
| /// Unwinding suggested for the benchmarked runtime, if it has a known best setting. | ||
| fn suggested_unwinding(command: &str) -> Option<WalltimeUnwinding> { | ||
| if command_has_executable( | ||
| command, | ||
| &["gradle", "gradlew", "java", "maven", "mvn", "mvnw"], | ||
| ) { | ||
| return Some(WalltimeUnwinding::FramePointer); | ||
| } | ||
| if command_has_executable(command, &["go"]) { | ||
| return Some(WalltimeUnwinding::FramePointer); | ||
| } | ||
| if command_has_executable(command, &["pytest", "uv", "python", "python3"]) { | ||
| return Some(WalltimeUnwinding::Dwarf { | ||
| stack_size: Some(32 * 1024), | ||
| }); | ||
| } | ||
| None | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| #[cfg(target_os = "linux")] | ||
| fn go_and_java_use_frame_pointers_for_both_profilers() { | ||
| for profiler in [ | ||
| None, | ||
| Some(WalltimeProfiler::Perf), | ||
| Some(WalltimeProfiler::Samply), | ||
| ] { | ||
| for command in [ | ||
| "go test -bench=.", | ||
| "/usr/bin/java -jar bench.jar", | ||
| "./gradlew jmh", | ||
| "mvn test", | ||
| ] { | ||
| assert_eq!( | ||
| resolve_unwinding([command], None, profiler), | ||
| Some(WalltimeUnwinding::FramePointer) | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| #[cfg(target_os = "linux")] | ||
| fn mixed_exec_targets_use_frame_pointers_in_either_order() { | ||
| for profiler in [Some(WalltimeProfiler::Perf), Some(WalltimeProfiler::Samply)] { | ||
| for commands in [ | ||
| ["python", "bench.py", "java", "-jar", "bench.jar"], | ||
| ["java", "-jar", "bench.jar", "python", "bench.py"], | ||
| ] { | ||
| assert_eq!( | ||
| resolve_unwinding(commands, None, profiler), | ||
| Some(WalltimeUnwinding::FramePointer) | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn explicit_unwinding_overrides_language_inference() { | ||
| for profiler in [Some(WalltimeProfiler::Perf), Some(WalltimeProfiler::Samply)] { | ||
| for explicit in [ | ||
| WalltimeUnwinding::Dwarf { stack_size: None }, | ||
| WalltimeUnwinding::Dwarf { | ||
| stack_size: Some(16 * 1024), | ||
| }, | ||
| WalltimeUnwinding::FramePointer, | ||
| ] { | ||
| for command in [ | ||
| "go test -bench=.", | ||
| "java -jar bench.jar", | ||
| "python bench.py", | ||
| "cargo bench", | ||
| ] { | ||
| assert_eq!( | ||
| resolve_unwinding([command], Some(explicit), profiler), | ||
| Some(explicit) | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn dwarf_defaults_remain_backend_specific() { | ||
| assert_eq!( | ||
| resolve_unwinding(["python bench.py"], None, Some(WalltimeProfiler::Perf)), | ||
| Some(WalltimeUnwinding::Dwarf { | ||
| stack_size: Some(32 * 1024) | ||
| }) | ||
| ); | ||
| for profiler in [None, Some(WalltimeProfiler::Samply)] { | ||
| assert_eq!(resolve_unwinding(["python bench.py"], None, profiler), None); | ||
| } | ||
| for profiler in [ | ||
| None, | ||
| Some(WalltimeProfiler::Perf), | ||
| Some(WalltimeProfiler::Samply), | ||
| ] { | ||
| assert_eq!(resolve_unwinding(["cargo bench"], None, profiler), None); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| #[cfg(not(target_os = "linux"))] | ||
| fn samply_keeps_platform_unwinding_defaults() { | ||
| assert_eq!(resolve_unwinding(["go test -bench=."], None, None), None); | ||
| assert_eq!( | ||
| resolve_unwinding( | ||
| ["java -jar bench.jar"], | ||
| None, | ||
| Some(WalltimeProfiler::Samply) | ||
| ), | ||
| None | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Every exec argument is checked as an executable name. For example,
codspeed exec -m walltime -- grep go corpus.txtselects frame-pointer unwinding because the patterngoreachessuggested_unwindingas a command. If the native program was built without frame pointers, its call stacks will be incomplete. Every other target in the same recording also gets this setting.Keep each target's argument list intact and distinguish its executable from ordinary arguments before inferring the runtime.
Prompt To Fix With AI