Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

winch: Improve tunables/configuration validation #9490

Conversation

saulecabrera
Copy link
Member

This commit introduces proper validation and documentation to handle the engine features not currently supported by Winch (e.g., consume_fuel, follow-up to the discussion in
#9472).

In this commit, the tunables validation is done at the set_tunables method in Winch's wasmtime_environ::compile::CompilerBuilder implemetation, which enables removing Winch specific logic from Config::validate

This change also introduces the question of how to consolidate the compiler specific flags with Winch (e.g, the user-specified cranelift_* options) given that not all of them are applicable to Winch (e.g., cranelift_debug_verifier,
cranelift_nan_canonicalization), this change doesn't introduce any functionality on this front, however, it's probably something worth considering/discussing.

@saulecabrera saulecabrera requested a review from a team as a code owner October 20, 2024 21:33
@saulecabrera saulecabrera requested review from pchickey and removed request for a team October 20, 2024 21:33
@github-actions github-actions bot added wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime winch Winch issues or pull requests labels Oct 20, 2024
Copy link

Subscribe to Label Action

cc @saulecabrera

This issue or pull request has been labeled: "wasmtime:api", "wasmtime:config", "winch"

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

  • saulecabrera: winch

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

Learn more.

Copy link

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.

    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.

    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.


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.

@alexcrichton alexcrichton added this pull request to the merge queue Oct 21, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 21, 2024
@alexcrichton
Copy link
Member

For the fuzz failure I might recommend updating somewhere around here to switch back to Cranelift if epochs (or other Winch-unsupported configs) are enabled during fuzzing

@saulecabrera saulecabrera requested a review from a team as a code owner October 21, 2024 11:24
@saulecabrera saulecabrera requested review from elliottt and removed request for a team October 21, 2024 11:24
@saulecabrera saulecabrera added this pull request to the merge queue Oct 21, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 21, 2024
@github-actions github-actions bot added the fuzzing Issues related to our fuzzing infrastructure label Oct 21, 2024
Copy link

Subscribe to Label Action

cc @fitzgen

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.

@saulecabrera saulecabrera added this pull request to the merge queue Oct 21, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 21, 2024
saulecabrera added a commit to saulecabrera/wasmtime that referenced this pull request Oct 21, 2024
This commit handles dead code warnings produced by the compiler when the
macro is invoked as:

    #[wasmtime_test(strategies(not(Cranelift))]

Which occur because Winch currently only offers support for x86_64.

The motivation behind this change comes from
bytecodealliance#9490, which is where
the warnings surfaced.
github-merge-queue bot pushed a commit that referenced this pull request Oct 22, 2024
This commit handles dead code warnings produced by the compiler when the
macro is invoked as:

    #[wasmtime_test(strategies(not(Cranelift))]

Which occur because Winch currently only offers support for x86_64.

The motivation behind this change comes from
#9490, which is where
the warnings surfaced.
This commit introduces proper validation and documentation to handle the
engine features not currently supported by Winch (e.g., `consume_fuel`,
follow-up to the discussion in
bytecodealliance#9472).

In this commit, the tunables validation is done at the `set_tunables`
method in Winch's `wasmtime_environ::compile::CompilerBuilder`
implemetation, which enables removing Winch specific logic from
`Config::validate`

This change also introduces the question of how to consolidate the
compiler specific flags with Winch (e.g, the user-specified
`cranelift_*` options) given that not all of them are applicable to
Winch (e.g., `cranelift_debug_verifier`,
`cranelift_nan_canonicalization`), this change doesn't introduce any
functionality on this front, however, it's probably something worth
considering/discussing.
This allows a couple of things:
* Pre-configuring `Winch` as the strategy
* Handling the target architetures supported by Winch
@saulecabrera saulecabrera force-pushed the improve-winch-tunables-validation branch from 4a1d6df to 4e280bb Compare October 22, 2024 17:23
@saulecabrera saulecabrera added this pull request to the merge queue Oct 22, 2024
Merged via the queue into bytecodealliance:main with commit 6fdff5c Oct 22, 2024
39 checks passed
@saulecabrera saulecabrera deleted the improve-winch-tunables-validation branch October 22, 2024 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fuzzing Issues related to our fuzzing infrastructure wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime winch Winch issues or pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants