ed302b02f65304a5c26878ca00be78a9ef430950
[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 WeakGCHandlePool;
63     class SlotVisitor;
64
65     typedef std::pair<JSValue, WTF::String> ValueStringPair;
66     typedef HashCountedSet<JSCell*> ProtectCountSet;
67     typedef HashCountedSet<const char*> TypeCountSet;
68
69     enum OperationInProgress { NoOperation, Allocation, Collection };
70
71     enum HeapType { SmallHeap, LargeHeap };
72
73     class Heap {
74         WTF_MAKE_NONCOPYABLE(Heap);
75     public:
76         friend class JIT;
77         friend class GCThreadSharedData;
78         static Heap* heap(const JSValue); // 0 for immediate values
79         static Heap* heap(const JSCell*);
80
81         // This constant determines how many blocks we iterate between checks of our 
82         // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
83         // overstepping our deadline more quickly, while increasing it will cause 
84         // our scan to run faster. 
85         static const unsigned s_timeCheckResolution = 16;
86
87         static bool isMarked(const void*);
88         static bool testAndSetMarked(const void*);
89         static void setMarked(const void*);
90
91         static bool isWriteBarrierEnabled();
92         static void writeBarrier(const JSCell*, JSValue);
93         static void writeBarrier(const JSCell*, JSCell*);
94         static uint8_t* addressOfCardFor(JSCell*);
95
96         Heap(JSGlobalData*, HeapType);
97         ~Heap();
98         JS_EXPORT_PRIVATE void lastChanceToFinalize();
99
100         JSGlobalData* globalData() const { return m_globalData; }
101         MarkedSpace& objectSpace() { return m_objectSpace; }
102         MachineThreads& machineThreads() { return m_machineThreads; }
103
104         JS_EXPORT_PRIVATE GCActivityCallback* activityCallback();
105         JS_EXPORT_PRIVATE void setActivityCallback(GCActivityCallback*);
106         JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
107
108         JS_EXPORT_PRIVATE IncrementalSweeper* sweeper();
109
110         // true if an allocation or collection is in progress
111         inline bool isBusy();
112         
113         MarkedAllocator& firstAllocatorWithoutDestructors() { return m_objectSpace.firstAllocator(); }
114         MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
115         MarkedAllocator& allocatorForObjectWithNormalDestructor(size_t bytes) { return m_objectSpace.normalDestructorAllocatorFor(bytes); }
116         MarkedAllocator& allocatorForObjectWithImmortalStructureDestructor(size_t bytes) { return m_objectSpace.immortalStructureDestructorAllocatorFor(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         void didStartVMShutdown();
173
174     private:
175         friend class CodeBlock;
176         friend class GCAwareJITStubRoutine;
177         friend class JITStubRoutine;
178         friend class LLIntOffsetsExtractor;
179         friend class MarkedSpace;
180         friend class MarkedAllocator;
181         friend class MarkedBlock;
182         friend class CopiedSpace;
183         friend class SlotVisitor;
184         template<typename T> friend void* allocateCell(Heap&);
185         template<typename T> friend void* allocateCell(Heap&, size_t);
186
187         void* allocateWithImmortalStructureDestructor(size_t); // For use with special objects whose Structures never die.
188         void* allocateWithNormalDestructor(size_t); // For use with objects that inherit directly or indirectly from JSDestructibleObject.
189         void* allocateWithoutDestructor(size_t); // For use with objects without destructors.
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         void zombifyDeadObjects();
208  
209         RegisterFile& registerFile();
210         BlockAllocator& blockAllocator();
211
212         const HeapType m_heapType;
213         const size_t m_ramSize;
214         const size_t m_minBytesPerCycle;
215         size_t m_sizeAfterLastCollect;
216
217         size_t m_bytesAllocatedLimit;
218         size_t m_bytesAllocated;
219         size_t m_bytesAbandoned;
220         
221         OperationInProgress m_operationInProgress;
222         BlockAllocator m_blockAllocator;
223         MarkedSpace m_objectSpace;
224         CopiedSpace m_storageSpace;
225
226 #if ENABLE(SIMPLE_HEAP_PROFILING)
227         VTableSpectrum m_destroyedTypeCounts;
228 #endif
229
230         ProtectCountSet m_protectedValues;
231         Vector<Vector<ValueStringPair>* > m_tempSortingVectors;
232         OwnPtr<HashSet<MarkedArgumentBuffer*> > m_markListSet;
233
234         MachineThreads m_machineThreads;
235         
236         GCThreadSharedData m_sharedData;
237         SlotVisitor m_slotVisitor;
238
239         HandleSet m_handleSet;
240         HandleStack m_handleStack;
241         DFGCodeBlocks m_dfgCodeBlocks;
242         JITStubRoutineSet m_jitStubRoutines;
243         FinalizerOwner m_finalizerOwner;
244         
245         bool m_isSafeToCollect;
246
247         JSGlobalData* m_globalData;
248         double m_lastGCLength;
249         double m_lastCodeDiscardTime;
250
251         DoublyLinkedList<ExecutableBase> m_compiledCode;
252         
253         GCActivityCallback* m_activityCallback;
254         IncrementalSweeper* m_sweeper;
255     };
256
257     inline bool Heap::shouldCollect()
258     {
259 #if ENABLE(GGC)
260         return m_objectSpace.nurseryWaterMark() >= m_minBytesPerCycle && m_isSafeToCollect && m_operationInProgress == NoOperation;
261 #else
262         return m_bytesAllocated > m_bytesAllocatedLimit && m_isSafeToCollect && m_operationInProgress == NoOperation;
263 #endif
264     }
265
266     bool Heap::isBusy()
267     {
268         return m_operationInProgress != NoOperation;
269     }
270
271     inline Heap* Heap::heap(const JSCell* cell)
272     {
273         return MarkedBlock::blockFor(cell)->heap();
274     }
275
276     inline Heap* Heap::heap(const JSValue v)
277     {
278         if (!v.isCell())
279             return 0;
280         return heap(v.asCell());
281     }
282
283     inline bool Heap::isMarked(const void* cell)
284     {
285         return MarkedBlock::blockFor(cell)->isMarked(cell);
286     }
287
288     inline bool Heap::testAndSetMarked(const void* cell)
289     {
290         return MarkedBlock::blockFor(cell)->testAndSetMarked(cell);
291     }
292
293     inline void Heap::setMarked(const void* cell)
294     {
295         MarkedBlock::blockFor(cell)->setMarked(cell);
296     }
297
298     inline bool Heap::isWriteBarrierEnabled()
299     {
300 #if ENABLE(GGC) || ENABLE(WRITE_BARRIER_PROFILING)
301         return true;
302 #else
303         return false;
304 #endif
305     }
306
307 #if ENABLE(GGC)
308     inline uint8_t* Heap::addressOfCardFor(JSCell* cell)
309     {
310         return MarkedBlock::blockFor(cell)->addressOfCardFor(cell);
311     }
312
313     inline void Heap::writeBarrier(const JSCell* owner, JSCell*)
314     {
315         WriteBarrierCounters::countWriteBarrier();
316         MarkedBlock* block = MarkedBlock::blockFor(owner);
317         if (block->isMarked(owner))
318             block->setDirtyObject(owner);
319     }
320
321     inline void Heap::writeBarrier(const JSCell* owner, JSValue value)
322     {
323         if (!value)
324             return;
325         if (!value.isCell())
326             return;
327         writeBarrier(owner, value.asCell());
328     }
329 #else
330
331     inline void Heap::writeBarrier(const JSCell*, JSCell*)
332     {
333         WriteBarrierCounters::countWriteBarrier();
334     }
335
336     inline void Heap::writeBarrier(const JSCell*, JSValue)
337     {
338         WriteBarrierCounters::countWriteBarrier();
339     }
340 #endif
341
342     inline void Heap::reportExtraMemoryCost(size_t cost)
343     {
344         if (cost > minExtraCost) 
345             reportExtraMemoryCostSlowCase(cost);
346     }
347
348     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell(Functor& functor)
349     {
350         ProtectCountSet::iterator end = m_protectedValues.end();
351         for (ProtectCountSet::iterator it = m_protectedValues.begin(); it != end; ++it)
352             functor(it->first);
353         m_handleSet.forEachStrongHandle(functor, m_protectedValues);
354
355         return functor.returnValue();
356     }
357
358     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell()
359     {
360         Functor functor;
361         return forEachProtectedCell(functor);
362     }
363
364     inline void* Heap::allocateWithNormalDestructor(size_t bytes)
365     {
366         ASSERT(isValidAllocation(bytes));
367         return m_objectSpace.allocateWithNormalDestructor(bytes);
368     }
369     
370     inline void* Heap::allocateWithImmortalStructureDestructor(size_t bytes)
371     {
372         ASSERT(isValidAllocation(bytes));
373         return m_objectSpace.allocateWithImmortalStructureDestructor(bytes);
374     }
375     
376     inline void* Heap::allocateWithoutDestructor(size_t bytes)
377     {
378         ASSERT(isValidAllocation(bytes));
379         return m_objectSpace.allocateWithoutDestructor(bytes);
380     }
381    
382     inline CheckedBoolean Heap::tryAllocateStorage(size_t bytes, void** outPtr)
383     {
384         return m_storageSpace.tryAllocate(bytes, outPtr);
385     }
386     
387     inline CheckedBoolean Heap::tryReallocateStorage(void** ptr, size_t oldSize, size_t newSize)
388     {
389         return m_storageSpace.tryReallocate(ptr, oldSize, newSize);
390     }
391
392     inline BlockAllocator& Heap::blockAllocator()
393     {
394         return m_blockAllocator;
395     }
396
397 } // namespace JSC
398
399 #endif // Heap_h