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