3f971f2c0ef506cc17f34e745926cb198e709b3e
[WebKit-https.git] / Source / JavaScriptCore / wasm / js / WebAssemblyFunction.h
1 /*
2  * Copyright (C) 2016-2018 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 #pragma once
27
28 #if ENABLE(WEBASSEMBLY)
29
30 #include "MacroAssemblerCodeRef.h"
31 #include "WasmCallee.h"
32 #include "WebAssemblyFunctionBase.h"
33 #include <wtf/Noncopyable.h>
34
35 namespace JSC {
36
37 class JSGlobalObject;
38 struct ProtoCallFrame;
39 class WebAssemblyInstance;
40 using Wasm::WasmToWasmImportableFunction;
41
42 namespace B3 {
43 class Compilation;
44 }
45
46 class WebAssemblyFunction final : public WebAssemblyFunctionBase {
47 public:
48     using Base = WebAssemblyFunctionBase;
49
50     const static unsigned StructureFlags = Base::StructureFlags;
51
52     template<typename CellType, SubspaceAccess mode>
53     static IsoSubspace* subspaceFor(VM& vm)
54     {
55         return vm.webAssemblyFunctionSpace<mode>();
56     }
57
58     DECLARE_EXPORT_INFO;
59
60     JS_EXPORT_PRIVATE static WebAssemblyFunction* create(VM&, JSGlobalObject*, Structure*, unsigned, const String&, JSWebAssemblyInstance*, Wasm::Callee& jsEntrypoint, WasmToWasmImportableFunction::LoadLocation, Wasm::SignatureIndex);
61     static Structure* createStructure(VM&, JSGlobalObject*, JSValue);
62
63     Wasm::SignatureIndex signatureIndex() const { return m_importableFunction.signatureIndex; }
64     WasmToWasmImportableFunction::LoadLocation entrypointLoadLocation() const { return m_importableFunction.entrypointLoadLocation; }
65     WasmToWasmImportableFunction importableFunction() const { return m_importableFunction; }
66
67     MacroAssemblerCodePtr<WasmEntryPtrTag> jsEntrypoint(ArityCheckMode arity)
68     {
69         if (arity == ArityCheckNotRequired)
70             return m_jsEntrypoint;
71         ASSERT(arity == MustCheckArity);
72         return m_jsEntrypoint;
73     }
74
75     static ptrdiff_t offsetOfEntrypointLoadLocation() { return OBJECT_OFFSETOF(WebAssemblyFunction, m_importableFunction) + WasmToWasmImportableFunction::offsetOfEntrypointLoadLocation(); }
76
77 private:
78     WebAssemblyFunction(VM&, JSGlobalObject*, Structure*, Wasm::Callee& jsEntrypoint, WasmToWasmImportableFunction::LoadLocation entrypointLoadLocation, Wasm::SignatureIndex);
79
80     // It's safe to just hold the raw WasmToWasmImportableFunction/jsEntrypoint because we have a reference
81     // to our Instance, which points to the Module that exported us, which
82     // ensures that the actual Signature/code doesn't get deallocated.
83     MacroAssemblerCodePtr<WasmEntryPtrTag> m_jsEntrypoint;
84     WasmToWasmImportableFunction m_importableFunction;
85 };
86
87 } // namespace JSC
88
89 #endif // ENABLE(WEBASSEMBLY)