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