0765c59007973325d7b5208847c7bbac2d9fd419
[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 "DFGExitProfile.h"
36 #include "DFGGPRInfo.h"
37 #include "DFGValueRecoveryOverride.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 struct BasicBlock;
49 struct Node;
50
51 // This enum describes the types of additional recovery that
52 // may need be performed should a speculation check fail.
53 enum SpeculationRecoveryType {
54     SpeculativeAdd,
55     BooleanSpeculationCheck
56 };
57
58 // === SpeculationRecovery ===
59 //
60 // This class provides additional information that may be associated with a
61 // speculation check - for example 
62 class SpeculationRecovery {
63 public:
64     SpeculationRecovery(SpeculationRecoveryType type, GPRReg dest, GPRReg src)
65         : m_type(type)
66         , m_dest(dest)
67         , m_src(src)
68     {
69     }
70
71     SpeculationRecoveryType type() { return m_type; }
72     GPRReg dest() { return m_dest; }
73     GPRReg src() { return m_src; }
74
75 private:
76     // Indicates the type of additional recovery to be performed.
77     SpeculationRecoveryType m_type;
78     // different recovery types may required different additional information here.
79     GPRReg m_dest;
80     GPRReg m_src;
81 };
82
83 // === OSRExit ===
84 //
85 // This structure describes how to exit the speculative path by
86 // going into baseline code.
87 struct OSRExit {
88     OSRExit(ExitKind, JSValueSource, MethodOfGettingAValueProfile, SpeculativeJIT*, unsigned streamIndex, unsigned recoveryIndex = UINT_MAX);
89     
90     MacroAssemblerCodeRef m_code;
91     
92     JSValueSource m_jsValueSource;
93     MethodOfGettingAValueProfile m_valueProfile;
94
95     unsigned m_patchableCodeOffset;
96     CodeOrigin m_codeOrigin;
97     CodeOrigin m_codeOriginForExitProfile;
98     
99     unsigned m_recoveryIndex;
100     unsigned m_watchpointIndex;
101     
102     ExitKind m_kind;
103     uint32_t m_count;
104     
105     bool considerAddingAsFrequentExitSite(CodeBlock* profiledCodeBlock)
106     {
107         if (!m_count || !exitKindIsCountable(m_kind))
108             return false;
109         return considerAddingAsFrequentExitSiteSlow(profiledCodeBlock);
110     }
111
112     void setPatchableCodeOffset(MacroAssembler::PatchableJump);
113     MacroAssembler::Jump getPatchableCodeOffsetAsJump() const;
114     CodeLocationJump codeLocationForRepatch(CodeBlock*) const;
115     void correctJump(LinkBuffer&);
116     
117     void convertToForward(BasicBlock*, Node*, unsigned nodeIndex, const ValueRecovery&);
118
119     unsigned m_streamIndex;
120     int m_lastSetOperand;
121     
122     RefPtr<ValueRecoveryOverride> m_valueRecoveryOverride;
123
124 private:
125     bool considerAddingAsFrequentExitSiteSlow(CodeBlock* profiledCodeBlock);
126 };
127
128 struct SpeculationFailureDebugInfo {
129     CodeBlock* codeBlock;
130 };
131
132 } } // namespace JSC::DFG
133
134 #endif // ENABLE(DFG_JIT)
135
136 #endif // DFGOSRExit_h
137