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