72cd6d2a29b691462724857a58ef2854cffa9b9c
[WebKit.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 "List.h"
33 #include "Mutex.h"
34 #include "Object.h"
35 #include "SegregatedFreeList.h"
36 #include "SmallLine.h"
37 #include "SmallPage.h"
38 #include "VMHeap.h"
39 #include "Vector.h"
40 #include "XLargeMap.h"
41 #include <array>
42 #include <mutex>
43
44 namespace bmalloc {
45
46 class BeginTag;
47 class BumpAllocator;
48 class EndTag;
49
50 class Heap {
51 public:
52     Heap(std::lock_guard<StaticMutex>&);
53     
54     Environment& environment() { return m_environment; }
55
56     void allocateSmallBumpRanges(std::lock_guard<StaticMutex>&, size_t sizeClass, BumpAllocator&, BumpRangeCache&);
57     void derefSmallLine(std::lock_guard<StaticMutex>&, Object);
58
59     void* allocateLarge(std::lock_guard<StaticMutex>&, size_t);
60     void* allocateLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t, size_t unalignedSize);
61     void shrinkLarge(std::lock_guard<StaticMutex>&, LargeObject&, size_t);
62
63     void* allocateXLarge(std::lock_guard<StaticMutex>&, size_t);
64     void* allocateXLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t);
65     void* tryAllocateXLarge(std::lock_guard<StaticMutex>&, size_t alignment, size_t);
66     size_t xLargeSize(std::unique_lock<StaticMutex>&, void*);
67     void shrinkXLarge(std::unique_lock<StaticMutex>&, const Range&, size_t newSize);
68     void deallocateXLarge(std::unique_lock<StaticMutex>&, void*);
69
70     void scavenge(std::unique_lock<StaticMutex>&, std::chrono::milliseconds sleepDuration);
71
72 private:
73     ~Heap() = delete;
74     
75     void initializeLineMetadata();
76     void initializePageMetadata();
77
78     void allocateSmallBumpRangesByMetadata(std::lock_guard<StaticMutex>&,
79         size_t sizeClass, BumpAllocator&, BumpRangeCache&);
80     void allocateSmallBumpRangesByObject(std::lock_guard<StaticMutex>&,
81         size_t sizeClass, BumpAllocator&, BumpRangeCache&);
82
83     SmallPage* allocateSmallPage(std::lock_guard<StaticMutex>&, size_t sizeClass);
84
85     void deallocateSmallLine(std::lock_guard<StaticMutex>&, Object);
86     void deallocateLarge(std::lock_guard<StaticMutex>&, const LargeObject&);
87
88     LargeObject& splitAndAllocate(std::lock_guard<StaticMutex>&, LargeObject&, size_t);
89     LargeObject& splitAndAllocate(std::lock_guard<StaticMutex>&, 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     XLargeRange splitAndAllocate(XLargeRange&, size_t alignment, size_t);
95
96     void concurrentScavenge();
97     void scavengeSmallPages(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
98     void scavengeLargeObjects(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
99     void scavengeXLargeObjects(std::unique_lock<StaticMutex>&, std::chrono::milliseconds);
100
101     size_t m_vmPageSizePhysical;
102     Vector<LineMetadata> m_smallLineMetadata;
103     std::array<size_t, sizeClassCount> m_pageClasses;
104
105     std::array<List<SmallPage>, sizeClassCount> m_smallPagesWithFreeLines;
106     std::array<List<SmallPage>, pageClassCount> m_smallPages;
107
108     SegregatedFreeList m_largeObjects;
109     
110     XLargeMap m_xLargeMap;
111
112     bool m_isAllocatingPages;
113     AsyncTask<Heap, decltype(&Heap::concurrentScavenge)> m_scavenger;
114
115     Environment m_environment;
116
117     VMHeap m_vmHeap;
118 };
119
120 inline void Heap::allocateSmallBumpRanges(
121     std::lock_guard<StaticMutex>& lock, size_t sizeClass,
122     BumpAllocator& allocator, BumpRangeCache& rangeCache)
123 {
124     if (sizeClass < bmalloc::sizeClass(smallLineSize))
125         return allocateSmallBumpRangesByMetadata(lock, sizeClass, allocator, rangeCache);
126     return allocateSmallBumpRangesByObject(lock, sizeClass, allocator, rangeCache);
127 }
128
129 inline void Heap::derefSmallLine(std::lock_guard<StaticMutex>& lock, Object object)
130 {
131     if (!object.line()->deref(lock))
132         return;
133     deallocateSmallLine(lock, object);
134 }
135
136 } // namespace bmalloc
137
138 #endif // Heap_h