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