Skip to content

Latest commit

 

History

History
322 lines (244 loc) · 10.7 KB

README.md

File metadata and controls

322 lines (244 loc) · 10.7 KB
Raw

cargo-show-asm

A cargo subcommand that displays the Assembly, LLVM-IR, MIR and WASM generated for Rust source code.

Install

$ cargo install cargo-show-asm

Features

  • Platform support:

    • OS: Linux and macOS. Limited support for Windows
    • Rust: nightly and stable.
    • Architectures: x86, x86_64, aarch64, etc.
    • Cross-compilation support.

  • Displaying:

    • Assembly in Intel or AT&T syntax.
    • Corresponding Rust source code alongside assembly.
    • llvm-ir.
    • rustc MIR
    • Wasm code
    • llvm-mca analysis

cargo asm

Show the code rustc generates for any function

Usage: cargo asm [-p=SPEC] [ARTIFACT] [-M=ARG]... [TARGET-CPU] [--rust] [-c=COUNT] [--simplify] [--include-constants] [--this-workspace | --all-crates | --all-sources] OUTPUT-FORMAT [--everything | FUNCTION [INDEX]]

Usage:

  1. Focus on a single assembly producing target:
 % cargo asm -p isin --lib   # here we are targeting lib in isin crate
  1. Narrow down a function:
 % cargo asm -p isin --lib from_ # here "from_" is part of the function you are interested intel
  1. Get the full results:
 % cargo asm -p isin --lib isin::base36::from_alphanum

Pick artifact for analysis:

  • --lib — Show results from library code
  • --test=TEST — Show results from an integration test
  • --bench=BENCH — Show results from a benchmark
  • --example=EXAMPLE — Show results from an example
  • --bin=BIN — Show results from a binary

Cargo options

  • --manifest-path=PATH — Path to Cargo.toml, defaults to one in current folder

  • --config=<KEY=VALUE> — Override a cargo configuration value

  • --target-dir=DIR — Use custom target directory for generated artifacts, create if missing

    Uses environment variable CARGO_TARGET_DIR

  • --dry — Produce a build plan instead of actually building

  • --frozen — Requires Cargo.lock and cache to be up-to-date

  • --locked — Requires Cargo.lock to be up-to-date

  • --offline — Run without accessing the network

  • -q, --quiet — Do not print cargo log messages

  • --no-default-features — Do not activate default feature

  • --all-features — Activate all available features

  • --features=FEATURE — A feature to activate, can be used multiple times

  • --release — Compile in release mode (default)

  • --dev — Compile in dev mode

  • --profile=PROFILE — Build for this specific profile, you can also use dev and release here

    Uses environment variable CARGO_SHOW_ASM_PROFILE

  • --target=TRIPLE — Build for the target triple

  • -C=FLAG — Codegen flags to rustc, see 'rustc -C help' for details

  • -Z=FLAG — Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details

Postprocessing options:

  • --rust — Print interleaved Rust code

  • -c, --context=COUNT — Include other called functions, recursively, up to COUNT depth

    [default: 0]

  • --color — Enable color highlighting

  • --no-color — Disable color highlighting

  • --full-name — Include full demangled name instead of just prefix

  • --short-name — Include demangled names without hash suffix (default)

  • --keep-mangled — Do not demangle symbol names

  • -K, --keep-labels — Keep all the original labels

  • -B, --keep-blanks — Strip redundant labels, but keep spaces in their place

  • -R, --reduce-labels — Strip redundant labels entirely

  • -v, --verbose — more verbose output, can be specified multiple times

  • --simplify — Try to strip some of the non-assembly instruction information

  • --include-constants — Include sections containing string literals and other constants

  • -b, --keep-blank — Keep blank lines

  • --this-workspace — Show rust sources from current workspace only

  • --all-crates — Show rust sources from current workspace and from rust registry

  • --all-sources — Show all the rust sources including stdlib and compiler

Pick output type:

  • --asm — Show assembly
  • --disasm — Disassembly binaries or object files
  • --llvm — Show llvm-ir
  • --llvm-input — Show llvm-ir before any LLVM passes
  • --mir — Show MIR
  • --wasm — Show WASM, needs wasm32-unknown-unknown target installed
  • --mca — Show llvm-mca anasysis
  • --intel — Use Intel style for assembly
  • --att — Use AT&T style for assembly

