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