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