GC constraint solving should be parallel
[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 "HandleStack.h"
34 #include "HeapFinalizerCallback.h"
35 #include "HeapObserver.h"
36 #include "ListableHandler.h"
37 #include "MarkedBlock.h"
38 #include "MarkedSpace.h"
39 #include "MutatorState.h"
40 #include "Options.h"
41 #include "StructureIDTable.h"
42 #include "Synchronousness.h"
43 #include "UnconditionalFinalizer.h"
44 #include "WeakHandleOwner.h"
45 #include "WeakReferenceHarvester.h"
46 #include <wtf/AutomaticThread.h>
47 #include <wtf/ConcurrentPtrHashSet.h>
48 #include <wtf/Deque.h>
49 #include <wtf/HashCountedSet.h>
50 #include <wtf/HashSet.h>
51 #include <wtf/ParallelHelperPool.h>
52 #include <wtf/Threading.h>
53
54 namespace JSC {
55
56 class CodeBlock;
57 class CodeBlockSet;
58 class CollectingScope;
59 class ConservativeRoots;
60 class GCDeferralContext;
61 class EdenGCActivityCallback;
62 class ExecutableBase;
63 class FullGCActivityCallback;
64 class GCActivityCallback;
65 class GCAwareJITStubRoutine;
66 class Heap;
67 class HeapProfiler;
68 class HeapVerifier;
69 class IncrementalSweeper;
70 class JITStubRoutine;
71 class JITStubRoutineSet;
72 class JSCell;
73 class JSValue;
74 class LLIntOffsetsExtractor;
75 class MachineThreads;
76 class MarkStackArray;
77 class MarkStackMergingConstraint;
78 class MarkedAllocator;
79 class MarkedArgumentBuffer;
80 class MarkingConstraint;
81 class MarkingConstraintSet;
82 class MutatorScheduler;
83 class RunningScope;
84 class SlotVisitor;
85 class SpaceTimeMutatorScheduler;
86 class StopIfNecessaryTimer;
87 class SweepingScope;
88 class VM;
89 class WeakGCMapBase;
90 struct CurrentThreadState;
91
92 namespace DFG {
93 class SpeculativeJIT;
94 class Worklist;
95 }
96
97 typedef HashCountedSet<JSCell*> ProtectCountSet;
98 typedef HashCountedSet<const char*> TypeCountSet;
99
100 enum HeapType { SmallHeap, LargeHeap };
101
102 class HeapUtil;
103
104 class Heap {
105     WTF_MAKE_NONCOPYABLE(Heap);
106 public:
107     friend class JIT;
108     friend class DFG::SpeculativeJIT;
109     static Heap* heap(const JSValue); // 0 for immediate values
110     static Heap* heap(const HeapCell*);
111
112     // This constant determines how many blocks we iterate between checks of our 
113     // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
114     // overstepping our deadline more quickly, while increasing it will cause 
115     // our scan to run faster. 
116     static const unsigned s_timeCheckResolution = 16;
117
118     static bool isMarked(const void*);
119     static bool testAndSetMarked(HeapVersion, const void*);
120     
121     static size_t cellSize(const void*);
122
123     void writeBarrier(const JSCell* from);
124     void writeBarrier(const JSCell* from, JSValue to);
125     void writeBarrier(const JSCell* from, JSCell* to);
126     
127     void writeBarrierWithoutFence(const JSCell* from);
128     
129     void mutatorFence();
130     
131     // Take this if you know that from->cellState() < barrierThreshold.
132     JS_EXPORT_PRIVATE void writeBarrierSlowPath(const JSCell* from);
133
134     Heap(VM*, HeapType);
135     ~Heap();
136     void lastChanceToFinalize();
137     void releaseDelayedReleasedObjects();
138
139     VM* vm() const;
140
141     MarkedSpace& objectSpace() { return m_objectSpace; }
142     MachineThreads& machineThreads() { return *m_machineThreads; }
143
144     SlotVisitor& collectorSlotVisitor() { return *m_collectorSlotVisitor; }
145
146     JS_EXPORT_PRIVATE GCActivityCallback* fullActivityCallback();
147     JS_EXPORT_PRIVATE GCActivityCallback* edenActivityCallback();
148     JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
149
150     JS_EXPORT_PRIVATE IncrementalSweeper& sweeper();
151
152     void addObserver(HeapObserver* observer) { m_observers.append(observer); }
153     void removeObserver(HeapObserver* observer) { m_observers.removeFirst(observer); }
154
155     MutatorState mutatorState() const { return m_mutatorState; }
156     std::optional<CollectionScope> collectionScope() const { return m_collectionScope; }
157     bool hasHeapAccess() const;
158     bool worldIsStopped() const;
159     bool worldIsRunning() const { return !worldIsStopped(); }
160
161     // We're always busy on the collection threads. On the main thread, this returns true if we're
162     // helping heap.
163     JS_EXPORT_PRIVATE bool isCurrentThreadBusy();
164     
165     typedef void (*Finalizer)(JSCell*);
166     JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
167     void addExecutable(ExecutableBase*);
168
169     void notifyIsSafeToCollect();
170     bool isSafeToCollect() const { return m_isSafeToCollect; }
171
172     JS_EXPORT_PRIVATE bool isHeapSnapshotting() const;
173
174     JS_EXPORT_PRIVATE void sweepSynchronously();
175
176     bool shouldCollectHeuristic();
177     
178     // Queue up a collection. Returns immediately. This will not queue a collection if a collection
179     // of equal or greater strength exists. Full collections are stronger than std::nullopt collections
180     // and std::nullopt collections are stronger than Eden collections. std::nullopt means that the GC can
181     // choose Eden or Full. This implies that if you request a GC while that GC is ongoing, nothing
182     // will happen.
183     JS_EXPORT_PRIVATE void collectAsync(GCRequest = GCRequest());
184     
185     // Queue up a collection and wait for it to complete. This won't return until you get your own
186     // complete collection. For example, if there was an ongoing asynchronous collection at the time
187     // you called this, then this would wait for that one to complete and then trigger your
188     // collection and then return. In weird cases, there could be multiple GC requests in the backlog
189     // and this will wait for that backlog before running its GC and returning.
190     JS_EXPORT_PRIVATE void collectSync(GCRequest = GCRequest());
191     
192     JS_EXPORT_PRIVATE void collect(Synchronousness, GCRequest = GCRequest());
193     
194     // Like collect(), but in the case of Async this will stopIfNecessary() and in the case of
195     // Sync this will sweep synchronously.
196     JS_EXPORT_PRIVATE void collectNow(Synchronousness, GCRequest = GCRequest());
197     
198     JS_EXPORT_PRIVATE void collectNowFullIfNotDoneRecently(Synchronousness);
199     
200     void collectIfNecessaryOrDefer(GCDeferralContext* = nullptr);
201
202     void completeAllJITPlans();
203     
204     // Use this API to report non-GC memory referenced by GC objects. Be sure to
205     // call both of these functions: Calling only one may trigger catastropic
206     // memory growth.
207     void reportExtraMemoryAllocated(size_t);
208     JS_EXPORT_PRIVATE void reportExtraMemoryVisited(size_t);
209
210 #if ENABLE(RESOURCE_USAGE)
211     // Use this API to report the subset of extra memory that lives outside this process.
212     JS_EXPORT_PRIVATE void reportExternalMemoryVisited(size_t);
213     size_t externalMemorySize() { return m_externalMemorySize; }
214 #endif
215
216     // Use this API to report non-GC memory if you can't use the better API above.
217     void deprecatedReportExtraMemory(size_t);
218
219     JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
220
221     JS_EXPORT_PRIVATE void protect(JSValue);
222     JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
223     
224     JS_EXPORT_PRIVATE size_t extraMemorySize(); // Non-GC memory referenced by GC objects.
225     JS_EXPORT_PRIVATE size_t size();
226     JS_EXPORT_PRIVATE size_t capacity();
227     JS_EXPORT_PRIVATE size_t objectCount();
228     JS_EXPORT_PRIVATE size_t globalObjectCount();
229     JS_EXPORT_PRIVATE size_t protectedObjectCount();
230     JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
231     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> protectedObjectTypeCounts();
232     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> objectTypeCounts();
233
234     HashSet<MarkedArgumentBuffer*>& markListSet();
235     
236     template<typename Functor> void forEachProtectedCell(const Functor&);
237     template<typename Functor> void forEachCodeBlock(const Functor&);
238     template<typename Functor> void forEachCodeBlockIgnoringJITPlans(const AbstractLocker& codeBlockSetLocker, const Functor&);
239
240     HandleSet* handleSet() { return &m_handleSet; }
241     HandleStack* handleStack() { return &m_handleStack; }
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
376 private:
377     friend class AllocatingScope;
378     friend class CodeBlock;
379     friend class CollectingScope;
380     friend class DeferGC;
381     friend class DeferGCForAWhile;
382     friend class GCAwareJITStubRoutine;
383     friend class GCLogging;
384     friend class GCThread;
385     friend class HandleSet;
386     friend class HeapUtil;
387     friend class HeapVerifier;
388     friend class JITStubRoutine;
389     friend class LLIntOffsetsExtractor;
390     friend class MarkStackMergingConstraint;
391     friend class MarkedSpace;
392     friend class MarkedAllocator;
393     friend class MarkedBlock;
394     friend class RunningScope;
395     friend class SlotVisitor;
396     friend class SpaceTimeMutatorScheduler;
397     friend class StochasticSpaceTimeMutatorScheduler;
398     friend class SweepingScope;
399     friend class IncrementalSweeper;
400     friend class HeapStatistics;
401     friend class VM;
402     friend class WeakSet;
403
404     class Thread;
405     friend class Thread;
406
407     static const size_t minExtraMemory = 256;
408     
409     class FinalizerOwner : public WeakHandleOwner {
410         void finalize(Handle<Unknown>, void* context) override;
411     };
412
413     JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
414     JS_EXPORT_PRIVATE void reportExtraMemoryAllocatedSlowCase(size_t);
415     JS_EXPORT_PRIVATE void deprecatedReportExtraMemorySlowCase(size_t);
416     
417     bool shouldCollectInCollectorThread(const AbstractLocker&);
418     void collectInCollectorThread();
419     
420     void checkConn(GCConductor);
421
422     enum class RunCurrentPhaseResult {
423         Finished,
424         Continue,
425         NeedCurrentThreadState
426     };
427     RunCurrentPhaseResult runCurrentPhase(GCConductor, CurrentThreadState*);
428     
429     // Returns true if we should keep doing things.
430     bool runNotRunningPhase(GCConductor);
431     bool runBeginPhase(GCConductor);
432     bool runFixpointPhase(GCConductor);
433     bool runConcurrentPhase(GCConductor);
434     bool runReloopPhase(GCConductor);
435     bool runEndPhase(GCConductor);
436     bool changePhase(GCConductor, CollectorPhase);
437     bool finishChangingPhase(GCConductor);
438     
439     void collectInMutatorThread();
440     
441     void stopThePeriphery(GCConductor);
442     void resumeThePeriphery();
443     
444     // Returns true if the mutator is stopped, false if the mutator has the conn now.
445     bool stopTheMutator();
446     void resumeTheMutator();
447     
448     JS_EXPORT_PRIVATE void stopIfNecessarySlow();
449     bool stopIfNecessarySlow(unsigned extraStateBits);
450     
451     template<typename Func>
452     void waitForCollector(const Func&);
453     
454     JS_EXPORT_PRIVATE void acquireAccessSlow();
455     JS_EXPORT_PRIVATE void releaseAccessSlow();
456     
457     bool handleGCDidJIT(unsigned);
458     void handleGCDidJIT();
459     
460     bool handleNeedFinalize(unsigned);
461     void handleNeedFinalize();
462     
463     bool relinquishConn(unsigned);
464     void finishRelinquishingConn();
465     
466     void setGCDidJIT();
467     void setNeedFinalize();
468     void waitWhileNeedFinalize();
469     
470     void setMutatorWaiting();
471     void clearMutatorWaiting();
472     void notifyThreadStopping(const AbstractLocker&);
473     
474     typedef uint64_t Ticket;
475     Ticket requestCollection(GCRequest);
476     void waitForCollection(Ticket);
477     
478     void suspendCompilerThreads();
479     void willStartCollection();
480     void prepareForMarking();
481     
482     void gatherStackRoots(ConservativeRoots&);
483     void gatherJSStackRoots(ConservativeRoots&);
484     void gatherScratchBufferRoots(ConservativeRoots&);
485     void beginMarking();
486     void visitCompilerWorklistWeakReferences();
487     void removeDeadCompilerWorklistEntries();
488     void updateObjectCounts();
489     void endMarking();
490
491     void reapWeakHandles();
492     void pruneStaleEntriesFromWeakGCMaps();
493     void sweepArrayBuffers();
494     void snapshotUnswept();
495     void deleteSourceProviderCaches();
496     void notifyIncrementalSweeper();
497     void harvestWeakReferences();
498     void finalizeUnconditionalFinalizers();
499     void clearUnmarkedExecutables();
500     void deleteUnmarkedCompiledCode();
501     JS_EXPORT_PRIVATE void addToRememberedSet(const JSCell*);
502     void updateAllocationLimits();
503     void didFinishCollection();
504     void resumeCompilerThreads();
505     void gatherExtraHeapSnapshotData(HeapProfiler&);
506     void removeDeadHeapSnapshotNodes(HeapProfiler&);
507     void finalize();
508     void sweepInFinalize();
509     
510     void sweepAllLogicallyEmptyWeakBlocks();
511     bool sweepNextLogicallyEmptyWeakBlock();
512
513     bool shouldDoFullCollection();
514
515     void incrementDeferralDepth();
516     void decrementDeferralDepth();
517     void decrementDeferralDepthAndGCIfNeeded();
518     JS_EXPORT_PRIVATE void decrementDeferralDepthAndGCIfNeededSlow();
519
520     size_t visitCount();
521     size_t bytesVisited();
522     
523     void forEachCodeBlockImpl(const ScopedLambda<bool(CodeBlock*)>&);
524     void forEachCodeBlockIgnoringJITPlansImpl(const AbstractLocker& codeBlockSetLocker, const ScopedLambda<bool(CodeBlock*)>&);
525     
526     void setMutatorShouldBeFenced(bool value);
527     
528     void addCoreConstraints();
529
530     enum class MemoryThresholdCallType {
531         Cached,
532         Direct
533     };
534
535     bool overCriticalMemoryThreshold(MemoryThresholdCallType memoryThresholdCallType = MemoryThresholdCallType::Cached);
536     
537     template<typename Func>
538     void iterateExecutingAndCompilingCodeBlocks(const Func&);
539     
540     template<typename Func>
541     void iterateExecutingAndCompilingCodeBlocksWithoutHoldingLocks(const Func&);
542     
543     void assertMarkStacksEmpty();
544
545     void setBonusVisitorTask(RefPtr<SharedTask<void(SlotVisitor&)>>);
546     
547     const HeapType m_heapType;
548     const size_t m_ramSize;
549     const size_t m_minBytesPerCycle;
550     size_t m_sizeAfterLastCollect;
551     size_t m_sizeAfterLastFullCollect;
552     size_t m_sizeBeforeLastFullCollect;
553     size_t m_sizeAfterLastEdenCollect;
554     size_t m_sizeBeforeLastEdenCollect;
555
556     size_t m_bytesAllocatedThisCycle;
557     size_t m_bytesAbandonedSinceLastFullCollect;
558     size_t m_maxEdenSize;
559     size_t m_maxEdenSizeWhenCritical;
560     size_t m_maxHeapSize;
561     bool m_shouldDoFullCollection;
562     size_t m_totalBytesVisited;
563     size_t m_totalBytesVisitedThisCycle;
564     double m_incrementBalance { 0 };
565     
566     std::optional<CollectionScope> m_collectionScope;
567     std::optional<CollectionScope> m_lastCollectionScope;
568     MutatorState m_mutatorState { MutatorState::Running };
569     StructureIDTable m_structureIDTable;
570     MarkedSpace m_objectSpace;
571     GCIncomingRefCountedSet<ArrayBuffer> m_arrayBuffers;
572     size_t m_extraMemorySize;
573     size_t m_deprecatedExtraMemorySize;
574
575     HashSet<const JSCell*> m_copyingRememberedSet;
576
577     ProtectCountSet m_protectedValues;
578     std::unique_ptr<HashSet<MarkedArgumentBuffer*>> m_markListSet;
579
580     std::unique_ptr<MachineThreads> m_machineThreads;
581     
582     std::unique_ptr<SlotVisitor> m_collectorSlotVisitor;
583     std::unique_ptr<SlotVisitor> m_mutatorSlotVisitor;
584     std::unique_ptr<MarkStackArray> m_mutatorMarkStack;
585
586     Lock m_raceMarkStackLock;
587     std::unique_ptr<MarkStackArray> m_raceMarkStack;
588
589     std::unique_ptr<MarkingConstraintSet> m_constraintSet;
590
591     // We pool the slot visitors used by parallel marking threads. It's useful to be able to
592     // enumerate over them, and it's useful to have them cache some small amount of memory from
593     // one GC to the next. GC marking threads claim these at the start of marking, and return
594     // them at the end.
595     Vector<std::unique_ptr<SlotVisitor>> m_parallelSlotVisitors;
596     Vector<SlotVisitor*> m_availableParallelSlotVisitors;
597     Lock m_parallelSlotVisitorLock;
598     
599     HandleSet m_handleSet;
600     HandleStack m_handleStack;
601     std::unique_ptr<CodeBlockSet> m_codeBlocks;
602     std::unique_ptr<JITStubRoutineSet> m_jitStubRoutines;
603     FinalizerOwner m_finalizerOwner;
604     
605     bool m_isSafeToCollect;
606
607     bool m_mutatorShouldBeFenced { Options::forceFencedBarrier() };
608     unsigned m_barrierThreshold { Options::forceFencedBarrier() ? tautologicalThreshold : blackThreshold };
609
610     VM* m_vm;
611     Seconds m_lastFullGCLength;
612     Seconds m_lastEdenGCLength;
613
614     Vector<ExecutableBase*> m_executables;
615
616     Vector<WeakBlock*> m_logicallyEmptyWeakBlocks;
617     size_t m_indexOfNextLogicallyEmptyWeakBlockToSweep { WTF::notFound };
618     
619     RefPtr<FullGCActivityCallback> m_fullActivityCallback;
620     RefPtr<GCActivityCallback> m_edenActivityCallback;
621     RefPtr<IncrementalSweeper> m_sweeper;
622     RefPtr<StopIfNecessaryTimer> m_stopIfNecessaryTimer;
623
624     Vector<HeapObserver*> m_observers;
625     
626     Vector<HeapFinalizerCallback> m_heapFinalizerCallbacks;
627     
628     unsigned m_deferralDepth;
629     bool m_didDeferGCWork { false };
630
631     std::unique_ptr<HeapVerifier> m_verifier;
632
633 #if USE(FOUNDATION)
634     Vector<RetainPtr<CFTypeRef>> m_delayedReleaseObjects;
635     unsigned m_delayedReleaseRecursionCount;
636 #endif
637
638     HashSet<WeakGCMapBase*> m_weakGCMaps;
639     
640     Lock m_visitRaceLock;
641
642     Lock m_markingMutex;
643     Condition m_markingConditionVariable;
644     std::unique_ptr<MarkStackArray> m_sharedCollectorMarkStack;
645     std::unique_ptr<MarkStackArray> m_sharedMutatorMarkStack;
646     unsigned m_numberOfActiveParallelMarkers { 0 };
647     unsigned m_numberOfWaitingParallelMarkers { 0 };
648     bool m_parallelMarkersShouldExit { false };
649
650     ConcurrentPtrHashSet m_opaqueRoots;
651
652     static const size_t s_blockFragmentLength = 32;
653
654     ListableHandler<WeakReferenceHarvester>::List m_weakReferenceHarvesters;
655     ListableHandler<UnconditionalFinalizer>::List m_unconditionalFinalizers;
656
657     ParallelHelperClient m_helperClient;
658     RefPtr<SharedTask<void(SlotVisitor&)>> m_bonusVisitorTask;
659
660 #if ENABLE(RESOURCE_USAGE)
661     size_t m_blockBytesAllocated { 0 };
662     size_t m_externalMemorySize { 0 };
663 #endif
664     
665     std::unique_ptr<MutatorScheduler> m_scheduler;
666     
667     static const unsigned mutatorHasConnBit = 1u << 0u; // Must also be protected by threadLock.
668     static const unsigned stoppedBit = 1u << 1u; // Only set when !hasAccessBit
669     static const unsigned hasAccessBit = 1u << 2u;
670     static const unsigned gcDidJITBit = 1u << 3u; // Set when the GC did some JITing, so on resume we need to cpuid.
671     static const unsigned needFinalizeBit = 1u << 4u;
672     static const unsigned mutatorWaitingBit = 1u << 5u; // Allows the mutator to use this as a condition variable.
673     Atomic<unsigned> m_worldState;
674     bool m_worldIsStopped { false };
675     MonotonicTime m_beforeGC;
676     MonotonicTime m_afterGC;
677     MonotonicTime m_stopTime;
678     
679     Deque<GCRequest> m_requests;
680     GCRequest m_currentRequest;
681     Ticket m_lastServedTicket { 0 };
682     Ticket m_lastGrantedTicket { 0 };
683     CollectorPhase m_currentPhase { CollectorPhase::NotRunning };
684     CollectorPhase m_nextPhase { CollectorPhase::NotRunning };
685     bool m_threadShouldStop { false };
686     bool m_threadIsStopping { false };
687     bool m_mutatorDidRun { true };
688     uint64_t m_mutatorExecutionVersion { 0 };
689     uint64_t m_phaseVersion { 0 };
690     Box<Lock> m_threadLock;
691     RefPtr<AutomaticThreadCondition> m_threadCondition; // The mutator must not wait on this. It would cause a deadlock.
692     RefPtr<AutomaticThread> m_thread;
693
694 #if PLATFORM(IOS)
695     unsigned m_precentAvailableMemoryCachedCallCount;
696     bool m_overCriticalMemoryThreshold;
697 #endif
698
699     Lock m_collectContinuouslyLock;
700     Condition m_collectContinuouslyCondition;
701     bool m_shouldStopCollectingContinuously { false };
702     RefPtr<WTF::Thread> m_collectContinuouslyThread { nullptr };
703     
704     MonotonicTime m_lastGCStartTime;
705     MonotonicTime m_lastGCEndTime;
706     MonotonicTime m_currentGCStartTime;
707     
708     uintptr_t m_barriersExecuted { 0 };
709     
710     CurrentThreadState* m_currentThreadState { nullptr };
711     WTF::Thread* m_currentThread { nullptr }; // It's OK if this becomes a dangling pointer.
712 };
713
714 } // namespace JSC