/*

 *  Copyright 2011 The LibYuv Project Authors. All rights reserved.

 *

 *  Use of this source code is governed by a BSD-style license

 *  that can be found in the LICENSE file in the root of the source

 *  tree. An additional intellectual property rights grant can be found

 *  in the file PATENTS. All contributing project authors may

 *  be found in the AUTHORS file in the root of the source tree.

 */

#ifndef INCLUDE_LIBYUV_CPU_ID_H_

#define INCLUDE_LIBYUV_CPU_ID_H_

#include "libyuv/basic_types.h"

#ifdef __cplusplus

namespace libyuv {

extern "C" {

#endif

// Internal flag to indicate cpuid requires initialization.

static const int kCpuInitialized = 0x1;

// These flags are only valid on Arm processors.

static const int kCpuHasARM = 0x2;

static const int kCpuHasNEON = 0x100;

static const int kCpuHasNeonDotProd = 0x200;

static const int kCpuHasNeonI8MM = 0x400;

static const int kCpuHasSVE = 0x800;

static const int kCpuHasSVE2 = 0x1000;

static const int kCpuHasSME = 0x2000;

static const int kCpuHasSME2 = 0x4000;

static const int kCpuHasSVEF32MM = 0x8000;

// These flags are only valid on RISCV processors.

static const int kCpuHasRISCV = 0x4;

static const int kCpuHasRVV = 0x100;

static const int kCpuHasRVVZVFH = 0x200;

// These flags are only valid on x86 processors.

static const int kCpuHasX86 = 0x8;

static const int kCpuHasSSE2 = 0x100;

static const int kCpuHasSSSE3 = 0x200;

static const int kCpuHasSSE41 = 0x400;

static const int kCpuHasSSE42 = 0x800;

static const int kCpuHasAVX = 0x1000;

static const int kCpuHasAVX2 = 0x2000;

static const int kCpuHasERMS = 0x4000;

static const int kCpuHasFSMR = 0x8000;

static const int kCpuHasFMA3 = 0x10000;

static const int kCpuHasF16C = 0x20000;

static const int kCpuHasAVX512BW = 0x40000;

static const int kCpuHasAVX512VL = 0x80000;

static const int kCpuHasAVX512VNNI = 0x100000;

static const int kCpuHasAVX512VBMI = 0x200000;

static const int kCpuHasAVX512VBMI2 = 0x400000;

static const int kCpuHasAVX512VBITALG = 0x800000;

static const int kCpuHasAVX10 = 0x1000000;

static const int kCpuHasAVX10_2 = 0x2000000;

static const int kCpuHasAVXVNNI = 0x4000000;

static const int kCpuHasAVXVNNIINT8 = 0x8000000;

static const int kCpuHasAMXINT8 = 0x10000000;

// These flags are only valid on LOONGARCH processors.

static const int kCpuHasLOONGARCH = 0x20;

static const int kCpuHasLSX = 0x100;

static const int kCpuHasLASX = 0x200;

// Optional init function. TestCpuFlag does an auto-init.

// Returns cpu_info flags.

LIBYUV_API

int InitCpuFlags(void);

// Detect CPU has SSE2 etc.

// Test_flag parameter should be one of kCpuHas constants above.

// Returns non-zero if instruction set is detected

static __inline int TestCpuFlag(int test_flag) {

  LIBYUV_API extern int cpu_info_;

#ifdef __ATOMIC_RELAXED

  int cpu_info = __atomic_load_n(&cpu_info_, __ATOMIC_RELAXED);

#else

  int cpu_info = cpu_info_;

#endif

  return (!cpu_info ? InitCpuFlags() : cpu_info) & test_flag;

}

convert_argb.cc:libyuv::TestCpuFlag(int)

Line

Count

Source

77

13.2k

static __inline int TestCpuFlag(int test_flag) {

78

13.2k

  LIBYUV_API extern int cpu_info_;

79

13.2k

#ifdef __ATOMIC_RELAXED

80

13.2k

  int cpu_info = __atomic_load_n(&cpu_info_, __ATOMIC_RELAXED);

81

#else

82

  int cpu_info = cpu_info_;

83

#endif

84

13.2k

  return (!cpu_info ? InitCpuFlags() : cpu_info) & test_flag;

85

13.2k

}

Unexecuted instantiation: convert.cc:libyuv::TestCpuFlag(int)

Unexecuted instantiation: convert_from_argb.cc:libyuv::TestCpuFlag(int)

Unexecuted instantiation: cpu_id.cc:libyuv::TestCpuFlag(int)

planar_functions.cc:libyuv::TestCpuFlag(int)

Line

Count

Source

77

6.02k

static __inline int TestCpuFlag(int test_flag) {

78

6.02k

  LIBYUV_API extern int cpu_info_;

79

6.02k

#ifdef __ATOMIC_RELAXED

80

6.02k

  int cpu_info = __atomic_load_n(&cpu_info_, __ATOMIC_RELAXED);

81

#else

82

  int cpu_info = cpu_info_;

83

#endif

84

6.02k

  return (!cpu_info ? InitCpuFlags() : cpu_info) & test_flag;

85

6.02k

}

Unexecuted instantiation: rotate.cc:libyuv::TestCpuFlag(int)

scale.cc:libyuv::TestCpuFlag(int)

Line

Count

Source

77

33.5k

static __inline int TestCpuFlag(int test_flag) {

78

33.5k

  LIBYUV_API extern int cpu_info_;

79

33.5k

#ifdef __ATOMIC_RELAXED

80

33.5k

  int cpu_info = __atomic_load_n(&cpu_info_, __ATOMIC_RELAXED);

81

#else

82

  int cpu_info = cpu_info_;

83

#endif

84

33.5k

  return (!cpu_info ? InitCpuFlags() : cpu_info) & test_flag;

85

33.5k

}

scale_common.cc:libyuv::TestCpuFlag(int)

Line

Count

Source

77

4.96k

static __inline int TestCpuFlag(int test_flag) {

78

4.96k

  LIBYUV_API extern int cpu_info_;

79

4.96k

#ifdef __ATOMIC_RELAXED

80

4.96k

  int cpu_info = __atomic_load_n(&cpu_info_, __ATOMIC_RELAXED);

81

#else

82

  int cpu_info = cpu_info_;

83

#endif

84

4.96k

  return (!cpu_info ? InitCpuFlags() : cpu_info) & test_flag;

85

4.96k

}

Unexecuted instantiation: scale_uv.cc:libyuv::TestCpuFlag(int)

// Internal function for parsing /proc/cpuinfo.

LIBYUV_API

int ArmCpuCaps(const char* cpuinfo_name);

LIBYUV_API

int RiscvCpuCaps(const char* cpuinfo_name);

#ifdef __linux__

// On Linux, parse AArch64 features from getauxval(AT_HWCAP{,2}).

LIBYUV_API

int AArch64CpuCaps(unsigned long hwcap, unsigned long hwcap2);

#else

LIBYUV_API

int AArch64CpuCaps();

#endif

// For testing, allow CPU flags to be disabled.

// ie MaskCpuFlags(~kCpuHasSSSE3) to disable SSSE3.

// MaskCpuFlags(-1) to enable all cpu specific optimizations.

// MaskCpuFlags(1) to disable all cpu specific optimizations.

// MaskCpuFlags(0) to reset state so next call will auto init.

// Returns cpu_info flags.

LIBYUV_API

int MaskCpuFlags(int enable_flags);

// Sets the CPU flags to |cpu_flags|, bypassing the detection code. |cpu_flags|

// should be a valid combination of the kCpuHas constants above and include

// kCpuInitialized. Use this method when running in a sandboxed process where

// the detection code might fail (as it might access /proc/cpuinfo). In such

// cases the cpu_info can be obtained from a non sandboxed process by calling

// InitCpuFlags() and passed to the sandboxed process (via command line

// parameters, IPC...) which can then call this method to initialize the CPU

// flags.

// Notes:

// - when specifying 0 for |cpu_flags|, the auto initialization is enabled

//   again.

// - enabling CPU features that are not supported by the CPU will result in

//   undefined behavior.

// TODO(fbarchard): consider writing a helper function that translates from

// other library CPU info to libyuv CPU info and add a .md doc that explains

// CPU detection.

static __inline void SetCpuFlags(int cpu_flags) {

  LIBYUV_API extern int cpu_info_;

#ifdef __ATOMIC_RELAXED

  __atomic_store_n(&cpu_info_, cpu_flags, __ATOMIC_RELAXED);

#else

  cpu_info_ = cpu_flags;

#endif

}

Unexecuted instantiation: convert_argb.cc:libyuv::SetCpuFlags(int)

Unexecuted instantiation: convert.cc:libyuv::SetCpuFlags(int)

Unexecuted instantiation: convert_from_argb.cc:libyuv::SetCpuFlags(int)

cpu_id.cc:libyuv::SetCpuFlags(int)

Line

Count

Source

127

3

static __inline void SetCpuFlags(int cpu_flags) {

128

3

  LIBYUV_API extern int cpu_info_;

129

3

#ifdef __ATOMIC_RELAXED

130

3

  __atomic_store_n(&cpu_info_, cpu_flags, __ATOMIC_RELAXED);

131

#else

132

  cpu_info_ = cpu_flags;

133

#endif

134

3

}

Unexecuted instantiation: planar_functions.cc:libyuv::SetCpuFlags(int)

Unexecuted instantiation: rotate.cc:libyuv::SetCpuFlags(int)

Unexecuted instantiation: scale.cc:libyuv::SetCpuFlags(int)

Unexecuted instantiation: scale_common.cc:libyuv::SetCpuFlags(int)

Unexecuted instantiation: scale_uv.cc:libyuv::SetCpuFlags(int)

// Low level cpuid for X86. Returns zeros on other CPUs.

// eax is the info type that you want.

// ecx is typically the cpu number, and should normally be zero.

LIBYUV_API

void CpuId(int info_eax, int info_ecx, int* cpu_info);

#ifdef __cplusplus

}  // extern "C"

}  // namespace libyuv

#endif

#endif  // INCLUDE_LIBYUV_CPU_ID_H_