bmalloc: Added a fast XLarge allocator
[WebKit-https.git] / Source / bmalloc / bmalloc / Allocator.cpp
1 /*
2  * Copyright (C) 2014, 2015 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 #include "Allocator.h"
27 #include "BAssert.h"
28 #include "Deallocator.h"
29 #include "Heap.h"
30 #include "LargeChunk.h"
31 #include "LargeObject.h"
32 #include "PerProcess.h"
33 #include "Sizes.h"
34 #include <algorithm>
35 #include <cstdlib>
36
37 using namespace std;
38
39 namespace bmalloc {
40
41 Allocator::Allocator(Heap* heap, Deallocator& deallocator)
42     : m_isBmallocEnabled(heap->environment().isBmallocEnabled())
43     , m_deallocator(deallocator)
44 {
45     for (unsigned short size = alignment; size <= smallMax; size += alignment)
46         m_bumpAllocators[sizeClass(size)].init(size);
47 }
48
49 Allocator::~Allocator()
50 {
51     scavenge();
52 }
53
54 void* Allocator::tryAllocate(size_t size)
55 {
56     if (!m_isBmallocEnabled)
57         return malloc(size);
58
59     if (size <= largeMax)
60         return allocate(size);
61
62     if (size <= xLargeMax) {
63         std::lock_guard<StaticMutex> lock(PerProcess<Heap>::mutex());
64         return PerProcess<Heap>::getFastCase()->tryAllocateXLarge(lock, alignment, size);
65     }
66
67     return nullptr;
68 }
69
70 void* Allocator::allocate(size_t alignment, size_t size)
71 {
72     BASSERT(isPowerOfTwo(alignment));
73
74     if (!m_isBmallocEnabled) {
75         void* result = nullptr;
76         if (posix_memalign(&result, alignment, size))
77             return nullptr;
78         return result;
79     }
80     
81     if (size <= smallMax && alignment <= smallLineSize) {
82         size_t alignmentMask = alignment - 1;
83         while (void* p = allocate(size)) {
84             if (!test(p, alignmentMask))
85                 return p;
86             m_deallocator.deallocate(p);
87         }
88     }
89
90     if (size <= largeMax && alignment <= largeMax) {
91         size = std::max(largeMin, roundUpToMultipleOf<largeAlignment>(size));
92         alignment = roundUpToMultipleOf<largeAlignment>(alignment);
93         size_t unalignedSize = largeMin + alignment - largeAlignment + size;
94         if (unalignedSize <= largeMax && alignment <= largeChunkSize / 2) {
95             std::lock_guard<StaticMutex> lock(PerProcess<Heap>::mutex());
96             return PerProcess<Heap>::getFastCase()->allocateLarge(lock, alignment, size, unalignedSize);
97         }
98     }
99
100     if (size <= xLargeMax && alignment <= xLargeMax) {
101         std::lock_guard<StaticMutex> lock(PerProcess<Heap>::mutex());
102         return PerProcess<Heap>::getFastCase()->allocateXLarge(lock, alignment, size);
103     }
104
105     BCRASH();
106     return nullptr;
107 }
108
109 void* Allocator::reallocate(void* object, size_t newSize)
110 {
111     if (!m_isBmallocEnabled)
112         return realloc(object, newSize);
113
114     size_t oldSize = 0;
115     switch (objectType(object)) {
116     case Small: {
117         SmallPage* page = SmallPage::get(SmallLine::get(object));
118         oldSize = objectSize(page->sizeClass());
119         break;
120     }
121     case Large: {
122         std::unique_lock<StaticMutex> lock(PerProcess<Heap>::mutex());
123         LargeObject largeObject(object);
124         oldSize = largeObject.size();
125
126         if (newSize < oldSize && newSize > smallMax) {
127             newSize = roundUpToMultipleOf<largeAlignment>(newSize);
128             if (oldSize - newSize >= largeMin) {
129                 std::pair<LargeObject, LargeObject> split = largeObject.split(newSize);
130                 
131                 lock.unlock();
132                 m_deallocator.deallocate(split.second.begin());
133                 lock.lock();
134             }
135             return object;
136         }
137         break;
138     }
139     case XLarge: {
140         BASSERT(objectType(nullptr) == XLarge);
141         if (!object)
142             break;
143
144         std::unique_lock<StaticMutex> lock(PerProcess<Heap>::mutex());
145         oldSize = PerProcess<Heap>::getFastCase()->xLargeSize(lock, object);
146
147         if (newSize == oldSize)
148             return object;
149
150         if (newSize < oldSize && newSize > largeMax) {
151             PerProcess<Heap>::getFastCase()->shrinkXLarge(lock, Range(object, oldSize), newSize);
152             return object;
153         }
154         break;
155     }
156     }
157
158     void* result = allocate(newSize);
159     size_t copySize = std::min(oldSize, newSize);
160     memcpy(result, object, copySize);
161     m_deallocator.deallocate(object);
162     return result;
163 }
164
165 void Allocator::scavenge()
166 {
167     for (unsigned short i = alignment; i <= smallMax; i += alignment) {
168         BumpAllocator& allocator = m_bumpAllocators[sizeClass(i)];
169         BumpRangeCache& bumpRangeCache = m_bumpRangeCaches[sizeClass(i)];
170
171         while (allocator.canAllocate())
172             m_deallocator.deallocate(allocator.allocate());
173
174         while (bumpRangeCache.size()) {
175             allocator.refill(bumpRangeCache.pop());
176             while (allocator.canAllocate())
177                 m_deallocator.deallocate(allocator.allocate());
178         }
179
180         allocator.clear();
181     }
182 }
183
184 NO_INLINE void Allocator::refillAllocatorSlowCase(BumpAllocator& allocator, size_t sizeClass)
185 {
186     BumpRangeCache& bumpRangeCache = m_bumpRangeCaches[sizeClass];
187
188     std::lock_guard<StaticMutex> lock(PerProcess<Heap>::mutex());
189     PerProcess<Heap>::getFastCase()->allocateSmallBumpRanges(lock, sizeClass, allocator, bumpRangeCache);
190 }
191
192 INLINE void Allocator::refillAllocator(BumpAllocator& allocator, size_t sizeClass)
193 {
194     BumpRangeCache& bumpRangeCache = m_bumpRangeCaches[sizeClass];
195     if (!bumpRangeCache.size())
196         return refillAllocatorSlowCase(allocator, sizeClass);
197     return allocator.refill(bumpRangeCache.pop());
198 }
199
200 NO_INLINE void* Allocator::allocateLarge(size_t size)
201 {
202     size = roundUpToMultipleOf<largeAlignment>(size);
203     std::lock_guard<StaticMutex> lock(PerProcess<Heap>::mutex());
204     return PerProcess<Heap>::getFastCase()->allocateLarge(lock, size);
205 }
206
207 NO_INLINE void* Allocator::allocateXLarge(size_t size)
208 {
209     std::lock_guard<StaticMutex> lock(PerProcess<Heap>::mutex());
210     return PerProcess<Heap>::getFastCase()->allocateXLarge(lock, size);
211 }
212
213 void* Allocator::allocateSlowCase(size_t size)
214 {
215     if (!m_isBmallocEnabled)
216         return malloc(size);
217
218     if (size <= smallMax) {
219         size_t sizeClass = bmalloc::sizeClass(size);
220         BumpAllocator& allocator = m_bumpAllocators[sizeClass];
221         refillAllocator(allocator, sizeClass);
222         return allocator.allocate();
223     }
224
225     if (size <= largeMax)
226         return allocateLarge(size);
227
228     if (size <= xLargeMax)
229         return allocateXLarge(size);
230
231     BCRASH();
232     return nullptr;
233 }
234
235 } // namespace bmalloc