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