Pick item to display from the artifact

  • --everything — Dump the whole file
  • FUNCTION — Dump a function with a given name, filter functions by name
  • INDEX — Select specific function when there's several with the same name

Available options:

  • -p, --package=SPEC — Package to use, defaults to a current one,

    required for workspace projects, can also point to a dependency

  • --file=PATH — Disassemble or process this file instead of calling cargo, requires cargo-show-asm to be compiled with disasm feature

    You can specify executable, rlib or an object file

  • -M, --mca-arg=ARG — Pass parameter to llvm-mca for mca targets

  • --native — Optimize for the CPU running the compiler

  • --target-cpu=CPU — Optimize code for a specific CPU, see 'rustc --print target-cpus'

  • -h, --help — Prints help information

  • -V, --version — Prints version information

You can start by running cargo asm with no parameters - it will suggest how to narrow the search scope - for workspace crates you need to specify a crate to work with, for crates defining several targets (lib, binaries, examples) you need to specify exactly which target to use. In a workspace cargo asm lists only workspace members as suggestions but any crate from workspace tree is available.

Once cargo asm focuses on a single target it will run rustc producing assembly file and will try to list of available public functions:

$ cargo asm --lib
Try one of those
"<&T as core::fmt::Display>::fmt" [17, 12, 12, 12, 12, 19, 19, 12]
"<&mut W as core::fmt::Write>::write_char" [20]
"<&mut W as core::fmt::Write>::write_fmt" [38]
"<&mut W as core::fmt::Write>::write_str" [90]
"<F as nom::internal::Parser<I,O,E>>::parse" [263]
# ...

Name in quotes is demangled rust name, numbers in square brackets represent number of lines in asm file. Function with the same name can be present in several instances.

Specifying exact function name or a uniquely identifying part of it will print its assembly code

$ cargo asm --lib "cargo_show_asm::opts::focus::{{closure}}"

To pick between different alternatives you can either specify the index

$ cargo asm --lib "cargo_show_asm::opts::focus::{{closure}}" 2

Or start using full names with hex included:

$ cargo asm --lib --full-name
# ...
$ cargo asm --lib "once_cell::imp::OnceCell<T>::initialize::h9c5c7d5bd745000b"

cargo-show-asm comes with a built-in search function. Just pass partial name instead of a full one and only matching functions will be listed

$ cargo asm --lib Debug

My function isn't there!

rustc will only generate the code for your function if it knows what type it is, including generic parameters and if it is exported (in case of a library) and not inlined (in case of a binary, example, test, etc.). If your function takes a generic parameter - try making a monomorphic wrapper around it and make it pub and #[inline(never)].

Alternatively if your function is too small - rustc might decide to inline it automatically with the same result. Marking it with #[inline(never)] fixes this problem. See rust-lang/rust#116505 for more details

Include related functions?

So suppose you have a function foo that calls some other function - bar. With --context N or it's short variant -c N you can ask cargo-show-asm to include body of bar to the input. This is done recursively up to N steps. See #247

What about cargo-asm?

cargo-asm is not maintained: gnzlbg/cargo-asm#244. This crate is a reimplementation which addresses a number of its shortcomings, including:

  • cargo-asm recompiles everything every time with 1 codegen unit, which is slow and also not necessarily what is in your release profile. cargo-show-asm avoids that.

  • Because of how cargo-asm handles demangling the output looks like asm but isn't actually asm. It contains a bunch of extra commas which makes reusing it more annoying.

  • cargo-asm always uses colors unless you pass a flag while cargo-show-asm changes its default behavior if output is not sent to a terminal.

  • cargo-show-asm also supports MIR (note that the formatting of human-readable MIR is not stable).

Shell completion

cargo-asm comes with shell completion generated by bpaf, use one of the lines below and place it into the place right for your shell.

$ cargo-asm --bpaf-complete-style-bash
$ cargo-asm --bpaf-complete-style-zsh
$ cargo-asm --bpaf-complete-style-fish
$ cargo-asm --bpaf-complete-style-elvish

You'll need to use it as cargo-asm command rather than cargo asm to take advantage of it.

Colorful line parser output

You can install cargo-show-asm with one of two features to get prettier command line

cargo install cargo-show-asm -F bright-color
cargo install cargo-show-asm -F dull-color

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.