blob: 017db7aad817e33d7e9530468fb8eaf2dbafbbb3 [file] [log] [blame]
* Copyright (C) 1999-2000 Harri Porten (
* Copyright (C) 2001 Peter Kelly (
* Copyright (C) 2003-2018 Apple Inc. All rights reserved.
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#pragma once
#include "BlockDirectory.h"
#include "IterationStatus.h"
#include "LargeAllocation.h"
#include "MarkedBlock.h"
#include "MarkedBlockSet.h"
#include <array>
#include <wtf/Bag.h>
#include <wtf/HashSet.h>
#include <wtf/Noncopyable.h>
#include <wtf/RetainPtr.h>
#include <wtf/SentinelLinkedList.h>
#include <wtf/SinglyLinkedListWithTail.h>
#include <wtf/Vector.h>
namespace JSC {
class CompleteSubspace;
class Heap;
class HeapCell;
class HeapIterationScope;
class IsoSubspace;
class LLIntOffsetsExtractor;
class Subspace;
class WeakSet;
typedef uint32_t HeapVersion;
class MarkedSpace {
// sizeStep is really a synonym for atomSize; it's no accident that they are the same.
static constexpr size_t sizeStep = MarkedBlock::atomSize;
// Sizes up to this amount get a size class for each size step.
static constexpr size_t preciseCutoff = 80;
// The amount of available payload in a block is the block's size minus the footer.
static constexpr size_t blockPayload = MarkedBlock::payloadSize;
// The largest cell we're willing to allocate in a MarkedBlock the "normal way" (i.e. using size
// classes, rather than a large allocation) is half the size of the payload, rounded down. This
// ensures that we only use the size class approach if it means being able to pack two things
// into one block.
static constexpr size_t largeCutoff = (blockPayload / 2) & ~(sizeStep - 1);
// We have an extra size class for size zero.
static constexpr size_t numSizeClasses = largeCutoff / sizeStep + 1;
static constexpr HeapVersion nullVersion = 0; // The version of freshly allocated blocks.
static constexpr HeapVersion initialVersion = 2; // The version that the heap starts out with. Set to make sure that nextVersion(nullVersion) != initialVersion.
static HeapVersion nextVersion(HeapVersion version)
if (version == nullVersion)
version = initialVersion;
return version;
static size_t sizeClassToIndex(size_t size)
return (size + sizeStep - 1) / sizeStep;
static size_t indexToSizeClass(size_t index)
size_t result = index * sizeStep;
ASSERT(sizeClassToIndex(result) == index);
return result;
Heap* heap() const { return m_heap; }
void lastChanceToFinalize(); // Must call stopAllocatingForGood first.
void freeMemory();
static size_t optimalSizeFor(size_t);
void prepareForAllocation();
void visitWeakSets(SlotVisitor&);
void reapWeakSets();
MarkedBlockSet& blocks() { return m_blocks; }
void willStartIterating();
bool isIterating() const { return m_isIterating; }
void didFinishIterating();
void stopAllocating();
void stopAllocatingForGood();
void resumeAllocating(); // If we just stopped allocation but we didn't do a collection, we need to resume allocation.
void prepareForMarking();
void prepareForConservativeScan();
typedef HashSet<MarkedBlock*>::iterator BlockIterator;
template<typename Functor> void forEachLiveCell(HeapIterationScope&, const Functor&);
template<typename Functor> void forEachDeadCell(HeapIterationScope&, const Functor&);
template<typename Functor> void forEachBlock(const Functor&);
template<typename Functor> void forEachSubspace(const Functor&);
void shrink();
void freeBlock(MarkedBlock::Handle*);
void freeOrShrinkBlock(MarkedBlock::Handle*);
void didAddBlock(MarkedBlock::Handle*);
void didConsumeFreeList(MarkedBlock::Handle*);
void didAllocateInBlock(MarkedBlock::Handle*);
void beginMarking();
void endMarking();
void snapshotUnswept();
void clearNewlyAllocated();
void sweep();
void sweepLargeAllocations();
void assertNoUnswept();
size_t objectCount();
size_t size();
size_t capacity();
bool isPagedOut(MonotonicTime deadline);
HeapVersion markingVersion() const { return m_markingVersion; }
HeapVersion newlyAllocatedVersion() const { return m_newlyAllocatedVersion; }
const Vector<LargeAllocation*>& largeAllocations() const { return m_largeAllocations; }
unsigned largeAllocationsNurseryOffset() const { return m_largeAllocationsNurseryOffset; }
unsigned largeAllocationsOffsetForThisCollection() const { return m_largeAllocationsOffsetForThisCollection; }
HashSet<HeapCell*>* largeAllocationSet() const { return m_largeAllocationSet.get(); }
void enableLargeAllocationTracking();
// These are cached pointers and offsets for quickly searching the large allocations that are
// relevant to this collection.
LargeAllocation** largeAllocationsForThisCollectionBegin() const { return m_largeAllocationsForThisCollectionBegin; }
LargeAllocation** largeAllocationsForThisCollectionEnd() const { return m_largeAllocationsForThisCollectionEnd; }
unsigned largeAllocationsForThisCollectionSize() const { return m_largeAllocationsForThisCollectionSize; }
BlockDirectory* firstDirectory() const { return m_directories.first(); }
Lock& directoryLock() { return m_directoryLock; }
void addBlockDirectory(const AbstractLocker&, BlockDirectory*);
// When this is true it means that we have flipped but the mark bits haven't converged yet.
bool isMarking() const { return m_isMarking; }
WeakSet* activeWeakSetsBegin() { return m_activeWeakSets.begin(); }
WeakSet* activeWeakSetsEnd() { return m_activeWeakSets.end(); }
WeakSet* newActiveWeakSetsBegin() { return m_newActiveWeakSets.begin(); }
WeakSet* newActiveWeakSetsEnd() { return m_newActiveWeakSets.end(); }
void dumpBits(PrintStream& = WTF::dataFile());
JS_EXPORT_PRIVATE static std::array<size_t, numSizeClasses> s_sizeClassForSizeStep;
friend class CompleteSubspace;
friend class LLIntOffsetsExtractor;
friend class JIT;
friend class WeakSet;
friend class Subspace;
friend class IsoSubspace;
// Use this version when calling from within the GC where we know that the directories
// have already been stopped.
template<typename Functor> void forEachLiveCell(const Functor&);
static void initializeSizeClassForStepSize();
void initializeSubspace(Subspace&);
template<typename Functor> inline void forEachDirectory(const Functor&);
void addActiveWeakSet(WeakSet*);
Vector<Subspace*> m_subspaces;
std::unique_ptr<HashSet<HeapCell*>> m_largeAllocationSet;
Vector<LargeAllocation*> m_largeAllocations;
unsigned m_largeAllocationsNurseryOffset { 0 };
unsigned m_largeAllocationsOffsetForThisCollection { 0 };
unsigned m_largeAllocationsNurseryOffsetForSweep { 0 };
unsigned m_largeAllocationsForThisCollectionSize { 0 };
LargeAllocation** m_largeAllocationsForThisCollectionBegin { nullptr };
LargeAllocation** m_largeAllocationsForThisCollectionEnd { nullptr };
Heap* m_heap;
size_t m_capacity { 0 };
HeapVersion m_markingVersion { initialVersion };
HeapVersion m_newlyAllocatedVersion { initialVersion };
bool m_isIterating { false };
bool m_isMarking { false };
Lock m_directoryLock;
MarkedBlockSet m_blocks;
SentinelLinkedList<WeakSet, BasicRawSentinelNode<WeakSet>> m_activeWeakSets;
SentinelLinkedList<WeakSet, BasicRawSentinelNode<WeakSet>> m_newActiveWeakSets;
SinglyLinkedListWithTail<BlockDirectory> m_directories;
friend class HeapVerifier;
template <typename Functor> inline void MarkedSpace::forEachBlock(const Functor& functor)
[&] (BlockDirectory& directory) -> IterationStatus {
return IterationStatus::Continue;
template <typename Functor>
void MarkedSpace::forEachDirectory(const Functor& functor)
for (BlockDirectory* directory = m_directories.first(); directory; directory = directory->nextDirectory()) {
if (functor(*directory) == IterationStatus::Done)
template<typename Functor>
void MarkedSpace::forEachSubspace(const Functor& functor)
for (auto subspace : m_subspaces) {
if (functor(*subspace) == IterationStatus::Done)
ALWAYS_INLINE size_t MarkedSpace::optimalSizeFor(size_t bytes)
if (bytes <= preciseCutoff)
return WTF::roundUpToMultipleOf<sizeStep>(bytes);
if (bytes <= largeCutoff)
return s_sizeClassForSizeStep[sizeClassToIndex(bytes)];
return bytes;
} // namespace JSC