1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "WebAssemblyCompileOptions.h"
#if ENABLE(WEBASSEMBLY)
#include "IteratorOperations.h"
#include "WasmModuleInformation.h"
#include "WebAssemblyBuiltin.h"
namespace JSC {
std::optional<WebAssemblyCompileOptions> WebAssemblyCompileOptions::tryCreate(JSGlobalObject* globalObject, JSObject *optionsObject)
{
if (!optionsObject)
return std::nullopt;
WebAssemblyCompileOptions options;
VM& vm = globalObject->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
// Check for the 'importedStringConstants' entry
JSValue importedStringConstantsValue = optionsObject->get(globalObject, PropertyName(Identifier::fromString(vm, "importedStringConstants"_s)));
RETURN_IF_EXCEPTION(scope, std::nullopt);
if (importedStringConstantsValue.isString()) {
auto importedStringConstants = asString(importedStringConstantsValue)->value(globalObject);
options.m_importedStringConstants = makeString(StringView(importedStringConstants));
} else if (!importedStringConstantsValue.isUndefined()) {
auto error = createTypeError(globalObject, "importedStringConstants option value must be a string"_s);
throwException(globalObject, scope, error);
return std::nullopt;
}
// Check for the 'builtins' entry, qualifying builtin set names in the process.
JSValue builtinsValue = optionsObject->get(globalObject, PropertyName(Identifier::fromString(vm, "builtins"_s)));
RETURN_IF_EXCEPTION(scope, std::nullopt);
if (builtinsValue.isObject()) {
bool sawBadEntries = false;
forEachInIterable(globalObject, builtinsValue, [&] (VM&, JSGlobalObject* globalObject, JSValue nextValue) {
if (nextValue.isString()) {
auto contents = asString(nextValue)->value(globalObject);
String qualifiedName = makeString("wasm:"_s, StringView(contents));
options.m_qualifiedBuiltinSetNames.append(qualifiedName);
} else
sawBadEntries = true;
});
RETURN_IF_EXCEPTION(scope, std::nullopt);
if (sawBadEntries) {
auto error = createTypeError(globalObject, "builtins list option values must be strings"_s);
throwException(globalObject, scope, error);
return std::nullopt;
}
}
return options;
}
static bool namesInclude(const String& expected, const Vector<String>& names)
{
for (auto& name : names) {
if (name == expected)
return true;
}
return false;
}
static String makeQualifiedName(const Wasm::Import& import)
{
return makeString(import.module, ":"_s, import.field);
}
/**
* See step 2.1 of: https://webassembly.github.io/js-string-builtins/js-api/#validate-builtins-and-imported-string-for-a-webassembly-module
*
* Informally: the import should be an immutable global of type externref.
*/
static std::optional<String> validateImportedStringConstant(const Wasm::Import& import, const Wasm::ModuleInformation& moduleInformation)
{
if (import.kind != Wasm::ExternalKind::Global)
return makeString("imported string constant "_s, makeQualifiedName(import), " is not a global"_s);
const Wasm::GlobalInformation& global = moduleInformation.globals[import.kindIndex];
if (global.mutability != Wasm::Immutable || !Wasm::isExternref(global.type))
return makeString("imported string constant "_s, makeQualifiedName(import), " is not an immutable external reference"_s);
return std::nullopt;
}
/**
* See https://webassembly.github.io/js-string-builtins/js-api/#validate-an-import-for-builtins
*
* Informally:
* Fail the validation if:
* - there is a builtin set whose simple name appears in builtinSetNames, and
* - the qualified name of the builtin set matches the import module name, and
* - the builtin set contains a builtin matching the function name, and
* - the builtin type does not match the import type.
*/
bool WebAssemblyCompileOptions::validateImportForBuiltinSetNames(const Wasm::Import& import, const String& importModuleName, const Wasm::ModuleInformation& moduleInfo) const
{
if (!namesInclude(importModuleName, m_qualifiedBuiltinSetNames))
return true;
const WebAssemblyBuiltinSet* builtinSet = WebAssemblyBuiltinRegistry::singleton().findByQualifiedName(importModuleName);
if (!builtinSet)
return true;
String importName = makeString(import.field);
const WebAssemblyBuiltin* builtin = builtinSet->findBuiltin(importName);
if (!builtin)
return true;
auto& builtinSig = builtin->signature();
// The spec does not explicitly check if the import is a function because an import type is fully self-contained in `import[2]`.
// A non-function import would have a non-function type as its `import[2]`, failing the `match_externtype` check in Step 7.
// In our implementation import type is held externally, so we must check that the import kind is a function before fetching the function type
// at `kindIndex`. The wrong import kind is equivalent in spec terms to `match_externtype` returning false in Step 7.
if (import.kind != Wasm::ExternalKind::Function)
return false;
Wasm::TypeIndex typeIndex = moduleInfo.importFunctionTypeIndices[import.kindIndex];
Ref<const Wasm::TypeDefinition> type = Wasm::TypeInformation::get(typeIndex);
if (!type->is<Wasm::FunctionSignature>())
return false;
SUPPRESS_UNCOUNTED_LOCAL auto* importSig = type->as<Wasm::FunctionSignature>();
return builtinSig.isValid(*importSig);
}
/**
* See https://webassembly.github.io/js-string-builtins/js-api/#validate-builtins-and-imported-string-for-a-webassembly-module
*
* Return nullopt to indicate success or an error message if validation failed.
*/
std::optional<String> WebAssemblyCompileOptions::validateBuiltinsAndImportedStrings(const Wasm::Module& module) const
{
if (!validateBuiltinSetNames())
return String::fromLatin1("the list of builtin set names contains duplicates");
auto moduleInfo = Ref(module.moduleInformation());
for (const auto& import : moduleInfo.get().imports) {
String importModuleName = makeString(import.module);
if (m_importedStringConstants && *m_importedStringConstants == importModuleName) {
auto errorMessage = validateImportedStringConstant(import, moduleInfo.get());
if (errorMessage)
return errorMessage;
} else {
if (!validateImportForBuiltinSetNames(import, importModuleName, moduleInfo.get()))
return makeString("builtin import "_s, makeQualifiedName(import), " has an unexpected signature"_s);
}
}
return std::nullopt;
}
/**
* See https://webassembly.github.io/js-string-builtins/js-api/#validate-builtin-set-names
*
* Informally: the list of builtin set names should not have duplicates.
*/
bool WebAssemblyCompileOptions::validateBuiltinSetNames() const
{
UncheckedKeyHashSet<String> seen;
for (const auto& name : m_qualifiedBuiltinSetNames) {
if (seen.contains(name))
return false;
seen.add(name);
}
return true;
}
} // namespace JSC
#endif // ENABLE(WEBASSEMBLY)
|