55582559b927912751c3efbf8bb8009b323ce80d
[WebKit-https.git] / Source / bmalloc / bmalloc / LargeRange.h
1 /*
2  * Copyright (C) 2016-2018 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 LargeRange_h
27 #define LargeRange_h
28
29 #include "BAssert.h"
30 #include "Range.h"
31
32 namespace bmalloc {
33
34 class LargeRange : public Range {
35 public:
36     LargeRange()
37         : Range()
38         , m_startPhysicalSize(0)
39         , m_totalPhysicalSize(0)
40     {
41     }
42
43     LargeRange(const Range& other, size_t startPhysicalSize, size_t totalPhysicalSize)
44         : Range(other)
45         , m_startPhysicalSize(startPhysicalSize)
46         , m_totalPhysicalSize(totalPhysicalSize)
47     {
48         BASSERT(this->size() >= this->totalPhysicalSize());
49         BASSERT(this->totalPhysicalSize() >= this->startPhysicalSize());
50     }
51
52     LargeRange(void* begin, size_t size, size_t startPhysicalSize, size_t totalPhysicalSize)
53         : Range(begin, size)
54         , m_startPhysicalSize(startPhysicalSize)
55         , m_totalPhysicalSize(totalPhysicalSize)
56     {
57         BASSERT(this->size() >= this->totalPhysicalSize());
58         BASSERT(this->totalPhysicalSize() >= this->startPhysicalSize());
59     }
60
61     // Returns a lower bound on physical size at the start of the range. Ranges that
62     // span non-physical fragments use this number to remember the physical size of
63     // the first fragment.
64     size_t startPhysicalSize() const { return m_startPhysicalSize; }
65     void setStartPhysicalSize(size_t startPhysicalSize) { m_startPhysicalSize = startPhysicalSize; }
66
67     // This is accurate in the sense that if you take a range A and split it N ways
68     // and sum totalPhysicalSize over each of the N splits, you'll end up with A's
69     // totalPhysicalSize. This means if you take a LargeRange out of a LargeMap, split it,
70     // then insert the subsequent two ranges back into the LargeMap, the sum of the
71     // totalPhysicalSize of each LargeRange in the LargeMap will stay constant. This
72     // property is not true of startPhysicalSize. This invariant about totalPhysicalSize
73     // is good enough to get an accurate footprint estimate for memory used in bmalloc.
74     // The reason this is just an estimate is that splitting LargeRanges may lead to this
75     // number being rebalanced in arbitrary ways between the two resulting ranges. This
76     // is why the footprint is just an estimate. In practice, this arbitrary rebalance
77     // doesn't really affect accuracy.
78     size_t totalPhysicalSize() const { return m_totalPhysicalSize; }
79     void setTotalPhysicalSize(size_t totalPhysicalSize) { m_totalPhysicalSize = totalPhysicalSize; }
80
81     std::pair<LargeRange, LargeRange> split(size_t) const;
82
83     void setEligible(bool eligible) { m_isEligible = eligible; }
84     bool isEligibile() const { return m_isEligible; }
85
86     bool operator<(const void* other) const { return begin() < other; }
87     bool operator<(const LargeRange& other) const { return begin() < other.begin(); }
88
89 private:
90     size_t m_startPhysicalSize;
91     size_t m_totalPhysicalSize;
92     bool m_isEligible { true };
93 };
94
95 inline bool canMerge(const LargeRange& a, const LargeRange& b)
96 {
97     if (!a.isEligibile() || !b.isEligibile()) {
98         // FIXME: We can make this work if we find it's helpful as long as the merged
99         // range is only eligible if a and b are eligible.
100         return false;
101     }
102
103     if (a.end() == b.begin())
104         return true;
105     
106     if (b.end() == a.begin())
107         return true;
108     
109     return false;
110 }
111
112 inline LargeRange merge(const LargeRange& a, const LargeRange& b)
113 {
114     const LargeRange& left = std::min(a, b);
115     if (left.size() == left.startPhysicalSize()) {
116         return LargeRange(
117             left.begin(),
118             a.size() + b.size(),
119             a.startPhysicalSize() + b.startPhysicalSize(),
120             a.totalPhysicalSize() + b.totalPhysicalSize());
121     }
122
123     return LargeRange(
124         left.begin(),
125         a.size() + b.size(),
126         left.startPhysicalSize(),
127         a.totalPhysicalSize() + b.totalPhysicalSize());
128 }
129
130 inline std::pair<LargeRange, LargeRange> LargeRange::split(size_t leftSize) const
131 {
132     BASSERT(leftSize <= this->size());
133     size_t rightSize = this->size() - leftSize;
134
135     if (leftSize <= startPhysicalSize()) {
136         BASSERT(totalPhysicalSize() >= leftSize);
137         LargeRange left(begin(), leftSize, leftSize, leftSize);
138         LargeRange right(left.end(), rightSize, startPhysicalSize() - leftSize, totalPhysicalSize() - leftSize);
139         return std::make_pair(left, right);
140     }
141
142     double ratio = static_cast<double>(leftSize) / static_cast<double>(this->size());
143     size_t leftTotalPhysicalSize = static_cast<size_t>(ratio * totalPhysicalSize());
144     BASSERT(leftTotalPhysicalSize <= leftSize);
145     leftTotalPhysicalSize = std::max(startPhysicalSize(), leftTotalPhysicalSize);
146     size_t rightTotalPhysicalSize = totalPhysicalSize() - leftTotalPhysicalSize;
147     if (rightTotalPhysicalSize > rightSize) { // This may happen because of rounding.
148         leftTotalPhysicalSize += rightTotalPhysicalSize - rightSize;
149         BASSERT(leftTotalPhysicalSize <= leftSize);
150         rightTotalPhysicalSize = rightSize;
151     }
152
153     LargeRange left(begin(), leftSize, startPhysicalSize(), leftTotalPhysicalSize);
154     LargeRange right(left.end(), rightSize, 0, rightTotalPhysicalSize);
155     return std::make_pair(left, right);
156 }
157
158 } // namespace bmalloc
159
160 #endif // LargeRange_h