Teach Call ICs how to call Wasm
[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 "JSToWasmICCallee.h"
31 #include "MacroAssemblerCodeRef.h"
32 #include "WasmCallee.h"
33 #include "WebAssemblyFunctionBase.h"
34 #include <wtf/Noncopyable.h>
35
36 namespace JSC {
37
38 class JSGlobalObject;
39 struct ProtoCallFrame;
40 class WebAssemblyInstance;
41 using Wasm::WasmToWasmImportableFunction;
42
43 namespace B3 {
44 class Compilation;
45 }
46
47 class WebAssemblyFunction final : public WebAssemblyFunctionBase {
48 public:
49     using Base = WebAssemblyFunctionBase;
50
51     const static unsigned StructureFlags = Base::StructureFlags;
52
53     static const bool needsDestruction = true;
54     static void destroy(JSCell*);
55
56     template<typename CellType, SubspaceAccess mode>
57     static IsoSubspace* subspaceFor(VM& vm)
58     {
59         return vm.webAssemblyFunctionSpace<mode>();
60     }
61
62     DECLARE_EXPORT_INFO;
63
64     JS_EXPORT_PRIVATE static WebAssemblyFunction* create(VM&, JSGlobalObject*, Structure*, unsigned, const String&, JSWebAssemblyInstance*, Wasm::Callee& jsEntrypoint, WasmToWasmImportableFunction::LoadLocation, Wasm::SignatureIndex);
65     static Structure* createStructure(VM&, JSGlobalObject*, JSValue);
66
67     Wasm::SignatureIndex signatureIndex() const { return m_importableFunction.signatureIndex; }
68     WasmToWasmImportableFunction::LoadLocation entrypointLoadLocation() const { return m_importableFunction.entrypointLoadLocation; }
69     WasmToWasmImportableFunction importableFunction() const { return m_importableFunction; }
70
71     MacroAssemblerCodePtr<WasmEntryPtrTag> jsEntrypoint(ArityCheckMode arity)
72     {
73         if (arity == ArityCheckNotRequired)
74             return m_jsEntrypoint;
75         ASSERT(arity == MustCheckArity);
76         return m_jsEntrypoint;
77     }
78
79     static ptrdiff_t offsetOfEntrypointLoadLocation() { return OBJECT_OFFSETOF(WebAssemblyFunction, m_importableFunction) + WasmToWasmImportableFunction::offsetOfEntrypointLoadLocation(); }
80
81     MacroAssemblerCodePtr<JSEntryPtrTag> jsCallEntrypoint()
82     {
83         if (m_jsCallEntrypoint)
84             return m_jsCallEntrypoint.code();
85         return jsCallEntrypointSlow();
86     }
87
88     RegisterAtOffsetList usedCalleeSaveRegisters() const;
89     Wasm::Instance* previousInstance(CallFrame*);
90
91 private:
92     static void visitChildren(JSCell*, SlotVisitor&);
93     WebAssemblyFunction(VM&, JSGlobalObject*, Structure*, Wasm::Callee& jsEntrypoint, WasmToWasmImportableFunction::LoadLocation entrypointLoadLocation, Wasm::SignatureIndex);
94
95     MacroAssemblerCodePtr<JSEntryPtrTag> jsCallEntrypointSlow();
96     ptrdiff_t previousInstanceOffset() const;
97     bool useTagRegisters() const;
98
99     RegisterSet calleeSaves() const;
100
101     // It's safe to just hold the raw WasmToWasmImportableFunction/jsEntrypoint because we have a reference
102     // to our Instance, which points to the Module that exported us, which
103     // ensures that the actual Signature/code doesn't get deallocated.
104     MacroAssemblerCodePtr<WasmEntryPtrTag> m_jsEntrypoint;
105     WasmToWasmImportableFunction m_importableFunction;
106     WriteBarrier<JSToWasmICCallee> m_jsToWasmICCallee;
107     // Used for JS calling into Wasm.
108     MacroAssemblerCodeRef<JSEntryPtrTag> m_jsCallEntrypoint;
109 };
110
111 } // namespace JSC
112
113 #endif // ENABLE(WEBASSEMBLY)