blob: 3649e570f2f626a0a3eaec16e29971aef9dc10ba [file] [log] [blame]
/*
* Copyright (C) 2016-2019 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 "JSWebAssembly.h"
#if ENABLE(WEBASSEMBLY)
#include "CatchScope.h"
#include "Exception.h"
#include "FunctionPrototype.h"
#include "JSCBuiltins.h"
#include "JSCInlines.h"
#include "JSModuleNamespaceObject.h"
#include "JSPromise.h"
#include "JSToWasm.h"
#include "JSWebAssemblyHelpers.h"
#include "JSWebAssemblyInstance.h"
#include "JSWebAssemblyModule.h"
#include "ObjectConstructor.h"
#include "Options.h"
#include "PromiseTimer.h"
#include "StrongInlines.h"
#include "ThrowScope.h"
#include "WasmBBQPlan.h"
#include "WasmOperations.h"
#include "WasmToJS.h"
#include "WasmWorklist.h"
#include "WebAssemblyInstanceConstructor.h"
#include "WebAssemblyModuleConstructor.h"
using JSC::Wasm::Plan;
using JSC::Wasm::BBQPlan;
namespace JSC {
STATIC_ASSERT_IS_TRIVIALLY_DESTRUCTIBLE(JSWebAssembly);
#define DEFINE_CALLBACK_FOR_CONSTRUCTOR(capitalName, lowerName, properName, instanceType, jsName, prototypeBase, featureFlag) \
static JSValue create##capitalName(VM& vm, JSObject* object) \
{ \
JSWebAssembly* webAssembly = jsCast<JSWebAssembly*>(object); \
JSGlobalObject* globalObject = webAssembly->globalObject(vm); \
return globalObject->properName##Constructor(); \
}
FOR_EACH_WEBASSEMBLY_CONSTRUCTOR_TYPE(DEFINE_CALLBACK_FOR_CONSTRUCTOR)
#undef DEFINE_CALLBACK_FOR_CONSTRUCTOR
static EncodedJSValue JSC_HOST_CALL webAssemblyCompileFunc(JSGlobalObject*, CallFrame*);
static EncodedJSValue JSC_HOST_CALL webAssemblyInstantiateFunc(JSGlobalObject*, CallFrame*);
static EncodedJSValue JSC_HOST_CALL webAssemblyValidateFunc(JSGlobalObject*, CallFrame*);
}
#include "JSWebAssembly.lut.h"
namespace JSC {
const ClassInfo JSWebAssembly::s_info = { "WebAssembly", &Base::s_info, &webAssemblyTable, nullptr, CREATE_METHOD_TABLE(JSWebAssembly) };
/* Source for JSWebAssembly.lut.h
@begin webAssemblyTable
CompileError createWebAssemblyCompileError DontEnum|PropertyCallback
Global createWebAssemblyGlobal DontEnum|PropertyCallback
Instance createWebAssemblyInstance DontEnum|PropertyCallback
LinkError createWebAssemblyLinkError DontEnum|PropertyCallback
Memory createWebAssemblyMemory DontEnum|PropertyCallback
Module createWebAssemblyModule DontEnum|PropertyCallback
RuntimeError createWebAssemblyRuntimeError DontEnum|PropertyCallback
Table createWebAssemblyTable DontEnum|PropertyCallback
compile webAssemblyCompileFunc Function 1
instantiate webAssemblyInstantiateFunc Function 1
validate webAssemblyValidateFunc Function 1
@end
*/
JSWebAssembly* JSWebAssembly::create(VM& vm, JSGlobalObject* globalObject, Structure* structure)
{
auto* object = new (NotNull, allocateCell<JSWebAssembly>(vm.heap)) JSWebAssembly(vm, structure);
object->finishCreation(vm, globalObject);
return object;
}
Structure* JSWebAssembly::createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
{
return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
}
void JSWebAssembly::finishCreation(VM& vm, JSGlobalObject* globalObject)
{
Base::finishCreation(vm);
ASSERT(inherits(vm, info()));
if (Options::useWebAssemblyStreamingApi()) {
JSC_BUILTIN_FUNCTION_WITHOUT_TRANSITION("compileStreaming", webAssemblyCompileStreamingCodeGenerator, static_cast<unsigned>(PropertyAttribute::DontEnum));
JSC_BUILTIN_FUNCTION_WITHOUT_TRANSITION("instantiateStreaming", webAssemblyInstantiateStreamingCodeGenerator, static_cast<unsigned>(PropertyAttribute::DontEnum));
}
}
JSWebAssembly::JSWebAssembly(VM& vm, Structure* structure)
: JSNonFinalObject(vm, structure)
{
}
static void reject(JSGlobalObject* globalObject, CatchScope& catchScope, JSPromise* promise)
{
Exception* exception = catchScope.exception();
ASSERT(exception);
catchScope.clearException();
promise->reject(globalObject, exception->value());
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, void());
}
static void webAssemblyModuleValidateAsyncInternal(JSGlobalObject* globalObject, JSPromise* promise, Vector<uint8_t>&& source)
{
VM& vm = globalObject->vm();
Vector<Strong<JSCell>> dependencies;
dependencies.append(Strong<JSCell>(vm, globalObject));
vm.promiseTimer->addPendingPromise(vm, promise, WTFMove(dependencies));
Wasm::Module::validateAsync(&vm.wasmContext, WTFMove(source), createSharedTask<Wasm::Module::CallbackType>([promise, globalObject, &vm] (Wasm::Module::ValidationResult&& result) mutable {
vm.promiseTimer->scheduleWorkSoon(promise, [promise, globalObject, result = WTFMove(result), &vm] () mutable {
auto scope = DECLARE_CATCH_SCOPE(vm);
JSValue module = JSWebAssemblyModule::createStub(vm, globalObject, globalObject->webAssemblyModuleStructure(), WTFMove(result));
if (UNLIKELY(scope.exception())) {
reject(globalObject, scope, promise);
return;
}
promise->resolve(globalObject, module);
CLEAR_AND_RETURN_IF_EXCEPTION(scope, void());
});
}));
}
static EncodedJSValue JSC_HOST_CALL webAssemblyCompileFunc(JSGlobalObject* globalObject, CallFrame* callFrame)
{
VM& vm = globalObject->vm();
auto throwScope = DECLARE_THROW_SCOPE(vm);
auto* promise = JSPromise::create(vm, globalObject->promiseStructure());
RETURN_IF_EXCEPTION(throwScope, encodedJSValue());
{
auto catchScope = DECLARE_CATCH_SCOPE(vm);
Vector<uint8_t> source = createSourceBufferFromValue(vm, globalObject, callFrame->argument(0));
if (UNLIKELY(catchScope.exception()))
reject(globalObject, catchScope, promise);
else
webAssemblyModuleValidateAsyncInternal(globalObject, promise, WTFMove(source));
return JSValue::encode(promise);
}
}
enum class Resolve { WithInstance, WithModuleRecord, WithModuleAndInstance };
static void resolve(VM& vm, JSGlobalObject* globalObject, JSPromise* promise, JSWebAssemblyInstance* instance, JSWebAssemblyModule* module, JSObject* importObject, Ref<Wasm::CodeBlock>&& codeBlock, Resolve resolveKind, Wasm::CreationMode creationMode)
{
auto scope = DECLARE_CATCH_SCOPE(vm);
instance->finalizeCreation(vm, globalObject, WTFMove(codeBlock), importObject, creationMode);
RETURN_IF_EXCEPTION(scope, reject(globalObject, scope, promise));
if (resolveKind == Resolve::WithInstance)
promise->resolve(globalObject, instance);
else if (resolveKind == Resolve::WithModuleRecord) {
auto* moduleRecord = instance->moduleNamespaceObject()->moduleRecord();
if (Options::dumpModuleRecord())
moduleRecord->dump();
promise->resolve(globalObject, moduleRecord);
} else {
JSObject* result = constructEmptyObject(globalObject);
result->putDirect(vm, Identifier::fromString(vm, "module"_s), module);
result->putDirect(vm, Identifier::fromString(vm, "instance"_s), instance);
promise->resolve(globalObject, result);
}
CLEAR_AND_RETURN_IF_EXCEPTION(scope, void());
}
void JSWebAssembly::webAssemblyModuleValidateAsync(JSGlobalObject* globalObject, JSPromise* promise, Vector<uint8_t>&& source)
{
VM& vm = globalObject->vm();
auto catchScope = DECLARE_CATCH_SCOPE(vm);
webAssemblyModuleValidateAsyncInternal(globalObject, promise, WTFMove(source));
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, void());
}
static void instantiate(VM& vm, JSGlobalObject* globalObject, JSPromise* promise, JSWebAssemblyModule* module, JSObject* importObject, const Identifier& moduleKey, Resolve resolveKind, Wasm::CreationMode creationMode)
{
auto scope = DECLARE_CATCH_SCOPE(vm);
// In order to avoid potentially recompiling a module. We first gather all the import/memory information prior to compiling code.
JSWebAssemblyInstance* instance = JSWebAssemblyInstance::tryCreate(vm, globalObject, moduleKey, module, importObject, globalObject->webAssemblyInstanceStructure(), Ref<Wasm::Module>(module->module()), creationMode);
RETURN_IF_EXCEPTION(scope, reject(globalObject, scope, promise));
Vector<Strong<JSCell>> dependencies;
// The instance keeps the module alive.
dependencies.append(Strong<JSCell>(vm, instance));
dependencies.append(Strong<JSCell>(vm, importObject));
vm.promiseTimer->addPendingPromise(vm, promise, WTFMove(dependencies));
// Note: This completion task may or may not get called immediately.
module->module().compileAsync(&vm.wasmContext, instance->memoryMode(), createSharedTask<Wasm::CodeBlock::CallbackType>([promise, instance, module, importObject, resolveKind, creationMode, &vm] (Ref<Wasm::CodeBlock>&& refCodeBlock) mutable {
RefPtr<Wasm::CodeBlock> codeBlock = WTFMove(refCodeBlock);
vm.promiseTimer->scheduleWorkSoon(promise, [promise, instance, module, importObject, resolveKind, creationMode, &vm, codeBlock = WTFMove(codeBlock)] () mutable {
JSGlobalObject* globalObject = instance->globalObject();
resolve(vm, globalObject, promise, instance, module, importObject, codeBlock.releaseNonNull(), resolveKind, creationMode);
});
}));
}
static void compileAndInstantiate(VM& vm, JSGlobalObject* globalObject, JSPromise* promise, const Identifier& moduleKey, JSValue buffer, JSObject* importObject, Resolve resolveKind, Wasm::CreationMode creationMode)
{
auto scope = DECLARE_CATCH_SCOPE(vm);
JSCell* moduleKeyCell = identifierToJSValue(vm, moduleKey).asCell();
Vector<Strong<JSCell>> dependencies;
dependencies.append(Strong<JSCell>(vm, importObject));
dependencies.append(Strong<JSCell>(vm, moduleKeyCell));
vm.promiseTimer->addPendingPromise(vm, promise, WTFMove(dependencies));
Vector<uint8_t> source = createSourceBufferFromValue(vm, globalObject, buffer);
RETURN_IF_EXCEPTION(scope, reject(globalObject, scope, promise));
Wasm::Module::validateAsync(&vm.wasmContext, WTFMove(source), createSharedTask<Wasm::Module::CallbackType>([promise, importObject, moduleKeyCell, globalObject, resolveKind, creationMode, &vm] (Wasm::Module::ValidationResult&& result) mutable {
vm.promiseTimer->scheduleWorkSoon(promise, [promise, importObject, moduleKeyCell, globalObject, result = WTFMove(result), resolveKind, creationMode, &vm] () mutable {
auto scope = DECLARE_CATCH_SCOPE(vm);
JSWebAssemblyModule* module = JSWebAssemblyModule::createStub(vm, globalObject, globalObject->webAssemblyModuleStructure(), WTFMove(result));
if (UNLIKELY(scope.exception()))
return reject(globalObject, scope, promise);
const Identifier moduleKey = JSValue(moduleKeyCell).toPropertyKey(globalObject);
if (UNLIKELY(scope.exception()))
return reject(globalObject, scope, promise);
instantiate(vm, globalObject, promise, module, importObject, moduleKey, resolveKind, creationMode);
});
}));
}
JSValue JSWebAssembly::instantiate(JSGlobalObject* globalObject, JSPromise* promise, const Identifier& moduleKey, JSValue argument)
{
VM& vm = globalObject->vm();
compileAndInstantiate(vm, globalObject, promise, moduleKey, argument, nullptr, Resolve::WithModuleRecord, Wasm::CreationMode::FromModuleLoader);
return promise;
}
static void webAssemblyModuleInstantinateAsyncInternal(JSGlobalObject* globalObject, JSPromise* promise, Vector<uint8_t>&& source, JSObject* importObject)
{
VM& vm = globalObject->vm();
Vector<Strong<JSCell>> dependencies;
dependencies.append(Strong<JSCell>(vm, importObject));
dependencies.append(Strong<JSCell>(vm, globalObject));
vm.promiseTimer->addPendingPromise(vm, promise, WTFMove(dependencies));
Wasm::Module::validateAsync(&vm.wasmContext, WTFMove(source), createSharedTask<Wasm::Module::CallbackType>([promise, importObject, globalObject, &vm] (Wasm::Module::ValidationResult&& result) mutable {
vm.promiseTimer->scheduleWorkSoon(promise, [promise, importObject, globalObject, result = WTFMove(result), &vm] () mutable {
auto scope = DECLARE_CATCH_SCOPE(vm);
JSWebAssemblyModule* module = JSWebAssemblyModule::createStub(vm, globalObject, globalObject->webAssemblyModuleStructure(), WTFMove(result));
if (UNLIKELY(scope.exception()))
return reject(globalObject, scope, promise);
instantiate(vm, globalObject, promise, module, importObject, JSWebAssemblyInstance::createPrivateModuleKey(), Resolve::WithModuleAndInstance, Wasm::CreationMode::FromJS);
CLEAR_AND_RETURN_IF_EXCEPTION(scope, reject(globalObject, scope, promise));
});
}));
}
void JSWebAssembly::webAssemblyModuleInstantinateAsync(JSGlobalObject* globalObject, JSPromise* promise, Vector<uint8_t>&& source, JSObject* importedObject)
{
VM& vm = globalObject->vm();
auto catchScope = DECLARE_CATCH_SCOPE(vm);
webAssemblyModuleInstantinateAsyncInternal(globalObject, promise, WTFMove(source), importedObject);
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, void());
}
static EncodedJSValue JSC_HOST_CALL webAssemblyInstantiateFunc(JSGlobalObject* globalObject, CallFrame* callFrame)
{
VM& vm = globalObject->vm();
auto* promise = JSPromise::create(vm, globalObject->promiseStructure());
{
auto catchScope = DECLARE_CATCH_SCOPE(vm);
JSValue importArgument = callFrame->argument(1);
JSObject* importObject = importArgument.getObject();
if (UNLIKELY(!importArgument.isUndefined() && !importObject)) {
promise->reject(globalObject, createTypeError(globalObject,
"second argument to WebAssembly.instantiate must be undefined or an Object"_s, defaultSourceAppender, runtimeTypeForValue(vm, importArgument)));
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, JSValue::encode(promise));
} else {
JSValue firstArgument = callFrame->argument(0);
if (auto* module = jsDynamicCast<JSWebAssemblyModule*>(vm, firstArgument))
instantiate(vm, globalObject, promise, module, importObject, JSWebAssemblyInstance::createPrivateModuleKey(), Resolve::WithInstance, Wasm::CreationMode::FromJS);
else
compileAndInstantiate(vm, globalObject, promise, JSWebAssemblyInstance::createPrivateModuleKey(), firstArgument, importObject, Resolve::WithModuleAndInstance, Wasm::CreationMode::FromJS);
}
return JSValue::encode(promise);
}
}
static EncodedJSValue JSC_HOST_CALL webAssemblyValidateFunc(JSGlobalObject* globalObject, CallFrame* callFrame)
{
VM& vm = globalObject->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
// FIXME: We might want to throw an OOM exception here if we detect that something will OOM.
// https://bugs.webkit.org/show_bug.cgi?id=166015
Vector<uint8_t> source = createSourceBufferFromValue(vm, globalObject, callFrame->argument(0));
RETURN_IF_EXCEPTION(scope, encodedJSValue());
auto validationResult = Wasm::Module::validateSync(&vm.wasmContext, WTFMove(source));
return JSValue::encode(jsBoolean(validationResult.has_value()));
}
EncodedJSValue JSC_HOST_CALL webAssemblyCompileStreamingInternal(JSGlobalObject* globalObject, CallFrame* callFrame)
{
VM& vm = globalObject->vm();
auto catchScope = DECLARE_CATCH_SCOPE(vm);
auto* promise = JSPromise::create(vm, globalObject->promiseStructure());
Vector<Strong<JSCell>> dependencies;
dependencies.append(Strong<JSCell>(vm, globalObject));
vm.promiseTimer->addPendingPromise(vm, promise, WTFMove(dependencies));
if (globalObject->globalObjectMethodTable()->compileStreaming)
globalObject->globalObjectMethodTable()->compileStreaming(globalObject, promise, callFrame->argument(0));
else {
// CompileStreaming is not supported in jsc, only in browser environment
ASSERT_NOT_REACHED();
}
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, JSValue::encode(promise));
return JSValue::encode(promise);
}
EncodedJSValue JSC_HOST_CALL webAssemblyInstantiateStreamingInternal(JSGlobalObject* globalObject, CallFrame* callFrame)
{
VM& vm = globalObject->vm();
auto* promise = JSPromise::create(vm, globalObject->promiseStructure());
{
auto catchScope = DECLARE_CATCH_SCOPE(vm);
JSValue importArgument = callFrame->argument(1);
JSObject* importObject = importArgument.getObject();
if (UNLIKELY(!importArgument.isUndefined() && !importObject)) {
promise->reject(globalObject, createTypeError(globalObject,
"second argument to WebAssembly.instantiateStreaming must be undefined or an Object"_s, defaultSourceAppender, runtimeTypeForValue(vm, importArgument)));
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, JSValue::encode(promise));
} else {
if (globalObject->globalObjectMethodTable()->instantiateStreaming) {
Vector<Strong<JSCell>> dependencies;
dependencies.append(Strong<JSCell>(vm, globalObject));
dependencies.append(Strong<JSCell>(vm, importObject));
vm.promiseTimer->addPendingPromise(vm, promise, WTFMove(dependencies));
// FIXME: <http://webkit.org/b/184888> if there's an importObject and it contains a Memory, then we can compile the module with the right memory type (fast or not) by looking at the memory's type.
globalObject->globalObjectMethodTable()->instantiateStreaming(globalObject, promise, callFrame->argument(0), importObject);
} else {
// InstantiateStreaming is not supported in jsc, only in browser environment.
ASSERT_NOT_REACHED();
}
}
CLEAR_AND_RETURN_IF_EXCEPTION(catchScope, JSValue::encode(promise));
return JSValue::encode(promise);
}
}
} // namespace JSC
#endif // ENABLE(WEBASSEMBLY)