Objective-C API external object graphs don't handle generational collection properly
[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, 2013 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 "ArrayBuffer.h"
26 #include "BlockAllocator.h"
27 #include "CodeBlockSet.h"
28 #include "CopyVisitor.h"
29 #include "GCIncomingRefCountedSet.h"
30 #include "GCThreadSharedData.h"
31 #include "HandleSet.h"
32 #include "HandleStack.h"
33 #include "HeapOperation.h"
34 #include "JITStubRoutineSet.h"
35 #include "MarkedAllocator.h"
36 #include "MarkedBlock.h"
37 #include "MarkedBlockSet.h"
38 #include "MarkedSpace.h"
39 #include "Options.h"
40 #include "SlotVisitor.h"
41 #include "StructureIDTable.h"
42 #include "WeakHandleOwner.h"
43 #include "WriteBarrierBuffer.h"
44 #include "WriteBarrierSupport.h"
45 #include <wtf/HashCountedSet.h>
46 #include <wtf/HashSet.h>
47
48 #define COLLECT_ON_EVERY_ALLOCATION 0
49
50 namespace JSC {
51
52 class CopiedSpace;
53 class CodeBlock;
54 class ExecutableBase;
55 class EdenGCActivityCallback;
56 class FullGCActivityCallback;
57 class GCActivityCallback;
58 class GCAwareJITStubRoutine;
59 class GlobalCodeBlock;
60 class Heap;
61 class HeapRootVisitor;
62 class IncrementalSweeper;
63 class JITStubRoutine;
64 class JSCell;
65 class VM;
66 class JSStack;
67 class JSValue;
68 class LiveObjectIterator;
69 class LLIntOffsetsExtractor;
70 class MarkedArgumentBuffer;
71 class WeakGCHandlePool;
72 class SlotVisitor;
73
74 typedef std::pair<JSValue, WTF::String> ValueStringPair;
75 typedef HashCountedSet<JSCell*> ProtectCountSet;
76 typedef HashCountedSet<const char*> TypeCountSet;
77
78 enum HeapType { SmallHeap, LargeHeap };
79
80 class Heap {
81     WTF_MAKE_NONCOPYABLE(Heap);
82 public:
83     friend class JIT;
84     friend class DFG::SpeculativeJIT;
85     friend class GCThreadSharedData;
86     static Heap* heap(const JSValue); // 0 for immediate values
87     static Heap* heap(const JSCell*);
88
89     // This constant determines how many blocks we iterate between checks of our 
90     // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
91     // overstepping our deadline more quickly, while increasing it will cause 
92     // our scan to run faster. 
93     static const unsigned s_timeCheckResolution = 16;
94
95     static bool isLive(const void*);
96     static bool isMarked(const void*);
97     static bool testAndSetMarked(const void*);
98     static void setMarked(const void*);
99     static bool isRemembered(const void*);
100
101     JS_EXPORT_PRIVATE void addToRememberedSet(const JSCell*);
102     static bool isWriteBarrierEnabled();
103     void writeBarrier(const JSCell*);
104     void writeBarrier(const JSCell*, JSValue);
105     void writeBarrier(const JSCell*, JSCell*);
106
107     WriteBarrierBuffer& writeBarrierBuffer() { return m_writeBarrierBuffer; }
108     void flushWriteBarrierBuffer(JSCell*);
109
110     Heap(VM*, HeapType);
111     ~Heap();
112     JS_EXPORT_PRIVATE void lastChanceToFinalize();
113
114     VM* vm() const { return m_vm; }
115     MarkedSpace& objectSpace() { return m_objectSpace; }
116     MachineThreads& machineThreads() { return m_machineThreads; }
117
118     const SlotVisitor& slotVisitor() const { return m_slotVisitor; }
119
120     JS_EXPORT_PRIVATE GCActivityCallback* fullActivityCallback();
121     JS_EXPORT_PRIVATE GCActivityCallback* edenActivityCallback();
122     JS_EXPORT_PRIVATE void setFullActivityCallback(PassRefPtr<FullGCActivityCallback>);
123     JS_EXPORT_PRIVATE void setEdenActivityCallback(PassRefPtr<EdenGCActivityCallback>);
124     JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
125
126     JS_EXPORT_PRIVATE IncrementalSweeper* sweeper();
127     JS_EXPORT_PRIVATE void setIncrementalSweeper(PassOwnPtr<IncrementalSweeper>);
128
129     // true if collection is in progress
130     bool isCollecting();
131     HeapOperation operationInProgress() { return m_operationInProgress; }
132     // true if an allocation or collection is in progress
133     bool isBusy();
134     
135     MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
136     MarkedAllocator& allocatorForObjectWithNormalDestructor(size_t bytes) { return m_objectSpace.normalDestructorAllocatorFor(bytes); }
137     MarkedAllocator& allocatorForObjectWithImmortalStructureDestructor(size_t bytes) { return m_objectSpace.immortalStructureDestructorAllocatorFor(bytes); }
138     CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
139     CheckedBoolean tryAllocateStorage(JSCell* intendedOwner, size_t, void**);
140     CheckedBoolean tryReallocateStorage(JSCell* intendedOwner, void**, size_t, size_t);
141     void ascribeOwner(JSCell* intendedOwner, void*);
142
143     typedef void (*Finalizer)(JSCell*);
144     JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
145     void addCompiledCode(ExecutableBase*);
146
147     void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
148     bool isSafeToCollect() const { return m_isSafeToCollect; }
149
150     JS_EXPORT_PRIVATE void collectAllGarbage();
151     bool shouldCollect();
152     JS_EXPORT_PRIVATE void collect(HeapOperation collectionType = AnyCollection);
153     bool collectIfNecessaryOrDefer(); // Returns true if it did collect.
154
155     void reportExtraMemoryCost(size_t cost);
156     JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
157
158     JS_EXPORT_PRIVATE void protect(JSValue);
159     JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
160     
161     size_t extraSize(); // extra memory usage outside of pages allocated by the heap
162     JS_EXPORT_PRIVATE size_t size();
163     JS_EXPORT_PRIVATE size_t capacity();
164     JS_EXPORT_PRIVATE size_t objectCount();
165     JS_EXPORT_PRIVATE size_t globalObjectCount();
166     JS_EXPORT_PRIVATE size_t protectedObjectCount();
167     JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
168     JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> protectedObjectTypeCounts();
169     JS_EXPORT_PRIVATE PassOwnPtr<TypeCountSet> objectTypeCounts();
170     void showStatistics();
171
172     void pushTempSortVector(Vector<ValueStringPair, 0, UnsafeVectorOverflow>*);
173     void popTempSortVector(Vector<ValueStringPair, 0, UnsafeVectorOverflow>*);
174
175     HashSet<MarkedArgumentBuffer*>& markListSet();
176     
177     template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
178     template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
179     template<typename Functor> void forEachCodeBlock(Functor&);
180
181     HandleSet* handleSet() { return &m_handleSet; }
182     HandleStack* handleStack() { return &m_handleStack; }
183
184     void willStartIterating();
185     void didFinishIterating();
186     void getConservativeRegisterRoots(HashSet<JSCell*>& roots);
187
188     double lastFullGCLength() const { return m_lastFullGCLength; }
189     double lastEdenGCLength() const { return m_lastEdenGCLength; }
190     void increaseLastFullGCLength(double amount) { m_lastFullGCLength += amount; }
191
192     size_t sizeBeforeLastEdenCollection() const { return m_sizeBeforeLastEdenCollect; }
193     size_t sizeAfterLastEdenCollection() const { return m_sizeAfterLastEdenCollect; }
194     size_t sizeBeforeLastFullCollection() const { return m_sizeBeforeLastFullCollect; }
195     size_t sizeAfterLastFullCollection() const { return m_sizeAfterLastFullCollect; }
196
197     JS_EXPORT_PRIVATE void deleteAllCompiledCode();
198     void deleteAllUnlinkedFunctionCode();
199
200     void didAllocate(size_t);
201     void didAbandon(size_t);
202
203     bool isPagedOut(double deadline);
204     
205     const JITStubRoutineSet& jitStubRoutines() { return m_jitStubRoutines; }
206     
207     void addReference(JSCell*, ArrayBuffer*);
208     
209     bool isDeferred() const { return !!m_deferralDepth || Options::disableGC(); }
210
211     BlockAllocator& blockAllocator();
212     StructureIDTable& structureIDTable() { return m_structureIDTable; }
213
214 #if USE(CF)
215         template<typename T> void releaseSoon(RetainPtr<T>&&);
216 #endif
217
218     void removeCodeBlock(CodeBlock* cb) { m_codeBlocks.remove(cb); }
219
220 private:
221     friend class CodeBlock;
222     friend class CopiedBlock;
223     friend class DeferGC;
224     friend class DeferGCForAWhile;
225     friend class DelayedReleaseScope;
226     friend class GCAwareJITStubRoutine;
227     friend class GCLogging;
228     friend class HandleSet;
229     friend class JITStubRoutine;
230     friend class LLIntOffsetsExtractor;
231     friend class MarkedSpace;
232     friend class MarkedAllocator;
233     friend class MarkedBlock;
234     friend class CopiedSpace;
235     friend class CopyVisitor;
236     friend class RecursiveAllocationScope;
237     friend class SlotVisitor;
238     friend class SuperRegion;
239     friend class IncrementalSweeper;
240     friend class HeapStatistics;
241     friend class VM;
242     friend class WeakSet;
243     template<typename T> friend void* allocateCell(Heap&);
244     template<typename T> friend void* allocateCell(Heap&, size_t);
245
246     void* allocateWithImmortalStructureDestructor(size_t); // For use with special objects whose Structures never die.
247     void* allocateWithNormalDestructor(size_t); // For use with objects that inherit directly or indirectly from JSDestructibleObject.
248     void* allocateWithoutDestructor(size_t); // For use with objects without destructors.
249
250     static const size_t minExtraCost = 256;
251     static const size_t maxExtraCost = 1024 * 1024;
252     
253     class FinalizerOwner : public WeakHandleOwner {
254         virtual void finalize(Handle<Unknown>, void* context) override;
255     };
256
257     JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
258     JS_EXPORT_PRIVATE void reportExtraMemoryCostSlowCase(size_t);
259
260     void suspendCompilerThreads();
261     void willStartCollection(HeapOperation collectionType);
262     void deleteOldCode(double gcStartTime);
263     void flushOldStructureIDTables();
264     void flushWriteBarrierBuffer();
265     void stopAllocation();
266
267     void markRoots(double gcStartTime);
268     void gatherStackRoots(ConservativeRoots&, void** dummy);
269     void gatherJSStackRoots(ConservativeRoots&);
270     void gatherScratchBufferRoots(ConservativeRoots&);
271     void clearLivenessData();
272     void visitExternalRememberedSet();
273     void visitSmallStrings();
274     void visitConservativeRoots(ConservativeRoots&);
275     void visitCompilerWorklists();
276     void visitProtectedObjects(HeapRootVisitor&);
277     void visitTempSortVectors(HeapRootVisitor&);
278     void visitArgumentBuffers(HeapRootVisitor&);
279     void visitException(HeapRootVisitor&);
280     void visitStrongHandles(HeapRootVisitor&);
281     void visitHandleStack(HeapRootVisitor&);
282     void traceCodeBlocksAndJITStubRoutines();
283     void converge();
284     void visitWeakHandles(HeapRootVisitor&);
285     void clearRememberedSet(Vector<const JSCell*>&);
286     void updateObjectCounts(double gcStartTime);
287     void resetVisitors();
288
289     void reapWeakHandles();
290     void sweepArrayBuffers();
291     void snapshotMarkedSpace();
292     void deleteSourceProviderCaches();
293     void notifyIncrementalSweeper();
294     void rememberCurrentlyExecutingCodeBlocks();
295     void resetAllocators();
296     void copyBackingStores();
297     void harvestWeakReferences();
298     void finalizeUnconditionalFinalizers();
299     void clearUnmarkedExecutables();
300     void deleteUnmarkedCompiledCode();
301     void updateAllocationLimits();
302     void didFinishCollection(double gcStartTime);
303     void resumeCompilerThreads();
304     void zombifyDeadObjects();
305     void markDeadObjects();
306
307     bool shouldDoFullCollection(HeapOperation requestedCollectionType) const;
308     size_t sizeAfterCollect();
309
310     JSStack& stack();
311     
312     void incrementDeferralDepth();
313     void decrementDeferralDepth();
314     void decrementDeferralDepthAndGCIfNeeded();
315
316     const HeapType m_heapType;
317     const size_t m_ramSize;
318     const size_t m_minBytesPerCycle;
319     size_t m_sizeAfterLastCollect;
320     size_t m_sizeAfterLastFullCollect;
321     size_t m_sizeBeforeLastFullCollect;
322     size_t m_sizeAfterLastEdenCollect;
323     size_t m_sizeBeforeLastEdenCollect;
324
325     size_t m_bytesAllocatedThisCycle;
326     size_t m_bytesAbandonedSinceLastFullCollect;
327     size_t m_maxEdenSize;
328     size_t m_maxHeapSize;
329     bool m_shouldDoFullCollection;
330     size_t m_totalBytesVisited;
331     size_t m_totalBytesCopied;
332     
333     HeapOperation m_operationInProgress;
334     BlockAllocator m_blockAllocator;
335     StructureIDTable m_structureIDTable;
336     MarkedSpace m_objectSpace;
337     CopiedSpace m_storageSpace;
338     GCIncomingRefCountedSet<ArrayBuffer> m_arrayBuffers;
339     size_t m_extraMemoryUsage;
340
341     HashSet<const JSCell*> m_copyingRememberedSet;
342
343     ProtectCountSet m_protectedValues;
344     Vector<Vector<ValueStringPair, 0, UnsafeVectorOverflow>*> m_tempSortingVectors;
345     OwnPtr<HashSet<MarkedArgumentBuffer*>> m_markListSet;
346
347     MachineThreads m_machineThreads;
348     
349     GCThreadSharedData m_sharedData;
350     SlotVisitor m_slotVisitor;
351     CopyVisitor m_copyVisitor;
352
353     HandleSet m_handleSet;
354     HandleStack m_handleStack;
355     CodeBlockSet m_codeBlocks;
356     JITStubRoutineSet m_jitStubRoutines;
357     FinalizerOwner m_finalizerOwner;
358     
359     bool m_isSafeToCollect;
360
361     WriteBarrierBuffer m_writeBarrierBuffer;
362
363     VM* m_vm;
364     double m_lastFullGCLength;
365     double m_lastEdenGCLength;
366     double m_lastCodeDiscardTime;
367
368     DoublyLinkedList<ExecutableBase> m_compiledCode;
369     
370     RefPtr<GCActivityCallback> m_fullActivityCallback;
371     RefPtr<GCActivityCallback> m_edenActivityCallback;
372     OwnPtr<IncrementalSweeper> m_sweeper;
373     Vector<MarkedBlock*> m_blockSnapshot;
374     
375     unsigned m_deferralDepth;
376 };
377
378 } // namespace JSC
379
380 #endif // Heap_h