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