Remove "virtual" from all lines that have both "virtual" and "override".
[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-2009, 2013-2015 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 "CodeBlockSet.h"
27 #include "CopyVisitor.h"
28 #include "GCIncomingRefCountedSet.h"
29 #include "HandleSet.h"
30 #include "HandleStack.h"
31 #include "HeapObserver.h"
32 #include "HeapOperation.h"
33 #include "JITStubRoutineSet.h"
34 #include "ListableHandler.h"
35 #include "MachineStackMarker.h"
36 #include "MarkedAllocator.h"
37 #include "MarkedBlock.h"
38 #include "MarkedBlockSet.h"
39 #include "MarkedSpace.h"
40 #include "Options.h"
41 #include "SlotVisitor.h"
42 #include "StructureIDTable.h"
43 #include "TinyBloomFilter.h"
44 #include "UnconditionalFinalizer.h"
45 #include "WeakHandleOwner.h"
46 #include "WeakReferenceHarvester.h"
47 #include "WriteBarrierBuffer.h"
48 #include "WriteBarrierSupport.h"
49 #include <wtf/HashCountedSet.h>
50 #include <wtf/HashSet.h>
51 #include <wtf/ParallelHelperPool.h>
52
53 namespace JSC {
54
55 class CodeBlock;
56 class CopiedSpace;
57 class EdenGCActivityCallback;
58 class ExecutableBase;
59 class FullGCActivityCallback;
60 class GCActivityCallback;
61 class GCAwareJITStubRoutine;
62 class Heap;
63 class HeapRootVisitor;
64 class HeapVerifier;
65 class IncrementalSweeper;
66 class JITStubRoutine;
67 class JSCell;
68 class JSStack;
69 class JSValue;
70 class LLIntOffsetsExtractor;
71 class MarkedArgumentBuffer;
72 class VM;
73
74 namespace DFG {
75 class SpeculativeJIT;
76 class Worklist;
77 }
78
79 static void* const zombifiedBits = reinterpret_cast<void*>(static_cast<uintptr_t>(0xdeadbeef));
80
81 typedef HashCountedSet<JSCell*> ProtectCountSet;
82 typedef HashCountedSet<const char*> TypeCountSet;
83
84 enum HeapType { SmallHeap, LargeHeap };
85
86 class Heap {
87     WTF_MAKE_NONCOPYABLE(Heap);
88 public:
89     friend class JIT;
90     friend class DFG::SpeculativeJIT;
91     static Heap* heap(const JSValue); // 0 for immediate values
92     static Heap* heap(const JSCell*);
93
94     // This constant determines how many blocks we iterate between checks of our 
95     // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
96     // overstepping our deadline more quickly, while increasing it will cause 
97     // our scan to run faster. 
98     static const unsigned s_timeCheckResolution = 16;
99
100     static bool isLive(const void*);
101     static bool isMarked(const void*);
102     static bool testAndSetMarked(const void*);
103     static void setMarked(const void*);
104
105     // This function must be run after stopAllocation() is called and 
106     // before liveness data is cleared to be accurate.
107     static bool isPointerGCObject(TinyBloomFilter, MarkedBlockSet&, void* pointer);
108     static bool isValueGCObject(TinyBloomFilter, MarkedBlockSet&, JSValue);
109
110     void writeBarrier(const JSCell*);
111     void writeBarrier(const JSCell*, JSValue);
112     void writeBarrier(const JSCell*, JSCell*);
113
114     JS_EXPORT_PRIVATE static void* copyBarrier(const JSCell* owner, void*& copiedSpacePointer);
115
116     WriteBarrierBuffer& writeBarrierBuffer() { return m_writeBarrierBuffer; }
117     void flushWriteBarrierBuffer(JSCell*);
118
119     Heap(VM*, HeapType);
120     ~Heap();
121     void lastChanceToFinalize();
122     void releaseDelayedReleasedObjects();
123
124     VM* vm() const { return m_vm; }
125     MarkedSpace& objectSpace() { return m_objectSpace; }
126     CopiedSpace& storageSpace() { return m_storageSpace; }
127     MachineThreads& machineThreads() { return m_machineThreads; }
128
129     const SlotVisitor& slotVisitor() const { return m_slotVisitor; }
130
131     JS_EXPORT_PRIVATE GCActivityCallback* fullActivityCallback();
132     JS_EXPORT_PRIVATE GCActivityCallback* edenActivityCallback();
133     JS_EXPORT_PRIVATE void setFullActivityCallback(PassRefPtr<FullGCActivityCallback>);
134     JS_EXPORT_PRIVATE void setEdenActivityCallback(PassRefPtr<EdenGCActivityCallback>);
135     JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
136
137     JS_EXPORT_PRIVATE IncrementalSweeper* sweeper();
138     JS_EXPORT_PRIVATE void setIncrementalSweeper(std::unique_ptr<IncrementalSweeper>);
139
140     void addObserver(HeapObserver* observer) { m_observers.append(observer); }
141     void removeObserver(HeapObserver* observer) { m_observers.removeFirst(observer); }
142
143     // true if collection is in progress
144     bool isCollecting();
145     HeapOperation operationInProgress() { return m_operationInProgress; }
146     // true if an allocation or collection is in progress
147     bool isBusy();
148     MarkedSpace::Subspace& subspaceForObjectWithoutDestructor() { return m_objectSpace.subspaceForObjectsWithoutDestructor(); }
149     MarkedSpace::Subspace& subspaceForObjectDestructor() { return m_objectSpace.subspaceForObjectsWithDestructor(); }
150     template<typename ClassType> MarkedSpace::Subspace& subspaceForObjectOfType();
151     MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
152     MarkedAllocator& allocatorForObjectWithDestructor(size_t bytes) { return m_objectSpace.destructorAllocatorFor(bytes); }
153     template<typename ClassType> MarkedAllocator& allocatorForObjectOfType(size_t bytes);
154     CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
155     CheckedBoolean tryAllocateStorage(JSCell* intendedOwner, size_t, void**);
156     CheckedBoolean tryReallocateStorage(JSCell* intendedOwner, void**, size_t, size_t);
157     void ascribeOwner(JSCell* intendedOwner, void*);
158
159     typedef void (*Finalizer)(JSCell*);
160     JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
161     void addExecutable(ExecutableBase*);
162
163     void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
164     bool isSafeToCollect() const { return m_isSafeToCollect; }
165
166     JS_EXPORT_PRIVATE bool isHeapSnapshotting() const;
167
168     JS_EXPORT_PRIVATE void collectAllGarbageIfNotDoneRecently();
169     void collectAllGarbage() { collectAndSweep(FullCollection); }
170     JS_EXPORT_PRIVATE void collectAndSweep(HeapOperation collectionType = AnyCollection);
171     bool shouldCollect();
172     JS_EXPORT_PRIVATE void collect(HeapOperation collectionType = AnyCollection);
173     bool collectIfNecessaryOrDefer(); // Returns true if it did collect.
174
175     void completeAllDFGPlans();
176     
177     // Use this API to report non-GC memory referenced by GC objects. Be sure to
178     // call both of these functions: Calling only one may trigger catastropic
179     // memory growth.
180     void reportExtraMemoryAllocated(size_t);
181     void reportExtraMemoryVisited(CellState cellStateBeforeVisiting, size_t);
182
183     // Use this API to report non-GC memory if you can't use the better API above.
184     void deprecatedReportExtraMemory(size_t);
185
186     JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
187
188     JS_EXPORT_PRIVATE void protect(JSValue);
189     JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
190     
191     JS_EXPORT_PRIVATE size_t extraMemorySize(); // Non-GC memory referenced by GC objects.
192     JS_EXPORT_PRIVATE size_t size();
193     JS_EXPORT_PRIVATE size_t capacity();
194     JS_EXPORT_PRIVATE size_t objectCount();
195     JS_EXPORT_PRIVATE size_t globalObjectCount();
196     JS_EXPORT_PRIVATE size_t protectedObjectCount();
197     JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
198     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> protectedObjectTypeCounts();
199     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> objectTypeCounts();
200
201     HashSet<MarkedArgumentBuffer*>& markListSet();
202     
203     template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
204     template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
205     template<typename Functor> void forEachCodeBlock(Functor&);
206
207     HandleSet* handleSet() { return &m_handleSet; }
208     HandleStack* handleStack() { return &m_handleStack; }
209
210     void willStartIterating();
211     void didFinishIterating();
212
213     double lastFullGCLength() const { return m_lastFullGCLength; }
214     double lastEdenGCLength() const { return m_lastEdenGCLength; }
215     void increaseLastFullGCLength(double amount) { m_lastFullGCLength += amount; }
216
217     size_t sizeBeforeLastEdenCollection() const { return m_sizeBeforeLastEdenCollect; }
218     size_t sizeAfterLastEdenCollection() const { return m_sizeAfterLastEdenCollect; }
219     size_t sizeBeforeLastFullCollection() const { return m_sizeBeforeLastFullCollect; }
220     size_t sizeAfterLastFullCollection() const { return m_sizeAfterLastFullCollect; }
221
222     void deleteAllCodeBlocks();
223     void deleteAllUnlinkedCodeBlocks();
224
225     void didAllocate(size_t);
226     void didAbandon(size_t);
227
228     bool isPagedOut(double deadline);
229     
230     const JITStubRoutineSet& jitStubRoutines() { return m_jitStubRoutines; }
231     
232     void addReference(JSCell*, ArrayBuffer*);
233     
234     bool isDeferred() const { return !!m_deferralDepth || !Options::useGC(); }
235
236     StructureIDTable& structureIDTable() { return m_structureIDTable; }
237
238     CodeBlockSet& codeBlockSet() { return m_codeBlocks; }
239
240 #if USE(CF)
241         template<typename T> void releaseSoon(RetainPtr<T>&&);
242 #endif
243
244     static bool isZombified(JSCell* cell) { return *(void**)cell == zombifiedBits; }
245
246     void registerWeakGCMap(void* weakGCMap, std::function<void()> pruningCallback);
247     void unregisterWeakGCMap(void* weakGCMap);
248
249     void addLogicallyEmptyWeakBlock(WeakBlock*);
250
251 #if ENABLE(RESOURCE_USAGE)
252     size_t blockBytesAllocated() const { return m_blockBytesAllocated; }
253 #endif
254
255     void didAllocateBlock(size_t capacity);
256     void didFreeBlock(size_t capacity);
257
258 private:
259     friend class CodeBlock;
260     friend class CopiedBlock;
261     friend class DeferGC;
262     friend class DeferGCForAWhile;
263     friend class GCAwareJITStubRoutine;
264     friend class GCLogging;
265     friend class GCThread;
266     friend class HandleSet;
267     friend class HeapVerifier;
268     friend class JITStubRoutine;
269     friend class LLIntOffsetsExtractor;
270     friend class MarkedSpace;
271     friend class MarkedAllocator;
272     friend class MarkedBlock;
273     friend class CopiedSpace;
274     friend class CopyVisitor;
275     friend class SlotVisitor;
276     friend class IncrementalSweeper;
277     friend class HeapStatistics;
278     friend class VM;
279     friend class WeakSet;
280     template<typename T> friend void* allocateCell(Heap&);
281     template<typename T> friend void* allocateCell(Heap&, size_t);
282
283     void* allocateWithDestructor(size_t); // For use with objects with destructors.
284     void* allocateWithoutDestructor(size_t); // For use with objects without destructors.
285     template<typename ClassType> void* allocateObjectOfType(size_t); // Chooses one of the methods above based on type.
286
287     static const size_t minExtraMemory = 256;
288     
289     class FinalizerOwner : public WeakHandleOwner {
290         void finalize(Handle<Unknown>, void* context) override;
291     };
292
293     JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
294     JS_EXPORT_PRIVATE void reportExtraMemoryAllocatedSlowCase(size_t);
295     JS_EXPORT_PRIVATE void deprecatedReportExtraMemorySlowCase(size_t);
296
297     void collectImpl(HeapOperation, void* stackOrigin, void* stackTop, MachineThreads::RegisterState&);
298
299     void suspendCompilerThreads();
300     void willStartCollection(HeapOperation collectionType);
301     void flushOldStructureIDTables();
302     void flushWriteBarrierBuffer();
303     void stopAllocation();
304     
305     void markRoots(double gcStartTime, void* stackOrigin, void* stackTop, MachineThreads::RegisterState&);
306     void gatherStackRoots(ConservativeRoots&, void* stackOrigin, void* stackTop, MachineThreads::RegisterState&);
307     void gatherJSStackRoots(ConservativeRoots&);
308     void gatherScratchBufferRoots(ConservativeRoots&);
309     void clearLivenessData();
310     void visitExternalRememberedSet();
311     void visitSmallStrings();
312     void visitConservativeRoots(ConservativeRoots&);
313     void visitCompilerWorklistWeakReferences();
314     void removeDeadCompilerWorklistEntries();
315     void visitProtectedObjects(HeapRootVisitor&);
316     void visitArgumentBuffers(HeapRootVisitor&);
317     void visitException(HeapRootVisitor&);
318     void visitStrongHandles(HeapRootVisitor&);
319     void visitHandleStack(HeapRootVisitor&);
320     void visitSamplingProfiler();
321     void traceCodeBlocksAndJITStubRoutines();
322     void converge();
323     void visitWeakHandles(HeapRootVisitor&);
324     void updateObjectCounts(double gcStartTime);
325     void resetVisitors();
326
327     void reapWeakHandles();
328     void pruneStaleEntriesFromWeakGCMaps();
329     void sweepArrayBuffers();
330     void snapshotMarkedSpace();
331     void deleteSourceProviderCaches();
332     void removeDeadHeapSnapshotNodes();
333     void notifyIncrementalSweeper();
334     void writeBarrierCurrentlyExecutingCodeBlocks();
335     void resetAllocators();
336     void copyBackingStores();
337     void harvestWeakReferences();
338     void finalizeUnconditionalFinalizers();
339     void clearUnmarkedExecutables();
340     void deleteUnmarkedCompiledCode();
341     JS_EXPORT_PRIVATE void addToRememberedSet(const JSCell*);
342     void updateAllocationLimits();
343     void didFinishCollection(double gcStartTime);
344     void resumeCompilerThreads();
345     void zombifyDeadObjects();
346     void markDeadObjects();
347
348     void sweepAllLogicallyEmptyWeakBlocks();
349     bool sweepNextLogicallyEmptyWeakBlock();
350
351     bool shouldDoFullCollection(HeapOperation requestedCollectionType) const;
352
353     JSStack& stack();
354     
355     void incrementDeferralDepth();
356     void decrementDeferralDepth();
357     void decrementDeferralDepthAndGCIfNeeded();
358
359     size_t threadVisitCount();
360     size_t threadBytesVisited();
361     size_t threadBytesCopied();
362
363     const HeapType m_heapType;
364     const size_t m_ramSize;
365     const size_t m_minBytesPerCycle;
366     size_t m_sizeAfterLastCollect;
367     size_t m_sizeAfterLastFullCollect;
368     size_t m_sizeBeforeLastFullCollect;
369     size_t m_sizeAfterLastEdenCollect;
370     size_t m_sizeBeforeLastEdenCollect;
371
372     size_t m_bytesAllocatedThisCycle;
373     size_t m_bytesAbandonedSinceLastFullCollect;
374     size_t m_maxEdenSize;
375     size_t m_maxHeapSize;
376     bool m_shouldDoFullCollection;
377     size_t m_totalBytesVisited;
378     size_t m_totalBytesVisitedThisCycle;
379     size_t m_totalBytesCopied;
380     size_t m_totalBytesCopiedThisCycle;
381     
382     HeapOperation m_operationInProgress;
383     StructureIDTable m_structureIDTable;
384     MarkedSpace m_objectSpace;
385     CopiedSpace m_storageSpace;
386     GCIncomingRefCountedSet<ArrayBuffer> m_arrayBuffers;
387     size_t m_extraMemorySize;
388     size_t m_deprecatedExtraMemorySize;
389
390     HashSet<const JSCell*> m_copyingRememberedSet;
391
392     ProtectCountSet m_protectedValues;
393     std::unique_ptr<HashSet<MarkedArgumentBuffer*>> m_markListSet;
394
395     MachineThreads m_machineThreads;
396     
397     SlotVisitor m_slotVisitor;
398
399     // We pool the slot visitors used by parallel marking threads. It's useful to be able to
400     // enumerate over them, and it's useful to have them cache some small amount of memory from
401     // one GC to the next. GC marking threads claim these at the start of marking, and return
402     // them at the end.
403     Vector<std::unique_ptr<SlotVisitor>> m_parallelSlotVisitors;
404     Vector<SlotVisitor*> m_availableParallelSlotVisitors;
405     Lock m_parallelSlotVisitorLock;
406
407     HandleSet m_handleSet;
408     HandleStack m_handleStack;
409     CodeBlockSet m_codeBlocks;
410     JITStubRoutineSet m_jitStubRoutines;
411     FinalizerOwner m_finalizerOwner;
412     
413     bool m_isSafeToCollect;
414
415     WriteBarrierBuffer m_writeBarrierBuffer;
416
417     VM* m_vm;
418     double m_lastFullGCLength;
419     double m_lastEdenGCLength;
420
421     Vector<ExecutableBase*> m_executables;
422
423     Vector<WeakBlock*> m_logicallyEmptyWeakBlocks;
424     size_t m_indexOfNextLogicallyEmptyWeakBlockToSweep { WTF::notFound };
425     
426     RefPtr<FullGCActivityCallback> m_fullActivityCallback;
427     RefPtr<GCActivityCallback> m_edenActivityCallback;
428     std::unique_ptr<IncrementalSweeper> m_sweeper;
429     Vector<MarkedBlock*> m_blockSnapshot;
430
431     Vector<HeapObserver*> m_observers;
432
433     unsigned m_deferralDepth;
434     Vector<DFG::Worklist*> m_suspendedCompilerWorklists;
435
436     std::unique_ptr<HeapVerifier> m_verifier;
437 #if USE(CF)
438     Vector<RetainPtr<CFTypeRef>> m_delayedReleaseObjects;
439     unsigned m_delayedReleaseRecursionCount;
440 #endif
441
442     HashMap<void*, std::function<void()>> m_weakGCMaps;
443
444     Lock m_markingMutex;
445     Condition m_markingConditionVariable;
446     MarkStackArray m_sharedMarkStack;
447     unsigned m_numberOfActiveParallelMarkers { 0 };
448     unsigned m_numberOfWaitingParallelMarkers { 0 };
449     bool m_parallelMarkersShouldExit { false };
450
451     Lock m_opaqueRootsMutex;
452     HashSet<void*> m_opaqueRoots;
453
454     Vector<CopiedBlock*> m_blocksToCopy;
455     static const size_t s_blockFragmentLength = 32;
456
457     ListableHandler<WeakReferenceHarvester>::List m_weakReferenceHarvesters;
458     ListableHandler<UnconditionalFinalizer>::List m_unconditionalFinalizers;
459
460     ParallelHelperClient m_helperClient;
461
462 #if ENABLE(RESOURCE_USAGE)
463     size_t m_blockBytesAllocated { 0 };
464 #endif
465 };
466
467 } // namespace JSC
468
469 #endif // Heap_h