MarkedBlock should know what objects are live during marking
[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, 2004, 2005, 2006, 2007, 2008, 2009, 2011, 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 #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/Vector.h>
36
37 namespace JSC {
38
39 class Heap;
40 class HeapIterationScope;
41 class LLIntOffsetsExtractor;
42 class WeakSet;
43
44 typedef uint32_t HeapVersion;
45
46 class MarkedSpace {
47     WTF_MAKE_NONCOPYABLE(MarkedSpace);
48 public:
49     // sizeStep is really a synonym for atomSize; it's no accident that they are the same.
50     static const size_t sizeStep = MarkedBlock::atomSize;
51     
52     // Sizes up to this amount get a size class for each size step.
53     static const size_t preciseCutoff = 80;
54     
55     // The amount of available payload in a block is the block's size minus the header. But the
56     // header size might not be atom size aligned, so we round down the result accordingly.
57     static const size_t blockPayload = (MarkedBlock::blockSize - sizeof(MarkedBlock)) & ~(MarkedBlock::atomSize - 1);
58     
59     // The largest cell we're willing to allocate in a MarkedBlock the "normal way" (i.e. using size
60     // classes, rather than a large allocation) is half the size of the payload, rounded down. This
61     // ensures that we only use the size class approach if it means being able to pack two things
62     // into one block.
63     static const size_t largeCutoff = (blockPayload / 2) & ~(sizeStep - 1);
64
65     static const size_t numSizeClasses = largeCutoff / sizeStep;
66     
67     static const HeapVersion nullVersion = 0; // The version of freshly allocated blocks.
68     static const HeapVersion initialVersion = 2; // The version that the heap starts out with. Set to make sure that nextVersion(nullVersion) != initialVersion.
69     
70     static HeapVersion nextVersion(HeapVersion version)
71     {
72         version++;
73         if (version == nullVersion)
74             version = initialVersion;
75         return version;
76     }
77     
78     static size_t sizeClassToIndex(size_t size)
79     {
80         ASSERT(size);
81         return (size + sizeStep - 1) / sizeStep - 1;
82     }
83     
84     static size_t indexToSizeClass(size_t index)
85     {
86         return (index + 1) * sizeStep;
87     }
88     
89     // Each Subspace corresponds to all of the blocks for all of the sizes for some "class" of
90     // objects. There are three classes: non-destructor JSCells, destructor JSCells, and auxiliary.
91     // MarkedSpace is set up to make it relatively easy to add new Subspaces.
92     struct Subspace {
93         std::array<MarkedAllocator*, numSizeClasses> allocatorForSizeStep;
94         
95         // Each MarkedAllocator is a size class.
96         Bag<MarkedAllocator> bagOfAllocators;
97         
98         AllocatorAttributes attributes;
99     };
100     
101     MarkedSpace(Heap*);
102     ~MarkedSpace();
103     void lastChanceToFinalize();
104
105     static size_t optimalSizeFor(size_t);
106     
107     static MarkedAllocator* allocatorFor(Subspace&, size_t);
108
109     MarkedAllocator* allocatorFor(size_t);
110     MarkedAllocator* destructorAllocatorFor(size_t);
111     MarkedAllocator* auxiliaryAllocatorFor(size_t);
112
113     JS_EXPORT_PRIVATE void* allocate(Subspace&, size_t);
114     JS_EXPORT_PRIVATE void* allocate(Subspace&, GCDeferralContext*, size_t);
115     JS_EXPORT_PRIVATE void* tryAllocate(Subspace&, size_t);
116     JS_EXPORT_PRIVATE void* tryAllocate(Subspace&, GCDeferralContext*, size_t);
117     
118     void* allocateWithDestructor(size_t);
119     void* allocateWithoutDestructor(size_t);
120     void* allocateWithDestructor(GCDeferralContext*, size_t);
121     void* allocateWithoutDestructor(GCDeferralContext*, size_t);
122     void* allocateAuxiliary(size_t);
123     void* tryAllocateAuxiliary(size_t);
124     void* tryAllocateAuxiliary(GCDeferralContext*, size_t);
125     
126     Subspace& subspaceForObjectsWithDestructor() { return m_destructorSpace; }
127     Subspace& subspaceForObjectsWithoutDestructor() { return m_normalSpace; }
128     Subspace& subspaceForAuxiliaryData() { return m_auxiliarySpace; }
129     
130     void prepareForAllocation();
131
132     void visitWeakSets(HeapRootVisitor&);
133     void reapWeakSets();
134
135     MarkedBlockSet& blocks() { return m_blocks; }
136
137     void willStartIterating();
138     bool isIterating() const { return m_isIterating; }
139     void didFinishIterating();
140
141     void stopAllocating();
142     void resumeAllocating(); // If we just stopped allocation but we didn't do a collection, we need to resume allocation.
143     
144     void prepareForMarking();
145
146     typedef HashSet<MarkedBlock*>::iterator BlockIterator;
147
148     template<typename Functor> void forEachLiveCell(HeapIterationScope&, const Functor&);
149     template<typename Functor> void forEachDeadCell(HeapIterationScope&, const Functor&);
150     template<typename Functor> void forEachBlock(const Functor&);
151
152     void shrink();
153     void freeBlock(MarkedBlock::Handle*);
154     void freeOrShrinkBlock(MarkedBlock::Handle*);
155
156     void didAddBlock(MarkedBlock::Handle*);
157     void didConsumeFreeList(MarkedBlock::Handle*);
158     void didAllocateInBlock(MarkedBlock::Handle*);
159
160     void beginMarking();
161     void endMarking();
162     void snapshotUnswept();
163     void clearNewlyAllocated();
164     void sweep();
165     void sweepLargeAllocations();
166     void assertNoUnswept();
167     size_t objectCount();
168     size_t size();
169     size_t capacity();
170
171     bool isPagedOut(double deadline);
172     
173     HeapVersion markingVersion() const { return m_markingVersion; }
174     HeapVersion newlyAllocatedVersion() const { return m_newlyAllocatedVersion; }
175
176     const Vector<LargeAllocation*>& largeAllocations() const { return m_largeAllocations; }
177     unsigned largeAllocationsNurseryOffset() const { return m_largeAllocationsNurseryOffset; }
178     unsigned largeAllocationsOffsetForThisCollection() const { return m_largeAllocationsOffsetForThisCollection; }
179     
180     // These are cached pointers and offsets for quickly searching the large allocations that are
181     // relevant to this collection.
182     LargeAllocation** largeAllocationsForThisCollectionBegin() const { return m_largeAllocationsForThisCollectionBegin; }
183     LargeAllocation** largeAllocationsForThisCollectionEnd() const { return m_largeAllocationsForThisCollectionEnd; }
184     unsigned largeAllocationsForThisCollectionSize() const { return m_largeAllocationsForThisCollectionSize; }
185     
186     MarkedAllocator* firstAllocator() const { return m_firstAllocator; }
187     MarkedAllocator* allocatorForEmptyAllocation() const { return m_allocatorForEmptyAllocation; }
188     
189     MarkedBlock::Handle* findEmptyBlockToSteal();
190     
191     // When this is true it means that we have flipped but the mark bits haven't converged yet.
192     bool isMarking() const { return m_isMarking; }
193     
194     void dumpBits(PrintStream& = WTF::dataFile());
195     
196 private:
197     friend class LLIntOffsetsExtractor;
198     friend class JIT;
199     friend class WeakSet;
200     
201     JS_EXPORT_PRIVATE static std::array<size_t, numSizeClasses> s_sizeClassForSizeStep;
202     
203     void* allocateLarge(Subspace&, GCDeferralContext*, size_t);
204     void* tryAllocateLarge(Subspace&, GCDeferralContext*, size_t);
205
206     static void initializeSizeClassForStepSize();
207     
208     void initializeSubspace(Subspace&);
209
210     template<typename Functor> inline void forEachAllocator(const Functor&);
211     template<typename Functor> inline void forEachSubspace(const Functor&);
212     
213     void addActiveWeakSet(WeakSet*);
214
215     Subspace m_destructorSpace;
216     Subspace m_normalSpace;
217     Subspace m_auxiliarySpace;
218
219     Heap* m_heap;
220     HeapVersion m_markingVersion { initialVersion };
221     HeapVersion m_newlyAllocatedVersion { initialVersion };
222     size_t m_capacity;
223     bool m_isIterating;
224     bool m_isMarking { false };
225     MarkedBlockSet m_blocks;
226     Vector<LargeAllocation*> m_largeAllocations;
227     unsigned m_largeAllocationsNurseryOffset { 0 };
228     unsigned m_largeAllocationsOffsetForThisCollection { 0 };
229     unsigned m_largeAllocationsNurseryOffsetForSweep { 0 };
230     LargeAllocation** m_largeAllocationsForThisCollectionBegin { nullptr };
231     LargeAllocation** m_largeAllocationsForThisCollectionEnd { nullptr };
232     unsigned m_largeAllocationsForThisCollectionSize { 0 };
233     SentinelLinkedList<WeakSet, BasicRawSentinelNode<WeakSet>> m_activeWeakSets;
234     SentinelLinkedList<WeakSet, BasicRawSentinelNode<WeakSet>> m_newActiveWeakSets;
235     
236     MarkedAllocator* m_firstAllocator { nullptr };
237     MarkedAllocator* m_allocatorForEmptyAllocation { nullptr };
238 };
239
240 inline MarkedAllocator* MarkedSpace::allocatorFor(Subspace& space, size_t bytes)
241 {
242     ASSERT(bytes);
243     if (bytes <= largeCutoff)
244         return space.allocatorForSizeStep[sizeClassToIndex(bytes)];
245     return nullptr;
246 }
247
248 inline MarkedAllocator* MarkedSpace::allocatorFor(size_t bytes)
249 {
250     return allocatorFor(m_normalSpace, bytes);
251 }
252
253 inline MarkedAllocator* MarkedSpace::destructorAllocatorFor(size_t bytes)
254 {
255     return allocatorFor(m_destructorSpace, bytes);
256 }
257
258 inline MarkedAllocator* MarkedSpace::auxiliaryAllocatorFor(size_t bytes)
259 {
260     return allocatorFor(m_auxiliarySpace, bytes);
261 }
262
263 inline void* MarkedSpace::allocateWithoutDestructor(size_t bytes)
264 {
265     return allocate(m_normalSpace, bytes);
266 }
267
268 inline void* MarkedSpace::allocateWithDestructor(size_t bytes)
269 {
270     return allocate(m_destructorSpace, bytes);
271 }
272
273 inline void* MarkedSpace::allocateWithoutDestructor(GCDeferralContext* deferralContext, size_t bytes)
274 {
275     return allocate(m_normalSpace, deferralContext, bytes);
276 }
277
278 inline void* MarkedSpace::allocateWithDestructor(GCDeferralContext* deferralContext, size_t bytes)
279 {
280     return allocate(m_destructorSpace, deferralContext, bytes);
281 }
282
283 inline void* MarkedSpace::allocateAuxiliary(size_t bytes)
284 {
285     return allocate(m_auxiliarySpace, bytes);
286 }
287
288 inline void* MarkedSpace::tryAllocateAuxiliary(size_t bytes)
289 {
290     return tryAllocate(m_auxiliarySpace, bytes);
291 }
292
293 inline void* MarkedSpace::tryAllocateAuxiliary(GCDeferralContext* deferralContext, size_t bytes)
294 {
295     return tryAllocate(m_auxiliarySpace, deferralContext, bytes);
296 }
297
298 template <typename Functor> inline void MarkedSpace::forEachBlock(const Functor& functor)
299 {
300     forEachAllocator(
301         [&] (MarkedAllocator& allocator) -> IterationStatus {
302             allocator.forEachBlock(functor);
303             return IterationStatus::Continue;
304         });
305 }
306
307 template <typename Functor>
308 void MarkedSpace::forEachAllocator(const Functor& functor)
309 {
310     for (MarkedAllocator* allocator = m_firstAllocator; allocator; allocator = allocator->nextAllocator()) {
311         if (functor(*allocator) == IterationStatus::Done)
312             return;
313     }
314 }
315
316 template<typename Functor>
317 inline void MarkedSpace::forEachSubspace(const Functor& func)
318 {
319     AllocatorAttributes attributes;
320     
321     attributes.destruction = NeedsDestruction;
322     attributes.cellKind = HeapCell::JSCell;
323     if (func(m_destructorSpace, attributes) == IterationStatus::Done)
324         return;
325     
326     attributes.destruction = DoesNotNeedDestruction;
327     attributes.cellKind = HeapCell::JSCell;
328     if (func(m_normalSpace, attributes) == IterationStatus::Done)
329         return;
330
331     attributes.destruction = DoesNotNeedDestruction;
332     attributes.cellKind = HeapCell::Auxiliary;
333     func(m_auxiliarySpace, attributes);
334 }
335
336 ALWAYS_INLINE size_t MarkedSpace::optimalSizeFor(size_t bytes)
337 {
338     ASSERT(bytes);
339     if (bytes <= preciseCutoff)
340         return WTF::roundUpToMultipleOf<sizeStep>(bytes);
341     if (bytes <= largeCutoff)
342         return s_sizeClassForSizeStep[sizeClassToIndex(bytes)];
343     return bytes;
344 }
345
346 } // namespace JSC