aab200ffe5f2bb9b682592f8c4dee461234c2dbd
[wimlib] / src / x86_cpu_features.c
1 /*
2  * x86_cpu_features.c
3  *
4  * Feature detection for x86 processors.
5  *
6  * Author:      Eric Biggers
7  * Year:        2015
8  *
9  * The author dedicates this file to the public domain.
10  * You can do whatever you want with this file.
11  */
12
13 #include "wimlib/x86_cpu_features.h"
14
15 #if defined(__i386__) || defined(__x86_64__)
16
17 #define DEBUG 0
18
19 #if DEBUG
20 #  include <stdio.h>
21 #endif
22
23 u32 _x86_cpu_features = 0;
24
25 /* With old GCC versions we have to manually save and restore the x86_32 PIC
26  * register (ebx).  See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=47602  */
27 #if defined(__i386__) && defined(__PIC__)
28 #  define EBX_CONSTRAINT "=r"
29 #else
30 #  define EBX_CONSTRAINT "=b"
31 #endif
32
33 /* Execute the CPUID instruction.  */
34 static inline void
35 cpuid(u32 leaf, u32 subleaf, u32 *a, u32 *b, u32 *c, u32 *d)
36 {
37         __asm__(".ifnc %%ebx, %1; mov  %%ebx, %1; .endif\n"
38                 "cpuid                                  \n"
39                 ".ifnc %%ebx, %1; xchg %%ebx, %1; .endif\n"
40                 : "=a" (*a), EBX_CONSTRAINT (*b), "=c" (*c), "=d" (*d)
41                 : "a" (leaf), "c" (subleaf));
42 }
43
44 /* Read an extended control register.  */
45 static inline u64
46 read_xcr(u32 index)
47 {
48         u32 edx, eax;
49
50         __asm__ ("xgetbv" : "=d" (edx), "=a" (eax) : "c" (index));
51
52         return ((u64)edx << 32) | eax;
53 }
54
55 #define IS_SET(reg, bit) ((reg) & ((u32)1 << (bit)))
56
57 /* Initialize _x86_cpu_features with bits for interesting processor features. */
58 void
59 x86_setup_cpu_features(void)
60 {
61         u32 features = 0;
62         u32 dummy1, dummy2, dummy3, dummy4;
63         u32 max_function;
64         u32 features_1, features_2, features_3, features_4;
65         bool os_saves_ymm_regs = false;
66
67         /* Get maximum supported function  */
68         cpuid(0, 0, &max_function, &dummy2, &dummy3, &dummy4);
69         if (max_function < 1)
70                 goto out;
71
72         /* Standard feature flags  */
73         cpuid(1, 0, &dummy1, &dummy2, &features_2, &features_1);
74
75         if (IS_SET(features_1, 25))
76                 features |= X86_CPU_FEATURE_SSE;
77
78         if (IS_SET(features_1, 26))
79                 features |= X86_CPU_FEATURE_SSE2;
80
81         if (IS_SET(features_2, 0))
82                 features |= X86_CPU_FEATURE_SSE3;
83
84         if (IS_SET(features_2, 9))
85                 features |= X86_CPU_FEATURE_SSSE3;
86
87         if (IS_SET(features_2, 19))
88                 features |= X86_CPU_FEATURE_SSE4_1;
89
90         if (IS_SET(features_2, 20))
91                 features |= X86_CPU_FEATURE_SSE4_2;
92
93         if (IS_SET(features_2, 27)) /* OSXSAVE set?  */
94                 if ((read_xcr(0) & 0x6) == 0x6)
95                         os_saves_ymm_regs = true;
96
97         if (os_saves_ymm_regs && IS_SET(features_2, 28))
98                 features |= X86_CPU_FEATURE_AVX;
99
100         if (max_function < 7)
101                 goto out;
102
103         /* Extended feature flags  */
104         cpuid(7, 0, &dummy1, &features_3, &features_4, &dummy4);
105
106         if (IS_SET(features_3, 3))
107                 features |= X86_CPU_FEATURE_BMI;
108
109         if (os_saves_ymm_regs && IS_SET(features_3, 5))
110                 features |= X86_CPU_FEATURE_AVX2;
111
112         if (IS_SET(features_3, 8))
113                 features |= X86_CPU_FEATURE_BMI2;
114
115 out:
116
117 #if DEBUG
118         printf("Detected x86 CPU features: ");
119         if (features & X86_CPU_FEATURE_SSE)
120                 printf("SSE ");
121         if (features & X86_CPU_FEATURE_SSE2)
122                 printf("SSE2 ");
123         if (features & X86_CPU_FEATURE_SSE3)
124                 printf("SSE3 ");
125         if (features & X86_CPU_FEATURE_SSSE3)
126                 printf("SSSE3 ");
127         if (features & X86_CPU_FEATURE_SSE4_1)
128                 printf("SSE4.1 ");
129         if (features & X86_CPU_FEATURE_SSE4_2)
130                 printf("SSE4.2 ");
131         if (features & X86_CPU_FEATURE_BMI)
132                 printf("BMI ");
133         if (features & X86_CPU_FEATURE_AVX)
134                 printf("AVX ");
135         if (features & X86_CPU_FEATURE_BMI2)
136                 printf("BMI2 ");
137         if (features & X86_CPU_FEATURE_AVX2)
138                 printf("AVX2 ");
139         printf("\n");
140 #endif /* DEBUG */
141
142         _x86_cpu_features = features | X86_CPU_FEATURES_KNOWN;
143 }
144
145 #endif /* __i386__ || __x86_64__ */