DFG SSA stack accesses shouldn't speak of VariableAccessDatas
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGNodeType.h
1 /*
2  * Copyright (C) 2012-2015 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 DFGNodeType_h
27 #define DFGNodeType_h
28
29 #if ENABLE(DFG_JIT)
30
31 #include "DFGNodeFlags.h"
32
33 namespace JSC { namespace DFG {
34
35 // This macro defines a set of information about all known node types, used to populate NodeId, NodeType below.
36 #define FOR_EACH_DFG_OP(macro) \
37     /* A constant in the CodeBlock's constant pool. */\
38     macro(JSConstant, NodeResultJS) \
39     \
40     /* Constants with specific representations. */\
41     macro(DoubleConstant, NodeResultDouble) \
42     macro(Int52Constant, NodeResultInt52) \
43     \
44     /* Marker to indicate that an operation was optimized entirely and all that is left */\
45     /* is to make one node alias another. CSE will later usually eliminate this node, */\
46     /* though it may choose not to if it would corrupt predictions (very rare). */\
47     macro(Identity, NodeResultJS) \
48     \
49     /* Nodes for handling functions (both as call and as construct). */\
50     macro(ToThis, NodeResultJS) \
51     macro(CreateThis, NodeResultJS) /* Note this is not MustGenerate since we're returning it anyway. */ \
52     macro(GetCallee, NodeResultJS) \
53     \
54     /* Nodes for local variable access. These nodes are linked together using Phi nodes. */\
55     /* Any two nodes that are part of the same Phi graph will share the same */\
56     /* VariableAccessData, and thus will share predictions. FIXME: We should come up with */\
57     /* better names for a lot of these. https://bugs.webkit.org/show_bug.cgi?id=137307 */\
58     macro(GetLocal, NodeResultJS) \
59     macro(SetLocal, 0) \
60     \
61     macro(PutStack, NodeMustGenerate) \
62     macro(KillStack, NodeMustGenerate) \
63     macro(GetStack, NodeResultJS) \
64     \
65     macro(MovHint, 0) \
66     macro(ZombieHint, 0) \
67     macro(Phantom, NodeMustGenerate) \
68     macro(HardPhantom, NodeMustGenerate) /* Like Phantom, but we never remove any of its children. */ \
69     macro(Check, NodeMustGenerate) /* Used if we want just a type check but not liveness. Non-checking uses will be removed. */\
70     macro(Upsilon, NodeRelevantToOSR) \
71     macro(Phi, NodeRelevantToOSR) \
72     macro(Flush, NodeMustGenerate) \
73     macro(PhantomLocal, NodeMustGenerate) \
74     \
75     /* Hint that this is where bytecode thinks is a good place to OSR. Note that this */\
76     /* will exist even in inlined loops. This has no execution semantics but it must */\
77     /* survive all DCE. We treat this as being a can-exit because tier-up to FTL may */\
78     /* want all state. */\
79     macro(LoopHint, NodeMustGenerate) \
80     \
81     /* Special node for OSR entry into the FTL. Indicates that we're loading a local */\
82     /* variable from the scratch buffer. */\
83     macro(ExtractOSREntryLocal, NodeResultJS) \
84     \
85     /* Tier-up checks from the DFG to the FTL. */\
86     macro(CheckTierUpInLoop, NodeMustGenerate) \
87     macro(CheckTierUpAndOSREnter, NodeMustGenerate) \
88     macro(CheckTierUpAtReturn, NodeMustGenerate) \
89     \
90     /* Get the value of a local variable, without linking into the VariableAccessData */\
91     /* network. This is only valid for variable accesses whose predictions originated */\
92     /* as something other than a local access, and thus had their own profiling. */\
93     macro(GetLocalUnlinked, NodeResultJS) \
94     \
95     /* Marker for an argument being set at the prologue of a function. */\
96     macro(SetArgument, 0) \
97     \
98     /* Marker of location in the IR where we may possibly perform jump replacement to */\
99     /* invalidate this code block. */\
100     macro(InvalidationPoint, NodeMustGenerate) \
101     \
102     /* Nodes for bitwise operations. */\
103     macro(BitAnd, NodeResultInt32) \
104     macro(BitOr, NodeResultInt32) \
105     macro(BitXor, NodeResultInt32) \
106     macro(BitLShift, NodeResultInt32) \
107     macro(BitRShift, NodeResultInt32) \
108     macro(BitURShift, NodeResultInt32) \
109     /* Bitwise operators call ToInt32 on their operands. */\
110     macro(ValueToInt32, NodeResultInt32) \
111     /* Used to box the result of URShift nodes (result has range 0..2^32-1). */\
112     macro(UInt32ToNumber, NodeResultNumber) \
113     /* Converts booleans to numbers but passes everything else through. */\
114     macro(BooleanToNumber, NodeResultJS) \
115     \
116     /* Attempt to truncate a double to int32; this will exit if it can't do it. */\
117     macro(DoubleAsInt32, NodeResultInt32) \
118     \
119     /* Change the representation of a value. */\
120     macro(DoubleRep, NodeResultDouble) \
121     macro(Int52Rep, NodeResultInt52) \
122     macro(ValueRep, NodeResultJS) \
123     \
124     /* Bogus type asserting node. Useful for testing, disappears during Fixup. */\
125     macro(FiatInt52, NodeResultJS) \
126     \
127     /* Nodes for arithmetic operations. */\
128     macro(ArithAdd, NodeResultNumber) \
129     macro(ArithSub, NodeResultNumber) \
130     macro(ArithNegate, NodeResultNumber) \
131     macro(ArithMul, NodeResultNumber) \
132     macro(ArithIMul, NodeResultInt32) \
133     macro(ArithDiv, NodeResultNumber) \
134     macro(ArithMod, NodeResultNumber) \
135     macro(ArithAbs, NodeResultNumber) \
136     macro(ArithMin, NodeResultNumber) \
137     macro(ArithMax, NodeResultNumber) \
138     macro(ArithFRound, NodeResultNumber) \
139     macro(ArithPow, NodeResultNumber) \
140     macro(ArithSqrt, NodeResultNumber) \
141     macro(ArithSin, NodeResultNumber) \
142     macro(ArithCos, NodeResultNumber) \
143     \
144     /* Add of values may either be arithmetic, or result in string concatenation. */\
145     macro(ValueAdd, NodeResultJS | NodeMustGenerate) \
146     \
147     /* Property access. */\
148     /* PutByValAlias indicates a 'put' aliases a prior write to the same property. */\
149     /* Since a put to 'length' may invalidate optimizations here, */\
150     /* this must be the directly subsequent property put. Note that PutByVal */\
151     /* opcodes use VarArgs beause they may have up to 4 children. */\
152     macro(GetByVal, NodeResultJS | NodeMustGenerate) \
153     macro(LoadVarargs, NodeMustGenerate) \
154     macro(PutByValDirect, NodeMustGenerate | NodeHasVarArgs) \
155     macro(PutByVal, NodeMustGenerate | NodeHasVarArgs) \
156     macro(PutByValAlias, NodeMustGenerate | NodeHasVarArgs) \
157     macro(GetById, NodeResultJS | NodeMustGenerate) \
158     macro(GetByIdFlush, NodeResultJS | NodeMustGenerate) \
159     macro(PutById, NodeMustGenerate) \
160     macro(PutByIdFlush, NodeMustGenerate | NodeMustGenerate) \
161     macro(PutByIdDirect, NodeMustGenerate) \
162     macro(CheckStructure, NodeMustGenerate) \
163     macro(GetExecutable, NodeResultJS) \
164     macro(PutStructure, NodeMustGenerate) \
165     macro(AllocatePropertyStorage, NodeMustGenerate | NodeResultStorage) \
166     macro(ReallocatePropertyStorage, NodeMustGenerate | NodeResultStorage) \
167     macro(GetButterfly, NodeResultStorage) \
168     macro(CheckArray, NodeMustGenerate) \
169     macro(Arrayify, NodeMustGenerate) \
170     macro(ArrayifyToStructure, NodeMustGenerate) \
171     macro(GetIndexedPropertyStorage, NodeResultStorage) \
172     macro(ConstantStoragePointer, NodeResultStorage) \
173     macro(TypedArrayWatchpoint, NodeMustGenerate) \
174     macro(GetGetter, NodeResultJS) \
175     macro(GetSetter, NodeResultJS) \
176     macro(GetByOffset, NodeResultJS) \
177     macro(GetGetterSetterByOffset, NodeResultJS) \
178     macro(MultiGetByOffset, NodeResultJS | NodeMustGenerate) \
179     macro(PutByOffset, NodeMustGenerate) \
180     macro(MultiPutByOffset, NodeMustGenerate) \
181     macro(GetArrayLength, NodeResultInt32) \
182     macro(GetTypedArrayByteOffset, NodeResultInt32) \
183     macro(GetScope, NodeResultJS) \
184     macro(SkipScope, NodeResultJS) \
185     macro(GetClosureRegisters, NodeResultStorage) \
186     macro(GetClosureVar, NodeResultJS) \
187     macro(PutClosureVar, NodeMustGenerate) \
188     macro(GetGlobalVar, NodeResultJS) \
189     macro(PutGlobalVar, NodeMustGenerate) \
190     macro(NotifyWrite, NodeMustGenerate) \
191     macro(VariableWatchpoint, NodeMustGenerate) \
192     macro(VarInjectionWatchpoint, NodeMustGenerate) \
193     macro(FunctionReentryWatchpoint, NodeMustGenerate) \
194     macro(CheckCell, NodeMustGenerate) \
195     macro(CheckBadCell, NodeMustGenerate) \
196     macro(AllocationProfileWatchpoint, NodeMustGenerate) \
197     macro(CheckInBounds, NodeMustGenerate) \
198     \
199     /* Optimizations for array mutation. */\
200     macro(ArrayPush, NodeResultJS | NodeMustGenerate) \
201     macro(ArrayPop, NodeResultJS | NodeMustGenerate) \
202     \
203     /* Optimizations for regular expression matching. */\
204     macro(RegExpExec, NodeResultJS | NodeMustGenerate) \
205     macro(RegExpTest, NodeResultJS | NodeMustGenerate) \
206     \
207     /* Optimizations for string access */ \
208     macro(StringCharCodeAt, NodeResultInt32) \
209     macro(StringCharAt, NodeResultJS) \
210     macro(StringFromCharCode, NodeResultJS) \
211     \
212     /* Nodes for comparison operations. */\
213     macro(CompareLess, NodeResultBoolean | NodeMustGenerate) \
214     macro(CompareLessEq, NodeResultBoolean | NodeMustGenerate) \
215     macro(CompareGreater, NodeResultBoolean | NodeMustGenerate) \
216     macro(CompareGreaterEq, NodeResultBoolean | NodeMustGenerate) \
217     macro(CompareEq, NodeResultBoolean | NodeMustGenerate) \
218     macro(CompareEqConstant, NodeResultBoolean) \
219     macro(CompareStrictEq, NodeResultBoolean) \
220     \
221     /* Calls. */\
222     macro(Call, NodeResultJS | NodeMustGenerate | NodeHasVarArgs) \
223     macro(Construct, NodeResultJS | NodeMustGenerate | NodeHasVarArgs) \
224     macro(CallVarargs, NodeResultJS | NodeMustGenerate) \
225     macro(CallForwardVarargs, NodeResultJS | NodeMustGenerate) \
226     macro(ConstructVarargs, NodeResultJS | NodeMustGenerate) \
227     macro(NativeCall, NodeResultJS | NodeMustGenerate | NodeHasVarArgs) \
228     macro(NativeConstruct, NodeResultJS | NodeMustGenerate | NodeHasVarArgs) \
229     \
230     /* Allocations. */\
231     macro(NewObject, NodeResultJS) \
232     macro(NewArray, NodeResultJS | NodeHasVarArgs) \
233     macro(NewArrayWithSize, NodeResultJS | NodeMustGenerate) \
234     macro(NewArrayBuffer, NodeResultJS) \
235     macro(NewTypedArray, NodeResultJS | NodeMustGenerate) \
236     macro(NewRegexp, NodeResultJS) \
237     \
238     /* Support for allocation sinking. */\
239     macro(PhantomNewObject, NodeResultJS) \
240     macro(PutByOffsetHint, NodeMustGenerate) \
241     macro(CheckStructureImmediate, NodeMustGenerate) \
242     macro(PutStructureHint, NodeMustGenerate) \
243     macro(MaterializeNewObject, NodeResultJS | NodeHasVarArgs) \
244     \
245     /* Nodes for misc operations. */\
246     macro(Breakpoint, NodeMustGenerate) \
247     macro(ProfileWillCall, NodeMustGenerate) \
248     macro(ProfileDidCall, NodeMustGenerate) \
249     macro(CheckHasInstance, NodeMustGenerate) \
250     macro(InstanceOf, NodeResultBoolean) \
251     macro(IsUndefined, NodeResultBoolean) \
252     macro(IsBoolean, NodeResultBoolean) \
253     macro(IsNumber, NodeResultBoolean) \
254     macro(IsString, NodeResultBoolean) \
255     macro(IsObject, NodeResultBoolean) \
256     macro(IsObjectOrNull, NodeResultBoolean) \
257     macro(IsFunction, NodeResultBoolean) \
258     macro(TypeOf, NodeResultJS) \
259     macro(LogicalNot, NodeResultBoolean) \
260     macro(ToPrimitive, NodeResultJS | NodeMustGenerate) \
261     macro(ToString, NodeResultJS | NodeMustGenerate) \
262     macro(NewStringObject, NodeResultJS) \
263     macro(MakeRope, NodeResultJS) \
264     macro(In, NodeResultBoolean | NodeMustGenerate) \
265     macro(ProfileType, NodeMustGenerate) \
266     macro(ProfileControlFlow, NodeMustGenerate) \
267     \
268     /* Nodes used for activations. Activation support works by having it anchored at */\
269     /* epilgoues via TearOffActivation, and all CreateActivation nodes kept alive by */\
270     /* being threaded with each other. */\
271     macro(CreateActivation, NodeResultJS) \
272     \
273     /* Nodes used for arguments. Similar to lexical environment support, only it makes even less */\
274     /* sense. */\
275     macro(CreateArguments, NodeResultJS) \
276     macro(PhantomArguments, NodeResultJS) \
277     macro(TearOffArguments, NodeMustGenerate) \
278     macro(GetMyArgumentsLength, NodeResultJS | NodeMustGenerate) \
279     macro(GetMyArgumentByVal, NodeResultJS | NodeMustGenerate) \
280     macro(GetMyArgumentsLengthSafe, NodeResultJS | NodeMustGenerate) \
281     macro(GetMyArgumentByValSafe, NodeResultJS | NodeMustGenerate) \
282     macro(CheckArgumentsNotCreated, NodeMustGenerate) \
283     \
284     /* Nodes for creating functions. */\
285     macro(NewFunctionNoCheck, NodeResultJS) \
286     macro(NewFunction, NodeResultJS) \
287     macro(NewFunctionExpression, NodeResultJS) \
288     \
289     /* These aren't terminals but always exit */ \
290     macro(Throw, NodeMustGenerate) \
291     macro(ThrowReferenceError, NodeMustGenerate) \
292     \
293     /* Block terminals. */\
294     macro(Jump, NodeMustGenerate) \
295     macro(Branch, NodeMustGenerate) \
296     macro(Switch, NodeMustGenerate) \
297     macro(Return, NodeMustGenerate) \
298     macro(Unreachable, NodeMustGenerate) \
299     \
300     /* Count execution. */\
301     macro(CountExecution, NodeMustGenerate) \
302     \
303     /* This is a pseudo-terminal. It means that execution should fall out of DFG at */\
304     /* this point, but execution does continue in the basic block - just in a */\
305     /* different compiler. */\
306     macro(ForceOSRExit, NodeMustGenerate) \
307     \
308     /* Vends a bottom JS value. It is invalid to ever execute this. Useful for cases */\
309     /* where we know that we would have exited but we'd like to still track the control */\
310     /* flow. */\
311     macro(BottomValue, NodeResultJS) \
312     \
313     /* Checks the watchdog timer. If the timer has fired, we OSR exit to the */ \
314     /* baseline JIT to redo the watchdog timer check, and service the timer. */ \
315     macro(CheckWatchdogTimer, NodeMustGenerate) \
316     /* Write barriers ! */\
317     macro(StoreBarrier, NodeMustGenerate) \
318     macro(StoreBarrierWithNullCheck, NodeMustGenerate) \
319     \
320     /* For-in enumeration opcodes */\
321     macro(GetEnumerableLength, NodeMustGenerate | NodeResultJS) \
322     macro(HasIndexedProperty, NodeResultBoolean) \
323     macro(HasStructureProperty, NodeResultBoolean) \
324     macro(HasGenericProperty, NodeResultBoolean) \
325     macro(GetDirectPname, NodeMustGenerate | NodeHasVarArgs | NodeResultJS) \
326     macro(GetStructurePropertyEnumerator, NodeMustGenerate | NodeResultJS) \
327     macro(GetGenericPropertyEnumerator, NodeMustGenerate | NodeResultJS) \
328     macro(GetEnumeratorPname, NodeMustGenerate | NodeResultJS) \
329     macro(ToIndexString, NodeResultJS)
330
331 // This enum generates a monotonically increasing id for all Node types,
332 // and is used by the subsequent enum to fill out the id (as accessed via the NodeIdMask).
333 enum NodeType {
334 #define DFG_OP_ENUM(opcode, flags) opcode,
335     FOR_EACH_DFG_OP(DFG_OP_ENUM)
336 #undef DFG_OP_ENUM
337     LastNodeType
338 };
339
340 // Specifies the default flags for each node.
341 inline NodeFlags defaultFlags(NodeType op)
342 {
343     switch (op) {
344 #define DFG_OP_ENUM(opcode, flags) case opcode: return flags;
345     FOR_EACH_DFG_OP(DFG_OP_ENUM)
346 #undef DFG_OP_ENUM
347     default:
348         RELEASE_ASSERT_NOT_REACHED();
349         return 0;
350     }
351 }
352
353 } } // namespace JSC::DFG
354
355 #endif // ENABLE(DFG_JIT)
356
357 #endif // DFGNodeType_h
358