implement op_get_rest_length so that we can allocate the rest array with the right...
[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 GetRestLength:
144     case GetLocal:
145     case SetLocal:
146     case PutStack:
147     case KillStack:
148     case GetStack:
149     case MovHint:
150     case ZombieHint:
151     case ExitOK:
152     case Phantom:
153     case Upsilon:
154     case Phi:
155     case Flush:
156     case PhantomLocal:
157     case GetLocalUnlinked:
158     case SetArgument:
159     case BitAnd:
160     case BitOr:
161     case BitXor:
162     case BitLShift:
163     case BitRShift:
164     case BitURShift:
165     case ValueToInt32:
166     case UInt32ToNumber:
167     case DoubleAsInt32:
168     case ArithAdd:
169     case ArithClz32:
170     case ArithSub:
171     case ArithNegate:
172     case ArithMul:
173     case ArithIMul:
174     case ArithDiv:
175     case ArithMod:
176     case ArithAbs:
177     case ArithMin:
178     case ArithMax:
179     case ArithPow:
180     case ArithSqrt:
181     case ArithFRound:
182     case ArithRound:
183     case ArithSin:
184     case ArithCos:
185     case ArithLog:
186     case ValueAdd:
187     case GetById:
188     case GetByIdFlush:
189     case PutById:
190     case PutByIdFlush:
191     case PutByIdDirect:
192     case PutGetterById:
193     case PutSetterById:
194     case PutGetterSetterById:
195     case PutGetterByVal:
196     case PutSetterByVal:
197     case CheckStructure:
198     case GetExecutable:
199     case GetButterfly:
200     case GetButterflyReadOnly:
201     case CheckArray:
202     case Arrayify:
203     case ArrayifyToStructure:
204     case GetScope:
205     case LoadArrowFunctionThis:
206     case SkipScope:
207     case GetClosureVar:
208     case PutClosureVar:
209     case GetGlobalVar:
210     case GetGlobalLexicalVariable:
211     case PutGlobalVariable:
212     case VarInjectionWatchpoint:
213     case CheckCell:
214     case CheckBadCell:
215     case CheckNotEmpty:
216     case CheckIdent:
217     case RegExpExec:
218     case RegExpTest:
219     case CompareLess:
220     case CompareLessEq:
221     case CompareGreater:
222     case CompareGreaterEq:
223     case CompareEq:
224     case CompareStrictEq:
225     case Call:
226     case TailCallInlinedCaller:
227     case Construct:
228     case CallVarargs:
229     case TailCallVarargsInlinedCaller:
230     case TailCallForwardVarargsInlinedCaller:
231     case ConstructVarargs:
232     case LoadVarargs:
233     case CallForwardVarargs:
234     case ConstructForwardVarargs:
235     case NewObject:
236     case NewArray:
237     case NewArrayWithSize:
238     case NewArrayBuffer:
239     case NewRegexp:
240     case Breakpoint:
241     case ProfileWillCall:
242     case ProfileDidCall:
243     case ProfileType:
244     case ProfileControlFlow:
245     case CheckHasInstance:
246     case InstanceOf:
247     case IsUndefined:
248     case IsBoolean:
249     case IsNumber:
250     case IsString:
251     case IsObject:
252     case IsObjectOrNull:
253     case IsFunction:
254     case TypeOf:
255     case LogicalNot:
256     case ToPrimitive:
257     case ToString:
258     case StrCat:
259     case CallStringConstructor:
260     case NewStringObject:
261     case MakeRope:
262     case In:
263     case CreateActivation:
264     case CreateDirectArguments:
265     case CreateScopedArguments:
266     case CreateClonedArguments:
267     case GetFromArguments:
268     case PutToArguments:
269     case NewArrowFunction:
270     case NewFunction:
271     case Jump:
272     case Branch:
273     case Switch:
274     case Return:
275     case TailCall:
276     case TailCallVarargs:
277     case TailCallForwardVarargs:
278     case Throw:
279     case ThrowReferenceError:
280     case CountExecution:
281     case ForceOSRExit:
282     case CheckWatchdogTimer:
283     case StringFromCharCode:
284     case NewTypedArray:
285     case Unreachable:
286     case ExtractOSREntryLocal:
287     case CheckTierUpInLoop:
288     case CheckTierUpAtReturn:
289     case CheckTierUpAndOSREnter:
290     case CheckTierUpWithNestedTriggerAndOSREnter:
291     case LoopHint:
292     case StoreBarrier:
293     case InvalidationPoint:
294     case NotifyWrite:
295     case CheckInBounds:
296     case ConstantStoragePointer:
297     case Check:
298     case MultiPutByOffset:
299     case ValueRep:
300     case DoubleRep:
301     case Int52Rep:
302     case BooleanToNumber:
303     case FiatInt52:
304     case GetGetter:
305     case GetSetter:
306     case GetEnumerableLength:
307     case HasGenericProperty:
308     case HasStructureProperty:
309     case HasIndexedProperty:
310     case GetDirectPname:
311     case GetPropertyEnumerator:
312     case GetEnumeratorStructurePname:
313     case GetEnumeratorGenericPname:
314     case ToIndexString:
315     case PhantomNewObject:
316     case PhantomNewFunction:
317     case PhantomCreateActivation:
318     case PutHint:
319     case CheckStructureImmediate:
320     case MaterializeNewObject:
321     case MaterializeCreateActivation:
322     case PhantomDirectArguments:
323     case PhantomClonedArguments:
324     case GetMyArgumentByVal:
325     case ForwardVarargs:
326     case CopyRest:
327         return true;
328
329     case BottomValue:
330         // If in doubt, assume that this isn't safe to execute, just because we have no way of
331         // compiling this node.
332         return false;
333
334     case GetByVal:
335     case GetIndexedPropertyStorage:
336     case GetArrayLength:
337     case ArrayPush:
338     case ArrayPop:
339     case StringCharAt:
340     case StringCharCodeAt:
341         return node->arrayMode().alreadyChecked(graph, node, state.forNode(node->child1()));
342         
343     case GetTypedArrayByteOffset:
344         return !(state.forNode(node->child1()).m_type & ~(SpecTypedArrayView));
345             
346     case PutByValDirect:
347     case PutByVal:
348     case PutByValAlias:
349         return node->arrayMode().modeForPut().alreadyChecked(
350             graph, node, state.forNode(graph.varArgChild(node, 0)));
351
352     case PutStructure:
353     case AllocatePropertyStorage:
354     case ReallocatePropertyStorage:
355         return state.forNode(node->child1()).m_structure.isSubsetOf(
356             StructureSet(node->transition()->previous));
357         
358     case GetByOffset:
359     case GetGetterSetterByOffset:
360     case PutByOffset: {
361         PropertyOffset offset = node->storageAccessData().offset;
362
363         if (state.structureClobberState() == StructuresAreWatched) {
364             if (JSObject* knownBase = node->child1()->dynamicCastConstant<JSObject*>()) {
365                 if (graph.isSafeToLoad(knownBase, offset))
366                     return true;
367             }
368         }
369         
370         StructureAbstractValue& value = state.forNode(node->child1()).m_structure;
371         if (value.isInfinite())
372             return false;
373         for (unsigned i = value.size(); i--;) {
374             if (!value[i]->isValidOffset(offset))
375                 return false;
376         }
377         return true;
378     }
379         
380     case MultiGetByOffset: {
381         // We can't always guarantee that the MultiGetByOffset is safe to execute if it
382         // contains loads from prototypes. If the load requires a check in IR, which is rare, then
383         // we currently claim that we don't know if it's safe to execute because finding that
384         // check in the abstract state would be hard. If the load requires watchpoints, we just
385         // check if we're not in a clobbered state (i.e. in between a side effect and an
386         // invalidation point).
387         for (const MultiGetByOffsetCase& getCase : node->multiGetByOffsetData().cases) {
388             GetByOffsetMethod method = getCase.method();
389             switch (method.kind()) {
390             case GetByOffsetMethod::Invalid:
391                 RELEASE_ASSERT_NOT_REACHED();
392                 break;
393             case GetByOffsetMethod::Constant: // OK because constants are always safe to execute.
394             case GetByOffsetMethod::Load: // OK because the MultiGetByOffset has its own checks for loading from self.
395                 break;
396             case GetByOffsetMethod::LoadFromPrototype:
397                 // Only OK if the state isn't clobbered. That's almost always the case.
398                 if (state.structureClobberState() != StructuresAreWatched)
399                     return false;
400                 if (!graph.isSafeToLoad(method.prototype()->cast<JSObject*>(), method.offset()))
401                     return false;
402                 break;
403             }
404         }
405         return true;
406     }
407
408     case LastNodeType:
409         RELEASE_ASSERT_NOT_REACHED();
410         return false;
411     }
412     
413     RELEASE_ASSERT_NOT_REACHED();
414     return false;
415 }
416
417 } } // namespace JSC::DFG
418
419 #endif // ENABLE(DFG_JIT)
420
421 #endif // DFGSafeToExecute_h
422