d355876efd833f84d1abf6136974fb355c9715ff
[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 #pragma once
27
28 #if ENABLE(DFG_JIT)
29
30 #include "CodeOrigin.h"
31 #include "DFGCommon.h"
32 #include "DFGExitProfile.h"
33 #include "DFGOSRExitBase.h"
34 #include "GPRInfo.h"
35 #include "MacroAssembler.h"
36 #include "MethodOfGettingAValueProfile.h"
37 #include "Operands.h"
38 #include "ValueProfile.h"
39 #include "ValueRecovery.h"
40
41 namespace JSC { namespace DFG {
42
43 class SpeculativeJIT;
44 struct BasicBlock;
45 struct Node;
46
47 // This enum describes the types of additional recovery that
48 // may need be performed should a speculation check fail.
49 enum SpeculationRecoveryType : uint8_t {
50     SpeculativeAdd,
51     SpeculativeAddImmediate,
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_src(src)
63         , m_dest(dest)
64         , m_type(type)
65     {
66         ASSERT(m_type == SpeculativeAdd || m_type == BooleanSpeculationCheck);
67     }
68
69     SpeculationRecovery(SpeculationRecoveryType type, GPRReg dest, int32_t immediate)
70         : m_immediate(immediate)
71         , m_dest(dest)
72         , m_type(type)
73     {
74         ASSERT(m_type == SpeculativeAddImmediate);
75     }
76
77     SpeculationRecoveryType type() { return m_type; }
78     GPRReg dest() { return m_dest; }
79     GPRReg src() { return m_src; }
80     int32_t immediate() { return m_immediate; }
81
82 private:
83     // different recovery types may required different additional information here.
84     union {
85         GPRReg m_src;
86         int32_t m_immediate;
87     };
88     GPRReg m_dest;
89
90     // Indicates the type of additional recovery to be performed.
91     SpeculationRecoveryType m_type;
92 };
93
94 // === OSRExit ===
95 //
96 // This structure describes how to exit the speculative path by
97 // going into baseline code.
98 struct OSRExit : public OSRExitBase {
99     OSRExit(ExitKind, JSValueSource, MethodOfGettingAValueProfile, SpeculativeJIT*, unsigned streamIndex, unsigned recoveryIndex = UINT_MAX);
100
101     unsigned m_patchableCodeOffset { 0 };
102     
103     MacroAssemblerCodeRef m_code;
104     
105     JSValueSource m_jsValueSource;
106     MethodOfGettingAValueProfile m_valueProfile;
107     
108     unsigned m_recoveryIndex;
109
110     void setPatchableCodeOffset(MacroAssembler::PatchableJump);
111     MacroAssembler::Jump getPatchableCodeOffsetAsJump() const;
112     CodeLocationJump codeLocationForRepatch(CodeBlock*) const;
113     void correctJump(LinkBuffer&);
114
115     unsigned m_streamIndex;
116     void considerAddingAsFrequentExitSite(CodeBlock* profiledCodeBlock)
117     {
118         OSRExitBase::considerAddingAsFrequentExitSite(profiledCodeBlock, ExitFromDFG);
119     }
120 };
121
122 struct SpeculationFailureDebugInfo {
123     CodeBlock* codeBlock;
124     ExitKind kind;
125     unsigned bytecodeOffset;
126 };
127
128 } } // namespace JSC::DFG
129
130 #endif // ENABLE(DFG_JIT)