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 
14 #include "llvm/Support/AArch64TargetParser.h"
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 
27 unsigned AArch64::getDefaultFPU(StringRef CPU, AArch64::ArchKind AK) {
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"
35   .Default(ARM::FK_INVALID);
36 }
37 
38 uint64_t AArch64::getDefaultExtensions(StringRef CPU, AArch64::ArchKind AK) {
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"
48   .Default(AArch64::AEK_INVALID);
49 }
50 
51 AArch64::ArchKind AArch64::getCPUArchKind(StringRef CPU) {
52   if (CPU == "generic")
53     return ArchKind::ARMV8A;
54 
55   return StringSwitch<AArch64::ArchKind>(CPU)
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 
104   return true;
105 }
106 
107 bool AArch64::getArchFeatures(AArch64::ArchKind AK,
108                               std::vector<StringRef> &Features) {
109   if (AK == ArchKind::ARMV8_1A)
110     Features.push_back("+v8.1a");
111   if (AK == ArchKind::ARMV8_2A)
112     Features.push_back("+v8.2a");
113   if (AK == ArchKind::ARMV8_3A)
114     Features.push_back("+v8.3a");
115   if (AK == ArchKind::ARMV8_4A)
116     Features.push_back("+v8.4a");
117   if (AK == ArchKind::ARMV8_5A)
118     Features.push_back("+v8.5a");
119   if (AK == AArch64::ArchKind::ARMV8_6A)
120     Features.push_back("+v8.6a");
121   if(AK == AArch64::ArchKind::ARMV8R)
122     Features.push_back("+v8r");
123 
124   return AK != ArchKind::INVALID;
125 }
126 
127 StringRef AArch64::getArchName(AArch64::ArchKind AK) {
128   return AArch64ARCHNames[static_cast<unsigned>(AK)].getName();
129 }
130 
131 StringRef AArch64::getCPUAttr(AArch64::ArchKind AK) {
132   return AArch64ARCHNames[static_cast<unsigned>(AK)].getCPUAttr();
133 }
134 
135 StringRef AArch64::getSubArch(AArch64::ArchKind AK) {
136   return AArch64ARCHNames[static_cast<unsigned>(AK)].getSubArch();
137 }
138 
139 unsigned AArch64::getArchAttr(AArch64::ArchKind AK) {
140   return AArch64ARCHNames[static_cast<unsigned>(AK)].ArchAttr;
141 }
142 
143 StringRef AArch64::getArchExtName(unsigned ArchExtKind) {
144   for (const auto &AE : AArch64ARCHExtNames)
145     if (ArchExtKind == AE.ID)
146       return AE.getName();
147   return StringRef();
148 }
149 
150 StringRef AArch64::getArchExtFeature(StringRef ArchExt) {
151   if (ArchExt.startswith("no")) {
152     StringRef ArchExtBase(ArchExt.substr(2));
153     for (const auto &AE : AArch64ARCHExtNames) {
154       if (AE.NegFeature && ArchExtBase == AE.getName())
155         return StringRef(AE.NegFeature);
156     }
157   }
158 
159   for (const auto &AE : AArch64ARCHExtNames)
160     if (AE.Feature && ArchExt == AE.getName())
161       return StringRef(AE.Feature);
162   return StringRef();
163 }
164 
165 StringRef AArch64::getDefaultCPU(StringRef Arch) {
166   ArchKind AK = parseArch(Arch);
167   if (AK == ArchKind::INVALID)
168     return StringRef();
169 
170   // Look for multiple AKs to find the default for pair AK+Name.
171   for (const auto &CPU : AArch64CPUNames)
172     if (CPU.ArchID == AK && CPU.Default)
173       return CPU.getName();
174 
175   // If we can't find a default then target the architecture instead
176   return "generic";
177 }
178 
179 void AArch64::fillValidCPUArchList(SmallVectorImpl<StringRef> &Values) {
180   for (const auto &Arch : AArch64CPUNames) {
181     if (Arch.ArchID != ArchKind::INVALID)
182       Values.push_back(Arch.getName());
183   }
184 }
185 
186 bool AArch64::isX18ReservedByDefault(const Triple &TT) {
187   return TT.isAndroid() || TT.isOSDarwin() || TT.isOSFuchsia() ||
188          TT.isOSWindows();
189 }
190 
191 // Allows partial match, ex. "v8a" matches "armv8a".
192 AArch64::ArchKind AArch64::parseArch(StringRef Arch) {
193   Arch = ARM::getCanonicalArchName(Arch);
194   if (checkArchVersion(Arch) < 8)
195     return ArchKind::INVALID;
196 
197   StringRef Syn = ARM::getArchSynonym(Arch);
198   for (const auto &A : AArch64ARCHNames) {
199     if (A.getName().endswith(Syn))
200       return A.ID;
201   }
202   return ArchKind::INVALID;
203 }
204 
205 AArch64::ArchExtKind AArch64::parseArchExt(StringRef ArchExt) {
206   for (const auto &A : AArch64ARCHExtNames) {
207     if (ArchExt == A.getName())
208       return static_cast<ArchExtKind>(A.ID);
209   }
210   return AArch64::AEK_INVALID;
211 }
212 
213 AArch64::ArchKind AArch64::parseCPUArch(StringRef CPU) {
214   for (const auto &C : AArch64CPUNames) {
215     if (CPU == C.getName())
216       return C.ArchID;
217   }
218   return ArchKind::INVALID;
219 }
220 
221 // Parse a branch protection specification, which has the form
222 //   standard | none | [bti,pac-ret[+b-key,+leaf]*]
223 // Returns true on success, with individual elements of the specification
224 // returned in `PBP`. Returns false in error, with `Err` containing
225 // an erroneous part of the spec.
226 bool AArch64::parseBranchProtection(StringRef Spec, ParsedBranchProtection &PBP,
227                                     StringRef &Err) {
228   PBP = {"none", "a_key", false};
229   if (Spec == "none")
230     return true; // defaults are ok
231 
232   if (Spec == "standard") {
233     PBP.Scope = "non-leaf";
234     PBP.BranchTargetEnforcement = true;
235     return true;
236   }
237 
238   SmallVector<StringRef, 4> Opts;
239   Spec.split(Opts, "+");
240   for (int I = 0, E = Opts.size(); I != E; ++I) {
241     StringRef Opt = Opts[I].trim();
242     if (Opt == "bti") {
243       PBP.BranchTargetEnforcement = true;
244       continue;
245     }
246     if (Opt == "pac-ret") {
247       PBP.Scope = "non-leaf";
248       for (; I + 1 != E; ++I) {
249         StringRef PACOpt = Opts[I + 1].trim();
250         if (PACOpt == "leaf")
251           PBP.Scope = "all";
252         else if (PACOpt == "b-key")
253           PBP.Key = "b_key";
254         else
255           break;
256       }
257       continue;
258     }
259     if (Opt == "")
260       Err = "<empty>";
261     else
262       Err = Opt;
263     return false;
264   }
265 
266   return true;
267 }
268