Migrate wasm-bindgen to using walrus
#1237
Merged
Conversation
This file contains 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
alexcrichton
force-pushed
the
walrus
branch
3 times, most recently
from
66d0d2c to
c783d52
Compare
Nice, looks like this is actually paying off :) |
alexcrichton
force-pushed
the
walrus
branch
2 times, most recently
from
28b6a1a to
2a3966a
Compare
This commit moves `wasm-bindgen` the CLI tool from internally using `parity-wasm` for wasm parsing/serialization to instead use `walrus`. The `walrus` crate is something we've been working on recently with an aim to replace the usage of `parity-wasm` in `wasm-bindgen` to make the current CLI tool more maintainable as well as more future-proof. The `walrus` crate provides a much nicer AST to work with as well as a structured `Module`, whereas `parity-wasm` provides a very raw interface to the wasm module which isn't really appropriate for our use case. The many transformations and tweaks that wasm-bindgen does have a huge amount of ad-hoc index management to carefully craft a final wasm binary, but this is all entirely taken care for us with the `walrus` crate. Additionally, `wasm-bindgen` will ingest and rewrite the wasm file, often changing the binary offsets of functions. Eventually with DWARF debug information we'll need to be sure to preserve the debug information throughout the transformations that `wasm-bindgen` does today. This is practically impossible to do with the `parity-wasm` architecture, but `walrus` was designed from the get-go to solve this problem transparently in the `walrus` crate itself. (it doesn't today, but this is planned work) It is the intention that this does not end up regressing any `wasm-bindgen` use cases, neither in functionality or in speed. As a large change and refactoring, however, it's likely that at least something will arise! We'll want to continue to remain vigilant to any issues that come up with this commit. Note that the `gc` crate has been deleted as part of this change, as the `gc` crate is no longer necessary since `walrus` does it automatically. Additionally the `gc` crate was one of the main problems with preserving debug information as it often deletes wasm items! Finally, this also starts moving crates to the 2018 edition where necessary since `walrus` requires the 2018 edition, and in general it's more pleasant to work within the 2018 edition!
fitzgen
added
the
TWiRaWA
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit moves
wasm-bindgenthe CLI tool from internally usingparity-wasmfor wasm parsing/serialization to instead usewalrus.The
walruscrate is something we've been working on recently with anaim to replace the usage of
parity-wasminwasm-bindgento make thecurrent CLI tool more maintainable as well as more future-proof.
The
walruscrate provides a much nicer AST to work with as well as astructured
Module, whereasparity-wasmprovides a very raw interfaceto the wasm module which isn't really appropriate for our use case. The
many transformations and tweaks that wasm-bindgen does have a huge
amount of ad-hoc index management to carefully craft a final wasm
binary, but this is all entirely taken care for us with the
walruscrate.
Additionally,
wasm-bindgenwill ingest and rewrite the wasm file,often changing the binary offsets of functions. Eventually with DWARF
debug information we'll need to be sure to preserve the debug
information throughout the transformations that
wasm-bindgendoestoday. This is practically impossible to do with the
parity-wasmarchitecture, but
walruswas designed from the get-go to solve thisproblem transparently in the
walruscrate itself. (it doesn't today,but this is planned work)
It is the intention that this does not end up regressing any
wasm-bindgenuse cases, neither in functionality or in speed. As alarge change and refactoring, however, it's likely that at least
something will arise! We'll want to continue to remain vigilant to any
issues that come up with this commit.
Note that the
gccrate has been deleted as part of this change, as thegccrate is no longer necessary sincewalrusdoes it automatically.Additionally the
gccrate was one of the main problems with preservingdebug information as it often deletes wasm items!
Finally, this also starts moving crates to the 2018 edition where
necessary since
walrusrequires the 2018 edition, and in general it'smore pleasant to work within the 2018 edition!