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