Enable gigacage on iOS with a 32GB runway and ensure it doesn't break WasmBench
[WebKit-https.git] / Source / bmalloc / bmalloc / Algorithm.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 Algorithm_h
27 #define Algorithm_h
28
29 #include "BAssert.h"
30 #include <algorithm>
31 #include <cstdint>
32 #include <cstddef>
33 #include <limits>
34 #include <type_traits>
35 #include <chrono>
36
37 namespace bmalloc {
38
39 // Versions of min and max that are compatible with compile-time constants.
40 template<typename T> inline constexpr T max(T a, T b)
41 {
42     return a > b ? a : b;
43 }
44     
45 template<typename T> inline constexpr T min(T a, T b)
46 {
47     return a < b ? a : b;
48 }
49
50 template<typename T> inline constexpr T mask(T value, uintptr_t mask)
51 {
52     static_assert(sizeof(T) == sizeof(uintptr_t), "sizeof(T) must be equal to sizeof(uintptr_t).");
53     return static_cast<T>(static_cast<uintptr_t>(value) & mask);
54 }
55
56 template<typename T> inline T* mask(T* value, uintptr_t mask)
57 {
58     return reinterpret_cast<T*>(reinterpret_cast<uintptr_t>(value) & mask);
59 }
60
61 template<typename T> inline constexpr bool test(T value, uintptr_t mask)
62 {
63     return !!(reinterpret_cast<uintptr_t>(value) & mask);
64 }
65
66 template <typename T>
67 inline constexpr bool isPowerOfTwo(T size)
68 {
69     static_assert(std::is_integral<T>::value, "");
70     return size && !(size & (size - 1));
71 }
72
73 template<typename T> inline T roundUpToMultipleOf(size_t divisor, T x)
74 {
75     BASSERT(isPowerOfTwo(divisor));
76     static_assert(sizeof(T) == sizeof(uintptr_t), "sizeof(T) must be equal to sizeof(uintptr_t).");
77     return static_cast<T>((static_cast<uintptr_t>(x) + (divisor - 1)) & ~(divisor - 1));
78 }
79
80 template<size_t divisor, typename T> inline T roundUpToMultipleOf(T x)
81 {
82     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
83     return roundUpToMultipleOf(divisor, x);
84 }
85
86 template<typename T> inline T* roundUpToMultipleOf(size_t divisor, T* x)
87 {
88     BASSERT(isPowerOfTwo(divisor));
89     return reinterpret_cast<T*>((reinterpret_cast<uintptr_t>(x) + (divisor - 1)) & ~(divisor - 1));
90 }
91
92 template<size_t divisor, typename T> inline T* roundUpToMultipleOf(T* x)
93 {
94     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
95     return roundUpToMultipleOf(divisor, x);
96 }
97
98 template<typename T> inline T roundDownToMultipleOf(size_t divisor, T x)
99 {
100     BASSERT(isPowerOfTwo(divisor));
101     return reinterpret_cast<T>(mask(reinterpret_cast<uintptr_t>(x), ~(divisor - 1ul)));
102 }
103
104 template<size_t divisor, typename T> inline constexpr T roundDownToMultipleOf(T x)
105 {
106     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
107     return roundDownToMultipleOf(divisor, x);
108 }
109
110 template<typename T> inline void divideRoundingUp(T numerator, T denominator, T& quotient, T& remainder)
111 {
112     // We expect the compiler to emit a single divide instruction to extract both the quotient and the remainder.
113     quotient = numerator / denominator;
114     remainder = numerator % denominator;
115     if (remainder)
116         quotient += 1;
117 }
118
119 template<typename T> inline T divideRoundingUp(T numerator, T denominator)
120 {
121     return (numerator + denominator - 1) / denominator;
122 }
123
124 template<typename T> inline T roundUpToMultipleOfNonPowerOfTwo(size_t divisor, T x)
125 {
126     return divideRoundingUp(x, divisor) * divisor;
127 }
128
129 // Version of sizeof that returns 0 for empty classes.
130
131 template<typename T> inline constexpr size_t sizeOf()
132 {
133     return std::is_empty<T>::value ? 0 : sizeof(T);
134 }
135
136 template<typename T> inline constexpr size_t bitCount()
137 {
138     return sizeof(T) * 8;
139 }
140
141 #if BOS(WINDOWS)
142 template<int depth> __forceinline constexpr unsigned long clzl(unsigned long value)
143 {
144     return value & (1UL << (bitCount<unsigned long>() - 1)) ? 0 : 1 + clzl<depth - 1>(value << 1);
145 }
146
147 template<> __forceinline constexpr unsigned long clzl<1>(unsigned long value)
148 {
149     return 0;
150 }
151
152 __forceinline constexpr unsigned long __builtin_clzl(unsigned long value)
153 {
154     return value == 0 ? 32 : clzl<bitCount<unsigned long>()>(value);
155 }
156 #endif
157
158 inline constexpr unsigned long log2(unsigned long value)
159 {
160     return bitCount<unsigned long>() - 1 - __builtin_clzl(value);
161 }
162
163 #define BOFFSETOF(class, field) (reinterpret_cast<ptrdiff_t>(&(reinterpret_cast<class*>(0x4000)->field)) - 0x4000)
164
165 template<typename T>
166 bool findBitInWord(T word, size_t& index, size_t endIndex, bool value)
167 {
168     static_assert(std::is_unsigned<T>::value, "Type used in findBitInWord must be unsigned");
169     
170     word >>= index;
171     
172     while (index < endIndex) {
173         if ((word & 1) == static_cast<T>(value))
174             return true;
175         index++;
176         word >>= 1;
177     }
178     
179     index = endIndex;
180     return false;
181 }
182
183 } // namespace bmalloc
184
185 #endif // Algorithm_h