aboutsummaryrefslogtreecommitdiffstats
path: root/common/opthelpers.h
blob: 0b8b821048ea6b87621d699cdaa06cdad076fb39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
#ifndef OPTHELPERS_H
#define OPTHELPERS_H

#ifdef __has_builtin
#define HAS_BUILTIN __has_builtin
#else
#define HAS_BUILTIN(x) (0)
#endif

#if defined(__GNUC__) || HAS_BUILTIN(__builtin_expect)
/* likely() optimizes for the case where the condition is true. The condition
 * is not required to be true, but it can result in more optimal code for the
 * true path at the expense of a less optimal false path.
 */
template<typename T>
constexpr bool likely(T&& expr) noexcept
{ return __builtin_expect(static_cast<bool>(expr), true); }
/* The opposite of likely(), optimizing for the case where the condition is
 * false.
 */
template<typename T>
constexpr bool unlikely(T&& expr) noexcept
{ return __builtin_expect(static_cast<bool>(expr), false); }

#else

template<typename T>
constexpr bool likely(T&& expr) noexcept { return static_cast<bool>(expr); }
template<typename T>
constexpr bool unlikely(T&& expr) noexcept { return static_cast<bool>(expr); }
#endif
#define LIKELY(x) (likely(x))
#define UNLIKELY(x) (unlikely(x))

#if HAS_BUILTIN(__builtin_assume)
/* Unlike LIKELY, ASSUME requires the condition to be true or else it invokes
 * undefined behavior. It's essentially an assert without actually checking the
 * condition at run-time, allowing for stronger optimizations than LIKELY.
 */
#define ASSUME __builtin_assume
#elif defined(_MSC_VER)
#define ASSUME __assume
#elif defined(__GNUC__)
#define ASSUME(x) do { if(!(x)) __builtin_unreachable(); } while(0)
#else
#define ASSUME(x) ((void)0)
#endif

#if __cplusplus >= 201703L || defined(__cpp_if_constexpr)
#define if_constexpr if constexpr
#else
#define if_constexpr if
#endif

#endif /* OPTHELPERS_H */