bmalloc: Added a fast XLarge allocator
[WebKit-https.git] / Source / bmalloc / bmalloc / Heap.h
1 /*
2  * Copyright (C) 2014-2016 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 #ifndef Heap_h
27 #define Heap_h
28
29 #include "BumpRange.h"
30 #include "Environment.h"
31 #include "LineMetadata.h"
32 #include "Mutex.h"
33 #include "SegregatedFreeList.h"
34 #include "SmallChunk.h"
35 #include "SmallLine.h"
36 #include "SmallPage.h"
37 #include "VMHeap.h"
38 #include "Vector.h"
39 #include "XLargeMap.h"
40 #include <array>
41 #include <mutex>
42
43 namespace bmalloc {
44
45 class BeginTag;
46 class BumpAllocator;
47 class EndTag;
48
49 class Heap {
50 public:
51     Heap(std::lock_guard<StaticMutex>&);
52     
53     Environment& environment() { return m_environment; }
54
55     void allocateSmallBumpRanges(std::lock_guard<StaticMutex>&, size_t sizeClass, BumpAllocator&, BumpRangeCache&);
56     void derefSmallLine(std::lock_guard<StaticMutex>&, SmallLine*);
57
58     void* allocateLarge(std::lock_guard<StaticMutex>&, size_t);
59     void* allocateLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t, size_t unalignedSize);
60     void deallocateLarge(std::lock_guard<StaticMutex>&, void*);
61
62     void* allocateXLarge(std::lock_guard<StaticMutex>&, size_t);
63     void* allocateXLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t);
64     void* tryAllocateXLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t);
65     size_t xLargeSize(std::unique_lock<StaticMutex>&, void*);
66     void shrinkXLarge(std::unique_lock<StaticMutex>&, const Range&, size_t newSize);
67     void deallocateXLarge(std::unique_lock<StaticMutex>&, void*);
68
69     void scavenge(std::unique_lock<StaticMutex>&, std::chrono::milliseconds sleepDuration);
70
71 private:
72     ~Heap() = delete;
73     
74     void initializeLineMetadata();
75
76     SmallPage* allocateSmallPage(std::lock_guard<StaticMutex>&, size_t sizeClass);
77
78     void deallocateSmallLine(std::lock_guard<StaticMutex>&, SmallLine*);
79     void deallocateLarge(std::lock_guard<StaticMutex>&, const LargeObject&);
80
81     LargeObject& splitAndAllocate(LargeObject&, size_t);
82     LargeObject& splitAndAllocate(LargeObject&, size_t, size_t);
83     void mergeLarge(BeginTag*&, EndTag*&, Range&);
84     void mergeLargeLeft(EndTag*&, BeginTag*&, Range&, bool& inVMHeap);
85     void mergeLargeRight(EndTag*&, BeginTag*&, Range&, bool& inVMHeap);
86
87     XLargeRange splitAndAllocate(XLargeRange&, size_t alignment, size_t);
88
89     void concurrentScavenge();
90     void scavengeSmallPages(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
91     void scavengeLargeObjects(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
92     void scavengeXLargeObjects(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
93
94     std::array<std::array<LineMetadata, smallLineCount>, smallMax / alignment> m_smallLineMetadata;
95
96     std::array<Vector<SmallPage*>, smallMax / alignment> m_smallPagesWithFreeLines;
97
98     Vector<SmallPage*> m_smallPages;
99
100     SegregatedFreeList m_largeObjects;
101     
102     XLargeMap m_xLargeMap;
103
104     bool m_isAllocatingPages;
105     AsyncTask<Heap, decltype(&Heap::concurrentScavenge)> m_scavenger;
106
107     Environment m_environment;
108
109     VMHeap m_vmHeap;
110 };
111
112 inline void Heap::derefSmallLine(std::lock_guard<StaticMutex>& lock, SmallLine* line)
113 {
114     if (!line->deref(lock))
115         return;
116     deallocateSmallLine(lock, line);
117 }
118
119 } // namespace bmalloc
120
121 #endif // Heap_h