Add a `wasmtime objdump` subcommand by alexcrichton · Pull Request #10405 · bytecodealliance/wasmtime

alexcrichton · 2025-03-15T17:30:23Z

This commit adds an objdump subcommand to the wasmtime CLI. Like all
other subcommands this can be disabled for a more minimal build of the
CLI as well. The purpose of this subcommand is to provide a
Wasmtime-specific spin on the venerable native objdump itself. Notably
this brings Wasmtime-specific knowledge for filtering functions, showing
Wasmtime metadata, etc.

This command is intended to look like objdump roughly but also has
configurable output with various flags and things that can be printed.
For now the main Wasmtime additions are showing the address map
section, stack map section, and trap section of a *.cwasm file.

This new subcommand replaces the infrastructure of the disas test
suite, and now that test suite uses wasmtime objdump to generate test
expectations. Additionally the subcommand replaces the Pulley objdump
example as a more full-featured objdump that also works natively with
Pulley.

The hope is that if we add more binary metadata in the future (such as
unwinding tables) that can be relatively easily added here for
exploration as well. Otherwise this is mostly just a developer
convenience for Wasmtime developers as well and hopefully doesn't cost
too much in maintenance burden.

Closes #10336

alexcrichton · 2025-03-15T17:31:25Z

I'll note that this is built on #10404 currently and an example output looks like this:

github-actions · 2025-03-15T18:46:01Z

Subscribe to Label Action

cc @fitzgen, @saulecabrera

Details

This issue or pull request has been labeled: "cranelift", "pulley", "wasmtime:api", "wasmtime:docs", "winch"

Thus the following users have been cc'd because of the following labels:

fitzgen: pulley
saulecabrera: winch

To subscribe or unsubscribe from this label, edit the .github/subscribe-to-label.json configuration file.

Learn more.

fitzgen

Looks fantastic! (modulo my comments on the stack-maps-in-an-elf-section bits in the other PR)

Thanks for putting this together, it is going to be super helpful going forward

fitzgen · 2025-03-17T19:54:10Z

src/commands/objdump.rs

+    /// Whether or not to interleave instructions with address maps.
+    #[arg(long)]
+    addrmap: bool,
+
+    /// Whether or not to interleave instructions with stack maps.
+    #[arg(long)]
+    stack_maps: bool,
+
+    /// Column width of how large an address is rendered as.
+    #[arg(long, default_value = "10")]
+    address_width: usize,
+
+    /// Whether or not to show information about what instructions can trap.
+    #[arg(long)]
+    traps: bool,


These seem like they should all be on by default?

Personally I found the address map pretty noisy so I'm not sure we'd want to have that on-by-default. For the others I figured it wasn't too too hard to enable but it means we'd need flags to disable them. Flags-to-disable I find a bit cumbersome with with clap so I left it as off-by-default.

Yeah that makes sense 👍

alexcrichton · 2025-03-17T20:52:31Z

It'll take me some time to work through the stack map bits, so I'm splitting that out of this PR

alexcrichton · 2025-03-19T16:49:39Z

I'm going to go ahead and merge this but @fitzgen I'm happy to continue to iterate on the CLI and defaults if you'd like

This commit consolidates all of the existing crates we have for testing into a smaller set of crates. Specifically: * `crates/misc/component-fuzz-util` => `wasmtime-test-util` + `component-fuzz` feature * `crates/misc/component-test-util` => `wasmtime-test-util` + `component` feature * `crates/wast-util` => `wasmtime-test-util` + `wast` feature * `crates/misc/component-macro-test` => `wasmtime-test-macros` The goal is to have one location we put various test helpers/macros rather than our current organically-grown many locations. This is inspired by the test failure on bytecodealliance#10405 where I'd like to refactor more infrastructure to a "test util" location but it wasn't clear where to put it so I wanted to do this refactoring first.

alexcrichton · 2025-03-19T19:16:31Z

This PR now depends on #10423 and is temporarily rebased on it

github-actions · 2025-03-19T20:45:02Z

Subscribe to Label Action

cc @fitzgen

Details

This issue or pull request has been labeled: "fuzzing"

Thus the following users have been cc'd because of the following labels:

fitzgen: fuzzing

To subscribe or unsubscribe from this label, edit the .github/subscribe-to-label.json configuration file.

Learn more.

* Consolidate "util" crates for testing This commit consolidates all of the existing crates we have for testing into a smaller set of crates. Specifically: * `crates/misc/component-fuzz-util` => `wasmtime-test-util` + `component-fuzz` feature * `crates/misc/component-test-util` => `wasmtime-test-util` + `component` feature * `crates/wast-util` => `wasmtime-test-util` + `wast` feature * `crates/misc/component-macro-test` => `wasmtime-test-macros` The goal is to have one location we put various test helpers/macros rather than our current organically-grown many locations. This is inspired by the test failure on #10405 where I'd like to refactor more infrastructure to a "test util" location but it wasn't clear where to put it so I wanted to do this refactoring first. * Remove unused file

