Skip to content

Instantly share code, notes, and snippets.

@KodrAus
Last active November 14, 2023 17:19
Show Gist options
  • Save KodrAus/97c92c07a90b1fdd6853654357fd557a to your computer and use it in GitHub Desktop.
Save KodrAus/97c92c07a90b1fdd6853654357fd557a to your computer and use it in GitHub Desktop.
Profiling Rust Applications

Profiling performance

Using perf:

$ perf record -g binary
$ perf script | stackcollapse-perf.pl | rust-unmangle | flamegraph.pl > flame.svg

NOTE: See @GabrielMajeri's comments below about the -g option.

This requires you have flamegraph available in your path. The rust-unmangle script is optional but nice.

Also check out @dlaehnemann's more detailed walkthrough about generating flamegraphs here.

Profiling heap memory

Using valgrind (massif) and massif-visualiser:

$ valgrind --tool=massif binary

Also check out heaptrack, it's similar to massif but more useful out-of-the-box. It also has a nice gui experience:

$ heaptrack binary

Debugging

$ rust-gdb binary

Namespaces are prefixed by the crate name, which is probably also the name of the binary. You can do stuff like:

  • break to set breakpoints
  • print to print a variable
  • step,next,finish to step through calls

Links

@hcpl
Copy link

hcpl commented May 14, 2019

Thanks for the notice; you're right, now not even that is needed anymore. And thanks for your tutorial as well, the heaptrack_gui part was new to me!

@anurbol
Copy link

anurbol commented Nov 26, 2019

Is there a similar thing for Windows?

@dlaehnemann
Copy link

Now, there is a cargo subcommand that can be used for flamegraphing Rust code. This should work cross-platform and a little less hacky than the solutions in these gists. Check it out here:
https://github.com/flamegraph-rs/flamegraph

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment