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