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