Unreviewed, rolling out r222945.
[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 inline constexpr bool isPowerOfTwo(size_t size)
67 {
68     return size && !(size & (size - 1));
69 }
70
71 template<typename T> inline T roundUpToMultipleOf(size_t divisor, T x)
72 {
73     BASSERT(isPowerOfTwo(divisor));
74     static_assert(sizeof(T) == sizeof(uintptr_t), "sizeof(T) must be equal to sizeof(uintptr_t).");
75     return static_cast<T>((static_cast<uintptr_t>(x) + (divisor - 1)) & ~(divisor - 1));
76 }
77
78 template<size_t divisor, typename T> inline T roundUpToMultipleOf(T x)
79 {
80     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
81     return roundUpToMultipleOf(divisor, x);
82 }
83
84 template<typename T> inline T* roundUpToMultipleOf(size_t divisor, T* x)
85 {
86     BASSERT(isPowerOfTwo(divisor));
87     return reinterpret_cast<T*>((reinterpret_cast<uintptr_t>(x) + (divisor - 1)) & ~(divisor - 1));
88 }
89
90 template<size_t divisor, typename T> inline T* roundUpToMultipleOf(T* x)
91 {
92     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
93     return roundUpToMultipleOf(divisor, x);
94 }
95
96 template<typename T> inline T roundDownToMultipleOf(size_t divisor, T x)
97 {
98     BASSERT(isPowerOfTwo(divisor));
99     return reinterpret_cast<T>(mask(reinterpret_cast<uintptr_t>(x), ~(divisor - 1ul)));
100 }
101
102 template<size_t divisor, typename T> inline constexpr T roundDownToMultipleOf(T x)
103 {
104     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
105     return roundDownToMultipleOf(divisor, x);
106 }
107
108 template<typename T> inline void divideRoundingUp(T numerator, T denominator, T& quotient, T& remainder)
109 {
110     // We expect the compiler to emit a single divide instruction to extract both the quotient and the remainder.
111     quotient = numerator / denominator;
112     remainder = numerator % denominator;
113     if (remainder)
114         quotient += 1;
115 }
116
117 template<typename T> inline T divideRoundingUp(T numerator, T denominator)
118 {
119     return (numerator + denominator - 1) / denominator;
120 }
121
122 template<typename T> inline T roundUpToMultipleOfNonPowerOfTwo(size_t divisor, T x)
123 {
124     return divideRoundingUp(x, divisor) * divisor;
125 }
126
127 // Version of sizeof that returns 0 for empty classes.
128
129 template<typename T> inline constexpr size_t sizeOf()
130 {
131     return std::is_empty<T>::value ? 0 : sizeof(T);
132 }
133
134 template<typename T> inline constexpr size_t bitCount()
135 {
136     return sizeof(T) * 8;
137 }
138
139 #if BOS(WINDOWS)
140 template<int depth> __forceinline constexpr unsigned long clzl(unsigned long value)
141 {
142     return value & (1UL << (bitCount<unsigned long>() - 1)) ? 0 : 1 + clzl<depth - 1>(value << 1);
143 }
144
145 template<> __forceinline constexpr unsigned long clzl<1>(unsigned long value)
146 {
147     return 0;
148 }
149
150 __forceinline constexpr unsigned long __builtin_clzl(unsigned long value)
151 {
152     return value == 0 ? 32 : clzl<bitCount<unsigned long>()>(value);
153 }
154 #endif
155
156 inline constexpr unsigned long log2(unsigned long value)
157 {
158     return bitCount<unsigned long>() - 1 - __builtin_clzl(value);
159 }
160
161 } // namespace bmalloc
162
163 #endif // Algorithm_h