The CleanUp after LICM is erroneously removing a Check
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGAbstractInterpreter.h
1 /*
2  * Copyright (C) 2013-2016 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 "DFGAbstractValue.h"
31 #include "DFGGraph.h"
32 #include "DFGNode.h"
33 #include "DFGNodeFlowProjection.h"
34 #include "DFGPhiChildren.h"
35
36 namespace JSC { namespace DFG {
37
38 template<typename AbstractStateType>
39 class AbstractInterpreter {
40 public:
41     AbstractInterpreter(Graph&, AbstractStateType&);
42     ~AbstractInterpreter();
43     
44     AbstractValue& forNode(NodeFlowProjection node)
45     {
46         return m_state.forNode(node);
47     }
48     
49     AbstractValue& forNode(Edge edge)
50     {
51         return forNode(edge.node());
52     }
53     
54     Operands<AbstractValue>& variables()
55     {
56         return m_state.variables();
57     }
58     
59     bool needsTypeCheck(Node* node, SpeculatedType typesPassedThrough)
60     {
61         return !forNode(node).isType(typesPassedThrough);
62     }
63     
64     bool needsTypeCheck(Edge edge, SpeculatedType typesPassedThrough)
65     {
66         return needsTypeCheck(edge.node(), typesPassedThrough);
67     }
68     
69     bool needsTypeCheck(Edge edge)
70     {
71         return needsTypeCheck(edge, typeFilterFor(edge.useKind()));
72     }
73     
74     // Abstractly executes the given node. The new abstract state is stored into an
75     // abstract stack stored in *this. Loads of local variables (that span
76     // basic blocks) interrogate the basic block's notion of the state at the head.
77     // Stores to local variables are handled in endBasicBlock(). This returns true
78     // if execution should continue past this node. Notably, it will return true
79     // for block terminals, so long as those terminals are not Return or Unreachable.
80     //
81     // This is guaranteed to be equivalent to doing:
82     //
83     // state.startExecuting()
84     // state.executeEdges(node);
85     // result = state.executeEffects(index);
86     bool execute(unsigned indexInBlock);
87     bool execute(Node*);
88     
89     // Indicate the start of execution of a node. It resets any state in the node
90     // that is progressively built up by executeEdges() and executeEffects().
91     void startExecuting();
92     
93     // Abstractly execute the edges of the given node. This runs filterEdgeByUse()
94     // on all edges of the node. You can skip this step, if you have already used
95     // filterEdgeByUse() (or some equivalent) on each edge.
96     void executeEdges(Node*);
97
98     void executeKnownEdgeTypes(Node*);
99     
100     ALWAYS_INLINE void filterEdgeByUse(Edge& edge)
101     {
102         filterByType(edge, typeFilterFor(edge.useKind()));
103     }
104     
105     // Abstractly execute the effects of the given node. This changes the abstract
106     // state assuming that edges have already been filtered.
107     bool executeEffects(unsigned indexInBlock);
108     bool executeEffects(unsigned clobberLimit, Node*);
109     
110     void dump(PrintStream& out) const;
111     void dump(PrintStream& out);
112     
113     template<typename T>
114     FiltrationResult filter(T node, const RegisteredStructureSet& set, SpeculatedType admittedTypes = SpecNone)
115     {
116         return filter(forNode(node), set, admittedTypes);
117     }
118     
119     template<typename T>
120     FiltrationResult filterArrayModes(T node, ArrayModes arrayModes)
121     {
122         return filterArrayModes(forNode(node), arrayModes);
123     }
124     
125     template<typename T>
126     FiltrationResult filter(T node, SpeculatedType type)
127     {
128         return filter(forNode(node), type);
129     }
130     
131     template<typename T>
132     FiltrationResult filterByValue(T node, FrozenValue value)
133     {
134         return filterByValue(forNode(node), value);
135     }
136     
137     template<typename T>
138     FiltrationResult filterClassInfo(T node, const ClassInfo* classInfo)
139     {
140         return filterClassInfo(forNode(node), classInfo);
141     }
142
143     FiltrationResult filter(AbstractValue&, const RegisteredStructureSet&, SpeculatedType admittedTypes = SpecNone);
144     FiltrationResult filterArrayModes(AbstractValue&, ArrayModes);
145     FiltrationResult filter(AbstractValue&, SpeculatedType);
146     FiltrationResult filterByValue(AbstractValue&, FrozenValue);
147     FiltrationResult filterClassInfo(AbstractValue&, const ClassInfo*);
148     
149     PhiChildren* phiChildren() { return m_phiChildren.get(); }
150     
151 private:
152     void clobberWorld(const CodeOrigin&, unsigned indexInBlock);
153     
154     template<typename Functor>
155     void forAllValues(unsigned indexInBlock, Functor&);
156     
157     void clobberStructures(unsigned indexInBlock);
158     void observeTransition(unsigned indexInBlock, RegisteredStructure from, RegisteredStructure to);
159     void observeTransitions(unsigned indexInBlock, const TransitionVector&);
160     void setDidClobber();
161     
162     enum BooleanResult {
163         UnknownBooleanResult,
164         DefinitelyFalse,
165         DefinitelyTrue
166     };
167     BooleanResult booleanResult(Node*, AbstractValue&);
168     
169     void setBuiltInConstant(Node* node, FrozenValue value)
170     {
171         AbstractValue& abstractValue = forNode(node);
172         abstractValue.set(m_graph, value, m_state.structureClobberState());
173         abstractValue.fixTypeForRepresentation(m_graph, node);
174     }
175     
176     void setConstant(Node* node, FrozenValue value)
177     {
178         setBuiltInConstant(node, value);
179         m_state.setFoundConstants(true);
180     }
181     
182     ALWAYS_INLINE void filterByType(Edge& edge, SpeculatedType type)
183     {
184         AbstractValue& value = forNode(edge);
185         m_state.setProofStatus(edge, value.isType(type) ? IsProved : NeedsCheck);
186         filter(value, type);
187     }
188     
189     void verifyEdge(Node*, Edge);
190     void verifyEdges(Node*);
191     void executeDoubleUnaryOpEffects(Node*, double(*equivalentFunction)(double));
192     
193     CodeBlock* m_codeBlock;
194     Graph& m_graph;
195     VM& m_vm;
196     AbstractStateType& m_state;
197     std::unique_ptr<PhiChildren> m_phiChildren;
198 };
199
200 } } // namespace JSC::DFG
201
202 #endif // ENABLE(DFG_JIT)