LLVM  13.0.0git
AArch64TargetParser.cpp
Go to the documentation of this file.
1 //===-- AArch64TargetParser - Parser for AArch64 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 AArch64 hardware features
10 // such as FPU/CPU/ARCH and extension names.
11 //
12 //===----------------------------------------------------------------------===//
13 
15 #include "llvm/ADT/StringSwitch.h"
16 #include "llvm/ADT/Triple.h"
17 #include <cctype>
18 
19 using namespace llvm;
20 
21 static unsigned checkArchVersion(llvm::StringRef Arch) {
22  if (Arch.size() >= 2 && Arch[0] == 'v' && std::isdigit(Arch[1]))
23  return (Arch[1] - 48);
24  return 0;
25 }
26 
28  if (CPU == "generic")
29  return AArch64ARCHNames[static_cast<unsigned>(AK)].DefaultFPU;
30 
31  return StringSwitch<unsigned>(CPU)
32 #define AARCH64_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
33  .Case(NAME, ARM::DEFAULT_FPU)
34 #include "../../include/llvm/Support/AArch64TargetParser.def"
36 }
37 
39  if (CPU == "generic")
40  return AArch64ARCHNames[static_cast<unsigned>(AK)].ArchBaseExtensions;
41 
42  return StringSwitch<uint64_t>(CPU)
43 #define AARCH64_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
44  .Case(NAME, AArch64ARCHNames[static_cast<unsigned>(ArchKind::ID)] \
45  .ArchBaseExtensions | \
46  DEFAULT_EXT)
47 #include "../../include/llvm/Support/AArch64TargetParser.def"
49 }
50 
52  if (CPU == "generic")
53  return ArchKind::ARMV8A;
54 
56 #define AARCH64_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
57  .Case(NAME, ArchKind::ID)
58 #include "../../include/llvm/Support/AArch64TargetParser.def"
59  .Default(ArchKind::INVALID);
60 }
61 
62 bool AArch64::getExtensionFeatures(uint64_t Extensions,
63  std::vector<StringRef> &Features) {
64  if (Extensions == AArch64::AEK_INVALID)
65  return false;
66 
67  if (Extensions & AEK_FP)
68  Features.push_back("+fp-armv8");
69  if (Extensions & AEK_SIMD)
70  Features.push_back("+neon");
71  if (Extensions & AEK_CRC)
72  Features.push_back("+crc");
73  if (Extensions & AEK_CRYPTO)
74  Features.push_back("+crypto");
75  if (Extensions & AEK_DOTPROD)
76  Features.push_back("+dotprod");
77  if (Extensions & AEK_FP16FML)
78  Features.push_back("+fp16fml");
79  if (Extensions & AEK_FP16)
80  Features.push_back("+fullfp16");
81  if (Extensions & AEK_PROFILE)
82  Features.push_back("+spe");
83  if (Extensions & AEK_RAS)
84  Features.push_back("+ras");
85  if (Extensions & AEK_LSE)
86  Features.push_back("+lse");
87  if (Extensions & AEK_RDM)
88  Features.push_back("+rdm");
89  if (Extensions & AEK_SVE)
90  Features.push_back("+sve");
91  if (Extensions & AEK_SVE2)
92  Features.push_back("+sve2");
93  if (Extensions & AEK_SVE2AES)
94  Features.push_back("+sve2-aes");
95  if (Extensions & AEK_SVE2SM4)
96  Features.push_back("+sve2-sm4");
97  if (Extensions & AEK_SVE2SHA3)
98  Features.push_back("+sve2-sha3");
99  if (Extensions & AEK_SVE2BITPERM)
100  Features.push_back("+sve2-bitperm");
101  if (Extensions & AEK_RCPC)
102  Features.push_back("+rcpc");
103  if (Extensions & AEK_BRBE)
104  Features.push_back("+brbe");
105  if (Extensions & AEK_PAUTH)
106  Features.push_back("+pauth");
107  if (Extensions & AEK_FLAGM)
108  Features.push_back("+flagm");
109 
110  return true;
111 }
112 
114  std::vector<StringRef> &Features) {
115  if (AK == ArchKind::ARMV8_1A)
116  Features.push_back("+v8.1a");
117  if (AK == ArchKind::ARMV8_2A)
118  Features.push_back("+v8.2a");
119  if (AK == ArchKind::ARMV8_3A)
120  Features.push_back("+v8.3a");
121  if (AK == ArchKind::ARMV8_4A)
122  Features.push_back("+v8.4a");
123  if (AK == ArchKind::ARMV8_5A)
124  Features.push_back("+v8.5a");
125  if (AK == AArch64::ArchKind::ARMV8_6A)
126  Features.push_back("+v8.6a");
127  if (AK == AArch64::ArchKind::ARMV8_7A)
128  Features.push_back("+v8.7a");
129  if(AK == AArch64::ArchKind::ARMV8R)
130  Features.push_back("+v8r");
131 
132  return AK != ArchKind::INVALID;
133 }
134 
136  return AArch64ARCHNames[static_cast<unsigned>(AK)].getName();
137 }
138 
140  return AArch64ARCHNames[static_cast<unsigned>(AK)].getCPUAttr();
141 }
142 
144  return AArch64ARCHNames[static_cast<unsigned>(AK)].getSubArch();
145 }
146 
148  return AArch64ARCHNames[static_cast<unsigned>(AK)].ArchAttr;
149 }
150 
152  for (const auto &AE : AArch64ARCHExtNames)
153  if (ArchExtKind == AE.ID)
154  return AE.getName();
155  return StringRef();
156 }
157 
159  if (ArchExt.startswith("no")) {
160  StringRef ArchExtBase(ArchExt.substr(2));
161  for (const auto &AE : AArch64ARCHExtNames) {
162  if (AE.NegFeature && ArchExtBase == AE.getName())
163  return StringRef(AE.NegFeature);
164  }
165  }
166 
167  for (const auto &AE : AArch64ARCHExtNames)
168  if (AE.Feature && ArchExt == AE.getName())
169  return StringRef(AE.Feature);
170  return StringRef();
171 }
172 
174  ArchKind AK = parseArch(Arch);
175  if (AK == ArchKind::INVALID)
176  return StringRef();
177 
178  // Look for multiple AKs to find the default for pair AK+Name.
179  for (const auto &CPU : AArch64CPUNames)
180  if (CPU.ArchID == AK && CPU.Default)
181  return CPU.getName();
182 
183  // If we can't find a default then target the architecture instead
184  return "generic";
185 }
186 
188  for (const auto &Arch : AArch64CPUNames) {
189  if (Arch.ArchID != ArchKind::INVALID)
190  Values.push_back(Arch.getName());
191  }
192 }
193 
195  return TT.isAndroid() || TT.isOSDarwin() || TT.isOSFuchsia() ||
196  TT.isOSWindows();
197 }
198 
199 // Allows partial match, ex. "v8a" matches "armv8a".
201  Arch = ARM::getCanonicalArchName(Arch);
202  if (checkArchVersion(Arch) < 8)
203  return ArchKind::INVALID;
204 
205  StringRef Syn = ARM::getArchSynonym(Arch);
206  for (const auto &A : AArch64ARCHNames) {
207  if (A.getName().endswith(Syn))
208  return A.ID;
209  }
210  return ArchKind::INVALID;
211 }
212 
214  for (const auto &A : AArch64ARCHExtNames) {
215  if (ArchExt == A.getName())
216  return static_cast<ArchExtKind>(A.ID);
217  }
218  return AArch64::AEK_INVALID;
219 }
220 
222  for (const auto &C : AArch64CPUNames) {
223  if (CPU == C.getName())
224  return C.ArchID;
225  }
226  return ArchKind::INVALID;
227 }
228 
229 // Parse a branch protection specification, which has the form
230 // standard | none | [bti,pac-ret[+b-key,+leaf]*]
231 // Returns true on success, with individual elements of the specification
232 // returned in `PBP`. Returns false in error, with `Err` containing
233 // an erroneous part of the spec.
235  StringRef &Err) {
236  PBP = {"none", "a_key", false};
237  if (Spec == "none")
238  return true; // defaults are ok
239 
240  if (Spec == "standard") {
241  PBP.Scope = "non-leaf";
242  PBP.BranchTargetEnforcement = true;
243  return true;
244  }
245 
247  Spec.split(Opts, "+");
248  for (int I = 0, E = Opts.size(); I != E; ++I) {
249  StringRef Opt = Opts[I].trim();
250  if (Opt == "bti") {
251  PBP.BranchTargetEnforcement = true;
252  continue;
253  }
254  if (Opt == "pac-ret") {
255  PBP.Scope = "non-leaf";
256  for (; I + 1 != E; ++I) {
257  StringRef PACOpt = Opts[I + 1].trim();
258  if (PACOpt == "leaf")
259  PBP.Scope = "all";
260  else if (PACOpt == "b-key")
261  PBP.Key = "b_key";
262  else
263  break;
264  }
265  continue;
266  }
267  if (Opt == "")
268  Err = "<empty>";
269  else
270  Err = Opt;
271  return false;
272  }
273 
274  return true;
275 }
llvm::AArch64::getArchFeatures
bool getArchFeatures(ArchKind AK, std::vector< StringRef > &Features)
Definition: AArch64TargetParser.cpp:113
llvm::StringRef::startswith
LLVM_NODISCARD bool startswith(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition: StringRef.h:286
getName
static StringRef getName(Value *V)
Definition: ProvenanceAnalysisEvaluator.cpp:42
llvm
Definition: AllocatorList.h:23
llvm::AArch64::ArchExtKind
ArchExtKind
Definition: AArch64TargetParser.h:30
llvm::AArch64::AEK_RCPC
@ AEK_RCPC
Definition: AArch64TargetParser.h:43
llvm::AArch64::AEK_SVE2
@ AEK_SVE2
Definition: AArch64TargetParser.h:55
llvm::ARM::getCanonicalArchName
StringRef getCanonicalArchName(StringRef Arch)
Definition: ARMTargetParser.cpp:279
AArch64TargetParser.h
llvm::AArch64::AEK_SIMD
@ AEK_SIMD
Definition: AArch64TargetParser.h:36
llvm::AArch64::AEK_CRYPTO
@ AEK_CRYPTO
Definition: AArch64TargetParser.h:34
llvm::StringSwitch::Default
LLVM_NODISCARD R Default(T Value)
Definition: StringSwitch.h:181
llvm::AArch64::getExtensionFeatures
bool getExtensionFeatures(uint64_t Extensions, std::vector< StringRef > &Features)
Definition: AArch64TargetParser.cpp:62
llvm::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1167
llvm::Triple
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:45
llvm::ARM::getArchSynonym
StringRef getArchSynonym(StringRef Arch)
Definition: ARMTargetParser.cpp:140
llvm::AArch64::getCPUAttr
StringRef getCPUAttr(ArchKind AK)
Definition: AArch64TargetParser.cpp:139
llvm::AArch64::AEK_FP16
@ AEK_FP16
Definition: AArch64TargetParser.h:37
llvm::AArch64::parseArchExt
ArchExtKind parseArchExt(StringRef ArchExt)
Definition: AArch64TargetParser.cpp:213
llvm::AArch64::AEK_SVE2SM4
@ AEK_SVE2SM4
Definition: AArch64TargetParser.h:57
llvm::AArch64::ParsedBranchProtection::Key
StringRef Key
Definition: AArch64TargetParser.h:139
llvm::AArch64::ParsedBranchProtection
Definition: AArch64TargetParser.h:137
llvm::AArch64::getArchExtName
StringRef getArchExtName(unsigned ArchExtKind)
Definition: AArch64TargetParser.cpp:151
llvm::AArch64::getDefaultExtensions
uint64_t getDefaultExtensions(StringRef CPU, ArchKind AK)
Definition: AArch64TargetParser.cpp:38
llvm::AArch64::getDefaultCPU
StringRef getDefaultCPU(StringRef Arch)
Definition: AArch64TargetParser.cpp:173
llvm::AArch64::getArchAttr
unsigned getArchAttr(ArchKind AK)
Definition: AArch64TargetParser.cpp:147
llvm::AArch64::AEK_DOTPROD
@ AEK_DOTPROD
Definition: AArch64TargetParser.h:42
llvm::AArch64::getArchExtFeature
StringRef getArchExtFeature(StringRef ArchExt)
Definition: AArch64TargetParser.cpp:158
llvm::StringRef::substr
LLVM_NODISCARD StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:609
llvm::AArch64::AArch64CPUNames
const ARM::CpuNames< ArchKind > AArch64CPUNames[]
Definition: AArch64TargetParser.h:98
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::AArch64::AEK_INVALID
@ AEK_INVALID
Definition: AArch64TargetParser.h:31
llvm::StringRef::split
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:727
llvm::AArch64::AEK_SVE2AES
@ AEK_SVE2AES
Definition: AArch64TargetParser.h:56
C
(vector float) vec_cmpeq(*A, *B) C
Definition: README_ALTIVEC.txt:86
llvm::AArch64::ParsedBranchProtection::Scope
StringRef Scope
Definition: AArch64TargetParser.h:138
llvm::AArch64::AEK_SVE2SHA3
@ AEK_SVE2SHA3
Definition: AArch64TargetParser.h:58
llvm::AArch64::AEK_LSE
@ AEK_LSE
Definition: AArch64TargetParser.h:40
llvm::AArch64::ParsedBranchProtection::BranchTargetEnforcement
bool BranchTargetEnforcement
Definition: AArch64TargetParser.h:140
llvm::AArch64::isX18ReservedByDefault
bool isX18ReservedByDefault(const Triple &TT)
Definition: AArch64TargetParser.cpp:194
llvm::AArch64::AEK_SVE
@ AEK_SVE
Definition: AArch64TargetParser.h:41
llvm::AArch64::getDefaultFPU
unsigned getDefaultFPU(StringRef CPU, ArchKind AK)
Definition: AArch64TargetParser.cpp:27
llvm::AArch64::parseBranchProtection
bool parseBranchProtection(StringRef Spec, ParsedBranchProtection &PBP, StringRef &Err)
Definition: AArch64TargetParser.cpp:234
checkArchVersion
static unsigned checkArchVersion(llvm::StringRef Arch)
Definition: AArch64TargetParser.cpp:21
parseArch
static Triple::ArchType parseArch(StringRef ArchName)
Definition: Triple.cpp:403
llvm::AArch64::AEK_CRC
@ AEK_CRC
Definition: AArch64TargetParser.h:33
I
#define I(x, y, z)
Definition: MD5.cpp:59
llvm::AArch64::getArchName
StringRef getArchName(ArchKind AK)
Definition: AArch64TargetParser.cpp:135
llvm::AArch64::AEK_RDM
@ AEK_RDM
Definition: AArch64TargetParser.h:44
llvm::AArch64::AArch64ARCHNames
const ARM::ArchNames< ArchKind > AArch64ARCHNames[]
Definition: AArch64TargetParser.h:76
llvm::AArch64::fillValidCPUArchList
void fillValidCPUArchList(SmallVectorImpl< StringRef > &Values)
Definition: AArch64TargetParser.cpp:187
llvm::AArch64::parseCPUArch
ArchKind parseCPUArch(StringRef CPU)
Definition: AArch64TargetParser.cpp:221
llvm::AArch64::AEK_BRBE
@ AEK_BRBE
Definition: AArch64TargetParser.h:66
Triple.h
llvm::AArch64::AEK_RAS
@ AEK_RAS
Definition: AArch64TargetParser.h:39
llvm::AArch64::parseArch
ArchKind parseArch(StringRef Arch)
Definition: AArch64TargetParser.cpp:200
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
llvm::AArch64::AArch64ARCHExtNames
const ARM::ExtName AArch64ARCHExtNames[]
Definition: AArch64TargetParser.h:92
llvm::AArch64::AEK_PAUTH
@ AEK_PAUTH
Definition: AArch64TargetParser.h:67
llvm::AArch64::AEK_PROFILE
@ AEK_PROFILE
Definition: AArch64TargetParser.h:38
llvm::RISCV::FK_INVALID
@ FK_INVALID
Definition: TargetParser.h:156
llvm::AArch64::AEK_SVE2BITPERM
@ AEK_SVE2BITPERM
Definition: AArch64TargetParser.h:59
llvm::AArch64::getSubArch
StringRef getSubArch(ArchKind AK)
Definition: AArch64TargetParser.cpp:143
StringSwitch.h
llvm::AArch64::AEK_FLAGM
@ AEK_FLAGM
Definition: AArch64TargetParser.h:68
llvm::AArch64::getCPUArchKind
ArchKind getCPUArchKind(StringRef CPU)
Definition: AArch64TargetParser.cpp:51
llvm::AArch64::AEK_FP
@ AEK_FP
Definition: AArch64TargetParser.h:35
llvm::AArch64::ArchKind
ArchKind
Definition: AArch64TargetParser.h:71
llvm::SmallVectorImpl< StringRef >
llvm::StringSwitch
A switch()-like statement whose cases are string literals.
Definition: StringSwitch.h:42
llvm::AArch64::AEK_FP16FML
@ AEK_FP16FML
Definition: AArch64TargetParser.h:49
llvm::StringRef::size
LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:157