lib/Support/TargetParser.cpp

   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 <cctype>
  20
  21 using namespace llvm;
  22 using namespace ARM;
  23
  24 namespace {
  25
  26 // List of canonical FPU names (use getFPUSynonym) and which architectural
  27 // features they correspond to (use getFPUFeatures).
  28 // FIXME: TableGen this.
  29 // The entries must appear in the order listed in ARM::FPUKind for correct indexing
  30 struct {
  31   const char *NameCStr;
  32   size_t NameLength;
  33   ARM::FPUKind ID;
  34   ARM::FPUVersion FPUVersion;
  35   ARM::NeonSupportLevel NeonSupport;
  36   ARM::FPURestriction Restriction;
  37
  38   StringRef getName() const { return StringRef(NameCStr, NameLength); }
  39 } FPUNames[] = {
  40 #define ARM_FPU(NAME, KIND, VERSION, NEON_SUPPORT, RESTRICTION) \
  41   { NAME, sizeof(NAME) - 1, KIND, VERSION, NEON_SUPPORT, RESTRICTION },
  42 #include "llvm/Support/ARMTargetParser.def"
  43 };
  44
  45 // List of canonical arch names (use getArchSynonym).
  46 // This table also provides the build attribute fields for CPU arch
  47 // and Arch ID, according to the Addenda to the ARM ABI, chapters
  48 // 2.4 and 2.3.5.2 respectively.
  49 // FIXME: SubArch values were simplified to fit into the expectations
  50 // of the triples and are not conforming with their official names.
  51 // Check to see if the expectation should be changed.
  52 // FIXME: TableGen this.
  53 struct {
  54   const char *NameCStr;
  55   size_t NameLength;
  56   ARM::ArchKind ID;
  57   const char *CPUAttrCStr;
  58   size_t CPUAttrLength;
  59   const char *SubArchCStr;
  60   size_t SubArchLength;
  61   ARMBuildAttrs::CPUArch ArchAttr; // Arch ID in build attributes.
  62
  63   StringRef getName() const { return StringRef(NameCStr, NameLength); }
  64
  65   // CPU class in build attributes.
  66   StringRef getCPUAttr() const { return StringRef(CPUAttrCStr, CPUAttrLength); }
  67
  68   // Sub-Arch name.
  69   StringRef getSubArch() const { return StringRef(SubArchCStr, SubArchLength); }
  70 } ARCHNames[] = {
  71 #define ARM_ARCH(NAME, ID, CPU_ATTR, SUB_ARCH, ARCH_ATTR)                      \
  72   {NAME, sizeof(NAME) - 1, ID, CPU_ATTR, sizeof(CPU_ATTR) - 1, SUB_ARCH,       \
  73    sizeof(SUB_ARCH) - 1, ARCH_ATTR},
  74 #include "llvm/Support/ARMTargetParser.def"
  75 };
  76
  77 // List of Arch Extension names.
  78 // FIXME: TableGen this.
  79 struct {
  80   const char *NameCStr;
  81   size_t NameLength;
  82   unsigned ID;
  83
  84   StringRef getName() const { return StringRef(NameCStr, NameLength); }
  85 } ARCHExtNames[] = {
  86 #define ARM_ARCH_EXT_NAME(NAME, ID) { NAME, sizeof(NAME) - 1, ID },
  87 #include "llvm/Support/ARMTargetParser.def"
  88 };
  89
  90 // List of HWDiv names (use getHWDivSynonym) and which architectural
  91 // features they correspond to (use getHWDivFeatures).
  92 // FIXME: TableGen this.
  93 struct {
  94   const char *NameCStr;
  95   size_t NameLength;
  96   unsigned ID;
  97
  98   StringRef getName() const { return StringRef(NameCStr, NameLength); }
  99 } HWDivNames[] = {
 100 #define ARM_HW_DIV_NAME(NAME, ID) { NAME, sizeof(NAME) - 1, ID },
 101 #include "llvm/Support/ARMTargetParser.def"
 102 };
 103
 104 // List of CPU names and their arches.
 105 // The same CPU can have multiple arches and can be default on multiple arches.
 106 // When finding the Arch for a CPU, first-found prevails. Sort them accordingly.
 107 // When this becomes table-generated, we'd probably need two tables.
 108 // FIXME: TableGen this.
 109 struct {
 110   const char *NameCStr;
 111   size_t NameLength;
 112   ARM::ArchKind ArchID;
 113   ARM::FPUKind DefaultFPU;
 114   bool Default; // is $Name the default CPU for $ArchID ?
 115
 116   StringRef getName() const { return StringRef(NameCStr, NameLength); }
 117 } CPUNames[] = {
 118 #define ARM_CPU_NAME(NAME, ID, DEFAULT_FPU, IS_DEFAULT) \
 119   { NAME, sizeof(NAME) - 1, ID, DEFAULT_FPU, IS_DEFAULT },
 120 #include "llvm/Support/ARMTargetParser.def"
 121 };
 122
 123 } // namespace
 124
 125 // ======================================================= //
 126 // Information by ID
 127 // ======================================================= //
 128
 129 StringRef llvm::ARM::getFPUName(unsigned FPUKind) {
 130   if (FPUKind >= ARM::FK_LAST)
 131     return StringRef();
 132   return FPUNames[FPUKind].getName();
 133 }
 134
 135 unsigned llvm::ARM::getFPUVersion(unsigned FPUKind) {
 136   if (FPUKind >= ARM::FK_LAST)
 137     return 0;
 138   return FPUNames[FPUKind].FPUVersion;
 139 }
 140
 141 unsigned llvm::ARM::getFPUNeonSupportLevel(unsigned FPUKind) {
 142   if (FPUKind >= ARM::FK_LAST)
 143     return 0;
 144   return FPUNames[FPUKind].NeonSupport;
 145 }
 146
 147 unsigned llvm::ARM::getFPURestriction(unsigned FPUKind) {
 148   if (FPUKind >= ARM::FK_LAST)
 149     return 0;
 150   return FPUNames[FPUKind].Restriction;
 151 }
 152
 153 unsigned llvm::ARM::getDefaultFPU(StringRef CPU) {
 154   for (const auto C : CPUNames) {
 155     if (CPU == C.getName())
 156       return C.DefaultFPU;
 157   }
 158   return ARM::FK_INVALID;
 159 }
 160
 161 bool llvm::ARM::getHWDivFeatures(unsigned HWDivKind,
 162                                  std::vector<const char *> &Features) {
 163
 164   if (HWDivKind == ARM::AEK_INVALID)
 165     return false;
 166
 167   if (HWDivKind & ARM::AEK_HWDIVARM)
 168     Features.push_back("+hwdiv-arm");
 169   else
 170     Features.push_back("-hwdiv-arm");
 171
 172   if (HWDivKind & ARM::AEK_HWDIV)
 173     Features.push_back("+hwdiv");
 174   else
 175     Features.push_back("-hwdiv");
 176
 177   return true;
 178 }
 179
 180 bool llvm::ARM::getFPUFeatures(unsigned FPUKind,
 181                                std::vector<const char *> &Features) {
 182
 183   if (FPUKind >= ARM::FK_LAST || FPUKind == ARM::FK_INVALID)
 184     return false;
 185
 186   // fp-only-sp and d16 subtarget features are independent of each other, so we
 187   // must enable/disable both.
 188   switch (FPUNames[FPUKind].Restriction) {
 189   case ARM::FR_SP_D16:
 190     Features.push_back("+fp-only-sp");
 191     Features.push_back("+d16");
 192     break;
 193   case ARM::FR_D16:
 194     Features.push_back("-fp-only-sp");
 195     Features.push_back("+d16");
 196     break;
 197   case ARM::FR_None:
 198     Features.push_back("-fp-only-sp");
 199     Features.push_back("-d16");
 200     break;
 201   }
 202
 203   // FPU version subtarget features are inclusive of lower-numbered ones, so
 204   // enable the one corresponding to this version and disable all that are
 205   // higher. We also have to make sure to disable fp16 when vfp4 is disabled,
 206   // as +vfp4 implies +fp16 but -vfp4 does not imply -fp16.
 207   switch (FPUNames[FPUKind].FPUVersion) {
 208   case ARM::FV_VFPV5:
 209     Features.push_back("+fp-armv8");
 210     break;
 211   case ARM::FV_VFPV4:
 212     Features.push_back("+vfp4");
 213     Features.push_back("-fp-armv8");
 214     break;
 215   case ARM::FV_VFPV3_FP16:
 216     Features.push_back("+vfp3");
 217     Features.push_back("+fp16");
 218     Features.push_back("-vfp4");
 219     Features.push_back("-fp-armv8");
 220     break;
 221   case ARM::FV_VFPV3:
 222     Features.push_back("+vfp3");
 223     Features.push_back("-fp16");
 224     Features.push_back("-vfp4");
 225     Features.push_back("-fp-armv8");
 226     break;
 227   case ARM::FV_VFPV2:
 228     Features.push_back("+vfp2");
 229     Features.push_back("-vfp3");
 230     Features.push_back("-fp16");
 231     Features.push_back("-vfp4");
 232     Features.push_back("-fp-armv8");
 233     break;
 234   case ARM::FV_NONE:
 235     Features.push_back("-vfp2");
 236     Features.push_back("-vfp3");
 237     Features.push_back("-fp16");
 238     Features.push_back("-vfp4");
 239     Features.push_back("-fp-armv8");
 240     break;
 241   }
 242
 243   // crypto includes neon, so we handle this similarly to FPU version.
 244   switch (FPUNames[FPUKind].NeonSupport) {
 245   case ARM::NS_Crypto:
 246     Features.push_back("+crypto");
 247     break;
 248   case ARM::NS_Neon:
 249     Features.push_back("+neon");
 250     Features.push_back("-crypto");
 251     break;
 252   case ARM::NS_None:
 253     Features.push_back("-neon");
 254     Features.push_back("-crypto");
 255     break;
 256   }
 257
 258   return true;
 259 }
 260
 261 StringRef llvm::ARM::getArchName(unsigned ArchKind) {
 262   if (ArchKind >= ARM::AK_LAST)
 263     return StringRef();
 264   return ARCHNames[ArchKind].getName();
 265 }
 266
 267 StringRef llvm::ARM::getCPUAttr(unsigned ArchKind) {
 268   if (ArchKind >= ARM::AK_LAST)
 269     return StringRef();
 270   return ARCHNames[ArchKind].getCPUAttr();
 271 }
 272
 273 StringRef llvm::ARM::getSubArch(unsigned ArchKind) {
 274   if (ArchKind >= ARM::AK_LAST)
 275     return StringRef();
 276   return ARCHNames[ArchKind].getSubArch();
 277 }
 278
 279 unsigned llvm::ARM::getArchAttr(unsigned ArchKind) {
 280   if (ArchKind >= ARM::AK_LAST)
 281     return ARMBuildAttrs::CPUArch::Pre_v4;
 282   return ARCHNames[ArchKind].ArchAttr;
 283 }
 284
 285 StringRef llvm::ARM::getArchExtName(unsigned ArchExtKind) {
 286   for (const auto AE : ARCHExtNames) {
 287     if (ArchExtKind == AE.ID)
 288       return AE.getName();
 289   }
 290   return StringRef();
 291 }
 292
 293 StringRef llvm::ARM::getHWDivName(unsigned HWDivKind) {
 294   for (const auto D : HWDivNames) {
 295     if (HWDivKind == D.ID)
 296       return D.getName();
 297   }
 298   return StringRef();
 299 }
 300
 301 StringRef llvm::ARM::getDefaultCPU(StringRef Arch) {
 302   unsigned AK = parseArch(Arch);
 303   if (AK == ARM::AK_INVALID)
 304     return StringRef();
 305
 306   // Look for multiple AKs to find the default for pair AK+Name.
 307   for (const auto CPU : CPUNames) {
 308     if (CPU.ArchID == AK && CPU.Default)
 309       return CPU.getName();
 310   }
 311   return StringRef();
 312 }
 313
 314 // ======================================================= //
 315 // Parsers
 316 // ======================================================= //
 317
 318 static StringRef getHWDivSynonym(StringRef HWDiv) {
 319   return StringSwitch<StringRef>(HWDiv)
 320       .Case("thumb,arm", "arm,thumb")
 321       .Default(HWDiv);
 322 }
 323
 324 static StringRef getFPUSynonym(StringRef FPU) {
 325   return StringSwitch<StringRef>(FPU)
 326       .Cases("fpa", "fpe2", "fpe3", "maverick", "invalid") // Unsupported
 327       .Case("vfp2", "vfpv2")
 328       .Case("vfp3", "vfpv3")
 329       .Case("vfp4", "vfpv4")
 330       .Case("vfp3-d16", "vfpv3-d16")
 331       .Case("vfp4-d16", "vfpv4-d16")
 332       .Cases("fp4-sp-d16", "vfpv4-sp-d16", "fpv4-sp-d16")
 333       .Cases("fp4-dp-d16", "fpv4-dp-d16", "vfpv4-d16")
 334       .Case("fp5-sp-d16", "fpv5-sp-d16")
 335       .Cases("fp5-dp-d16", "fpv5-dp-d16", "fpv5-d16")
 336       // FIXME: Clang uses it, but it's bogus, since neon defaults to vfpv3.
 337       .Case("neon-vfpv3", "neon")
 338       .Default(FPU);
 339 }
 340
 341 static StringRef getArchSynonym(StringRef Arch) {
 342   return StringSwitch<StringRef>(Arch)
 343       .Case("v6sm", "v6s-m")
 344       .Case("v6m", "v6-m")
 345       .Case("v7a", "v7-a")
 346       .Case("v7r", "v7-r")
 347       .Case("v7m", "v7-m")
 348       .Case("v7em", "v7e-m")
 349       .Cases("v8", "v8a", "aarch64", "arm64", "v8-a")
 350       .Case("v8.1a", "v8.1-a")
 351       .Default(Arch);
 352 }
 353
 354 // MArch is expected to be of the form (arm|thumb)?(eb)?(v.+)?(eb)?, but
 355 // (iwmmxt|xscale)(eb)? is also permitted. If the former, return
 356 // "v.+", if the latter, return unmodified string, minus 'eb'.
 357 // If invalid, return empty string.
 358 StringRef llvm::ARM::getCanonicalArchName(StringRef Arch) {
 359   size_t offset = StringRef::npos;
 360   StringRef A = Arch;
 361   StringRef Error = "";
 362
 363   // Begins with "arm" / "thumb", move past it.
 364   if (A.startswith("arm64"))
 365     offset = 5;
 366   else if (A.startswith("arm"))
 367     offset = 3;
 368   else if (A.startswith("thumb"))
 369     offset = 5;
 370   else if (A.startswith("aarch64")) {
 371     offset = 7;
 372     // AArch64 uses "_be", not "eb" suffix.
 373     if (A.find("eb") != StringRef::npos)
 374       return Error;
 375     if (A.substr(offset, 3) == "_be")
 376       offset += 3;
 377   }
 378
 379   // Ex. "armebv7", move past the "eb".
 380   if (offset != StringRef::npos && A.substr(offset, 2) == "eb")
 381     offset += 2;
 382   // Or, if it ends with eb ("armv7eb"), chop it off.
 383   else if (A.endswith("eb"))
 384     A = A.substr(0, A.size() - 2);
 385   // Trim the head
 386   if (offset != StringRef::npos)
 387     A = A.substr(offset);
 388
 389   // Empty string means offset reached the end, which means it's valid.
 390   if (A.empty())
 391     return Arch;
 392
 393   // Only match non-marketing names
 394   if (offset != StringRef::npos) {
 395     // Must start with 'vN'.
 396     if (A[0] != 'v' || !std::isdigit(A[1]))
 397       return Error;
 398     // Can't have an extra 'eb'.
 399     if (A.find("eb") != StringRef::npos)
 400       return Error;
 401   }
 402
 403   // Arch will either be a 'v' name (v7a) or a marketing name (xscale).
 404   return A;
 405 }
 406
 407 unsigned llvm::ARM::parseHWDiv(StringRef HWDiv) {
 408   StringRef Syn = getHWDivSynonym(HWDiv);
 409   for (const auto D : HWDivNames) {
 410     if (Syn == D.getName())
 411       return D.ID;
 412   }
 413   return ARM::AEK_INVALID;
 414 }
 415
 416 unsigned llvm::ARM::parseFPU(StringRef FPU) {
 417   StringRef Syn = getFPUSynonym(FPU);
 418   for (const auto F : FPUNames) {
 419     if (Syn == F.getName())
 420       return F.ID;
 421   }
 422   return ARM::FK_INVALID;
 423 }
 424
 425 // Allows partial match, ex. "v7a" matches "armv7a".
 426 unsigned llvm::ARM::parseArch(StringRef Arch) {
 427   Arch = getCanonicalArchName(Arch);
 428   StringRef Syn = getArchSynonym(Arch);
 429   for (const auto A : ARCHNames) {
 430     if (A.getName().endswith(Syn))
 431       return A.ID;
 432   }
 433   return ARM::AK_INVALID;
 434 }
 435
 436 unsigned llvm::ARM::parseArchExt(StringRef ArchExt) {
 437   for (const auto A : ARCHExtNames) {
 438     if (ArchExt == A.getName())
 439       return A.ID;
 440   }
 441   return ARM::AEK_INVALID;
 442 }
 443
 444 unsigned llvm::ARM::parseCPUArch(StringRef CPU) {
 445   for (const auto C : CPUNames) {
 446     if (CPU == C.getName())
 447       return C.ArchID;
 448   }
 449   return ARM::AK_INVALID;
 450 }
 451
 452 // ARM, Thumb, AArch64
 453 unsigned llvm::ARM::parseArchISA(StringRef Arch) {
 454   return StringSwitch<unsigned>(Arch)
 455       .StartsWith("aarch64", ARM::IK_AARCH64)
 456       .StartsWith("arm64", ARM::IK_AARCH64)
 457       .StartsWith("thumb", ARM::IK_THUMB)
 458       .StartsWith("arm", ARM::IK_ARM)
 459       .Default(ARM::EK_INVALID);
 460 }
 461
 462 // Little/Big endian
 463 unsigned llvm::ARM::parseArchEndian(StringRef Arch) {
 464   if (Arch.startswith("armeb") || Arch.startswith("thumbeb") ||
 465       Arch.startswith("aarch64_be"))
 466     return ARM::EK_BIG;
 467
 468   if (Arch.startswith("arm") || Arch.startswith("thumb")) {
 469     if (Arch.endswith("eb"))
 470       return ARM::EK_BIG;
 471     else
 472       return ARM::EK_LITTLE;
 473   }
 474
 475   if (Arch.startswith("aarch64"))
 476     return ARM::EK_LITTLE;
 477
 478   return ARM::EK_INVALID;
 479 }
 480
 481 // Profile A/R/M
 482 unsigned llvm::ARM::parseArchProfile(StringRef Arch) {
 483   Arch = getCanonicalArchName(Arch);
 484   switch (parseArch(Arch)) {
 485   case ARM::AK_ARMV6M:
 486   case ARM::AK_ARMV7M:
 487   case ARM::AK_ARMV6SM:
 488   case ARM::AK_ARMV7EM:
 489     return ARM::PK_M;
 490   case ARM::AK_ARMV7R:
 491     return ARM::PK_R;
 492   case ARM::AK_ARMV7:
 493   case ARM::AK_ARMV7A:
 494   case ARM::AK_ARMV7L:
 495   case ARM::AK_ARMV8A:
 496   case ARM::AK_ARMV8_1A:
 497     return ARM::PK_A;
 498   }
 499   return ARM::PK_INVALID;
 500 }
 501
 502 // Version number (ex. v7 = 7).
 503 unsigned llvm::ARM::parseArchVersion(StringRef Arch) {
 504   Arch = getCanonicalArchName(Arch);
 505   switch (parseArch(Arch)) {
 506   case ARM::AK_ARMV2:
 507   case ARM::AK_ARMV2A:
 508     return 2;
 509   case ARM::AK_ARMV3:
 510   case ARM::AK_ARMV3M:
 511     return 3;
 512   case ARM::AK_ARMV4:
 513   case ARM::AK_ARMV4T:
 514     return 4;
 515   case ARM::AK_ARMV5:
 516   case ARM::AK_ARMV5T:
 517   case ARM::AK_ARMV5TE:
 518   case ARM::AK_IWMMXT:
 519   case ARM::AK_IWMMXT2:
 520   case ARM::AK_XSCALE:
 521   case ARM::AK_ARMV5E:
 522   case ARM::AK_ARMV5TEJ:
 523     return 5;
 524   case ARM::AK_ARMV6:
 525   case ARM::AK_ARMV6J:
 526   case ARM::AK_ARMV6K:
 527   case ARM::AK_ARMV6T2:
 528   case ARM::AK_ARMV6Z:
 529   case ARM::AK_ARMV6ZK:
 530   case ARM::AK_ARMV6M:
 531   case ARM::AK_ARMV6SM:
 532   case ARM::AK_ARMV6HL:
 533     return 6;
 534   case ARM::AK_ARMV7:
 535   case ARM::AK_ARMV7A:
 536   case ARM::AK_ARMV7R:
 537   case ARM::AK_ARMV7M:
 538   case ARM::AK_ARMV7L:
 539   case ARM::AK_ARMV7HL:
 540   case ARM::AK_ARMV7S:
 541   case ARM::AK_ARMV7EM:
 542   case ARM::AK_ARMV7K:
 543     return 7;
 544   case ARM::AK_ARMV8A:
 545   case ARM::AK_ARMV8_1A:
 546     return 8;
 547   }
 548   return 0;
 549 }