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