Unreviewed, rolling out r222791 and r222873.
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmCodeBlock.h
1 /*
2  * Copyright (C) 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 "MacroAssemblerCodeRef.h"
31 #include "WasmTierUpCount.h"
32 #include <wtf/Lock.h>
33 #include <wtf/RefPtr.h>
34 #include <wtf/SharedTask.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36 #include <wtf/text/WTFString.h>
37
38 namespace JSC {
39
40 class VM;
41
42 namespace Wasm {
43
44 class Callee;
45 class BBQPlan;
46 class OMGPlan;
47 struct ModuleInformation;
48 struct UnlinkedWasmToWasmCall;
49 typedef void** WasmEntrypointLoadLocation;
50 enum class MemoryMode : uint8_t;
51     
52 class CodeBlock : public ThreadSafeRefCounted<CodeBlock> {
53 public:
54     typedef void CallbackType(VM&, Ref<CodeBlock>&&);
55     using AsyncCompilationCallback = RefPtr<WTF::SharedTask<CallbackType>>;
56     static Ref<CodeBlock> create(MemoryMode mode, ModuleInformation& moduleInformation)
57     {
58         return adoptRef(*new CodeBlock(mode, moduleInformation));
59     }
60
61     void waitUntilFinished();
62     void compileAsync(VM&, AsyncCompilationCallback&&);
63
64     bool compilationFinished()
65     {
66         auto locker = holdLock(m_lock);
67         return !m_plan;
68     }
69     bool runnable() { return compilationFinished() && !m_errorMessage; }
70
71     // Note, we do this copy to ensure it's thread safe to have this
72     // called from multiple threads simultaneously.
73     String errorMessage()
74     {
75         ASSERT(!runnable());
76         CString cString = m_errorMessage.ascii();
77         return String(cString.data());
78     }
79
80     unsigned functionImportCount() const { return m_wasmToWasmExitStubs.size(); }
81
82     Callee& jsEntrypointCalleeFromFunctionIndexSpace(unsigned functionIndexSpace)
83     {
84         RELEASE_ASSERT(functionIndexSpace >= functionImportCount());
85         unsigned calleeIndex = functionIndexSpace - functionImportCount();
86
87         auto callee = m_jsCallees.get(calleeIndex);
88         RELEASE_ASSERT(callee);
89         return *callee;
90     }
91     Callee& wasmEntrypointCalleeFromFunctionIndexSpace(unsigned functionIndexSpace)
92     {
93         RELEASE_ASSERT(functionIndexSpace >= functionImportCount());
94         unsigned calleeIndex = functionIndexSpace - functionImportCount();
95         if (m_optimizedCallees[calleeIndex])
96             return *m_optimizedCallees[calleeIndex].get();
97         return *m_callees[calleeIndex].get();
98     }
99
100     WasmEntrypointLoadLocation wasmEntrypointLoadLocationFromFunctionIndexSpace(unsigned functionIndexSpace)
101     {
102         RELEASE_ASSERT(functionIndexSpace >= functionImportCount());
103         unsigned calleeIndex = functionIndexSpace - functionImportCount();
104         return &m_wasmIndirectCallEntryPoints[calleeIndex];
105     }
106
107     TierUpCount& tierUpCount(uint32_t functionIndex)
108     {
109         return m_tierUpCounts[functionIndex];
110     }
111
112     bool isSafeToRun(MemoryMode);
113
114     MemoryMode mode() const { return m_mode; }
115
116     ~CodeBlock();
117 private:
118     friend class OMGPlan;
119
120     CodeBlock(MemoryMode, ModuleInformation&);
121     unsigned m_calleeCount;
122     MemoryMode m_mode;
123     Vector<RefPtr<Callee>> m_callees;
124     Vector<RefPtr<Callee>> m_optimizedCallees;
125     HashMap<uint32_t, RefPtr<Callee>, typename DefaultHash<uint32_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<uint32_t>> m_jsCallees;
126     Vector<void*> m_wasmIndirectCallEntryPoints;
127     Vector<TierUpCount> m_tierUpCounts;
128     Vector<Vector<UnlinkedWasmToWasmCall>> m_wasmToWasmCallsites;
129     Vector<MacroAssemblerCodeRef> m_wasmToWasmExitStubs;
130     RefPtr<BBQPlan> m_plan;
131     String m_errorMessage;
132     Lock m_lock;
133 };
134
135 } } // namespace JSC::Wasm
136
137 #endif // ENABLE(WEBASSEMBLY)