Make JSMap and JSSet faster
[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 CheckStringIdent:
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 CallEval:
146     case TailCallVarargs:
147     case TailCallVarargsInlinedCaller:
148     case ConstructVarargs:
149     case CallForwardVarargs:
150     case TailCallForwardVarargs:
151     case TailCallForwardVarargsInlinedCaller:
152     case ConstructForwardVarargs:
153     case LoadVarargs:
154     case ValueToInt32:
155     case Branch:
156     case LogicalNot:
157     case CheckInBounds:
158     case ConstantStoragePointer:
159     case Check:
160     case CountExecution:
161     case GetExecutable:
162     case GetScope:
163     case GetCallee:
164     case GetArgumentCountIncludingThis:
165     case ToNumber:
166     case ToString:
167     case CallObjectConstructor:
168     case CallStringConstructor:
169     case MakeRope:
170     case NewArrayWithSize:
171     case TryGetById:
172     case GetById:
173     case GetByIdFlush:
174     case GetByIdWithThis:
175     case ToThis:
176     case MultiGetByOffset:
177     case MultiPutByOffset:
178     case ToPrimitive:
179     case Throw:
180     case ThrowReferenceError:
181     case Unreachable:
182     case In:
183     case IsJSArray:
184     case MapHash:
185     case GetMapBucket:
186     case LoadFromJSMapBucket:
187     case IsNonEmptyMapBucket:
188     case IsEmpty:
189     case IsUndefined:
190     case IsBoolean:
191     case IsNumber:
192     case IsString:
193     case IsObject:
194     case IsObjectOrNull:
195     case IsFunction:
196     case IsRegExpObject:
197     case IsTypedArrayView:
198     case CheckTypeInfoFlags:
199     case OverridesHasInstance:
200     case InstanceOf:
201     case InstanceOfCustom:
202     case DoubleRep:
203     case ValueRep:
204     case Int52Rep:
205     case DoubleConstant:
206     case Int52Constant:
207     case BooleanToNumber:
208     case HasGenericProperty:
209     case HasStructureProperty:
210     case GetDirectPname:
211     case GetEnumerableLength:
212     case GetIndexedPropertyStorage:
213     case GetPropertyEnumerator:
214     case GetEnumeratorStructurePname:
215     case GetEnumeratorGenericPname:
216     case ToIndexString:
217     case BottomValue:
218     case PhantomNewObject:
219     case PhantomNewFunction:
220     case PhantomNewGeneratorFunction:
221     case PhantomCreateActivation:
222     case PutHint:
223     case CheckStructureImmediate:
224     case MaterializeNewObject:
225     case MaterializeCreateActivation:
226     case PhantomDirectArguments:
227     case PhantomClonedArguments:
228     case GetMyArgumentByVal:
229     case GetMyArgumentByValOutOfBounds:
230     case ForwardVarargs:
231     case Switch:
232     case TypeOf:
233     case PutById:
234     case PutByIdDirect:
235     case PutByIdFlush:
236     case PutByIdWithThis:
237     case PutGetterById:
238     case PutSetterById:
239     case PutGetterSetterById:
240     case PutGetterByVal:
241     case PutSetterByVal:
242     case CreateRest:
243     case GetRestLength:
244     case RegExpExec:
245     case RegExpTest:
246     case NewRegexp:
247     case StringReplace:
248     case StringReplaceRegExp: 
249     case GetRegExpObjectLastIndex:
250     case SetRegExpObjectLastIndex:
251     case RecordRegExpCachedResult:
252     case SetFunctionName:
253     case LogShadowChickenPrologue:
254     case LogShadowChickenTail:
255     case ResolveScope:
256     case GetDynamicVar:
257     case PutDynamicVar:
258     case CompareEq:
259     case CompareEqPtr:
260     case CompareLess:
261     case CompareLessEq:
262     case CompareGreater:
263     case CompareGreaterEq:
264     case CompareStrictEq:
265         // These are OK.
266         break;
267
268     case Identity:
269         // No backend handles this because it will be optimized out. But we may check
270         // for capabilities before optimization. It would be a deep error to remove this
271         // case because it would prevent us from catching bugs where the FTL backend
272         // pipeline failed to optimize out an Identity.
273         break;
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     default:
364         // Don't know how to handle anything else.
365         return CannotCompile;
366     }
367     return CanCompileAndOSREnter;
368 }
369
370 CapabilityLevel canCompile(Graph& graph)
371 {
372     if (graph.m_codeBlock->instructionCount() > Options::maximumFTLCandidateInstructionCount()) {
373         if (verboseCapabilities())
374             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it's too big.\n");
375         return CannotCompile;
376     }
377     
378     if (graph.m_codeBlock->codeType() != FunctionCode) {
379         if (verboseCapabilities())
380             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it doesn't belong to a function.\n");
381         return CannotCompile;
382     }
383
384     if (UNLIKELY(graph.m_codeBlock->ownerScriptExecutable()->neverFTLOptimize())) {
385         if (verboseCapabilities())
386             dataLog("FTL rejecting ", *graph.m_codeBlock, " because it is marked as never FTL compile.\n");
387         return CannotCompile;
388     }
389     
390     CapabilityLevel result = CanCompileAndOSREnter;
391     
392     for (BlockIndex blockIndex = graph.numBlocks(); blockIndex--;) {
393         BasicBlock* block = graph.block(blockIndex);
394         if (!block)
395             continue;
396         
397         // We don't care if we can compile blocks that the CFA hasn't visited.
398         if (!block->cfaHasVisited)
399             continue;
400         
401         for (unsigned nodeIndex = 0; nodeIndex < block->size(); ++nodeIndex) {
402             Node* node = block->at(nodeIndex);
403             
404             for (unsigned childIndex = graph.numChildren(node); childIndex--;) {
405                 Edge edge = graph.child(node, childIndex);
406                 if (!edge)
407                     continue;
408                 switch (edge.useKind()) {
409                 case UntypedUse:
410                 case Int32Use:
411                 case KnownInt32Use:
412                 case Int52RepUse:
413                 case NumberUse:
414                 case RealNumberUse:
415                 case DoubleRepUse:
416                 case DoubleRepRealUse:
417                 case BooleanUse:
418                 case KnownBooleanUse:
419                 case CellUse:
420                 case KnownCellUse:
421                 case CellOrOtherUse:
422                 case ObjectUse:
423                 case FunctionUse:
424                 case ObjectOrOtherUse:
425                 case StringUse:
426                 case StringOrOtherUse:
427                 case KnownStringUse:
428                 case KnownPrimitiveUse:
429                 case StringObjectUse:
430                 case StringOrStringObjectUse:
431                 case SymbolUse:
432                 case MapObjectUse:
433                 case SetObjectUse:
434                 case FinalObjectUse:
435                 case RegExpObjectUse:
436                 case NotCellUse:
437                 case OtherUse:
438                 case MiscUse:
439                 case StringIdentUse:
440                 case NotStringVarUse:
441                 case AnyIntUse:
442                 case DoubleRepAnyIntUse:
443                     // These are OK.
444                     break;
445                 default:
446                     // Don't know how to handle anything else.
447                     if (verboseCapabilities()) {
448                         dataLog("FTL rejecting node in ", *graph.m_codeBlock, " because of bad use kind: ", edge.useKind(), " in node:\n");
449                         graph.dump(WTF::dataFile(), "    ", node);
450                     }
451                     return CannotCompile;
452                 }
453             }
454             
455             switch (canCompile(node)) {
456             case CannotCompile: 
457                 if (verboseCapabilities()) {
458                     dataLog("FTL rejecting node in ", *graph.m_codeBlock, ":\n");
459                     graph.dump(WTF::dataFile(), "    ", node);
460                 }
461                 return CannotCompile;
462                 
463             case CanCompile:
464                 if (result == CanCompileAndOSREnter && verboseCompilationEnabled()) {
465                     dataLog("FTL disabling OSR entry because of node:\n");
466                     graph.dump(WTF::dataFile(), "    ", node);
467                 }
468                 result = CanCompile;
469                 break;
470                 
471             case CanCompileAndOSREnter:
472                 break;
473             }
474             
475             if (node->op() == ForceOSRExit)
476                 break;
477         }
478     }
479     
480     return result;
481 }
482
483 } } // namespace JSC::FTL
484
485 #endif // ENABLE(FTL_JIT)
486