[BMalloc] Scavenger should react to recent memory activity
[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     std::lock_guard<Mutex> locker(this->lock);
105     forEachDirectory(
106         [&] (auto& directory) {
107             directory.scavenge(decommits);
108         });
109     m_directoryHighWatermark = 0;
110 }
111
112 template<typename Config>
113 size_t IsoHeapImpl<Config>::freeableMemory()
114 {
115     return m_freeableMemory;
116 }
117
118 template<typename Config>
119 unsigned IsoHeapImpl<Config>::allocatorOffset()
120 {
121     return m_allocator.offset();
122 }
123
124 template<typename Config>
125 unsigned IsoHeapImpl<Config>::deallocatorOffset()
126 {
127     return PerProcess<IsoTLSDeallocatorEntry<Config>>::get()->offset();
128 }
129
130 template<typename Config>
131 unsigned IsoHeapImpl<Config>::numLiveObjects()
132 {
133     unsigned result = 0;
134     forEachLiveObject(
135         [&] (void*) {
136             result++;
137         });
138     return result;
139 }
140
141 template<typename Config>
142 unsigned IsoHeapImpl<Config>::numCommittedPages()
143 {
144     unsigned result = 0;
145     forEachCommittedPage(
146         [&] (IsoPage<Config>&) {
147             result++;
148         });
149     return result;
150 }
151
152 template<typename Config>
153 template<typename Func>
154 void IsoHeapImpl<Config>::forEachDirectory(const Func& func)
155 {
156     func(m_inlineDirectory);
157     for (IsoDirectoryPage<Config>* page = m_headDirectory; page; page = page->next)
158         func(page->payload);
159 }
160
161 template<typename Config>
162 template<typename Func>
163 void IsoHeapImpl<Config>::forEachCommittedPage(const Func& func)
164 {
165     forEachDirectory(
166         [&] (auto& directory) {
167             directory.forEachCommittedPage(func);
168         });
169 }
170
171 template<typename Config>
172 template<typename Func>
173 void IsoHeapImpl<Config>::forEachLiveObject(const Func& func)
174 {
175     forEachCommittedPage(
176         [&] (IsoPage<Config>& page) {
177             page.forEachLiveObject(func);
178         });
179 }
180
181 template<typename Config>
182 size_t IsoHeapImpl<Config>::footprint()
183 {
184 #if ENABLE_PHYSICAL_PAGE_MAP
185     RELEASE_BASSERT(m_footprint == m_physicalPageMap.footprint());
186 #endif
187     return m_footprint;
188 }
189
190 template<typename Config>
191 void IsoHeapImpl<Config>::didCommit(void* ptr, size_t bytes)
192 {
193     BUNUSED_PARAM(ptr);
194     m_footprint += bytes;
195 #if ENABLE_PHYSICAL_PAGE_MAP
196     m_physicalPageMap.commit(ptr, bytes);
197 #endif
198 }
199
200 template<typename Config>
201 void IsoHeapImpl<Config>::didDecommit(void* ptr, size_t bytes)
202 {
203     BUNUSED_PARAM(ptr);
204     m_footprint -= bytes;
205 #if ENABLE_PHYSICAL_PAGE_MAP
206     m_physicalPageMap.decommit(ptr, bytes);
207 #endif
208 }
209
210 template<typename Config>
211 void IsoHeapImpl<Config>::isNowFreeable(void* ptr, size_t bytes)
212 {
213     BUNUSED_PARAM(ptr);
214     m_freeableMemory += bytes;
215 }
216
217 template<typename Config>
218 void IsoHeapImpl<Config>::isNoLongerFreeable(void* ptr, size_t bytes)
219 {
220     BUNUSED_PARAM(ptr);
221     m_freeableMemory -= bytes;
222 }
223
224 } // namespace bmalloc
225