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