ClickHouse/src/Common/BitHelpers.h

107 lines
2.1 KiB
C++
Raw Normal View History

2016-03-07 06:18:06 +00:00
#pragma once
#include <cstddef>
#include <type_traits>
#include <common/defines.h>
/** Returns log2 of number, rounded down.
* Compiles to single 'bsr' instruction on x86.
* For zero argument, result is unspecified.
*/
inline unsigned int bitScanReverse(unsigned int x)
2016-03-07 06:18:06 +00:00
{
return sizeof(unsigned int) * 8 - 1 - __builtin_clz(x);
2016-03-07 06:18:06 +00:00
}
/** For zero argument, result is zero.
* For arguments with most significand bit set, result is n.
* For other arguments, returns value, rounded up to power of two.
*/
inline size_t roundUpToPowerOfTwoOrZero(size_t n)
{
// if MSB is set, return n, to avoid return zero
2020-08-02 16:09:51 +00:00
if (unlikely(n >= 0x8000000000000000ULL))
return n;
--n;
n |= n >> 1;
n |= n >> 2;
n |= n >> 4;
n |= n >> 8;
n |= n >> 16;
n |= n >> 32;
++n;
return n;
}
template <typename T>
inline size_t getLeadingZeroBits(T x)
{
if (!x)
return sizeof(x) * 8;
if constexpr (sizeof(T) <= sizeof(unsigned int))
{
return __builtin_clz(x);
}
else if constexpr (sizeof(T) <= sizeof(unsigned long int))
{
return __builtin_clzl(x);
}
else
{
return __builtin_clzll(x);
}
}
// Unsafe since __builtin_ctz()-family explicitly state that result is undefined on x == 0
template <typename T>
inline size_t getTrailingZeroBitsUnsafe(T x)
{
if constexpr (sizeof(T) <= sizeof(unsigned int))
{
return __builtin_ctz(x);
}
else if constexpr (sizeof(T) <= sizeof(unsigned long int))
{
return __builtin_ctzl(x);
}
else
{
return __builtin_ctzll(x);
}
}
template <typename T>
inline size_t getTrailingZeroBits(T x)
{
if (!x)
return sizeof(x) * 8;
return getTrailingZeroBitsUnsafe(x);
}
/** Returns a mask that has '1' for `bits` LSB set:
* maskLowBits<UInt8>(3) => 00000111
*/
template <typename T>
inline T maskLowBits(unsigned char bits)
{
2019-06-19 15:32:13 +00:00
if (bits == 0)
{
return 0;
}
T result = static_cast<T>(~T{0});
if (bits < sizeof(T) * 8)
{
result = static_cast<T>(result >> (sizeof(T) * 8 - bits));
}
return result;
}