We should have a way of profiling when a get_by_id is pure and to emit a PureGetById...
[WebKit-https.git] / Source / JavaScriptCore / ftl / FTLCapabilities.cpp
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 #include "config.h"
27 #include "FTLCapabilities.h"
28
29 #if ENABLE(FTL_JIT)
30
31 namespace JSC { namespace FTL {
32
33 using namespace DFG;
34
35 static bool verboseCapabilities()
36 {
37     return verboseCompilationEnabled() || Options::verboseFTLFailure();
38 }
39
40 inline CapabilityLevel canCompile(Node* node)
41 {
42     // NOTE: If we ever have phantom arguments, we can compile them but we cannot
43     // OSR enter.
44     
45     switch (node->op()) {
46     case JSConstant:
47     case LazyJSConstant:
48     case GetLocal:
49     case SetLocal:
50     case PutStack:
51     case KillStack:
52     case GetStack:
53     case MovHint:
54     case ZombieHint:
55     case ExitOK:
56     case Phantom:
57     case Flush:
58     case PhantomLocal:
59     case SetArgument:
60     case Return:
61     case BitAnd:
62     case BitOr:
63     case BitXor:
64     case BitRShift:
65     case BitLShift:
66     case BitURShift:
67     case CheckStructure:
68     case DoubleAsInt32:
69     case ArrayifyToStructure:
70     case PutStructure:
71     case GetButterfly:
72     case NewObject:
73     case NewArray:
74     case NewArrayBuffer:
75     case NewTypedArray:
76     case GetByOffset:
77     case GetGetterSetterByOffset:
78     case GetGetter:
79     case GetSetter:
80     case PutByOffset:
81     case GetGlobalVar:
82     case GetGlobalLexicalVariable:
83     case PutGlobalVariable:
84     case ValueAdd:
85     case StrCat:
86     case ArithAdd:
87     case ArithClz32:
88     case ArithSub:
89     case ArithMul:
90     case ArithDiv:
91     case ArithMod:
92     case ArithMin:
93     case ArithMax:
94     case ArithAbs:
95     case ArithSin:
96     case ArithCos:
97     case ArithTan:
98     case ArithPow:
99     case ArithRandom:
100     case ArithRound:
101     case ArithFloor:
102     case ArithCeil:
103     case ArithTrunc:
104     case ArithSqrt:
105     case ArithLog:
106     case ArithFRound:
107     case ArithNegate:
108     case UInt32ToNumber:
109     case Jump:
110     case ForceOSRExit:
111     case Phi:
112     case Upsilon:
113     case ExtractOSREntryLocal:
114     case LoopHint:
115     case SkipScope:
116     case GetGlobalObject:
117     case CreateActivation:
118     case NewFunction:
119     case NewGeneratorFunction:
120     case GetClosureVar:
121     case PutClosureVar:
122     case CreateDirectArguments:
123     case CreateScopedArguments:
124     case CreateClonedArguments:
125     case GetFromArguments:
126     case PutToArguments:
127     case InvalidationPoint:
128     case StringCharAt:
129     case CheckCell:
130     case CheckBadCell:
131     case CheckNotEmpty:
132     case CheckStringIdent:
133     case CheckWatchdogTimer:
134     case StringCharCodeAt:
135     case StringFromCharCode:
136     case AllocatePropertyStorage:
137     case ReallocatePropertyStorage:
138     case GetTypedArrayByteOffset:
139     case NotifyWrite:
140     case StoreBarrier:
141     case FencedStoreBarrier:
142     case Call:
143     case DirectCall:
144     case TailCall:
145     case DirectTailCall:
146     case TailCallInlinedCaller:
147     case DirectTailCallInlinedCaller:
148     case Construct:
149     case DirectConstruct:
150     case CallVarargs:
151     case CallEval:
152     case TailCallVarargs:
153     case TailCallVarargsInlinedCaller:
154     case ConstructVarargs:
155     case CallForwardVarargs:
156     case TailCallForwardVarargs:
157     case TailCallForwardVarargsInlinedCaller:
158     case ConstructForwardVarargs:
159     case LoadVarargs:
160     case ValueToInt32:
161     case Branch:
162     case LogicalNot:
163     case CheckInBounds:
164     case ConstantStoragePointer:
165     case Check:
166     case CountExecution:
167     case GetExecutable:
168     case GetScope:
169     case GetCallee:
170     case GetArgumentCountIncludingThis:
171     case ToNumber:
172     case ToString:
173     case CallObjectConstructor:
174     case CallStringConstructor:
175     case MakeRope:
176     case NewArrayWithSize:
177     case TryGetById:
178     case GetById:
179     case PureGetById:
180     case GetByIdFlush:
181     case GetByIdWithThis:
182     case ToThis:
183     case MultiGetByOffset:
184     case MultiPutByOffset:
185     case ToPrimitive:
186     case Throw:
187     case ThrowStaticError:
188     case Unreachable:
189     case In:
190     case HasOwnProperty:
191     case IsCellWithType:
192     case MapHash:
193     case GetMapBucket:
194     case LoadFromJSMapBucket:
195     case IsNonEmptyMapBucket:
196     case IsEmpty:
197     case IsUndefined:
198     case IsBoolean:
199     case IsNumber:
200     case IsObject:
201     case IsObjectOrNull:
202     case IsFunction:
203     case IsTypedArrayView:
204     case CheckTypeInfoFlags:
205     case OverridesHasInstance:
206     case InstanceOf:
207     case InstanceOfCustom:
208     case DoubleRep:
209     case ValueRep:
210     case Int52Rep:
211     case DoubleConstant:
212     case Int52Constant:
213     case BooleanToNumber:
214     case HasGenericProperty:
215     case HasStructureProperty:
216     case GetDirectPname:
217     case GetEnumerableLength:
218     case GetIndexedPropertyStorage:
219     case GetPropertyEnumerator:
220     case GetEnumeratorStructurePname:
221     case GetEnumeratorGenericPname:
222     case ToIndexString:
223     case BottomValue:
224     case PhantomNewObject:
225     case PhantomNewFunction:
226     case PhantomNewGeneratorFunction:
227     case PhantomCreateActivation:
228     case PutHint:
229     case CheckStructureImmediate:
230     case MaterializeNewObject:
231     case MaterializeCreateActivation:
232     case PhantomDirectArguments:
233     case PhantomClonedArguments:
234     case GetMyArgumentByVal:
235     case GetMyArgumentByValOutOfBounds:
236     case ForwardVarargs:
237     case Switch:
238     case TypeOf:
239     case PutById:
240     case PutByIdDirect:
241     case PutByIdFlush:
242     case PutByIdWithThis:
243     case PutGetterById:
244     case PutSetterById:
245     case PutGetterSetterById:
246     case PutGetterByVal:
247     case PutSetterByVal:
248     case CreateRest:
249     case GetRestLength:
250     case RegExpExec:
251     case RegExpTest:
252     case NewRegexp:
253     case StringReplace:
254     case StringReplaceRegExp: 
255     case GetRegExpObjectLastIndex:
256     case SetRegExpObjectLastIndex:
257     case RecordRegExpCachedResult:
258     case SetFunctionName:
259     case LogShadowChickenPrologue:
260     case LogShadowChickenTail:
261     case ResolveScope:
262     case GetDynamicVar:
263     case PutDynamicVar:
264     case CompareEq:
265     case CompareEqPtr:
266     case CompareLess:
267     case CompareLessEq:
268     case CompareGreater:
269     case CompareGreaterEq:
270     case CompareStrictEq:
271     case DefineDataProperty:
272     case DefineAccessorProperty:
273     case ToLowerCase:
274     case CheckDOM:
275     case CallDOMGetter:
276         // These are OK.
277         break;
278
279     case Identity:
280         // No backend handles this because it will be optimized out. But we may check
281         // for capabilities before optimization. It would be a deep error to remove this
282         // case because it would prevent us from catching bugs where the FTL backend
283         // pipeline failed to optimize out an Identity.
284         break;
285     case CheckArray:
286         switch (node->arrayMode().type()) {
287         case Array::Int32:
288         case Array::Double:
289         case Array::Contiguous:
290         case Array::DirectArguments:
291         case Array::ScopedArguments:
292             break;
293         default:
294             if (isTypedView(node->arrayMode().typedArrayType()))
295                 break;
296             return CannotCompile;
297         }
298         break;
299     case GetArrayLength:
300         switch (node->arrayMode().type()) {
301         case Array::Undecided:
302         case Array::Int32:
303         case Array::Double:
304         case Array::Contiguous:
305         case Array::String:
306         case Array::DirectArguments:
307         case Array::ScopedArguments:
308             break;
309         default:
310             if (node->arrayMode().isSomeTypedArrayView())
311                 break;
312             return CannotCompile;
313         }
314         break;
315     case HasIndexedProperty:
316         switch (node->arrayMode().type()) {
317         case Array::ForceExit:
318         case Array::Int32:
319         case Array::Double:
320         case Array::Contiguous:
321             break;
322         default:
323             return CannotCompile;
324         }
325         break;
326     case GetByVal:
327         switch (node->arrayMode().type()) {
328         case Array::ForceExit:
329         case Array::Generic:
330         case Array::String:
331         case Array::Int32:
332         case Array::Double:
333         case Array::Contiguous:
334         case Array::Undecided:
335         case Array::DirectArguments:
336         case Array::ScopedArguments:
337             break;
338         default:
339             if (isTypedView(node->arrayMode().typedArrayType()))
340                 return CanCompileAndOSREnter;
341             return CannotCompile;
342         }
343         break;
344     case GetByValWithThis:
345         break;
346     case PutByVal:
347     case PutByValAlias:
348     case PutByValDirect:
349         switch (node->arrayMode().type()) {
350         case Array::ForceExit:
351         case Array::Generic:
352         case Array::Int32:
353         case Array::Double:
354         case Array::Contiguous:
355             break;
356         default:
357             if (isTypedView(node->arrayMode().typedArrayType()))
358                 return CanCompileAndOSREnter;
359             return CannotCompile;
360         }
361         break;
362     case PutByValWithThis:
363         break;
364     case ArrayPush:
365     case ArrayPop:
366         switch (node->arrayMode().type()) {
367         case Array::Int32:
368         case Array::Contiguous:
369         case Array::Double:
370             break;
371         default:
372             return CannotCompile;
373         }
374         break;
375     default:
376         // Don't know how to handle anything else.
377         return CannotCompile;
378     }
379     return CanCompileAndOSREnter;
380 }
381
382 CapabilityLevel canCompile(Graph& graph)
383 {
384     if (graph.m_codeBlock->instructionCount() > Options::maximumFTLCandidateInstructionCount()) {
385         if (verboseCapabilities())
386             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it's too big.\n");
387         return CannotCompile;
388     }
389     
390     if (graph.m_codeBlock->codeType() != FunctionCode) {
391         if (verboseCapabilities())
392             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it doesn't belong to a function.\n");
393         return CannotCompile;
394     }
395
396     if (UNLIKELY(graph.m_codeBlock->ownerScriptExecutable()->neverFTLOptimize())) {
397         if (verboseCapabilities())
398             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it is marked as never FTL compile.\n");
399         return CannotCompile;
400     }
401     
402     CapabilityLevel result = CanCompileAndOSREnter;
403     
404     for (BlockIndex blockIndex = graph.numBlocks(); blockIndex--;) {
405         BasicBlock* block = graph.block(blockIndex);
406         if (!block)
407             continue;
408         
409         // We don't care if we can compile blocks that the CFA hasn't visited.
410         if (!block->cfaHasVisited)
411             continue;
412         
413         for (unsigned nodeIndex = 0; nodeIndex < block->size(); ++nodeIndex) {
414             Node* node = block->at(nodeIndex);
415             
416             for (unsigned childIndex = graph.numChildren(node); childIndex--;) {
417                 Edge edge = graph.child(node, childIndex);
418                 if (!edge)
419                     continue;
420                 switch (edge.useKind()) {
421                 case UntypedUse:
422                 case Int32Use:
423                 case KnownInt32Use:
424                 case Int52RepUse:
425                 case NumberUse:
426                 case RealNumberUse:
427                 case DoubleRepUse:
428                 case DoubleRepRealUse:
429                 case BooleanUse:
430                 case KnownBooleanUse:
431                 case CellUse:
432                 case KnownCellUse:
433                 case CellOrOtherUse:
434                 case ObjectUse:
435                 case ArrayUse:
436                 case FunctionUse:
437                 case ObjectOrOtherUse:
438                 case StringUse:
439                 case StringOrOtherUse:
440                 case KnownStringUse:
441                 case KnownPrimitiveUse:
442                 case StringObjectUse:
443                 case StringOrStringObjectUse:
444                 case SymbolUse:
445                 case MapObjectUse:
446                 case SetObjectUse:
447                 case FinalObjectUse:
448                 case RegExpObjectUse:
449                 case ProxyObjectUse:
450                 case DerivedArrayUse:
451                 case NotCellUse:
452                 case OtherUse:
453                 case MiscUse:
454                 case StringIdentUse:
455                 case NotStringVarUse:
456                 case AnyIntUse:
457                 case DoubleRepAnyIntUse:
458                     // These are OK.
459                     break;
460                 default:
461                     // Don't know how to handle anything else.
462                     if (verboseCapabilities()) {
463                         dataLog("FTL rejecting node in ", *graph.m_codeBlock, " because of bad use kind: ", edge.useKind(), " in node:\n");
464                         graph.dump(WTF::dataFile(), "    ", node);
465                     }
466                     return CannotCompile;
467                 }
468             }
469             
470             switch (canCompile(node)) {
471             case CannotCompile: 
472                 if (verboseCapabilities()) {
473                     dataLog("FTL rejecting node in ", *graph.m_codeBlock, ":\n");
474                     graph.dump(WTF::dataFile(), "    ", node);
475                 }
476                 return CannotCompile;
477                 
478             case CanCompile:
479                 if (result == CanCompileAndOSREnter && verboseCompilationEnabled()) {
480                     dataLog("FTL disabling OSR entry because of node:\n");
481                     graph.dump(WTF::dataFile(), "    ", node);
482                 }
483                 result = CanCompile;
484                 break;
485                 
486             case CanCompileAndOSREnter:
487                 break;
488             }
489             
490             if (node->op() == ForceOSRExit)
491                 break;
492         }
493     }
494     
495     return result;
496 }
497
498 } } // namespace JSC::FTL
499
500 #endif // ENABLE(FTL_JIT)
501