bmalloc: stress_aligned test fails if you increase smallMax
[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 "Algorithm.h"
30 #include "BAssert.h"
31 #include <algorithm>
32 #include <cstdint>
33 #include <cstddef>
34 #include <limits>
35 #include <type_traits>
36 #include <chrono>
37
38 namespace bmalloc {
39
40 // Versions of min and max that are compatible with compile-time constants.
41 template<typename T> inline constexpr T max(T a, T b)
42 {
43     return a > b ? a : b;
44 }
45     
46 template<typename T> inline constexpr T min(T a, T b)
47 {
48     return a < b ? a : b;
49 }
50
51 template<typename T> inline constexpr T mask(T value, uintptr_t mask)
52 {
53     return reinterpret_cast<T>(reinterpret_cast<uintptr_t>(value) & mask);
54 }
55
56 template<typename T> inline constexpr bool test(T value, uintptr_t mask)
57 {
58     return !!(reinterpret_cast<uintptr_t>(value) & mask);
59 }
60
61 inline constexpr bool isPowerOfTwo(size_t size)
62 {
63     return size && !(size & (size - 1));
64 }
65
66 template<typename T> inline T roundUpToMultipleOf(size_t divisor, T x)
67 {
68     BASSERT(isPowerOfTwo(divisor));
69     return reinterpret_cast<T>((reinterpret_cast<uintptr_t>(x) + (divisor - 1)) & ~(divisor - 1));
70 }
71
72 template<size_t divisor, typename T> inline constexpr T roundUpToMultipleOf(T x)
73 {
74     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
75     return roundUpToMultipleOf(divisor, x);
76 }
77
78 template<typename T> inline T roundDownToMultipleOf(size_t divisor, T x)
79 {
80     BASSERT(isPowerOfTwo(divisor));
81     return reinterpret_cast<T>(mask(reinterpret_cast<uintptr_t>(x), ~(divisor - 1ul)));
82 }
83
84 template<size_t divisor, typename T> inline constexpr T roundDownToMultipleOf(T x)
85 {
86     static_assert(isPowerOfTwo(divisor), "'divisor' must be a power of two.");
87     return roundDownToMultipleOf(divisor, x);
88 }
89
90 template<typename T> inline void divideRoundingUp(T numerator, T denominator, T& quotient, T& remainder)
91 {
92     // We expect the compiler to emit a single divide instruction to extract both the quotient and the remainder.
93     quotient = numerator / denominator;
94     remainder = numerator % denominator;
95     if (remainder)
96         quotient += 1;
97 }
98
99 template<typename T> inline T divideRoundingUp(T numerator, T denominator)
100 {
101     return (numerator + denominator - 1) / denominator;
102 }
103
104 // Version of sizeof that returns 0 for empty classes.
105
106 template<typename T> inline constexpr size_t sizeOf()
107 {
108     return std::is_empty<T>::value ? 0 : sizeof(T);
109 }
110
111 template<typename T> inline constexpr size_t bitCount()
112 {
113     return sizeof(T) * 8;
114 }
115
116 inline constexpr unsigned long log2(unsigned long value)
117 {
118     return bitCount<unsigned long>() - 1 - __builtin_clzl(value);
119 }
120
121 } // namespace bmalloc
122
123 #endif // Algorithm_h