Unreviewed, rolling out r208584.
[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 GetArgument:
128     case InvalidationPoint:
129     case StringCharAt:
130     case CheckCell:
131     case CheckBadCell:
132     case CheckNotEmpty:
133     case CheckStringIdent:
134     case CheckWatchdogTimer:
135     case StringCharCodeAt:
136     case StringFromCharCode:
137     case AllocatePropertyStorage:
138     case ReallocatePropertyStorage:
139     case GetTypedArrayByteOffset:
140     case NotifyWrite:
141     case StoreBarrier:
142     case FencedStoreBarrier:
143     case Call:
144     case DirectCall:
145     case TailCall:
146     case DirectTailCall:
147     case TailCallInlinedCaller:
148     case DirectTailCallInlinedCaller:
149     case Construct:
150     case DirectConstruct:
151     case CallVarargs:
152     case CallEval:
153     case TailCallVarargs:
154     case TailCallVarargsInlinedCaller:
155     case ConstructVarargs:
156     case CallForwardVarargs:
157     case TailCallForwardVarargs:
158     case TailCallForwardVarargsInlinedCaller:
159     case ConstructForwardVarargs:
160     case LoadVarargs:
161     case ValueToInt32:
162     case Branch:
163     case LogicalNot:
164     case CheckInBounds:
165     case ConstantStoragePointer:
166     case Check:
167     case CountExecution:
168     case GetExecutable:
169     case GetScope:
170     case GetCallee:
171     case GetArgumentCountIncludingThis:
172     case ToNumber:
173     case ToString:
174     case CallObjectConstructor:
175     case CallStringConstructor:
176     case MakeRope:
177     case NewArrayWithSize:
178     case TryGetById:
179     case GetById:
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 CallDOM:
277     case CallDOMGetter:
278         // These are OK.
279         break;
280
281     case Identity:
282         // No backend handles this because it will be optimized out. But we may check
283         // for capabilities before optimization. It would be a deep error to remove this
284         // case because it would prevent us from catching bugs where the FTL backend
285         // pipeline failed to optimize out an Identity.
286         break;
287     case CheckArray:
288         switch (node->arrayMode().type()) {
289         case Array::Int32:
290         case Array::Double:
291         case Array::Contiguous:
292         case Array::DirectArguments:
293         case Array::ScopedArguments:
294             break;
295         default:
296             if (isTypedView(node->arrayMode().typedArrayType()))
297                 break;
298             return CannotCompile;
299         }
300         break;
301     case GetArrayLength:
302         switch (node->arrayMode().type()) {
303         case Array::Undecided:
304         case Array::Int32:
305         case Array::Double:
306         case Array::Contiguous:
307         case Array::String:
308         case Array::DirectArguments:
309         case Array::ScopedArguments:
310             break;
311         default:
312             if (node->arrayMode().isSomeTypedArrayView())
313                 break;
314             return CannotCompile;
315         }
316         break;
317     case HasIndexedProperty:
318         switch (node->arrayMode().type()) {
319         case Array::ForceExit:
320         case Array::Int32:
321         case Array::Double:
322         case Array::Contiguous:
323             break;
324         default:
325             return CannotCompile;
326         }
327         break;
328     case GetByVal:
329         switch (node->arrayMode().type()) {
330         case Array::ForceExit:
331         case Array::Generic:
332         case Array::String:
333         case Array::Int32:
334         case Array::Double:
335         case Array::Contiguous:
336         case Array::Undecided:
337         case Array::DirectArguments:
338         case Array::ScopedArguments:
339             break;
340         default:
341             if (isTypedView(node->arrayMode().typedArrayType()))
342                 return CanCompileAndOSREnter;
343             return CannotCompile;
344         }
345         break;
346     case GetByValWithThis:
347         break;
348     case PutByVal:
349     case PutByValAlias:
350     case PutByValDirect:
351         switch (node->arrayMode().type()) {
352         case Array::ForceExit:
353         case Array::Generic:
354         case Array::Int32:
355         case Array::Double:
356         case Array::Contiguous:
357             break;
358         default:
359             if (isTypedView(node->arrayMode().typedArrayType()))
360                 return CanCompileAndOSREnter;
361             return CannotCompile;
362         }
363         break;
364     case PutByValWithThis:
365         break;
366     case ArrayPush:
367     case ArrayPop:
368         switch (node->arrayMode().type()) {
369         case Array::Int32:
370         case Array::Contiguous:
371         case Array::Double:
372             break;
373         default:
374             return CannotCompile;
375         }
376         break;
377     default:
378         // Don't know how to handle anything else.
379         return CannotCompile;
380     }
381     return CanCompileAndOSREnter;
382 }
383
384 CapabilityLevel canCompile(Graph& graph)
385 {
386     if (graph.m_codeBlock->instructionCount() > Options::maximumFTLCandidateInstructionCount()) {
387         if (verboseCapabilities())
388             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it's too big.\n");
389         return CannotCompile;
390     }
391     
392     if (graph.m_codeBlock->codeType() != FunctionCode) {
393         if (verboseCapabilities())
394             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it doesn't belong to a function.\n");
395         return CannotCompile;
396     }
397
398     if (UNLIKELY(graph.m_codeBlock->ownerScriptExecutable()->neverFTLOptimize())) {
399         if (verboseCapabilities())
400             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it is marked as never FTL compile.\n");
401         return CannotCompile;
402     }
403     
404     CapabilityLevel result = CanCompileAndOSREnter;
405     
406     for (BlockIndex blockIndex = graph.numBlocks(); blockIndex--;) {
407         BasicBlock* block = graph.block(blockIndex);
408         if (!block)
409             continue;
410         
411         // We don't care if we can compile blocks that the CFA hasn't visited.
412         if (!block->cfaHasVisited)
413             continue;
414         
415         for (unsigned nodeIndex = 0; nodeIndex < block->size(); ++nodeIndex) {
416             Node* node = block->at(nodeIndex);
417             
418             for (unsigned childIndex = graph.numChildren(node); childIndex--;) {
419                 Edge edge = graph.child(node, childIndex);
420                 if (!edge)
421                     continue;
422                 switch (edge.useKind()) {
423                 case UntypedUse:
424                 case Int32Use:
425                 case KnownInt32Use:
426                 case Int52RepUse:
427                 case NumberUse:
428                 case RealNumberUse:
429                 case DoubleRepUse:
430                 case DoubleRepRealUse:
431                 case BooleanUse:
432                 case KnownBooleanUse:
433                 case CellUse:
434                 case KnownCellUse:
435                 case CellOrOtherUse:
436                 case ObjectUse:
437                 case ArrayUse:
438                 case FunctionUse:
439                 case ObjectOrOtherUse:
440                 case StringUse:
441                 case StringOrOtherUse:
442                 case KnownStringUse:
443                 case KnownPrimitiveUse:
444                 case StringObjectUse:
445                 case StringOrStringObjectUse:
446                 case SymbolUse:
447                 case MapObjectUse:
448                 case SetObjectUse:
449                 case FinalObjectUse:
450                 case RegExpObjectUse:
451                 case ProxyObjectUse:
452                 case DerivedArrayUse:
453                 case NotCellUse:
454                 case OtherUse:
455                 case MiscUse:
456                 case StringIdentUse:
457                 case NotStringVarUse:
458                 case AnyIntUse:
459                 case DoubleRepAnyIntUse:
460                     // These are OK.
461                     break;
462                 default:
463                     // Don't know how to handle anything else.
464                     if (verboseCapabilities()) {
465                         dataLog("FTL rejecting node in ", *graph.m_codeBlock, " because of bad use kind: ", edge.useKind(), " in node:\n");
466                         graph.dump(WTF::dataFile(), "    ", node);
467                     }
468                     return CannotCompile;
469                 }
470             }
471             
472             switch (canCompile(node)) {
473             case CannotCompile: 
474                 if (verboseCapabilities()) {
475                     dataLog("FTL rejecting node in ", *graph.m_codeBlock, ":\n");
476                     graph.dump(WTF::dataFile(), "    ", node);
477                 }
478                 return CannotCompile;
479                 
480             case CanCompile:
481                 if (result == CanCompileAndOSREnter && verboseCompilationEnabled()) {
482                     dataLog("FTL disabling OSR entry because of node:\n");
483                     graph.dump(WTF::dataFile(), "    ", node);
484                 }
485                 result = CanCompile;
486                 break;
487                 
488             case CanCompileAndOSREnter:
489                 break;
490             }
491             
492             if (node->op() == ForceOSRExit)
493                 break;
494         }
495     }
496     
497     return result;
498 }
499
500 } } // namespace JSC::FTL
501
502 #endif // ENABLE(FTL_JIT)
503