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