1 //===-- TargetParser - Parser for target features ---------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements a target parser to recognise hardware features such as
11 // FPU/CPU/ARCH names as well as specific support such as HDIV, etc.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "llvm/Support/ARMBuildAttributes.h"
16 #include "llvm/Support/TargetParser.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/ADT/StringSwitch.h"
19 #include "llvm/ADT/Twine.h"
20 #include <cctype>
21 
22 using namespace llvm;
23 using namespace ARM;
24 using namespace AArch64;
25 
26 namespace {
27 
28 // List of canonical FPU names (use getFPUSynonym) and which architectural
29 // features they correspond to (use getFPUFeatures).
30 // FIXME: TableGen this.
31 // The entries must appear in the order listed in ARM::FPUKind for correct indexing
32 static const struct {
33   const char *NameCStr;
34   size_t NameLength;
35   ARM::FPUKind ID;
36   ARM::FPUVersion FPUVersion;
37   ARM::NeonSupportLevel NeonSupport;
38   ARM::FPURestriction Restriction;
39 
40   StringRef getName() const { return StringRef(NameCStr, NameLength); }
41 } FPUNames[] = {
42 #define ARM_FPU(NAME, KIND, VERSION, NEON_SUPPORT, RESTRICTION) \
43   { NAME, sizeof(NAME) - 1, KIND, VERSION, NEON_SUPPORT, RESTRICTION },
44 #include "llvm/Support/ARMTargetParser.def"
45 };
46 
47 // List of canonical arch names (use getArchSynonym).
48 // This table also provides the build attribute fields for CPU arch
49 // and Arch ID, according to the Addenda to the ARM ABI, chapters
50 // 2.4 and 2.3.5.2 respectively.
51 // FIXME: SubArch values were simplified to fit into the expectations
52 // of the triples and are not conforming with their official names.
53 // Check to see if the expectation should be changed.
54 // FIXME: TableGen this.
55 template <typename T> struct ArchNames {
56   const char *NameCStr;
57   size_t NameLength;
58   const char *CPUAttrCStr;
59   size_t CPUAttrLength;
60   const char *SubArchCStr;
61   size_t SubArchLength;
62   unsigned DefaultFPU;
63   unsigned ArchBaseExtensions;
64   T ID;
65   ARMBuildAttrs::CPUArch ArchAttr; // Arch ID in build attributes.
66 
67   StringRef getName() const { return StringRef(NameCStr, NameLength); }
68 
69   // CPU class in build attributes.
70   StringRef getCPUAttr() const { return StringRef(CPUAttrCStr, CPUAttrLength); }
71 
72   // Sub-Arch name.
73   StringRef getSubArch() const { return StringRef(SubArchCStr, SubArchLength); }
74 };
75 ArchNames<ARM::ArchKind> ARCHNames[] = {
76 #define ARM_ARCH(NAME, ID, CPU_ATTR, SUB_ARCH, ARCH_ATTR, ARCH_FPU, ARCH_BASE_EXT)       \
77   {NAME, sizeof(NAME) - 1, CPU_ATTR, sizeof(CPU_ATTR) - 1, SUB_ARCH,       \
78    sizeof(SUB_ARCH) - 1, ARCH_FPU, ARCH_BASE_EXT, ARM::ArchKind::ID, ARCH_ATTR},
79 #include "llvm/Support/ARMTargetParser.def"
80 };
81 
82 ArchNames<AArch64::ArchKind> AArch64ARCHNames[] = {
83  #define AARCH64_ARCH(NAME, ID, CPU_ATTR, SUB_ARCH, ARCH_ATTR, ARCH_FPU, ARCH_BASE_EXT)       \
84    {NAME, sizeof(NAME) - 1, CPU_ATTR, sizeof(CPU_ATTR) - 1, SUB_ARCH,       \
85     sizeof(SUB_ARCH) - 1, ARCH_FPU, ARCH_BASE_EXT, AArch64::ArchKind::ID, ARCH_ATTR},
86  #include "llvm/Support/AArch64TargetParser.def"
87  };
88 
89 
90 // List of Arch Extension names.
91 // FIXME: TableGen this.
92 static const struct {
93   const char *NameCStr;
94   size_t NameLength;
95   unsigned ID;
96   const char *Feature;
97   const char *NegFeature;
98 
99   StringRef getName() const { return StringRef(NameCStr, NameLength); }
100 } ARCHExtNames[] = {
101 #define ARM_ARCH_EXT_NAME(NAME, ID, FEATURE, NEGFEATURE) \
102   { NAME, sizeof(NAME) - 1, ID, FEATURE, NEGFEATURE },
103 #include "llvm/Support/ARMTargetParser.def"
104 },AArch64ARCHExtNames[] = {
105 #define AARCH64_ARCH_EXT_NAME(NAME, ID, FEATURE, NEGFEATURE) \
106   { NAME, sizeof(NAME) - 1, ID, FEATURE, NEGFEATURE },
107 #include "llvm/Support/AArch64TargetParser.def"
108 };
109 
110 // List of HWDiv names (use getHWDivSynonym) and which architectural
111 // features they correspond to (use getHWDivFeatures).
112 // FIXME: TableGen this.
113 static const struct {
114   const char *NameCStr;
115   size_t NameLength;
116   unsigned ID;
117 
118   StringRef getName() const { return StringRef(NameCStr, NameLength); }
119 } HWDivNames[] = {
120 #define ARM_HW_DIV_NAME(NAME, ID) { NAME, sizeof(NAME) - 1, ID },
121 #include "llvm/Support/ARMTargetParser.def"
122 };
123 
124 // List of CPU names and their arches.
125 // The same CPU can have multiple arches and can be default on multiple arches.
126 // When finding the Arch for a CPU, first-found prevails. Sort them accordingly.
127 // When this becomes table-generated, we'd probably need two tables.
128 // FIXME: TableGen this.
129 template <typename T> struct CpuNames {
130   const char *NameCStr;
131   size_t NameLength;
132   T ArchID;
133   bool Default; // is $Name the default CPU for $ArchID ?
134   unsigned DefaultExtensions;
135 
136   StringRef getName() const { return StringRef(NameCStr, NameLength); }
137 };
138 CpuNames<ARM::ArchKind> CPUNames[] = {
139 #define ARM_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
140   { NAME, sizeof(NAME) - 1, ARM::ArchKind::ID, IS_DEFAULT, DEFAULT_EXT },
141 #include "llvm/Support/ARMTargetParser.def"
142 };
143 
144 CpuNames<AArch64::ArchKind> AArch64CPUNames[] = {
145  #define AARCH64_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
146    { NAME, sizeof(NAME) - 1, AArch64::ArchKind::ID, IS_DEFAULT, DEFAULT_EXT },
147  #include "llvm/Support/AArch64TargetParser.def"
148  };
149 
150 } // namespace
151 
152 // ======================================================= //
153 // Information by ID
154 // ======================================================= //
155 
156 StringRef ARM::getFPUName(unsigned FPUKind) {
157   if (FPUKind >= ARM::FK_LAST)
158     return StringRef();
159   return FPUNames[FPUKind].getName();
160 }
161 
162 FPUVersion ARM::getFPUVersion(unsigned FPUKind) {
163   if (FPUKind >= ARM::FK_LAST)
164     return FPUVersion::NONE;
165   return FPUNames[FPUKind].FPUVersion;
166 }
167 
168 ARM::NeonSupportLevel ARM::getFPUNeonSupportLevel(unsigned FPUKind) {
169   if (FPUKind >= ARM::FK_LAST)
170     return ARM::NeonSupportLevel::None;
171   return FPUNames[FPUKind].NeonSupport;
172 }
173 
174 ARM::FPURestriction ARM::getFPURestriction(unsigned FPUKind) {
175   if (FPUKind >= ARM::FK_LAST)
176     return ARM::FPURestriction::None;
177   return FPUNames[FPUKind].Restriction;
178 }
179 
180 unsigned llvm::ARM::getDefaultFPU(StringRef CPU, ArchKind AK) {
181   if (CPU == "generic")
182     return ARCHNames[static_cast<unsigned>(AK)].DefaultFPU;
183 
184   return StringSwitch<unsigned>(CPU)
185 #define ARM_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
186     .Case(NAME, DEFAULT_FPU)
187 #include "llvm/Support/ARMTargetParser.def"
188     .Default(ARM::FK_INVALID);
189 }
190 
191 unsigned llvm::ARM::getDefaultExtensions(StringRef CPU, ArchKind AK) {
192   if (CPU == "generic")
193     return ARCHNames[static_cast<unsigned>(AK)].ArchBaseExtensions;
194 
195   return StringSwitch<unsigned>(CPU)
196 #define ARM_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
197     .Case(NAME, ARCHNames[static_cast<unsigned>(ARM::ArchKind::ID)]\
198             .ArchBaseExtensions | DEFAULT_EXT)
199 #include "llvm/Support/ARMTargetParser.def"
200     .Default(ARM::AEK_INVALID);
201 }
202 
203 bool llvm::ARM::getHWDivFeatures(unsigned HWDivKind,
204                                  std::vector<StringRef> &Features) {
205 
206   if (HWDivKind == ARM::AEK_INVALID)
207     return false;
208 
209   if (HWDivKind & ARM::AEK_HWDIVARM)
210     Features.push_back("+hwdiv-arm");
211   else
212     Features.push_back("-hwdiv-arm");
213 
214   if (HWDivKind & ARM::AEK_HWDIVTHUMB)
215     Features.push_back("+hwdiv");
216   else
217     Features.push_back("-hwdiv");
218 
219   return true;
220 }
221 
222 bool llvm::ARM::getExtensionFeatures(unsigned Extensions,
223                                      std::vector<StringRef> &Features) {
224 
225   if (Extensions == ARM::AEK_INVALID)
226     return false;
227 
228   if (Extensions & ARM::AEK_CRC)
229     Features.push_back("+crc");
230   else
231     Features.push_back("-crc");
232 
233   if (Extensions & ARM::AEK_DSP)
234     Features.push_back("+dsp");
235   else
236     Features.push_back("-dsp");
237 
238   return getHWDivFeatures(Extensions, Features);
239 }
240 
241 bool llvm::ARM::getFPUFeatures(unsigned FPUKind,
242                                std::vector<StringRef> &Features) {
243 
244   if (FPUKind >= ARM::FK_LAST || FPUKind == ARM::FK_INVALID)
245     return false;
246 
247   // fp-only-sp and d16 subtarget features are independent of each other, so we
248   // must enable/disable both.
249   switch (FPUNames[FPUKind].Restriction) {
250   case ARM::FPURestriction::SP_D16:
251     Features.push_back("+fp-only-sp");
252     Features.push_back("+d16");
253     break;
254   case ARM::FPURestriction::D16:
255     Features.push_back("-fp-only-sp");
256     Features.push_back("+d16");
257     break;
258   case ARM::FPURestriction::None:
259     Features.push_back("-fp-only-sp");
260     Features.push_back("-d16");
261     break;
262   }
263 
264   // FPU version subtarget features are inclusive of lower-numbered ones, so
265   // enable the one corresponding to this version and disable all that are
266   // higher. We also have to make sure to disable fp16 when vfp4 is disabled,
267   // as +vfp4 implies +fp16 but -vfp4 does not imply -fp16.
268   switch (FPUNames[FPUKind].FPUVersion) {
269   case ARM::FPUVersion::VFPV5:
270     Features.push_back("+fp-armv8");
271     break;
272   case ARM::FPUVersion::VFPV4:
273     Features.push_back("+vfp4");
274     Features.push_back("-fp-armv8");
275     break;
276   case ARM::FPUVersion::VFPV3_FP16:
277     Features.push_back("+vfp3");
278     Features.push_back("+fp16");
279     Features.push_back("-vfp4");
280     Features.push_back("-fp-armv8");
281     break;
282   case ARM::FPUVersion::VFPV3:
283     Features.push_back("+vfp3");
284     Features.push_back("-fp16");
285     Features.push_back("-vfp4");
286     Features.push_back("-fp-armv8");
287     break;
288   case ARM::FPUVersion::VFPV2:
289     Features.push_back("+vfp2");
290     Features.push_back("-vfp3");
291     Features.push_back("-fp16");
292     Features.push_back("-vfp4");
293     Features.push_back("-fp-armv8");
294     break;
295   case ARM::FPUVersion::NONE:
296     Features.push_back("-vfp2");
297     Features.push_back("-vfp3");
298     Features.push_back("-fp16");
299     Features.push_back("-vfp4");
300     Features.push_back("-fp-armv8");
301     break;
302   }
303 
304   // crypto includes neon, so we handle this similarly to FPU version.
305   switch (FPUNames[FPUKind].NeonSupport) {
306   case ARM::NeonSupportLevel::Crypto:
307     Features.push_back("+neon");
308     Features.push_back("+crypto");
309     break;
310   case ARM::NeonSupportLevel::Neon:
311     Features.push_back("+neon");
312     Features.push_back("-crypto");
313     break;
314   case ARM::NeonSupportLevel::None:
315     Features.push_back("-neon");
316     Features.push_back("-crypto");
317     break;
318   }
319 
320   return true;
321 }
322 
323 StringRef llvm::ARM::getArchName(ArchKind AK) {
324   return ARCHNames[static_cast<unsigned>(AK)].getName();
325 }
326 
327 StringRef llvm::ARM::getCPUAttr(ArchKind AK) {
328   return ARCHNames[static_cast<unsigned>(AK)].getCPUAttr();
329 }
330 
331 StringRef llvm::ARM::getSubArch(ArchKind AK) {
332   return ARCHNames[static_cast<unsigned>(AK)].getSubArch();
333 }
334 
335 unsigned llvm::ARM::getArchAttr(ArchKind AK) {
336   return ARCHNames[static_cast<unsigned>(AK)].ArchAttr;
337 }
338 
339 StringRef llvm::ARM::getArchExtName(unsigned ArchExtKind) {
340   for (const auto AE : ARCHExtNames) {
341     if (ArchExtKind == AE.ID)
342       return AE.getName();
343   }
344   return StringRef();
345 }
346 
347 StringRef llvm::ARM::getArchExtFeature(StringRef ArchExt) {
348   if (ArchExt.startswith("no")) {
349     StringRef ArchExtBase(ArchExt.substr(2));
350     for (const auto AE : ARCHExtNames) {
351       if (AE.NegFeature && ArchExtBase == AE.getName())
352         return StringRef(AE.NegFeature);
353     }
354   }
355   for (const auto AE : ARCHExtNames) {
356     if (AE.Feature && ArchExt == AE.getName())
357       return StringRef(AE.Feature);
358   }
359 
360   return StringRef();
361 }
362 
363 StringRef llvm::ARM::getHWDivName(unsigned HWDivKind) {
364   for (const auto D : HWDivNames) {
365     if (HWDivKind == D.ID)
366       return D.getName();
367   }
368   return StringRef();
369 }
370 
371 StringRef llvm::ARM::getDefaultCPU(StringRef Arch) {
372   ArchKind AK = parseArch(Arch);
373   if (AK == ARM::ArchKind::INVALID)
374     return StringRef();
375 
376   // Look for multiple AKs to find the default for pair AK+Name.
377   for (const auto CPU : CPUNames) {
378     if (CPU.ArchID == AK && CPU.Default)
379       return CPU.getName();
380   }
381 
382   // If we can't find a default then target the architecture instead
383   return "generic";
384 }
385 
386 StringRef llvm::AArch64::getFPUName(unsigned FPUKind) {
387   return ARM::getFPUName(FPUKind);
388 }
389 
390 ARM::FPUVersion AArch64::getFPUVersion(unsigned FPUKind) {
391   return ARM::getFPUVersion(FPUKind);
392 }
393 
394 ARM::NeonSupportLevel AArch64::getFPUNeonSupportLevel(unsigned FPUKind) {
395   return ARM::getFPUNeonSupportLevel( FPUKind);
396 }
397 
398 ARM::FPURestriction AArch64::getFPURestriction(unsigned FPUKind) {
399   return ARM::getFPURestriction(FPUKind);
400 }
401 
402 unsigned llvm::AArch64::getDefaultFPU(StringRef CPU, ArchKind AK) {
403   if (CPU == "generic")
404     return AArch64ARCHNames[static_cast<unsigned>(AK)].DefaultFPU;
405 
406   return StringSwitch<unsigned>(CPU)
407 #define AARCH64_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT) \
408     .Case(NAME, DEFAULT_FPU)
409 #include "llvm/Support/AArch64TargetParser.def"
410     .Default(ARM::FK_INVALID);
411 }
412 
413 unsigned llvm::AArch64::getDefaultExtensions(StringRef CPU, ArchKind AK) {
414   if (CPU == "generic")
415     return AArch64ARCHNames[static_cast<unsigned>(AK)].ArchBaseExtensions;
416 
417   return StringSwitch<unsigned>(CPU)
418 #define AARCH64_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT, DEFAULT_EXT)       \
419   .Case(NAME,                                                                  \
420         AArch64ARCHNames[static_cast<unsigned>(AArch64::ArchKind::ID)] \
421             .ArchBaseExtensions | \
422             DEFAULT_EXT)
423 #include "llvm/Support/AArch64TargetParser.def"
424     .Default(AArch64::AEK_INVALID);
425 }
426 
427 bool llvm::AArch64::getExtensionFeatures(unsigned Extensions,
428                                      std::vector<StringRef> &Features) {
429 
430   if (Extensions == AArch64::AEK_INVALID)
431     return false;
432 
433   if (Extensions & AArch64::AEK_FP)
434     Features.push_back("+fp-armv8");
435   if (Extensions & AArch64::AEK_SIMD)
436     Features.push_back("+neon");
437   if (Extensions & AArch64::AEK_CRC)
438     Features.push_back("+crc");
439   if (Extensions & AArch64::AEK_CRYPTO)
440     Features.push_back("+crypto");
441   if (Extensions & AArch64::AEK_FP16)
442     Features.push_back("+fullfp16");
443   if (Extensions & AArch64::AEK_PROFILE)
444     Features.push_back("+spe");
445   if (Extensions & AArch64::AEK_RAS)
446     Features.push_back("+ras");
447   if (Extensions & AArch64::AEK_LSE)
448     Features.push_back("+lse");
449   if (Extensions & AArch64::AEK_SVE)
450     Features.push_back("+sve");
451 
452   return true;
453 }
454 
455 bool llvm::AArch64::getFPUFeatures(unsigned FPUKind,
456                                std::vector<StringRef> &Features) {
457   return ARM::getFPUFeatures(FPUKind, Features);
458 }
459 
460 bool llvm::AArch64::getArchFeatures(AArch64::ArchKind AK,
461                                     std::vector<StringRef> &Features) {
462   if (AK == AArch64::ArchKind::ARMV8_1A)
463     Features.push_back("+v8.1a");
464   if (AK == AArch64::ArchKind::ARMV8_2A)
465     Features.push_back("+v8.2a");
466   if (AK == AArch64::ArchKind::ARMV8_3A)
467     Features.push_back("+v8.3a");
468 
469   return AK != AArch64::ArchKind::INVALID;
470 }
471 
472 StringRef llvm::AArch64::getArchName(ArchKind AK) {
473   return AArch64ARCHNames[static_cast<unsigned>(AK)].getName();
474 }
475 
476 StringRef llvm::AArch64::getCPUAttr(ArchKind AK) {
477   return AArch64ARCHNames[static_cast<unsigned>(AK)].getCPUAttr();
478 }
479 
480 StringRef llvm::AArch64::getSubArch(ArchKind AK) {
481   return AArch64ARCHNames[static_cast<unsigned>(AK)].getSubArch();
482 }
483 
484 unsigned llvm::AArch64::getArchAttr(ArchKind AK) {
485   return AArch64ARCHNames[static_cast<unsigned>(AK)].ArchAttr;
486 }
487 
488 StringRef llvm::AArch64::getArchExtName(unsigned ArchExtKind) {
489   for (const auto &AE : AArch64ARCHExtNames)
490     if (ArchExtKind == AE.ID)
491       return AE.getName();
492   return StringRef();
493 }
494 
495 StringRef llvm::AArch64::getArchExtFeature(StringRef ArchExt) {
496   if (ArchExt.startswith("no")) {
497     StringRef ArchExtBase(ArchExt.substr(2));
498     for (const auto &AE : AArch64ARCHExtNames) {
499       if (AE.NegFeature && ArchExtBase == AE.getName())
500         return StringRef(AE.NegFeature);
501     }
502   }
503 
504   for (const auto &AE : AArch64ARCHExtNames)
505     if (AE.Feature && ArchExt == AE.getName())
506       return StringRef(AE.Feature);
507   return StringRef();
508 }
509 
510 StringRef llvm::AArch64::getDefaultCPU(StringRef Arch) {
511   AArch64::ArchKind AK = parseArch(Arch);
512   if (AK == ArchKind::INVALID)
513     return StringRef();
514 
515   // Look for multiple AKs to find the default for pair AK+Name.
516   for (const auto &CPU : AArch64CPUNames)
517     if (CPU.ArchID == AK && CPU.Default)
518       return CPU.getName();
519 
520   // If we can't find a default then target the architecture instead
521   return "generic";
522 }
523 
524 unsigned llvm::AArch64::checkArchVersion(StringRef Arch) {
525   if (Arch[0] == 'v' && std::isdigit(Arch[1]))
526     return (Arch[1] - 48);
527   return 0;
528 }
529 
530 // ======================================================= //
531 // Parsers
532 // ======================================================= //
533 
534 static StringRef getHWDivSynonym(StringRef HWDiv) {
535   return StringSwitch<StringRef>(HWDiv)
536       .Case("thumb,arm", "arm,thumb")
537       .Default(HWDiv);
538 }
539 
540 static StringRef getFPUSynonym(StringRef FPU) {
541   return StringSwitch<StringRef>(FPU)
542       .Cases("fpa", "fpe2", "fpe3", "maverick", "invalid") // Unsupported
543       .Case("vfp2", "vfpv2")
544       .Case("vfp3", "vfpv3")
545       .Case("vfp4", "vfpv4")
546       .Case("vfp3-d16", "vfpv3-d16")
547       .Case("vfp4-d16", "vfpv4-d16")
548       .Cases("fp4-sp-d16", "vfpv4-sp-d16", "fpv4-sp-d16")
549       .Cases("fp4-dp-d16", "fpv4-dp-d16", "vfpv4-d16")
550       .Case("fp5-sp-d16", "fpv5-sp-d16")
551       .Cases("fp5-dp-d16", "fpv5-dp-d16", "fpv5-d16")
552       // FIXME: Clang uses it, but it's bogus, since neon defaults to vfpv3.
553       .Case("neon-vfpv3", "neon")
554       .Default(FPU);
555 }
556 
557 static StringRef getArchSynonym(StringRef Arch) {
558   return StringSwitch<StringRef>(Arch)
559       .Case("v5", "v5t")
560       .Case("v5e", "v5te")
561       .Case("v6j", "v6")
562       .Case("v6hl", "v6k")
563       .Cases("v6m", "v6sm", "v6s-m", "v6-m")
564       .Cases("v6z", "v6zk", "v6kz")
565       .Cases("v7", "v7a", "v7hl", "v7l", "v7-a")
566       .Case("v7r", "v7-r")
567       .Case("v7m", "v7-m")
568       .Case("v7em", "v7e-m")
569       .Cases("v8", "v8a", "aarch64", "arm64", "v8-a")
570       .Case("v8.1a", "v8.1-a")
571       .Case("v8.2a", "v8.2-a")
572       .Case("v8.3a", "v8.3-a")
573       .Case("v8r", "v8-r")
574       .Case("v8m.base", "v8-m.base")
575       .Case("v8m.main", "v8-m.main")
576       .Default(Arch);
577 }
578 
579 // MArch is expected to be of the form (arm|thumb)?(eb)?(v.+)?(eb)?, but
580 // (iwmmxt|xscale)(eb)? is also permitted. If the former, return
581 // "v.+", if the latter, return unmodified string, minus 'eb'.
582 // If invalid, return empty string.
583 StringRef llvm::ARM::getCanonicalArchName(StringRef Arch) {
584   size_t offset = StringRef::npos;
585   StringRef A = Arch;
586   StringRef Error = "";
587 
588   // Begins with "arm" / "thumb", move past it.
589   if (A.startswith("arm64"))
590     offset = 5;
591   else if (A.startswith("arm"))
592     offset = 3;
593   else if (A.startswith("thumb"))
594     offset = 5;
595   else if (A.startswith("aarch64")) {
596     offset = 7;
597     // AArch64 uses "_be", not "eb" suffix.
598     if (A.find("eb") != StringRef::npos)
599       return Error;
600     if (A.substr(offset, 3) == "_be")
601       offset += 3;
602   }
603 
604   // Ex. "armebv7", move past the "eb".
605   if (offset != StringRef::npos && A.substr(offset, 2) == "eb")
606     offset += 2;
607   // Or, if it ends with eb ("armv7eb"), chop it off.
608   else if (A.endswith("eb"))
609     A = A.substr(0, A.size() - 2);
610   // Trim the head
611   if (offset != StringRef::npos)
612     A = A.substr(offset);
613 
614   // Empty string means offset reached the end, which means it's valid.
615   if (A.empty())
616     return Arch;
617 
618   // Only match non-marketing names
619   if (offset != StringRef::npos) {
620     // Must start with 'vN'.
621     if (A[0] != 'v' || !std::isdigit(A[1]))
622       return Error;
623     // Can't have an extra 'eb'.
624     if (A.find("eb") != StringRef::npos)
625       return Error;
626   }
627 
628   // Arch will either be a 'v' name (v7a) or a marketing name (xscale).
629   return A;
630 }
631 
632 unsigned llvm::ARM::parseHWDiv(StringRef HWDiv) {
633   StringRef Syn = getHWDivSynonym(HWDiv);
634   for (const auto D : HWDivNames) {
635     if (Syn == D.getName())
636       return D.ID;
637   }
638   return ARM::AEK_INVALID;
639 }
640 
641 unsigned llvm::ARM::parseFPU(StringRef FPU) {
642   StringRef Syn = getFPUSynonym(FPU);
643   for (const auto F : FPUNames) {
644     if (Syn == F.getName())
645       return F.ID;
646   }
647   return ARM::FK_INVALID;
648 }
649 
650 // Allows partial match, ex. "v7a" matches "armv7a".
651 ARM::ArchKind ARM::parseArch(StringRef Arch) {
652   Arch = getCanonicalArchName(Arch);
653   StringRef Syn = getArchSynonym(Arch);
654   for (const auto A : ARCHNames) {
655     if (A.getName().endswith(Syn))
656       return A.ID;
657   }
658   return ARM::ArchKind::INVALID;
659 }
660 
661 unsigned llvm::ARM::parseArchExt(StringRef ArchExt) {
662   for (const auto A : ARCHExtNames) {
663     if (ArchExt == A.getName())
664       return A.ID;
665   }
666   return ARM::AEK_INVALID;
667 }
668 
669 ARM::ArchKind llvm::ARM::parseCPUArch(StringRef CPU) {
670   for (const auto C : CPUNames) {
671     if (CPU == C.getName())
672       return C.ArchID;
673   }
674   return ARM::ArchKind::INVALID;
675 }
676 
677 // ARM, Thumb, AArch64
678 ARM::ISAKind ARM::parseArchISA(StringRef Arch) {
679   return StringSwitch<ARM::ISAKind>(Arch)
680       .StartsWith("aarch64", ARM::ISAKind::AARCH64)
681       .StartsWith("arm64", ARM::ISAKind::AARCH64)
682       .StartsWith("thumb", ARM::ISAKind::THUMB)
683       .StartsWith("arm", ARM::ISAKind::ARM)
684       .Default(ARM::ISAKind::INVALID);
685 }
686 
687 // Little/Big endian
688 ARM::EndianKind ARM::parseArchEndian(StringRef Arch) {
689   if (Arch.startswith("armeb") || Arch.startswith("thumbeb") ||
690       Arch.startswith("aarch64_be"))
691     return ARM::EndianKind::BIG;
692 
693   if (Arch.startswith("arm") || Arch.startswith("thumb")) {
694     if (Arch.endswith("eb"))
695       return ARM::EndianKind::BIG;
696     else
697       return ARM::EndianKind::LITTLE;
698   }
699 
700   if (Arch.startswith("aarch64"))
701     return ARM::EndianKind::LITTLE;
702 
703   return ARM::EndianKind::INVALID;
704 }
705 
706 // Profile A/R/M
707 ARM::ProfileKind ARM::parseArchProfile(StringRef Arch) {
708   Arch = getCanonicalArchName(Arch);
709   switch (parseArch(Arch)) {
710   case ARM::ArchKind::ARMV6M:
711   case ARM::ArchKind::ARMV7M:
712   case ARM::ArchKind::ARMV7EM:
713   case ARM::ArchKind::ARMV8MMainline:
714   case ARM::ArchKind::ARMV8MBaseline:
715     return ARM::ProfileKind::M;
716   case ARM::ArchKind::ARMV7R:
717   case ARM::ArchKind::ARMV8R:
718     return ARM::ProfileKind::R;
719   case ARM::ArchKind::ARMV7A:
720   case ARM::ArchKind::ARMV7VE:
721   case ARM::ArchKind::ARMV7K:
722   case ARM::ArchKind::ARMV8A:
723   case ARM::ArchKind::ARMV8_1A:
724   case ARM::ArchKind::ARMV8_2A:
725   case ARM::ArchKind::ARMV8_3A:
726     return ARM::ProfileKind::A;
727     LLVM_FALLTHROUGH;
728   case ARM::ArchKind::ARMV2:
729   case ARM::ArchKind::ARMV2A:
730   case ARM::ArchKind::ARMV3:
731   case ARM::ArchKind::ARMV3M:
732   case ARM::ArchKind::ARMV4:
733   case ARM::ArchKind::ARMV4T:
734   case ARM::ArchKind::ARMV5T:
735   case ARM::ArchKind::ARMV5TE:
736   case ARM::ArchKind::ARMV5TEJ:
737   case ARM::ArchKind::ARMV6:
738   case ARM::ArchKind::ARMV6K:
739   case ARM::ArchKind::ARMV6T2:
740   case ARM::ArchKind::ARMV6KZ:
741   case ARM::ArchKind::ARMV7S:
742   case ARM::ArchKind::IWMMXT:
743   case ARM::ArchKind::IWMMXT2:
744   case ARM::ArchKind::XSCALE:
745   case ARM::ArchKind::INVALID:
746     return ARM::ProfileKind::INVALID;
747   }
748   llvm_unreachable("Unhandled architecture");
749 }
750 
751 // Version number (ex. v7 = 7).
752 unsigned llvm::ARM::parseArchVersion(StringRef Arch) {
753   Arch = getCanonicalArchName(Arch);
754   switch (parseArch(Arch)) {
755   case ARM::ArchKind::ARMV2:
756   case ARM::ArchKind::ARMV2A:
757     return 2;
758   case ARM::ArchKind::ARMV3:
759   case ARM::ArchKind::ARMV3M:
760     return 3;
761   case ARM::ArchKind::ARMV4:
762   case ARM::ArchKind::ARMV4T:
763     return 4;
764   case ARM::ArchKind::ARMV5T:
765   case ARM::ArchKind::ARMV5TE:
766   case ARM::ArchKind::IWMMXT:
767   case ARM::ArchKind::IWMMXT2:
768   case ARM::ArchKind::XSCALE:
769   case ARM::ArchKind::ARMV5TEJ:
770     return 5;
771   case ARM::ArchKind::ARMV6:
772   case ARM::ArchKind::ARMV6K:
773   case ARM::ArchKind::ARMV6T2:
774   case ARM::ArchKind::ARMV6KZ:
775   case ARM::ArchKind::ARMV6M:
776     return 6;
777   case ARM::ArchKind::ARMV7A:
778   case ARM::ArchKind::ARMV7VE:
779   case ARM::ArchKind::ARMV7R:
780   case ARM::ArchKind::ARMV7M:
781   case ARM::ArchKind::ARMV7S:
782   case ARM::ArchKind::ARMV7EM:
783   case ARM::ArchKind::ARMV7K:
784     return 7;
785   case ARM::ArchKind::ARMV8A:
786   case ARM::ArchKind::ARMV8_1A:
787   case ARM::ArchKind::ARMV8_2A:
788   case ARM::ArchKind::ARMV8_3A:
789   case ARM::ArchKind::ARMV8R:
790   case ARM::ArchKind::ARMV8MBaseline:
791   case ARM::ArchKind::ARMV8MMainline:
792     return 8;
793   case ARM::ArchKind::INVALID:
794     return 0;
795   }
796   llvm_unreachable("Unhandled architecture");
797 }
798 
799 StringRef llvm::ARM::computeDefaultTargetABI(const Triple &TT, StringRef CPU) {
800   StringRef ArchName =
801       CPU.empty() ? TT.getArchName() : ARM::getArchName(ARM::parseCPUArch(CPU));
802 
803   if (TT.isOSBinFormatMachO()) {
804     if (TT.getEnvironment() == Triple::EABI ||
805         TT.getOS() == Triple::UnknownOS ||
806         llvm::ARM::parseArchProfile(ArchName) == ARM::ProfileKind::M)
807       return "aapcs";
808     if (TT.isWatchABI())
809       return "aapcs16";
810     return "apcs-gnu";
811   } else if (TT.isOSWindows())
812     // FIXME: this is invalid for WindowsCE.
813     return "aapcs";
814 
815   // Select the default based on the platform.
816   switch (TT.getEnvironment()) {
817   case Triple::Android:
818   case Triple::GNUEABI:
819   case Triple::GNUEABIHF:
820   case Triple::MuslEABI:
821   case Triple::MuslEABIHF:
822     return "aapcs-linux";
823   case Triple::EABIHF:
824   case Triple::EABI:
825     return "aapcs";
826   default:
827     if (TT.isOSNetBSD())
828       return "apcs-gnu";
829     if (TT.isOSOpenBSD())
830       return "aapcs-linux";
831     return "aapcs";
832   }
833 }
834 
835 StringRef llvm::AArch64::getCanonicalArchName(StringRef Arch) {
836   return ARM::getCanonicalArchName(Arch);
837 }
838 
839 unsigned llvm::AArch64::parseFPU(StringRef FPU) {
840   return ARM::parseFPU(FPU);
841 }
842 
843 // Allows partial match, ex. "v8a" matches "armv8a".
844 AArch64::ArchKind AArch64::parseArch(StringRef Arch) {
845   Arch = getCanonicalArchName(Arch);
846   if (checkArchVersion(Arch) < 8)
847     return ArchKind::INVALID;
848 
849   StringRef Syn = getArchSynonym(Arch);
850   for (const auto A : AArch64ARCHNames) {
851     if (A.getName().endswith(Syn))
852       return A.ID;
853   }
854   return ArchKind::INVALID;
855 }
856 
857 unsigned llvm::AArch64::parseArchExt(StringRef ArchExt) {
858   for (const auto A : AArch64ARCHExtNames) {
859     if (ArchExt == A.getName())
860       return A.ID;
861   }
862   return AArch64::AEK_INVALID;
863 }
864 
865 AArch64::ArchKind llvm::AArch64::parseCPUArch(StringRef CPU) {
866   for (const auto C : AArch64CPUNames) {
867     if (CPU == C.getName())
868       return C.ArchID;
869   }
870   return ArchKind::INVALID;
871 }
872 
873 // ARM, Thumb, AArch64
874 ARM::ISAKind AArch64::parseArchISA(StringRef Arch) {
875   return ARM::parseArchISA(Arch);
876 }
877 
878 // Little/Big endian
879 ARM::EndianKind AArch64::parseArchEndian(StringRef Arch) {
880   return ARM::parseArchEndian(Arch);
881 }
882 
883 // Profile A/R/M
884 ARM::ProfileKind AArch64::parseArchProfile(StringRef Arch) {
885   return ARM::parseArchProfile(Arch);
886 }
887 
888 // Version number (ex. v8 = 8).
889 unsigned llvm::AArch64::parseArchVersion(StringRef Arch) {
890   return ARM::parseArchVersion(Arch);
891 }
892