Address review comments on wasm32v1-none target
This commit is contained in:
parent
e14d6d8314
commit
212d516ab0
6 changed files with 126 additions and 50 deletions
|
@ -1,55 +1,16 @@
|
|||
//! A "bare wasm" target representing a WebAssembly output that makes zero
|
||||
//! assumptions about its environment, similar to wasm32-unknown-unknown, but
|
||||
//! that also specifies an _upper_ bound on the set of wasm proposals that are
|
||||
//! supported.
|
||||
//! A "bare wasm" target representing a WebAssembly output that does not import
|
||||
//! anything from its environment and also specifies an _upper_ bound on the set
|
||||
//! of WebAssembly proposals that are supported.
|
||||
//!
|
||||
//! It is implemented as a variant on LLVM's wasm32-unknown-unknown target, with
|
||||
//! the additional flags `-Ctarget-cpu=mvp` and `-Ctarget-feature=+mutable-globals`.
|
||||
//!
|
||||
//! This target exists to resolve a tension in Rustc's choice of WebAssembly
|
||||
//! proposals to support. Since most WebAssembly users are in fact _on the web_
|
||||
//! and web browsers are frequently updated with support for the latest
|
||||
//! features, it is reasonable for Rustc to generate wasm code that exploits new
|
||||
//! WebAssembly proposals as they gain browser support. At least by default. And
|
||||
//! this is what the wasm32-unknown-unknown target does, which means that the
|
||||
//! _exact_ WebAssembly features that Rustc generates will change over time.
|
||||
//!
|
||||
//! But a different set of users -- smaller but nonetheless worth supporting --
|
||||
//! are using WebAssembly in implementations that either don't get updated very
|
||||
//! often, or need to prioritize stability, implementation simplicity or
|
||||
//! security over feature support. This target is for them, and it promises that
|
||||
//! the wasm code it generates will not go beyond the proposals/features of the
|
||||
//! W3C WebAssembly core 1.0 spec, which (as far as I can tell) is approximately
|
||||
//! "the wasm MVP plus mutable globals". Mutable globals was proposed in 2018
|
||||
//! and made it in.
|
||||
//!
|
||||
//! See https://www.w3.org/TR/wasm-core-1/
|
||||
//!
|
||||
//! Notably this feature-set _excludes_:
|
||||
//!
|
||||
//! - sign-extension operators
|
||||
//! - non-trapping / saturating float-to-int conversions
|
||||
//! - multi-value
|
||||
//! - reference types
|
||||
//! - bulk memory operations
|
||||
//! - SIMD
|
||||
//!
|
||||
//! These are all listed as additions in the core 2.0 spec. Also they were all
|
||||
//! proposed after 2020, and core 1.0 shipped in 2019. It also excludes even
|
||||
//! later proposals such as:
|
||||
//!
|
||||
//! - exception handling
|
||||
//! - tail calls
|
||||
//! - extended consts
|
||||
//! - function references
|
||||
//! - multi-memory
|
||||
//! - component model
|
||||
//! - gc
|
||||
//! - threads
|
||||
//! - relaxed SIMD
|
||||
//! - custom annotations
|
||||
//! - branch hinting
|
||||
//! It's equivalent to the `wasm32-unknown-unknown` target with the additional
|
||||
//! flags `-Ctarget-cpu=mvp` and `-Ctarget-feature=+mutable-globals`. This
|
||||
//! enables just the features specified in <https://www.w3.org/TR/wasm-core-1/>
|
||||
//!
|
||||
//! This is a _separate target_ because using `wasm32-unknown-unknown` with
|
||||
//! those target flags doesn't automatically rebuild libcore / liballoc with
|
||||
//! them, and in order to get those libraries rebuilt you need to use the
|
||||
//! nightly Rust feature `-Zbuild-std`. This target is for people who want to
|
||||
//! use stable Rust, and target a stable set pf WebAssembly features.
|
||||
|
||||
use crate::spec::{Cc, LinkerFlavor, Target, base};
|
||||
|
||||
|
@ -57,6 +18,8 @@ pub(crate) fn target() -> Target {
|
|||
let mut options = base::wasm::options();
|
||||
options.os = "none".into();
|
||||
|
||||
// WebAssembly 1.0 shipped in 2019 and included exactly one proposal
|
||||
// after the initial "MVP" feature set: "mutable-globals".
|
||||
options.cpu = "mvp".into();
|
||||
options.features = "+mutable-globals".into();
|
||||
|
||||
|
|
|
@ -118,6 +118,7 @@ ENV TARGETS=$TARGETS,wasm32-wasi
|
|||
ENV TARGETS=$TARGETS,wasm32-wasip1
|
||||
ENV TARGETS=$TARGETS,wasm32-wasip1-threads
|
||||
ENV TARGETS=$TARGETS,wasm32-wasip2
|
||||
ENV TARGETS=$TARGETS,wasm32v1-none
|
||||
ENV TARGETS=$TARGETS,sparcv9-sun-solaris
|
||||
ENV TARGETS=$TARGETS,x86_64-pc-solaris
|
||||
ENV TARGETS=$TARGETS,x86_64-unknown-linux-gnux32
|
||||
|
|
|
@ -86,6 +86,7 @@
|
|||
- [wasm32-wasip2](platform-support/wasm32-wasip2.md)
|
||||
- [wasm32-unknown-emscripten](platform-support/wasm32-unknown-emscripten.md)
|
||||
- [wasm32-unknown-unknown](platform-support/wasm32-unknown-unknown.md)
|
||||
- [wasm32v1-none](platform-support/wasm32v1-none.md)
|
||||
- [wasm64-unknown-unknown](platform-support/wasm64-unknown-unknown.md)
|
||||
- [\*-win7-windows-msvc](platform-support/win7-windows-msvc.md)
|
||||
- [x86_64-fortanix-unknown-sgx](platform-support/x86_64-fortanix-unknown-sgx.md)
|
||||
|
|
|
@ -195,6 +195,7 @@ target | std | notes
|
|||
`wasm32-wasi` | ✓ | WebAssembly with WASI (undergoing a [rename to `wasm32-wasip1`][wasi-rename])
|
||||
[`wasm32-wasip1`](platform-support/wasm32-wasip1.md) | ✓ | WebAssembly with WASI
|
||||
[`wasm32-wasip1-threads`](platform-support/wasm32-wasip1-threads.md) | ✓ | WebAssembly with WASI Preview 1 and threads
|
||||
[`wasm32v1-none`](platform-support/wasm32v1-none.md) | * | WebAssembly limited to 1.0 features and no imports
|
||||
[`x86_64-apple-ios`](platform-support/apple-ios.md) | ✓ | 64-bit x86 iOS
|
||||
[`x86_64-apple-ios-macabi`](platform-support/apple-ios-macabi.md) | ✓ | Mac Catalyst on x86_64
|
||||
[`x86_64-fortanix-unknown-sgx`](platform-support/x86_64-fortanix-unknown-sgx.md) | ✓ | [Fortanix ABI] for 64-bit Intel SGX
|
||||
|
|
109
src/doc/rustc/src/platform-support/wasm32v1-none.md
Normal file
109
src/doc/rustc/src/platform-support/wasm32v1-none.md
Normal file
|
@ -0,0 +1,109 @@
|
|||
# `wasm32v1-none`
|
||||
|
||||
**Tier: 2**
|
||||
|
||||
The `wasm32v1-none` target is a WebAssembly compilation target that:
|
||||
|
||||
- Imports nothing from its host environment
|
||||
- Enables no proposals / features past the [W3C WebAssembly Core 1.0 spec]
|
||||
|
||||
[W3C WebAssembly Core 1.0 spec]: https://www.w3.org/TR/wasm-core-1/
|
||||
|
||||
The target is very similar to [`wasm32-unknown-unknown`](./wasm32-unknown-unknown.md) and similarly uses LLVM's `wasm32-unknown-unknown` backend target. It contains only three minor differences:
|
||||
|
||||
* Setting the `target-cpu` to `mvp` rather than the default `generic`. Requesting `mvp` disables _all_ WebAssembly proposals / LLVM target feature flags.
|
||||
* Enabling the [Import/Export of Mutable Globals] proposal (i.e. the `+mutable-globals` LLVM target feature flag)
|
||||
* Not compiling the `std` library at all, rather than compiling it with stubs.
|
||||
|
||||
[Import/Export of Mutable Globals]: https://github.com/WebAssembly/mutable-global
|
||||
|
||||
## Target maintainers
|
||||
|
||||
- Alex Crichton, https://github.com/alexcrichton
|
||||
- Graydon Hoare, https://github.com/graydon
|
||||
|
||||
## Requirements
|
||||
|
||||
This target is cross-compiled. It does not support `std`, only `core` and `alloc`. Since it imports nothing from its environment, any `std` parts that use OS facilities would be stubbed out with functions-that-fail anyways, and the experience of working with the stub `std` in the `wasm32-unknown-unknown` target was deemed not something worth repeating here.
|
||||
|
||||
Everything else about this target's requirements, building, usage and testing is the same as what's described in the [`wasm32-unknown-unknown` document](./wasm32-unknown-unknown.md), just using the target string `wasm32v1-none` in place of `wasm32-unknown-unknown`.
|
||||
|
||||
## Conditionally compiling code
|
||||
|
||||
It's recommended to conditionally compile code for this target with:
|
||||
|
||||
```text
|
||||
#[cfg(all(target_family = "wasm", target_os = "none"))]
|
||||
```
|
||||
|
||||
Note that there is no way to tell via `#[cfg]` whether code will be running on
|
||||
the web or not.
|
||||
|
||||
## Enabled WebAssembly features
|
||||
|
||||
As noted above, _no WebAssembly proposals past 1.0_ are enabled on this target by default. Indeed, the entire point of this target is to have a way to compile for a stable "no post-1.0 proposals" subset of WebAssembly _on stable Rust_.
|
||||
|
||||
The [W3C WebAssembly Core 1.0 spec] was adopted as a W3C recommendation in December 2019, and includes exactly one "post-MVP" proposal: the [Import/Export of Mutable Globals] proposal.
|
||||
|
||||
All subsequent proposals are _disabled_ on this target by default, though they can be individually enabled by passing LLVM target-feature flags.
|
||||
|
||||
For reference sake, the set of proposals that LLVM supports at the time of writing, that this target _does not enable by default_, are listed here along with their LLVM target-feature flags:
|
||||
|
||||
* Post-1.0 proposals (integrated into the WebAssembly core 2.0 spec):
|
||||
* [Bulk memory] - `+bulk-memory`
|
||||
* [Sign-extending operations] - `+sign-ext`
|
||||
* [Non-trapping fp-to-int operations] - `+nontrapping-fptoint`
|
||||
* [Multi-value] - `+multivalue`
|
||||
* [Reference Types] - `+reference-types`
|
||||
* [Fixed-width SIMD] - `+simd128`
|
||||
* Post-2.0 proposals:
|
||||
* [Threads] (supported by atomics) - `+atomics`
|
||||
* [Exception handling] - `+exception-handling`
|
||||
* [Extended Constant Expressions] - `+extended-const`
|
||||
* [Half Precision] - `+half-precision`
|
||||
* [Multiple memories]- `+multimemory`
|
||||
* [Relaxed SIMD] - `+relaxed-simd`
|
||||
* [Tail call] - `+tail-call`
|
||||
|
||||
[Bulk memory]: https://github.com/WebAssembly/spec/blob/main/proposals/bulk-memory-operations/Overview.md
|
||||
[Sign-extending operations]: https://github.com/WebAssembly/spec/blob/main/proposals/sign-extension-ops/Overview.md
|
||||
[Non-trapping fp-to-int operations]: https://github.com/WebAssembly/spec/blob/main/proposals/nontrapping-float-to-int-conversion/Overview.md
|
||||
[Multi-value]: https://github.com/WebAssembly/spec/blob/main/proposals/multi-value/Overview.md
|
||||
[Reference Types]: https://github.com/WebAssembly/spec/blob/main/proposals/reference-types/Overview.md
|
||||
[Fixed-width SIMD]: https://github.com/WebAssembly/spec/blob/main/proposals/simd/SIMD.md
|
||||
[Threads]: https://github.com/webassembly/threads
|
||||
[Exception handling]: https://github.com/WebAssembly/exception-handling
|
||||
[Extended Constant Expressions]: https://github.com/WebAssembly/extended-const
|
||||
[Half Precision]: https://github.com/WebAssembly/half-precision
|
||||
[Multiple memories]: https://github.com/WebAssembly/multi-memory
|
||||
[Relaxed SIMD]: https://github.com/WebAssembly/relaxed-simd
|
||||
[Tail call]: https://github.com/WebAssembly/tail-call
|
||||
|
||||
Additional proposals in the future are, of course, also not enabled by default.
|
||||
|
||||
## Rationale relative to wasm32-unknown-unknown
|
||||
|
||||
As noted in the [`wasm32-unknown-unknown` document](./wasm32-unknown-unknown.md), it is possible to compile with `-target wasm32-unknown-unknown` and disable all WebAssembly proposals "by hand", by passing `-Ctarget-cpu=mvp`. Furthermore one can enable proposals one by one by passing LLVM target feature flags, such as `-Ctarget-feature=+mutable-globals`.
|
||||
|
||||
Is it therefore reasonable to wonder what the difference is between building with this:
|
||||
|
||||
```sh
|
||||
$ rustc -target wasm32-unknown-unknown -Ctarget-cpu=mvp -Ctarget-feature=+mutable-globals
|
||||
```
|
||||
|
||||
and building with this:
|
||||
|
||||
```sh
|
||||
$ rustc -target wasm32v1-none
|
||||
```
|
||||
|
||||
The difference is in how the `core` and `alloc` crates are compiled for distribution with the toolchain, and whether it works on _stable_ Rust toolchains or requires _nightly_ ones. Again referring back to the [`wasm32-unknown-unknown` document](./wasm32-unknown-unknown.md), note that to disable all post-MVP proposals on that target one _actually_ has to compile with this:
|
||||
|
||||
```sh
|
||||
$ export RUSTFLAGS="-Ctarget-cpu=mvp -Ctarget-feature=+mutable-globals"
|
||||
$ cargo +nightly build -Zbuild-std=panic_abort,std -target wasm32-unknown-unknown
|
||||
```
|
||||
|
||||
Which not only rebuilds `std`, `core` and `alloc` (which is somewhat costly and annoying) but more importantly requires the use of nightly Rust toolchains (for the `-Zbuild-std` flag). This is very undesirable for the target audience, which consists of people targeting WebAssembly implementations that prioritize stability, simplicity and/or security over feature support.
|
||||
|
||||
This `wasm32v1-none` target exists as an alternative option that works on stable Rust toolchains, without rebuilding the stdlib.
|
|
@ -161,6 +161,7 @@ static TARGETS: &[&str] = &[
|
|||
"wasm32-wasip1",
|
||||
"wasm32-wasip1-threads",
|
||||
"wasm32-wasip2",
|
||||
"wasm32v1-none",
|
||||
"x86_64-apple-darwin",
|
||||
"x86_64-apple-ios",
|
||||
"x86_64-apple-ios-macabi",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue