bmalloc
[WebKit-https.git] / Source / bmalloc / bmalloc / Heap.h
1 /*
2  * Copyright (C) 2014 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 "FixedVector.h"
30 #include "VMHeap.h"
31 #include "MediumLine.h"
32 #include "Mutex.h"
33 #include "SmallPage.h"
34 #include "MediumChunk.h"
35 #include "MediumPage.h"
36 #include "SegregatedFreeList.h"
37 #include "SmallChunk.h"
38 #include "SmallLine.h"
39 #include "Vector.h"
40 #include <array>
41 #include <mutex>
42
43 namespace bmalloc {
44
45 class BeginTag;
46 class EndTag;
47
48 class Heap {
49 public:
50     Heap(std::lock_guard<Mutex>&);
51     
52     SmallLine* allocateSmallLine(std::lock_guard<Mutex>&);
53     void deallocateSmallLine(SmallLine*);
54
55     MediumLine* allocateMediumLine(std::lock_guard<Mutex>&);
56     void deallocateMediumLine(MediumLine*);
57     
58     void* allocateLarge(std::lock_guard<Mutex>&, size_t);
59     void deallocateLarge(std::lock_guard<Mutex>&, void*);
60
61     void* allocateXLarge(std::lock_guard<Mutex>&, size_t);
62     void deallocateXLarge(std::lock_guard<Mutex>&, void*);
63
64 private:
65     ~Heap() = delete;
66
67     SmallLine* allocateSmallLineSlowCase(std::lock_guard<Mutex>&);
68     MediumLine* allocateMediumLineSlowCase(std::lock_guard<Mutex>&);
69
70     void* allocateLarge(Range, size_t);
71     Range allocateLargeChunk();
72
73     void splitLarge(BeginTag*, size_t, EndTag*&, Range&);
74     void mergeLarge(BeginTag*&, EndTag*&, Range&);
75     void mergeLargeLeft(EndTag*&, BeginTag*&, Range&, bool& hasPhysicalPages);
76     void mergeLargeRight(EndTag*&, BeginTag*&, Range&, bool& hasPhysicalPages);
77     
78     void concurrentScavenge();
79     void scavengeSmallPages(std::unique_lock<Mutex>&);
80     void scavengeMediumPages(std::unique_lock<Mutex>&);
81     void scavengeLargeRanges(std::unique_lock<Mutex>&);
82
83     Vector<SmallLine*> m_smallLines;
84     Vector<MediumLine*> m_mediumLines;
85
86     Vector<SmallPage*> m_smallPages;
87     Vector<MediumPage*> m_mediumPages;
88
89     SegregatedFreeList m_largeRanges;
90
91     bool m_isAllocatingPages;
92
93     VMHeap m_vmHeap;
94     AsyncTask<Heap, decltype(&Heap::concurrentScavenge)> m_scavenger;
95 };
96
97 inline void Heap::deallocateSmallLine(SmallLine* line)
98 {
99     SmallPage* page = SmallPage::get(line);
100     if (page->deref()) {
101         m_smallPages.push(page);
102         m_scavenger.run();
103         return;
104     }
105     m_smallLines.push(line);
106 }
107
108 inline SmallLine* Heap::allocateSmallLine(std::lock_guard<Mutex>& lock)
109 {
110     while (m_smallLines.size()) {
111         SmallLine* line = m_smallLines.pop();
112         SmallPage* page = SmallPage::get(line);
113         if (!page->refCount(lock)) // The line was promoted to the small pages list.
114             continue;
115         page->ref(lock);
116         return line;
117     }
118
119     return allocateSmallLineSlowCase(lock);
120 }
121
122 inline void Heap::deallocateMediumLine(MediumLine* line)
123 {
124     MediumPage* page = MediumPage::get(line);
125     if (page->deref()) {
126         m_mediumPages.push(page);
127         m_scavenger.run();
128         return;
129     }
130     m_mediumLines.push(line);
131 }
132
133 inline MediumLine* Heap::allocateMediumLine(std::lock_guard<Mutex>& lock)
134 {
135     while (m_mediumLines.size()) {
136         MediumLine* line = m_mediumLines.pop();
137         MediumPage* page = MediumPage::get(line);
138         if (!page->refCount(lock)) // The line was promoted to the medium pages list.
139             continue;
140         page->ref(lock);
141         return line;
142     }
143
144     return allocateMediumLineSlowCase(lock);
145 }
146
147 } // namespace bmalloc
148
149 #endif // Heap_h