6a3d3883d7a563ecec02652dd45bb8279c4ccf8f
[WebKit-https.git] / Source / JavaScriptCore / bytecode / CallLinkStatus.h
1 /*
2  * Copyright (C) 2012, 2013, 2014 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 CallLinkStatus_h
27 #define CallLinkStatus_h
28
29 #include "CallLinkInfo.h"
30 #include "CodeOrigin.h"
31 #include "CodeSpecializationKind.h"
32 #include "ConcurrentJITLock.h"
33 #include "ExitingJITType.h"
34 #include "Intrinsic.h"
35 #include "JSCJSValue.h"
36
37 namespace JSC {
38
39 class CodeBlock;
40 class ExecutableBase;
41 class InternalFunction;
42 class JSFunction;
43 class Structure;
44 struct CallLinkInfo;
45
46 class CallLinkStatus {
47 public:
48     CallLinkStatus()
49         : m_couldTakeSlowPath(false)
50         , m_isProved(false)
51         , m_canTrustCounts(false)
52     {
53     }
54     
55     static CallLinkStatus takesSlowPath()
56     {
57         CallLinkStatus result;
58         result.m_couldTakeSlowPath = true;
59         return result;
60     }
61     
62     explicit CallLinkStatus(JSValue);
63     
64     CallLinkStatus(CallVariant variant)
65         : m_edges(1, CallEdge(variant, 1))
66         , m_couldTakeSlowPath(false)
67         , m_isProved(false)
68         , m_canTrustCounts(false)
69     {
70     }
71     
72     CallLinkStatus& setIsProved(bool isProved)
73     {
74         m_isProved = isProved;
75         return *this;
76     }
77     
78     static CallLinkStatus computeFor(
79         CodeBlock*, unsigned bytecodeIndex, const CallLinkInfoMap&);
80
81     struct ExitSiteData {
82         ExitSiteData()
83             : m_takesSlowPath(false)
84             , m_badFunction(false)
85         {
86         }
87         
88         bool m_takesSlowPath;
89         bool m_badFunction;
90     };
91     static ExitSiteData computeExitSiteData(const ConcurrentJITLocker&, CodeBlock*, unsigned bytecodeIndex, ExitingJITType = ExitFromAnything);
92     
93 #if ENABLE(JIT)
94     // Computes the status assuming that we never took slow path and never previously
95     // exited.
96     static CallLinkStatus computeFor(const ConcurrentJITLocker&, CodeBlock*, CallLinkInfo&);
97     static CallLinkStatus computeFor(
98         const ConcurrentJITLocker&, CodeBlock*, CallLinkInfo&, ExitSiteData);
99 #endif
100     
101     typedef HashMap<CodeOrigin, CallLinkStatus, CodeOriginApproximateHash> ContextMap;
102     
103     // Computes all of the statuses of the DFG code block. Doesn't include statuses that had
104     // no information. Currently we use this when compiling FTL code, to enable polyvariant
105     // inlining.
106     static void computeDFGStatuses(CodeBlock* dfgCodeBlock, ContextMap&);
107     
108     // Helper that first consults the ContextMap and then does computeFor().
109     static CallLinkStatus computeFor(
110         CodeBlock*, CodeOrigin, const CallLinkInfoMap&, const ContextMap&);
111     
112     bool isSet() const { return !m_edges.isEmpty() || m_couldTakeSlowPath; }
113     
114     bool operator!() const { return !isSet(); }
115     
116     bool couldTakeSlowPath() const { return m_couldTakeSlowPath; }
117     
118     CallEdgeList edges() const { return m_edges; }
119     unsigned size() const { return m_edges.size(); }
120     CallEdge at(unsigned i) const { return m_edges[i]; }
121     CallEdge operator[](unsigned i) const { return at(i); }
122     bool isProved() const { return m_isProved; }
123     bool canOptimize() const { return !m_edges.isEmpty(); }
124     bool canTrustCounts() const { return m_canTrustCounts; }
125     
126     bool isClosureCall() const; // Returns true if any callee is a closure call.
127     
128     void dump(PrintStream&) const;
129     
130 private:
131     void makeClosureCall();
132     
133     static CallLinkStatus computeFromLLInt(const ConcurrentJITLocker&, CodeBlock*, unsigned bytecodeIndex);
134 #if ENABLE(JIT)
135     static CallLinkStatus computeFromCallEdgeProfile(CallEdgeProfile*);
136     static CallLinkStatus computeFromCallLinkInfo(
137         const ConcurrentJITLocker&, CallLinkInfo&);
138 #endif
139     
140     CallEdgeList m_edges;
141     bool m_couldTakeSlowPath;
142     bool m_isProved;
143     bool m_canTrustCounts;
144 };
145
146 } // namespace JSC
147
148 #endif // CallLinkStatus_h
149