8ec8f642117704ca768191dc49a913d5f5ced756
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSArray.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2003-2018 Apple Inc. All rights reserved.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Lesser General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Lesser General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Lesser General Public
16  *  License along with this library; if not, write to the Free Software
17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  */
20
21 #pragma once
22
23 #include "ArgList.h"
24 #include "ArrayConventions.h"
25 #include "ButterflyInlines.h"
26 #include "JSCellInlines.h"
27 #include "JSObject.h"
28
29 namespace JSC {
30
31 class JSArray;
32 class LLIntOffsetsExtractor;
33
34 extern const ASCIILiteral LengthExceededTheMaximumArrayLengthError;
35
36 class JSArray : public JSNonFinalObject {
37     friend class LLIntOffsetsExtractor;
38     friend class Walker;
39     friend class JIT;
40
41 public:
42     typedef JSNonFinalObject Base;
43     static const unsigned StructureFlags = Base::StructureFlags | OverridesGetOwnPropertySlot | OverridesGetPropertyNames;
44
45     static size_t allocationSize(Checked<size_t> inlineCapacity)
46     {
47         ASSERT_UNUSED(inlineCapacity, !inlineCapacity);
48         return sizeof(JSArray);
49     }
50         
51 protected:
52     explicit JSArray(VM& vm, Structure* structure, Butterfly* butterfly)
53         : JSNonFinalObject(vm, structure, butterfly)
54     {
55     }
56
57 public:
58     static JSArray* tryCreate(VM&, Structure*, unsigned initialLength = 0);
59     static JSArray* tryCreate(VM&, Structure*, unsigned initialLength, unsigned vectorLengthHint);
60     static JSArray* create(VM&, Structure*, unsigned initialLength = 0);
61     static JSArray* createWithButterfly(VM&, GCDeferralContext*, Structure*, Butterfly*);
62
63     // tryCreateUninitializedRestricted is used for fast construction of arrays whose size and
64     // contents are known at time of creation. This is a restricted API for careful use only in
65     // performance critical code paths. If you don't have a good reason to use it, you probably
66     // shouldn't use it. Instead, you should go with
67     //   - JSArray::tryCreate() or JSArray::create() instead of tryCreateUninitializedRestricted(), and
68     //   - putDirectIndex() instead of initializeIndex().
69     //
70     // Clients of this interface must:
71     //   - null-check the result (indicating out of memory, or otherwise unable to allocate vector).
72     //   - call 'initializeIndex' for all properties in sequence, for 0 <= i < initialLength.
73     //   - Provide a valid GCDefferalContext* if they might garbage collect when initializing properties,
74     //     otherwise the caller can provide a null GCDefferalContext*.
75     //   - Provide a local stack instance of ObjectInitializationScope at the call site.
76     //
77     JS_EXPORT_PRIVATE static JSArray* tryCreateUninitializedRestricted(ObjectInitializationScope&, GCDeferralContext*, Structure*, unsigned initialLength);
78     static JSArray* tryCreateUninitializedRestricted(ObjectInitializationScope& scope, Structure* structure, unsigned initialLength)
79     {
80         return tryCreateUninitializedRestricted(scope, nullptr, structure, initialLength);
81     }
82
83     JS_EXPORT_PRIVATE static bool defineOwnProperty(JSObject*, ExecState*, PropertyName, const PropertyDescriptor&, bool throwException);
84
85     JS_EXPORT_PRIVATE static bool getOwnPropertySlot(JSObject*, ExecState*, PropertyName, PropertySlot&);
86
87     DECLARE_EXPORT_INFO;
88
89     // OK if we know this is a JSArray, but not if it could be an object of a derived class; for RuntimeArray this always returns 0.
90     unsigned length() const { return getArrayLength(); }
91
92     // OK to use on new arrays, but not if it might be a RegExpMatchArray or RuntimeArray.
93     JS_EXPORT_PRIVATE bool setLength(ExecState*, unsigned, bool throwException = false);
94
95     void pushInline(ExecState*, JSValue);
96     JS_EXPORT_PRIVATE void push(ExecState*, JSValue);
97     JS_EXPORT_PRIVATE JSValue pop(ExecState*);
98
99     JSArray* fastSlice(ExecState&, unsigned startIndex, unsigned count);
100
101     bool canFastCopy(VM&, JSArray* otherArray);
102     // This function returns NonArray if the indexing types are not compatable for copying.
103     IndexingType mergeIndexingTypeForCopying(IndexingType other);
104     bool appendMemcpy(ExecState*, VM&, unsigned startIndex, JSArray* otherArray);
105
106     enum ShiftCountMode {
107         // This form of shift hints that we're doing queueing. With this assumption in hand,
108         // we convert to ArrayStorage, which has queue optimizations.
109         ShiftCountForShift,
110             
111         // This form of shift hints that we're just doing care and feeding on an array that
112         // is probably typically used for ordinary accesses. With this assumption in hand,
113         // we try to preserve whatever indexing type it has already.
114         ShiftCountForSplice
115     };
116
117     bool shiftCountForShift(ExecState* exec, unsigned startIndex, unsigned count)
118     {
119         VM& vm = exec->vm();
120         return shiftCountWithArrayStorage(vm, startIndex, count, ensureArrayStorage(vm));
121     }
122     bool shiftCountForSplice(ExecState* exec, unsigned& startIndex, unsigned count)
123     {
124         return shiftCountWithAnyIndexingType(exec, startIndex, count);
125     }
126     template<ShiftCountMode shiftCountMode>
127     bool shiftCount(ExecState* exec, unsigned& startIndex, unsigned count)
128     {
129         switch (shiftCountMode) {
130         case ShiftCountForShift:
131             return shiftCountForShift(exec, startIndex, count);
132         case ShiftCountForSplice:
133             return shiftCountForSplice(exec, startIndex, count);
134         default:
135             CRASH();
136             return false;
137         }
138     }
139         
140     bool unshiftCountForShift(ExecState* exec, unsigned startIndex, unsigned count)
141     {
142         return unshiftCountWithArrayStorage(exec, startIndex, count, ensureArrayStorage(exec->vm()));
143     }
144     bool unshiftCountForSplice(ExecState* exec, unsigned startIndex, unsigned count)
145     {
146         return unshiftCountWithAnyIndexingType(exec, startIndex, count);
147     }
148     template<ShiftCountMode shiftCountMode>
149     bool unshiftCount(ExecState* exec, unsigned startIndex, unsigned count)
150     {
151         switch (shiftCountMode) {
152         case ShiftCountForShift:
153             return unshiftCountForShift(exec, startIndex, count);
154         case ShiftCountForSplice:
155             return unshiftCountForSplice(exec, startIndex, count);
156         default:
157             CRASH();
158             return false;
159         }
160     }
161
162     JS_EXPORT_PRIVATE void fillArgList(ExecState*, MarkedArgumentBuffer&);
163     JS_EXPORT_PRIVATE void copyToArguments(ExecState*, VirtualRegister firstElementDest, unsigned offset, unsigned length);
164
165     JS_EXPORT_PRIVATE bool isIteratorProtocolFastAndNonObservable();
166
167     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype, IndexingType indexingType)
168     {
169         return Structure::create(vm, globalObject, prototype, TypeInfo(ArrayType, StructureFlags), info(), indexingType);
170     }
171         
172 protected:
173     void finishCreation(VM& vm)
174     {
175         Base::finishCreation(vm);
176         ASSERT(jsDynamicCast<JSArray*>(vm, this));
177         ASSERT_WITH_MESSAGE(type() == ArrayType || type() == DerivedArrayType, "Instance inheriting JSArray should have either ArrayType or DerivedArrayType");
178     }
179
180     static bool put(JSCell*, ExecState*, PropertyName, JSValue, PutPropertySlot&);
181
182     static bool deleteProperty(JSCell*, ExecState*, PropertyName);
183     JS_EXPORT_PRIVATE static void getOwnNonIndexPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
184
185 private:
186     bool isLengthWritable()
187     {
188         ArrayStorage* storage = arrayStorageOrNull();
189         if (!storage)
190             return true;
191         SparseArrayValueMap* map = storage->m_sparseMap.get();
192         return !map || !map->lengthIsReadOnly();
193     }
194         
195     bool shiftCountWithAnyIndexingType(ExecState*, unsigned& startIndex, unsigned count);
196     JS_EXPORT_PRIVATE bool shiftCountWithArrayStorage(VM&, unsigned startIndex, unsigned count, ArrayStorage*);
197
198     bool unshiftCountWithAnyIndexingType(ExecState*, unsigned startIndex, unsigned count);
199     bool unshiftCountWithArrayStorage(ExecState*, unsigned startIndex, unsigned count, ArrayStorage*);
200     bool unshiftCountSlowCase(const AbstractLocker&, VM&, DeferGC&, bool, unsigned);
201
202     bool setLengthWithArrayStorage(ExecState*, unsigned newLength, bool throwException, ArrayStorage*);
203     void setLengthWritable(ExecState*, bool writable);
204 };
205
206 inline Butterfly* tryCreateArrayButterfly(VM& vm, JSObject* intendedOwner, unsigned initialLength)
207 {
208     Butterfly* butterfly = Butterfly::tryCreate(
209         vm, intendedOwner, 0, 0, true, baseIndexingHeaderForArrayStorage(initialLength),
210         ArrayStorage::sizeFor(BASE_ARRAY_STORAGE_VECTOR_LEN));
211     if (!butterfly)
212         return nullptr;
213     ArrayStorage* storage = butterfly->arrayStorage();
214     storage->m_sparseMap.clear();
215     storage->m_indexBias = 0;
216     storage->m_numValuesInVector = 0;
217     return butterfly;
218 }
219
220 inline JSArray* JSArray::tryCreate(VM& vm, Structure* structure, unsigned initialLength, unsigned vectorLengthHint)
221 {
222     ASSERT(vectorLengthHint >= initialLength);
223     unsigned outOfLineStorage = structure->outOfLineCapacity();
224
225     Butterfly* butterfly;
226     IndexingType indexingType = structure->indexingType();
227     if (LIKELY(!hasAnyArrayStorage(indexingType))) {
228         ASSERT(
229             hasUndecided(indexingType)
230             || hasInt32(indexingType)
231             || hasDouble(indexingType)
232             || hasContiguous(indexingType));
233
234         if (UNLIKELY(vectorLengthHint > MAX_STORAGE_VECTOR_LENGTH))
235             return nullptr;
236
237         unsigned vectorLength = Butterfly::optimalContiguousVectorLength(structure, vectorLengthHint);
238         void* temp = vm.jsValueGigacageAuxiliarySpace.allocateNonVirtual(
239             vm,
240             Butterfly::totalSize(0, outOfLineStorage, true, vectorLength * sizeof(EncodedJSValue)),
241             nullptr, AllocationFailureMode::ReturnNull);
242         if (!temp)
243             return nullptr;
244         butterfly = Butterfly::fromBase(temp, 0, outOfLineStorage);
245         butterfly->setVectorLength(vectorLength);
246         butterfly->setPublicLength(initialLength);
247         if (hasDouble(indexingType))
248             clearArray(butterfly->contiguousDouble().data(), vectorLength);
249         else
250             clearArray(butterfly->contiguous().data(), vectorLength);
251     } else {
252         ASSERT(
253             indexingType == ArrayWithSlowPutArrayStorage
254             || indexingType == ArrayWithArrayStorage);
255         butterfly = tryCreateArrayButterfly(vm, nullptr, initialLength);
256         if (!butterfly)
257             return nullptr;
258         for (unsigned i = 0; i < BASE_ARRAY_STORAGE_VECTOR_LEN; ++i)
259             butterfly->arrayStorage()->m_vector[i].clear();
260     }
261
262     return createWithButterfly(vm, nullptr, structure, butterfly);
263 }
264
265 inline JSArray* JSArray::tryCreate(VM& vm, Structure* structure, unsigned initialLength)
266 {
267     return tryCreate(vm, structure, initialLength, initialLength);
268 }
269
270 inline JSArray* JSArray::create(VM& vm, Structure* structure, unsigned initialLength)
271 {
272     JSArray* result = JSArray::tryCreate(vm, structure, initialLength);
273     RELEASE_ASSERT(result);
274
275     return result;
276 }
277
278 inline JSArray* JSArray::createWithButterfly(VM& vm, GCDeferralContext* deferralContext, Structure* structure, Butterfly* butterfly)
279 {
280     JSArray* array = new (NotNull, allocateCell<JSArray>(vm.heap, deferralContext)) JSArray(vm, structure, butterfly);
281     array->finishCreation(vm);
282     return array;
283 }
284
285 JSArray* asArray(JSValue);
286
287 inline JSArray* asArray(JSCell* cell)
288 {
289     ASSERT(cell->inherits<JSArray>(*cell->vm()));
290     return jsCast<JSArray*>(cell);
291 }
292
293 inline JSArray* asArray(JSValue value)
294 {
295     return asArray(value.asCell());
296 }
297
298 inline bool isJSArray(JSCell* cell)
299 {
300     ASSERT((cell->classInfo(*cell->vm()) == JSArray::info()) == (cell->type() == ArrayType));
301     return cell->type() == ArrayType;
302 }
303
304 inline bool isJSArray(JSValue v) { return v.isCell() && isJSArray(v.asCell()); }
305
306 JS_EXPORT_PRIVATE JSArray* constructArray(ExecState*, Structure*, const ArgList& values);
307 JS_EXPORT_PRIVATE JSArray* constructArray(ExecState*, Structure*, const JSValue* values, unsigned length);
308 JS_EXPORT_PRIVATE JSArray* constructArrayNegativeIndexed(ExecState*, Structure*, const JSValue* values, unsigned length);
309
310 } // namespace JSC