d71010bf23d7b0b5efefde85a4a470e4b2ecc95b
[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 "GCThreadSharedData.h"
28 #include "HandleSet.h"
29 #include "HandleStack.h"
30 #include "JITStubRoutineSet.h"
31 #include "MarkedAllocator.h"
32 #include "MarkedBlock.h"
33 #include "MarkedBlockSet.h"
34 #include "MarkedSpace.h"
35 #include "SlotVisitor.h"
36 #include "WeakHandleOwner.h"
37 #include "WriteBarrierSupport.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 ExecutableBase;
48     class GCActivityCallback;
49     class GCAwareJITStubRoutine;
50     class GlobalCodeBlock;
51     class Heap;
52     class HeapRootVisitor;
53     class IncrementalSweeper;
54     class JITStubRoutine;
55     class JSCell;
56     class JSGlobalData;
57     class JSValue;
58     class LiveObjectIterator;
59     class LLIntOffsetsExtractor;
60     class MarkedArgumentBuffer;
61     class RegisterFile;
62     class UString;
63     class WeakGCHandlePool;
64     class SlotVisitor;
65
66     typedef std::pair<JSValue, UString> ValueStringPair;
67     typedef HashCountedSet<JSCell*> ProtectCountSet;
68     typedef HashCountedSet<const char*> TypeCountSet;
69
70     enum OperationInProgress { NoOperation, Allocation, Collection };
71
72     enum HeapType { SmallHeap, LargeHeap };
73
74     class Heap {
75         WTF_MAKE_NONCOPYABLE(Heap);
76     public:
77         friend class JIT;
78         friend class GCThreadSharedData;
79         static Heap* heap(const JSValue); // 0 for immediate values
80         static Heap* heap(const JSCell*);
81
82         // This constant determines how many blocks we iterate between checks of our 
83         // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
84         // overstepping our deadline more quickly, while increasing it will cause 
85         // our scan to run faster. 
86         static const unsigned s_timeCheckResolution = 16;
87
88         static bool isMarked(const void*);
89         static bool testAndSetMarked(const void*);
90         static void setMarked(const void*);
91
92         static bool isWriteBarrierEnabled();
93         static void writeBarrier(const JSCell*, JSValue);
94         static void writeBarrier(const JSCell*, JSCell*);
95         static uint8_t* addressOfCardFor(JSCell*);
96
97         Heap(JSGlobalData*, HeapType);
98         ~Heap();
99         JS_EXPORT_PRIVATE void lastChanceToFinalize();
100
101         JSGlobalData* globalData() const { return m_globalData; }
102         MarkedSpace& objectSpace() { return m_objectSpace; }
103         MachineThreads& machineThreads() { return m_machineThreads; }
104
105         JS_EXPORT_PRIVATE GCActivityCallback* activityCallback();
106         JS_EXPORT_PRIVATE void setActivityCallback(GCActivityCallback*);
107         JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
108
109         JS_EXPORT_PRIVATE IncrementalSweeper* sweeper();
110
111         // true if an allocation or collection is in progress
112         inline bool isBusy();
113         
114         MarkedAllocator& firstAllocatorWithoutDestructors() { return m_objectSpace.firstAllocator(); }
115         MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
116         MarkedAllocator& allocatorForObjectWithDestructor(size_t bytes) { return m_objectSpace.destructorAllocatorFor(bytes); }
117         CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
118         CheckedBoolean tryAllocateStorage(size_t, void**);
119         CheckedBoolean tryReallocateStorage(void**, size_t, size_t);
120
121         typedef void (*Finalizer)(JSCell*);
122         JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
123         void addCompiledCode(ExecutableBase*);
124
125         void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
126         bool isSafeToCollect() const { return m_isSafeToCollect; }
127
128         JS_EXPORT_PRIVATE void collectAllGarbage();
129         enum SweepToggle { DoNotSweep, DoSweep };
130         bool shouldCollect();
131         void collect(SweepToggle);
132
133         void reportExtraMemoryCost(size_t cost);
134         JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
135
136         JS_EXPORT_PRIVATE void protect(JSValue);
137         JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
138         
139         void jettisonDFGCodeBlock(PassOwnPtr<CodeBlock>);
140
141         JS_EXPORT_PRIVATE size_t size();
142         JS_EXPORT_PRIVATE size_t capacity();
143         JS_EXPORT_PRIVATE size_t objectCount();
144         JS_EXPORT_PRIVATE size_t globalObjectCount();
145         JS_EXPORT_PRIVATE size_t protectedObjectCount();
146         JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
147         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> protectedObjectTypeCounts();
148         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> objectTypeCounts();
149
150         void pushTempSortVector(Vector<ValueStringPair>*);
151         void popTempSortVector(Vector<ValueStringPair>*);
152     
153         HashSet<MarkedArgumentBuffer*>& markListSet() { if (!m_markListSet) m_markListSet = adoptPtr(new HashSet<MarkedArgumentBuffer*>); return *m_markListSet; }
154         
155         template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
156         template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
157
158         HandleSet* handleSet() { return &m_handleSet; }
159         HandleStack* handleStack() { return &m_handleStack; }
160
161         void getConservativeRegisterRoots(HashSet<JSCell*>& roots);
162
163         double lastGCLength() { return m_lastGCLength; }
164         void increaseLastGCLength(double amount) { m_lastGCLength += amount; }
165
166         JS_EXPORT_PRIVATE void deleteAllCompiledCode();
167
168         void didAllocate(size_t);
169         void didAbandon(size_t);
170
171         bool isPagedOut(double deadline);
172         bool isSafeToSweepStructures();
173         void didStartVMShutdown();
174
175     private:
176         friend class CodeBlock;
177         friend class GCAwareJITStubRoutine;
178         friend class JITStubRoutine;
179         friend class LLIntOffsetsExtractor;
180         friend class MarkedSpace;
181         friend class MarkedAllocator;
182         friend class MarkedBlock;
183         friend class CopiedSpace;
184         friend class SlotVisitor;
185         template<typename T> friend void* allocateCell(Heap&);
186
187         void* allocateWithDestructor(size_t);
188         void* allocateWithoutDestructor(size_t);
189         void* allocateStructure();
190
191         static const size_t minExtraCost = 256;
192         static const size_t maxExtraCost = 1024 * 1024;
193         
194         class FinalizerOwner : public WeakHandleOwner {
195             virtual void finalize(Handle<Unknown>, void* context);
196         };
197
198         JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
199         JS_EXPORT_PRIVATE void reportExtraMemoryCostSlowCase(size_t);
200
201         void markRoots(bool fullGC);
202         void markProtectedObjects(HeapRootVisitor&);
203         void markTempSortVectors(HeapRootVisitor&);
204         void harvestWeakReferences();
205         void finalizeUnconditionalFinalizers();
206         void deleteUnmarkedCompiledCode();
207         
208         RegisterFile& registerFile();
209         BlockAllocator& blockAllocator();
210
211         const HeapType m_heapType;
212         const size_t m_ramSize;
213         const size_t m_minBytesPerCycle;
214         size_t m_sizeAfterLastCollect;
215
216         size_t m_bytesAllocatedLimit;
217         size_t m_bytesAllocated;
218         size_t m_bytesAbandoned;
219         
220         OperationInProgress m_operationInProgress;
221         BlockAllocator m_blockAllocator;
222         MarkedSpace m_objectSpace;
223         CopiedSpace m_storageSpace;
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         OwnPtr<HashSet<MarkedArgumentBuffer*> > m_markListSet;
232
233         MachineThreads m_machineThreads;
234         
235         GCThreadSharedData m_sharedData;
236         SlotVisitor m_slotVisitor;
237
238         HandleSet m_handleSet;
239         HandleStack m_handleStack;
240         DFGCodeBlocks m_dfgCodeBlocks;
241         JITStubRoutineSet m_jitStubRoutines;
242         FinalizerOwner m_finalizerOwner;
243         
244         bool m_isSafeToCollect;
245
246         JSGlobalData* m_globalData;
247         double m_lastGCLength;
248         double m_lastCodeDiscardTime;
249
250         DoublyLinkedList<ExecutableBase> m_compiledCode;
251         
252         GCActivityCallback* m_activityCallback;
253         IncrementalSweeper* m_sweeper;
254     };
255
256     inline bool Heap::shouldCollect()
257     {
258 #if ENABLE(GGC)
259         return m_objectSpace.nurseryWaterMark() >= m_minBytesPerCycle && m_isSafeToCollect && m_operationInProgress == NoOperation;
260 #else
261         return m_bytesAllocated > m_bytesAllocatedLimit && m_isSafeToCollect && m_operationInProgress == NoOperation;
262 #endif
263     }
264
265     bool Heap::isBusy()
266     {
267         return m_operationInProgress != NoOperation;
268     }
269
270     inline Heap* Heap::heap(const JSCell* cell)
271     {
272         return MarkedBlock::blockFor(cell)->heap();
273     }
274
275     inline Heap* Heap::heap(const JSValue v)
276     {
277         if (!v.isCell())
278             return 0;
279         return heap(v.asCell());
280     }
281
282     inline bool Heap::isMarked(const void* cell)
283     {
284         return MarkedBlock::blockFor(cell)->isMarked(cell);
285     }
286
287     inline bool Heap::testAndSetMarked(const void* cell)
288     {
289         return MarkedBlock::blockFor(cell)->testAndSetMarked(cell);
290     }
291
292     inline void Heap::setMarked(const void* cell)
293     {
294         MarkedBlock::blockFor(cell)->setMarked(cell);
295     }
296
297     inline bool Heap::isWriteBarrierEnabled()
298     {
299 #if ENABLE(GGC) || ENABLE(WRITE_BARRIER_PROFILING)
300         return true;
301 #else
302         return false;
303 #endif
304     }
305
306 #if ENABLE(GGC)
307     inline uint8_t* Heap::addressOfCardFor(JSCell* cell)
308     {
309         return MarkedBlock::blockFor(cell)->addressOfCardFor(cell);
310     }
311
312     inline void Heap::writeBarrier(const JSCell* owner, JSCell*)
313     {
314         WriteBarrierCounters::countWriteBarrier();
315         MarkedBlock* block = MarkedBlock::blockFor(owner);
316         if (block->isMarked(owner))
317             block->setDirtyObject(owner);
318     }
319
320     inline void Heap::writeBarrier(const JSCell* owner, JSValue value)
321     {
322         if (!value)
323             return;
324         if (!value.isCell())
325             return;
326         writeBarrier(owner, value.asCell());
327     }
328 #else
329
330     inline void Heap::writeBarrier(const JSCell*, JSCell*)
331     {
332         WriteBarrierCounters::countWriteBarrier();
333     }
334
335     inline void Heap::writeBarrier(const JSCell*, JSValue)
336     {
337         WriteBarrierCounters::countWriteBarrier();
338     }
339 #endif
340
341     inline void Heap::reportExtraMemoryCost(size_t cost)
342     {
343         if (cost > minExtraCost) 
344             reportExtraMemoryCostSlowCase(cost);
345     }
346
347     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell(Functor& functor)
348     {
349         ProtectCountSet::iterator end = m_protectedValues.end();
350         for (ProtectCountSet::iterator it = m_protectedValues.begin(); it != end; ++it)
351             functor(it->key);
352         m_handleSet.forEachStrongHandle(functor, m_protectedValues);
353
354         return functor.returnValue();
355     }
356
357     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell()
358     {
359         Functor functor;
360         return forEachProtectedCell(functor);
361     }
362
363     inline void* Heap::allocateWithDestructor(size_t bytes)
364     {
365         ASSERT(isValidAllocation(bytes));
366         return m_objectSpace.allocateWithDestructor(bytes);
367     }
368     
369     inline void* Heap::allocateWithoutDestructor(size_t bytes)
370     {
371         ASSERT(isValidAllocation(bytes));
372         return m_objectSpace.allocateWithoutDestructor(bytes);
373     }
374    
375     inline void* Heap::allocateStructure()
376     {
377         return m_objectSpace.allocateStructure();
378     }
379  
380     inline CheckedBoolean Heap::tryAllocateStorage(size_t bytes, void** outPtr)
381     {
382         return m_storageSpace.tryAllocate(bytes, outPtr);
383     }
384     
385     inline CheckedBoolean Heap::tryReallocateStorage(void** ptr, size_t oldSize, size_t newSize)
386     {
387         return m_storageSpace.tryReallocate(ptr, oldSize, newSize);
388     }
389
390     inline BlockAllocator& Heap::blockAllocator()
391     {
392         return m_blockAllocator;
393     }
394
395 } // namespace JSC
396
397 #endif // Heap_h