fourthTier: Landing the initial FTL logic in a single commit to avoid spurious
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGOSRExit.h
1 /*
2  * Copyright (C) 2011, 2013 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 "DFGOSRExitBase.h"
38 #include "DFGValueRecoveryOverride.h"
39 #include "MacroAssembler.h"
40 #include "MethodOfGettingAValueProfile.h"
41 #include "Operands.h"
42 #include "ValueProfile.h"
43 #include "ValueRecovery.h"
44 #include <wtf/Vector.h>
45
46 namespace JSC { namespace DFG {
47
48 class SpeculativeJIT;
49 struct BasicBlock;
50 struct Node;
51
52 // This enum describes the types of additional recovery that
53 // may need be performed should a speculation check fail.
54 enum SpeculationRecoveryType {
55     SpeculativeAdd,
56     BooleanSpeculationCheck
57 };
58
59 // === SpeculationRecovery ===
60 //
61 // This class provides additional information that may be associated with a
62 // speculation check - for example 
63 class SpeculationRecovery {
64 public:
65     SpeculationRecovery(SpeculationRecoveryType type, GPRReg dest, GPRReg src)
66         : m_type(type)
67         , m_dest(dest)
68         , m_src(src)
69     {
70     }
71
72     SpeculationRecoveryType type() { return m_type; }
73     GPRReg dest() { return m_dest; }
74     GPRReg src() { return m_src; }
75
76 private:
77     // Indicates the type of additional recovery to be performed.
78     SpeculationRecoveryType m_type;
79     // different recovery types may required different additional information here.
80     GPRReg m_dest;
81     GPRReg m_src;
82 };
83
84 // === OSRExit ===
85 //
86 // This structure describes how to exit the speculative path by
87 // going into baseline code.
88 struct OSRExit : public OSRExitBase {
89     OSRExit(ExitKind, JSValueSource, MethodOfGettingAValueProfile, SpeculativeJIT*, unsigned streamIndex, unsigned recoveryIndex = UINT_MAX);
90     
91     MacroAssemblerCodeRef m_code;
92     
93     JSValueSource m_jsValueSource;
94     MethodOfGettingAValueProfile m_valueProfile;
95
96     unsigned m_patchableCodeOffset;
97     
98     unsigned m_recoveryIndex;
99     unsigned m_watchpointIndex;
100     
101     void setPatchableCodeOffset(MacroAssembler::PatchableJump);
102     MacroAssembler::Jump getPatchableCodeOffsetAsJump() const;
103     CodeLocationJump codeLocationForRepatch(CodeBlock*) const;
104     void correctJump(LinkBuffer&);
105     
106     void convertToForward(BasicBlock*, Node*, unsigned nodeIndex, const ValueRecovery&);
107
108     unsigned m_streamIndex;
109     int m_lastSetOperand;
110     
111     RefPtr<ValueRecoveryOverride> m_valueRecoveryOverride;
112 };
113
114 struct SpeculationFailureDebugInfo {
115     CodeBlock* codeBlock;
116 };
117
118 } } // namespace JSC::DFG
119
120 #endif // ENABLE(DFG_JIT)
121
122 #endif // DFGOSRExit_h
123