bmalloc
[WebKit-https.git] / Source / bmalloc / bmalloc / BoundaryTag.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 BoundaryTag_h
27 #define BoundaryTag_h
28
29 #include "BAssert.h"
30 #include "Sizes.h"
31
32 namespace bmalloc {
33
34 class BeginTag;
35 class EndTag;
36 class LargeChunk;
37 class Range;
38
39 class BoundaryTag {
40 public:
41     static Range init(LargeChunk*);
42     static Range deallocate(void*);
43     static void allocate(size_t, Range&, Range& leftover, bool& hasPhysicalPages);
44
45     bool isXLarge() { return m_size == xLargeMarker; }
46     void setXLarge() { m_size = xLargeMarker; }
47
48     bool isFree() { return m_isFree; }
49     void setFree(bool isFree) { m_isFree = isFree; }
50     
51     bool isEnd() { return m_isEnd; }
52     void setEnd(bool isEnd) { m_isEnd = isEnd; }
53
54     bool hasPhysicalPages() { return m_hasPhysicalPages; }
55     void setHasPhysicalPages(bool hasPhysicalPages) { m_hasPhysicalPages = hasPhysicalPages; }
56
57     bool isNull() { return !m_size; }
58     void clear() { memset(this, 0, sizeof(*this)); }
59     
60     size_t size() { return m_size; }
61     void setSize(size_t);
62     
63     EndTag* prev();
64     BeginTag* next();
65
66 private:
67     static const size_t flagBits = 3;
68     static const size_t sizeBits = bitCount<unsigned>() - flagBits;
69     static const size_t xLargeMarker = 1; // This size is unused because our minimum object size is greater than it.
70
71     static_assert(largeMin > xLargeMarker, "largeMin must provide enough umbrella to fit xLargeMarker.");
72     static_assert((1 << sizeBits) - 1 >= largeMax, "largeMax must be encodable in a BoundaryTag.");
73
74     static void splitLarge(BeginTag*, size_t size, EndTag*& endTag, Range&, Range& leftover);
75     static void mergeLargeLeft(EndTag*& prev, BeginTag*& beginTag, Range&, bool& hasPhysicalPages);
76     static void mergeLargeRight(EndTag*&, BeginTag*& next, Range&, bool& hasPhysicalPages);
77     static void mergeLarge(BeginTag*&, EndTag*&, Range&);
78
79     bool m_isFree: 1;
80     bool m_isEnd: 1;
81     bool m_hasPhysicalPages: 1;
82     unsigned m_size: sizeBits;
83 };
84
85 inline void BoundaryTag::setSize(size_t size)
86 {
87     m_size = static_cast<unsigned>(size);
88     ASSERT(this->size() == size);
89     ASSERT(!isXLarge());
90 }
91
92 inline EndTag* BoundaryTag::prev()
93 {
94     BoundaryTag* prev = this - 1;
95     return reinterpret_cast<EndTag*>(prev);
96 }
97
98 inline BeginTag* BoundaryTag::next()
99 {
100     BoundaryTag* next = this + 1;
101     return reinterpret_cast<BeginTag*>(next);
102 }
103
104 } // namespace bmalloc
105
106 #endif // BoundaryTag_h