bmalloc should do partial scavenges more frequently
[WebKit-https.git] / Source / bmalloc / bmalloc / IsoHeapImplInlines.h
1 /*
2  * Copyright (C) 2017-2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "IsoHeapImpl.h"
29 #include "IsoTLSDeallocatorEntry.h"
30
31 namespace bmalloc {
32
33 template<typename Config>
34 IsoHeapImpl<Config>::IsoHeapImpl()
35     : lock(PerProcess<IsoTLSDeallocatorEntry<Config>>::get()->lock)
36     , m_inlineDirectory(*this)
37     , m_allocator(*this)
38 {
39     addToAllIsoHeaps();
40 }
41
42 template<typename Config>
43 EligibilityResult<Config> IsoHeapImpl<Config>::takeFirstEligible()
44 {
45     if (m_isInlineDirectoryEligible) {
46         EligibilityResult<Config> result = m_inlineDirectory.takeFirstEligible();
47         if (result.kind == EligibilityKind::Full)
48             m_isInlineDirectoryEligible = false;
49         else
50             return result;
51     }
52     
53     if (!m_firstEligibleDirectory) {
54         // If nothing is eligible, it can only be because we have no directories. It wouldn't be the end
55         // of the world if we broke this invariant. It would only mean that didBecomeEligible() would need
56         // a null check.
57         RELEASE_BASSERT(!m_headDirectory);
58         RELEASE_BASSERT(!m_tailDirectory);
59     }
60     
61     for (; m_firstEligibleDirectory; m_firstEligibleDirectory = m_firstEligibleDirectory->next) {
62         EligibilityResult<Config> result = m_firstEligibleDirectory->payload.takeFirstEligible();
63         if (result.kind != EligibilityKind::Full) {
64             m_directoryHighWatermark = std::max(m_directoryHighWatermark, m_firstEligibleDirectory->index());
65             return result;
66         }
67     }
68     
69     auto* newDirectory = new IsoDirectoryPage<Config>(*this, m_nextDirectoryPageIndex++);
70     if (m_headDirectory) {
71         m_tailDirectory->next = newDirectory;
72         m_tailDirectory = newDirectory;
73     } else {
74         RELEASE_BASSERT(!m_tailDirectory);
75         m_headDirectory = newDirectory;
76         m_tailDirectory = newDirectory;
77     }
78     m_directoryHighWatermark = newDirectory->index();
79     m_firstEligibleDirectory = newDirectory;
80     EligibilityResult<Config> result = newDirectory->payload.takeFirstEligible();
81     RELEASE_BASSERT(result.kind != EligibilityKind::Full);
82     return result;
83 }
84
85 template<typename Config>
86 void IsoHeapImpl<Config>::didBecomeEligible(IsoDirectory<Config, numPagesInInlineDirectory>* directory)
87 {
88     RELEASE_BASSERT(directory == &m_inlineDirectory);
89     m_isInlineDirectoryEligible = true;
90 }
91
92 template<typename Config>
93 void IsoHeapImpl<Config>::didBecomeEligible(IsoDirectory<Config, IsoDirectoryPage<Config>::numPages>* directory)
94 {
95     RELEASE_BASSERT(m_firstEligibleDirectory);
96     auto* directoryPage = IsoDirectoryPage<Config>::pageFor(directory);
97     if (directoryPage->index() < m_firstEligibleDirectory->index())
98         m_firstEligibleDirectory = directoryPage;
99 }
100
101 template<typename Config>
102 void IsoHeapImpl<Config>::scavenge(Vector<DeferredDecommit>& decommits)
103 {
104     forEachDirectory(
105         [&] (auto& directory) {
106             directory.scavenge(decommits);
107         });
108     m_directoryHighWatermark = 0;
109 }
110
111 template<typename Config>
112 void IsoHeapImpl<Config>::scavengeToHighWatermark(Vector<DeferredDecommit>& decommits)
113 {
114     if (!m_directoryHighWatermark)
115         m_inlineDirectory.scavengeToHighWatermark(decommits);
116     for (IsoDirectoryPage<Config>* page = m_headDirectory; page; page = page->next) {
117         if (page->index() >= m_directoryHighWatermark)
118             page->payload.scavengeToHighWatermark(decommits);
119     }
120     m_directoryHighWatermark = 0;
121 }
122
123 template<typename Config>
124 size_t IsoHeapImpl<Config>::freeableMemory()
125 {
126     return m_freeableMemory;
127 }
128
129 template<typename Config>
130 unsigned IsoHeapImpl<Config>::allocatorOffset()
131 {
132     return m_allocator.offset();
133 }
134
135 template<typename Config>
136 unsigned IsoHeapImpl<Config>::deallocatorOffset()
137 {
138     return PerProcess<IsoTLSDeallocatorEntry<Config>>::get()->offset();
139 }
140
141 template<typename Config>
142 unsigned IsoHeapImpl<Config>::numLiveObjects()
143 {
144     unsigned result = 0;
145     forEachLiveObject(
146         [&] (void*) {
147             result++;
148         });
149     return result;
150 }
151
152 template<typename Config>
153 unsigned IsoHeapImpl<Config>::numCommittedPages()
154 {
155     unsigned result = 0;
156     forEachCommittedPage(
157         [&] (IsoPage<Config>&) {
158             result++;
159         });
160     return result;
161 }
162
163 template<typename Config>
164 template<typename Func>
165 void IsoHeapImpl<Config>::forEachDirectory(const Func& func)
166 {
167     func(m_inlineDirectory);
168     for (IsoDirectoryPage<Config>* page = m_headDirectory; page; page = page->next)
169         func(page->payload);
170 }
171
172 template<typename Config>
173 template<typename Func>
174 void IsoHeapImpl<Config>::forEachCommittedPage(const Func& func)
175 {
176     forEachDirectory(
177         [&] (auto& directory) {
178             directory.forEachCommittedPage(func);
179         });
180 }
181
182 template<typename Config>
183 template<typename Func>
184 void IsoHeapImpl<Config>::forEachLiveObject(const Func& func)
185 {
186     forEachCommittedPage(
187         [&] (IsoPage<Config>& page) {
188             page.forEachLiveObject(func);
189         });
190 }
191
192 template<typename Config>
193 size_t IsoHeapImpl<Config>::footprint()
194 {
195 #if ENABLE_PHYSICAL_PAGE_MAP
196     RELEASE_BASSERT(m_footprint == m_physicalPageMap.footprint());
197 #endif
198     return m_footprint;
199 }
200
201 template<typename Config>
202 void IsoHeapImpl<Config>::didCommit(void* ptr, size_t bytes)
203 {
204     BUNUSED_PARAM(ptr);
205     m_footprint += bytes;
206 #if ENABLE_PHYSICAL_PAGE_MAP
207     m_physicalPageMap.commit(ptr, bytes);
208 #endif
209 }
210
211 template<typename Config>
212 void IsoHeapImpl<Config>::didDecommit(void* ptr, size_t bytes)
213 {
214     BUNUSED_PARAM(ptr);
215     m_footprint -= bytes;
216 #if ENABLE_PHYSICAL_PAGE_MAP
217     m_physicalPageMap.decommit(ptr, bytes);
218 #endif
219 }
220
221 template<typename Config>
222 void IsoHeapImpl<Config>::isNowFreeable(void* ptr, size_t bytes)
223 {
224     BUNUSED_PARAM(ptr);
225     m_freeableMemory += bytes;
226 }
227
228 template<typename Config>
229 void IsoHeapImpl<Config>::isNoLongerFreeable(void* ptr, size_t bytes)
230 {
231     BUNUSED_PARAM(ptr);
232     m_freeableMemory -= bytes;
233 }
234
235 } // namespace bmalloc
236