726e27f121f52ed9a02f78d5558866cc1bf0d78c
[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 "MediumChunk.h"
33 #include "MediumLine.h"
34 #include "MediumPage.h"
35 #include "Mutex.h"
36 #include "SegregatedFreeList.h"
37 #include "SmallChunk.h"
38 #include "SmallLine.h"
39 #include "SmallPage.h"
40 #include "VMHeap.h"
41 #include "Vector.h"
42 #include <array>
43 #include <mutex>
44
45 namespace bmalloc {
46
47 class BeginTag;
48 class BumpAllocator;
49 class EndTag;
50
51 class Heap {
52 public:
53     Heap(std::lock_guard<StaticMutex>&);
54     
55     Environment& environment() { return m_environment; }
56
57     void allocateSmallBumpRanges(std::lock_guard<StaticMutex>&, size_t sizeClass, BumpAllocator&, BumpRangeCache&);
58     void derefSmallLine(std::lock_guard<StaticMutex>&, SmallLine*);
59
60     void allocateMediumBumpRanges(std::lock_guard<StaticMutex>&, size_t sizeClass, BumpAllocator&, BumpRangeCache&);
61     void derefMediumLine(std::lock_guard<StaticMutex>&, MediumLine*);
62
63     void* allocateLarge(std::lock_guard<StaticMutex>&, size_t);
64     void* allocateLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t, size_t unalignedSize);
65     void deallocateLarge(std::lock_guard<StaticMutex>&, void*);
66
67     void* allocateXLarge(std::lock_guard<StaticMutex>&, size_t);
68     void* allocateXLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t);
69     void* tryAllocateXLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t);
70     Range& findXLarge(std::unique_lock<StaticMutex>&, void*);
71     void deallocateXLarge(std::unique_lock<StaticMutex>&, void*);
72
73     void scavenge(std::unique_lock<StaticMutex>&, std::chrono::milliseconds sleepDuration);
74
75 private:
76     ~Heap() = delete;
77     
78     void initializeLineMetadata();
79
80     SmallPage* allocateSmallPage(std::lock_guard<StaticMutex>&, size_t sizeClass);
81     MediumPage* allocateMediumPage(std::lock_guard<StaticMutex>&, size_t sizeClass);
82
83     void deallocateSmallLine(std::lock_guard<StaticMutex>&, SmallLine*);
84     void deallocateMediumLine(std::lock_guard<StaticMutex>&, MediumLine*);
85
86     void deallocateLarge(std::lock_guard<StaticMutex>&, const LargeObject&);
87
88     LargeObject& splitAndAllocate(LargeObject&, size_t);
89     LargeObject& splitAndAllocate(LargeObject&, size_t, size_t);
90     void mergeLarge(BeginTag*&, EndTag*&, Range&);
91     void mergeLargeLeft(EndTag*&, BeginTag*&, Range&, bool& inVMHeap);
92     void mergeLargeRight(EndTag*&, BeginTag*&, Range&, bool& inVMHeap);
93     
94     void concurrentScavenge();
95     void scavengeSmallPages(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
96     void scavengeMediumPages(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
97     void scavengeLargeObjects(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
98
99     std::array<std::array<LineMetadata, SmallPage::lineCount>, smallMax / alignment> m_smallLineMetadata;
100     std::array<std::array<LineMetadata, MediumPage::lineCount>, mediumMax / alignment> m_mediumLineMetadata;
101
102     std::array<Vector<SmallPage*>, smallMax / alignment> m_smallPagesWithFreeLines;
103     std::array<Vector<MediumPage*>, mediumMax / alignment> m_mediumPagesWithFreeLines;
104
105     Vector<SmallPage*> m_smallPages;
106     Vector<MediumPage*> m_mediumPages;
107
108     SegregatedFreeList m_largeObjects;
109     Vector<Range> m_xLargeObjects;
110
111     bool m_isAllocatingPages;
112     AsyncTask<Heap, decltype(&Heap::concurrentScavenge)> m_scavenger;
113
114     Environment m_environment;
115
116     VMHeap m_vmHeap;
117 };
118
119 inline void Heap::derefSmallLine(std::lock_guard<StaticMutex>& lock, SmallLine* line)
120 {
121     if (!line->deref(lock))
122         return;
123     deallocateSmallLine(lock, line);
124 }
125
126 inline void Heap::derefMediumLine(std::lock_guard<StaticMutex>& lock, MediumLine* line)
127 {
128     if (!line->deref(lock))
129         return;
130     deallocateMediumLine(lock, line);
131 }
132
133 } // namespace bmalloc
134
135 #endif // Heap_h