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