1 //===-- X86TargetParser - Parser for X86 features ---------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements a target parser to recognise X86 hardware features.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/Support/X86TargetParser.h"
14 #include "llvm/ADT/StringSwitch.h"
15 #include "llvm/ADT/Triple.h"
16 #include <numeric>
17 
18 using namespace llvm;
19 using namespace llvm::X86;
20 
21 namespace {
22 
23 /// Container class for CPU features.
24 /// This is a constexpr reimplementation of a subset of std::bitset. It would be
25 /// nice to use std::bitset directly, but it doesn't support constant
26 /// initialization.
27 class FeatureBitset {
28   static constexpr unsigned NUM_FEATURE_WORDS =
29       (X86::CPU_FEATURE_MAX + 31) / 32;
30 
31   // This cannot be a std::array, operator[] is not constexpr until C++17.
32   uint32_t Bits[NUM_FEATURE_WORDS] = {};
33 
34 public:
35   constexpr FeatureBitset() = default;
36   constexpr FeatureBitset(std::initializer_list<unsigned> Init) {
37     for (auto I : Init)
38       set(I);
39   }
40 
41   bool any() const {
42     return llvm::any_of(Bits, [](uint64_t V) { return V != 0; });
43   }
44 
45   constexpr FeatureBitset &set(unsigned I) {
46     // GCC <6.2 crashes if this is written in a single statement.
47     uint32_t NewBits = Bits[I / 32] | (uint32_t(1) << (I % 32));
48     Bits[I / 32] = NewBits;
49     return *this;
50   }
51 
52   constexpr bool operator[](unsigned I) const {
53     uint32_t Mask = uint32_t(1) << (I % 32);
54     return (Bits[I / 32] & Mask) != 0;
55   }
56 
57   constexpr FeatureBitset &operator&=(const FeatureBitset &RHS) {
58     for (unsigned I = 0, E = array_lengthof(Bits); I != E; ++I) {
59       // GCC <6.2 crashes if this is written in a single statement.
60       uint32_t NewBits = Bits[I] & RHS.Bits[I];
61       Bits[I] = NewBits;
62     }
63     return *this;
64   }
65 
66   constexpr FeatureBitset &operator|=(const FeatureBitset &RHS) {
67     for (unsigned I = 0, E = array_lengthof(Bits); I != E; ++I) {
68       // GCC <6.2 crashes if this is written in a single statement.
69       uint32_t NewBits = Bits[I] | RHS.Bits[I];
70       Bits[I] = NewBits;
71     }
72     return *this;
73   }
74 
75   // gcc 5.3 miscompiles this if we try to write this using operator&=.
76   constexpr FeatureBitset operator&(const FeatureBitset &RHS) const {
77     FeatureBitset Result;
78     for (unsigned I = 0, E = array_lengthof(Bits); I != E; ++I)
79       Result.Bits[I] = Bits[I] & RHS.Bits[I];
80     return Result;
81   }
82 
83   // gcc 5.3 miscompiles this if we try to write this using operator&=.
84   constexpr FeatureBitset operator|(const FeatureBitset &RHS) const {
85     FeatureBitset Result;
86     for (unsigned I = 0, E = array_lengthof(Bits); I != E; ++I)
87       Result.Bits[I] = Bits[I] | RHS.Bits[I];
88     return Result;
89   }
90 
91   constexpr FeatureBitset operator~() const {
92     FeatureBitset Result;
93     for (unsigned I = 0, E = array_lengthof(Bits); I != E; ++I)
94       Result.Bits[I] = ~Bits[I];
95     return Result;
96   }
97 
98   constexpr bool operator!=(const FeatureBitset &RHS) const {
99     for (unsigned I = 0, E = array_lengthof(Bits); I != E; ++I)
100       if (Bits[I] != RHS.Bits[I])
101         return true;
102     return false;
103   }
104 };
105 
106 struct ProcInfo {
107   StringLiteral Name;
108   X86::CPUKind Kind;
109   unsigned KeyFeature;
110   FeatureBitset Features;
111 };
112 
113 struct FeatureInfo {
114   StringLiteral Name;
115   FeatureBitset ImpliedFeatures;
116 };
117 
118 } // end anonymous namespace
119 
120 #define X86_FEATURE(ENUM, STRING)                                              \
121   constexpr FeatureBitset Feature##ENUM = {X86::FEATURE_##ENUM};
122 #include "llvm/Support/X86TargetParser.def"
123 
124 // Pentium with MMX.
125 constexpr FeatureBitset FeaturesPentiumMMX =
126     FeatureX87 | FeatureCMPXCHG8B | FeatureMMX;
127 
128 // Pentium 2 and 3.
129 constexpr FeatureBitset FeaturesPentium2 =
130     FeatureX87 | FeatureCMPXCHG8B | FeatureMMX | FeatureFXSR;
131 constexpr FeatureBitset FeaturesPentium3 = FeaturesPentium2 | FeatureSSE;
132 
133 // Pentium 4 CPUs
134 constexpr FeatureBitset FeaturesPentium4 = FeaturesPentium3 | FeatureSSE2;
135 constexpr FeatureBitset FeaturesPrescott = FeaturesPentium4 | FeatureSSE3;
136 constexpr FeatureBitset FeaturesNocona =
137     FeaturesPrescott | Feature64BIT | FeatureCMPXCHG16B;
138 
139 // Basic 64-bit capable CPU.
140 constexpr FeatureBitset FeaturesX86_64 = FeaturesPentium4 | Feature64BIT;
141 constexpr FeatureBitset FeaturesX86_64_V2 = FeaturesX86_64 | FeatureSAHF |
142                                             FeaturePOPCNT | FeatureCRC32 |
143                                             FeatureSSE4_2 | FeatureCMPXCHG16B;
144 constexpr FeatureBitset FeaturesX86_64_V3 =
145     FeaturesX86_64_V2 | FeatureAVX2 | FeatureBMI | FeatureBMI2 | FeatureF16C |
146     FeatureFMA | FeatureLZCNT | FeatureMOVBE | FeatureXSAVE;
147 constexpr FeatureBitset FeaturesX86_64_V4 = FeaturesX86_64_V3 |
148                                             FeatureAVX512BW | FeatureAVX512CD |
149                                             FeatureAVX512DQ | FeatureAVX512VL;
150 
151 // Intel Core CPUs
152 constexpr FeatureBitset FeaturesCore2 =
153     FeaturesNocona | FeatureSAHF | FeatureSSSE3;
154 constexpr FeatureBitset FeaturesPenryn = FeaturesCore2 | FeatureSSE4_1;
155 constexpr FeatureBitset FeaturesNehalem =
156     FeaturesPenryn | FeaturePOPCNT | FeatureCRC32 | FeatureSSE4_2;
157 constexpr FeatureBitset FeaturesWestmere = FeaturesNehalem | FeaturePCLMUL;
158 constexpr FeatureBitset FeaturesSandyBridge =
159     FeaturesWestmere | FeatureAVX | FeatureXSAVE | FeatureXSAVEOPT;
160 constexpr FeatureBitset FeaturesIvyBridge =
161     FeaturesSandyBridge | FeatureF16C | FeatureFSGSBASE | FeatureRDRND;
162 constexpr FeatureBitset FeaturesHaswell =
163     FeaturesIvyBridge | FeatureAVX2 | FeatureBMI | FeatureBMI2 | FeatureFMA |
164     FeatureINVPCID | FeatureLZCNT | FeatureMOVBE;
165 constexpr FeatureBitset FeaturesBroadwell =
166     FeaturesHaswell | FeatureADX | FeaturePRFCHW | FeatureRDSEED;
167 
168 // Intel Knights Landing and Knights Mill
169 // Knights Landing has feature parity with Broadwell.
170 constexpr FeatureBitset FeaturesKNL =
171     FeaturesBroadwell | FeatureAES | FeatureAVX512F | FeatureAVX512CD |
172     FeatureAVX512ER | FeatureAVX512PF | FeaturePREFETCHWT1;
173 constexpr FeatureBitset FeaturesKNM = FeaturesKNL | FeatureAVX512VPOPCNTDQ;
174 
175 // Intel Skylake processors.
176 constexpr FeatureBitset FeaturesSkylakeClient =
177     FeaturesBroadwell | FeatureAES | FeatureCLFLUSHOPT | FeatureXSAVEC |
178     FeatureXSAVES | FeatureSGX;
179 // SkylakeServer inherits all SkylakeClient features except SGX.
180 // FIXME: That doesn't match gcc.
181 constexpr FeatureBitset FeaturesSkylakeServer =
182     (FeaturesSkylakeClient & ~FeatureSGX) | FeatureAVX512F | FeatureAVX512CD |
183     FeatureAVX512DQ | FeatureAVX512BW | FeatureAVX512VL | FeatureCLWB |
184     FeaturePKU;
185 constexpr FeatureBitset FeaturesCascadeLake =
186     FeaturesSkylakeServer | FeatureAVX512VNNI;
187 constexpr FeatureBitset FeaturesCooperLake =
188     FeaturesCascadeLake | FeatureAVX512BF16;
189 
190 // Intel 10nm processors.
191 constexpr FeatureBitset FeaturesCannonlake =
192     FeaturesSkylakeClient | FeatureAVX512F | FeatureAVX512CD | FeatureAVX512DQ |
193     FeatureAVX512BW | FeatureAVX512VL | FeatureAVX512IFMA | FeatureAVX512VBMI |
194     FeaturePKU | FeatureSHA;
195 constexpr FeatureBitset FeaturesICLClient =
196     FeaturesCannonlake | FeatureAVX512BITALG | FeatureAVX512VBMI2 |
197     FeatureAVX512VNNI | FeatureAVX512VPOPCNTDQ | FeatureGFNI | FeatureRDPID |
198     FeatureVAES | FeatureVPCLMULQDQ;
199 constexpr FeatureBitset FeaturesRocketlake = FeaturesICLClient & ~FeatureSGX;
200 constexpr FeatureBitset FeaturesICLServer =
201     FeaturesICLClient | FeatureCLWB | FeaturePCONFIG | FeatureWBNOINVD;
202 constexpr FeatureBitset FeaturesTigerlake =
203     FeaturesICLClient | FeatureAVX512VP2INTERSECT | FeatureMOVDIR64B |
204     FeatureCLWB | FeatureMOVDIRI | FeatureSHSTK | FeatureKL | FeatureWIDEKL;
205 constexpr FeatureBitset FeaturesSapphireRapids =
206     FeaturesICLServer | FeatureAMX_BF16 | FeatureAMX_INT8 | FeatureAMX_TILE |
207     FeatureAVX512BF16 | FeatureAVX512FP16 | FeatureAVX512VP2INTERSECT |
208     FeatureAVXVNNI | FeatureCLDEMOTE | FeatureENQCMD | FeatureMOVDIR64B |
209     FeatureMOVDIRI | FeaturePTWRITE | FeatureSERIALIZE | FeatureSHSTK |
210     FeatureTSXLDTRK | FeatureUINTR | FeatureWAITPKG;
211 
212 // Intel Atom processors.
213 // Bonnell has feature parity with Core2 and adds MOVBE.
214 constexpr FeatureBitset FeaturesBonnell = FeaturesCore2 | FeatureMOVBE;
215 // Silvermont has parity with Westmere and Bonnell plus PRFCHW and RDRND.
216 constexpr FeatureBitset FeaturesSilvermont =
217     FeaturesBonnell | FeaturesWestmere | FeaturePRFCHW | FeatureRDRND;
218 constexpr FeatureBitset FeaturesGoldmont =
219     FeaturesSilvermont | FeatureAES | FeatureCLFLUSHOPT | FeatureFSGSBASE |
220     FeatureRDSEED | FeatureSHA | FeatureXSAVE | FeatureXSAVEC |
221     FeatureXSAVEOPT | FeatureXSAVES;
222 constexpr FeatureBitset FeaturesGoldmontPlus =
223     FeaturesGoldmont | FeaturePTWRITE | FeatureRDPID | FeatureSGX;
224 constexpr FeatureBitset FeaturesTremont =
225     FeaturesGoldmontPlus | FeatureCLWB | FeatureGFNI;
226 constexpr FeatureBitset FeaturesAlderlake =
227     FeaturesTremont | FeatureADX | FeatureBMI | FeatureBMI2 | FeatureF16C |
228     FeatureFMA | FeatureINVPCID | FeatureLZCNT | FeaturePCONFIG | FeaturePKU |
229     FeatureSERIALIZE | FeatureSHSTK | FeatureVAES | FeatureVPCLMULQDQ |
230     FeatureCLDEMOTE | FeatureMOVDIR64B | FeatureMOVDIRI | FeatureWAITPKG |
231     FeatureAVXVNNI | FeatureHRESET | FeatureWIDEKL;
232 
233 // Geode Processor.
234 constexpr FeatureBitset FeaturesGeode =
235     FeatureX87 | FeatureCMPXCHG8B | FeatureMMX | Feature3DNOW | Feature3DNOWA;
236 
237 // K6 processor.
238 constexpr FeatureBitset FeaturesK6 = FeatureX87 | FeatureCMPXCHG8B | FeatureMMX;
239 
240 // K7 and K8 architecture processors.
241 constexpr FeatureBitset FeaturesAthlon =
242     FeatureX87 | FeatureCMPXCHG8B | FeatureMMX | Feature3DNOW | Feature3DNOWA;
243 constexpr FeatureBitset FeaturesAthlonXP =
244     FeaturesAthlon | FeatureFXSR | FeatureSSE;
245 constexpr FeatureBitset FeaturesK8 =
246     FeaturesAthlonXP | FeatureSSE2 | Feature64BIT;
247 constexpr FeatureBitset FeaturesK8SSE3 = FeaturesK8 | FeatureSSE3;
248 constexpr FeatureBitset FeaturesAMDFAM10 =
249     FeaturesK8SSE3 | FeatureCMPXCHG16B | FeatureLZCNT | FeaturePOPCNT |
250     FeaturePRFCHW | FeatureSAHF | FeatureSSE4_A;
251 
252 // Bobcat architecture processors.
253 constexpr FeatureBitset FeaturesBTVER1 =
254     FeatureX87 | FeatureCMPXCHG8B | FeatureCMPXCHG16B | Feature64BIT |
255     FeatureFXSR | FeatureLZCNT | FeatureMMX | FeaturePOPCNT | FeaturePRFCHW |
256     FeatureSSE | FeatureSSE2 | FeatureSSE3 | FeatureSSSE3 | FeatureSSE4_A |
257     FeatureSAHF;
258 constexpr FeatureBitset FeaturesBTVER2 =
259     FeaturesBTVER1 | FeatureAES | FeatureAVX | FeatureBMI | FeatureCRC32 |
260     FeatureF16C | FeatureMOVBE | FeaturePCLMUL | FeatureXSAVE | FeatureXSAVEOPT;
261 
262 // AMD Bulldozer architecture processors.
263 constexpr FeatureBitset FeaturesBDVER1 =
264     FeatureX87 | FeatureAES | FeatureAVX | FeatureCMPXCHG8B |
265     FeatureCMPXCHG16B | FeatureCRC32 | Feature64BIT | FeatureFMA4 |
266     FeatureFXSR | FeatureLWP | FeatureLZCNT | FeatureMMX | FeaturePCLMUL |
267     FeaturePOPCNT | FeaturePRFCHW | FeatureSAHF | FeatureSSE | FeatureSSE2 |
268     FeatureSSE3 | FeatureSSSE3 | FeatureSSE4_1 | FeatureSSE4_2 | FeatureSSE4_A |
269     FeatureXOP | FeatureXSAVE;
270 constexpr FeatureBitset FeaturesBDVER2 =
271     FeaturesBDVER1 | FeatureBMI | FeatureFMA | FeatureF16C | FeatureTBM;
272 constexpr FeatureBitset FeaturesBDVER3 =
273     FeaturesBDVER2 | FeatureFSGSBASE | FeatureXSAVEOPT;
274 constexpr FeatureBitset FeaturesBDVER4 = FeaturesBDVER3 | FeatureAVX2 |
275                                          FeatureBMI2 | FeatureMOVBE |
276                                          FeatureMWAITX | FeatureRDRND;
277 
278 // AMD Zen architecture processors.
279 constexpr FeatureBitset FeaturesZNVER1 =
280     FeatureX87 | FeatureADX | FeatureAES | FeatureAVX | FeatureAVX2 |
281     FeatureBMI | FeatureBMI2 | FeatureCLFLUSHOPT | FeatureCLZERO |
282     FeatureCMPXCHG8B | FeatureCMPXCHG16B | FeatureCRC32 | Feature64BIT |
283     FeatureF16C | FeatureFMA | FeatureFSGSBASE | FeatureFXSR | FeatureLZCNT |
284     FeatureMMX | FeatureMOVBE | FeatureMWAITX | FeaturePCLMUL | FeaturePOPCNT |
285     FeaturePRFCHW | FeatureRDRND | FeatureRDSEED | FeatureSAHF | FeatureSHA |
286     FeatureSSE | FeatureSSE2 | FeatureSSE3 | FeatureSSSE3 | FeatureSSE4_1 |
287     FeatureSSE4_2 | FeatureSSE4_A | FeatureXSAVE | FeatureXSAVEC |
288     FeatureXSAVEOPT | FeatureXSAVES;
289 constexpr FeatureBitset FeaturesZNVER2 =
290     FeaturesZNVER1 | FeatureCLWB | FeatureRDPID | FeatureWBNOINVD;
291 static constexpr FeatureBitset FeaturesZNVER3 = FeaturesZNVER2 |
292                                                 FeatureINVPCID | FeaturePKU |
293                                                 FeatureVAES | FeatureVPCLMULQDQ;
294 
295 constexpr ProcInfo Processors[] = {
296   // Empty processor. Include X87 and CMPXCHG8 for backwards compatibility.
297   { {""}, CK_None, ~0U, FeatureX87 | FeatureCMPXCHG8B },
298   // i386-generation processors.
299   { {"i386"}, CK_i386, ~0U, FeatureX87 },
300   // i486-generation processors.
301   { {"i486"}, CK_i486, ~0U, FeatureX87 },
302   { {"winchip-c6"}, CK_WinChipC6, ~0U, FeaturesPentiumMMX },
303   { {"winchip2"}, CK_WinChip2, ~0U, FeaturesPentiumMMX | Feature3DNOW },
304   { {"c3"}, CK_C3, ~0U, FeaturesPentiumMMX | Feature3DNOW },
305   // i586-generation processors, P5 microarchitecture based.
306   { {"i586"}, CK_i586, ~0U, FeatureX87 | FeatureCMPXCHG8B },
307   { {"pentium"}, CK_Pentium, ~0U, FeatureX87 | FeatureCMPXCHG8B },
308   { {"pentium-mmx"}, CK_PentiumMMX, ~0U, FeaturesPentiumMMX },
309   // i686-generation processors, P6 / Pentium M microarchitecture based.
310   { {"pentiumpro"}, CK_PentiumPro, ~0U, FeatureX87 | FeatureCMPXCHG8B },
311   { {"i686"}, CK_i686, ~0U, FeatureX87 | FeatureCMPXCHG8B },
312   { {"pentium2"}, CK_Pentium2, ~0U, FeaturesPentium2 },
313   { {"pentium3"}, CK_Pentium3, ~0U, FeaturesPentium3 },
314   { {"pentium3m"}, CK_Pentium3, ~0U, FeaturesPentium3 },
315   { {"pentium-m"}, CK_PentiumM, ~0U, FeaturesPentium4 },
316   { {"c3-2"}, CK_C3_2, ~0U, FeaturesPentium3 },
317   { {"yonah"}, CK_Yonah, ~0U, FeaturesPrescott },
318   // Netburst microarchitecture based processors.
319   { {"pentium4"}, CK_Pentium4, ~0U, FeaturesPentium4 },
320   { {"pentium4m"}, CK_Pentium4, ~0U, FeaturesPentium4 },
321   { {"prescott"}, CK_Prescott, ~0U, FeaturesPrescott },
322   { {"nocona"}, CK_Nocona, ~0U, FeaturesNocona },
323   // Core microarchitecture based processors.
324   { {"core2"}, CK_Core2, ~0U, FeaturesCore2 },
325   { {"penryn"}, CK_Penryn, ~0U, FeaturesPenryn },
326   // Atom processors
327   { {"bonnell"}, CK_Bonnell, FEATURE_SSSE3, FeaturesBonnell },
328   { {"atom"}, CK_Bonnell, FEATURE_SSSE3, FeaturesBonnell },
329   { {"silvermont"}, CK_Silvermont, FEATURE_SSE4_2, FeaturesSilvermont },
330   { {"slm"}, CK_Silvermont, FEATURE_SSE4_2, FeaturesSilvermont },
331   { {"goldmont"}, CK_Goldmont, FEATURE_SSE4_2, FeaturesGoldmont },
332   { {"goldmont-plus"}, CK_GoldmontPlus, FEATURE_SSE4_2, FeaturesGoldmontPlus },
333   { {"tremont"}, CK_Tremont, FEATURE_SSE4_2, FeaturesTremont },
334   // Nehalem microarchitecture based processors.
335   { {"nehalem"}, CK_Nehalem, FEATURE_SSE4_2, FeaturesNehalem },
336   { {"corei7"}, CK_Nehalem, FEATURE_SSE4_2, FeaturesNehalem },
337   // Westmere microarchitecture based processors.
338   { {"westmere"}, CK_Westmere, FEATURE_PCLMUL, FeaturesWestmere },
339   // Sandy Bridge microarchitecture based processors.
340   { {"sandybridge"}, CK_SandyBridge, FEATURE_AVX, FeaturesSandyBridge },
341   { {"corei7-avx"}, CK_SandyBridge, FEATURE_AVX, FeaturesSandyBridge },
342   // Ivy Bridge microarchitecture based processors.
343   { {"ivybridge"}, CK_IvyBridge, FEATURE_AVX, FeaturesIvyBridge },
344   { {"core-avx-i"}, CK_IvyBridge, FEATURE_AVX, FeaturesIvyBridge },
345   // Haswell microarchitecture based processors.
346   { {"haswell"}, CK_Haswell, FEATURE_AVX2, FeaturesHaswell },
347   { {"core-avx2"}, CK_Haswell, FEATURE_AVX2, FeaturesHaswell },
348   // Broadwell microarchitecture based processors.
349   { {"broadwell"}, CK_Broadwell, FEATURE_AVX2, FeaturesBroadwell },
350   // Skylake client microarchitecture based processors.
351   { {"skylake"}, CK_SkylakeClient, FEATURE_AVX2, FeaturesSkylakeClient },
352   // Skylake server microarchitecture based processors.
353   { {"skylake-avx512"}, CK_SkylakeServer, FEATURE_AVX512F, FeaturesSkylakeServer },
354   { {"skx"}, CK_SkylakeServer, FEATURE_AVX512F, FeaturesSkylakeServer },
355   // Cascadelake Server microarchitecture based processors.
356   { {"cascadelake"}, CK_Cascadelake, FEATURE_AVX512VNNI, FeaturesCascadeLake },
357   // Cooperlake Server microarchitecture based processors.
358   { {"cooperlake"}, CK_Cooperlake, FEATURE_AVX512BF16, FeaturesCooperLake },
359   // Cannonlake client microarchitecture based processors.
360   { {"cannonlake"}, CK_Cannonlake, FEATURE_AVX512VBMI, FeaturesCannonlake },
361   // Icelake client microarchitecture based processors.
362   { {"icelake-client"}, CK_IcelakeClient, FEATURE_AVX512VBMI2, FeaturesICLClient },
363   // Rocketlake microarchitecture based processors.
364   { {"rocketlake"}, CK_Rocketlake, FEATURE_AVX512VBMI2, FeaturesRocketlake },
365   // Icelake server microarchitecture based processors.
366   { {"icelake-server"}, CK_IcelakeServer, FEATURE_AVX512VBMI2, FeaturesICLServer },
367   // Tigerlake microarchitecture based processors.
368   { {"tigerlake"}, CK_Tigerlake, FEATURE_AVX512VP2INTERSECT, FeaturesTigerlake },
369   // Sapphire Rapids microarchitecture based processors.
370   { {"sapphirerapids"}, CK_SapphireRapids, FEATURE_AVX512VP2INTERSECT, FeaturesSapphireRapids },
371   // Alderlake microarchitecture based processors.
372   { {"alderlake"}, CK_Alderlake, FEATURE_AVX2, FeaturesAlderlake },
373   // Knights Landing processor.
374   { {"knl"}, CK_KNL, FEATURE_AVX512F, FeaturesKNL },
375   // Knights Mill processor.
376   { {"knm"}, CK_KNM, FEATURE_AVX5124FMAPS, FeaturesKNM },
377   // Lakemont microarchitecture based processors.
378   { {"lakemont"}, CK_Lakemont, ~0U, FeatureCMPXCHG8B },
379   // K6 architecture processors.
380   { {"k6"}, CK_K6, ~0U, FeaturesK6 },
381   { {"k6-2"}, CK_K6_2, ~0U, FeaturesK6 | Feature3DNOW },
382   { {"k6-3"}, CK_K6_3, ~0U, FeaturesK6 | Feature3DNOW },
383   // K7 architecture processors.
384   { {"athlon"}, CK_Athlon, ~0U, FeaturesAthlon },
385   { {"athlon-tbird"}, CK_Athlon, ~0U, FeaturesAthlon },
386   { {"athlon-xp"}, CK_AthlonXP, ~0U, FeaturesAthlonXP },
387   { {"athlon-mp"}, CK_AthlonXP, ~0U, FeaturesAthlonXP },
388   { {"athlon-4"}, CK_AthlonXP, ~0U, FeaturesAthlonXP },
389   // K8 architecture processors.
390   { {"k8"}, CK_K8, ~0U, FeaturesK8 },
391   { {"athlon64"}, CK_K8, ~0U, FeaturesK8 },
392   { {"athlon-fx"}, CK_K8, ~0U, FeaturesK8 },
393   { {"opteron"}, CK_K8, ~0U, FeaturesK8 },
394   { {"k8-sse3"}, CK_K8SSE3, ~0U, FeaturesK8SSE3 },
395   { {"athlon64-sse3"}, CK_K8SSE3, ~0U, FeaturesK8SSE3 },
396   { {"opteron-sse3"}, CK_K8SSE3, ~0U, FeaturesK8SSE3 },
397   { {"amdfam10"}, CK_AMDFAM10, FEATURE_SSE4_A, FeaturesAMDFAM10 },
398   { {"barcelona"}, CK_AMDFAM10, FEATURE_SSE4_A, FeaturesAMDFAM10 },
399   // Bobcat architecture processors.
400   { {"btver1"}, CK_BTVER1, FEATURE_SSE4_A, FeaturesBTVER1 },
401   { {"btver2"}, CK_BTVER2, FEATURE_BMI, FeaturesBTVER2 },
402   // Bulldozer architecture processors.
403   { {"bdver1"}, CK_BDVER1, FEATURE_XOP, FeaturesBDVER1 },
404   { {"bdver2"}, CK_BDVER2, FEATURE_FMA, FeaturesBDVER2 },
405   { {"bdver3"}, CK_BDVER3, FEATURE_FMA, FeaturesBDVER3 },
406   { {"bdver4"}, CK_BDVER4, FEATURE_AVX2, FeaturesBDVER4 },
407   // Zen architecture processors.
408   { {"znver1"}, CK_ZNVER1, FEATURE_AVX2, FeaturesZNVER1 },
409   { {"znver2"}, CK_ZNVER2, FEATURE_AVX2, FeaturesZNVER2 },
410   { {"znver3"}, CK_ZNVER3, FEATURE_AVX2, FeaturesZNVER3 },
411   // Generic 64-bit processor.
412   { {"x86-64"}, CK_x86_64, ~0U, FeaturesX86_64 },
413   { {"x86-64-v2"}, CK_x86_64_v2, ~0U, FeaturesX86_64_V2 },
414   { {"x86-64-v3"}, CK_x86_64_v3, ~0U, FeaturesX86_64_V3 },
415   { {"x86-64-v4"}, CK_x86_64_v4, ~0U, FeaturesX86_64_V4 },
416   // Geode processors.
417   { {"geode"}, CK_Geode, ~0U, FeaturesGeode },
418 };
419 
420 constexpr const char *NoTuneList[] = {"x86-64-v2", "x86-64-v3", "x86-64-v4"};
421 
422 X86::CPUKind llvm::X86::parseArchX86(StringRef CPU, bool Only64Bit) {
423   for (const auto &P : Processors)
424     if (P.Name == CPU && (P.Features[FEATURE_64BIT] || !Only64Bit))
425       return P.Kind;
426 
427   return CK_None;
428 }
429 
430 X86::CPUKind llvm::X86::parseTuneCPU(StringRef CPU, bool Only64Bit) {
431   if (llvm::is_contained(NoTuneList, CPU))
432     return CK_None;
433   return parseArchX86(CPU, Only64Bit);
434 }
435 
436 void llvm::X86::fillValidCPUArchList(SmallVectorImpl<StringRef> &Values,
437                                      bool Only64Bit) {
438   for (const auto &P : Processors)
439     if (!P.Name.empty() && (P.Features[FEATURE_64BIT] || !Only64Bit))
440       Values.emplace_back(P.Name);
441 }
442 
443 void llvm::X86::fillValidTuneCPUList(SmallVectorImpl<StringRef> &Values,
444                                      bool Only64Bit) {
445   for (const ProcInfo &P : Processors)
446     if (!P.Name.empty() && (P.Features[FEATURE_64BIT] || !Only64Bit) &&
447         !llvm::is_contained(NoTuneList, P.Name))
448       Values.emplace_back(P.Name);
449 }
450 
451 ProcessorFeatures llvm::X86::getKeyFeature(X86::CPUKind Kind) {
452   // FIXME: Can we avoid a linear search here? The table might be sorted by
453   // CPUKind so we could binary search?
454   for (const auto &P : Processors) {
455     if (P.Kind == Kind) {
456       assert(P.KeyFeature != ~0U && "Processor does not have a key feature.");
457       return static_cast<ProcessorFeatures>(P.KeyFeature);
458     }
459   }
460 
461   llvm_unreachable("Unable to find CPU kind!");
462 }
463 
464 // Features with no dependencies.
465 constexpr FeatureBitset ImpliedFeatures64BIT = {};
466 constexpr FeatureBitset ImpliedFeaturesADX = {};
467 constexpr FeatureBitset ImpliedFeaturesBMI = {};
468 constexpr FeatureBitset ImpliedFeaturesBMI2 = {};
469 constexpr FeatureBitset ImpliedFeaturesCLDEMOTE = {};
470 constexpr FeatureBitset ImpliedFeaturesCLFLUSHOPT = {};
471 constexpr FeatureBitset ImpliedFeaturesCLWB = {};
472 constexpr FeatureBitset ImpliedFeaturesCLZERO = {};
473 constexpr FeatureBitset ImpliedFeaturesCMOV = {};
474 constexpr FeatureBitset ImpliedFeaturesCMPXCHG16B = {};
475 constexpr FeatureBitset ImpliedFeaturesCMPXCHG8B = {};
476 constexpr FeatureBitset ImpliedFeaturesCRC32 = {};
477 constexpr FeatureBitset ImpliedFeaturesENQCMD = {};
478 constexpr FeatureBitset ImpliedFeaturesFSGSBASE = {};
479 constexpr FeatureBitset ImpliedFeaturesFXSR = {};
480 constexpr FeatureBitset ImpliedFeaturesINVPCID = {};
481 constexpr FeatureBitset ImpliedFeaturesLWP = {};
482 constexpr FeatureBitset ImpliedFeaturesLZCNT = {};
483 constexpr FeatureBitset ImpliedFeaturesMWAITX = {};
484 constexpr FeatureBitset ImpliedFeaturesMOVBE = {};
485 constexpr FeatureBitset ImpliedFeaturesMOVDIR64B = {};
486 constexpr FeatureBitset ImpliedFeaturesMOVDIRI = {};
487 constexpr FeatureBitset ImpliedFeaturesPCONFIG = {};
488 constexpr FeatureBitset ImpliedFeaturesPOPCNT = {};
489 constexpr FeatureBitset ImpliedFeaturesPKU = {};
490 constexpr FeatureBitset ImpliedFeaturesPREFETCHWT1 = {};
491 constexpr FeatureBitset ImpliedFeaturesPRFCHW = {};
492 constexpr FeatureBitset ImpliedFeaturesPTWRITE = {};
493 constexpr FeatureBitset ImpliedFeaturesRDPID = {};
494 constexpr FeatureBitset ImpliedFeaturesRDRND = {};
495 constexpr FeatureBitset ImpliedFeaturesRDSEED = {};
496 constexpr FeatureBitset ImpliedFeaturesRTM = {};
497 constexpr FeatureBitset ImpliedFeaturesSAHF = {};
498 constexpr FeatureBitset ImpliedFeaturesSERIALIZE = {};
499 constexpr FeatureBitset ImpliedFeaturesSGX = {};
500 constexpr FeatureBitset ImpliedFeaturesSHSTK = {};
501 constexpr FeatureBitset ImpliedFeaturesTBM = {};
502 constexpr FeatureBitset ImpliedFeaturesTSXLDTRK = {};
503 constexpr FeatureBitset ImpliedFeaturesUINTR = {};
504 constexpr FeatureBitset ImpliedFeaturesWAITPKG = {};
505 constexpr FeatureBitset ImpliedFeaturesWBNOINVD = {};
506 constexpr FeatureBitset ImpliedFeaturesVZEROUPPER = {};
507 constexpr FeatureBitset ImpliedFeaturesX87 = {};
508 constexpr FeatureBitset ImpliedFeaturesXSAVE = {};
509 
510 // Not really CPU features, but need to be in the table because clang uses
511 // target features to communicate them to the backend.
512 constexpr FeatureBitset ImpliedFeaturesRETPOLINE_EXTERNAL_THUNK = {};
513 constexpr FeatureBitset ImpliedFeaturesRETPOLINE_INDIRECT_BRANCHES = {};
514 constexpr FeatureBitset ImpliedFeaturesRETPOLINE_INDIRECT_CALLS = {};
515 constexpr FeatureBitset ImpliedFeaturesLVI_CFI = {};
516 constexpr FeatureBitset ImpliedFeaturesLVI_LOAD_HARDENING = {};
517 
518 // XSAVE features are dependent on basic XSAVE.
519 constexpr FeatureBitset ImpliedFeaturesXSAVEC = FeatureXSAVE;
520 constexpr FeatureBitset ImpliedFeaturesXSAVEOPT = FeatureXSAVE;
521 constexpr FeatureBitset ImpliedFeaturesXSAVES = FeatureXSAVE;
522 
523 // MMX->3DNOW->3DNOWA chain.
524 constexpr FeatureBitset ImpliedFeaturesMMX = {};
525 constexpr FeatureBitset ImpliedFeatures3DNOW = FeatureMMX;
526 constexpr FeatureBitset ImpliedFeatures3DNOWA = Feature3DNOW;
527 
528 // SSE/AVX/AVX512F chain.
529 constexpr FeatureBitset ImpliedFeaturesSSE = {};
530 constexpr FeatureBitset ImpliedFeaturesSSE2 = FeatureSSE;
531 constexpr FeatureBitset ImpliedFeaturesSSE3 = FeatureSSE2;
532 constexpr FeatureBitset ImpliedFeaturesSSSE3 = FeatureSSE3;
533 constexpr FeatureBitset ImpliedFeaturesSSE4_1 = FeatureSSSE3;
534 constexpr FeatureBitset ImpliedFeaturesSSE4_2 = FeatureSSE4_1;
535 constexpr FeatureBitset ImpliedFeaturesAVX = FeatureSSE4_2;
536 constexpr FeatureBitset ImpliedFeaturesAVX2 = FeatureAVX;
537 constexpr FeatureBitset ImpliedFeaturesAVX512F =
538     FeatureAVX2 | FeatureF16C | FeatureFMA;
539 
540 // Vector extensions that build on SSE or AVX.
541 constexpr FeatureBitset ImpliedFeaturesAES = FeatureSSE2;
542 constexpr FeatureBitset ImpliedFeaturesF16C = FeatureAVX;
543 constexpr FeatureBitset ImpliedFeaturesFMA = FeatureAVX;
544 constexpr FeatureBitset ImpliedFeaturesGFNI = FeatureSSE2;
545 constexpr FeatureBitset ImpliedFeaturesPCLMUL = FeatureSSE2;
546 constexpr FeatureBitset ImpliedFeaturesSHA = FeatureSSE2;
547 constexpr FeatureBitset ImpliedFeaturesVAES = FeatureAES | FeatureAVX;
548 constexpr FeatureBitset ImpliedFeaturesVPCLMULQDQ = FeatureAVX | FeaturePCLMUL;
549 
550 // AVX512 features.
551 constexpr FeatureBitset ImpliedFeaturesAVX512CD = FeatureAVX512F;
552 constexpr FeatureBitset ImpliedFeaturesAVX512BW = FeatureAVX512F;
553 constexpr FeatureBitset ImpliedFeaturesAVX512DQ = FeatureAVX512F;
554 constexpr FeatureBitset ImpliedFeaturesAVX512ER = FeatureAVX512F;
555 constexpr FeatureBitset ImpliedFeaturesAVX512PF = FeatureAVX512F;
556 constexpr FeatureBitset ImpliedFeaturesAVX512VL = FeatureAVX512F;
557 
558 constexpr FeatureBitset ImpliedFeaturesAVX512BF16 = FeatureAVX512BW;
559 constexpr FeatureBitset ImpliedFeaturesAVX512BITALG = FeatureAVX512BW;
560 constexpr FeatureBitset ImpliedFeaturesAVX512IFMA = FeatureAVX512F;
561 constexpr FeatureBitset ImpliedFeaturesAVX512VNNI = FeatureAVX512F;
562 constexpr FeatureBitset ImpliedFeaturesAVX512VPOPCNTDQ = FeatureAVX512F;
563 constexpr FeatureBitset ImpliedFeaturesAVX512VBMI = FeatureAVX512BW;
564 constexpr FeatureBitset ImpliedFeaturesAVX512VBMI2 = FeatureAVX512BW;
565 constexpr FeatureBitset ImpliedFeaturesAVX512VP2INTERSECT = FeatureAVX512F;
566 
567 // FIXME: These two aren't really implemented and just exist in the feature
568 // list for __builtin_cpu_supports. So omit their dependencies.
569 constexpr FeatureBitset ImpliedFeaturesAVX5124FMAPS = {};
570 constexpr FeatureBitset ImpliedFeaturesAVX5124VNNIW = {};
571 
572 // SSE4_A->FMA4->XOP chain.
573 constexpr FeatureBitset ImpliedFeaturesSSE4_A = FeatureSSE3;
574 constexpr FeatureBitset ImpliedFeaturesFMA4 = FeatureAVX | FeatureSSE4_A;
575 constexpr FeatureBitset ImpliedFeaturesXOP = FeatureFMA4;
576 
577 // AMX Features
578 constexpr FeatureBitset ImpliedFeaturesAMX_TILE = {};
579 constexpr FeatureBitset ImpliedFeaturesAMX_BF16 = FeatureAMX_TILE;
580 constexpr FeatureBitset ImpliedFeaturesAMX_INT8 = FeatureAMX_TILE;
581 constexpr FeatureBitset ImpliedFeaturesHRESET = {};
582 
583 static constexpr FeatureBitset ImpliedFeaturesAVX512FP16 =
584     FeatureAVX512BW | FeatureAVX512DQ | FeatureAVX512VL;
585 // Key Locker Features
586 constexpr FeatureBitset ImpliedFeaturesKL = FeatureSSE2;
587 constexpr FeatureBitset ImpliedFeaturesWIDEKL = FeatureKL;
588 
589 // AVXVNNI Features
590 constexpr FeatureBitset ImpliedFeaturesAVXVNNI = FeatureAVX2;
591 
592 constexpr FeatureInfo FeatureInfos[X86::CPU_FEATURE_MAX] = {
593 #define X86_FEATURE(ENUM, STR) {{STR}, ImpliedFeatures##ENUM},
594 #include "llvm/Support/X86TargetParser.def"
595 };
596 
597 void llvm::X86::getFeaturesForCPU(StringRef CPU,
598                                   SmallVectorImpl<StringRef> &EnabledFeatures) {
599   auto I = llvm::find_if(Processors,
600                          [&](const ProcInfo &P) { return P.Name == CPU; });
601   assert(I != std::end(Processors) && "Processor not found!");
602 
603   FeatureBitset Bits = I->Features;
604 
605   // Remove the 64-bit feature which we only use to validate if a CPU can
606   // be used with 64-bit mode.
607   Bits &= ~Feature64BIT;
608 
609   // Add the string version of all set bits.
610   for (unsigned i = 0; i != CPU_FEATURE_MAX; ++i)
611     if (Bits[i] && !FeatureInfos[i].Name.empty())
612       EnabledFeatures.push_back(FeatureInfos[i].Name);
613 }
614 
615 // For each feature that is (transitively) implied by this feature, set it.
616 static void getImpliedEnabledFeatures(FeatureBitset &Bits,
617                                       const FeatureBitset &Implies) {
618   // Fast path: Implies is often empty.
619   if (!Implies.any())
620     return;
621   FeatureBitset Prev;
622   Bits |= Implies;
623   do {
624     Prev = Bits;
625     for (unsigned i = CPU_FEATURE_MAX; i;)
626       if (Bits[--i])
627         Bits |= FeatureInfos[i].ImpliedFeatures;
628   } while (Prev != Bits);
629 }
630 
631 /// Create bit vector of features that are implied disabled if the feature
632 /// passed in Value is disabled.
633 static void getImpliedDisabledFeatures(FeatureBitset &Bits, unsigned Value) {
634   // Check all features looking for any dependent on this feature. If we find
635   // one, mark it and recursively find any feature that depend on it.
636   FeatureBitset Prev;
637   Bits.set(Value);
638   do {
639     Prev = Bits;
640     for (unsigned i = 0; i != CPU_FEATURE_MAX; ++i)
641       if ((FeatureInfos[i].ImpliedFeatures & Bits).any())
642         Bits.set(i);
643   } while (Prev != Bits);
644 }
645 
646 void llvm::X86::updateImpliedFeatures(
647     StringRef Feature, bool Enabled,
648     StringMap<bool> &Features) {
649   auto I = llvm::find_if(
650       FeatureInfos, [&](const FeatureInfo &FI) { return FI.Name == Feature; });
651   if (I == std::end(FeatureInfos)) {
652     // FIXME: This shouldn't happen, but may not have all features in the table
653     // yet.
654     return;
655   }
656 
657   FeatureBitset ImpliedBits;
658   if (Enabled)
659     getImpliedEnabledFeatures(ImpliedBits, I->ImpliedFeatures);
660   else
661     getImpliedDisabledFeatures(ImpliedBits,
662                                std::distance(std::begin(FeatureInfos), I));
663 
664   // Update the map entry for all implied features.
665   for (unsigned i = 0; i != CPU_FEATURE_MAX; ++i)
666     if (ImpliedBits[i] && !FeatureInfos[i].Name.empty())
667       Features[FeatureInfos[i].Name] = Enabled;
668 }
669 
670 uint64_t llvm::X86::getCpuSupportsMask(ArrayRef<StringRef> FeatureStrs) {
671   // Processor features and mapping to processor feature value.
672   uint64_t FeaturesMask = 0;
673   for (const StringRef &FeatureStr : FeatureStrs) {
674     unsigned Feature = StringSwitch<unsigned>(FeatureStr)
675 #define X86_FEATURE_COMPAT(ENUM, STR, PRIORITY)                                \
676   .Case(STR, llvm::X86::FEATURE_##ENUM)
677 #include "llvm/Support/X86TargetParser.def"
678         ;
679     FeaturesMask |= (1ULL << Feature);
680   }
681   return FeaturesMask;
682 }
683 
684 unsigned llvm::X86::getFeaturePriority(ProcessorFeatures Feat) {
685 #ifndef NDEBUG
686   // Check that priorities are set properly in the .def file. We expect that
687   // "compat" features are assigned non-duplicate consecutive priorities
688   // starting from zero (0, 1, ..., num_features - 1).
689 #define X86_FEATURE_COMPAT(ENUM, STR, PRIORITY) PRIORITY,
690   unsigned Priorities[] = {
691 #include "llvm/Support/X86TargetParser.def"
692       std::numeric_limits<unsigned>::max() // Need to consume last comma.
693   };
694   std::array<unsigned, array_lengthof(Priorities) - 1> HelperList;
695   std::iota(HelperList.begin(), HelperList.end(), 0);
696   assert(std::is_permutation(HelperList.begin(), HelperList.end(),
697                              std::begin(Priorities),
698                              std::prev(std::end(Priorities))) &&
699          "Priorities don't form consecutive range!");
700 #endif
701 
702   switch (Feat) {
703 #define X86_FEATURE_COMPAT(ENUM, STR, PRIORITY)                                \
704   case X86::FEATURE_##ENUM:                                                    \
705     return PRIORITY;
706 #include "llvm/Support/X86TargetParser.def"
707   default:
708     llvm_unreachable("No Feature Priority for non-CPUSupports Features");
709   }
710 }
711