[ES6] Implement tail calls in the DFG
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGSafeToExecute.h
1 /*
2  * Copyright (C) 2013-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 DFGSafeToExecute_h
27 #define DFGSafeToExecute_h
28
29 #if ENABLE(DFG_JIT)
30
31 #include "DFGGraph.h"
32
33 namespace JSC { namespace DFG {
34
35 template<typename AbstractStateType>
36 class SafeToExecuteEdge {
37 public:
38     SafeToExecuteEdge(AbstractStateType& state)
39         : m_state(state)
40         , m_result(true)
41     {
42     }
43     
44     void operator()(Node*, Edge edge)
45     {
46         switch (edge.useKind()) {
47         case UntypedUse:
48         case Int32Use:
49         case DoubleRepUse:
50         case DoubleRepRealUse:
51         case Int52RepUse:
52         case NumberUse:
53         case RealNumberUse:
54         case BooleanUse:
55         case CellUse:
56         case CellOrOtherUse:
57         case ObjectUse:
58         case FunctionUse:
59         case FinalObjectUse:
60         case ObjectOrOtherUse:
61         case StringIdentUse:
62         case StringUse:
63         case SymbolUse:
64         case StringObjectUse:
65         case StringOrStringObjectUse:
66         case NotStringVarUse:
67         case NotCellUse:
68         case OtherUse:
69         case MiscUse:
70         case MachineIntUse:
71         case DoubleRepMachineIntUse:
72             return;
73             
74         case KnownInt32Use:
75             if (m_state.forNode(edge).m_type & ~SpecInt32)
76                 m_result = false;
77             return;
78
79         case KnownBooleanUse:
80             if (m_state.forNode(edge).m_type & ~SpecBoolean)
81                 m_result = false;
82             return;
83             
84         case KnownCellUse:
85             if (m_state.forNode(edge).m_type & ~SpecCell)
86                 m_result = false;
87             return;
88             
89         case KnownStringUse:
90             if (m_state.forNode(edge).m_type & ~SpecString)
91                 m_result = false;
92             return;
93
94         case KnownPrimitiveUse:
95             if (m_state.forNode(edge).m_type & ~(SpecHeapTop & ~SpecObject))
96                 m_result = false;
97             return;
98             
99         case LastUseKind:
100             RELEASE_ASSERT_NOT_REACHED();
101             break;
102         }
103         RELEASE_ASSERT_NOT_REACHED();
104     }
105     
106     bool result() const { return m_result; }
107 private:
108     AbstractStateType& m_state;
109     bool m_result;
110 };
111
112 // Determines if it's safe to execute a node within the given abstract state. This may
113 // return false conservatively. If it returns true, then you can hoist the given node
114 // up to the given point and expect that it will not crash. It also guarantees that the
115 // node will not produce a malformed JSValue or object pointer when executed in the
116 // given state. But this doesn't guarantee that the node will produce the result you
117 // wanted. For example, you may have a GetByOffset from a prototype that only makes
118 // semantic sense if you've also checked that some nearer prototype doesn't also have
119 // a property of the same name. This could still return true even if that check hadn't
120 // been performed in the given abstract state. That's fine though: the load can still
121 // safely execute before that check, so long as that check continues to guard any
122 // user-observable things done to the loaded value.
123 template<typename AbstractStateType>
124 bool safeToExecute(AbstractStateType& state, Graph& graph, Node* node)
125 {
126     SafeToExecuteEdge<AbstractStateType> safeToExecuteEdge(state);
127     DFG_NODE_DO_TO_CHILDREN(graph, node, safeToExecuteEdge);
128     if (!safeToExecuteEdge.result())
129         return false;
130
131     // NOTE: This tends to lie when it comes to effectful nodes, because it knows that they aren't going to
132     // get hoisted anyway.
133
134     switch (node->op()) {
135     case JSConstant:
136     case DoubleConstant:
137     case Int52Constant:
138     case Identity:
139     case ToThis:
140     case CreateThis:
141     case GetCallee:
142     case GetArgumentCount:
143     case GetLocal:
144     case SetLocal:
145     case PutStack:
146     case KillStack:
147     case GetStack:
148     case MovHint:
149     case ZombieHint:
150     case ExitOK:
151     case Phantom:
152     case Upsilon:
153     case Phi:
154     case Flush:
155     case PhantomLocal:
156     case GetLocalUnlinked:
157     case SetArgument:
158     case BitAnd:
159     case BitOr:
160     case BitXor:
161     case BitLShift:
162     case BitRShift:
163     case BitURShift:
164     case ValueToInt32:
165     case UInt32ToNumber:
166     case DoubleAsInt32:
167     case ArithAdd:
168     case ArithClz32:
169     case ArithSub:
170     case ArithNegate:
171     case ArithMul:
172     case ArithIMul:
173     case ArithDiv:
174     case ArithMod:
175     case ArithAbs:
176     case ArithMin:
177     case ArithMax:
178     case ArithPow:
179     case ArithSqrt:
180     case ArithFRound:
181     case ArithRound:
182     case ArithSin:
183     case ArithCos:
184     case ArithLog:
185     case ValueAdd:
186     case GetById:
187     case GetByIdFlush:
188     case PutById:
189     case PutByIdFlush:
190     case PutByIdDirect:
191     case CheckStructure:
192     case GetExecutable:
193     case GetButterfly:
194     case CheckArray:
195     case Arrayify:
196     case ArrayifyToStructure:
197     case GetScope:
198     case LoadArrowFunctionThis:
199     case SkipScope:
200     case GetClosureVar:
201     case PutClosureVar:
202     case GetGlobalVar:
203     case GetGlobalLexicalVariable:
204     case PutGlobalVariable:
205     case VarInjectionWatchpoint:
206     case CheckCell:
207     case CheckBadCell:
208     case CheckNotEmpty:
209     case CheckIdent:
210     case RegExpExec:
211     case RegExpTest:
212     case CompareLess:
213     case CompareLessEq:
214     case CompareGreater:
215     case CompareGreaterEq:
216     case CompareEq:
217     case CompareStrictEq:
218     case Call:
219     case TailCallInlinedCaller:
220     case Construct:
221     case CallVarargs:
222     case TailCallVarargsInlinedCaller:
223     case TailCallForwardVarargsInlinedCaller:
224     case ConstructVarargs:
225     case LoadVarargs:
226     case CallForwardVarargs:
227     case ConstructForwardVarargs:
228     case NewObject:
229     case NewArray:
230     case NewArrayWithSize:
231     case NewArrayBuffer:
232     case NewRegexp:
233     case Breakpoint:
234     case ProfileWillCall:
235     case ProfileDidCall:
236     case ProfileType:
237     case ProfileControlFlow:
238     case CheckHasInstance:
239     case InstanceOf:
240     case IsUndefined:
241     case IsBoolean:
242     case IsNumber:
243     case IsString:
244     case IsObject:
245     case IsObjectOrNull:
246     case IsFunction:
247     case TypeOf:
248     case LogicalNot:
249     case ToPrimitive:
250     case ToString:
251     case StrCat:
252     case CallStringConstructor:
253     case NewStringObject:
254     case MakeRope:
255     case In:
256     case CreateActivation:
257     case CreateDirectArguments:
258     case CreateScopedArguments:
259     case CreateClonedArguments:
260     case GetFromArguments:
261     case PutToArguments:
262     case NewArrowFunction:
263     case NewFunction:
264     case Jump:
265     case Branch:
266     case Switch:
267     case Return:
268     case TailCall:
269     case TailCallVarargs:
270     case TailCallForwardVarargs:
271     case Throw:
272     case ThrowReferenceError:
273     case CountExecution:
274     case ForceOSRExit:
275     case CheckWatchdogTimer:
276     case StringFromCharCode:
277     case NewTypedArray:
278     case Unreachable:
279     case ExtractOSREntryLocal:
280     case CheckTierUpInLoop:
281     case CheckTierUpAtReturn:
282     case CheckTierUpAndOSREnter:
283     case CheckTierUpWithNestedTriggerAndOSREnter:
284     case LoopHint:
285     case StoreBarrier:
286     case InvalidationPoint:
287     case NotifyWrite:
288     case CheckInBounds:
289     case ConstantStoragePointer:
290     case Check:
291     case MultiPutByOffset:
292     case ValueRep:
293     case DoubleRep:
294     case Int52Rep:
295     case BooleanToNumber:
296     case FiatInt52:
297     case GetGetter:
298     case GetSetter:
299     case GetEnumerableLength:
300     case HasGenericProperty:
301     case HasStructureProperty:
302     case HasIndexedProperty:
303     case GetDirectPname:
304     case GetPropertyEnumerator:
305     case GetEnumeratorStructurePname:
306     case GetEnumeratorGenericPname:
307     case ToIndexString:
308     case PhantomNewObject:
309     case PhantomNewFunction:
310     case PhantomCreateActivation:
311     case PutHint:
312     case CheckStructureImmediate:
313     case MaterializeNewObject:
314     case MaterializeCreateActivation:
315     case PhantomDirectArguments:
316     case PhantomClonedArguments:
317     case GetMyArgumentByVal:
318     case ForwardVarargs:
319         return true;
320
321     case BottomValue:
322         // If in doubt, assume that this isn't safe to execute, just because we have no way of
323         // compiling this node.
324         return false;
325
326     case GetByVal:
327     case GetIndexedPropertyStorage:
328     case GetArrayLength:
329     case ArrayPush:
330     case ArrayPop:
331     case StringCharAt:
332     case StringCharCodeAt:
333         return node->arrayMode().alreadyChecked(graph, node, state.forNode(node->child1()));
334         
335     case GetTypedArrayByteOffset:
336         return !(state.forNode(node->child1()).m_type & ~(SpecTypedArrayView));
337             
338     case PutByValDirect:
339     case PutByVal:
340     case PutByValAlias:
341         return node->arrayMode().modeForPut().alreadyChecked(
342             graph, node, state.forNode(graph.varArgChild(node, 0)));
343
344     case PutStructure:
345     case AllocatePropertyStorage:
346     case ReallocatePropertyStorage:
347         return state.forNode(node->child1()).m_structure.isSubsetOf(
348             StructureSet(node->transition()->previous));
349         
350     case GetByOffset:
351     case GetGetterSetterByOffset:
352     case PutByOffset: {
353         PropertyOffset offset = node->storageAccessData().offset;
354
355         if (state.structureClobberState() == StructuresAreWatched) {
356             if (JSObject* knownBase = node->child1()->dynamicCastConstant<JSObject*>()) {
357                 if (graph.isSafeToLoad(knownBase, offset))
358                     return true;
359             }
360         }
361         
362         StructureAbstractValue& value = state.forNode(node->child1()).m_structure;
363         if (value.isInfinite())
364             return false;
365         for (unsigned i = value.size(); i--;) {
366             if (!value[i]->isValidOffset(offset))
367                 return false;
368         }
369         return true;
370     }
371         
372     case MultiGetByOffset: {
373         // We can't always guarantee that the MultiGetByOffset is safe to execute if it
374         // contains loads from prototypes. If the load requires a check in IR, which is rare, then
375         // we currently claim that we don't know if it's safe to execute because finding that
376         // check in the abstract state would be hard. If the load requires watchpoints, we just
377         // check if we're not in a clobbered state (i.e. in between a side effect and an
378         // invalidation point).
379         for (const MultiGetByOffsetCase& getCase : node->multiGetByOffsetData().cases) {
380             GetByOffsetMethod method = getCase.method();
381             switch (method.kind()) {
382             case GetByOffsetMethod::Invalid:
383                 RELEASE_ASSERT_NOT_REACHED();
384                 break;
385             case GetByOffsetMethod::Constant: // OK because constants are always safe to execute.
386             case GetByOffsetMethod::Load: // OK because the MultiGetByOffset has its own checks for loading from self.
387                 break;
388             case GetByOffsetMethod::LoadFromPrototype:
389                 // Only OK if the state isn't clobbered. That's almost always the case.
390                 if (state.structureClobberState() != StructuresAreWatched)
391                     return false;
392                 if (!graph.isSafeToLoad(method.prototype()->cast<JSObject*>(), method.offset()))
393                     return false;
394                 break;
395             }
396         }
397         return true;
398     }
399
400     case LastNodeType:
401         RELEASE_ASSERT_NOT_REACHED();
402         return false;
403     }
404     
405     RELEASE_ASSERT_NOT_REACHED();
406     return false;
407 }
408
409 } } // namespace JSC::DFG
410
411 #endif // ENABLE(DFG_JIT)
412
413 #endif // DFGSafeToExecute_h
414