pg_bitutils.c

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * pg_bitutils.c
 *    Miscellaneous functions for bit-wise operations.
 *
 * Copyright (c) 2019-2025, PostgreSQL Global Development Group
 *
 * IDENTIFICATION
 *    src/port/pg_bitutils.c
 *
 *-------------------------------------------------------------------------
 */
#include "c.h"
 
#ifdef HAVE__GET_CPUID
#include <cpuid.h>
#endif
#ifdef HAVE__CPUID
#include <intrin.h>
#endif
 
#include "port/pg_bitutils.h"
 
 
/*
 * Array giving the position of the left-most set bit for each possible
 * byte value.  We count the right-most position as the 0th bit, and the
 * left-most the 7th bit.  The 0th entry of the array should not be used.
 *
 * Note: this is not used by the functions in pg_bitutils.h when
 * HAVE__BUILTIN_CLZ is defined, but we provide it anyway, so that
 * extensions possibly compiled with a different compiler can use it.
 */
const uint8 pg_leftmost_one_pos[256] = {
    0, 0, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3,
    4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
    5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5,
    5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5,
    6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
    6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
    6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
    6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
    7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7
};
 
/*
 * Array giving the position of the right-most set bit for each possible
 * byte value.  We count the right-most position as the 0th bit, and the
 * left-most the 7th bit.  The 0th entry of the array should not be used.
 *
 * Note: this is not used by the functions in pg_bitutils.h when
 * HAVE__BUILTIN_CTZ is defined, but we provide it anyway, so that
 * extensions possibly compiled with a different compiler can use it.
 */
const uint8 pg_rightmost_one_pos[256] = {
    0, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    7, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0
};
 
/*
 * Array giving the number of 1-bits in each possible byte value.
 *
 * Note: we export this for use by functions in which explicit use
 * of the popcount functions seems unlikely to be a win.
 */
const uint8 pg_number_of_ones[256] = {
    0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4,
    1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5,
    1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5,
    2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,
    1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5,
    2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,
    2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,
    3, 4, 4, 5, 4, 5, 5, 6, 4, 5, 5, 6, 5, 6, 6, 7,
    1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5,
    2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,
    2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,
    3, 4, 4, 5, 4, 5, 5, 6, 4, 5, 5, 6, 5, 6, 6, 7,
    2, 3, 3, 4, 3, 4, 4, 5, 3, 4, 4, 5, 4, 5, 5, 6,
    3, 4, 4, 5, 4, 5, 5, 6, 4, 5, 5, 6, 5, 6, 6, 7,
    3, 4, 4, 5, 4, 5, 5, 6, 4, 5, 5, 6, 5, 6, 6, 7,
    4, 5, 5, 6, 5, 6, 6, 7, 5, 6, 6, 7, 6, 7, 7, 8
};
 
static inline int pg_popcount32_slow(uint32 word);
static inline int pg_popcount64_slow(uint64 word);
static uint64 pg_popcount_slow(const char *buf, int bytes);
static uint64 pg_popcount_masked_slow(const char *buf, int bytes, bits8 mask);
 
#ifdef TRY_POPCNT_FAST
static bool pg_popcount_available(void);
static int  pg_popcount32_choose(uint32 word);
static int  pg_popcount64_choose(uint64 word);
static uint64 pg_popcount_choose(const char *buf, int bytes);
static uint64 pg_popcount_masked_choose(const char *buf, int bytes, bits8 mask);
static inline int pg_popcount32_fast(uint32 word);
static inline int pg_popcount64_fast(uint64 word);
static uint64 pg_popcount_fast(const char *buf, int bytes);
static uint64 pg_popcount_masked_fast(const char *buf, int bytes, bits8 mask);
 
int         (*pg_popcount32) (uint32 word) = pg_popcount32_choose;
int         (*pg_popcount64) (uint64 word) = pg_popcount64_choose;
uint64      (*pg_popcount_optimized) (const char *buf, int bytes) = pg_popcount_choose;
uint64      (*pg_popcount_masked_optimized) (const char *buf, int bytes, bits8 mask) = pg_popcount_masked_choose;
#endif                          /* TRY_POPCNT_FAST */
 
#ifdef TRY_POPCNT_FAST
 
/*
 * Return true if CPUID indicates that the POPCNT instruction is available.
 */
static bool
pg_popcount_available(void)
{
    unsigned int exx[4] = {0, 0, 0, 0};
 
#if defined(HAVE__GET_CPUID)
    __get_cpuid(1, &exx[0], &exx[1], &exx[2], &exx[3]);
#elif defined(HAVE__CPUID)
    __cpuid(exx, 1);
#else
#error cpuid instruction not available
#endif
 
    return (exx[2] & (1 << 23)) != 0;   /* POPCNT */
}
 
/*
 * These functions get called on the first call to pg_popcount32 etc.
 * They detect whether we can use the asm implementations, and replace
 * the function pointers so that subsequent calls are routed directly to
 * the chosen implementation.
 */
