WebAssembly: ModuleInformation should be a ref counted thing that can be shared acros...
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmPlan.h
1 /*
2  * Copyright (C) 2016-2017 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 "CompilationResult.h"
31 #include "VM.h"
32 #include "WasmB3IRGenerator.h"
33 #include "WasmModuleInformation.h"
34 #include <wtf/Bag.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36 #include <wtf/Vector.h>
37
38 namespace JSC {
39
40 class CallLinkInfo;
41 class JSGlobalObject;
42 class JSPromiseDeferred;
43
44 namespace Wasm {
45
46 class Plan : public ThreadSafeRefCounted<Plan> {
47 public:
48     static void dontFinalize(Plan&) { }
49     typedef std::function<void(Plan&)> CompletionTask;
50     enum AsyncWork : uint8_t { FullCompile, Validation };
51     // Note: CompletionTask should not hold a reference to the Plan otherwise there will be a reference cycle.
52     Plan(VM&, Ref<ModuleInformation>, AsyncWork, CompletionTask&&);
53     JS_EXPORT_PRIVATE Plan(VM&, Vector<uint8_t>&&, AsyncWork, CompletionTask&&);
54     // Note: This constructor should only be used if you are not actually building a module e.g. validation/function tests
55     // FIXME: When we get rid of function tests we should remove AsyncWork from this constructor.
56     JS_EXPORT_PRIVATE Plan(VM&, const uint8_t*, size_t, AsyncWork, CompletionTask&&);
57     JS_EXPORT_PRIVATE ~Plan();
58
59     bool parseAndValidateModule();
60
61     JS_EXPORT_PRIVATE void prepare();
62     enum CompilationEffort { All, Partial };
63     void compileFunctions(CompilationEffort = All);
64
65     template<typename Functor>
66     void initializeCallees(const Functor&);
67
68     Vector<Export>& exports() const
69     {
70         RELEASE_ASSERT(!failed() && !hasWork());
71         return m_moduleInformation->exports;
72     }
73
74     size_t internalFunctionCount() const
75     {
76         RELEASE_ASSERT(!failed() && !hasWork());
77         return m_moduleInformation->internalFunctionCount();
78     }
79
80     Ref<ModuleInformation>&& takeModuleInformation()
81     {
82         RELEASE_ASSERT(!failed() && !hasWork());
83         return WTFMove(m_moduleInformation);
84     }
85
86     Bag<CallLinkInfo>&& takeCallLinkInfos()
87     {
88         RELEASE_ASSERT(!failed() && !hasWork());
89         return WTFMove(m_callLinkInfos);
90     }
91
92     Vector<WasmExitStubs>&& takeWasmExitStubs()
93     {
94         RELEASE_ASSERT(!failed() && !hasWork());
95         return WTFMove(m_wasmExitStubs);
96     }
97
98     void setModeAndPromise(MemoryMode mode, JSPromiseDeferred* promise)
99     {
100         m_mode = mode;
101         m_pendingPromise = promise;
102     }
103     MemoryMode mode() const { return m_mode; }
104     JSPromiseDeferred* pendingPromise() { return m_pendingPromise; }
105     VM& vm() const { return m_vm; }
106
107     enum class State : uint8_t {
108         Initial,
109         Validated,
110         Prepared,
111         Compiled,
112         Completed // We should only move to Completed if we are holding the lock.
113     };
114
115     const String& errorMessage() const { return m_errorMessage; }
116
117     bool WARN_UNUSED_RETURN failed() const { return !errorMessage().isNull(); }
118     bool hasWork() const { return m_state < State::Compiled; }
119     bool hasBeenPrepared() const { return m_state >= State::Prepared; }
120
121     void waitForCompletion();
122     void cancel();
123
124 private:
125     class ThreadCountHolder;
126     friend class ThreadCountHolder;
127
128     void complete(const AbstractLocker&);
129
130     void moveToState(State);
131     void fail(const AbstractLocker&, String&& errorMessage);
132
133     const char* stateString(State);
134
135     Ref<ModuleInformation> m_moduleInformation;
136     Bag<CallLinkInfo> m_callLinkInfos;
137     Vector<WasmExitStubs> m_wasmExitStubs;
138     Vector<std::unique_ptr<WasmInternalFunction>> m_wasmInternalFunctions;
139     Vector<CompilationContext> m_compilationContexts;
140
141     VM& m_vm;
142     JSPromiseDeferred* m_pendingPromise { nullptr };
143     CompletionTask m_completionTask;
144
145     Vector<Vector<UnlinkedWasmToWasmCall>> m_unlinkedWasmToWasmCalls;
146     const uint8_t* m_source;
147     const size_t m_sourceLength;
148     String m_errorMessage;
149     MemoryMode m_mode { MemoryMode::BoundsChecking };
150     Lock m_lock;
151     Condition m_completed;
152     State m_state;
153     const AsyncWork m_asyncWork;
154     uint8_t m_numberOfActiveThreads { 0 };
155     uint32_t m_currentIndex { 0 };
156 };
157
158
159 } } // namespace JSC::Wasm
160
161 #endif // ENABLE(WEBASSEMBLY)