alexcrichton opened PR #9941 from alexcrichton:rejigger-features
to bytecodealliance:main
:
This commit refactors the platform support of the
wasmtime
crate itself to remove the previously addedsignals-based-traps
feature in favor of auto-detecting whether it's there or not. Thebuild.rs
script for thewasmtime
crate will now detect the target platform and auto-enable this feature as necessary.The
signals-based-traps
cargo feature is removed and split into two custom#[cfg]
directives that the build script sets:
has_virtual_memory
- this is used to gate mmap implementations for example. This is enabled onunix || windows
and will be off forno_std
targets for example. This is split out of "signals-based-traps" to better handle platforms like iOS which have virtual memory but don't execute native code (removing the need for native signals).
has_native_signals
- gates signal handlers on Unix for example. This is disabled on MIRI but otherwise enabled forunix || windows
. This is intended to in the future get disabled for iOS by default for example since it's not necessary when using Pulley. This is additionally off-by-default forno_std
platforms.Two new crate features were added for
no_std
or "custom" platforms to opt-in to thewasmtime-platform.h
C APIs for implementing virtual memory and signals. These are used in themin-platform
embedding example.This commit additionally updates some various documentation here and there to be more up-to-date.
<!--
Please make sure you include the following information:
If this work has been discussed elsewhere, please include a link to that
conversation. If it was discussed in an issue, just mention "issue #...".Explain why this change is needed. If the details are in an issue already,
this can be brief.Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.htmlPlease ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->
alexcrichton requested fitzgen for a review on PR #9941.
alexcrichton requested wasmtime-fuzz-reviewers for a review on PR #9941.
alexcrichton requested wasmtime-core-reviewers for a review on PR #9941.
alexcrichton requested wasmtime-default-reviewers for a review on PR #9941.
alexcrichton commented on PR #9941:
One of the rough high-level goals here is that in conjunction with https://github.com/bytecodealliance/wasmtime/pull/9837 I hope to disable
has_native_signals
on Pulley-only platforms in the near future to statically remove all that code. That should make Wasmtime more portable by default since when there's no Cranelift backend there's no need to install signal handlers which often has lots of platform/architecture-specific implications.
alexcrichton updated PR #9941.
github-actions[bot] commented on PR #9941:
Subscribe to Label Action
cc @fitzgen
<details>
This issue or pull request has been labeled: "fuzzing", "wasi", "wasmtime:api", "wasmtime:config", "wasmtime:docs"Thus the following users have been cc'd because of the following labels:
- fitzgen: fuzzing
To subscribe or unsubscribe from this label, edit the <code>.github/subscribe-to-label.json</code> configuration file.
Learn more.
</details>
github-actions[bot] commented on PR #9941:
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:
```text
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.
```</details>
[ ] 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
][fuzzing-config] (or one
of its nestedstruct
s).Rarely, this may require authoring a new fuzz target to specifically test this
configuration. See [our docs on fuzzing][fuzzing-docs] for more details.</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.[fuzzing-config]: https://github.com/bytecodealliance/wasmtime/blob/ca0e8d0a1d8cefc0496dba2f77a670571d8fdcab/crates/fuzzing/src/generators.rs#L182-L194
[fuzzing-docs]: https://docs.wasmtime.dev/contributing-fuzzing.html
<details>
To modify this label's message, edit the <code>.github/label-messager/wasmtime-config.md</code> file.
To add new label messages or remove existing label messages, edit the
<code>.github/label-messager.json</code> configuration file.</details>
bjorn3 submitted PR review.
bjorn3 created PR review comment:
wasm32-unknown-emscripten is marked as unix, but has neither signals, nor virtual memory. I guess it is not all too important that Wasmtime works on Emscripten though.
alexcrichton created PR review comment:
That's a good point yeah, although this
unix || windows
logic matches what's currently in thesys
module so we technically already didn't support Emscripten. It should be reasonable though to add support here though in the future.
alexcrichton submitted PR review.
fitzgen submitted PR review:
LGTM! I'm glad that this leaves the ability to turn off signals usage at engine config-time, even if the target supports it, as I think that is a use case we need to support.
alexcrichton updated PR #9941.
alexcrichton has enabled auto merge for PR #9941.
alexcrichton updated PR #9941.
alexcrichton has enabled auto merge for PR #9941.
alexcrichton updated PR #9941.
alexcrichton has enabled auto merge for PR #9941.
alexcrichton updated PR #9941.
alexcrichton updated PR #9941.
alexcrichton has enabled auto merge for PR #9941.
alexcrichton merged PR #9941.
Last updated: Jan 24 2025 at 00:11 UTC