Re-landing: ES6: Implement RegExp.prototype[@@search].
[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 #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 RegExpObjectUse:
61         case ObjectOrOtherUse:
62         case StringIdentUse:
63         case StringUse:
64         case StringOrOtherUse:
65         case SymbolUse:
66         case StringObjectUse:
67         case StringOrStringObjectUse:
68         case NotStringVarUse:
69         case NotCellUse:
70         case OtherUse:
71         case MiscUse:
72         case MachineIntUse:
73         case DoubleRepMachineIntUse:
74             return;
75             
76         case KnownInt32Use:
77             if (m_state.forNode(edge).m_type & ~SpecInt32)
78                 m_result = false;
79             return;
80
81         case KnownBooleanUse:
82             if (m_state.forNode(edge).m_type & ~SpecBoolean)
83                 m_result = false;
84             return;
85             
86         case KnownCellUse:
87             if (m_state.forNode(edge).m_type & ~SpecCell)
88                 m_result = false;
89             return;
90             
91         case KnownStringUse:
92             if (m_state.forNode(edge).m_type & ~SpecString)
93                 m_result = false;
94             return;
95
96         case KnownPrimitiveUse:
97             if (m_state.forNode(edge).m_type & ~(SpecHeapTop & ~SpecObject))
98                 m_result = false;
99             return;
100             
101         case LastUseKind:
102             RELEASE_ASSERT_NOT_REACHED();
103             break;
104         }
105         RELEASE_ASSERT_NOT_REACHED();
106     }
107     
108     bool result() const { return m_result; }
109 private:
110     AbstractStateType& m_state;
111     bool m_result;
112 };
113
114 // Determines if it's safe to execute a node within the given abstract state. This may
115 // return false conservatively. If it returns true, then you can hoist the given node
116 // up to the given point and expect that it will not crash. It also guarantees that the
117 // node will not produce a malformed JSValue or object pointer when executed in the
118 // given state. But this doesn't guarantee that the node will produce the result you
119 // wanted. For example, you may have a GetByOffset from a prototype that only makes
120 // semantic sense if you've also checked that some nearer prototype doesn't also have
121 // a property of the same name. This could still return true even if that check hadn't
122 // been performed in the given abstract state. That's fine though: the load can still
123 // safely execute before that check, so long as that check continues to guard any
124 // user-observable things done to the loaded value.
125 template<typename AbstractStateType>
126 bool safeToExecute(AbstractStateType& state, Graph& graph, Node* node)
127 {
128     SafeToExecuteEdge<AbstractStateType> safeToExecuteEdge(state);
129     DFG_NODE_DO_TO_CHILDREN(graph, node, safeToExecuteEdge);
130     if (!safeToExecuteEdge.result())
131         return false;
132
133     // NOTE: This tends to lie when it comes to effectful nodes, because it knows that they aren't going to
134     // get hoisted anyway.
135
136     switch (node->op()) {
137     case JSConstant:
138     case DoubleConstant:
139     case Int52Constant:
140     case LazyJSConstant:
141     case Identity:
142     case ToThis:
143     case CreateThis:
144     case GetCallee:
145     case GetArgumentCount:
146     case GetRestLength:
147     case GetLocal:
148     case SetLocal:
149     case PutStack:
150     case KillStack:
151     case GetStack:
152     case MovHint:
153     case ZombieHint:
154     case ExitOK:
155     case Phantom:
156     case Upsilon:
157     case Phi:
158     case Flush:
159     case PhantomLocal:
160     case GetLocalUnlinked:
161     case SetArgument:
162     case BitAnd:
163     case BitOr:
164     case BitXor:
165     case BitLShift:
166     case BitRShift:
167     case BitURShift:
168     case ValueToInt32:
169     case UInt32ToNumber:
170     case DoubleAsInt32:
171     case ArithAdd:
172     case ArithClz32:
173     case ArithSub:
174     case ArithNegate:
175     case ArithMul:
176     case ArithIMul:
177     case ArithDiv:
178     case ArithMod:
179     case ArithAbs:
180     case ArithMin:
181     case ArithMax:
182     case ArithPow:
183     case ArithRandom:
184     case ArithSqrt:
185     case ArithFRound:
186     case ArithRound:
187     case ArithFloor:
188     case ArithCeil:
189     case ArithTrunc:
190     case ArithSin:
191     case ArithCos:
192     case ArithLog:
193     case ValueAdd:
194     case TryGetById:
195     case DeleteById:
196     case GetById:
197     case GetByIdFlush:
198     case PutById:
199     case PutByIdFlush:
200     case PutByIdDirect:
201     case PutGetterById:
202     case PutSetterById:
203     case PutGetterSetterById:
204     case PutGetterByVal:
205     case PutSetterByVal:
206     case CheckStructure:
207     case GetExecutable:
208     case GetButterfly:
209     case CheckArray:
210     case Arrayify:
211     case ArrayifyToStructure:
212     case GetScope:
213     case SkipScope:
214     case GetGlobalObject:
215     case GetClosureVar:
216     case PutClosureVar:
217     case GetGlobalVar:
218     case GetGlobalLexicalVariable:
219     case PutGlobalVariable:
220     case VarInjectionWatchpoint:
221     case CheckCell:
222     case CheckBadCell:
223     case CheckNotEmpty:
224     case CheckIdent:
225     case RegExpExec:
226     case RegExpTest:
227     case CompareLess:
228     case CompareLessEq:
229     case CompareGreater:
230     case CompareGreaterEq:
231     case CompareEq:
232     case CompareStrictEq:
233     case Call:
234     case TailCallInlinedCaller:
235     case Construct:
236     case CallVarargs:
237     case TailCallVarargsInlinedCaller:
238     case TailCallForwardVarargsInlinedCaller:
239     case ConstructVarargs:
240     case LoadVarargs:
241     case CallForwardVarargs:
242     case ConstructForwardVarargs:
243     case NewObject:
244     case NewArray:
245     case NewArrayWithSize:
246     case NewArrayBuffer:
247     case NewRegexp:
248     case ProfileWillCall:
249     case ProfileDidCall:
250     case ProfileType:
251     case ProfileControlFlow:
252     case CheckTypeInfoFlags:
253     case OverridesHasInstance:
254     case InstanceOf:
255     case InstanceOfCustom:
256     case IsArrayObject:
257     case IsJSArray:
258     case IsArrayConstructor:
259     case IsUndefined:
260     case IsBoolean:
261     case IsNumber:
262     case IsString:
263     case IsObject:
264     case IsObjectOrNull:
265     case IsFunction:
266     case IsRegExpObject:
267     case TypeOf:
268     case LogicalNot:
269     case CallObjectConstructor:
270     case ToPrimitive:
271     case ToString:
272     case SetFunctionName:
273     case StrCat:
274     case CallStringConstructor:
275     case NewStringObject:
276     case MakeRope:
277     case In:
278     case CreateActivation:
279     case CreateDirectArguments:
280     case CreateScopedArguments:
281     case CreateClonedArguments:
282     case GetFromArguments:
283     case PutToArguments:
284     case NewFunction:
285     case NewGeneratorFunction:
286     case Jump:
287     case Branch:
288     case Switch:
289     case Return:
290     case TailCall:
291     case TailCallVarargs:
292     case TailCallForwardVarargs:
293     case Throw:
294     case ThrowReferenceError:
295     case CountExecution:
296     case ForceOSRExit:
297     case CheckWatchdogTimer:
298     case LogShadowChickenPrologue:
299     case LogShadowChickenTail:
300     case StringFromCharCode:
301     case NewTypedArray:
302     case Unreachable:
303     case ExtractOSREntryLocal:
304     case CheckTierUpInLoop:
305     case CheckTierUpAtReturn:
306     case CheckTierUpAndOSREnter:
307     case LoopHint:
308     case StoreBarrier:
309     case InvalidationPoint:
310     case NotifyWrite:
311     case CheckInBounds:
312     case ConstantStoragePointer:
313     case Check:
314     case MultiPutByOffset:
315     case ValueRep:
316     case DoubleRep:
317     case Int52Rep:
318     case BooleanToNumber:
319     case FiatInt52:
320     case GetGetter:
321     case GetSetter:
322     case GetEnumerableLength:
323     case HasGenericProperty:
324     case HasStructureProperty:
325     case HasIndexedProperty:
326     case GetDirectPname:
327     case GetPropertyEnumerator:
328     case GetEnumeratorStructurePname:
329     case GetEnumeratorGenericPname:
330     case ToIndexString:
331     case PhantomNewObject:
332     case PhantomNewFunction:
333     case PhantomNewGeneratorFunction:
334     case PhantomCreateActivation:
335     case PutHint:
336     case CheckStructureImmediate:
337     case MaterializeNewObject:
338     case MaterializeCreateActivation:
339     case PhantomDirectArguments:
340     case PhantomClonedArguments:
341     case GetMyArgumentByVal:
342     case ForwardVarargs:
343     case CopyRest:
344     case StringReplace:
345     case GetRegExpObjectLastIndex:
346     case SetRegExpObjectLastIndex:
347     case RecordRegExpCachedResult:
348     case GetDynamicVar:
349     case PutDynamicVar:
350     case ResolveScope:
351         return true;
352
353     case BottomValue:
354         // If in doubt, assume that this isn't safe to execute, just because we have no way of
355         // compiling this node.
356         return false;
357
358     case GetByVal:
359     case GetIndexedPropertyStorage:
360     case GetArrayLength:
361     case ArrayPush:
362     case ArrayPop:
363     case StringCharAt:
364     case StringCharCodeAt:
365         return node->arrayMode().alreadyChecked(graph, node, state.forNode(node->child1()));
366         
367     case GetTypedArrayByteOffset:
368         return !(state.forNode(node->child1()).m_type & ~(SpecTypedArrayView));
369             
370     case PutByValDirect:
371     case PutByVal:
372     case PutByValAlias:
373         return node->arrayMode().modeForPut().alreadyChecked(
374             graph, node, state.forNode(graph.varArgChild(node, 0)));
375
376     case PutStructure:
377     case AllocatePropertyStorage:
378     case ReallocatePropertyStorage:
379         return state.forNode(node->child1()).m_structure.isSubsetOf(
380             StructureSet(node->transition()->previous));
381         
382     case GetByOffset:
383     case GetGetterSetterByOffset:
384     case PutByOffset: {
385         PropertyOffset offset = node->storageAccessData().offset;
386
387         if (state.structureClobberState() == StructuresAreWatched) {
388             if (JSObject* knownBase = node->child1()->dynamicCastConstant<JSObject*>()) {
389                 if (graph.isSafeToLoad(knownBase, offset))
390                     return true;
391             }
392         }
393         
394         StructureAbstractValue& value = state.forNode(node->child1()).m_structure;
395         if (value.isInfinite())
396             return false;
397         for (unsigned i = value.size(); i--;) {
398             if (!value[i]->isValidOffset(offset))
399                 return false;
400         }
401         return true;
402     }
403         
404     case MultiGetByOffset: {
405         // We can't always guarantee that the MultiGetByOffset is safe to execute if it
406         // contains loads from prototypes. If the load requires a check in IR, which is rare, then
407         // we currently claim that we don't know if it's safe to execute because finding that
408         // check in the abstract state would be hard. If the load requires watchpoints, we just
409         // check if we're not in a clobbered state (i.e. in between a side effect and an
410         // invalidation point).
411         for (const MultiGetByOffsetCase& getCase : node->multiGetByOffsetData().cases) {
412             GetByOffsetMethod method = getCase.method();
413             switch (method.kind()) {
414             case GetByOffsetMethod::Invalid:
415                 RELEASE_ASSERT_NOT_REACHED();
416                 break;
417             case GetByOffsetMethod::Constant: // OK because constants are always safe to execute.
418             case GetByOffsetMethod::Load: // OK because the MultiGetByOffset has its own checks for loading from self.
419                 break;
420             case GetByOffsetMethod::LoadFromPrototype:
421                 // Only OK if the state isn't clobbered. That's almost always the case.
422                 if (state.structureClobberState() != StructuresAreWatched)
423                     return false;
424                 if (!graph.isSafeToLoad(method.prototype()->cast<JSObject*>(), method.offset()))
425                     return false;
426                 break;
427             }
428         }
429         return true;
430     }
431
432     case LastNodeType:
433         RELEASE_ASSERT_NOT_REACHED();
434         return false;
435     }
436     
437     RELEASE_ASSERT_NOT_REACHED();
438     return false;
439 }
440
441 } } // namespace JSC::DFG
442
443 #endif // ENABLE(DFG_JIT)
444
445 #endif // DFGSafeToExecute_h
446