[JSC] OSR entry to Wasm OMG
[WebKit.git] / Source / JavaScriptCore / wasm / WasmOMGForOSREntryPlan.h
1 /*
2  * Copyright (C) 2019 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 "WasmContext.h"
31 #include "WasmModule.h"
32 #include "WasmOperations.h"
33 #include "WasmPlan.h"
34
35 namespace JSC {
36
37 class BBQCallee;
38 class CallLinkInfo;
39
40 namespace Wasm {
41
42 class OMGForOSREntryPlan final : public Plan {
43 public:
44     using Base = Plan;
45
46     bool hasWork() const override { return !m_completed; }
47     void work(CompilationEffort) override;
48     bool multiThreaded() const override { return false; }
49
50     // Note: CompletionTask should not hold a reference to the Plan otherwise there will be a reference cycle.
51     OMGForOSREntryPlan(Context*, Ref<Module>&&, Ref<BBQCallee>&&, uint32_t functionIndex, uint32_t loopIndex, MemoryMode, CompletionTask&&);
52
53 private:
54     // For some reason friendship doesn't extend to parent classes...
55     using Base::m_lock;
56
57     bool isComplete() const override { return m_completed; }
58     void complete(const AbstractLocker& locker) override
59     {
60         m_completed = true;
61         runCompletionTasks(locker);
62     }
63
64     Ref<Module> m_module;
65     Ref<CodeBlock> m_codeBlock;
66     Ref<BBQCallee> m_callee;
67     bool m_completed { false };
68     uint32_t m_functionIndex;
69     uint32_t m_loopIndex;
70 };
71
72 } } // namespace JSC::Wasm
73
74 #endif // ENABLE(WEBASSEMBLY)