static inline void
choose_popcount_functions(void)
{
    if (pg_popcount_available())
    {
        pg_popcount32 = pg_popcount32_fast;
        pg_popcount64 = pg_popcount64_fast;
        pg_popcount_optimized = pg_popcount_fast;
        pg_popcount_masked_optimized = pg_popcount_masked_fast;
    }
    else
    {
        pg_popcount32 = pg_popcount32_slow;
        pg_popcount64 = pg_popcount64_slow;
        pg_popcount_optimized = pg_popcount_slow;
        pg_popcount_masked_optimized = pg_popcount_masked_slow;
    }
 
#ifdef USE_AVX512_POPCNT_WITH_RUNTIME_CHECK
    if (pg_popcount_avx512_available())
    {
        pg_popcount_optimized = pg_popcount_avx512;
        pg_popcount_masked_optimized = pg_popcount_masked_avx512;
    }
#endif
}
 
static int
pg_popcount32_choose(uint32 word)
{
    choose_popcount_functions();
    return pg_popcount32(word);
}
 
static int
pg_popcount64_choose(uint64 word)
{
    choose_popcount_functions();
    return pg_popcount64(word);
}
 
static uint64
pg_popcount_choose(const char *buf, int bytes)
{
    choose_popcount_functions();
    return pg_popcount_optimized(buf, bytes);
}
 
static uint64
pg_popcount_masked_choose(const char *buf, int bytes, bits8 mask)
{
    choose_popcount_functions();
    return pg_popcount_masked(buf, bytes, mask);
}
 
/*
 * pg_popcount32_fast
 *      Return the number of 1 bits set in word
 */
static inline int
pg_popcount32_fast(uint32 word)
{
#ifdef _MSC_VER
    return __popcnt(word);
#else
    uint32      res;
 
__asm__ __volatile__(" popcntl %1,%0\n":"=q"(res):"rm"(word):"cc");
    return (int) res;
#endif
}
 
/*
 * pg_popcount64_fast
 *      Return the number of 1 bits set in word
 */
static inline int
pg_popcount64_fast(uint64 word)
{
#ifdef _MSC_VER
    return __popcnt64(word);
#else
    uint64      res;
 
__asm__ __volatile__(" popcntq %1,%0\n":"=q"(res):"rm"(word):"cc");
    return (int) res;
#endif
}
 
/*
 * pg_popcount_fast
 *      Returns the number of 1-bits in buf
 */
static uint64
pg_popcount_fast(const char *buf, int bytes)
{
    uint64      popcnt = 0;
 
#if SIZEOF_VOID_P >= 8
    /* Process in 64-bit chunks if the buffer is aligned. */
    if (buf == (const char *) TYPEALIGN(8, buf))
    {
        const uint64 *words = (const uint64 *) buf;
 
        while (bytes >= 8)
        {
            popcnt += pg_popcount64_fast(*words++);
            bytes -= 8;
        }
 
        buf = (const char *) words;
    }
#else
    /* Process in 32-bit chunks if the buffer is aligned. */
    if (buf == (const char *) TYPEALIGN(4, buf))
    {
        const uint32 *words = (const uint32 *) buf;
 
        while (bytes >= 4)
        {
            popcnt += pg_popcount32_fast(*words++);
            bytes -= 4;
        }
 
        buf = (const char *) words;
    }
#endif
 
    /* Process any remaining bytes */
    while (bytes--)
        popcnt += pg_number_of_ones[(unsigned char) *buf++];
 
    return popcnt;
}
 
/*
 * pg_popcount_masked_fast
 *      Returns the number of 1-bits in buf after applying the mask to each byte
 */
static uint64
pg_popcount_masked_fast(const char *buf, int bytes, bits8 mask)
{
    uint64      popcnt = 0;
 
#if SIZEOF_VOID_P >= 8
    /* Process in 64-bit chunks if the buffer is aligned */
    uint64      maskv = ~UINT64CONST(0) / 0xFF * mask;
 
    if (buf == (const char *) TYPEALIGN(8, buf))
    {
        const uint64 *words = (const uint64 *) buf;
 
        while (bytes >= 8)
        {
            popcnt += pg_popcount64_fast(*words++ & maskv);
            bytes -= 8;
        }
 
        buf = (const char *) words;
    }
#else
    /* Process in 32-bit chunks if the buffer is aligned. */
    uint32      maskv = ~((uint32) 0) / 0xFF * mask;
 
    if (buf == (const char *) TYPEALIGN(4, buf))
    {
        const uint32 *words = (const uint32 *) buf;
 
        while (bytes >= 4)
        {
            popcnt += pg_popcount32_fast(*words++ & maskv);
            bytes -= 4;
        }
 
        buf = (const char *) words;
    }
#endif
 
    /* Process any remaining bytes */
    while (bytes--)
        popcnt += pg_number_of_ones[(unsigned char) *buf++ & mask];
 
    return popcnt;
}
 
#endif                          /* TRY_POPCNT_FAST */
 
 
/*
 * pg_popcount32_slow
 *      Return the number of 1 bits set in word
 */
