Skip to content

Merge static/dynamic guard size options#9528

Merged
alexcrichton merged 3 commits intobytecodealliance:mainfrom
alexcrichton:merge-guard-size-options
Nov 1, 2024
Merged

Merge static/dynamic guard size options#9528
alexcrichton merged 3 commits intobytecodealliance:mainfrom
alexcrichton:merge-guard-size-options

Conversation

@alexcrichton
Copy link
Copy Markdown
Member

@alexcrichton alexcrichton commented Oct 31, 2024

This commit is the first of what will likely be a few to refactor the memory-related configuration options in Wasmtime. The end goal of these refactorings is to fix some preexisting issues and additionally make the configuration easier to understand for both users and implementors alike. First on the chopping block here is to merge the dynamic_memory_guard_size and static_memory_guard_size options into one option. AFAIK there's not a strong reason to have separate configuration options for these so it's hopefully simpler to have a single memory_guard_size option which applies to all linear memories equally.

I'll note that the old CLI options are preserved but are documented as deprecated. We don't currently warn on using "deprecated options" so for now the old options are just documented as deprecated and are otherwise silently accepted.

@alexcrichton alexcrichton requested a review from a team as a code owner October 31, 2024 16:22
@alexcrichton alexcrichton requested review from pchickey and removed request for a team October 31, 2024 16:22
@alexcrichton alexcrichton requested a review from a team as a code owner October 31, 2024 16:49
@alexcrichton alexcrichton requested review from elliottt and removed request for a team October 31, 2024 16:49
@github-actions github-actions bot added fuzzing Issues related to our fuzzing infrastructure wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:c-api Issues pertaining to the C API. wasmtime:config Issues related to the configuration of Wasmtime labels Oct 31, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 31, 2024

Subscribe to Label Action

cc @fitzgen

Details This issue or pull request has been labeled: "fuzzing", "wasmtime:api", "wasmtime:c-api", "wasmtime:config"

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.

@alexcrichton alexcrichton force-pushed the merge-guard-size-options branch from 3e48531 to cb48e95 Compare October 31, 2024 18:52
@alexcrichton alexcrichton requested a review from a team as a code owner October 31, 2024 18:52
@alexcrichton
Merge static/dynamic guard size options
17d71fd 
This commit is the first of what will likely be a few to refactor the
memory-related configuration options in Wasmtime. The end goal of these
refactorings is to fix some preexisting issues and additionally make the
configuration easier to understand for both users and implementors
alike. First on the chopping block here is to merge the
`dynamic_memory_guard_size` and `static_memory_guard_size` options into
one option. AFAIK there's not a strong reason to have separate
configuration options for these so it's hopefully simpler to have a
single `memory_guard_size` option which applies to all linear memories
equally.

I'll note that the old CLI options are preserved but are documented as
deprecated. We don't currently warn on using "deprecated options" so for
now the old options are just documented as deprecated and are otherwise
silently accepted.
@alexcrichton
Fix compilation of C API
63d66a7
@alexcrichton
Fix build of fuzzers
525c93a
@alexcrichton alexcrichton force-pushed the merge-guard-size-options branch from cb48e95 to 525c93a Compare October 31, 2024 18:53
@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 31, 2024

Label Messager: wasmtime:config

It looks like you are changing Wasmtime's configuration options. Make sure to
complete this check list:

  • If you added a new Config method, you wrote extensive documentation for
    it.

    Details

    Our documentation should be of the following form:

    Short, simple summary sentence.

More details. These details can be multiple paragraphs. There should be
information about not just the method, but its parameters and results as
well.

Is this method fallible? If so, when can it return an error?

Can this method panic? If so, when does it panic?

# Example

Optional example here.

  • If you added a new Config method, or modified an existing one, you
    ensured that this configuration is exercised by the fuzz targets.

    Details

    For example, if you expose a new strategy for allocating the next instance
    slot inside the pooling allocator, you should ensure that at least one of our
    fuzz targets exercises that new strategy.

    Often, all that is required of you is to ensure that there is a knob for this
    configuration option in wasmtime_fuzzing::Config (or one
    of its nested structs).

    Rarely, this may require authoring a new fuzz target to specifically test this
    configuration. See our docs on fuzzing for more details.

  • If you are enabling a configuration option by default, make sure that it
    has been fuzzed for at least two weeks before turning it on by default.

Details

To modify this label's message, edit the .github/label-messager/wasmtime-config.md file.

To add new label messages or remove existing label messages, edit the
.github/label-messager.json configuration file.

Learn more.

pchickey
pchickey approved these changes Nov 1, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@pchickey pchickey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is a nice simplification

@alexcrichton alexcrichton added this pull request to the merge queue Nov 1, 2024
Merged via the queue into bytecodealliance:main with commit 48d5338 Nov 1, 2024
@alexcrichton alexcrichton deleted the merge-guard-size-options branch November 1, 2024 17:39
@alexcrichton alexcrichton mentioned this pull request Nov 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pchickey pchickey pchickey approved these changes

@elliottt elliottt Awaiting requested review from elliottt elliottt is a code owner automatically assigned from bytecodealliance/wasmtime-fuzz-reviewers

Assignees

No one assigned

Labels

fuzzing Issues related to our fuzzing infrastructure wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:c-api Issues pertaining to the C API. wasmtime:config Issues related to the configuration of Wasmtime

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcrichton @pchickey