b810189de0d3f1140b51249a9ad7013d086ea916
[WebKit-https.git] / Source / JavaScriptCore / wasm / js / WebAssemblyFunction.cpp
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "WebAssemblyFunction.h"
28
29 #if ENABLE(WEBASSEMBLY)
30
31 #include "B3Compilation.h"
32 #include "JSCInlines.h"
33 #include "JSFunctionInlines.h"
34 #include "JSObject.h"
35 #include "JSWebAssemblyCallee.h"
36 #include "JSWebAssemblyInstance.h"
37 #include "JSWebAssemblyMemory.h"
38 #include "JSWebAssemblyRuntimeError.h"
39 #include "LLIntThunks.h"
40 #include "ProtoCallFrame.h"
41 #include "VM.h"
42 #include "WasmFormat.h"
43 #include "WasmMemory.h"
44
45 namespace JSC {
46
47 const ClassInfo WebAssemblyFunction::s_info = { "WebAssemblyFunction", &Base::s_info, nullptr, CREATE_METHOD_TABLE(WebAssemblyFunction) };
48
49 static EncodedJSValue JSC_HOST_CALL callWebAssemblyFunction(ExecState* exec)
50 {
51     VM& vm = exec->vm();
52     auto scope = DECLARE_THROW_SCOPE(vm);
53     WebAssemblyFunction* wasmFunction = jsDynamicCast<WebAssemblyFunction*>(exec->jsCallee());
54     if (!wasmFunction)
55         return JSValue::encode(throwException(exec, scope, createTypeError(exec, "expected a WebAssembly function", defaultSourceAppender, runtimeTypeForValue(exec->jsCallee()))));
56     Wasm::SignatureIndex signatureIndex = wasmFunction->signatureIndex();
57     const Wasm::Signature* signature = Wasm::SignatureInformation::get(&vm, signatureIndex);
58
59     // FIXME is this the right behavior? https://bugs.webkit.org/show_bug.cgi?id=164876
60     if (exec->argumentCount() != signature->argumentCount())
61         return JSValue::encode(throwException(exec, scope, createNotEnoughArgumentsError(exec, defaultSourceAppender)));
62
63     {
64         // Check if we have a disallowed I64 use.
65
66         for (unsigned argIndex = 0; argIndex < signature->argumentCount(); ++argIndex) {
67             if (signature->argument(argIndex) == Wasm::I64) {
68                 JSWebAssemblyRuntimeError* error = JSWebAssemblyRuntimeError::create(exec, vm, exec->lexicalGlobalObject()->WebAssemblyRuntimeErrorStructure(),
69                     "WebAssembly function with an i64 argument can't be called from JavaScript");
70                 return JSValue::encode(throwException(exec, scope, error));
71             }
72         }
73
74         if (signature->returnType() == Wasm::I64) {
75             JSWebAssemblyRuntimeError* error = JSWebAssemblyRuntimeError::create(exec, vm, exec->lexicalGlobalObject()->WebAssemblyRuntimeErrorStructure(),
76                 "WebAssembly function that returns i64 can't be called from JavaScript");
77             return JSValue::encode(throwException(exec, scope, error));
78         }
79     }
80
81     // FIXME is this boxing correct? https://bugs.webkit.org/show_bug.cgi?id=164876
82     Vector<JSValue> boxedArgs;
83     for (unsigned argIndex = 0; argIndex < signature->argumentCount(); ++argIndex) {
84         JSValue arg = exec->uncheckedArgument(argIndex);
85         switch (signature->argument(argIndex)) {
86         case Wasm::I32:
87             arg = JSValue::decode(arg.toInt32(exec));
88             break;
89         case Wasm::F32:
90             arg = JSValue::decode(bitwise_cast<uint32_t>(arg.toFloat(exec)));
91             break;
92         case Wasm::F64:
93             arg = JSValue::decode(bitwise_cast<uint64_t>(arg.toNumber(exec)));
94             break;
95         case Wasm::Void:
96         case Wasm::I64:
97         case Wasm::Func:
98         case Wasm::Anyfunc:
99             RELEASE_ASSERT_NOT_REACHED();
100         }
101         RETURN_IF_EXCEPTION(scope, encodedJSValue());
102         boxedArgs.append(arg);
103     }
104
105     JSValue firstArgument = JSValue();
106     int argCount = 1;
107     JSValue* remainingArgs = nullptr;
108     if (boxedArgs.size()) {
109         remainingArgs = boxedArgs.data();
110         firstArgument = *remainingArgs;
111         remainingArgs++;
112         argCount = boxedArgs.size();
113     }
114
115     // Note: we specifically use the WebAssemblyFunction as the callee to begin with in the ProtoCallFrame.
116     // The reason for this is that calling into the llint may stack overflow, and the stack overflow
117     // handler might read the global object from the callee. The JSWebAssemblyCallee doesn't have a
118     // global object, but the WebAssemblyFunction does.
119     ProtoCallFrame protoCallFrame;
120     protoCallFrame.init(nullptr, wasmFunction, firstArgument, argCount, remainingArgs);
121
122     // FIXME Do away with this entire function, and only use the entrypoint generated by B3. https://bugs.webkit.org/show_bug.cgi?id=166486
123     JSWebAssemblyInstance* prevJSWebAssemblyInstance = vm.topJSWebAssemblyInstance;
124     vm.topJSWebAssemblyInstance = wasmFunction->instance();
125     ASSERT(wasmFunction->instance());
126     EncodedJSValue rawResult = vmEntryToWasm(wasmFunction->jsEntrypoint(), &vm, &protoCallFrame);
127     vm.topJSWebAssemblyInstance = prevJSWebAssemblyInstance;
128     RETURN_IF_EXCEPTION(scope, { });
129
130     // FIXME is this correct? https://bugs.webkit.org/show_bug.cgi?id=164876
131     switch (signature->returnType()) {
132     case Wasm::Void:
133         return JSValue::encode(jsUndefined());
134     case Wasm::I32:
135         return JSValue::encode(jsNumber(static_cast<int32_t>(rawResult)));
136     case Wasm::F32:
137         return JSValue::encode(jsNumber(purifyNaN(static_cast<double>(bitwise_cast<float>(static_cast<int32_t>(rawResult))))));
138     case Wasm::F64:
139         return JSValue::encode(jsNumber(purifyNaN(bitwise_cast<double>(rawResult))));
140     case Wasm::I64:
141     case Wasm::Func:
142     case Wasm::Anyfunc:
143         RELEASE_ASSERT_NOT_REACHED();
144     }
145
146     return EncodedJSValue();
147 }
148
149 WebAssemblyFunction* WebAssemblyFunction::create(VM& vm, JSGlobalObject* globalObject, unsigned length, const String& name, JSWebAssemblyInstance* instance, JSWebAssemblyCallee* jsEntrypoint, JSWebAssemblyCallee* wasmEntrypoint, Wasm::SignatureIndex signatureIndex)
150 {
151     NativeExecutable* executable = vm.getHostFunction(callWebAssemblyFunction, NoIntrinsic, callHostFunctionAsConstructor, nullptr, name);
152     Structure* structure = globalObject->webAssemblyFunctionStructure();
153     WebAssemblyFunction* function = new (NotNull, allocateCell<WebAssemblyFunction>(vm.heap)) WebAssemblyFunction(vm, globalObject, structure, wasmEntrypoint, signatureIndex);
154     function->finishCreation(vm, executable, length, name, instance, jsEntrypoint, wasmEntrypoint);
155     return function;
156 }
157
158 Structure* WebAssemblyFunction::createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
159 {
160     ASSERT(globalObject);
161     return Structure::create(vm, globalObject, prototype, TypeInfo(WebAssemblyFunctionType, StructureFlags), info());
162 }
163
164 WebAssemblyFunction::WebAssemblyFunction(VM& vm, JSGlobalObject* globalObject, Structure* structure, JSWebAssemblyCallee* wasmEntrypoint, Wasm::SignatureIndex signatureIndex)
165     : Base(vm, globalObject, structure)
166     , m_wasmEntryPointCode(wasmEntrypoint->entrypoint())
167     , m_signatureIndex(signatureIndex)
168 { }
169
170 void WebAssemblyFunction::visitChildren(JSCell* cell, SlotVisitor& visitor)
171 {
172     WebAssemblyFunction* thisObject = jsCast<WebAssemblyFunction*>(cell);
173     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
174     Base::visitChildren(thisObject, visitor);
175     visitor.append(thisObject->m_instance);
176     visitor.append(thisObject->m_jsEntrypoint);
177     visitor.append(thisObject->m_wasmEntrypoint);
178 }
179
180 void WebAssemblyFunction::finishCreation(VM& vm, NativeExecutable* executable, unsigned length, const String& name, JSWebAssemblyInstance* instance, JSWebAssemblyCallee* jsEntrypoint, JSWebAssemblyCallee* wasmEntrypoint)
181 {
182     Base::finishCreation(vm, executable, length, name);
183     ASSERT(inherits(info()));
184     m_instance.set(vm, this, instance);
185     ASSERT(jsEntrypoint != wasmEntrypoint);
186     m_jsEntrypoint.set(vm, this, jsEntrypoint);
187     m_wasmEntrypoint.set(vm, this, wasmEntrypoint);
188     ASSERT(m_wasmEntrypoint->entrypoint() == m_wasmEntryPointCode);
189 }
190
191 } // namespace JSC
192
193 #endif // ENABLE(WEBASSEMBLY)