bmalloc: Allocation should be more precise
[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 <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     return reinterpret_cast<T>(reinterpret_cast<uintptr_t>(value) & mask);
53 }
54
55 template<typename T> inline constexpr T rightShift(T value, uintptr_t shift)
56 {
57     return reinterpret_cast<T>(reinterpret_cast<uintptr_t>(value) >> shift);
58 }
59
60 template<typename T> inline constexpr bool test(T value, uintptr_t mask)
61 {
62     return !!(reinterpret_cast<uintptr_t>(value) & mask);
63 }
64
65 template<size_t divisor, typename T> inline constexpr T roundUpToMultipleOf(T x)
66 {
67     static_assert(divisor && !(divisor & (divisor - 1)), "'divisor' must be a power of two.");
68     return reinterpret_cast<T>((reinterpret_cast<uintptr_t>(x) + (divisor - 1ul)) & ~(divisor - 1ul));
69 }
70
71 template<size_t divisor, typename T> inline constexpr T roundDownToMultipleOf(T x)
72 {
73     static_assert(divisor && !(divisor & (divisor - 1)), "'divisor' must be a power of two.");
74     return reinterpret_cast<T>(mask(reinterpret_cast<uintptr_t>(x), ~(divisor - 1ul)));
75 }
76
77 template<typename T> void divideRoundingUp(T numerator, T denominator, T& quotient, T& remainder)
78 {
79     // We expect the compiler to emit a single divide instruction to extract both the quotient and the remainder.
80     quotient = numerator / denominator;
81     remainder = numerator % denominator;
82     if (remainder)
83         quotient += 1;
84 }
85
86 // Version of sizeof that returns 0 for empty classes.
87
88 template<typename T> inline constexpr size_t sizeOf()
89 {
90     return std::is_empty<T>::value ? 0 : sizeof(T);
91 }
92
93 template<typename T> inline constexpr size_t bitCount()
94 {
95     return sizeof(T) * 8;
96 }
97
98 inline constexpr bool isPowerOfTwo(size_t size)
99 {
100     return !(size & (size - 1));
101 }
102
103 } // namespace bmalloc
104
105 #endif // Algorithm_h