static inline int
pg_popcount32_slow(uint32 word)
{
#ifdef HAVE__BUILTIN_POPCOUNT
    return __builtin_popcount(word);
#else                           /* !HAVE__BUILTIN_POPCOUNT */
    int         result = 0;
 
    while (word != 0)
    {
        result += pg_number_of_ones[word & 255];
        word >>= 8;
    }
 
    return result;
#endif                          /* HAVE__BUILTIN_POPCOUNT */
}
 
/*
 * pg_popcount64_slow
 *      Return the number of 1 bits set in word
 */
static inline int
pg_popcount64_slow(uint64 word)
{
#ifdef HAVE__BUILTIN_POPCOUNT
#if SIZEOF_LONG == 8
    return __builtin_popcountl(word);
#elif SIZEOF_LONG_LONG == 8
    return __builtin_popcountll(word);
#else
#error "cannot find integer of the same size as uint64_t"
#endif
#else                           /* !HAVE__BUILTIN_POPCOUNT */
    int         result = 0;
 
    while (word != 0)
    {
        result += pg_number_of_ones[word & 255];
        word >>= 8;
    }
 
    return result;
#endif                          /* HAVE__BUILTIN_POPCOUNT */
}
 
/*
 * pg_popcount_slow
 *      Returns the number of 1-bits in buf
 */
static uint64
pg_popcount_slow(const char *buf, int bytes)
{
    uint64      popcnt = 0;
 
#if SIZEOF_VOID_P >= 8
    /* Process in 64-bit chunks if the buffer is aligned. */
    if (buf == (const char *) TYPEALIGN(8, buf))
    {
        const uint64 *words = (const uint64 *) buf;
 
        while (bytes >= 8)
        {
            popcnt += pg_popcount64_slow(*words++);
            bytes -= 8;
        }
 
        buf = (const char *) words;
    }
#else
    /* Process in 32-bit chunks if the buffer is aligned. */
    if (buf == (const char *) TYPEALIGN(4, buf))
    {
        const uint32 *words = (const uint32 *) buf;
 
        while (bytes >= 4)
        {
            popcnt += pg_popcount32_slow(*words++);
            bytes -= 4;
        }
 
        buf = (const char *) words;
    }
#endif
 
    /* Process any remaining bytes */
    while (bytes--)
        popcnt += pg_number_of_ones[(unsigned char) *buf++];
 
    return popcnt;
}
 
/*
 * pg_popcount_masked_slow
 *      Returns the number of 1-bits in buf after applying the mask to each byte
 */
static uint64
pg_popcount_masked_slow(const char *buf, int bytes, bits8 mask)
{
    uint64      popcnt = 0;
 
#if SIZEOF_VOID_P >= 8
    /* Process in 64-bit chunks if the buffer is aligned */
    uint64      maskv = ~UINT64CONST(0) / 0xFF * mask;
 
    if (buf == (const char *) TYPEALIGN(8, buf))
    {
        const uint64 *words = (const uint64 *) buf;
 
        while (bytes >= 8)
        {
            popcnt += pg_popcount64_slow(*words++ & maskv);
            bytes -= 8;
        }
 
        buf = (const char *) words;
    }
#else
    /* Process in 32-bit chunks if the buffer is aligned. */
    uint32      maskv = ~((uint32) 0) / 0xFF * mask;
 
    if (buf == (const char *) TYPEALIGN(4, buf))
    {
        const uint32 *words = (const uint32 *) buf;
 
        while (bytes >= 4)
        {
            popcnt += pg_popcount32_slow(*words++ & maskv);
            bytes -= 4;
        }
 
        buf = (const char *) words;
    }
#endif
 
    /* Process any remaining bytes */
    while (bytes--)
        popcnt += pg_number_of_ones[(unsigned char) *buf++ & mask];
 
    return popcnt;
}
 
#ifndef TRY_POPCNT_FAST
 
/*
 * When the POPCNT instruction is not available, there's no point in using
 * function pointers to vary the implementation between the fast and slow
 * method.  We instead just make these actual external functions when
 * TRY_POPCNT_FAST is not defined.  The compiler should be able to inline
 * the slow versions here.
 */
int
pg_popcount32(uint32 word)
{
    return pg_popcount32_slow(word);
}
 
int
pg_popcount64(uint64 word)
{
    return pg_popcount64_slow(word);
}
 
/*
 * pg_popcount_optimized
 *      Returns the number of 1-bits in buf
 */
uint64
pg_popcount_optimized(const char *buf, int bytes)
{
    return pg_popcount_slow(buf, bytes);
}
 
/*
 * pg_popcount_masked_optimized
 *      Returns the number of 1-bits in buf after applying the mask to each byte
 */
uint64
pg_popcount_masked_optimized(const char *buf, int bytes, bits8 mask)
{
    return pg_popcount_masked_slow(buf, bytes, mask);
}
 
#endif                          /* !TRY_POPCNT_FAST */