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

Wasmtime: Add a gc cargo feature #7975

Merged
merged 12 commits into from
Feb 23, 2024

Conversation

fitzgen
Copy link
Member

@fitzgen fitzgen commented Feb 22, 2024

This controls whether support for ExternRef and its associated deferred, reference-counting garbage collector is enabled at compile time or not. It will also be used for similarly for Wasmtime's full Wasm GC support as that gets added.

@fitzgen fitzgen requested a review from a team as a code owner February 22, 2024 00:04
@fitzgen fitzgen requested review from alexcrichton and removed request for a team February 22, 2024 00:04
@fitzgen
Copy link
Member Author

fitzgen commented Feb 22, 2024

I didn't add a smoke test build without the gc cargo feature to CI, but I can do that if we decide we can afford the CI time.

@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 labels Feb 22, 2024
Copy link

Subscribe to Label Action

cc @peterhuene

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

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

  • peterhuene: wasmtime:api

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.

Copy link
Member

@alexcrichton alexcrichton left a comment

Choose a reason for hiding this comment

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

Nice!

My main comments below are about perhaps shifting around #[cfg] to try to reduce it. That's my main worried with these sorts of features is that it can become difficult in the limit to ensure all the #[cfg] annotations are aligned so I'm hoping we can try to reduce them as much as possible. More-or-less I think that ExternRef and probably VMExternRef should have the same API no matter the feature set (modulo constructors) and that way consumers don't have to #[cfg] which should help centralize this.

We'll also definitely want this on CI and I'd recommend putting it around here

crates/wasmtime/src/runtime/values.rs Outdated Show resolved Hide resolved
crates/wasmtime/src/runtime/store.rs Show resolved Hide resolved
crates/wasmtime/src/runtime/store.rs Outdated Show resolved Hide resolved
crates/wasmtime/src/runtime/ref/gc_ref.rs Show resolved Hide resolved
crates/wasmtime/src/config.rs Show resolved Hide resolved
crates/runtime/src/table.rs Outdated Show resolved Hide resolved
@fitzgen fitzgen requested a review from a team as a code owner February 22, 2024 17:52
@fitzgen
Copy link
Member Author

fitzgen commented Feb 22, 2024

Okay, I've updated this PR to stub out more VMExternRef things and methods when GC is disabled at compile time and removed a bunch of cfgs from the rest of the code base. Not all of them in store.rs, as mentioned inline above. I think this is ready for another round of review.

@fitzgen fitzgen requested a review from a team as a code owner February 22, 2024 19:16
@fitzgen fitzgen requested review from cfallin and removed request for a team February 22, 2024 19:16
crates/runtime/src/table.rs Outdated Show resolved Hide resolved
crates/wasmtime/src/runtime/func.rs Outdated Show resolved Hide resolved
crates/wasmtime/src/runtime/ref/no_gc_ref.rs Outdated Show resolved Hide resolved
crates/wasmtime/src/runtime/ref/no_gc_ref.rs Outdated Show resolved Hide resolved
@fitzgen fitzgen requested review from alexcrichton and removed request for cfallin and alexcrichton February 22, 2024 19:16
@fitzgen fitzgen added this pull request to the merge queue Feb 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 22, 2024
@github-actions github-actions bot added wasmtime:ref-types Issues related to reference types and GC in Wasmtime winch Winch issues or pull requests labels Feb 22, 2024
Copy link

Subscribe to Label Action

cc @fitzgen, @saulecabrera

This issue or pull request has been labeled: "wasmtime:ref-types", "winch"

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

  • fitzgen: wasmtime:ref-types
  • saulecabrera: winch

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

Learn more.

@fitzgen fitzgen added this pull request to the merge queue Feb 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 22, 2024
@fitzgen fitzgen added this pull request to the merge queue Feb 22, 2024
@fitzgen fitzgen removed this pull request from the merge queue due to a manual request Feb 22, 2024
@github-actions github-actions bot added the wasmtime:c-api Issues pertaining to the C API. label Feb 23, 2024
Copy link

Subscribe to Label Action

cc @peterhuene

This issue or pull request has been labeled: "wasmtime:c-api"

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

  • peterhuene: wasmtime:c-api

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

Learn more.

@fitzgen fitzgen added this pull request to the merge queue Feb 23, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 23, 2024
@fitzgen fitzgen added this pull request to the merge queue Feb 23, 2024
Merged via the queue into bytecodealliance:main with commit dd0364d Feb 23, 2024
19 checks passed
@fitzgen fitzgen deleted the gc-cargo-feature branch February 23, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 wasmtime:ref-types Issues related to reference types and GC in Wasmtime winch Winch issues or pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants