Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSCell.h
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003-2017 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #pragma once
24
25 #include "CallData.h"
26 #include "CellState.h"
27 #include "ConstructData.h"
28 #include "EnumerationMode.h"
29 #include "Heap.h"
30 #include "HeapCell.h"
31 #include "IndexingType.h"
32 #include "JSLock.h"
33 #include "JSTypeInfo.h"
34 #include "SlotVisitor.h"
35 #include "TypedArrayType.h"
36 #include "WriteBarrier.h"
37
38 namespace JSC {
39
40 class CopyVisitor;
41 class GCDeferralContext;
42 class ExecState;
43 class Identifier;
44 class JSArrayBufferView;
45 class JSDestructibleObject;
46 class JSGlobalObject;
47 class LLIntOffsetsExtractor;
48 class PropertyDescriptor;
49 class PropertyNameArray;
50 class Structure;
51
52 enum class AllocationFailureMode {
53     ShouldAssertOnFailure,
54     ShouldNotAssertOnFailure
55 };
56
57 enum class GCDeferralContextArgPresense {
58     HasArg,
59     DoesNotHaveArg
60 };
61
62 template<typename T> void* allocateCell(Heap&, size_t = sizeof(T));
63 template<typename T> void* tryAllocateCell(Heap&, size_t = sizeof(T));
64 template<typename T> void* allocateCell(Heap&, GCDeferralContext*, size_t = sizeof(T));
65 template<typename T> void* tryAllocateCell(Heap&, GCDeferralContext*, size_t = sizeof(T));
66
67 #define DECLARE_EXPORT_INFO                                                  \
68     protected:                                                               \
69         static JS_EXPORTDATA const ::JSC::ClassInfo s_info;                  \
70     public:                                                                  \
71         static constexpr const ::JSC::ClassInfo* info() { return &s_info; }
72
73 #define DECLARE_INFO                                                         \
74     protected:                                                               \
75         static const ::JSC::ClassInfo s_info;                                \
76     public:                                                                  \
77         static constexpr const ::JSC::ClassInfo* info() { return &s_info; }
78
79 class JSCell : public HeapCell {
80     friend class JSValue;
81     friend class MarkedBlock;
82     template<typename T, AllocationFailureMode, GCDeferralContextArgPresense>
83     friend void* tryAllocateCellHelper(Heap&, GCDeferralContext*, size_t);
84
85 public:
86     static const unsigned StructureFlags = 0;
87
88     static const bool needsDestruction = false;
89
90     // Don't call this directly. Call JSC::subspaceFor<Type>(vm) instead.
91     // FIXME: Refer to Subspace by reference.
92     // https://bugs.webkit.org/show_bug.cgi?id=166988
93     template<typename CellType>
94     static Subspace* subspaceFor(VM&);
95
96     static JSCell* seenMultipleCalleeObjects() { return bitwise_cast<JSCell*>(static_cast<uintptr_t>(1)); }
97
98     enum CreatingEarlyCellTag { CreatingEarlyCell };
99     JSCell(CreatingEarlyCellTag);
100     
101 protected:
102     JSCell(VM&, Structure*);
103     JS_EXPORT_PRIVATE static void destroy(JSCell*);
104
105 public:
106     // Querying the type.
107     bool isString() const;
108     bool isSymbol() const;
109     bool isObject() const;
110     bool isGetterSetter() const;
111     bool isCustomGetterSetter() const;
112     bool isProxy() const;
113     bool inherits(VM&, const ClassInfo*) const;
114     bool isAPIValueWrapper() const;
115     
116     // Each cell has a built-in lock. Currently it's simply available for use if you need it. It's
117     // a full-blown WTF::Lock. Note that this lock is currently used in JSArray and that lock's
118     // ordering with the Structure lock is that the Structure lock must be acquired first.
119     void lock();
120     bool tryLock();
121     void unlock();
122     bool isLocked() const;
123     
124     JSType type() const;
125     IndexingType indexingTypeAndMisc() const;
126     IndexingType indexingType() const;
127     StructureID structureID() const { return m_structureID; }
128     Structure* structure() const;
129     Structure* structure(VM&) const;
130     void setStructure(VM&, Structure*);
131     void setStructureIDDirectly(StructureID id) { m_structureID = id; }
132     void clearStructure() { m_structureID = 0; }
133
134     TypeInfo::InlineTypeFlags inlineTypeFlags() const { return m_flags; }
135
136     const char* className(VM&) const;
137
138     // Extracting the value.
139     JS_EXPORT_PRIVATE bool getString(ExecState*, String&) const;
140     JS_EXPORT_PRIVATE String getString(ExecState*) const; // null string if not a string
141     JS_EXPORT_PRIVATE JSObject* getObject(); // NULL if not an object
142     const JSObject* getObject() const; // NULL if not an object
143         
144     // Returns information about how to call/construct this cell as a function/constructor. May tell
145     // you that the cell is not callable or constructor (default is that it's not either). If it
146     // says that the function is callable, and the TypeOfShouldCallGetCallData type flag is set, and
147     // this is an object, then typeof will return "function" instead of "object". These methods
148     // cannot change their minds and must be thread-safe. They are sometimes called from compiler
149     // threads.
150     JS_EXPORT_PRIVATE static CallType getCallData(JSCell*, CallData&);
151     JS_EXPORT_PRIVATE static ConstructType getConstructData(JSCell*, ConstructData&);
152
153     // Basic conversions.
154     JS_EXPORT_PRIVATE JSValue toPrimitive(ExecState*, PreferredPrimitiveType) const;
155     bool getPrimitiveNumber(ExecState*, double& number, JSValue&) const;
156     bool toBoolean(ExecState*) const;
157     TriState pureToBoolean() const;
158     JS_EXPORT_PRIVATE double toNumber(ExecState*) const;
159     JSObject* toObject(ExecState*, JSGlobalObject*) const;
160
161     void dump(PrintStream&) const;
162     JS_EXPORT_PRIVATE static void dumpToStream(const JSCell*, PrintStream&);
163
164     size_t estimatedSizeInBytes() const;
165     JS_EXPORT_PRIVATE static size_t estimatedSize(JSCell*);
166
167     static void visitChildren(JSCell*, SlotVisitor&);
168     static void visitOutputConstraints(JSCell*, SlotVisitor&);
169
170     JS_EXPORT_PRIVATE static void heapSnapshot(JSCell*, HeapSnapshotBuilder&);
171
172     // Object operations, with the toObject operation included.
173     const ClassInfo* classInfo(VM&) const;
174     const MethodTable* methodTable() const;
175     const MethodTable* methodTable(VM&) const;
176     static bool put(JSCell*, ExecState*, PropertyName, JSValue, PutPropertySlot&);
177     static bool putByIndex(JSCell*, ExecState*, unsigned propertyName, JSValue, bool shouldThrow);
178     bool putInline(ExecState*, PropertyName, JSValue, PutPropertySlot&);
179         
180     static bool deleteProperty(JSCell*, ExecState*, PropertyName);
181     static bool deletePropertyByIndex(JSCell*, ExecState*, unsigned propertyName);
182
183     static JSValue toThis(JSCell*, ExecState*, ECMAMode);
184
185     static bool canUseFastGetOwnProperty(const Structure&);
186     JSValue fastGetOwnProperty(VM&, Structure&, PropertyName);
187
188     // The recommended idiom for using cellState() is to switch on it or perform an == comparison on it
189     // directly. We deliberately avoid helpers for this, because we want transparency about how the various
190     // CellState values influences our various algorithms. 
191     CellState cellState() const { return m_cellState; }
192     
193     void setCellState(CellState data) const { const_cast<JSCell*>(this)->m_cellState = data; }
194     
195     bool atomicCompareExchangeCellStateWeakRelaxed(CellState oldState, CellState newState)
196     {
197         return WTF::atomicCompareExchangeWeakRelaxed(&m_cellState, oldState, newState);
198     }
199
200     CellState atomicCompareExchangeCellStateStrong(CellState oldState, CellState newState)
201     {
202         return WTF::atomicCompareExchangeStrong(&m_cellState, oldState, newState);
203     }
204
205     static ptrdiff_t structureIDOffset()
206     {
207         return OBJECT_OFFSETOF(JSCell, m_structureID);
208     }
209
210     static ptrdiff_t typeInfoFlagsOffset()
211     {
212         return OBJECT_OFFSETOF(JSCell, m_flags);
213     }
214
215     static ptrdiff_t typeInfoTypeOffset()
216     {
217         return OBJECT_OFFSETOF(JSCell, m_type);
218     }
219
220     // DO NOT store to this field. Always use a CAS loop, since some bits are flipped using CAS
221     // from other threads due to the internal lock. One exception: you don't need the CAS if the
222     // object has not escaped yet.
223     static ptrdiff_t indexingTypeAndMiscOffset()
224     {
225         return OBJECT_OFFSETOF(JSCell, m_indexingTypeAndMisc);
226     }
227
228     static ptrdiff_t cellStateOffset()
229     {
230         return OBJECT_OFFSETOF(JSCell, m_cellState);
231     }
232     
233     void callDestructor(VM&);
234
235     static const TypedArrayType TypedArrayStorageType = NotTypedArray;
236 protected:
237
238     void finishCreation(VM&);
239     void finishCreation(VM&, Structure*, CreatingEarlyCellTag);
240
241     // Dummy implementations of override-able static functions for classes to put in their MethodTable
242     static JSValue defaultValue(const JSObject*, ExecState*, PreferredPrimitiveType);
243     static NO_RETURN_DUE_TO_CRASH void getOwnPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
244     static NO_RETURN_DUE_TO_CRASH void getOwnNonIndexPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
245     static NO_RETURN_DUE_TO_CRASH void getPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
246
247     static uint32_t getEnumerableLength(ExecState*, JSObject*);
248     static NO_RETURN_DUE_TO_CRASH void getStructurePropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
249     static NO_RETURN_DUE_TO_CRASH void getGenericPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
250     static NO_RETURN_DUE_TO_CRASH bool preventExtensions(JSObject*, ExecState*);
251     static NO_RETURN_DUE_TO_CRASH bool isExtensible(JSObject*, ExecState*);
252     static NO_RETURN_DUE_TO_CRASH bool setPrototype(JSObject*, ExecState*, JSValue, bool);
253     static NO_RETURN_DUE_TO_CRASH JSValue getPrototype(JSObject*, ExecState*);
254
255     static String className(const JSObject*);
256     static String toStringName(const JSObject*, ExecState*);
257     JS_EXPORT_PRIVATE static bool customHasInstance(JSObject*, ExecState*, JSValue);
258     static bool defineOwnProperty(JSObject*, ExecState*, PropertyName, const PropertyDescriptor&, bool shouldThrow);
259     static bool getOwnPropertySlot(JSObject*, ExecState*, PropertyName, PropertySlot&);
260     static bool getOwnPropertySlotByIndex(JSObject*, ExecState*, unsigned propertyName, PropertySlot&);
261     JS_EXPORT_PRIVATE static ArrayBuffer* slowDownAndWasteMemory(JSArrayBufferView*);
262     JS_EXPORT_PRIVATE static RefPtr<ArrayBufferView> getTypedArrayImpl(JSArrayBufferView*);
263
264 private:
265     friend class LLIntOffsetsExtractor;
266
267     JS_EXPORT_PRIVATE JSObject* toObjectSlow(ExecState*, JSGlobalObject*) const;
268
269     StructureID m_structureID;
270     IndexingType m_indexingTypeAndMisc; // DO NOT store to this field. Always CAS.
271     JSType m_type;
272     TypeInfo::InlineTypeFlags m_flags;
273     CellState m_cellState;
274 };
275
276 template<typename To, typename From>
277 inline To jsCast(From* from)
278 {
279     ASSERT_WITH_SECURITY_IMPLICATION(!from || from->JSCell::inherits(*from->JSCell::vm(), std::remove_pointer<To>::type::info()));
280     return static_cast<To>(from);
281 }
282     
283 template<typename To>
284 inline To jsCast(JSValue from)
285 {
286     ASSERT_WITH_SECURITY_IMPLICATION(from.isCell() && from.asCell()->JSCell::inherits(*from.asCell()->vm(), std::remove_pointer<To>::type::info()));
287     return static_cast<To>(from.asCell());
288 }
289
290 template<typename To, typename From>
291 inline To jsDynamicCast(VM& vm, From* from)
292 {
293     if (LIKELY(from->JSCell::inherits(vm, std::remove_pointer<To>::type::info())))
294         return static_cast<To>(from);
295     return nullptr;
296 }
297
298 template<typename To>
299 inline To jsDynamicCast(VM& vm, JSValue from)
300 {
301     if (LIKELY(from.isCell() && from.asCell()->inherits(vm, std::remove_pointer<To>::type::info())))
302         return static_cast<To>(from.asCell());
303     return nullptr;
304 }
305
306 // FIXME: Refer to Subspace by reference.
307 // https://bugs.webkit.org/show_bug.cgi?id=166988
308 template<typename Type>
309 inline Subspace* subspaceFor(VM& vm)
310 {
311     return Type::template subspaceFor<Type>(vm);
312 }
313
314 } // namespace JSC