Implement fast path for op_new_array in the baseline JIT
[WebKit-https.git] / Source / JavaScriptCore / heap / Heap.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 Lesser 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  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #ifndef Heap_h
23 #define Heap_h
24
25 #include "DFGCodeBlocks.h"
26 #include "HandleHeap.h"
27 #include "HandleStack.h"
28 #include "MarkedAllocator.h"
29 #include "MarkedBlock.h"
30 #include "MarkedBlockSet.h"
31 #include "MarkedSpace.h"
32 #include "SlotVisitor.h"
33 #include "WriteBarrierSupport.h"
34 #include <wtf/DoublyLinkedList.h>
35 #include <wtf/Forward.h>
36 #include <wtf/HashCountedSet.h>
37 #include <wtf/HashSet.h>
38
39 #define COLLECT_ON_EVERY_ALLOCATION 0
40
41 namespace JSC {
42
43     class CopiedSpace;
44     class CodeBlock;
45     class GCActivityCallback;
46     class GlobalCodeBlock;
47     class Heap;
48     class HeapRootVisitor;
49     class JSCell;
50     class JSGlobalData;
51     class JSValue;
52     class LiveObjectIterator;
53     class MarkedArgumentBuffer;
54     class RegisterFile;
55     class UString;
56     class WeakGCHandlePool;
57     class SlotVisitor;
58
59     typedef std::pair<JSValue, UString> ValueStringPair;
60     typedef HashCountedSet<JSCell*> ProtectCountSet;
61     typedef HashCountedSet<const char*> TypeCountSet;
62
63     enum OperationInProgress { NoOperation, Allocation, Collection };
64
65     // Heap size hint.
66     enum HeapSize { SmallHeap, LargeHeap };
67
68     class Heap {
69         WTF_MAKE_NONCOPYABLE(Heap);
70     public:
71         friend class JIT;
72         friend class MarkStackThreadSharedData;
73         static Heap* heap(JSValue); // 0 for immediate values
74         static Heap* heap(JSCell*);
75
76         static bool isMarked(const void*);
77         static bool testAndSetMarked(const void*);
78         static void setMarked(const void*);
79
80         static void writeBarrier(const JSCell*, JSValue);
81         static void writeBarrier(const JSCell*, JSCell*);
82         static uint8_t* addressOfCardFor(JSCell*);
83
84         Heap(JSGlobalData*, HeapSize);
85         ~Heap();
86         JS_EXPORT_PRIVATE void destroy(); // JSGlobalData must call destroy() before ~Heap().
87
88         JSGlobalData* globalData() const { return m_globalData; }
89         MarkedSpace& objectSpace() { return m_objectSpace; }
90         MachineThreads& machineThreads() { return m_machineThreads; }
91
92         JS_EXPORT_PRIVATE GCActivityCallback* activityCallback();
93         JS_EXPORT_PRIVATE void setActivityCallback(PassOwnPtr<GCActivityCallback>);
94
95         // true if an allocation or collection is in progress
96         inline bool isBusy();
97         
98         MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
99         MarkedAllocator& allocatorForObjectWithDestructor(size_t bytes) { return m_objectSpace.destructorAllocatorFor(bytes); }
100         CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
101         CheckedBoolean tryAllocateStorage(size_t, void**);
102         CheckedBoolean tryReallocateStorage(void**, size_t, size_t);
103
104         typedef void (*Finalizer)(JSCell*);
105         JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
106
107         void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
108         JS_EXPORT_PRIVATE void collectAllGarbage();
109
110         void reportExtraMemoryCost(size_t cost);
111
112         JS_EXPORT_PRIVATE void protect(JSValue);
113         JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
114         
115         void jettisonDFGCodeBlock(PassOwnPtr<CodeBlock>);
116
117         JS_EXPORT_PRIVATE size_t size();
118         JS_EXPORT_PRIVATE size_t capacity();
119         JS_EXPORT_PRIVATE size_t objectCount();
120         JS_EXPORT_PRIVATE size_t globalObjectCount();
121         JS_EXPORT_PRIVATE size_t protectedObjectCount();
122         JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
123         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> protectedObjectTypeCounts();
124         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> objectTypeCounts();
125
126         void pushTempSortVector(Vector<ValueStringPair>*);
127         void popTempSortVector(Vector<ValueStringPair>*);
128     
129         HashSet<MarkedArgumentBuffer*>& markListSet() { if (!m_markListSet) m_markListSet = new HashSet<MarkedArgumentBuffer*>; return *m_markListSet; }
130         
131         template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
132         template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
133
134         HandleHeap* handleHeap() { return &m_handleHeap; }
135         HandleStack* handleStack() { return &m_handleStack; }
136
137         void getConservativeRegisterRoots(HashSet<JSCell*>& roots);
138
139     private:
140         friend class MarkedSpace;
141         friend class MarkedAllocator;
142         friend class MarkedBlock;
143         friend class CopiedSpace;
144         friend class SlotVisitor;
145         friend class CodeBlock;
146         template<typename T> friend void* allocateCell(Heap&);
147
148         void* allocateWithDestructor(size_t);
149         void* allocateWithoutDestructor(size_t);
150
151         size_t waterMark();
152         size_t highWaterMark();
153         void setHighWaterMark(size_t);
154
155         static const size_t minExtraCost = 256;
156         static const size_t maxExtraCost = 1024 * 1024;
157         
158         class FinalizerOwner : public WeakHandleOwner {
159             virtual void finalize(Handle<Unknown>, void* context);
160         };
161
162         JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
163         JS_EXPORT_PRIVATE void reportExtraMemoryCostSlowCase(size_t);
164
165         // Call this function before any operation that needs to know which cells
166         // in the heap are live. (For example, call this function before
167         // conservative marking, eager sweeping, or iterating the cells in a MarkedBlock.)
168         void canonicalizeCellLivenessData();
169
170         void resetAllocators();
171         void freeBlocks(MarkedBlock*);
172
173         void clearMarks();
174         void markRoots(bool fullGC);
175         void markProtectedObjects(HeapRootVisitor&);
176         void markTempSortVectors(HeapRootVisitor&);
177         void harvestWeakReferences();
178         void finalizeUnconditionalFinalizers();
179         
180         enum SweepToggle { DoNotSweep, DoSweep };
181         void collect(SweepToggle);
182         void shrink();
183         void releaseFreeBlocks();
184         void sweep();
185
186         RegisterFile& registerFile();
187
188         void waitForRelativeTimeWhileHoldingLock(double relative);
189         void waitForRelativeTime(double relative);
190         void blockFreeingThreadMain();
191         static void blockFreeingThreadStartFunc(void* heap);
192         
193         const HeapSize m_heapSize;
194         const size_t m_minBytesPerCycle;
195         size_t m_lastFullGCSize;
196         size_t m_waterMark;
197         size_t m_highWaterMark;
198         
199         OperationInProgress m_operationInProgress;
200         MarkedSpace m_objectSpace;
201         CopiedSpace m_storageSpace;
202
203         DoublyLinkedList<HeapBlock> m_freeBlocks;
204         size_t m_numberOfFreeBlocks;
205         
206         ThreadIdentifier m_blockFreeingThread;
207         Mutex m_freeBlockLock;
208         ThreadCondition m_freeBlockCondition;
209         bool m_blockFreeingThreadShouldQuit;
210
211 #if ENABLE(SIMPLE_HEAP_PROFILING)
212         VTableSpectrum m_destroyedTypeCounts;
213 #endif
214
215         size_t m_extraCost;
216
217         ProtectCountSet m_protectedValues;
218         Vector<Vector<ValueStringPair>* > m_tempSortingVectors;
219         HashSet<MarkedArgumentBuffer*>* m_markListSet;
220
221         OwnPtr<GCActivityCallback> m_activityCallback;
222         
223         MachineThreads m_machineThreads;
224         
225         MarkStackThreadSharedData m_sharedData;
226         SlotVisitor m_slotVisitor;
227
228         HandleHeap m_handleHeap;
229         HandleStack m_handleStack;
230         DFGCodeBlocks m_dfgCodeBlocks;
231         FinalizerOwner m_finalizerOwner;
232         
233         bool m_isSafeToCollect;
234
235         JSGlobalData* m_globalData;
236     };
237
238     bool Heap::isBusy()
239     {
240         return m_operationInProgress != NoOperation;
241     }
242
243     inline Heap* Heap::heap(JSCell* cell)
244     {
245         return MarkedBlock::blockFor(cell)->heap();
246     }
247
248     inline Heap* Heap::heap(JSValue v)
249     {
250         if (!v.isCell())
251             return 0;
252         return heap(v.asCell());
253     }
254
255     inline bool Heap::isMarked(const void* cell)
256     {
257         return MarkedBlock::blockFor(cell)->isMarked(cell);
258     }
259
260     inline bool Heap::testAndSetMarked(const void* cell)
261     {
262         return MarkedBlock::blockFor(cell)->testAndSetMarked(cell);
263     }
264
265     inline void Heap::setMarked(const void* cell)
266     {
267         MarkedBlock::blockFor(cell)->setMarked(cell);
268     }
269
270     inline size_t Heap::waterMark()
271     {
272         return m_objectSpace.waterMark() + m_storageSpace.totalMemoryUtilized();
273     }
274
275     inline size_t Heap::highWaterMark()
276     {
277         return m_highWaterMark;
278     }
279
280     inline void Heap::setHighWaterMark(size_t newHighWaterMark)
281     {
282         m_highWaterMark = newHighWaterMark;
283     }
284
285 #if ENABLE(GGC)
286     inline uint8_t* Heap::addressOfCardFor(JSCell* cell)
287     {
288         return MarkedBlock::blockFor(cell)->addressOfCardFor(cell);
289     }
290
291     inline void Heap::writeBarrier(const JSCell* owner, JSCell*)
292     {
293         WriteBarrierCounters::countWriteBarrier();
294         MarkedBlock* block = MarkedBlock::blockFor(owner);
295         if (block->isMarked(owner))
296             block->setDirtyObject(owner);
297     }
298
299     inline void Heap::writeBarrier(const JSCell* owner, JSValue value)
300     {
301         if (!value)
302             return;
303         if (!value.isCell())
304             return;
305         writeBarrier(owner, value.asCell());
306     }
307 #else
308
309     inline void Heap::writeBarrier(const JSCell*, JSCell*)
310     {
311         WriteBarrierCounters::countWriteBarrier();
312     }
313
314     inline void Heap::writeBarrier(const JSCell*, JSValue)
315     {
316         WriteBarrierCounters::countWriteBarrier();
317     }
318 #endif
319
320     inline void Heap::reportExtraMemoryCost(size_t cost)
321     {
322         if (cost > minExtraCost) 
323             reportExtraMemoryCostSlowCase(cost);
324     }
325
326     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell(Functor& functor)
327     {
328         ProtectCountSet::iterator end = m_protectedValues.end();
329         for (ProtectCountSet::iterator it = m_protectedValues.begin(); it != end; ++it)
330             functor(it->first);
331         m_handleHeap.forEachStrongHandle(functor, m_protectedValues);
332
333         return functor.returnValue();
334     }
335
336     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell()
337     {
338         Functor functor;
339         return forEachProtectedCell(functor);
340     }
341
342     inline void* Heap::allocateWithDestructor(size_t bytes)
343     {
344         ASSERT(isValidAllocation(bytes));
345         return m_objectSpace.allocateWithDestructor(bytes);
346     }
347     
348     inline void* Heap::allocateWithoutDestructor(size_t bytes)
349     {
350         ASSERT(isValidAllocation(bytes));
351         return m_objectSpace.allocateWithoutDestructor(bytes);
352     }
353     
354     inline CheckedBoolean Heap::tryAllocateStorage(size_t bytes, void** outPtr)
355     {
356         return m_storageSpace.tryAllocate(bytes, outPtr);
357     }
358     
359     inline CheckedBoolean Heap::tryReallocateStorage(void** ptr, size_t oldSize, size_t newSize)
360     {
361         return m_storageSpace.tryReallocate(ptr, oldSize, newSize);
362     }
363
364 } // namespace JSC
365
366 #endif // Heap_h