Roll out r108309, r108323, and r108326
[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         CheckedBoolean tryAllocateStorage(size_t, void**);
101         CheckedBoolean tryReallocateStorage(void**, size_t, size_t);
102
103         typedef void (*Finalizer)(JSCell*);
104         JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
105
106         void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
107         JS_EXPORT_PRIVATE void collectAllGarbage();
108
109         void reportExtraMemoryCost(size_t cost);
110
111         JS_EXPORT_PRIVATE void protect(JSValue);
112         JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
113         
114         void jettisonDFGCodeBlock(PassOwnPtr<CodeBlock>);
115
116         JS_EXPORT_PRIVATE size_t size();
117         JS_EXPORT_PRIVATE size_t capacity();
118         JS_EXPORT_PRIVATE size_t objectCount();
119         JS_EXPORT_PRIVATE size_t globalObjectCount();
120         JS_EXPORT_PRIVATE size_t protectedObjectCount();
121         JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
122         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> protectedObjectTypeCounts();
123         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> objectTypeCounts();
124
125         void pushTempSortVector(Vector<ValueStringPair>*);
126         void popTempSortVector(Vector<ValueStringPair>*);
127     
128         HashSet<MarkedArgumentBuffer*>& markListSet() { if (!m_markListSet) m_markListSet = new HashSet<MarkedArgumentBuffer*>; return *m_markListSet; }
129         
130         template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
131         template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
132
133         HandleHeap* handleHeap() { return &m_handleHeap; }
134         HandleStack* handleStack() { return &m_handleStack; }
135
136         void getConservativeRegisterRoots(HashSet<JSCell*>& roots);
137
138     private:
139         friend class MarkedSpace;
140         friend class MarkedAllocator;
141         friend class MarkedBlock;
142         friend class CopiedSpace;
143         friend class SlotVisitor;
144         friend class CodeBlock;
145         template<typename T> friend void* allocateCell(Heap&);
146
147         void* allocateWithDestructor(size_t);
148         void* allocateWithoutDestructor(size_t);
149
150         size_t waterMark();
151         size_t highWaterMark();
152         void setHighWaterMark(size_t);
153
154         static const size_t minExtraCost = 256;
155         static const size_t maxExtraCost = 1024 * 1024;
156         
157         class FinalizerOwner : public WeakHandleOwner {
158             virtual void finalize(Handle<Unknown>, void* context);
159         };
160
161         JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
162         JS_EXPORT_PRIVATE void reportExtraMemoryCostSlowCase(size_t);
163
164         // Call this function before any operation that needs to know which cells
165         // in the heap are live. (For example, call this function before
166         // conservative marking, eager sweeping, or iterating the cells in a MarkedBlock.)
167         void canonicalizeCellLivenessData();
168
169         void resetAllocators();
170         void freeBlocks(MarkedBlock*);
171
172         void clearMarks();
173         void markRoots(bool fullGC);
174         void markProtectedObjects(HeapRootVisitor&);
175         void markTempSortVectors(HeapRootVisitor&);
176         void harvestWeakReferences();
177         void finalizeUnconditionalFinalizers();
178         
179         enum SweepToggle { DoNotSweep, DoSweep };
180         void collect(SweepToggle);
181         void shrink();
182         void releaseFreeBlocks();
183         void sweep();
184
185         RegisterFile& registerFile();
186
187         void waitForRelativeTimeWhileHoldingLock(double relative);
188         void waitForRelativeTime(double relative);
189         void blockFreeingThreadMain();
190         static void blockFreeingThreadStartFunc(void* heap);
191         
192         const HeapSize m_heapSize;
193         const size_t m_minBytesPerCycle;
194         size_t m_lastFullGCSize;
195         size_t m_waterMark;
196         size_t m_highWaterMark;
197         
198         OperationInProgress m_operationInProgress;
199         MarkedSpace m_objectSpace;
200         CopiedSpace m_storageSpace;
201
202         DoublyLinkedList<HeapBlock> m_freeBlocks;
203         size_t m_numberOfFreeBlocks;
204         
205         ThreadIdentifier m_blockFreeingThread;
206         Mutex m_freeBlockLock;
207         ThreadCondition m_freeBlockCondition;
208         bool m_blockFreeingThreadShouldQuit;
209
210 #if ENABLE(SIMPLE_HEAP_PROFILING)
211         VTableSpectrum m_destroyedTypeCounts;
212 #endif
213
214         size_t m_extraCost;
215
216         ProtectCountSet m_protectedValues;
217         Vector<Vector<ValueStringPair>* > m_tempSortingVectors;
218         HashSet<MarkedArgumentBuffer*>* m_markListSet;
219
220         OwnPtr<GCActivityCallback> m_activityCallback;
221         
222         MachineThreads m_machineThreads;
223         
224         MarkStackThreadSharedData m_sharedData;
225         SlotVisitor m_slotVisitor;
226
227         HandleHeap m_handleHeap;
228         HandleStack m_handleStack;
229         DFGCodeBlocks m_dfgCodeBlocks;
230         FinalizerOwner m_finalizerOwner;
231         
232         bool m_isSafeToCollect;
233
234         JSGlobalData* m_globalData;
235     };
236
237     bool Heap::isBusy()
238     {
239         return m_operationInProgress != NoOperation;
240     }
241
242     inline Heap* Heap::heap(JSCell* cell)
243     {
244         return MarkedBlock::blockFor(cell)->heap();
245     }
246
247     inline Heap* Heap::heap(JSValue v)
248     {
249         if (!v.isCell())
250             return 0;
251         return heap(v.asCell());
252     }
253
254     inline bool Heap::isMarked(const void* cell)
255     {
256         return MarkedBlock::blockFor(cell)->isMarked(cell);
257     }
258
259     inline bool Heap::testAndSetMarked(const void* cell)
260     {
261         return MarkedBlock::blockFor(cell)->testAndSetMarked(cell);
262     }
263
264     inline void Heap::setMarked(const void* cell)
265     {
266         MarkedBlock::blockFor(cell)->setMarked(cell);
267     }
268
269     inline size_t Heap::waterMark()
270     {
271         return m_objectSpace.waterMark() + m_storageSpace.totalMemoryUtilized();
272     }
273
274     inline size_t Heap::highWaterMark()
275     {
276         return m_highWaterMark;
277     }
278
279     inline void Heap::setHighWaterMark(size_t newHighWaterMark)
280     {
281         m_highWaterMark = newHighWaterMark;
282     }
283
284 #if ENABLE(GGC)
285     inline uint8_t* Heap::addressOfCardFor(JSCell* cell)
286     {
287         return MarkedBlock::blockFor(cell)->addressOfCardFor(cell);
288     }
289
290     inline void Heap::writeBarrier(const JSCell* owner, JSCell*)
291     {
292         WriteBarrierCounters::countWriteBarrier();
293         MarkedBlock* block = MarkedBlock::blockFor(owner);
294         if (block->isMarked(owner))
295             block->setDirtyObject(owner);
296     }
297
298     inline void Heap::writeBarrier(const JSCell* owner, JSValue value)
299     {
300         if (!value)
301             return;
302         if (!value.isCell())
303             return;
304         writeBarrier(owner, value.asCell());
305     }
306 #else
307
308     inline void Heap::writeBarrier(const JSCell*, JSCell*)
309     {
310         WriteBarrierCounters::countWriteBarrier();
311     }
312
313     inline void Heap::writeBarrier(const JSCell*, JSValue)
314     {
315         WriteBarrierCounters::countWriteBarrier();
316     }
317 #endif
318
319     inline void Heap::reportExtraMemoryCost(size_t cost)
320     {
321         if (cost > minExtraCost) 
322             reportExtraMemoryCostSlowCase(cost);
323     }
324
325     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell(Functor& functor)
326     {
327         ProtectCountSet::iterator end = m_protectedValues.end();
328         for (ProtectCountSet::iterator it = m_protectedValues.begin(); it != end; ++it)
329             functor(it->first);
330         m_handleHeap.forEachStrongHandle(functor, m_protectedValues);
331
332         return functor.returnValue();
333     }
334
335     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell()
336     {
337         Functor functor;
338         return forEachProtectedCell(functor);
339     }
340
341     inline void* Heap::allocateWithDestructor(size_t bytes)
342     {
343         ASSERT(isValidAllocation(bytes));
344         return m_objectSpace.allocateWithDestructor(bytes);
345     }
346     
347     inline void* Heap::allocateWithoutDestructor(size_t bytes)
348     {
349         ASSERT(isValidAllocation(bytes));
350         return m_objectSpace.allocateWithoutDestructor(bytes);
351     }
352     
353     inline CheckedBoolean Heap::tryAllocateStorage(size_t bytes, void** outPtr)
354     {
355         return m_storageSpace.tryAllocate(bytes, outPtr);
356     }
357     
358     inline CheckedBoolean Heap::tryReallocateStorage(void** ptr, size_t oldSize, size_t newSize)
359     {
360         return m_storageSpace.tryReallocate(ptr, oldSize, newSize);
361     }
362
363 } // namespace JSC
364
365 #endif // Heap_h