b5102faa8342ea6f1c8668147f2fa32590f16e29
[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 GetByIdWithThis:
173     case ToThis:
174     case MultiGetByOffset:
175     case MultiPutByOffset:
176     case ToPrimitive:
177     case Throw:
178     case ThrowReferenceError:
179     case Unreachable:
180     case IsArrayObject:
181     case IsJSArray:
182     case IsArrayConstructor:
183     case IsEmpty:
184     case IsUndefined:
185     case IsBoolean:
186     case IsNumber:
187     case IsString:
188     case IsObject:
189     case IsObjectOrNull:
190     case IsFunction:
191     case IsRegExpObject:
192     case CheckTypeInfoFlags:
193     case OverridesHasInstance:
194     case InstanceOf:
195     case InstanceOfCustom:
196     case DoubleRep:
197     case ValueRep:
198     case Int52Rep:
199     case DoubleConstant:
200     case Int52Constant:
201     case BooleanToNumber:
202     case HasGenericProperty:
203     case HasStructureProperty:
204     case GetDirectPname:
205     case GetEnumerableLength:
206     case GetPropertyEnumerator:
207     case GetEnumeratorStructurePname:
208     case GetEnumeratorGenericPname:
209     case ToIndexString:
210     case BottomValue:
211     case PhantomNewObject:
212     case PhantomNewFunction:
213     case PhantomNewGeneratorFunction:
214     case PhantomCreateActivation:
215     case PutHint:
216     case CheckStructureImmediate:
217     case MaterializeNewObject:
218     case MaterializeCreateActivation:
219     case PhantomDirectArguments:
220     case PhantomClonedArguments:
221     case GetMyArgumentByVal:
222     case GetMyArgumentByValOutOfBounds:
223     case ForwardVarargs:
224     case Switch:
225     case TypeOf:
226     case PutGetterById:
227     case PutSetterById:
228     case PutGetterSetterById:
229     case PutGetterByVal:
230     case PutSetterByVal:
231     case CopyRest:
232     case GetRestLength:
233     case RegExpExec:
234     case RegExpTest:
235     case NewRegexp:
236     case StringReplace:
237     case StringReplaceRegExp: 
238     case GetRegExpObjectLastIndex:
239     case SetRegExpObjectLastIndex:
240     case RecordRegExpCachedResult:
241     case SetFunctionName:
242     case LogShadowChickenPrologue:
243     case LogShadowChickenTail:
244     case ResolveScope:
245     case GetDynamicVar:
246     case PutDynamicVar:
247         // These are OK.
248         break;
249
250     case Identity:
251         // No backend handles this because it will be optimized out. But we may check
252         // for capabilities before optimization. It would be a deep error to remove this
253         // case because it would prevent us from catching bugs where the FTL backend
254         // pipeline failed to optimize out an Identity.
255         break;
256     case In:
257         if (node->child2().useKind() == CellUse)
258             break;
259         return CannotCompile;
260     case PutByIdDirect:
261     case PutById:
262     case PutByIdFlush:
263         if (node->child1().useKind() == CellUse)
264             break;
265         return CannotCompile;
266     case PutByIdWithThis:
267         break;
268     case GetIndexedPropertyStorage:
269         if (node->arrayMode().type() == Array::String)
270             break;
271         if (isTypedView(node->arrayMode().typedArrayType()))
272             break;
273         return CannotCompile;
274     case CheckArray:
275         switch (node->arrayMode().type()) {
276         case Array::Int32:
277         case Array::Double:
278         case Array::Contiguous:
279         case Array::DirectArguments:
280         case Array::ScopedArguments:
281             break;
282         default:
283             if (isTypedView(node->arrayMode().typedArrayType()))
284                 break;
285             return CannotCompile;
286         }
287         break;
288     case GetArrayLength:
289         switch (node->arrayMode().type()) {
290         case Array::Int32:
291         case Array::Double:
292         case Array::Contiguous:
293         case Array::String:
294         case Array::DirectArguments:
295         case Array::ScopedArguments:
296             break;
297         default:
298             if (node->arrayMode().isSomeTypedArrayView())
299                 break;
300             return CannotCompile;
301         }
302         break;
303     case HasIndexedProperty:
304         switch (node->arrayMode().type()) {
305         case Array::ForceExit:
306         case Array::Int32:
307         case Array::Double:
308         case Array::Contiguous:
309             break;
310         default:
311             return CannotCompile;
312         }
313         break;
314     case GetByVal:
315         switch (node->arrayMode().type()) {
316         case Array::ForceExit:
317         case Array::Generic:
318         case Array::String:
319         case Array::Int32:
320         case Array::Double:
321         case Array::Contiguous:
322         case Array::Undecided:
323         case Array::DirectArguments:
324         case Array::ScopedArguments:
325             break;
326         default:
327             if (isTypedView(node->arrayMode().typedArrayType()))
328                 return CanCompileAndOSREnter;
329             return CannotCompile;
330         }
331         break;
332     case GetByValWithThis:
333         break;
334     case PutByVal:
335     case PutByValAlias:
336     case PutByValDirect:
337         switch (node->arrayMode().type()) {
338         case Array::ForceExit:
339         case Array::Generic:
340         case Array::Int32:
341         case Array::Double:
342         case Array::Contiguous:
343             break;
344         default:
345             if (isTypedView(node->arrayMode().typedArrayType()))
346                 return CanCompileAndOSREnter;
347             return CannotCompile;
348         }
349         break;
350     case PutByValWithThis:
351         break;
352     case ArrayPush:
353     case ArrayPop:
354         switch (node->arrayMode().type()) {
355         case Array::Int32:
356         case Array::Contiguous:
357         case Array::Double:
358             break;
359         default:
360             return CannotCompile;
361         }
362         break;
363     case CompareEq:
364         if (node->isBinaryUseKind(Int32Use))
365             break;
366         if (node->isBinaryUseKind(Int52RepUse))
367             break;
368         if (node->isBinaryUseKind(DoubleRepUse))
369             break;
370         if (node->isBinaryUseKind(StringIdentUse))
371             break;
372         if (node->isBinaryUseKind(StringUse))
373             break;
374         if (node->isBinaryUseKind(SymbolUse))
375             break;
376         if (node->isBinaryUseKind(ObjectUse))
377             break;
378         if (node->isBinaryUseKind(UntypedUse))
379             break;
380         if (node->isBinaryUseKind(BooleanUse))
381             break;
382         if (node->isBinaryUseKind(ObjectUse, ObjectOrOtherUse))
383             break;
384         if (node->isBinaryUseKind(ObjectOrOtherUse, ObjectUse))
385             break;
386         if (node->child1().useKind() == OtherUse || node->child2().useKind() == OtherUse)
387             break;
388         return CannotCompile;
389     case CompareStrictEq:
390         if (node->isBinaryUseKind(Int32Use))
391             break;
392         if (node->isBinaryUseKind(Int52RepUse))
393             break;
394         if (node->isBinaryUseKind(DoubleRepUse))
395             break;
396         if (node->isBinaryUseKind(StringIdentUse))
397             break;
398         if (node->isBinaryUseKind(StringUse))
399             break;
400         if (node->isBinaryUseKind(ObjectUse, UntypedUse))
401             break;
402         if (node->isBinaryUseKind(UntypedUse, ObjectUse))
403             break;
404         if (node->isBinaryUseKind(ObjectUse))
405             break;
406         if (node->isBinaryUseKind(BooleanUse))
407             break;
408         if (node->isBinaryUseKind(SymbolUse))
409             break;
410         if (node->isBinaryUseKind(MiscUse, UntypedUse))
411             break;
412         if (node->isBinaryUseKind(UntypedUse, MiscUse))
413             break;
414         if (node->isBinaryUseKind(StringIdentUse, NotStringVarUse))
415             break;
416         if (node->isBinaryUseKind(NotStringVarUse, StringIdentUse))
417             break;
418         return CannotCompile;
419     case CompareLess:
420     case CompareLessEq:
421     case CompareGreater:
422     case CompareGreaterEq:
423         if (node->isBinaryUseKind(Int32Use))
424             break;
425         if (node->isBinaryUseKind(Int52RepUse))
426             break;
427         if (node->isBinaryUseKind(DoubleRepUse))
428             break;
429         if (node->isBinaryUseKind(StringIdentUse))
430             break;
431         if (node->isBinaryUseKind(StringUse))
432             break;
433         if (node->isBinaryUseKind(UntypedUse))
434             break;
435         return CannotCompile;
436     default:
437         // Don't know how to handle anything else.
438         return CannotCompile;
439     }
440     return CanCompileAndOSREnter;
441 }
442
443 CapabilityLevel canCompile(Graph& graph)
444 {
445     if (graph.m_codeBlock->instructionCount() > Options::maximumFTLCandidateInstructionCount()) {
446         if (verboseCapabilities())
447             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it's too big.\n");
448         return CannotCompile;
449     }
450     
451     if (graph.m_codeBlock->codeType() != FunctionCode) {
452         if (verboseCapabilities())
453             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it doesn't belong to a function.\n");
454         return CannotCompile;
455     }
456
457     if (UNLIKELY(graph.m_codeBlock->ownerScriptExecutable()->neverFTLOptimize())) {
458         if (verboseCapabilities())
459             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it is marked as never FTL compile.\n");
460         return CannotCompile;
461     }
462     
463     CapabilityLevel result = CanCompileAndOSREnter;
464     
465     for (BlockIndex blockIndex = graph.numBlocks(); blockIndex--;) {
466         BasicBlock* block = graph.block(blockIndex);
467         if (!block)
468             continue;
469         
470         // We don't care if we can compile blocks that the CFA hasn't visited.
471         if (!block->cfaHasVisited)
472             continue;
473         
474         for (unsigned nodeIndex = 0; nodeIndex < block->size(); ++nodeIndex) {
475             Node* node = block->at(nodeIndex);
476             
477             for (unsigned childIndex = graph.numChildren(node); childIndex--;) {
478                 Edge edge = graph.child(node, childIndex);
479                 if (!edge)
480                     continue;
481                 switch (edge.useKind()) {
482                 case UntypedUse:
483                 case Int32Use:
484                 case KnownInt32Use:
485                 case Int52RepUse:
486                 case NumberUse:
487                 case RealNumberUse:
488                 case DoubleRepUse:
489                 case DoubleRepRealUse:
490                 case BooleanUse:
491                 case KnownBooleanUse:
492                 case CellUse:
493                 case KnownCellUse:
494                 case CellOrOtherUse:
495                 case ObjectUse:
496                 case FunctionUse:
497                 case ObjectOrOtherUse:
498                 case StringUse:
499                 case StringOrOtherUse:
500                 case KnownStringUse:
501                 case KnownPrimitiveUse:
502                 case StringObjectUse:
503                 case StringOrStringObjectUse:
504                 case SymbolUse:
505                 case FinalObjectUse:
506                 case RegExpObjectUse:
507                 case NotCellUse:
508                 case OtherUse:
509                 case MiscUse:
510                 case StringIdentUse:
511                 case NotStringVarUse:
512                 case AnyIntUse:
513                 case DoubleRepAnyIntUse:
514                     // These are OK.
515                     break;
516                 default:
517                     // Don't know how to handle anything else.
518                     if (verboseCapabilities()) {
519                         dataLog("FTL rejecting node in ", *graph.m_codeBlock, " because of bad use kind: ", edge.useKind(), " in node:\n");
520                         graph.dump(WTF::dataFile(), "    ", node);
521                     }
522                     return CannotCompile;
523                 }
524             }
525             
526             switch (canCompile(node)) {
527             case CannotCompile: 
528                 if (verboseCapabilities()) {
529                     dataLog("FTL rejecting node in ", *graph.m_codeBlock, ":\n");
530                     graph.dump(WTF::dataFile(), "    ", node);
531                 }
532                 return CannotCompile;
533                 
534             case CanCompile:
535                 if (result == CanCompileAndOSREnter && verboseCompilationEnabled()) {
536                     dataLog("FTL disabling OSR entry because of node:\n");
537                     graph.dump(WTF::dataFile(), "    ", node);
538                 }
539                 result = CanCompile;
540                 break;
541                 
542             case CanCompileAndOSREnter:
543                 break;
544             }
545             
546             if (node->op() == ForceOSRExit)
547                 break;
548         }
549     }
550     
551     return result;
552 }
553
554 } } // namespace JSC::FTL
555
556 #endif // ENABLE(FTL_JIT)
557