DFG::Plan shouldn't read from its VM once it's been cancelled
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGPlan.h
1 /*
2  * Copyright (C) 2013-2016 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 #ifndef DFGPlan_h
27 #define DFGPlan_h
28
29 #include "CompilationResult.h"
30 #include "DFGCompilationKey.h"
31 #include "DFGCompilationMode.h"
32 #include "DFGDesiredIdentifiers.h"
33 #include "DFGDesiredTransitions.h"
34 #include "DFGDesiredWatchpoints.h"
35 #include "DFGDesiredWeakReferences.h"
36 #include "DFGFinalizer.h"
37 #include "DeferredCompilationCallback.h"
38 #include "Operands.h"
39 #include "ProfilerCompilation.h"
40 #include <wtf/HashMap.h>
41 #include <wtf/ThreadSafeRefCounted.h>
42 #include <wtf/text/CString.h>
43
44 namespace JSC {
45
46 class CodeBlock;
47 class SlotVisitor;
48
49 namespace DFG {
50
51 class LongLivedState;
52 class ThreadData;
53
54 #if ENABLE(DFG_JIT)
55
56 struct Plan : public ThreadSafeRefCounted<Plan> {
57     Plan(
58         CodeBlock* codeBlockToCompile, CodeBlock* profiledDFGCodeBlock,
59         CompilationMode, unsigned osrEntryBytecodeIndex,
60         const Operands<JSValue>& mustHandleValues);
61     ~Plan();
62
63     void compileInThread(LongLivedState&, ThreadData*);
64     
65     CompilationResult finalizeWithoutNotifyingCallback();
66     void finalizeAndNotifyCallback();
67     
68     void notifyCompiling();
69     void notifyCompiled();
70     void notifyReady();
71     
72     CompilationKey key();
73     
74     void rememberCodeBlocks();
75     void checkLivenessAndVisitChildren(SlotVisitor&);
76     bool isKnownToBeLiveDuringGC();
77     void cancel();
78
79     bool canTierUpAndOSREnter() const { return !tierUpAndOSREnterBytecodes.isEmpty(); }
80     
81     // Warning: pretty much all of the pointer fields in this object get nulled by cancel(). So, if
82     // you're writing code that is callable on the cancel path, be sure to null check everything!
83     
84     VM* vm;
85
86     // These can be raw pointers because we visit them during every GC in checkLivenessAndVisitChildren.
87     CodeBlock* codeBlock;
88     CodeBlock* profiledDFGCodeBlock;
89
90     CompilationMode mode;
91     const unsigned osrEntryBytecodeIndex;
92     Operands<JSValue> mustHandleValues;
93     
94     ThreadData* threadData;
95
96     RefPtr<Profiler::Compilation> compilation;
97
98     std::unique_ptr<Finalizer> finalizer;
99     
100     RefPtr<InlineCallFrameSet> inlineCallFrames;
101     DesiredWatchpoints watchpoints;
102     DesiredIdentifiers identifiers;
103     DesiredWeakReferences weakReferences;
104     DesiredTransitions transitions;
105     
106     bool willTryToTierUp { false };
107
108     HashMap<unsigned, Vector<unsigned>> tierUpInLoopHierarchy;
109     Vector<unsigned> tierUpAndOSREnterBytecodes;
110
111     enum Stage { Preparing, Compiling, Compiled, Ready, Cancelled };
112     Stage stage;
113
114     RefPtr<DeferredCompilationCallback> callback;
115
116 private:
117     bool computeCompileTimes() const;
118     bool reportCompileTimes() const;
119     
120     enum CompilationPath { FailPath, DFGPath, FTLPath, CancelPath };
121     CompilationPath compileInThreadImpl(LongLivedState&);
122     
123     bool isStillValid();
124     void reallyAdd(CommonData*);
125
126     double m_timeBeforeFTL;
127 };
128
129 #endif // ENABLE(DFG_JIT)
130
131 } } // namespace JSC::DFG
132
133 #endif // DFGPlan_h
134