1 /*
2 * Copyright 2011 The LibYuv Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11 #ifndef INCLUDE_LIBYUV_CPU_ID_H_
12 #define INCLUDE_LIBYUV_CPU_ID_H_
13
14 #include "libyuv/basic_types.h"
15
16 #ifdef __cplusplus
17 namespace libyuv {
18 extern "C" {
19 #endif
20
21 // Internal flag to indicate cpuid requires initialization.
22 static const int kCpuInitialized = 0x1;
23
24 // These flags are only valid on ARM processors.
25 static const int kCpuHasARM = 0x2;
26 static const int kCpuHasNEON = 0x4;
27 // 0x8 reserved for future ARM flag.
28
29 // These flags are only valid on x86 processors.
30 static const int kCpuHasX86 = 0x10;
31 static const int kCpuHasSSE2 = 0x20;
32 static const int kCpuHasSSSE3 = 0x40;
33 static const int kCpuHasSSE41 = 0x80;
34 static const int kCpuHasSSE42 = 0x100; // unused at this time.
35 static const int kCpuHasAVX = 0x200;
36 static const int kCpuHasAVX2 = 0x400;
37 static const int kCpuHasERMS = 0x800;
38 static const int kCpuHasFMA3 = 0x1000;
39 static const int kCpuHasF16C = 0x2000;
40 static const int kCpuHasGFNI = 0x4000;
41 static const int kCpuHasAVX512BW = 0x8000;
42 static const int kCpuHasAVX512VL = 0x10000;
43 static const int kCpuHasAVX512VNNI = 0x20000;
44 static const int kCpuHasAVX512VBMI = 0x40000;
45 static const int kCpuHasAVX512VBMI2 = 0x80000;
46 static const int kCpuHasAVX512VBITALG = 0x100000;
47 static const int kCpuHasAVX512VPOPCNTDQ = 0x200000;
48
49 // These flags are only valid on MIPS processors.
50 static const int kCpuHasMIPS = 0x400000;
51 static const int kCpuHasMSA = 0x800000;
52
53 // These flags are only valid on LOONGARCH processors.
54 static const int kCpuHasLOONGARCH = 0x2000000;
55 static const int kCpuHasLSX = 0x4000000;
56 static const int kCpuHasLASX = 0x8000000;
57
58 // Optional init function. TestCpuFlag does an auto-init.
59 // Returns cpu_info flags.
60 LIBYUV_API
61 int InitCpuFlags(void);
62
63 // Detect CPU has SSE2 etc.
64 // Test_flag parameter should be one of kCpuHas constants above.
65 // Returns non-zero if instruction set is detected
TestCpuFlag(int test_flag)66 static __inline int TestCpuFlag(int test_flag) {
67 LIBYUV_API extern int cpu_info_;
68 #ifdef __ATOMIC_RELAXED
69 int cpu_info = __atomic_load_n(&cpu_info_, __ATOMIC_RELAXED);
70 #else
71 int cpu_info = cpu_info_;
72 #endif
73 return (!cpu_info ? InitCpuFlags() : cpu_info) & test_flag;
74 }
75
76 // Internal function for parsing /proc/cpuinfo.
77 LIBYUV_API
78 int ArmCpuCaps(const char* cpuinfo_name);
79 LIBYUV_API
80 int MipsCpuCaps(const char* cpuinfo_name);
81
82 // For testing, allow CPU flags to be disabled.
83 // ie MaskCpuFlags(~kCpuHasSSSE3) to disable SSSE3.
84 // MaskCpuFlags(-1) to enable all cpu specific optimizations.
85 // MaskCpuFlags(1) to disable all cpu specific optimizations.
86 // MaskCpuFlags(0) to reset state so next call will auto init.
87 // Returns cpu_info flags.
88 LIBYUV_API
89 int MaskCpuFlags(int enable_flags);
90
91 // Sets the CPU flags to |cpu_flags|, bypassing the detection code. |cpu_flags|
92 // should be a valid combination of the kCpuHas constants above and include
93 // kCpuInitialized. Use this method when running in a sandboxed process where
94 // the detection code might fail (as it might access /proc/cpuinfo). In such
95 // cases the cpu_info can be obtained from a non sandboxed process by calling
96 // InitCpuFlags() and passed to the sandboxed process (via command line
97 // parameters, IPC...) which can then call this method to initialize the CPU
98 // flags.
99 // Notes:
100 // - when specifying 0 for |cpu_flags|, the auto initialization is enabled
101 // again.
102 // - enabling CPU features that are not supported by the CPU will result in
103 // undefined behavior.
104 // TODO(fbarchard): consider writing a helper function that translates from
105 // other library CPU info to libyuv CPU info and add a .md doc that explains
106 // CPU detection.
SetCpuFlags(int cpu_flags)107 static __inline void SetCpuFlags(int cpu_flags) {
108 LIBYUV_API extern int cpu_info_;
109 #ifdef __ATOMIC_RELAXED
110 __atomic_store_n(&cpu_info_, cpu_flags, __ATOMIC_RELAXED);
111 #else
112 cpu_info_ = cpu_flags;
113 #endif
114 }
115
116 // Low level cpuid for X86. Returns zeros on other CPUs.
117 // eax is the info type that you want.
118 // ecx is typically the cpu number, and should normally be zero.
119 LIBYUV_API
120 void CpuId(int info_eax, int info_ecx, int* cpu_info);
121
122 #ifdef __cplusplus
123 } // extern "C"
124 } // namespace libyuv
125 #endif
126
127 #endif // INCLUDE_LIBYUV_CPU_ID_H_
128