fe0987737ed208f329f020242ba28570e8467b39
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGOSRExit.h
1 /*
2  * Copyright (C) 2011 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 DFGOSRExit_h
27 #define DFGOSRExit_h
28
29 #include <wtf/Platform.h>
30
31 #if ENABLE(DFG_JIT)
32
33 #include "CodeOrigin.h"
34 #include "DFGCommon.h"
35 #include "DFGCorrectableJumpPoint.h"
36 #include "DFGExitProfile.h"
37 #include "DFGGPRInfo.h"
38 #include "DFGOperands.h"
39 #include "MacroAssembler.h"
40 #include "ValueProfile.h"
41 #include "ValueRecovery.h"
42 #include <wtf/Vector.h>
43
44 namespace JSC { namespace DFG {
45
46 class SpeculativeJIT;
47
48 // This enum describes the types of additional recovery that
49 // may need be performed should a speculation check fail.
50 enum SpeculationRecoveryType {
51     SpeculativeAdd,
52     BooleanSpeculationCheck
53 };
54
55 // === SpeculationRecovery ===
56 //
57 // This class provides additional information that may be associated with a
58 // speculation check - for example 
59 class SpeculationRecovery {
60 public:
61     SpeculationRecovery(SpeculationRecoveryType type, GPRReg dest, GPRReg src)
62         : m_type(type)
63         , m_dest(dest)
64         , m_src(src)
65     {
66     }
67
68     SpeculationRecoveryType type() { return m_type; }
69     GPRReg dest() { return m_dest; }
70     GPRReg src() { return m_src; }
71
72 private:
73     // Indicates the type of additional recovery to be performed.
74     SpeculationRecoveryType m_type;
75     // different recovery types may required different additional information here.
76     GPRReg m_dest;
77     GPRReg m_src;
78 };
79
80 // === OSRExit ===
81 //
82 // This structure describes how to exit the speculative path by
83 // going into baseline code.
84 struct OSRExit {
85     OSRExit(ExitKind, JSValueSource, ValueProfile*, MacroAssembler::Jump, SpeculativeJIT*, unsigned recoveryIndex = 0);
86     
87     MacroAssemblerCodeRef m_code;
88     
89     JSValueSource m_jsValueSource;
90     ValueProfile* m_valueProfile;
91     
92     CorrectableJumpPoint m_check;
93     NodeIndex m_nodeIndex;
94     CodeOrigin m_codeOrigin;
95     
96     unsigned m_recoveryIndex;
97     
98     ExitKind m_kind;
99     uint32_t m_count;
100     
101     // Convenient way of iterating over ValueRecoveries while being
102     // generic over argument versus variable.
103     int numberOfRecoveries() const { return m_arguments.size() + m_variables.size(); }
104     const ValueRecovery& valueRecovery(int index) const
105     {
106         if (index < (int)m_arguments.size())
107             return m_arguments[index];
108         return m_variables[index - m_arguments.size()];
109     }
110     bool isArgument(int index) const { return index < (int)m_arguments.size(); }
111     bool isVariable(int index) const { return !isArgument(index); }
112     int argumentForIndex(int index) const
113     {
114         return index;
115     }
116     int variableForIndex(int index) const
117     {
118         return index - m_arguments.size();
119     }
120     int operandForIndex(int index) const
121     {
122         if (index < (int)m_arguments.size())
123             return operandToArgument(index);
124         return index - m_arguments.size();
125     }
126     
127     bool considerAddingAsFrequentExitSite(CodeBlock* dfgCodeBlock, CodeBlock* profiledCodeBlock)
128     {
129         if (!m_count || !exitKindIsCountable(m_kind))
130             return false;
131         return considerAddingAsFrequentExitSiteSlow(dfgCodeBlock, profiledCodeBlock);
132     }
133     
134 #ifndef NDEBUG
135     void dump(FILE* out) const;
136 #endif
137     
138     Vector<ValueRecovery, 0> m_arguments;
139     Vector<ValueRecovery, 0> m_variables;
140     int m_lastSetOperand;
141
142 private:
143     bool considerAddingAsFrequentExitSiteSlow(CodeBlock* dfgCodeBlock, CodeBlock* profiledCodeBlock);
144 };
145
146 #if DFG_ENABLE(VERBOSE_SPECULATION_FAILURE)
147 struct SpeculationFailureDebugInfo {
148     CodeBlock* codeBlock;
149     NodeIndex nodeIndex;
150 };
151 #endif
152
153 } } // namespace JSC::DFG
154
155 #endif // ENABLE(DFG_JIT)
156
157 #endif // DFGOSRExit_h
158