Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / bytecode / ArrayProfile.h
1 /*
2  * Copyright (C) 2012, 2013 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 #pragma once
27
28 #include "ConcurrentJSLock.h"
29 #include "Structure.h"
30 #include <wtf/SegmentedVector.h>
31
32 namespace JSC {
33
34 class CodeBlock;
35 class LLIntOffsetsExtractor;
36
37 // This is a bitfield where each bit represents an type of array access that we have seen.
38 // There are 16 indexing types that use the lower bits.
39 // There are 9 typed array types taking the bits 16 to 25.
40 typedef unsigned ArrayModes;
41
42 const ArrayModes Int8ArrayMode = 1 << 16;
43 const ArrayModes Int16ArrayMode = 1 << 17;
44 const ArrayModes Int32ArrayMode = 1 << 18;
45 const ArrayModes Uint8ArrayMode = 1 << 19;
46 const ArrayModes Uint8ClampedArrayMode = 1 << 20;
47 const ArrayModes Uint16ArrayMode = 1 << 21;
48 const ArrayModes Uint32ArrayMode = 1 << 22;
49 const ArrayModes Float32ArrayMode = 1 << 23;
50 const ArrayModes Float64ArrayMode = 1 << 24;
51
52 #define asArrayModes(type) \
53     (static_cast<unsigned>(1) << static_cast<unsigned>(type))
54
55 #define ALL_TYPED_ARRAY_MODES \
56     (Int8ArrayMode            \
57     | Int16ArrayMode          \
58     | Int32ArrayMode          \
59     | Uint8ArrayMode          \
60     | Uint8ClampedArrayMode   \
61     | Uint16ArrayMode         \
62     | Uint32ArrayMode         \
63     | Float32ArrayMode        \
64     | Float64ArrayMode        \
65     )
66
67 #define ALL_NON_ARRAY_ARRAY_MODES                       \
68     (asArrayModes(NonArray)                             \
69     | asArrayModes(NonArrayWithInt32)                   \
70     | asArrayModes(NonArrayWithDouble)                  \
71     | asArrayModes(NonArrayWithContiguous)              \
72     | asArrayModes(NonArrayWithArrayStorage)            \
73     | asArrayModes(NonArrayWithSlowPutArrayStorage)     \
74     | ALL_TYPED_ARRAY_MODES)
75
76 #define ALL_ARRAY_ARRAY_MODES                           \
77     (asArrayModes(ArrayClass)                           \
78     | asArrayModes(ArrayWithUndecided)                  \
79     | asArrayModes(ArrayWithInt32)                      \
80     | asArrayModes(ArrayWithDouble)                     \
81     | asArrayModes(ArrayWithContiguous)                 \
82     | asArrayModes(ArrayWithArrayStorage)               \
83     | asArrayModes(ArrayWithSlowPutArrayStorage))
84
85 #define ALL_ARRAY_MODES (ALL_NON_ARRAY_ARRAY_MODES | ALL_ARRAY_ARRAY_MODES)
86
87 inline ArrayModes arrayModeFromStructure(Structure* structure)
88 {
89     switch (structure->classInfo()->typedArrayStorageType) {
90     case TypeInt8:
91         return Int8ArrayMode;
92     case TypeUint8:
93         return Uint8ArrayMode;
94     case TypeUint8Clamped:
95         return Uint8ClampedArrayMode;
96     case TypeInt16:
97         return Int16ArrayMode;
98     case TypeUint16:
99         return Uint16ArrayMode;
100     case TypeInt32:
101         return Int32ArrayMode;
102     case TypeUint32:
103         return Uint32ArrayMode;
104     case TypeFloat32:
105         return Float32ArrayMode;
106     case TypeFloat64:
107         return Float64ArrayMode;
108     case TypeDataView:
109     case NotTypedArray:
110         break;
111     }
112     return asArrayModes(structure->indexingType());
113 }
114
115 void dumpArrayModes(PrintStream&, ArrayModes);
116 MAKE_PRINT_ADAPTOR(ArrayModesDump, ArrayModes, dumpArrayModes);
117
118 inline bool mergeArrayModes(ArrayModes& left, ArrayModes right)
119 {
120     ArrayModes newModes = left | right;
121     if (newModes == left)
122         return false;
123     left = newModes;
124     return true;
125 }
126
127 inline bool arrayModesAreClearOrTop(ArrayModes modes)
128 {
129     return !modes || modes == ALL_ARRAY_MODES;
130 }
131
132 // Checks if proven is a subset of expected.
133 inline bool arrayModesAlreadyChecked(ArrayModes proven, ArrayModes expected)
134 {
135     return (expected | proven) == expected;
136 }
137
138 inline bool arrayModesInclude(ArrayModes arrayModes, IndexingType shape)
139 {
140     return !!(arrayModes & (asArrayModes(NonArray | shape) | asArrayModes(ArrayClass | shape)));
141 }
142
143 inline bool shouldUseSlowPutArrayStorage(ArrayModes arrayModes)
144 {
145     return arrayModesInclude(arrayModes, SlowPutArrayStorageShape);
146 }
147
148 inline bool shouldUseFastArrayStorage(ArrayModes arrayModes)
149 {
150     return arrayModesInclude(arrayModes, ArrayStorageShape);
151 }
152
153 inline bool shouldUseContiguous(ArrayModes arrayModes)
154 {
155     return arrayModesInclude(arrayModes, ContiguousShape);
156 }
157
158 inline bool shouldUseDouble(ArrayModes arrayModes)
159 {
160     return arrayModesInclude(arrayModes, DoubleShape);
161 }
162
163 inline bool shouldUseInt32(ArrayModes arrayModes)
164 {
165     return arrayModesInclude(arrayModes, Int32Shape);
166 }
167
168 inline bool hasSeenArray(ArrayModes arrayModes)
169 {
170     return arrayModes & ALL_ARRAY_ARRAY_MODES;
171 }
172
173 inline bool hasSeenNonArray(ArrayModes arrayModes)
174 {
175     return arrayModes & ALL_NON_ARRAY_ARRAY_MODES;
176 }
177
178 class ArrayProfile {
179 public:
180     ArrayProfile()
181         : m_bytecodeOffset(std::numeric_limits<unsigned>::max())
182         , m_lastSeenStructureID(0)
183         , m_mayStoreToHole(false)
184         , m_outOfBounds(false)
185         , m_mayInterceptIndexedAccesses(false)
186         , m_usesOriginalArrayStructures(true)
187         , m_didPerformFirstRunPruning(false)
188         , m_observedArrayModes(0)
189     {
190     }
191     
192     ArrayProfile(unsigned bytecodeOffset)
193         : m_bytecodeOffset(bytecodeOffset)
194         , m_lastSeenStructureID(0)
195         , m_mayStoreToHole(false)
196         , m_outOfBounds(false)
197         , m_mayInterceptIndexedAccesses(false)
198         , m_usesOriginalArrayStructures(true)
199         , m_didPerformFirstRunPruning(false)
200         , m_observedArrayModes(0)
201     {
202     }
203     
204     unsigned bytecodeOffset() const { return m_bytecodeOffset; }
205     
206     StructureID* addressOfLastSeenStructureID() { return &m_lastSeenStructureID; }
207     ArrayModes* addressOfArrayModes() { return &m_observedArrayModes; }
208     bool* addressOfMayStoreToHole() { return &m_mayStoreToHole; }
209
210     void setOutOfBounds() { m_outOfBounds = true; }
211     bool* addressOfOutOfBounds() { return &m_outOfBounds; }
212     
213     void observeStructure(Structure* structure)
214     {
215         m_lastSeenStructureID = structure->id();
216     }
217     
218     void computeUpdatedPrediction(const ConcurrentJSLocker&, CodeBlock*);
219     void computeUpdatedPrediction(const ConcurrentJSLocker&, CodeBlock*, Structure* lastSeenStructure);
220     
221     ArrayModes observedArrayModes(const ConcurrentJSLocker&) const { return m_observedArrayModes; }
222     bool mayInterceptIndexedAccesses(const ConcurrentJSLocker&) const { return m_mayInterceptIndexedAccesses; }
223     
224     bool mayStoreToHole(const ConcurrentJSLocker&) const { return m_mayStoreToHole; }
225     bool outOfBounds(const ConcurrentJSLocker&) const { return m_outOfBounds; }
226     
227     bool usesOriginalArrayStructures(const ConcurrentJSLocker&) const { return m_usesOriginalArrayStructures; }
228     
229     CString briefDescription(const ConcurrentJSLocker&, CodeBlock*);
230     CString briefDescriptionWithoutUpdating(const ConcurrentJSLocker&);
231     
232 private:
233     friend class LLIntOffsetsExtractor;
234     
235     static Structure* polymorphicStructure() { return static_cast<Structure*>(reinterpret_cast<void*>(1)); }
236     
237     unsigned m_bytecodeOffset;
238     StructureID m_lastSeenStructureID;
239     bool m_mayStoreToHole; // This flag may become overloaded to indicate other special cases that were encountered during array access, as it depends on indexing type. Since we currently have basically just one indexing type (two variants of ArrayStorage), this flag for now just means exactly what its name implies.
240     bool m_outOfBounds;
241     bool m_mayInterceptIndexedAccesses : 1;
242     bool m_usesOriginalArrayStructures : 1;
243     bool m_didPerformFirstRunPruning : 1;
244     ArrayModes m_observedArrayModes;
245 };
246
247 typedef SegmentedVector<ArrayProfile, 4> ArrayProfileVector;
248
249 } // namespace JSC