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