a6528b3e10d23d7a5e25ea09d23b133ac6276fa4
[WebKit-https.git] / Source / JavaScriptCore / heap / MarkedSpace.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 "IterationStatus.h"
25 #include "LargeAllocation.h"
26 #include "MarkedAllocator.h"
27 #include "MarkedBlock.h"
28 #include "MarkedBlockSet.h"
29 #include <array>
30 #include <wtf/Bag.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/Noncopyable.h>
33 #include <wtf/RetainPtr.h>
34 #include <wtf/SentinelLinkedList.h>
35 #include <wtf/SinglyLinkedListWithTail.h>
36 #include <wtf/Vector.h>
37
38 namespace JSC {
39
40 class CompleteSubspace;
41 class Heap;
42 class HeapIterationScope;
43 class LLIntOffsetsExtractor;
44 class Subspace;
45 class WeakSet;
46
47 typedef uint32_t HeapVersion;
48
49 class MarkedSpace {
50     WTF_MAKE_NONCOPYABLE(MarkedSpace);
51 public:
52     // sizeStep is really a synonym for atomSize; it's no accident that they are the same.
53     static const size_t sizeStep = MarkedBlock::atomSize;
54     
55     // Sizes up to this amount get a size class for each size step.
56     static const size_t preciseCutoff = 80;
57     
58     // The amount of available payload in a block is the block's size minus the header. But the
59     // header size might not be atom size aligned, so we round down the result accordingly.
60     static const size_t blockPayload = (MarkedBlock::blockSize - sizeof(MarkedBlock)) & ~(MarkedBlock::atomSize - 1);
61     
62     // The largest cell we're willing to allocate in a MarkedBlock the "normal way" (i.e. using size
63     // classes, rather than a large allocation) is half the size of the payload, rounded down. This
64     // ensures that we only use the size class approach if it means being able to pack two things
65     // into one block.
66     static const size_t largeCutoff = (blockPayload / 2) & ~(sizeStep - 1);
67
68     static const size_t numSizeClasses = largeCutoff / sizeStep;
69     
70     static const HeapVersion nullVersion = 0; // The version of freshly allocated blocks.
71     static const HeapVersion initialVersion = 2; // The version that the heap starts out with. Set to make sure that nextVersion(nullVersion) != initialVersion.
72     
73     static HeapVersion nextVersion(HeapVersion version)
74     {
75         version++;
76         if (version == nullVersion)
77             version = initialVersion;
78         return version;
79     }
80     
81     static size_t sizeClassToIndex(size_t size)
82     {
83         ASSERT(size);
84         return (size + sizeStep - 1) / sizeStep - 1;
85     }
86     
87     static size_t indexToSizeClass(size_t index)
88     {
89         return (index + 1) * sizeStep;
90     }
91     
92     MarkedSpace(Heap*);
93     ~MarkedSpace();
94     
95     Heap* heap() const { return m_heap; }
96     
97     void lastChanceToFinalize(); // You must call stopAllocating before you call this.
98     void freeMemory();
99
100     static size_t optimalSizeFor(size_t);
101     
102     void prepareForAllocation();
103
104     void visitWeakSets(SlotVisitor&);
105     void reapWeakSets();
106
107     MarkedBlockSet& blocks() { return m_blocks; }
108
109     void willStartIterating();
110     bool isIterating() const { return m_isIterating; }
111     void didFinishIterating();
112
113     void stopAllocating();
114     void resumeAllocating(); // If we just stopped allocation but we didn't do a collection, we need to resume allocation.
115     
116     void prepareForMarking();
117     
118     void prepareForConservativeScan();
119
120     typedef HashSet<MarkedBlock*>::iterator BlockIterator;
121
122     template<typename Functor> void forEachLiveCell(HeapIterationScope&, const Functor&);
123     template<typename Functor> void forEachDeadCell(HeapIterationScope&, const Functor&);
124     template<typename Functor> void forEachBlock(const Functor&);
125
126     void shrink();
127     void freeBlock(MarkedBlock::Handle*);
128     void freeOrShrinkBlock(MarkedBlock::Handle*);
129
130     void didAddBlock(MarkedBlock::Handle*);
131     void didConsumeFreeList(MarkedBlock::Handle*);
132     void didAllocateInBlock(MarkedBlock::Handle*);
133
134     void beginMarking();
135     void endMarking();
136     void snapshotUnswept();
137     void clearNewlyAllocated();
138     void sweep();
139     void sweepLargeAllocations();
140     void assertNoUnswept();
141     size_t objectCount();
142     size_t size();
143     size_t capacity();
144
145     bool isPagedOut(double deadline);
146     
147     HeapVersion markingVersion() const { return m_markingVersion; }
148     HeapVersion newlyAllocatedVersion() const { return m_newlyAllocatedVersion; }
149
150     const Vector<LargeAllocation*>& largeAllocations() const { return m_largeAllocations; }
151     unsigned largeAllocationsNurseryOffset() const { return m_largeAllocationsNurseryOffset; }
152     unsigned largeAllocationsOffsetForThisCollection() const { return m_largeAllocationsOffsetForThisCollection; }
153     
154     // These are cached pointers and offsets for quickly searching the large allocations that are
155     // relevant to this collection.
156     LargeAllocation** largeAllocationsForThisCollectionBegin() const { return m_largeAllocationsForThisCollectionBegin; }
157     LargeAllocation** largeAllocationsForThisCollectionEnd() const { return m_largeAllocationsForThisCollectionEnd; }
158     unsigned largeAllocationsForThisCollectionSize() const { return m_largeAllocationsForThisCollectionSize; }
159     
160     MarkedAllocator* firstAllocator() const { return m_allocators.first(); }
161     
162     Lock& allocatorLock() { return m_allocatorLock; }
163     void addMarkedAllocator(const AbstractLocker&, MarkedAllocator*);
164     
165     // When this is true it means that we have flipped but the mark bits haven't converged yet.
166     bool isMarking() const { return m_isMarking; }
167     
168     void dumpBits(PrintStream& = WTF::dataFile());
169     
170     JS_EXPORT_PRIVATE static std::array<size_t, numSizeClasses> s_sizeClassForSizeStep;
171     
172 private:
173     friend class CompleteSubspace;
174     friend class LLIntOffsetsExtractor;
175     friend class JIT;
176     friend class WeakSet;
177     friend class Subspace;
178     
179     // Use this version when calling from within the GC where we know that the allocators
180     // have already been stopped.
181     template<typename Functor> void forEachLiveCell(const Functor&);
182
183     static void initializeSizeClassForStepSize();
184     
185     void initializeSubspace(Subspace&);
186
187     template<typename Functor> inline void forEachAllocator(const Functor&);
188     
189     void addActiveWeakSet(WeakSet*);
190
191     Vector<Subspace*> m_subspaces;
192
193     Vector<LargeAllocation*> m_largeAllocations;
194     unsigned m_largeAllocationsNurseryOffset { 0 };
195     unsigned m_largeAllocationsOffsetForThisCollection { 0 };
196     unsigned m_largeAllocationsNurseryOffsetForSweep { 0 };
197     LargeAllocation** m_largeAllocationsForThisCollectionBegin { nullptr };
198     LargeAllocation** m_largeAllocationsForThisCollectionEnd { nullptr };
199     unsigned m_largeAllocationsForThisCollectionSize { 0 };
200
201     Heap* m_heap;
202     HeapVersion m_markingVersion { initialVersion };
203     HeapVersion m_newlyAllocatedVersion { initialVersion };
204     size_t m_capacity;
205     bool m_isIterating;
206     bool m_isMarking { false };
207     MarkedBlockSet m_blocks;
208     
209     SentinelLinkedList<WeakSet, BasicRawSentinelNode<WeakSet>> m_activeWeakSets;
210     SentinelLinkedList<WeakSet, BasicRawSentinelNode<WeakSet>> m_newActiveWeakSets;
211
212     Lock m_allocatorLock;
213     SinglyLinkedListWithTail<MarkedAllocator> m_allocators;
214
215     friend class HeapVerifier;
216 };
217
218 template <typename Functor> inline void MarkedSpace::forEachBlock(const Functor& functor)
219 {
220     forEachAllocator(
221         [&] (MarkedAllocator& allocator) -> IterationStatus {
222             allocator.forEachBlock(functor);
223             return IterationStatus::Continue;
224         });
225 }
226
227 template <typename Functor>
228 void MarkedSpace::forEachAllocator(const Functor& functor)
229 {
230     for (MarkedAllocator* allocator = m_allocators.first(); allocator; allocator = allocator->nextAllocator()) {
231         if (functor(*allocator) == IterationStatus::Done)
232             return;
233     }
234 }
235
236 ALWAYS_INLINE size_t MarkedSpace::optimalSizeFor(size_t bytes)
237 {
238     ASSERT(bytes);
239     if (bytes <= preciseCutoff)
240         return WTF::roundUpToMultipleOf<sizeStep>(bytes);
241     if (bytes <= largeCutoff)
242         return s_sizeClassForSizeStep[sizeClassToIndex(bytes)];
243     return bytes;
244 }
245
246 } // namespace JSC