wit-component: implement a tool to create WebAssembly components. #183
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
peterhuene
force-pushed
the
wit-component
branch
from
ad0824d
to
a1990ce
Compare
There was a problem hiding this comment.
I want to dig a bit more into the actual construction of the final component but I've otherwise looked at a most everything else and this is all looking really good. This is a first round of feedback but has a lot of musings about various unrelated things to this PR which we'll want to consider for future refactorings too.
crates/wit-component/tests/components/lower-options/component.wat
Outdated
Show resolved
Hide resolved
alexcrichton
added a commit
to alexcrichton/wasm-tools
that referenced
this pull request
Apr 1, 2022
From bytecodealliance/wit-bindgen#183 I realized that the current explainer has the printing of indices here slightly different where the outer index/name is outside in the `alias` annotation where the local name/index is printed inside of the `type` or item container. This also updates the printing of the local index to attempt to use the name section, if one is present.
alexcrichton
reviewed
Apr 1, 2022
peterhuene
pushed a commit
to bytecodealliance/wasm-tools
that referenced
this pull request
Apr 1, 2022
From bytecodealliance/wit-bindgen#183 I realized that the current explainer has the printing of indices here slightly different where the outer index/name is outside in the `alias` annotation where the local name/index is printed inside of the `type` or item container. This also updates the printing of the local index to attempt to use the name section, if one is present.
|
Working on fixing up the way we do import lowering, but that should be the last bit of feedback remaining thus far. |
|
Okay, I think all code review feedback thus far has been addressed. I'll rebase this once approved to resolve the conflict. |
alexcrichton
approved these changes
Apr 4, 2022
This commit provides the initial implementation for the `wit-component` tool. The tool is responsible for converting a core module implementing the canonical ABI into a component based on the WebAssembly component model proposal. Users provide the tool with the interfaces to be exported or imported by the component in `wit` format. The output of the tool is a component file. The tool validates that the core module is satisfied with the given imports and also exports the provided interfaces. The output component is also verified with the validator from `wasmparser`.
This commit adds a test to encode an interface, decode the bytes using `wasmprinter`, and then compare the output with a baseline wat file. It also adds a `simple` test case for encoding components where a component exports a single default interface.
This commit adds more tests to `wit-component` for component encoding.
This commit adds several test cases for validation of the module that will be encoded as a component.
This commit only adds an encoding option if the function signatures contain strings. It also only adds the `into` option only if the function signature requires it. Added tests for lifting and lowering of various function signatures to ensure the canonical options emitted are correct.
This commit updates the documentation for the tests in `wit-component` and restructures the interface encoding tests directory layout to match that of the component encoding tests.
This commit updates wasmprinter and the test baselines now that it correctly prints outer aliases.
The `pretty_assertions` crate prints a nice diff for `assert_eq!` failures, but the tests were reversing left and right to make it more confusing when conceptually seeing changes from the baseline. This commit swaps the two arguments to `assert_eq!` so that left is the baseline and right is the output of the test.
This commit adds some names to one of the test module's canonical definitions. This helps to test that the names survive encoding and are also present when printed.
This commit adds a test to cover both importing and exporting interfaces from the same component. Fixes a bug where importing functions wasn't contributing to the function type list.
This commit uses the type information returned from wasmparser for the validation of the core module. It also reduces the complexity of parsing the core module by using methods provided by wasmparser.
Various code review feedback changes.
This commit changes how imports are lowered. Previously, the tool used indirect lowerings for all imports, even if the import didn't need the `into` option. Now such lowerings are lowered before the inner core module is instantiated and directly given as an argument. Additionally, if there are indirect lowerings to perform, at most two additional modules are encoded: a module storing a table for only the indirect lowerings and another that initializes the table once the core module has been instantiated.
peterhuene
force-pushed
the
wit-component
branch
from
f057fae
to
c73b953
Compare
willemneal
pushed a commit
to AhaLabs/wit-bindgen
that referenced
this pull request
May 31, 2022
…tecodealliance#183) * wit-component: initial implementation. This commit provides the initial implementation for the `wit-component` tool. The tool is responsible for converting a core module implementing the canonical ABI into a component based on the WebAssembly component model proposal. Users provide the tool with the interfaces to be exported or imported by the component in `wit` format. The output of the tool is a component file. The tool validates that the core module is satisfied with the given imports and also exports the provided interfaces. The output component is also verified with the validator from `wasmparser`. * wit-component: add more tests. This commit adds a test to encode an interface, decode the bytes using `wasmprinter`, and then compare the output with a baseline wat file. It also adds a `simple` test case for encoding components where a component exports a single default interface. * wit-component: add more component tests. This commit adds more tests to `wit-component` for component encoding. * wit-component: add error handling test cases. This commit adds several test cases for validation of the module that will be encoded as a component. * wit-component: be smarter about canonical option encoding. This commit only adds an encoding option if the function signatures contain strings. It also only adds the `into` option only if the function signature requires it. Added tests for lifting and lowering of various function signatures to ensure the canonical options emitted are correct. * wit-component: update and better doc test cases. This commit updates the documentation for the tests in `wit-component` and restructures the interface encoding tests directory layout to match that of the component encoding tests. * wit-component: update test baseline for new wasmprinter. This commit updates wasmprinter and the test baselines now that it correctly prints outer aliases. * wit-component: update assert_eq! for better diff printing. The `pretty_assertions` crate prints a nice diff for `assert_eq!` failures, but the tests were reversing left and right to make it more confusing when conceptually seeing changes from the baseline. This commit swaps the two arguments to `assert_eq!` so that left is the baseline and right is the output of the test. * wit-component: give names to one of the test core modules. This commit adds some names to one of the test module's canonical definitions. This helps to test that the names survive encoding and are also present when printed. * wit-component: add an import and export test case. This commit adds a test to cover both importing and exporting interfaces from the same component. Fixes a bug where importing functions wasn't contributing to the function type list. * wit-component: use type information from wasmparser for validation. This commit uses the type information returned from wasmparser for the validation of the core module. It also reduces the complexity of parsing the core module by using methods provided by wasmparser. * wit-component: code review feedback changes. Various code review feedback changes. * wit-component: be smarter about import lowerings. This commit changes how imports are lowered. Previously, the tool used indirect lowerings for all imports, even if the import didn't need the `into` option. Now such lowerings are lowered before the inner core module is instantiated and directly given as an argument. Additionally, if there are indirect lowerings to perform, at most two additional modules are encoded: a module storing a table for only the indirect lowerings and another that initializes the table once the core module has been instantiated.
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 PR introduces the
wit-componenttool responsible for taking as input a core WebAssembly module that implements the canonical ABI (i.e. produced bywit-bindgen) and a set of import and export interfaces to output a WebAssembly component based on the component model proposal.