/*

 * x86/cpu_features.h - feature detection for x86 CPUs

 *

 * Copyright 2016 Eric Biggers

 *

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use,

 * copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following

 * conditions:

 *

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 * OTHER DEALINGS IN THE SOFTWARE.

 */

#ifndef LIB_X86_CPU_FEATURES_H

#define LIB_X86_CPU_FEATURES_H

#include "../lib_common.h"

#if defined(ARCH_X86_32) || defined(ARCH_X86_64)

#define X86_CPU_FEATURE_SSE2    (1 << 0)

#define X86_CPU_FEATURE_PCLMULQDQ (1 << 1)

#define X86_CPU_FEATURE_AVX   (1 << 2)

#define X86_CPU_FEATURE_AVX2    (1 << 3)

#define X86_CPU_FEATURE_BMI2    (1 << 4)

/*

 * ZMM indicates whether 512-bit vectors (zmm registers) should be used.  On

 * some CPUs, to avoid downclocking issues we don't set ZMM even if the CPU and

 * operating system support AVX-512.  On these CPUs, we may still use AVX-512

 * instructions, but only with xmm and ymm registers.

 */

#define X86_CPU_FEATURE_ZMM   (1 << 5)

#define X86_CPU_FEATURE_AVX512BW  (1 << 6)

#define X86_CPU_FEATURE_AVX512VL  (1 << 7)

#define X86_CPU_FEATURE_VPCLMULQDQ  (1 << 8)

#define X86_CPU_FEATURE_AVX512VNNI  (1 << 9)

#define X86_CPU_FEATURE_AVXVNNI   (1 << 10)

#if defined(__GNUC__) || defined(__clang__) || defined(_MSC_VER)

/* Runtime x86 CPU feature detection is supported. */

#  define X86_CPU_FEATURES_KNOWN  (1U << 31)

extern LIBDEFLATE_ATOMIC(u32) libdeflate_x86_cpu_features;

void libdeflate_init_x86_cpu_features(void);

static inline u32 get_x86_cpu_features(void)

{

  u32 features = LIBDEFLATE_ATOMIC_LOAD_RELAXED(&libdeflate_x86_cpu_features);

  if (features == 0) {

    libdeflate_init_x86_cpu_features();

    features = LIBDEFLATE_ATOMIC_LOAD_RELAXED(&libdeflate_x86_cpu_features);

  }

  return features;

}

Unexecuted instantiation: deflate_compress.c:get_x86_cpu_features

Unexecuted instantiation: cpu_features.c:get_x86_cpu_features

deflate_decompress.c:get_x86_cpu_features

Line

Count

Source

61

6

{

62

6

  u32 features = LIBDEFLATE_ATOMIC_LOAD_RELAXED(&libdeflate_x86_cpu_features);

63

64

6

  if (features == 0) {

65

6

    libdeflate_init_x86_cpu_features();

66

    features = LIBDEFLATE_ATOMIC_LOAD_RELAXED(&libdeflate_x86_cpu_features);

67

6

  }

68

6

  return features;

69

6

}

adler32.c:get_x86_cpu_features

Line

Count

Source

61

5

{

62

5

  u32 features = LIBDEFLATE_ATOMIC_LOAD_RELAXED(&libdeflate_x86_cpu_features);

63

64

5

  if (features == 0) {

65

0

    libdeflate_init_x86_cpu_features();

66

    features = LIBDEFLATE_ATOMIC_LOAD_RELAXED(&libdeflate_x86_cpu_features);

67

0

  }

68

5

  return features;

69

5

}

/*

 * x86 intrinsics are also supported.  Include the headers needed to use them.

 * Normally just immintrin.h suffices.  With clang in MSVC compatibility mode,

 * immintrin.h incorrectly skips including sub-headers, so include those too.

 */

#  include <immintrin.h>

#  if defined(_MSC_VER) && defined(__clang__)

#    include <tmmintrin.h>

#    include <smmintrin.h>

#    include <wmmintrin.h>

#    include <avxintrin.h>

#    include <avx2intrin.h>

#    include <avx512fintrin.h>

#    include <avx512bwintrin.h>

#    include <avx512vlintrin.h>

#    if __has_include(<avx512vlbwintrin.h>)

#      include <avx512vlbwintrin.h>

#    endif

#    if __has_include(<vpclmulqdqintrin.h>)

#      include <vpclmulqdqintrin.h>

#    endif

#    if __has_include(<avx512vnniintrin.h>)

#      include <avx512vnniintrin.h>

#    endif

#    if __has_include(<avx512vlvnniintrin.h>)

#      include <avx512vlvnniintrin.h>

#    endif

#    if __has_include(<avxvnniintrin.h>)

#      include <avxvnniintrin.h>

#    endif

#  endif

#else

static inline u32 get_x86_cpu_features(void) { return 0; }

#endif

#if defined(__SSE2__) || \

  (defined(_MSC_VER) && \

   (defined(ARCH_X86_64) || (defined(_M_IX86_FP) && _M_IX86_FP >= 2)))

#  define HAVE_SSE2(features)   1

#  define HAVE_SSE2_NATIVE    1

#else

#  define HAVE_SSE2(features)   ((features) & X86_CPU_FEATURE_SSE2)

#  define HAVE_SSE2_NATIVE    0

#endif

#if (defined(__PCLMUL__) && defined(__SSE4_1__)) || \

  (defined(_MSC_VER) && defined(__AVX2__))

#  define HAVE_PCLMULQDQ(features)  1

#else

#  define HAVE_PCLMULQDQ(features)  ((features) & X86_CPU_FEATURE_PCLMULQDQ)

#endif

#ifdef __AVX__

#  define HAVE_AVX(features)    1

#else

#  define HAVE_AVX(features)    ((features) & X86_CPU_FEATURE_AVX)

#endif

#ifdef __AVX2__

#  define HAVE_AVX2(features)   1

#else

#  define HAVE_AVX2(features)   ((features) & X86_CPU_FEATURE_AVX2)

#endif

#if defined(__BMI2__) || (defined(_MSC_VER) && defined(__AVX2__))

#  define HAVE_BMI2(features)   1

#  define HAVE_BMI2_NATIVE    1

#else

#  define HAVE_BMI2(features)   ((features) & X86_CPU_FEATURE_BMI2)

#  define HAVE_BMI2_NATIVE    0

#endif

#ifdef __AVX512BW__

#  define HAVE_AVX512BW(features) 1

#else

#  define HAVE_AVX512BW(features) ((features) & X86_CPU_FEATURE_AVX512BW)

#endif

#ifdef __AVX512VL__

#  define HAVE_AVX512VL(features) 1

#else

#  define HAVE_AVX512VL(features) ((features) & X86_CPU_FEATURE_AVX512VL)

#endif

#ifdef __VPCLMULQDQ__

#  define HAVE_VPCLMULQDQ(features) 1

#else

#  define HAVE_VPCLMULQDQ(features) ((features) & X86_CPU_FEATURE_VPCLMULQDQ)

#endif

#ifdef __AVX512VNNI__

#  define HAVE_AVX512VNNI(features) 1

#else

#  define HAVE_AVX512VNNI(features) ((features) & X86_CPU_FEATURE_AVX512VNNI)

#endif

#ifdef __AVXVNNI__

#  define HAVE_AVXVNNI(features)  1

#else

#  define HAVE_AVXVNNI(features)  ((features) & X86_CPU_FEATURE_AVXVNNI)

#endif

#endif /* ARCH_X86_32 || ARCH_X86_64 */

#endif /* LIB_X86_CPU_FEATURES_H */