/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- * vim: set ts=8 sts=2 et sw=2 tw=80: * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #ifndef js_WasmFeatures_h #define js_WasmFeatures_h // [SMDOC] WebAssembly feature gating // // Declarative listing of WebAssembly optional features. This macro is used to // generate most of the feature gating code in a centralized manner. See // 'Adding a feature' below for the exact steps needed to add a new feature. // // Each feature is either `DEFAULT`, `TENTATIVE`, or `EXPERIMENTAL`: // // Default features are enabled by default in ContextOptions and in the // JS-shell, and are given a `--no-wasm-FEATURE` shell flag to disable. The // `--wasm-FEATURE` flag is rejected. // // Tentative features are like Default features, but the `--wasm-FEATURE` flag // is silently ignored. // // Experimental features are disabled by default in ContextOptions and in the // JS-shell, and are given a `--wasm-FEATURE` shell flag to enable. The // `--no-wasm-FEATURE` flag is silently ignored. // // The browser pref is `javascript.options.wasm-FEATURE` for default, tentative, // and experimental features alike. // // # Adding a feature // // 1. Add a configure switch for the feature in js/moz.configure // 2. Add a WASM_FEATURE_ENABLED #define below // 3. Add the feature to JS_FOR_WASM_FEATURES // a. capitalized name: Used for naming of feature functions, including // wasmFeatureEnabled shell function. // b. lower case name: Used for naming of feature flag variables, including // in wasm::FeatureArgs. // c. compile predicate: Set to WASM_FEATURE_ENABLED // d. compiler predicate: Expression of compilers that this feature depends // on. // e. flag predicate: Expression used to predicate enablement of feature // flag. Useful for disabling a feature when dependent feature is not // enabled or if we are fuzzing. // f. shell flag: The stem of the JS-shell flag. Will be expanded to // --no-wasm-FEATURE or --wasm-FEATURE as explained above. // g. preference name: The stem of the browser preference. Will be expanded // to `javascript.options.wasm-FEATURE`. // 4. Add the preference to module/libpref/init/StaticPrefList.yaml // a. Use conditionally compiled flag // b. Set value to 'true' for default features, @IS_NIGHTLY_BUILD@ for // tentative features, and 'false' for experimental features. // 5. [fuzzing] Add the feature to gluesmith/src/lib.rs, if wasm-smith has // support for it. #ifdef ENABLE_WASM_RELAXED_SIMD # define WASM_RELAXED_SIMD_ENABLED 1 #else # define WASM_RELAXED_SIMD_ENABLED 0 #endif #ifdef ENABLE_WASM_EXTENDED_CONST # define WASM_EXTENDED_CONST_ENABLED 1 #else # define WASM_EXTENDED_CONST_ENABLED 0 #endif #ifdef ENABLE_WASM_FUNCTION_REFERENCES # define WASM_FUNCTION_REFERENCES_ENABLED 1 #else # define WASM_FUNCTION_REFERENCES_ENABLED 0 #endif #ifdef ENABLE_WASM_GC # define WASM_GC_ENABLED 1 #else # define WASM_GC_ENABLED 0 #endif #ifdef ENABLE_WASM_MEMORY64 # define WASM_MEMORY64_ENABLED 1 #else # define WASM_MEMORY64_ENABLED 0 #endif #ifdef ENABLE_WASM_MEMORY_CONTROL # define WASM_MEMORY_CONTROL_ENABLED 1 #else # define WASM_MEMORY_CONTROL_ENABLED 0 #endif #ifdef ENABLE_WASM_TAIL_CALLS # define WASM_TAIL_CALLS_ENABLED 1 #else # define WASM_TAIL_CALLS_ENABLED 0 #endif #ifdef ENABLE_WASM_MOZ_INTGEMM # define WASM_MOZ_INTGEMM_ENABLED 1 #else # define WASM_MOZ_INTGEMM_ENABLED 0 #endif #ifdef ENABLE_WASM_MULTI_MEMORY # define WASM_MULTI_MEMORY_ENABLED 1 #else # define WASM_MULTI_MEMORY_ENABLED 0 #endif #ifdef ENABLE_WASM_JS_STRING_BUILTINS # define WASM_JS_STRING_BUILTINS_ENABLED 1 #else # define WASM_JS_STRING_BUILTINS_ENABLED 0 #endif enum class WasmFeatureStage { Experimental = 0, Tentative, Default, }; // clang-format off #define JS_FOR_WASM_FEATURES(FEATURE) \ FEATURE( \ /* capitalized name */ ExtendedConst, \ /* lower case name */ extendedConst, \ /* stage */ WasmFeatureStage::Tentative, \ /* compile predicate */ WASM_EXTENDED_CONST_ENABLED, \ /* compiler predicate */ true, \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ true, \ /* shell flag */ "extended-const", \ /* preference name */ "extended_const") \ FEATURE( \ /* capitalized name */ Exceptions, \ /* lower case name */ exceptions, \ /* stage */ WasmFeatureStage::Default, \ /* compile predicate */ true, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ WasmExnRefFlag(cx), \ /* flag fuzz enable */ true, \ /* shell flag */ "exceptions", \ /* preference name */ "exceptions") \ FEATURE( \ /* capitalized name */ ExnRef, \ /* lower case name */ exnref, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ true, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ true, \ /* shell flag */ "exnref", \ /* preference name */ "exnref ") \ FEATURE( \ /* capitalized name */ FunctionReferences, \ /* lower case name */ functionReferences, \ /* stage */ WasmFeatureStage::Tentative, \ /* compile predicate */ WASM_FUNCTION_REFERENCES_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ WasmGcFlag(cx), \ /* flag fuzz enable */ false, \ /* shell flag */ "function-references", \ /* preference name */ "function_references") \ FEATURE( \ /* capitalized name */ Gc, \ /* lower case name */ gc, \ /* stage */ WasmFeatureStage::Tentative, \ /* compile predicate */ WASM_GC_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ false, \ /* shell flag */ "gc", \ /* preference name */ "gc") \ FEATURE( \ /* capitalized name */ JSStringBuiltins, \ /* lower case name */ jsStringBuiltins, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ WASM_JS_STRING_BUILTINS_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ true, \ /* shell flag */ "js-string-builtins", \ /* preference name */ "js_string_builtins") \ FEATURE( \ /* capitalized name */ RelaxedSimd, \ /* lower case name */ v128Relaxed, \ /* stage */ WasmFeatureStage::Tentative, \ /* compile predicate */ WASM_RELAXED_SIMD_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ js::jit::JitSupportsWasmSimd(), \ /* flag force enable */ false, \ /* flag fuzz enable */ true, \ /* shell flag */ "relaxed-simd", \ /* preference name */ "relaxed_simd") \ FEATURE( \ /* capitalized name */ Memory64, \ /* lower case name */ memory64, \ /* stage */ WasmFeatureStage::Tentative, \ /* compile predicate */ WASM_MEMORY64_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ true, \ /* shell flag */ "memory64", \ /* preference name */ "memory64") \ FEATURE( \ /* capitalized name */ MemoryControl, \ /* lower case name */ memoryControl, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ WASM_MEMORY_CONTROL_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ false, \ /* shell flag */ "memory-control", \ /* preference name */ "memory_control") \ FEATURE( \ /* capitalized name */ MultiMemory, \ /* lower case name */ multiMemory, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ WASM_MULTI_MEMORY_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ false, \ /* shell flag */ "multi-memory", \ /* preference name */ "multi_memory") \ FEATURE( \ /* capitalized name */ TailCalls, \ /* lower case name */ tailCalls, \ /* stage */ WasmFeatureStage::Tentative, \ /* compile predicate */ WASM_TAIL_CALLS_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ true, \ /* shell flag */ "tail-calls", \ /* preference name */ "tail_calls") \ FEATURE( \ /* capitalized name */ MozIntGemm, \ /* lower case name */ mozIntGemm, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ WASM_MOZ_INTGEMM_ENABLED, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ IsSimdPrivilegedContext(cx), \ /* flag force enable */ false, \ /* flag fuzz enable */ false, \ /* shell flag */ "moz-intgemm", \ /* preference name */ "moz_intgemm") \ FEATURE( \ /* capitalized name */ TestSerialization, \ /* lower case name */ testSerialization, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ 1, \ /* compiler predicate */ IonAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ false, \ /* shell flag */ "test-serialization", \ /* preference name */ "test-serialization") \ FEATURE( \ /* capitalized name */ TestMetadata, \ /* lower case name */ testMetadata, \ /* stage */ WasmFeatureStage::Experimental, \ /* compile predicate */ 1, \ /* compiler predicate */ AnyCompilerAvailable(cx), \ /* flag predicate */ true, \ /* flag force enable */ false, \ /* flag fuzz enable */ false, \ /* shell flag */ "test-metadata", \ /* preference name */ "test_metadata") // clang-format on #endif // js_WasmFeatures_h