ee5be8f77c6ef088bfdf2c7e827d8f1a4786942b
[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 ArithPow:
98     case ArithRandom:
99     case ArithRound:
100     case ArithFloor:
101     case ArithCeil:
102     case ArithTrunc:
103     case ArithSqrt:
104     case ArithLog:
105     case ArithFRound:
106     case ArithNegate:
107     case UInt32ToNumber:
108     case Jump:
109     case ForceOSRExit:
110     case Phi:
111     case Upsilon:
112     case ExtractOSREntryLocal:
113     case LoopHint:
114     case SkipScope:
115     case GetGlobalObject:
116     case CreateActivation:
117     case NewFunction:
118     case NewGeneratorFunction:
119     case GetClosureVar:
120     case PutClosureVar:
121     case CreateDirectArguments:
122     case CreateScopedArguments:
123     case CreateClonedArguments:
124     case GetFromArguments:
125     case PutToArguments:
126     case InvalidationPoint:
127     case StringCharAt:
128     case CheckCell:
129     case CheckBadCell:
130     case CheckNotEmpty:
131     case CheckIdent:
132     case CheckWatchdogTimer:
133     case StringCharCodeAt:
134     case StringFromCharCode:
135     case AllocatePropertyStorage:
136     case ReallocatePropertyStorage:
137     case GetTypedArrayByteOffset:
138     case NotifyWrite:
139     case StoreBarrier:
140     case Call:
141     case TailCall:
142     case TailCallInlinedCaller:
143     case Construct:
144     case CallVarargs:
145     case TailCallVarargs:
146     case TailCallVarargsInlinedCaller:
147     case ConstructVarargs:
148     case CallForwardVarargs:
149     case TailCallForwardVarargs:
150     case TailCallForwardVarargsInlinedCaller:
151     case ConstructForwardVarargs:
152     case LoadVarargs:
153     case ValueToInt32:
154     case Branch:
155     case LogicalNot:
156     case CheckInBounds:
157     case ConstantStoragePointer:
158     case Check:
159     case CountExecution:
160     case GetExecutable:
161     case GetScope:
162     case GetCallee:
163     case GetArgumentCount:
164     case CallObjectConstructor:
165     case ToString:
166     case CallStringConstructor:
167     case MakeRope:
168     case NewArrayWithSize:
169     case TryGetById:
170     case GetById:
171     case GetByIdFlush:
172     case ToThis:
173     case MultiGetByOffset:
174     case MultiPutByOffset:
175     case ToPrimitive:
176     case Throw:
177     case ThrowReferenceError:
178     case Unreachable:
179     case IsArrayObject:
180     case IsJSArray:
181     case IsArrayConstructor:
182     case IsUndefined:
183     case IsBoolean:
184     case IsNumber:
185     case IsString:
186     case IsObject:
187     case IsObjectOrNull:
188     case IsFunction:
189     case IsRegExpObject:
190     case CheckTypeInfoFlags:
191     case OverridesHasInstance:
192     case InstanceOf:
193     case InstanceOfCustom:
194     case DoubleRep:
195     case ValueRep:
196     case Int52Rep:
197     case DoubleConstant:
198     case Int52Constant:
199     case BooleanToNumber:
200     case HasGenericProperty:
201     case HasStructureProperty:
202     case GetDirectPname:
203     case GetEnumerableLength:
204     case GetPropertyEnumerator:
205     case GetEnumeratorStructurePname:
206     case GetEnumeratorGenericPname:
207     case ToIndexString:
208     case BottomValue:
209     case PhantomNewObject:
210     case PhantomNewFunction:
211     case PhantomNewGeneratorFunction:
212     case PhantomCreateActivation:
213     case PutHint:
214     case CheckStructureImmediate:
215     case MaterializeNewObject:
216     case MaterializeCreateActivation:
217     case PhantomDirectArguments:
218     case PhantomClonedArguments:
219     case GetMyArgumentByVal:
220     case ForwardVarargs:
221     case Switch:
222     case TypeOf:
223     case PutGetterById:
224     case PutSetterById:
225     case PutGetterSetterById:
226     case PutGetterByVal:
227     case PutSetterByVal:
228     case CopyRest:
229     case GetRestLength:
230     case RegExpExec:
231     case RegExpTest:
232     case NewRegexp:
233     case StringReplace:
234     case GetRegExpObjectLastIndex:
235     case SetRegExpObjectLastIndex:
236     case RecordRegExpCachedResult:
237     case SetFunctionName:
238     case LogShadowChickenPrologue:
239     case LogShadowChickenTail:
240     case ResolveScope:
241     case GetDynamicVar:
242     case PutDynamicVar:
243         // These are OK.
244         break;
245
246     case Identity:
247         // No backend handles this because it will be optimized out. But we may check
248         // for capabilities before optimization. It would be a deep error to remove this
249         // case because it would prevent us from catching bugs where the FTL backend
250         // pipeline failed to optimize out an Identity.
251         break;
252     case In:
253         if (node->child2().useKind() == CellUse)
254             break;
255         return CannotCompile;
256     case PutByIdDirect:
257     case PutById:
258     case PutByIdFlush:
259         if (node->child1().useKind() == CellUse)
260             break;
261         return CannotCompile;
262     case GetIndexedPropertyStorage:
263         if (node->arrayMode().type() == Array::String)
264             break;
265         if (isTypedView(node->arrayMode().typedArrayType()))
266             break;
267         return CannotCompile;
268     case CheckArray:
269         switch (node->arrayMode().type()) {
270         case Array::Int32:
271         case Array::Double:
272         case Array::Contiguous:
273         case Array::DirectArguments:
274         case Array::ScopedArguments:
275             break;
276         default:
277             if (isTypedView(node->arrayMode().typedArrayType()))
278                 break;
279             return CannotCompile;
280         }
281         break;
282     case GetArrayLength:
283         switch (node->arrayMode().type()) {
284         case Array::Int32:
285         case Array::Double:
286         case Array::Contiguous:
287         case Array::String:
288         case Array::DirectArguments:
289         case Array::ScopedArguments:
290             break;
291         default:
292             if (node->arrayMode().isSomeTypedArrayView())
293                 break;
294             return CannotCompile;
295         }
296         break;
297     case HasIndexedProperty:
298         switch (node->arrayMode().type()) {
299         case Array::ForceExit:
300         case Array::Int32:
301         case Array::Double:
302         case Array::Contiguous:
303             break;
304         default:
305             return CannotCompile;
306         }
307         break;
308     case GetByVal:
309         switch (node->arrayMode().type()) {
310         case Array::ForceExit:
311         case Array::Generic:
312         case Array::String:
313         case Array::Int32:
314         case Array::Double:
315         case Array::Contiguous:
316         case Array::Undecided:
317         case Array::DirectArguments:
318         case Array::ScopedArguments:
319             break;
320         default:
321             if (isTypedView(node->arrayMode().typedArrayType()))
322                 return CanCompileAndOSREnter;
323             return CannotCompile;
324         }
325         break;
326     case PutByVal:
327     case PutByValAlias:
328     case PutByValDirect:
329         switch (node->arrayMode().type()) {
330         case Array::ForceExit:
331         case Array::Generic:
332         case Array::Int32:
333         case Array::Double:
334         case Array::Contiguous:
335             break;
336         default:
337             if (isTypedView(node->arrayMode().typedArrayType()))
338                 return CanCompileAndOSREnter;
339             return CannotCompile;
340         }
341         break;
342     case ArrayPush:
343     case ArrayPop:
344         switch (node->arrayMode().type()) {
345         case Array::Int32:
346         case Array::Contiguous:
347         case Array::Double:
348             break;
349         default:
350             return CannotCompile;
351         }
352         break;
353     case CompareEq:
354         if (node->isBinaryUseKind(Int32Use))
355             break;
356         if (node->isBinaryUseKind(Int52RepUse))
357             break;
358         if (node->isBinaryUseKind(DoubleRepUse))
359             break;
360         if (node->isBinaryUseKind(StringIdentUse))
361             break;
362         if (node->isBinaryUseKind(StringUse))
363             break;
364         if (node->isBinaryUseKind(SymbolUse))
365             break;
366         if (node->isBinaryUseKind(ObjectUse))
367             break;
368         if (node->isBinaryUseKind(UntypedUse))
369             break;
370         if (node->isBinaryUseKind(BooleanUse))
371             break;
372         if (node->isBinaryUseKind(ObjectUse, ObjectOrOtherUse))
373             break;
374         if (node->isBinaryUseKind(ObjectOrOtherUse, ObjectUse))
375             break;
376         if (node->child1().useKind() == OtherUse || node->child2().useKind() == OtherUse)
377             break;
378         return CannotCompile;
379     case CompareStrictEq:
380         if (node->isBinaryUseKind(Int32Use))
381             break;
382         if (node->isBinaryUseKind(Int52RepUse))
383             break;
384         if (node->isBinaryUseKind(DoubleRepUse))
385             break;
386         if (node->isBinaryUseKind(StringIdentUse))
387             break;
388         if (node->isBinaryUseKind(StringUse))
389             break;
390         if (node->isBinaryUseKind(ObjectUse, UntypedUse))
391             break;
392         if (node->isBinaryUseKind(UntypedUse, ObjectUse))
393             break;
394         if (node->isBinaryUseKind(ObjectUse))
395             break;
396         if (node->isBinaryUseKind(BooleanUse))
397             break;
398         if (node->isBinaryUseKind(SymbolUse))
399             break;
400         if (node->isBinaryUseKind(MiscUse, UntypedUse))
401             break;
402         if (node->isBinaryUseKind(UntypedUse, MiscUse))
403             break;
404         if (node->isBinaryUseKind(StringIdentUse, NotStringVarUse))
405             break;
406         if (node->isBinaryUseKind(NotStringVarUse, StringIdentUse))
407             break;
408         return CannotCompile;
409     case CompareLess:
410     case CompareLessEq:
411     case CompareGreater:
412     case CompareGreaterEq:
413         if (node->isBinaryUseKind(Int32Use))
414             break;
415         if (node->isBinaryUseKind(Int52RepUse))
416             break;
417         if (node->isBinaryUseKind(DoubleRepUse))
418             break;
419         if (node->isBinaryUseKind(StringIdentUse))
420             break;
421         if (node->isBinaryUseKind(StringUse))
422             break;
423         if (node->isBinaryUseKind(UntypedUse))
424             break;
425         return CannotCompile;
426     default:
427         // Don't know how to handle anything else.
428         return CannotCompile;
429     }
430     return CanCompileAndOSREnter;
431 }
432
433 CapabilityLevel canCompile(Graph& graph)
434 {
435     if (graph.m_codeBlock->instructionCount() > Options::maximumFTLCandidateInstructionCount()) {
436         if (verboseCapabilities())
437             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it's too big.\n");
438         return CannotCompile;
439     }
440     
441     if (graph.m_codeBlock->codeType() != FunctionCode) {
442         if (verboseCapabilities())
443             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it doesn't belong to a function.\n");
444         return CannotCompile;
445     }
446
447     if (UNLIKELY(graph.m_codeBlock->ownerScriptExecutable()->neverFTLOptimize())) {
448         if (verboseCapabilities())
449             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it is marked as never FTL compile.\n");
450         return CannotCompile;
451     }
452     
453     CapabilityLevel result = CanCompileAndOSREnter;
454     
455     for (BlockIndex blockIndex = graph.numBlocks(); blockIndex--;) {
456         BasicBlock* block = graph.block(blockIndex);
457         if (!block)
458             continue;
459         
460         // We don't care if we can compile blocks that the CFA hasn't visited.
461         if (!block->cfaHasVisited)
462             continue;
463         
464         for (unsigned nodeIndex = 0; nodeIndex < block->size(); ++nodeIndex) {
465             Node* node = block->at(nodeIndex);
466             
467             for (unsigned childIndex = graph.numChildren(node); childIndex--;) {
468                 Edge edge = graph.child(node, childIndex);
469                 if (!edge)
470                     continue;
471                 switch (edge.useKind()) {
472                 case UntypedUse:
473                 case Int32Use:
474                 case KnownInt32Use:
475                 case Int52RepUse:
476                 case NumberUse:
477                 case RealNumberUse:
478                 case DoubleRepUse:
479                 case DoubleRepRealUse:
480                 case BooleanUse:
481                 case KnownBooleanUse:
482                 case CellUse:
483                 case KnownCellUse:
484                 case CellOrOtherUse:
485                 case ObjectUse:
486                 case FunctionUse:
487                 case ObjectOrOtherUse:
488                 case StringUse:
489                 case StringOrOtherUse:
490                 case KnownStringUse:
491                 case KnownPrimitiveUse:
492                 case StringObjectUse:
493                 case StringOrStringObjectUse:
494                 case SymbolUse:
495                 case FinalObjectUse:
496                 case RegExpObjectUse:
497                 case NotCellUse:
498                 case OtherUse:
499                 case MiscUse:
500                 case StringIdentUse:
501                 case NotStringVarUse:
502                 case MachineIntUse:
503                 case DoubleRepMachineIntUse:
504                     // These are OK.
505                     break;
506                 default:
507                     // Don't know how to handle anything else.
508                     if (verboseCapabilities()) {
509                         dataLog("FTL rejecting node in ", *graph.m_codeBlock, " because of bad use kind: ", edge.useKind(), " in node:\n");
510                         graph.dump(WTF::dataFile(), "    ", node);
511                     }
512                     return CannotCompile;
513                 }
514             }
515             
516             switch (canCompile(node)) {
517             case CannotCompile: 
518                 if (verboseCapabilities()) {
519                     dataLog("FTL rejecting node in ", *graph.m_codeBlock, ":\n");
520                     graph.dump(WTF::dataFile(), "    ", node);
521                 }
522                 return CannotCompile;
523                 
524             case CanCompile:
525                 if (result == CanCompileAndOSREnter && verboseCompilationEnabled()) {
526                     dataLog("FTL disabling OSR entry because of node:\n");
527                     graph.dump(WTF::dataFile(), "    ", node);
528                 }
529                 result = CanCompile;
530                 break;
531                 
532             case CanCompileAndOSREnter:
533                 break;
534             }
535             
536             if (node->op() == ForceOSRExit)
537                 break;
538         }
539     }
540     
541     return result;
542 }
543
544 } } // namespace JSC::FTL
545
546 #endif // ENABLE(FTL_JIT)
547