This commit adds an `objdump` subcommand to the `wasmtime` CLI. Like all other subcommands this can be disabled for a more minimal build of the CLI as well. The purpose of this subcommand is to provide a Wasmtime-specific spin on the venerable native `objdump` itself. Notably this brings Wasmtime-specific knowledge for filtering functions, showing Wasmtime metadata, etc. This command is intended to look like `objdump` roughly but also has configurable output with various flags and things that can be printed. For now the main Wasmtime additions are showing the address map section, stack map section, and trap section of a `*.cwasm` file. This new subcommand replaces the infrastructure of the `disas` test suite, and now that test suite uses `wasmtime objdump` to generate test expectations. Additionally the subcommand replaces the Pulley `objdump` example as a more full-featured objdump that also works natively with Pulley. The hope is that if we add more binary metadata in the future (such as unwinding tables) that can be relatively easily added here for exploration as well. Otherwise this is mostly just a developer convenience for Wasmtime developers as well and hopefully doesn't cost too much in maintenance burden. Closes bytecodealliance#10336

Follow-up to bytecodealliance#10404 and bytecodealliance#10405

* Add `--stack-maps` to `wasmtime objdump` Follow-up to #10404 and #10405 * Enable traps/stack maps by default in objdump

`IOView` is split off of `WasiView`. bytecodealliance/wasmtime#10016 `static_memory_maximum_size` is now `memory_reservation`. bytecodealliance/wasmtime#9545 `detect_precompiled` is now associated function. bytecodealliance/wasmtime#10405

`IOView` is split off of `WasiView`. bytecodealliance/wasmtime#10016 `static_memory_maximum_size` is now `memory_reservation`. bytecodealliance/wasmtime#9545 `detect_precompiled` is now associated function. bytecodealliance/wasmtime#10405 Moved WASIp2 related things to `wasmtime_wasi::p2` module. bytecodealliance/wasmtime#10073

alexcrichton requested review from a team as code owners March 15, 2025 17:30

alexcrichton requested review from fitzgen and removed request for a team March 15, 2025 17:30

alexcrichton mentioned this pull request Mar 17, 2025

x64: Misaligned load fault with sunk float operation when AVX disabled #10408

Closed

fitzgen approved these changes Mar 17, 2025

View reviewed changes

alexcrichton force-pushed the objdump branch from 9ba7f24 to 7e18415 Compare March 17, 2025 20:52

alexcrichton added this pull request to the merge queue Mar 19, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 19, 2025

alexcrichton enabled auto-merge March 19, 2025 16:57

alexcrichton added this pull request to the merge queue Mar 19, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 19, 2025

alexcrichton mentioned this pull request Mar 19, 2025

Consolidate "util" crates for testing #10423

Merged

alexcrichton force-pushed the objdump branch from 979c9be to ad37156 Compare March 19, 2025 19:15

alexcrichton requested a review from a team as a code owner March 19, 2025 19:15

github-actions bot added the fuzzing Issues related to our fuzzing infrastructure label Mar 19, 2025

alexcrichton force-pushed the objdump branch from bf6e7cf to 2d90bea Compare March 20, 2025 19:08

alexcrichton enabled auto-merge March 20, 2025 19:09

alexcrichton added this pull request to the merge queue Mar 20, 2025

github-actions bot added the wasi Issues pertaining to WASI label Mar 20, 2025

Merged via the queue into bytecodealliance:main with commit 3e406d2 Mar 20, 2025
40 checks passed

alexcrichton deleted the objdump branch March 20, 2025 19:45

alexcrichton added a commit to alexcrichton/wasmtime that referenced this pull request Mar 20, 2025

Add --stack-maps to wasmtime objdump

024de96

Follow-up to bytecodealliance#10404 and bytecodealliance#10405

alexcrichton mentioned this pull request Mar 20, 2025

Add --stack-maps to wasmtime objdump #10439

Merged

github-merge-queue bot pushed a commit that referenced this pull request Mar 20, 2025

Add --stack-maps to wasmtime objdump (#10439)

5b07689

* Add `--stack-maps` to `wasmtime objdump` Follow-up to #10404 and #10405 * Enable traps/stack maps by default in objdump

tanishiking mentioned this pull request Jun 8, 2025

deps: bump wasmtime to 33.0.0 containerd/runwasi#1006

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a `wasmtime objdump` subcommand #10405

Add a `wasmtime objdump` subcommand #10405
alexcrichton merged 1 commit intobytecodealliance:mainfrom
alexcrichton:objdump

alexcrichton commented Mar 15, 2025

Uh oh!

alexcrichton commented Mar 15, 2025

Uh oh!

github-actions bot commented Mar 15, 2025

Uh oh!

fitzgen left a comment

Uh oh!

fitzgen Mar 17, 2025

Uh oh!

alexcrichton Mar 17, 2025

Uh oh!

fitzgen Mar 19, 2025

Uh oh!

alexcrichton commented Mar 17, 2025

Uh oh!

alexcrichton commented Mar 19, 2025

Uh oh!

Uh oh!

Uh oh!

alexcrichton commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

alexcrichton commented Mar 15, 2025

Uh oh!

alexcrichton commented Mar 15, 2025

Uh oh!

github-actions bot commented Mar 15, 2025

Subscribe to Label Action

Uh oh!

fitzgen left a comment

Choose a reason for hiding this comment

Uh oh!

fitzgen Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

alexcrichton Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

fitzgen Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

alexcrichton commented Mar 17, 2025

Uh oh!

alexcrichton commented Mar 19, 2025

Uh oh!

Uh oh!

Uh oh!

alexcrichton commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025

Subscribe to Label Action

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants