[DFG] Add ArrayIndexOf intrinsic
[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         , 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 ArithUnary:
195     case ValueAdd:
196     case TryGetById:
197     case DeleteById:
198     case DeleteByVal:
199     case GetById:
200     case GetByIdWithThis:
201     case GetByValWithThis:
202     case GetByIdFlush:
203     case PutById:
204     case PutByIdFlush:
205     case PutByIdWithThis:
206     case PutByValWithThis:
207     case PutByIdDirect:
208     case PutGetterById:
209     case PutSetterById:
210     case PutGetterSetterById:
211     case PutGetterByVal:
212     case PutSetterByVal:
213     case DefineDataProperty:
214     case DefineAccessorProperty:
215     case CheckStructure:
216     case GetExecutable:
217     case GetButterfly:
218     case CallDOMGetter:
219     case CallDOM:
220     case CheckSubClass:
221     case CheckArray:
222     case Arrayify:
223     case ArrayifyToStructure:
224     case GetScope:
225     case SkipScope:
226     case GetGlobalObject:
227     case GetClosureVar:
228     case PutClosureVar:
229     case GetGlobalVar:
230     case GetGlobalLexicalVariable:
231     case PutGlobalVariable:
232     case CheckCell:
233     case CheckBadCell:
234     case CheckNotEmpty:
235     case CheckStringIdent:
236     case RegExpExec:
237     case RegExpTest:
238     case CompareLess:
239     case CompareLessEq:
240     case CompareGreater:
241     case CompareGreaterEq:
242     case CompareEq:
243     case CompareStrictEq:
244     case CompareEqPtr:
245     case Call:
246     case DirectCall:
247     case TailCallInlinedCaller:
248     case DirectTailCallInlinedCaller:
249     case Construct:
250     case DirectConstruct:
251     case CallVarargs:
252     case CallEval:
253     case TailCallVarargsInlinedCaller:
254     case TailCallForwardVarargsInlinedCaller:
255     case ConstructVarargs:
256     case LoadVarargs:
257     case CallForwardVarargs:
258     case ConstructForwardVarargs:
259     case NewObject:
260     case NewArray:
261     case NewArrayWithSize:
262     case NewArrayBuffer:
263     case NewArrayWithSpread:
264     case Spread:
265     case NewRegexp:
266     case ProfileType:
267     case ProfileControlFlow:
268     case CheckTypeInfoFlags:
269     case ParseInt:
270     case OverridesHasInstance:
271     case InstanceOf:
272     case InstanceOfCustom:
273     case IsEmpty:
274     case IsUndefined:
275     case IsBoolean:
276     case IsNumber:
277     case IsObject:
278     case IsObjectOrNull:
279     case IsFunction:
280     case IsCellWithType:
281     case IsTypedArrayView:
282     case TypeOf:
283     case LogicalNot:
284     case CallObjectConstructor:
285     case ToPrimitive:
286     case ToString:
287     case ToNumber:
288     case NumberToStringWithRadix:
289     case SetFunctionName:
290     case StrCat:
291     case CallStringConstructor:
292     case NewStringObject:
293     case MakeRope:
294     case In:
295     case HasOwnProperty:
296     case CreateActivation:
297     case CreateDirectArguments:
298     case CreateScopedArguments:
299     case CreateClonedArguments:
300     case GetFromArguments:
301     case GetArgument:
302     case PutToArguments:
303     case NewFunction:
304     case NewGeneratorFunction:
305     case NewAsyncFunction:
306     case Jump:
307     case Branch:
308     case Switch:
309     case Return:
310     case TailCall:
311     case DirectTailCall:
312     case TailCallVarargs:
313     case TailCallForwardVarargs:
314     case Throw:
315     case ThrowStaticError:
316     case CountExecution:
317     case ForceOSRExit:
318     case CheckTraps:
319     case LogShadowChickenPrologue:
320     case LogShadowChickenTail:
321     case StringFromCharCode:
322     case NewTypedArray:
323     case Unreachable:
324     case ExtractOSREntryLocal:
325     case CheckTierUpInLoop:
326     case CheckTierUpAtReturn:
327     case CheckTierUpAndOSREnter:
328     case LoopHint:
329     case InvalidationPoint:
330     case NotifyWrite:
331     case CheckInBounds:
332     case ConstantStoragePointer:
333     case Check:
334     case MultiPutByOffset:
335     case ValueRep:
336     case DoubleRep:
337     case Int52Rep:
338     case BooleanToNumber:
339     case FiatInt52:
340     case GetGetter:
341     case GetSetter:
342     case GetEnumerableLength:
343     case HasGenericProperty:
344     case HasStructureProperty:
345     case HasIndexedProperty:
346     case GetDirectPname:
347     case GetPropertyEnumerator:
348     case GetEnumeratorStructurePname:
349     case GetEnumeratorGenericPname:
350     case ToIndexString:
351     case PhantomNewObject:
352     case PhantomNewFunction:
353     case PhantomNewGeneratorFunction:
354     case PhantomNewAsyncFunction:
355     case PhantomCreateActivation:
356     case PutHint:
357     case CheckStructureImmediate:
358     case MaterializeNewObject:
359     case MaterializeCreateActivation:
360     case PhantomDirectArguments:
361     case PhantomCreateRest:
362     case PhantomSpread:
363     case PhantomNewArrayWithSpread:
364     case PhantomClonedArguments:
365     case GetMyArgumentByVal:
366     case GetMyArgumentByValOutOfBounds:
367     case ForwardVarargs:
368     case CreateRest:
369     case StringReplace:
370     case StringReplaceRegExp:
371     case GetRegExpObjectLastIndex:
372     case SetRegExpObjectLastIndex:
373     case RecordRegExpCachedResult:
374     case GetDynamicVar:
375     case PutDynamicVar:
376     case ResolveScopeForHoistingFuncDeclInEval:
377     case ResolveScope:
378     case MapHash:
379     case ToLowerCase:
380     case GetMapBucket:
381     case LoadFromJSMapBucket:
382     case IsNonEmptyMapBucket:
383     case AtomicsAdd:
384     case AtomicsAnd:
385     case AtomicsCompareExchange:
386     case AtomicsExchange:
387     case AtomicsLoad:
388     case AtomicsOr:
389     case AtomicsStore:
390     case AtomicsSub:
391     case AtomicsXor:
392     case AtomicsIsLockFree:
393         return true;
394
395     case ArraySlice:
396     case ArrayIndexOf: {
397         // You could plausibly move this code around as long as you proved the
398         // incoming array base structure is an original array at the hoisted location.
399         // Instead of doing that extra work, we just conservatively return false.
400         return false;
401     }
402
403     case BottomValue:
404         // If in doubt, assume that this isn't safe to execute, just because we have no way of
405         // compiling this node.
406         return false;
407
408     case StoreBarrier:
409     case FencedStoreBarrier:
410     case PutStructure:
411     case NukeStructureAndSetButterfly:
412         // We conservatively assume that these cannot be put anywhere, which forces the compiler to
413         // keep them exactly where they were. This is sort of overkill since the clobberize effects
414         // already force these things to be ordered precisely. I'm just not confident enough in my
415         // effect based memory model to rely solely on that right now.
416         return false;
417
418     case GetByVal:
419     case GetIndexedPropertyStorage:
420     case GetArrayLength:
421     case GetVectorLength:
422     case ArrayPush:
423     case ArrayPop:
424     case StringCharAt:
425     case StringCharCodeAt:
426         return node->arrayMode().alreadyChecked(graph, node, state.forNode(node->child1()));
427         
428     case GetTypedArrayByteOffset:
429         return !(state.forNode(node->child1()).m_type & ~(SpecTypedArrayView));
430             
431     case PutByValDirect:
432     case PutByVal:
433     case PutByValAlias:
434         return node->arrayMode().modeForPut().alreadyChecked(
435             graph, node, state.forNode(graph.varArgChild(node, 0)));
436
437     case AllocatePropertyStorage:
438     case ReallocatePropertyStorage:
439         return state.forNode(node->child1()).m_structure.isSubsetOf(
440             RegisteredStructureSet(node->transition()->previous));
441         
442     case GetByOffset:
443     case GetGetterSetterByOffset:
444     case PutByOffset: {
445         PropertyOffset offset = node->storageAccessData().offset;
446
447         if (state.structureClobberState() == StructuresAreWatched) {
448             if (JSObject* knownBase = node->child1()->dynamicCastConstant<JSObject*>(graph.m_vm)) {
449                 if (graph.isSafeToLoad(knownBase, offset))
450                     return true;
451             }
452         }
453         
454         StructureAbstractValue& value = state.forNode(node->child1()).m_structure;
455         if (value.isInfinite())
456             return false;
457         for (unsigned i = value.size(); i--;) {
458             if (!value[i]->isValidOffset(offset))
459                 return false;
460         }
461         return true;
462     }
463         
464     case MultiGetByOffset: {
465         // We can't always guarantee that the MultiGetByOffset is safe to execute if it
466         // contains loads from prototypes. If the load requires a check in IR, which is rare, then
467         // we currently claim that we don't know if it's safe to execute because finding that
468         // check in the abstract state would be hard. If the load requires watchpoints, we just
469         // check if we're not in a clobbered state (i.e. in between a side effect and an
470         // invalidation point).
471         for (const MultiGetByOffsetCase& getCase : node->multiGetByOffsetData().cases) {
472             GetByOffsetMethod method = getCase.method();
473             switch (method.kind()) {
474             case GetByOffsetMethod::Invalid:
475                 RELEASE_ASSERT_NOT_REACHED();
476                 break;
477             case GetByOffsetMethod::Constant: // OK because constants are always safe to execute.
478             case GetByOffsetMethod::Load: // OK because the MultiGetByOffset has its own checks for loading from self.
479                 break;
480             case GetByOffsetMethod::LoadFromPrototype:
481                 // Only OK if the state isn't clobbered. That's almost always the case.
482                 if (state.structureClobberState() != StructuresAreWatched)
483                     return false;
484                 if (!graph.isSafeToLoad(method.prototype()->cast<JSObject*>(), method.offset()))
485                     return false;
486                 break;
487             }
488         }
489         return true;
490     }
491
492     case LastNodeType:
493         RELEASE_ASSERT_NOT_REACHED();
494         return false;
495     }
496     
497     RELEASE_ASSERT_NOT_REACHED();
498     return false;
499 }
500
501 } } // namespace JSC::DFG
502
503 #endif // ENABLE(DFG_JIT)