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