CodeBlocks should be in IsoSubspaces
[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-2017 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 #pragma once
23
24 #include "ArrayBuffer.h"
25 #include "CellState.h"
26 #include "CollectionScope.h"
27 #include "CollectorPhase.h"
28 #include "DeleteAllCodeEffort.h"
29 #include "GCConductor.h"
30 #include "GCIncomingRefCountedSet.h"
31 #include "GCRequest.h"
32 #include "HandleSet.h"
33 #include "HeapFinalizerCallback.h"
34 #include "HeapObserver.h"
35 #include "ListableHandler.h"
36 #include "MarkedBlock.h"
37 #include "MarkedSpace.h"
38 #include "MutatorState.h"
39 #include "Options.h"
40 #include "StructureIDTable.h"
41 #include "Synchronousness.h"
42 #include "UnconditionalFinalizer.h"
43 #include "WeakHandleOwner.h"
44 #include "WeakReferenceHarvester.h"
45 #include <wtf/AutomaticThread.h>
46 #include <wtf/ConcurrentPtrHashSet.h>
47 #include <wtf/Deque.h>
48 #include <wtf/HashCountedSet.h>
49 #include <wtf/HashSet.h>
50 #include <wtf/ParallelHelperPool.h>
51 #include <wtf/Threading.h>
52
53 namespace JSC {
54
55 class CodeBlock;
56 class CodeBlockSet;
57 class CollectingScope;
58 class ConservativeRoots;
59 class GCDeferralContext;
60 class EdenGCActivityCallback;
61 class ExecutableBase;
62 class FullGCActivityCallback;
63 class GCActivityCallback;
64 class GCAwareJITStubRoutine;
65 class Heap;
66 class HeapProfiler;
67 class HeapVerifier;
68 class IncrementalSweeper;
69 class JITStubRoutine;
70 class JITStubRoutineSet;
71 class JSCell;
72 class JSValue;
73 class LLIntOffsetsExtractor;
74 class MachineThreads;
75 class MarkStackArray;
76 class MarkStackMergingConstraint;
77 class MarkedAllocator;
78 class MarkedArgumentBuffer;
79 class MarkingConstraint;
80 class MarkingConstraintSet;
81 class MutatorScheduler;
82 class RunningScope;
83 class SlotVisitor;
84 class SpaceTimeMutatorScheduler;
85 class StopIfNecessaryTimer;
86 class SweepingScope;
87 class VM;
88 class WeakGCMapBase;
89 struct CurrentThreadState;
90
91 namespace DFG {
92 class SpeculativeJIT;
93 class Worklist;
94 }
95
96 typedef HashCountedSet<JSCell*> ProtectCountSet;
97 typedef HashCountedSet<const char*> TypeCountSet;
98
99 enum HeapType { SmallHeap, LargeHeap };
100
101 class HeapUtil;
102
103 class Heap {
104     WTF_MAKE_NONCOPYABLE(Heap);
105 public:
106     friend class JIT;
107     friend class DFG::SpeculativeJIT;
108     static Heap* heap(const JSValue); // 0 for immediate values
109     static Heap* heap(const HeapCell*);
110
111     // This constant determines how many blocks we iterate between checks of our 
112     // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
113     // overstepping our deadline more quickly, while increasing it will cause 
114     // our scan to run faster. 
115     static const unsigned s_timeCheckResolution = 16;
116
117     static bool isMarked(const void*);
118     static bool testAndSetMarked(HeapVersion, const void*);
119     
120     static size_t cellSize(const void*);
121
122     void writeBarrier(const JSCell* from);
123     void writeBarrier(const JSCell* from, JSValue to);
124     void writeBarrier(const JSCell* from, JSCell* to);
125     
126     void writeBarrierWithoutFence(const JSCell* from);
127     
128     void mutatorFence();
129     
130     // Take this if you know that from->cellState() < barrierThreshold.
131     JS_EXPORT_PRIVATE void writeBarrierSlowPath(const JSCell* from);
132
133     Heap(VM*, HeapType);
134     ~Heap();
135     void lastChanceToFinalize();
136     void releaseDelayedReleasedObjects();
137
138     VM* vm() const;
139
140     MarkedSpace& objectSpace() { return m_objectSpace; }
141     MachineThreads& machineThreads() { return *m_machineThreads; }
142
143     SlotVisitor& collectorSlotVisitor() { return *m_collectorSlotVisitor; }
144
145     JS_EXPORT_PRIVATE GCActivityCallback* fullActivityCallback();
146     JS_EXPORT_PRIVATE GCActivityCallback* edenActivityCallback();
147     JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
148
149     JS_EXPORT_PRIVATE IncrementalSweeper& sweeper();
150
151     void addObserver(HeapObserver* observer) { m_observers.append(observer); }
152     void removeObserver(HeapObserver* observer) { m_observers.removeFirst(observer); }
153
154     MutatorState mutatorState() const { return m_mutatorState; }
155     std::optional<CollectionScope> collectionScope() const { return m_collectionScope; }
156     bool hasHeapAccess() const;
157     bool worldIsStopped() const;
158     bool worldIsRunning() const { return !worldIsStopped(); }
159
160     // We're always busy on the collection threads. On the main thread, this returns true if we're
161     // helping heap.
162     JS_EXPORT_PRIVATE bool isCurrentThreadBusy();
163     
164     typedef void (*Finalizer)(JSCell*);
165     JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
166     void addExecutable(ExecutableBase*);
167
168     void notifyIsSafeToCollect();
169     bool isSafeToCollect() const { return m_isSafeToCollect; }
170     
171     bool isShuttingDown() const { return m_isShuttingDown; }
172
173     JS_EXPORT_PRIVATE bool isHeapSnapshotting() const;
174
175     JS_EXPORT_PRIVATE void sweepSynchronously();
176
177     bool shouldCollectHeuristic();
178     
179     // Queue up a collection. Returns immediately. This will not queue a collection if a collection
180     // of equal or greater strength exists. Full collections are stronger than std::nullopt collections
181     // and std::nullopt collections are stronger than Eden collections. std::nullopt means that the GC can
182     // choose Eden or Full. This implies that if you request a GC while that GC is ongoing, nothing
183     // will happen.
184     JS_EXPORT_PRIVATE void collectAsync(GCRequest = GCRequest());
185     
186     // Queue up a collection and wait for it to complete. This won't return until you get your own
187     // complete collection. For example, if there was an ongoing asynchronous collection at the time
188     // you called this, then this would wait for that one to complete and then trigger your
189     // collection and then return. In weird cases, there could be multiple GC requests in the backlog
190     // and this will wait for that backlog before running its GC and returning.
191     JS_EXPORT_PRIVATE void collectSync(GCRequest = GCRequest());
192     
193     JS_EXPORT_PRIVATE void collect(Synchronousness, GCRequest = GCRequest());
194     
195     // Like collect(), but in the case of Async this will stopIfNecessary() and in the case of
196     // Sync this will sweep synchronously.
197     JS_EXPORT_PRIVATE void collectNow(Synchronousness, GCRequest = GCRequest());
198     
199     JS_EXPORT_PRIVATE void collectNowFullIfNotDoneRecently(Synchronousness);
200     
201     void collectIfNecessaryOrDefer(GCDeferralContext* = nullptr);
202
203     void completeAllJITPlans();
204     
205     // Use this API to report non-GC memory referenced by GC objects. Be sure to
206     // call both of these functions: Calling only one may trigger catastropic
207     // memory growth.
208     void reportExtraMemoryAllocated(size_t);
209     JS_EXPORT_PRIVATE void reportExtraMemoryVisited(size_t);
210
211 #if ENABLE(RESOURCE_USAGE)
212     // Use this API to report the subset of extra memory that lives outside this process.
213     JS_EXPORT_PRIVATE void reportExternalMemoryVisited(size_t);
214     size_t externalMemorySize() { return m_externalMemorySize; }
215 #endif
216
217     // Use this API to report non-GC memory if you can't use the better API above.
218     void deprecatedReportExtraMemory(size_t);
219
220     JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
221
222     JS_EXPORT_PRIVATE void protect(JSValue);
223     JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
224     
225     JS_EXPORT_PRIVATE size_t extraMemorySize(); // Non-GC memory referenced by GC objects.
226     JS_EXPORT_PRIVATE size_t size();
227     JS_EXPORT_PRIVATE size_t capacity();
228     JS_EXPORT_PRIVATE size_t objectCount();
229     JS_EXPORT_PRIVATE size_t globalObjectCount();
230     JS_EXPORT_PRIVATE size_t protectedObjectCount();
231     JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
232     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> protectedObjectTypeCounts();
233     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> objectTypeCounts();
234
235     HashSet<MarkedArgumentBuffer*>& markListSet();
236     
237     template<typename Functor> void forEachProtectedCell(const Functor&);
238     template<typename Functor> void forEachCodeBlock(const Functor&);
239     template<typename Functor> void forEachCodeBlockIgnoringJITPlans(const AbstractLocker& codeBlockSetLocker, const Functor&);
240
241     HandleSet* handleSet() { return &m_handleSet; }
242
243     void willStartIterating();
244     void didFinishIterating();
245
246     Seconds lastFullGCLength() const { return m_lastFullGCLength; }
247     Seconds lastEdenGCLength() const { return m_lastEdenGCLength; }
248     void increaseLastFullGCLength(Seconds amount) { m_lastFullGCLength += amount; }
249
250     size_t sizeBeforeLastEdenCollection() const { return m_sizeBeforeLastEdenCollect; }
251     size_t sizeAfterLastEdenCollection() const { return m_sizeAfterLastEdenCollect; }
252     size_t sizeBeforeLastFullCollection() const { return m_sizeBeforeLastFullCollect; }
253     size_t sizeAfterLastFullCollection() const { return m_sizeAfterLastFullCollect; }
254
255     void deleteAllCodeBlocks(DeleteAllCodeEffort);
256     void deleteAllUnlinkedCodeBlocks(DeleteAllCodeEffort);
257
258     void didAllocate(size_t);
259     bool isPagedOut(double deadline);
260     
261     const JITStubRoutineSet& jitStubRoutines() { return *m_jitStubRoutines; }
262     
263     void addReference(JSCell*, ArrayBuffer*);
264     
265     bool isDeferred() const { return !!m_deferralDepth; }
266
267     StructureIDTable& structureIDTable() { return m_structureIDTable; }
268
269     CodeBlockSet& codeBlockSet() { return *m_codeBlocks; }
270
271 #if USE(FOUNDATION)
272     template<typename T> void releaseSoon(RetainPtr<T>&&);
273 #endif
274
275     JS_EXPORT_PRIVATE void registerWeakGCMap(WeakGCMapBase* weakGCMap);
276     JS_EXPORT_PRIVATE void unregisterWeakGCMap(WeakGCMapBase* weakGCMap);
277
278     void addLogicallyEmptyWeakBlock(WeakBlock*);
279
280 #if ENABLE(RESOURCE_USAGE)
281     size_t blockBytesAllocated() const { return m_blockBytesAllocated; }
282 #endif
283
284     void didAllocateBlock(size_t capacity);
285     void didFreeBlock(size_t capacity);
286     
287     bool mutatorShouldBeFenced() const { return m_mutatorShouldBeFenced; }
288     const bool* addressOfMutatorShouldBeFenced() const { return &m_mutatorShouldBeFenced; }
289     
290     unsigned barrierThreshold() const { return m_barrierThreshold; }
291     const unsigned* addressOfBarrierThreshold() const { return &m_barrierThreshold; }
292
293     // If true, the GC believes that the mutator is currently messing with the heap. We call this
294     // "having heap access". The GC may block if the mutator is in this state. If false, the GC may
295     // currently be doing things to the heap that make the heap unsafe to access for the mutator.
296     bool hasAccess() const;
297     
298     // If the mutator does not currently have heap access, this function will acquire it. If the GC
299     // is currently using the lack of heap access to do dangerous things to the heap then this
300     // function will block, waiting for the GC to finish. It's not valid to call this if the mutator
301     // already has heap access. The mutator is required to precisely track whether or not it has
302     // heap access.
303     //
304     // It's totally fine to acquireAccess() upon VM instantiation and keep it that way. This is how
305     // WebCore uses us. For most other clients, JSLock does acquireAccess()/releaseAccess() for you.
306     void acquireAccess();
307     
308     // Releases heap access. If the GC is blocking waiting to do bad things to the heap, it will be
309     // allowed to run now.
310     //
311     // Ordinarily, you should use the ReleaseHeapAccessScope to release and then reacquire heap
312     // access. You should do this anytime you're about do perform a blocking operation, like waiting
313     // on the ParkingLot.
314     void releaseAccess();
315     
316     // This is like a super optimized way of saying:
317     //
318     //     releaseAccess()
319     //     acquireAccess()
320     //
321     // The fast path is an inlined relaxed load and branch. The slow path will block the mutator if
322     // the GC wants to do bad things to the heap.
323     //
324     // All allocations logically call this. As an optimization to improve GC progress, you can call
325     // this anywhere that you can afford a load-branch and where an object allocation would have been
326     // safe.
327     //
328     // The GC will also push a stopIfNecessary() event onto the runloop of the thread that
329     // instantiated the VM whenever it wants the mutator to stop. This means that if you never block
330     // but instead use the runloop to wait for events, then you could safely run in a mode where the
331     // mutator has permanent heap access (like the DOM does). If you have good event handling
332     // discipline (i.e. you don't block the runloop) then you can be sure that stopIfNecessary() will
333     // already be called for you at the right times.
334     void stopIfNecessary();
335     
336     // This gives the conn to the collector.
337     void relinquishConn();
338     
339     bool mayNeedToStop();
340
341     void performIncrement(size_t bytes);
342     
343     // This is a much stronger kind of stopping of the collector, and it may require waiting for a
344     // while. This is meant to be a legacy API for clients of collectAllGarbage that expect that there
345     // is no GC before or after that function call. After calling this, you are free to start GCs
346     // yourself but you can be sure that none are running.
347     //
348     // This both prevents new collections from being started asynchronously and waits for any
349     // outstanding collections to complete.
350     void preventCollection();
351     void allowCollection();
352     
353     uint64_t mutatorExecutionVersion() const { return m_mutatorExecutionVersion; }
354     uint64_t phaseVersion() const { return m_phaseVersion; }
355     
356     JS_EXPORT_PRIVATE void addMarkingConstraint(std::unique_ptr<MarkingConstraint>);
357     
358     size_t numOpaqueRoots() const { return m_opaqueRoots.size(); }
359
360     HeapVerifier* verifier() const { return m_verifier.get(); }
361     
362     void addHeapFinalizerCallback(const HeapFinalizerCallback&);
363     void removeHeapFinalizerCallback(const HeapFinalizerCallback&);
364     
365     void runTaskInParallel(RefPtr<SharedTask<void(SlotVisitor&)>>);
366     
367     template<typename Func>
368     void runFunctionInParallel(const Func& func)
369     {
370         runTaskInParallel(createSharedTask<void(SlotVisitor&)>(func));
371     }
372
373     template<typename Func>
374     void forEachSlotVisitor(const Func&);
375     unsigned numberOfSlotVisitors();
376
377 private:
378     friend class AllocatingScope;
379     friend class CodeBlock;
380     friend class CollectingScope;
381     friend class DeferGC;
382     friend class DeferGCForAWhile;
383     friend class GCAwareJITStubRoutine;
384     friend class GCLogging;
385     friend class GCThread;
386     friend class HandleSet;
387     friend class HeapUtil;
388     friend class HeapVerifier;
389     friend class JITStubRoutine;
390     friend class LLIntOffsetsExtractor;
391     friend class MarkStackMergingConstraint;
392     friend class MarkedSpace;
393     friend class MarkedAllocator;
394     friend class MarkedBlock;
395     friend class RunningScope;
396     friend class SlotVisitor;
397     friend class SpaceTimeMutatorScheduler;
398     friend class StochasticSpaceTimeMutatorScheduler;
399     friend class SweepingScope;
400     friend class IncrementalSweeper;
401     friend class HeapStatistics;
402     friend class VM;
403     friend class WeakSet;
404
405     class Thread;
406     friend class Thread;
407
408     static const size_t minExtraMemory = 256;
409     
410     class FinalizerOwner : public WeakHandleOwner {
411         void finalize(Handle<Unknown>, void* context) override;
412     };
413
414     JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
415     JS_EXPORT_PRIVATE void reportExtraMemoryAllocatedSlowCase(size_t);
416     JS_EXPORT_PRIVATE void deprecatedReportExtraMemorySlowCase(size_t);
417     
418     bool shouldCollectInCollectorThread(const AbstractLocker&);
419     void collectInCollectorThread();
420     
421     void checkConn(GCConductor);
422
423     enum class RunCurrentPhaseResult {
424         Finished,
425         Continue,
426         NeedCurrentThreadState
427     };
428     RunCurrentPhaseResult runCurrentPhase(GCConductor, CurrentThreadState*);
429     
430     // Returns true if we should keep doing things.
431     bool runNotRunningPhase(GCConductor);
432     bool runBeginPhase(GCConductor);
433     bool runFixpointPhase(GCConductor);
434     bool runConcurrentPhase(GCConductor);
435     bool runReloopPhase(GCConductor);
436     bool runEndPhase(GCConductor);
437     bool changePhase(GCConductor, CollectorPhase);
438     bool finishChangingPhase(GCConductor);
439     
440     void collectInMutatorThread();
441     
442     void stopThePeriphery(GCConductor);
443     void resumeThePeriphery();
444     
445     // Returns true if the mutator is stopped, false if the mutator has the conn now.
446     bool stopTheMutator();
447     void resumeTheMutator();
448     
449     JS_EXPORT_PRIVATE void stopIfNecessarySlow();
450     bool stopIfNecessarySlow(unsigned extraStateBits);
451     
452     template<typename Func>
453     void waitForCollector(const Func&);
454     
455     JS_EXPORT_PRIVATE void acquireAccessSlow();
456     JS_EXPORT_PRIVATE void releaseAccessSlow();
457     
458     bool handleGCDidJIT(unsigned);
459     void handleGCDidJIT();
460     
461     bool handleNeedFinalize(unsigned);
462     void handleNeedFinalize();
463     
464     bool relinquishConn(unsigned);
465     void finishRelinquishingConn();
466     
467     void setGCDidJIT();
468     void setNeedFinalize();
469     void waitWhileNeedFinalize();
470     
471     void setMutatorWaiting();
472     void clearMutatorWaiting();
473     void notifyThreadStopping(const AbstractLocker&);
474     
475     typedef uint64_t Ticket;
476     Ticket requestCollection(GCRequest);
477     void waitForCollection(Ticket);
478     
479     void suspendCompilerThreads();
480     void willStartCollection();
481     void prepareForMarking();
482     
483     void gatherStackRoots(ConservativeRoots&);
484     void gatherJSStackRoots(ConservativeRoots&);
485     void gatherScratchBufferRoots(ConservativeRoots&);
486     void beginMarking();
487     void visitCompilerWorklistWeakReferences();
488     void removeDeadCompilerWorklistEntries();
489     void updateObjectCounts();
490     void endMarking();
491
492     void reapWeakHandles();
493     void pruneStaleEntriesFromWeakGCMaps();
494     void sweepArrayBuffers();
495     void snapshotUnswept();
496     void deleteSourceProviderCaches();
497     void notifyIncrementalSweeper();
498     void harvestWeakReferences();
499
500     template<typename CellType, typename CellSet>
501     void finalizeMarkedUnconditionalFinalizers(CellSet&);
502
503     void finalizeUnconditionalFinalizers();
504     
505     void clearUnmarkedExecutables();
506     void deleteUnmarkedCompiledCode();
507     JS_EXPORT_PRIVATE void addToRememberedSet(const JSCell*);
508     void updateAllocationLimits();
509     void didFinishCollection();
510     void resumeCompilerThreads();
511     void gatherExtraHeapSnapshotData(HeapProfiler&);
512     void removeDeadHeapSnapshotNodes(HeapProfiler&);
513     void finalize();
514     void sweepInFinalize();
515     
516     void sweepAllLogicallyEmptyWeakBlocks();
517     bool sweepNextLogicallyEmptyWeakBlock();
518
519     bool shouldDoFullCollection();
520
521     void incrementDeferralDepth();
522     void decrementDeferralDepth();
523     void decrementDeferralDepthAndGCIfNeeded();
524     JS_EXPORT_PRIVATE void decrementDeferralDepthAndGCIfNeededSlow();
525
526     size_t visitCount();
527     size_t bytesVisited();
528     
529     void forEachCodeBlockImpl(const ScopedLambda<void(CodeBlock*)>&);
530     void forEachCodeBlockIgnoringJITPlansImpl(const AbstractLocker& codeBlockSetLocker, const ScopedLambda<void(CodeBlock*)>&);
531     
532     void setMutatorShouldBeFenced(bool value);
533     
534     void addCoreConstraints();
535
536     enum class MemoryThresholdCallType {
537         Cached,
538         Direct
539     };
540
541     bool overCriticalMemoryThreshold(MemoryThresholdCallType memoryThresholdCallType = MemoryThresholdCallType::Cached);
542     
543     template<typename Func>
544     void iterateExecutingAndCompilingCodeBlocks(const Func&);
545     
546     template<typename Func>
547     void iterateExecutingAndCompilingCodeBlocksWithoutHoldingLocks(const Func&);
548     
549     void assertMarkStacksEmpty();
550
551     void setBonusVisitorTask(RefPtr<SharedTask<void(SlotVisitor&)>>);
552     
553     const HeapType m_heapType;
554     const size_t m_ramSize;
555     const size_t m_minBytesPerCycle;
556     size_t m_sizeAfterLastCollect;
557     size_t m_sizeAfterLastFullCollect;
558     size_t m_sizeBeforeLastFullCollect;
559     size_t m_sizeAfterLastEdenCollect;
560     size_t m_sizeBeforeLastEdenCollect;
561
562     size_t m_bytesAllocatedThisCycle;
563     size_t m_bytesAbandonedSinceLastFullCollect;
564     size_t m_maxEdenSize;
565     size_t m_maxEdenSizeWhenCritical;
566     size_t m_maxHeapSize;
567     bool m_shouldDoFullCollection;
568     size_t m_totalBytesVisited;
569     size_t m_totalBytesVisitedThisCycle;
570     double m_incrementBalance { 0 };
571     
572     std::optional<CollectionScope> m_collectionScope;
573     std::optional<CollectionScope> m_lastCollectionScope;
574     MutatorState m_mutatorState { MutatorState::Running };
575     StructureIDTable m_structureIDTable;
576     MarkedSpace m_objectSpace;
577     GCIncomingRefCountedSet<ArrayBuffer> m_arrayBuffers;
578     size_t m_extraMemorySize;
579     size_t m_deprecatedExtraMemorySize;
580
581     HashSet<const JSCell*> m_copyingRememberedSet;
582
583     ProtectCountSet m_protectedValues;
584     std::unique_ptr<HashSet<MarkedArgumentBuffer*>> m_markListSet;
585
586     std::unique_ptr<MachineThreads> m_machineThreads;
587     
588     std::unique_ptr<SlotVisitor> m_collectorSlotVisitor;
589     std::unique_ptr<SlotVisitor> m_mutatorSlotVisitor;
590     std::unique_ptr<MarkStackArray> m_mutatorMarkStack;
591
592     Lock m_raceMarkStackLock;
593     std::unique_ptr<MarkStackArray> m_raceMarkStack;
594
595     std::unique_ptr<MarkingConstraintSet> m_constraintSet;
596
597     // We pool the slot visitors used by parallel marking threads. It's useful to be able to
598     // enumerate over them, and it's useful to have them cache some small amount of memory from
599     // one GC to the next. GC marking threads claim these at the start of marking, and return
600     // them at the end.
601     Vector<std::unique_ptr<SlotVisitor>> m_parallelSlotVisitors;
602     Vector<SlotVisitor*> m_availableParallelSlotVisitors;
603     Lock m_parallelSlotVisitorLock;
604     
605     HandleSet m_handleSet;
606     std::unique_ptr<CodeBlockSet> m_codeBlocks;
607     std::unique_ptr<JITStubRoutineSet> m_jitStubRoutines;
608     FinalizerOwner m_finalizerOwner;
609     
610     bool m_isSafeToCollect;
611     bool m_isShuttingDown { false };
612
613     bool m_mutatorShouldBeFenced { Options::forceFencedBarrier() };
614     unsigned m_barrierThreshold { Options::forceFencedBarrier() ? tautologicalThreshold : blackThreshold };
615
616     VM* m_vm;
617     Seconds m_lastFullGCLength;
618     Seconds m_lastEdenGCLength;
619
620     Vector<ExecutableBase*> m_executables;
621
622     Vector<WeakBlock*> m_logicallyEmptyWeakBlocks;
623     size_t m_indexOfNextLogicallyEmptyWeakBlockToSweep { WTF::notFound };
624     
625     RefPtr<FullGCActivityCallback> m_fullActivityCallback;
626     RefPtr<GCActivityCallback> m_edenActivityCallback;
627     RefPtr<IncrementalSweeper> m_sweeper;
628     RefPtr<StopIfNecessaryTimer> m_stopIfNecessaryTimer;
629
630     Vector<HeapObserver*> m_observers;
631     
632     Vector<HeapFinalizerCallback> m_heapFinalizerCallbacks;
633     
634     unsigned m_deferralDepth;
635     bool m_didDeferGCWork { false };
636
637     std::unique_ptr<HeapVerifier> m_verifier;
638
639 #if USE(FOUNDATION)
640     Vector<RetainPtr<CFTypeRef>> m_delayedReleaseObjects;
641     unsigned m_delayedReleaseRecursionCount;
642 #endif
643
644     HashSet<WeakGCMapBase*> m_weakGCMaps;
645     
646     Lock m_visitRaceLock;
647
648     Lock m_markingMutex;
649     Condition m_markingConditionVariable;
650     std::unique_ptr<MarkStackArray> m_sharedCollectorMarkStack;
651     std::unique_ptr<MarkStackArray> m_sharedMutatorMarkStack;
652     unsigned m_numberOfActiveParallelMarkers { 0 };
653     unsigned m_numberOfWaitingParallelMarkers { 0 };
654     bool m_parallelMarkersShouldExit { false };
655
656     ConcurrentPtrHashSet m_opaqueRoots;
657
658     static const size_t s_blockFragmentLength = 32;
659
660     ListableHandler<WeakReferenceHarvester>::List m_weakReferenceHarvesters;
661     ListableHandler<UnconditionalFinalizer>::List m_unconditionalFinalizers;
662
663     ParallelHelperClient m_helperClient;
664     RefPtr<SharedTask<void(SlotVisitor&)>> m_bonusVisitorTask;
665
666 #if ENABLE(RESOURCE_USAGE)
667     size_t m_blockBytesAllocated { 0 };
668     size_t m_externalMemorySize { 0 };
669 #endif
670     
671     std::unique_ptr<MutatorScheduler> m_scheduler;
672     
673     static const unsigned mutatorHasConnBit = 1u << 0u; // Must also be protected by threadLock.
674     static const unsigned stoppedBit = 1u << 1u; // Only set when !hasAccessBit
675     static const unsigned hasAccessBit = 1u << 2u;
676     static const unsigned gcDidJITBit = 1u << 3u; // Set when the GC did some JITing, so on resume we need to cpuid.
677     static const unsigned needFinalizeBit = 1u << 4u;
678     static const unsigned mutatorWaitingBit = 1u << 5u; // Allows the mutator to use this as a condition variable.
679     Atomic<unsigned> m_worldState;
680     bool m_worldIsStopped { false };
681     MonotonicTime m_beforeGC;
682     MonotonicTime m_afterGC;
683     MonotonicTime m_stopTime;
684     
685     Deque<GCRequest> m_requests;
686     GCRequest m_currentRequest;
687     Ticket m_lastServedTicket { 0 };
688     Ticket m_lastGrantedTicket { 0 };
689     CollectorPhase m_currentPhase { CollectorPhase::NotRunning };
690     CollectorPhase m_nextPhase { CollectorPhase::NotRunning };
691     bool m_threadShouldStop { false };
692     bool m_threadIsStopping { false };
693     bool m_mutatorDidRun { true };
694     uint64_t m_mutatorExecutionVersion { 0 };
695     uint64_t m_phaseVersion { 0 };
696     Box<Lock> m_threadLock;
697     RefPtr<AutomaticThreadCondition> m_threadCondition; // The mutator must not wait on this. It would cause a deadlock.
698     RefPtr<AutomaticThread> m_thread;
699
700 #if PLATFORM(IOS)
701     unsigned m_precentAvailableMemoryCachedCallCount;
702     bool m_overCriticalMemoryThreshold;
703 #endif
704
705     Lock m_collectContinuouslyLock;
706     Condition m_collectContinuouslyCondition;
707     bool m_shouldStopCollectingContinuously { false };
708     RefPtr<WTF::Thread> m_collectContinuouslyThread { nullptr };
709     
710     MonotonicTime m_lastGCStartTime;
711     MonotonicTime m_lastGCEndTime;
712     MonotonicTime m_currentGCStartTime;
713     
714     uintptr_t m_barriersExecuted { 0 };
715     
716     CurrentThreadState* m_currentThreadState { nullptr };
717     WTF::Thread* m_currentThread { nullptr }; // It's OK if this becomes a dangling pointer.
718 };
719
720 } // namespace JSC