Renaming SpecInt32, SpecInt52, MachineInt to SpecInt32Only, SpecInt52Only, AnyInt.
[WebKit-https.git] / Source / JavaScriptCore / bytecode / SpeculatedType.h
1 /*
2  * Copyright (C) 2011-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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef SpeculatedType_h
30 #define SpeculatedType_h
31
32 #include "JSCJSValue.h"
33 #include "TypedArrayType.h"
34 #include <wtf/PrintStream.h>
35
36 namespace JSC {
37
38 class Structure;
39
40 typedef uint32_t SpeculatedType;
41 static const SpeculatedType SpecNone               = 0; // We don't know anything yet.
42 static const SpeculatedType SpecFinalObject        = 1u << 0; // It's definitely a JSFinalObject.
43 static const SpeculatedType SpecArray              = 1u << 1; // It's definitely a JSArray.
44 static const SpeculatedType SpecFunction           = 1u << 2; // It's definitely a JSFunction.
45 static const SpeculatedType SpecInt8Array          = 1u << 3; // It's definitely an Int8Array or one of its subclasses.
46 static const SpeculatedType SpecInt16Array         = 1u << 4; // It's definitely an Int16Array or one of its subclasses.
47 static const SpeculatedType SpecInt32Array         = 1u << 5; // It's definitely an Int32Array or one of its subclasses.
48 static const SpeculatedType SpecUint8Array         = 1u << 6; // It's definitely an Uint8Array or one of its subclasses.
49 static const SpeculatedType SpecUint8ClampedArray  = 1u << 7; // It's definitely an Uint8ClampedArray or one of its subclasses.
50 static const SpeculatedType SpecUint16Array        = 1u << 8; // It's definitely an Uint16Array or one of its subclasses.
51 static const SpeculatedType SpecUint32Array        = 1u << 9; // It's definitely an Uint32Array or one of its subclasses.
52 static const SpeculatedType SpecFloat32Array       = 1u << 10; // It's definitely an Uint16Array or one of its subclasses.
53 static const SpeculatedType SpecFloat64Array       = 1u << 11; // It's definitely an Uint16Array or one of its subclasses.
54 static const SpeculatedType SpecTypedArrayView     = SpecInt8Array | SpecInt16Array | SpecInt32Array | SpecUint8Array | SpecUint8ClampedArray | SpecUint16Array | SpecUint32Array | SpecFloat32Array | SpecFloat64Array;
55 static const SpeculatedType SpecDirectArguments    = 1u << 12; // It's definitely a DirectArguments object.
56 static const SpeculatedType SpecScopedArguments    = 1u << 13; // It's definitely a ScopedArguments object.
57 static const SpeculatedType SpecStringObject       = 1u << 14; // It's definitely a StringObject.
58 static const SpeculatedType SpecRegExpObject       = 1u << 15; // It's definitely a RegExpObject (and not any subclass of RegExpObject).
59 static const SpeculatedType SpecObjectOther        = 1u << 16; // It's definitely an object but not JSFinalObject, JSArray, or JSFunction.
60 static const SpeculatedType SpecObject             = SpecFinalObject | SpecArray | SpecFunction | SpecTypedArrayView | SpecDirectArguments | SpecScopedArguments | SpecStringObject | SpecRegExpObject | SpecObjectOther; // Bitmask used for testing for any kind of object prediction.
61 static const SpeculatedType SpecStringIdent        = 1u << 17; // It's definitely a JSString, and it's an identifier.
62 static const SpeculatedType SpecStringVar          = 1u << 18; // It's definitely a JSString, and it's not an identifier.
63 static const SpeculatedType SpecString             = SpecStringIdent | SpecStringVar; // It's definitely a JSString.
64 static const SpeculatedType SpecSymbol             = 1u << 19; // It's definitely a Symbol.
65 static const SpeculatedType SpecCellOther          = 1u << 20; // It's definitely a JSCell but not a subclass of JSObject and definitely not a JSString or a Symbol. FIXME: This shouldn't be part of heap-top or bytecode-top. https://bugs.webkit.org/show_bug.cgi?id=133078
66 static const SpeculatedType SpecCell               = SpecObject | SpecString | SpecSymbol | SpecCellOther; // It's definitely a JSCell.
67 static const SpeculatedType SpecBoolInt32          = 1u << 21; // It's definitely an Int32 with value 0 or 1.
68 static const SpeculatedType SpecNonBoolInt32       = 1u << 22; // It's definitely an Int32 with value other than 0 or 1.
69 static const SpeculatedType SpecInt32Only          = SpecBoolInt32 | SpecNonBoolInt32; // It's definitely an Int32.
70 static const SpeculatedType SpecInt52Only          = 1u << 23; // It's definitely an Int52 and we intend it to unbox it. It's also definitely not an Int32.
71 static const SpeculatedType SpecAnyInt             = SpecInt32Only | SpecInt52Only; // It's something that we can do machine int arithmetic on.
72 static const SpeculatedType SpecAnyIntAsDouble     = 1u << 24; // It's definitely an Int52 and it's inside a double.
73 static const SpeculatedType SpecNonIntAsDouble     = 1u << 25; // It's definitely not an Int52 but it's a real number and it's a double.
74 static const SpeculatedType SpecDoubleReal         = SpecNonIntAsDouble | SpecAnyIntAsDouble; // It's definitely a non-NaN double.
75 static const SpeculatedType SpecDoublePureNaN      = 1u << 26; // It's definitely a NaN that is sae to tag (i.e. pure).
76 static const SpeculatedType SpecDoubleImpureNaN    = 1u << 27; // It's definitely a NaN that is unsafe to tag (i.e. impure).
77 static const SpeculatedType SpecDoubleNaN          = SpecDoublePureNaN | SpecDoubleImpureNaN; // It's definitely some kind of NaN.
78 static const SpeculatedType SpecBytecodeDouble     = SpecDoubleReal | SpecDoublePureNaN; // It's either a non-NaN or a NaN double, but it's definitely not impure NaN.
79 static const SpeculatedType SpecFullDouble         = SpecDoubleReal | SpecDoubleNaN; // It's either a non-NaN or a NaN double.
80 static const SpeculatedType SpecBytecodeRealNumber = SpecInt32Only | SpecDoubleReal; // It's either an Int32 or a DoubleReal.
81 static const SpeculatedType SpecFullRealNumber     = SpecAnyInt | SpecDoubleReal; // It's either an Int32 or a DoubleReal, or a Int52.
82 static const SpeculatedType SpecBytecodeNumber     = SpecInt32Only | SpecBytecodeDouble; // It's either an Int32 or a Double, and the Double cannot be an impure NaN.
83 static const SpeculatedType SpecFullNumber         = SpecAnyInt | SpecFullDouble; // It's either an Int32, Int52, or a Double, and the Double can be impure NaN.
84 static const SpeculatedType SpecBoolean            = 1u << 28; // It's definitely a Boolean.
85 static const SpeculatedType SpecOther              = 1u << 29; // It's definitely either Null or Undefined.
86 static const SpeculatedType SpecMisc               = SpecBoolean | SpecOther; // It's definitely either a boolean, Null, or Undefined.
87 static const SpeculatedType SpecHeapTop            = SpecCell | SpecBytecodeNumber | SpecMisc; // It can be any of the above, except for SpecInt52Only and SpecDoubleImpureNaN.
88 static const SpeculatedType SpecPrimitive          = SpecString | SpecSymbol | SpecBytecodeNumber | SpecMisc; // It's any non-Object JSValue.
89 static const SpeculatedType SpecEmpty              = 1u << 30; // It's definitely an empty value marker.
90 static const SpeculatedType SpecBytecodeTop        = SpecHeapTop | SpecEmpty; // It can be any of the above, except for SpecInt52Only and SpecDoubleImpureNaN. Corresponds to what could be found in a bytecode local.
91 static const SpeculatedType SpecFullTop            = SpecBytecodeTop | SpecFullNumber; // It can be anything that bytecode could see plus exotic encodings of numbers.
92
93 typedef bool (*SpeculatedTypeChecker)(SpeculatedType);
94
95 // Dummy prediction checker, only useful if someone insists on requiring a prediction checker.
96 inline bool isAnySpeculation(SpeculatedType)
97 {
98     return true;
99 }
100
101 inline bool isCellSpeculation(SpeculatedType value)
102 {
103     return !!(value & SpecCell) && !(value & ~SpecCell);
104 }
105
106 inline bool isCellOrOtherSpeculation(SpeculatedType value)
107 {
108     return !!value && !(value & ~(SpecCell | SpecOther));
109 }
110
111 inline bool isNotCellSpeculation(SpeculatedType value)
112 {
113     return !(value & SpecCell) && value;
114 }
115
116 inline bool isObjectSpeculation(SpeculatedType value)
117 {
118     return !!(value & SpecObject) && !(value & ~SpecObject);
119 }
120
121 inline bool isObjectOrOtherSpeculation(SpeculatedType value)
122 {
123     return !!(value & (SpecObject | SpecOther)) && !(value & ~(SpecObject | SpecOther));
124 }
125
126 inline bool isFinalObjectSpeculation(SpeculatedType value)
127 {
128     return value == SpecFinalObject;
129 }
130
131 inline bool isFinalObjectOrOtherSpeculation(SpeculatedType value)
132 {
133     return !!(value & (SpecFinalObject | SpecOther)) && !(value & ~(SpecFinalObject | SpecOther));
134 }
135
136 inline bool isStringIdentSpeculation(SpeculatedType value)
137 {
138     return value == SpecStringIdent;
139 }
140
141 inline bool isNotStringVarSpeculation(SpeculatedType value)
142 {
143     return !(value & SpecStringVar);
144 }
145
146 inline bool isStringSpeculation(SpeculatedType value)
147 {
148     return !!value && (value & SpecString) == value;
149 }
150
151 inline bool isStringOrOtherSpeculation(SpeculatedType value)
152 {
153     return !!value && (value & (SpecString | SpecOther)) == value;
154 }
155
156 inline bool isSymbolSpeculation(SpeculatedType value)
157 {
158     return value == SpecSymbol;
159 }
160
161 inline bool isArraySpeculation(SpeculatedType value)
162 {
163     return value == SpecArray;
164 }
165
166 inline bool isFunctionSpeculation(SpeculatedType value)
167 {
168     return value == SpecFunction;
169 }
170
171 inline bool isInt8ArraySpeculation(SpeculatedType value)
172 {
173     return value == SpecInt8Array;
174 }
175
176 inline bool isInt16ArraySpeculation(SpeculatedType value)
177 {
178     return value == SpecInt16Array;
179 }
180
181 inline bool isInt32ArraySpeculation(SpeculatedType value)
182 {
183     return value == SpecInt32Array;
184 }
185
186 inline bool isUint8ArraySpeculation(SpeculatedType value)
187 {
188     return value == SpecUint8Array;
189 }
190
191 inline bool isUint8ClampedArraySpeculation(SpeculatedType value)
192 {
193     return value == SpecUint8ClampedArray;
194 }
195
196 inline bool isUint16ArraySpeculation(SpeculatedType value)
197 {
198     return value == SpecUint16Array;
199 }
200
201 inline bool isUint32ArraySpeculation(SpeculatedType value)
202 {
203     return value == SpecUint32Array;
204 }
205
206 inline bool isFloat32ArraySpeculation(SpeculatedType value)
207 {
208     return value == SpecFloat32Array;
209 }
210
211 inline bool isFloat64ArraySpeculation(SpeculatedType value)
212 {
213     return value == SpecFloat64Array;
214 }
215
216 inline bool isDirectArgumentsSpeculation(SpeculatedType value)
217 {
218     return value == SpecDirectArguments;
219 }
220
221 inline bool isScopedArgumentsSpeculation(SpeculatedType value)
222 {
223     return value == SpecScopedArguments;
224 }
225
226 inline bool isActionableIntMutableArraySpeculation(SpeculatedType value)
227 {
228     return isInt8ArraySpeculation(value)
229         || isInt16ArraySpeculation(value)
230         || isInt32ArraySpeculation(value)
231         || isUint8ArraySpeculation(value)
232         || isUint8ClampedArraySpeculation(value)
233         || isUint16ArraySpeculation(value)
234         || isUint32ArraySpeculation(value);
235 }
236
237 inline bool isActionableFloatMutableArraySpeculation(SpeculatedType value)
238 {
239     return isFloat32ArraySpeculation(value)
240         || isFloat64ArraySpeculation(value);
241 }
242
243 inline bool isActionableTypedMutableArraySpeculation(SpeculatedType value)
244 {
245     return isActionableIntMutableArraySpeculation(value)
246         || isActionableFloatMutableArraySpeculation(value);
247 }
248
249 inline bool isActionableMutableArraySpeculation(SpeculatedType value)
250 {
251     return isArraySpeculation(value)
252         || isActionableTypedMutableArraySpeculation(value);
253 }
254
255 inline bool isActionableArraySpeculation(SpeculatedType value)
256 {
257     return isStringSpeculation(value)
258         || isDirectArgumentsSpeculation(value)
259         || isScopedArgumentsSpeculation(value)
260         || isActionableMutableArraySpeculation(value);
261 }
262
263 inline bool isArrayOrOtherSpeculation(SpeculatedType value)
264 {
265     return !!(value & (SpecArray | SpecOther)) && !(value & ~(SpecArray | SpecOther));
266 }
267
268 inline bool isStringObjectSpeculation(SpeculatedType value)
269 {
270     return value == SpecStringObject;
271 }
272
273 inline bool isStringOrStringObjectSpeculation(SpeculatedType value)
274 {
275     return !!value && !(value & ~(SpecString | SpecStringObject));
276 }
277
278 inline bool isRegExpObjectSpeculation(SpeculatedType value)
279 {
280     return value == SpecRegExpObject;
281 }
282
283 inline bool isBoolInt32Speculation(SpeculatedType value)
284 {
285     return value == SpecBoolInt32;
286 }
287
288 inline bool isInt32Speculation(SpeculatedType value)
289 {
290     return value && !(value & ~SpecInt32Only);
291 }
292
293 inline bool isInt32OrBooleanSpeculation(SpeculatedType value)
294 {
295     return value && !(value & ~(SpecBoolean | SpecInt32Only));
296 }
297
298 inline bool isInt32SpeculationForArithmetic(SpeculatedType value)
299 {
300     return !(value & (SpecFullDouble | SpecInt52Only));
301 }
302
303 inline bool isInt32OrBooleanSpeculationForArithmetic(SpeculatedType value)
304 {
305     return !(value & (SpecFullDouble | SpecInt52Only));
306 }
307
308 inline bool isInt32OrBooleanSpeculationExpectingDefined(SpeculatedType value)
309 {
310     return isInt32OrBooleanSpeculation(value & ~SpecOther);
311 }
312
313 inline bool isInt52Speculation(SpeculatedType value)
314 {
315     return value == SpecInt52Only;
316 }
317
318 inline bool isAnyIntSpeculation(SpeculatedType value)
319 {
320     return !!value && (value & SpecAnyInt) == value;
321 }
322
323 inline bool isAnyIntAsDoubleSpeculation(SpeculatedType value)
324 {
325     return value == SpecAnyIntAsDouble;
326 }
327
328 inline bool isDoubleRealSpeculation(SpeculatedType value)
329 {
330     return !!value && (value & SpecDoubleReal) == value;
331 }
332
333 inline bool isDoubleSpeculation(SpeculatedType value)
334 {
335     return !!value && (value & SpecFullDouble) == value;
336 }
337
338 inline bool isDoubleSpeculationForArithmetic(SpeculatedType value)
339 {
340     return !!(value & SpecFullDouble);
341 }
342
343 inline bool isBytecodeRealNumberSpeculation(SpeculatedType value)
344 {
345     return !!(value & SpecBytecodeRealNumber) && !(value & ~SpecBytecodeRealNumber);
346 }
347
348 inline bool isFullRealNumberSpeculation(SpeculatedType value)
349 {
350     return !!(value & SpecFullRealNumber) && !(value & ~SpecFullRealNumber);
351 }
352
353 inline bool isBytecodeNumberSpeculation(SpeculatedType value)
354 {
355     return !!(value & SpecBytecodeNumber) && !(value & ~SpecBytecodeNumber);
356 }
357
358 inline bool isFullNumberSpeculation(SpeculatedType value)
359 {
360     return !!(value & SpecFullNumber) && !(value & ~SpecFullNumber);
361 }
362
363 inline bool isFullNumberOrBooleanSpeculation(SpeculatedType value)
364 {
365     return value && !(value & ~(SpecFullNumber | SpecBoolean));
366 }
367
368 inline bool isFullNumberOrBooleanSpeculationExpectingDefined(SpeculatedType value)
369 {
370     return isFullNumberOrBooleanSpeculation(value & ~SpecOther);
371 }
372
373 inline bool isBooleanSpeculation(SpeculatedType value)
374 {
375     return value == SpecBoolean;
376 }
377
378 inline bool isOtherSpeculation(SpeculatedType value)
379 {
380     return value == SpecOther;
381 }
382
383 inline bool isMiscSpeculation(SpeculatedType value)
384 {
385     return !!value && !(value & ~SpecMisc);
386 }
387
388 inline bool isOtherOrEmptySpeculation(SpeculatedType value)
389 {
390     return !value || value == SpecOther;
391 }
392
393 inline bool isEmptySpeculation(SpeculatedType value)
394 {
395     return value == SpecEmpty;
396 }
397
398 inline bool isUntypedSpeculationForArithmetic(SpeculatedType value)
399 {
400     return !!(value & ~(SpecFullNumber | SpecBoolean));
401 }
402
403 inline bool isUntypedSpeculationForBitOps(SpeculatedType value)
404 {
405     return !!(value & ~(SpecFullNumber | SpecBoolean | SpecOther));
406 }
407
408 void dumpSpeculation(PrintStream&, SpeculatedType);
409 void dumpSpeculationAbbreviated(PrintStream&, SpeculatedType);
410
411 MAKE_PRINT_ADAPTOR(SpeculationDump, SpeculatedType, dumpSpeculation);
412 MAKE_PRINT_ADAPTOR(AbbreviatedSpeculationDump, SpeculatedType, dumpSpeculationAbbreviated);
413
414 // Merge two predictions. Note that currently this just does left | right. It may
415 // seem tempting to do so directly, but you would be doing so at your own peril,
416 // since the merging protocol SpeculatedType may change at any time (and has already
417 // changed several times in its history).
418 inline SpeculatedType mergeSpeculations(SpeculatedType left, SpeculatedType right)
419 {
420     return left | right;
421 }
422
423 template<typename T>
424 inline bool mergeSpeculation(T& left, SpeculatedType right)
425 {
426     SpeculatedType newSpeculation = static_cast<T>(mergeSpeculations(static_cast<SpeculatedType>(left), right));
427     bool result = newSpeculation != static_cast<SpeculatedType>(left);
428     left = newSpeculation;
429     return result;
430 }
431
432 inline bool speculationChecked(SpeculatedType actual, SpeculatedType desired)
433 {
434     return (actual | desired) == desired;
435 }
436
437 SpeculatedType speculationFromClassInfo(const ClassInfo*);
438 SpeculatedType speculationFromStructure(Structure*);
439 SpeculatedType speculationFromCell(JSCell*);
440 SpeculatedType speculationFromValue(JSValue);
441
442 SpeculatedType speculationFromTypedArrayType(TypedArrayType); // only valid for typed views.
443 TypedArrayType typedArrayTypeFromSpeculation(SpeculatedType);
444
445 SpeculatedType leastUpperBoundOfStrictlyEquivalentSpeculations(SpeculatedType);
446
447 bool valuesCouldBeEqual(SpeculatedType, SpeculatedType);
448
449 // Precise computation of the type of the result of a double computation after we
450 // already know that the inputs are doubles and that the result must be a double. Use
451 // the closest one of these that applies.
452 SpeculatedType typeOfDoubleSum(SpeculatedType, SpeculatedType);
453 SpeculatedType typeOfDoubleDifference(SpeculatedType, SpeculatedType);
454 SpeculatedType typeOfDoubleProduct(SpeculatedType, SpeculatedType);
455 SpeculatedType typeOfDoubleQuotient(SpeculatedType, SpeculatedType);
456 SpeculatedType typeOfDoubleMinMax(SpeculatedType, SpeculatedType);
457 SpeculatedType typeOfDoubleNegation(SpeculatedType);
458 SpeculatedType typeOfDoubleAbs(SpeculatedType);
459 SpeculatedType typeOfDoubleRounding(SpeculatedType);
460 SpeculatedType typeOfDoublePow(SpeculatedType, SpeculatedType);
461
462 // This conservatively models the behavior of arbitrary double operations.
463 SpeculatedType typeOfDoubleBinaryOp(SpeculatedType, SpeculatedType);
464 SpeculatedType typeOfDoubleUnaryOp(SpeculatedType);
465
466 } // namespace JSC
467
468 #endif // SpeculatedType_h