JSC should dump object size inference statistics
[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& allocatorForObjectWithDestructor(size_t bytes) { return m_objectSpace.destructorAllocatorFor(bytes); }
116         CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
117         CheckedBoolean tryAllocateStorage(size_t, void**);
118         CheckedBoolean tryReallocateStorage(void**, size_t, size_t);
119
120         typedef void (*Finalizer)(JSCell*);
121         JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
122         void addCompiledCode(ExecutableBase*);
123
124         void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
125         bool isSafeToCollect() const { return m_isSafeToCollect; }
126
127         JS_EXPORT_PRIVATE void collectAllGarbage();
128         enum SweepToggle { DoNotSweep, DoSweep };
129         bool shouldCollect();
130         void collect(SweepToggle);
131
132         void reportExtraMemoryCost(size_t cost);
133         JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
134
135         JS_EXPORT_PRIVATE void protect(JSValue);
136         JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
137         
138         void jettisonDFGCodeBlock(PassOwnPtr<CodeBlock>);
139
140         JS_EXPORT_PRIVATE size_t size();
141         JS_EXPORT_PRIVATE size_t capacity();
142         JS_EXPORT_PRIVATE size_t objectCount();
143         JS_EXPORT_PRIVATE size_t globalObjectCount();
144         JS_EXPORT_PRIVATE size_t protectedObjectCount();
145         JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
146         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> protectedObjectTypeCounts();
147         JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> objectTypeCounts();
148         void showStatistics();
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         template<typename T> friend void* allocateCell(Heap&, size_t);
187
188         void* allocateWithDestructor(size_t);
189         void* allocateWithoutDestructor(size_t);
190         void* allocateStructure(size_t);
191
192         static const size_t minExtraCost = 256;
193         static const size_t maxExtraCost = 1024 * 1024;
194         
195         class FinalizerOwner : public WeakHandleOwner {
196             virtual void finalize(Handle<Unknown>, void* context);
197         };
198
199         JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
200         JS_EXPORT_PRIVATE void reportExtraMemoryCostSlowCase(size_t);
201
202         void markRoots(bool fullGC);
203         void markProtectedObjects(HeapRootVisitor&);
204         void markTempSortVectors(HeapRootVisitor&);
205         void harvestWeakReferences();
206         void finalizeUnconditionalFinalizers();
207         void deleteUnmarkedCompiledCode();
208         void zombifyDeadObjects();
209         void markDeadObjects();
210
211         RegisterFile& registerFile();
212         BlockAllocator& blockAllocator();
213
214         const HeapType m_heapType;
215         const size_t m_ramSize;
216         const size_t m_minBytesPerCycle;
217         size_t m_sizeAfterLastCollect;
218
219         size_t m_bytesAllocatedLimit;
220         size_t m_bytesAllocated;
221         size_t m_bytesAbandoned;
222         
223         OperationInProgress m_operationInProgress;
224         BlockAllocator m_blockAllocator;
225         MarkedSpace m_objectSpace;
226         CopiedSpace m_storageSpace;
227
228 #if ENABLE(SIMPLE_HEAP_PROFILING)
229         VTableSpectrum m_destroyedTypeCounts;
230 #endif
231
232         ProtectCountSet m_protectedValues;
233         Vector<Vector<ValueStringPair>* > m_tempSortingVectors;
234         OwnPtr<HashSet<MarkedArgumentBuffer*> > m_markListSet;
235
236         MachineThreads m_machineThreads;
237         
238         GCThreadSharedData m_sharedData;
239         SlotVisitor m_slotVisitor;
240
241         HandleSet m_handleSet;
242         HandleStack m_handleStack;
243         DFGCodeBlocks m_dfgCodeBlocks;
244         JITStubRoutineSet m_jitStubRoutines;
245         FinalizerOwner m_finalizerOwner;
246         
247         bool m_isSafeToCollect;
248
249         JSGlobalData* m_globalData;
250         double m_lastGCLength;
251         double m_lastCodeDiscardTime;
252
253         DoublyLinkedList<ExecutableBase> m_compiledCode;
254         
255         GCActivityCallback* m_activityCallback;
256         IncrementalSweeper* m_sweeper;
257     };
258
259     inline bool Heap::shouldCollect()
260     {
261 #if ENABLE(GGC)
262         return m_objectSpace.nurseryWaterMark() >= m_minBytesPerCycle && m_isSafeToCollect && m_operationInProgress == NoOperation;
263 #else
264         return m_bytesAllocated > m_bytesAllocatedLimit && m_isSafeToCollect && m_operationInProgress == NoOperation;
265 #endif
266     }
267
268     bool Heap::isBusy()
269     {
270         return m_operationInProgress != NoOperation;
271     }
272
273     inline Heap* Heap::heap(const JSCell* cell)
274     {
275         return MarkedBlock::blockFor(cell)->heap();
276     }
277
278     inline Heap* Heap::heap(const JSValue v)
279     {
280         if (!v.isCell())
281             return 0;
282         return heap(v.asCell());
283     }
284
285     inline bool Heap::isMarked(const void* cell)
286     {
287         return MarkedBlock::blockFor(cell)->isMarked(cell);
288     }
289
290     inline bool Heap::testAndSetMarked(const void* cell)
291     {
292         return MarkedBlock::blockFor(cell)->testAndSetMarked(cell);
293     }
294
295     inline void Heap::setMarked(const void* cell)
296     {
297         MarkedBlock::blockFor(cell)->setMarked(cell);
298     }
299
300     inline bool Heap::isWriteBarrierEnabled()
301     {
302 #if ENABLE(GGC) || ENABLE(WRITE_BARRIER_PROFILING)
303         return true;
304 #else
305         return false;
306 #endif
307     }
308
309 #if ENABLE(GGC)
310     inline uint8_t* Heap::addressOfCardFor(JSCell* cell)
311     {
312         return MarkedBlock::blockFor(cell)->addressOfCardFor(cell);
313     }
314
315     inline void Heap::writeBarrier(const JSCell* owner, JSCell*)
316     {
317         WriteBarrierCounters::countWriteBarrier();
318         MarkedBlock* block = MarkedBlock::blockFor(owner);
319         if (block->isMarked(owner))
320             block->setDirtyObject(owner);
321     }
322
323     inline void Heap::writeBarrier(const JSCell* owner, JSValue value)
324     {
325         if (!value)
326             return;
327         if (!value.isCell())
328             return;
329         writeBarrier(owner, value.asCell());
330     }
331 #else
332
333     inline void Heap::writeBarrier(const JSCell*, JSCell*)
334     {
335         WriteBarrierCounters::countWriteBarrier();
336     }
337
338     inline void Heap::writeBarrier(const JSCell*, JSValue)
339     {
340         WriteBarrierCounters::countWriteBarrier();
341     }
342 #endif
343
344     inline void Heap::reportExtraMemoryCost(size_t cost)
345     {
346         if (cost > minExtraCost) 
347             reportExtraMemoryCostSlowCase(cost);
348     }
349
350     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell(Functor& functor)
351     {
352         ProtectCountSet::iterator end = m_protectedValues.end();
353         for (ProtectCountSet::iterator it = m_protectedValues.begin(); it != end; ++it)
354             functor(it->first);
355         m_handleSet.forEachStrongHandle(functor, m_protectedValues);
356
357         return functor.returnValue();
358     }
359
360     template<typename Functor> inline typename Functor::ReturnType Heap::forEachProtectedCell()
361     {
362         Functor functor;
363         return forEachProtectedCell(functor);
364     }
365
366     inline void* Heap::allocateWithDestructor(size_t bytes)
367     {
368         ASSERT(isValidAllocation(bytes));
369         return m_objectSpace.allocateWithDestructor(bytes);
370     }
371     
372     inline void* Heap::allocateWithoutDestructor(size_t bytes)
373     {
374         ASSERT(isValidAllocation(bytes));
375         return m_objectSpace.allocateWithoutDestructor(bytes);
376     }
377    
378     inline void* Heap::allocateStructure(size_t bytes)
379     {
380         return m_objectSpace.allocateStructure(bytes);
381     }
382  
383     inline CheckedBoolean Heap::tryAllocateStorage(size_t bytes, void** outPtr)
384     {
385         return m_storageSpace.tryAllocate(bytes, outPtr);
386     }
387     
388     inline CheckedBoolean Heap::tryReallocateStorage(void** ptr, size_t oldSize, size_t newSize)
389     {
390         return m_storageSpace.tryReallocate(ptr, oldSize, newSize);
391     }
392
393     inline BlockAllocator& Heap::blockAllocator()
394     {
395         return m_blockAllocator;
396     }
397
398 } // namespace JSC
399
400 #endif // Heap_h