Make encodings in wit-component harder to get wrong#337
Merged
alexcrichton merged 1 commit intobytecodealliance:mainfrom Oct 3, 2022
Merged
Make encodings in wit-component harder to get wrong#337alexcrichton merged 1 commit intobytecodealliance:mainfrom
wit-component harder to get wrong#337alexcrichton merged 1 commit intobytecodealliance:mainfrom
Conversation
Currently the `wit-component` crate's encoding is structured with incremental encoding of a component where sections are added, in bulk, locally within each method. This method of adding sections, however, can lead to mistakes where declaratively assigned indices end up getting wrong indices in the final binary. In recent changes to `wit-component` one of my loops of encoding new items got things in the wrong order so I decided to do this refactoring first where items are always immediately encoded into a component to ensure that the assigned index is guaranteed to match. This does have the downside of producing components with more sections since the interleavings currently create a fair number of 1-item sections, but I'm hoping that rewriting this to a more optimal encoding can be done in the future with a post-processing tool if necessary or an otherwise more deliberate local handling of batching things up.
alexcrichton
force-pushed
the
encode-immediately
branch
from
017333f to
a3a1c01
Compare
pchickey
approved these changes
Sep 30, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Currently the
wit-componentcrate's encoding is structured with incremental encoding of a component where sections are added, in bulk, locally within each method. This method of adding sections, however, can lead to mistakes where declaratively assigned indices end up getting wrong indices in the final binary.In recent changes to
wit-componentone of my loops of encoding new items got things in the wrong order so I decided to do this refactoring first where items are always immediately encoded into a component to ensure that the assigned index is guaranteed to match. This does have the downside of producing components with more sections since the interleavings currently create a fair number of 1-item sections, but I'm hoping that rewriting this to a more optimal encoding can be done in the future with a post-processing tool if necessary or an otherwise more deliberate local handling of batching things up.