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