Try ripping out inferred types because it might be a performance improvement
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGAbstractValue.cpp
1 /*
2  * Copyright (C) 2013-2018 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 "DFGAbstractValue.h"
28
29 #if ENABLE(DFG_JIT)
30
31 #include "DFGGraph.h"
32 #include "JSCInlines.h"
33 #include "TrackedReferences.h"
34
35 namespace JSC { namespace DFG {
36
37 void AbstractValue::observeTransitions(const TransitionVector& vector)
38 {
39     if (m_type & SpecCell) {
40         m_structure.observeTransitions(vector);
41         ArrayModes newModes = 0;
42         for (unsigned i = vector.size(); i--;) {
43             if (m_arrayModes & arrayModesFromStructure(vector[i].previous.get()))
44                 newModes |= arrayModesFromStructure(vector[i].next.get());
45         }
46         m_arrayModes |= newModes;
47     }
48     checkConsistency();
49 }
50
51 void AbstractValue::set(Graph& graph, const FrozenValue& value, StructureClobberState clobberState)
52 {
53     if (!!value && value.value().isCell()) {
54         Structure* structure = value.structure();
55         StructureRegistrationResult result;
56         RegisteredStructure registeredStructure = graph.registerStructure(structure, result);
57         if (result == StructureRegisteredAndWatched) {
58             m_structure = registeredStructure;
59             if (clobberState == StructuresAreClobbered) {
60                 m_arrayModes = ALL_ARRAY_MODES;
61                 m_structure.clobber();
62             } else
63                 m_arrayModes = arrayModesFromStructure(structure);
64         } else {
65             m_structure.makeTop();
66             m_arrayModes = ALL_ARRAY_MODES;
67         }
68     } else {
69         m_structure.clear();
70         m_arrayModes = 0;
71     }
72     
73     m_type = speculationFromValue(value.value());
74     m_value = value.value();
75     
76     checkConsistency();
77     assertIsRegistered(graph);
78 }
79
80 void AbstractValue::set(Graph& graph, Structure* structure)
81 {
82     set(graph, graph.registerStructure(structure));
83 }
84
85 void AbstractValue::set(Graph& graph, RegisteredStructure structure)
86 {
87     RELEASE_ASSERT(structure);
88     
89     m_structure = structure;
90     m_arrayModes = arrayModesFromStructure(structure.get());
91     m_type = speculationFromStructure(structure.get());
92     m_value = JSValue();
93     
94     checkConsistency();
95     assertIsRegistered(graph);
96 }
97
98 void AbstractValue::set(Graph& graph, const RegisteredStructureSet& set)
99 {
100     m_structure = set;
101     m_arrayModes = set.arrayModesFromStructures();
102     m_type = set.speculationFromStructures();
103     m_value = JSValue();
104     
105     checkConsistency();
106     assertIsRegistered(graph);
107 }
108
109 void AbstractValue::setType(Graph& graph, SpeculatedType type)
110 {
111     SpeculatedType cellType = type & SpecCell;
112     if (cellType) {
113         if (!(cellType & ~SpecString))
114             m_structure = graph.stringStructure;
115         else if (isSymbolSpeculation(cellType))
116             m_structure = graph.symbolStructure;
117         else
118             m_structure.makeTop();
119         m_arrayModes = ALL_ARRAY_MODES;
120     } else {
121         m_structure.clear();
122         m_arrayModes = 0;
123     }
124     m_type = type;
125     m_value = JSValue();
126     checkConsistency();
127 }
128
129 void AbstractValue::fixTypeForRepresentation(Graph& graph, NodeFlags representation, Node* node)
130 {
131     if (representation == NodeResultDouble) {
132         if (m_value) {
133             DFG_ASSERT(graph, node, m_value.isNumber());
134             if (m_value.isInt32())
135                 m_value = jsDoubleNumber(m_value.asNumber());
136         }
137         if (m_type & SpecAnyInt) {
138             m_type &= ~SpecAnyInt;
139             m_type |= SpecAnyIntAsDouble;
140         }
141         if (m_type & ~SpecFullDouble)
142             DFG_CRASH(graph, node, toCString("Abstract value ", *this, " for double node has type outside SpecFullDouble.\n").data());
143     } else if (representation == NodeResultInt52) {
144         if (m_type & SpecAnyIntAsDouble) {
145             m_type &= ~SpecAnyIntAsDouble;
146             m_type |= SpecInt52Only;
147         }
148         if (m_type & ~SpecAnyInt)
149             DFG_CRASH(graph, node, toCString("Abstract value ", *this, " for int52 node has type outside SpecAnyInt.\n").data());
150     } else {
151         if (m_type & SpecInt52Only) {
152             m_type &= ~SpecInt52Only;
153             m_type |= SpecAnyIntAsDouble;
154         }
155         if (m_type & ~SpecBytecodeTop)
156             DFG_CRASH(graph, node, toCString("Abstract value ", *this, " for value node has type outside SpecBytecodeTop.\n").data());
157     }
158     
159     checkConsistency();
160 }
161
162 void AbstractValue::fixTypeForRepresentation(Graph& graph, Node* node)
163 {
164     fixTypeForRepresentation(graph, node->result(), node);
165 }
166
167 bool AbstractValue::mergeOSREntryValue(Graph& graph, JSValue value)
168 {
169     AbstractValue oldMe = *this;
170     
171     if (isClear()) {
172         FrozenValue* frozenValue = graph.freeze(value);
173         if (frozenValue->pointsToHeap()) {
174             m_structure = graph.registerStructure(frozenValue->structure());
175             m_arrayModes = arrayModesFromStructure(frozenValue->structure());
176         } else {
177             m_structure.clear();
178             m_arrayModes = 0;
179         }
180         
181         m_type = speculationFromValue(value);
182         m_value = value;
183     } else {
184         mergeSpeculation(m_type, speculationFromValue(value));
185         if (!!value && value.isCell()) {
186             RegisteredStructure structure = graph.registerStructure(value.asCell()->structure(graph.m_vm));
187             mergeArrayModes(m_arrayModes, arrayModesFromStructure(structure.get()));
188             m_structure.merge(RegisteredStructureSet(structure));
189         }
190         if (m_value != value)
191             m_value = JSValue();
192     }
193     
194     checkConsistency();
195     assertIsRegistered(graph);
196     
197     return oldMe != *this;
198 }
199
200 FiltrationResult AbstractValue::filter(
201     Graph& graph, const RegisteredStructureSet& other, SpeculatedType admittedTypes)
202 {
203     ASSERT(!(admittedTypes & SpecCell));
204     
205     if (isClear())
206         return FiltrationOK;
207     
208     // FIXME: This could be optimized for the common case of m_type not
209     // having structures, array modes, or a specific value.
210     // https://bugs.webkit.org/show_bug.cgi?id=109663
211     
212     m_type &= other.speculationFromStructures() | admittedTypes;
213     m_arrayModes &= other.arrayModesFromStructures();
214     m_structure.filter(other);
215     
216     // It's possible that prior to the above two statements we had (Foo, TOP), where
217     // Foo is a SpeculatedType that is disjoint with the passed RegisteredStructureSet. In that
218     // case, we will now have (None, [someStructure]). In general, we need to make
219     // sure that new information gleaned from the SpeculatedType needs to be fed back
220     // into the information gleaned from the RegisteredStructureSet.
221     m_structure.filter(m_type);
222     
223     filterArrayModesByType();
224     filterValueByType();
225     return normalizeClarity(graph);
226 }
227
228 FiltrationResult AbstractValue::changeStructure(Graph& graph, const RegisteredStructureSet& other)
229 {
230     m_type &= other.speculationFromStructures();
231     m_arrayModes = other.arrayModesFromStructures();
232     m_structure = other;
233     
234     filterValueByType();
235     
236     return normalizeClarity(graph);
237 }
238
239 FiltrationResult AbstractValue::filterArrayModes(ArrayModes arrayModes)
240 {
241     ASSERT(arrayModes);
242     
243     if (isClear())
244         return FiltrationOK;
245     
246     m_type &= SpecCell;
247     m_arrayModes &= arrayModes;
248     return normalizeClarity();
249 }
250
251 FiltrationResult AbstractValue::filterClassInfo(Graph& graph, const ClassInfo* classInfo)
252 {
253     // FIXME: AI should track ClassInfo to leverage hierarchical class information.
254     // https://bugs.webkit.org/show_bug.cgi?id=162989
255     if (isClear())
256         return FiltrationOK;
257
258     m_type &= speculationFromClassInfo(classInfo);
259     m_structure.filterClassInfo(classInfo);
260
261     m_structure.filter(m_type);
262
263     filterArrayModesByType();
264     filterValueByType();
265     return normalizeClarity(graph);
266 }
267
268 FiltrationResult AbstractValue::filterSlow(SpeculatedType type)
269 {
270     m_type &= type;
271     
272     // It's possible that prior to this filter() call we had, say, (Final, TOP), and
273     // the passed type is Array. At this point we'll have (None, TOP). The best way
274     // to ensure that the structure filtering does the right thing is to filter on
275     // the new type (None) rather than the one passed (Array).
276     m_structure.filter(m_type);
277     filterArrayModesByType();
278     filterValueByType();
279     return normalizeClarity();
280 }
281
282 FiltrationResult AbstractValue::fastForwardToAndFilterSlow(AbstractValueClobberEpoch newEpoch, SpeculatedType type)
283 {
284     if (newEpoch != m_effectEpoch)
285         fastForwardToSlow(newEpoch);
286     
287     return filterSlow(type);
288 }
289
290 FiltrationResult AbstractValue::filterByValue(const FrozenValue& value)
291 {
292     FiltrationResult result = filter(speculationFromValue(value.value()));
293     if (m_type)
294         m_value = value.value();
295     return result;
296 }
297
298 bool AbstractValue::contains(RegisteredStructure structure) const
299 {
300     return couldBeType(speculationFromStructure(structure.get()))
301         && (m_arrayModes & arrayModesFromStructure(structure.get()))
302         && m_structure.contains(structure);
303 }
304
305 FiltrationResult AbstractValue::filter(const AbstractValue& other)
306 {
307     m_type &= other.m_type;
308     m_structure.filter(other.m_structure);
309     m_arrayModes &= other.m_arrayModes;
310
311     m_structure.filter(m_type);
312     filterArrayModesByType();
313     filterValueByType();
314     
315     if (normalizeClarity() == Contradiction)
316         return Contradiction;
317     
318     if (m_value == other.m_value)
319         return FiltrationOK;
320     
321     // Neither of us are BOTTOM, so an empty value means TOP.
322     if (!m_value) {
323         // We previously didn't prove a value but now we have done so.
324         m_value = other.m_value; 
325         return FiltrationOK;
326     }
327     
328     if (!other.m_value) {
329         // We had proved a value but the other guy hadn't, so keep our proof.
330         return FiltrationOK;
331     }
332     
333     // We both proved there to be a specific value but they are different.
334     clear();
335     return Contradiction;
336 }
337
338 void AbstractValue::filterValueByType()
339 {
340     // We could go further, and ensure that if the futurePossibleStructure contravenes
341     // the value, then we could clear both of those things. But that's unlikely to help
342     // in any realistic scenario, so we don't do it. Simpler is better.
343
344     if (!!m_type) {
345         // The type is still non-empty. It may be that the new type renders
346         // the value empty because it contravenes the constant value we had.
347         if (m_value && !validateType(m_value))
348             clear();
349         return;
350     }
351     
352     // The type has been rendered empty. That means that the value must now be invalid,
353     // as well.
354     ASSERT(!m_value || !validateType(m_value));
355     m_value = JSValue();
356 }
357
358 void AbstractValue::filterArrayModesByType()
359 {
360     if (!(m_type & SpecCell))
361         m_arrayModes = 0;
362     else if (!(m_type & ~SpecArray))
363         m_arrayModes &= ALL_ARRAY_ARRAY_MODES;
364     
365     // NOTE: If m_type doesn't have SpecArray set, that doesn't mean that the
366     // array modes have to be a subset of ALL_NON_ARRAY_ARRAY_MODES, since
367     // in the speculated type type-system, RegExpMatchesArry and ArrayPrototype
368     // are Otherobj (since they are not *exactly* JSArray) but in the ArrayModes
369     // type system they are arrays (since they expose the magical length
370     // property and are otherwise allocated using array allocation). Hence the
371     // following would be wrong:
372     //
373     // if (!(m_type & SpecArray))
374     //    m_arrayModes &= ALL_NON_ARRAY_ARRAY_MODES;
375 }
376
377 bool AbstractValue::shouldBeClear() const
378 {
379     if (m_type == SpecNone)
380         return true;
381     
382     if (!(m_type & ~SpecCell)
383         && (!m_arrayModes || m_structure.isClear()))
384         return true;
385     
386     return false;
387 }
388
389 FiltrationResult AbstractValue::normalizeClarity()
390 {
391     // It's useful to be able to quickly check if an abstract value is clear.
392     // This normalizes everything to make that easy.
393     
394     FiltrationResult result;
395     
396     if (shouldBeClear()) {
397         clear();
398         result = Contradiction;
399     } else
400         result = FiltrationOK;
401
402     checkConsistency();
403     
404     return result;
405 }
406
407 FiltrationResult AbstractValue::normalizeClarity(Graph& graph)
408 {
409     FiltrationResult result = normalizeClarity();
410     assertIsRegistered(graph);
411     return result;
412 }
413
414 #if !ASSERT_DISABLED
415 void AbstractValue::checkConsistency() const
416 {
417     if (!(m_type & SpecCell)) {
418         ASSERT(m_structure.isClear());
419         ASSERT(!m_arrayModes);
420     }
421     
422     if (isClear())
423         ASSERT(!m_value);
424     
425     if (!!m_value) {
426         SpeculatedType type = m_type;
427         // This relaxes the assertion below a bit, since we don't know the representation of the
428         // node.
429         if (type & SpecInt52Only)
430             type |= SpecAnyIntAsDouble;
431         ASSERT(mergeSpeculations(type, speculationFromValue(m_value)) == type);
432     }
433     
434     // Note that it's possible for a prediction like (Final, []). This really means that
435     // the value is bottom and that any code that uses the value is unreachable. But
436     // we don't want to get pedantic about this as it would only increase the computational
437     // complexity of the code.
438 }
439
440 void AbstractValue::assertIsRegistered(Graph& graph) const
441 {
442     m_structure.assertIsRegistered(graph);
443 }
444 #endif
445
446 ResultType AbstractValue::resultType() const
447 {
448     ASSERT(isType(SpecBytecodeTop));
449     if (isType(SpecBoolean))
450         return ResultType::booleanType();
451     if (isType(SpecInt32Only))
452         return ResultType::numberTypeIsInt32();
453     if (isType(SpecBytecodeNumber))
454         return ResultType::numberType();
455     if (isType(SpecString))
456         return ResultType::stringType();
457     if (isType(SpecString | SpecBytecodeNumber))
458         return ResultType::stringOrNumberType();
459     return ResultType::unknownType();
460 }
461
462 void AbstractValue::dump(PrintStream& out) const
463 {
464     dumpInContext(out, 0);
465 }
466
467 void AbstractValue::dumpInContext(PrintStream& out, DumpContext* context) const
468 {
469     out.print("(", SpeculationDump(m_type));
470     if (m_type & SpecCell) {
471         out.print(
472             ", ", ArrayModesDump(m_arrayModes), ", ",
473             inContext(m_structure, context));
474     }
475     if (!!m_value)
476         out.print(", ", inContext(m_value, context));
477     out.print(", ", m_effectEpoch);
478     out.print(")");
479 }
480
481 void AbstractValue::validateReferences(const TrackedReferences& trackedReferences)
482 {
483     trackedReferences.check(m_value);
484     m_structure.validateReferences(trackedReferences);
485 }
486
487 #if USE(JSVALUE64) && !defined(NDEBUG)
488 void AbstractValue::ensureCanInitializeWithZeros()
489 {
490     std::aligned_storage<sizeof(AbstractValue), alignof(AbstractValue)>::type zeroFilledStorage;
491     memset(static_cast<void*>(&zeroFilledStorage), 0, sizeof(AbstractValue));
492     ASSERT(*this == *static_cast<AbstractValue*>(static_cast<void*>(&zeroFilledStorage)));
493 }
494 #endif
495
496 void AbstractValue::fastForwardToSlow(AbstractValueClobberEpoch newEpoch)
497 {
498     ASSERT(newEpoch != m_effectEpoch);
499     
500     if (newEpoch.clobberEpoch() != m_effectEpoch.clobberEpoch())
501         clobberStructures();
502     if (newEpoch.structureClobberState() == StructuresAreWatched)
503         m_structure.observeInvalidationPoint();
504     
505     m_effectEpoch = newEpoch;
506     
507     checkConsistency();
508 }
509
510 } } // namespace JSC::DFG
511
512 #endif // ENABLE(DFG_JIT)
513