GC allocation trigger should be tuned to system RAM
[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 "BlockAllocator.h"
26 #include "DFGCodeBlocks.h"
27 #include "HandleSet.h"
28 #include "HandleStack.h"
29 #include "MarkedAllocator.h"
30 #include "MarkedBlock.h"
31 #include "MarkedBlockSet.h"
32 #include "MarkedSpace.h"
33 #include "SlotVisitor.h"
34 #include "WeakHandleOwner.h"
35 #include "WeakSet.h"
36 #include "WriteBarrierSupport.h"
37 #include <wtf/HashCountedSet.h>
38 #include <wtf/HashSet.h>
39
40 #define COLLECT_ON_EVERY_ALLOCATION 0
41
42 namespace JSC {
43
44     class CopiedSpace;
45     class CodeBlock;
46     class FunctionExecutable;
47     class GCActivityCallback;
48     class GlobalCodeBlock;
49     class Heap;
50     class HeapRootVisitor;
51     class JSCell;
52     class JSGlobalData;
53     class JSValue;
54     class LiveObjectIterator;
55     class LLIntOffsetsExtractor;
56     class MarkedArgumentBuffer;
57     class RegisterFile;
58     class UString;
59     class WeakGCHandlePool;
60     class SlotVisitor;
61
62     typedef std::pair<JSValue, UString> ValueStringPair;
63     typedef HashCountedSet<JSCell*> ProtectCountSet;
64     typedef HashCountedSet<const char*> TypeCountSet;
65
66     enum OperationInProgress { NoOperation, Allocation, Collection };
67
68     enum HeapType { SmallHeap, LargeHeap };
69
70     class Heap {
71         WTF_MAKE_NONCOPYABLE(Heap);
72     public:
73         friend class JIT;
74         friend class MarkStackThreadSharedData;
75         static Heap* heap(const JSValue); // 0 for immediate values
76         static Heap* heap(const JSCell*);
77
78         // This constant determines how many blocks we iterate between checks of our 
79         // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
80         // overstepping our deadline more quickly, while increasing it will cause 
81         // our scan to run faster. 
82         static const unsigned s_timeCheckResolution = 16;
83
84         static bool isMarked(const void*);
85         static bool testAndSetMarked(const void*);
86         static void setMarked(const void*);
87
88         static void writeBarrier(const JSCell*, JSValue);
89         static void writeBarrier(const JSCell*, JSCell*);
90         static uint8_t* addressOfCardFor(JSCell*);
91
92         Heap(JSGlobalData*, HeapType);
93         ~Heap();
94         JS_EXPORT_PRIVATE void lastChanceToFinalize();
95
96         JSGlobalData* globalData() const { return m_globalData; }
97         MarkedSpace& objectSpace() { return m_objectSpace; }
98         MachineThreads& machineThreads() { return m_machineThreads; }
99
100         JS_EXPORT_PRIVATE GCActivityCallback* activityCallback();
101         JS_EXPORT_PRIVATE void setActivityCallback(PassOwnPtr<GCActivityCallback>);
102         JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
103
104         // true if an allocation or collection is in progress
105         inline bool isBusy();
106         
107         MarkedAllocator& firstAllocatorWithoutDestructors() { return m_objectSpace.firstAllocator(); }
108         MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
109         MarkedAllocator& allocatorForObjectWithDestructor(size_t bytes) { return m_objectSpace.destructorAllocatorFor(bytes); }
110         CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
111         CheckedBoolean tryAllocateStorage(size_t, void**);
112         CheckedBoolean tryReallocateStorage(void**, size_t, size_t);
113
114         typedef void (*Finalizer)(JSCell*);
115         JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
116         void addFunctionExecutable(FunctionExecutable*);
117         void removeFunctionExecutable(FunctionExecutable*);
118
119         void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
120
121         JS_EXPORT_PRIVATE void collectAllGarbage();
122         enum SweepToggle { DoNotSweep, DoSweep };
123         bool shouldCollect();
124         void collect(SweepToggle);
125
126         void reportExtraMemoryCost(size_t cost);
127         JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
128
129         JS_EXPORT_PRIVATE void protect(JSValue);
130         JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
131         
132         void jettisonDFGCodeBlock(PassOwnPtr<CodeBlock>);
133
134         JS_EXPORT_PRIVATE size_t size();
135         JS_EXPORT_PRIVATE size_t capacity();
136         JS_EXPORT_PRIVATE size_t objectCount();
137         JS_EXPORT_PRIVATE size_t globalObjectCount();
138         JS_EXPORT_PRIVATE size_t protectedObjectCount();
139         JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
140         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> protectedObjectTypeCounts();
141         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> objectTypeCounts();
142
143         void pushTempSortVector(Vector<ValueStringPair>*);
144         void popTempSortVector(Vector<ValueStringPair>*);
145     
146         HashSet<MarkedArgumentBuffer*>& markListSet() { if (!m_markListSet) m_markListSet = new HashSet<MarkedArgumentBuffer*>; return *m_markListSet; }
147         
148         template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
149         template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
150
151         WeakSet* weakSet() { return &m_weakSet; }
152         HandleSet* handleSet() { return &m_handleSet; }
153         HandleStack* handleStack() { return &m_handleStack; }
154
155         void getConservativeRegisterRoots(HashSet<JSCell*>& roots);
156
157         double lastGCLength() { return m_lastGCLength; }
158         void increaseLastGCLength(double amount) { m_lastGCLength += amount; }
159
160         JS_EXPORT_PRIVATE void discardAllCompiledCode();
161
162         void didAllocate(size_t);
163         void didAbandon(size_t);
164
165         bool isPagedOut(double deadline);
166
167     private:
168         friend class CodeBlock;
169         friend class LLIntOffsetsExtractor;
170         friend class MarkedSpace;
171         friend class MarkedAllocator;
172         friend class MarkedBlock;
173         friend class CopiedSpace;
174         friend class SlotVisitor;
175         template<typename T> friend void* allocateCell(Heap&);
176
177         void* allocateWithDestructor(size_t);
178         void* allocateWithoutDestructor(size_t);
179
180         static const size_t minExtraCost = 256;
181         static const size_t maxExtraCost = 1024 * 1024;
182         
183         class FinalizerOwner : public WeakHandleOwner {
184             virtual void finalize(Handle<Unknown>, void* context);
185         };
186
187         JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
188         JS_EXPORT_PRIVATE void reportExtraMemoryCostSlowCase(size_t);
189
190         void markRoots(bool fullGC);
191         void markProtectedObjects(HeapRootVisitor&);
192         void markTempSortVectors(HeapRootVisitor&);
193         void harvestWeakReferences();
194         void finalizeUnconditionalFinalizers();
195         
196         RegisterFile& registerFile();
197         BlockAllocator& blockAllocator();
198
199         const HeapType m_heapType;
200         const size_t m_ramSize;
201         const size_t m_minBytesPerCycle;
202         size_t m_sizeAfterLastCollect;
203
204         size_t m_bytesAllocatedLimit;
205         size_t m_bytesAllocated;
206         size_t m_bytesAbandoned;
207         
208         OperationInProgress m_operationInProgress;
209         MarkedSpace m_objectSpace;
210         CopiedSpace m_storageSpace;
211
212         BlockAllocator m_blockAllocator;
213
214 #if ENABLE(SIMPLE_HEAP_PROFILING)
215         VTableSpectrum m_destroyedTypeCounts;
216 #endif
217
218         ProtectCountSet m_protectedValues;
219         Vector<Vector<ValueStringPair>* > m_tempSortingVectors;
220         HashSet<MarkedArgumentBuffer*>* m_markListSet;
221
222         OwnPtr<GCActivityCallback> m_activityCallback;
223         
224         MachineThreads m_machineThreads;
225         
226         MarkStackThreadSharedData m_sharedData;
227         SlotVisitor m_slotVisitor;
228
229         WeakSet m_weakSet;
230         HandleSet m_handleSet;
231         HandleStack m_handleStack;
232         DFGCodeBlocks m_dfgCodeBlocks;
233         FinalizerOwner m_finalizerOwner;
234         
235         bool m_isSafeToCollect;
236
237         JSGlobalData* m_globalData;
238         double m_lastGCLength;
239         double m_lastCodeDiscardTime;
240
241         DoublyLinkedList<FunctionExecutable> m_functions;
242     };
243
244     inline bool Heap::shouldCollect()
245     {
246 #if ENABLE(GGC)
247         return m_objectSpace.nurseryWaterMark() >= m_minBytesPerCycle && m_isSafeToCollect;
248 #else
249         return m_bytesAllocated > m_bytesAllocatedLimit && m_isSafeToCollect;
250 #endif
251     }
252
253     bool Heap::isBusy()
254     {
255         return m_operationInProgress != NoOperation;
256     }
257
258     inline Heap* Heap::heap(const JSCell* cell)
259     {
260         return MarkedBlock::blockFor(cell)->heap();
261     }
262
263     inline Heap* Heap::heap(const JSValue v)
264     {
265         if (!v.isCell())
266             return 0;
267         return heap(v.asCell());
268     }
269
270     inline bool Heap::isMarked(const void* cell)
271     {
272         return MarkedBlock::blockFor(cell)->isMarked(cell);
273     }
274
275     inline bool Heap::testAndSetMarked(const void* cell)
276     {
277         return MarkedBlock::blockFor(cell)->testAndSetMarked(cell);
278     }
279
280     inline void Heap::setMarked(const void* cell)
281     {
282         MarkedBlock::blockFor(cell)->setMarked(cell);
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_handleSet.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     inline BlockAllocator& Heap::blockAllocator()
365     {
366         return m_blockAllocator;
367     }
368
369 } // namespace JSC
370
371 #endif // Heap_h