lib/Support/Triple.cpp

   1 //===--- Triple.cpp - Target triple helper class --------------------------===//
   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 #include "llvm/ADT/Triple.h"
  11
  12 #include "llvm/ADT/SmallString.h"
  13 #include "llvm/ADT/STLExtras.h"
  14 #include "llvm/ADT/Twine.h"
  15 #include <cassert>
  16 #include <cstring>
  17 using namespace llvm;
  18
  19 //
  20
  21 const char *Triple::getArchTypeName(ArchType Kind) {
  22   switch (Kind) {
  23   case InvalidArch: return "<invalid>";
  24   case UnknownArch: return "unknown";
  25
  26   case alpha:   return "alpha";
  27   case arm:     return "arm";
  28   case bfin:    return "bfin";
  29   case cellspu: return "cellspu";
  30   case mips:    return "mips";
  31   case mipsel:  return "mipsel";
  32   case msp430:  return "msp430";
  33   case ppc64:   return "powerpc64";
  34   case ppc:     return "powerpc";
  35   case sparc:   return "sparc";
  36   case sparcv9: return "sparcv9";
  37   case systemz: return "s390x";
  38   case tce:     return "tce";
  39   case thumb:   return "thumb";
  40   case x86:     return "i386";
  41   case x86_64:  return "x86_64";
  42   case xcore:   return "xcore";
  43   case mblaze:  return "mblaze";
  44   case ptx:     return "ptx";
  45   }
  46
  47   return "<invalid>";
  48 }
  49
  50 const char *Triple::getArchTypePrefix(ArchType Kind) {
  51   switch (Kind) {
  52   default:
  53     return 0;
  54
  55   case alpha:   return "alpha";
  56
  57   case arm:
  58   case thumb:   return "arm";
  59
  60   case bfin:    return "bfin";
  61
  62   case cellspu: return "spu";
  63
  64   case ppc64:
  65   case ppc:     return "ppc";
  66
  67   case mblaze:  return "mblaze";
  68
  69   case sparcv9:
  70   case sparc:   return "sparc";
  71
  72   case x86:
  73   case x86_64:  return "x86";
  74
  75   case xcore:   return "xcore";
  76
  77   case ptx:     return "ptx";
  78   }
  79 }
  80
  81 const char *Triple::getVendorTypeName(VendorType Kind) {
  82   switch (Kind) {
  83   case UnknownVendor: return "unknown";
  84
  85   case Apple: return "apple";
  86   case PC: return "pc";
  87   case SCEI: return "scei";
  88   }
  89
  90   return "<invalid>";
  91 }
  92
  93 const char *Triple::getOSTypeName(OSType Kind) {
  94   switch (Kind) {
  95   case UnknownOS: return "unknown";
  96
  97   case AuroraUX: return "auroraux";
  98   case Cygwin: return "cygwin";
  99   case Darwin: return "darwin";
 100   case DragonFly: return "dragonfly";
 101   case FreeBSD: return "freebsd";
 102   case IOS: return "ios";
 103   case Linux: return "linux";
 104   case Lv2: return "lv2";
 105   case MacOSX: return "macosx";
 106   case MinGW32: return "mingw32";
 107   case NetBSD: return "netbsd";
 108   case OpenBSD: return "openbsd";
 109   case Psp: return "psp";
 110   case Solaris: return "solaris";
 111   case Win32: return "win32";
 112   case Haiku: return "haiku";
 113   case Minix: return "minix";
 114   }
 115
 116   return "<invalid>";
 117 }
 118
 119 const char *Triple::getEnvironmentTypeName(EnvironmentType Kind) {
 120   switch (Kind) {
 121   case UnknownEnvironment: return "unknown";
 122   case GNU: return "gnu";
 123   case GNUEABI: return "gnueabi";
 124   case EABI: return "eabi";
 125   case MachO: return "macho";
 126   }
 127
 128   return "<invalid>";
 129 }
 130
 131 Triple::ArchType Triple::getArchTypeForLLVMName(StringRef Name) {
 132   if (Name == "alpha")
 133     return alpha;
 134   if (Name == "arm")
 135     return arm;
 136   if (Name == "bfin")
 137     return bfin;
 138   if (Name == "cellspu")
 139     return cellspu;
 140   if (Name == "mips")
 141     return mips;
 142   if (Name == "mipsel")
 143     return mipsel;
 144   if (Name == "msp430")
 145     return msp430;
 146   if (Name == "ppc64")
 147     return ppc64;
 148   if (Name == "ppc")
 149     return ppc;
 150   if (Name == "mblaze")
 151     return mblaze;
 152   if (Name == "sparc")
 153     return sparc;
 154   if (Name == "sparcv9")
 155     return sparcv9;
 156   if (Name == "systemz")
 157     return systemz;
 158   if (Name == "tce")
 159     return tce;
 160   if (Name == "thumb")
 161     return thumb;
 162   if (Name == "x86")
 163     return x86;
 164   if (Name == "x86-64")
 165     return x86_64;
 166   if (Name == "xcore")
 167     return xcore;
 168   if (Name == "ptx")
 169     return ptx;
 170
 171   return UnknownArch;
 172 }
 173
 174 Triple::ArchType Triple::getArchTypeForDarwinArchName(StringRef Str) {
 175   // See arch(3) and llvm-gcc's driver-driver.c. We don't implement support for
 176   // archs which Darwin doesn't use.
 177
 178   // The matching this routine does is fairly pointless, since it is neither the
 179   // complete architecture list, nor a reasonable subset. The problem is that
 180   // historically the driver driver accepts this and also ties its -march=
 181   // handling to the architecture name, so we need to be careful before removing
 182   // support for it.
 183
 184   // This code must be kept in sync with Clang's Darwin specific argument
 185   // translation.
 186
 187   if (Str == "ppc" || Str == "ppc601" || Str == "ppc603" || Str == "ppc604" ||
 188       Str == "ppc604e" || Str == "ppc750" || Str == "ppc7400" ||
 189       Str == "ppc7450" || Str == "ppc970")
 190     return Triple::ppc;
 191
 192   if (Str == "ppc64")
 193     return Triple::ppc64;
 194
 195   if (Str == "i386" || Str == "i486" || Str == "i486SX" || Str == "pentium" ||
 196       Str == "i586" || Str == "pentpro" || Str == "i686" || Str == "pentIIm3" ||
 197       Str == "pentIIm5" || Str == "pentium4")
 198     return Triple::x86;
 199
 200   if (Str == "x86_64")
 201     return Triple::x86_64;
 202
 203   // This is derived from the driver driver.
 204   if (Str == "arm" || Str == "armv4t" || Str == "armv5" || Str == "xscale" ||
 205       Str == "armv6" || Str == "armv7")
 206     return Triple::arm;
 207
 208   if (Str == "ptx")
 209     return Triple::ptx;
 210
 211   return Triple::UnknownArch;
 212 }
 213
 214 // Returns architecture name that is understood by the target assembler.
 215 const char *Triple::getArchNameForAssembler() {
 216   if (!isOSDarwin() && getVendor() != Triple::Apple)
 217     return NULL;
 218
 219   StringRef Str = getArchName();
 220   if (Str == "i386")
 221     return "i386";
 222   if (Str == "x86_64")
 223     return "x86_64";
 224   if (Str == "powerpc")
 225     return "ppc";
 226   if (Str == "powerpc64")
 227     return "ppc64";
 228   if (Str == "mblaze" || Str == "microblaze")
 229     return "mblaze";
 230   if (Str == "arm")
 231     return "arm";
 232   if (Str == "armv4t" || Str == "thumbv4t")
 233     return "armv4t";
 234   if (Str == "armv5" || Str == "armv5e" || Str == "thumbv5"
 235       || Str == "thumbv5e")
 236     return "armv5";
 237   if (Str == "armv6" || Str == "thumbv6")
 238     return "armv6";
 239   if (Str == "armv7" || Str == "thumbv7")
 240     return "armv7";
 241   if (Str == "ptx")
 242     return "ptx";
 243   return NULL;
 244 }
 245
 246 //
 247
 248 Triple::ArchType Triple::ParseArch(StringRef ArchName) {
 249   if (ArchName.size() == 4 && ArchName[0] == 'i' &&
 250       ArchName[2] == '8' && ArchName[3] == '6' &&
 251       ArchName[1] - '3' < 6) // i[3-9]86
 252     return x86;
 253   else if (ArchName == "amd64" || ArchName == "x86_64")
 254     return x86_64;
 255   else if (ArchName == "bfin")
 256     return bfin;
 257   else if (ArchName == "powerpc")
 258     return ppc;
 259   else if ((ArchName == "powerpc64") || (ArchName == "ppu"))
 260     return ppc64;
 261   else if (ArchName == "mblaze")
 262     return mblaze;
 263   else if (ArchName == "arm" ||
 264            ArchName.startswith("armv") ||
 265            ArchName == "xscale")
 266     return arm;
 267   else if (ArchName == "thumb" ||
 268            ArchName.startswith("thumbv"))
 269     return thumb;
 270   else if (ArchName.startswith("alpha"))
 271     return alpha;
 272   else if (ArchName == "spu" || ArchName == "cellspu")
 273     return cellspu;
 274   else if (ArchName == "msp430")
 275     return msp430;
 276   else if (ArchName == "mips" || ArchName == "mipsallegrex")
 277     return mips;
 278   else if (ArchName == "mipsel" || ArchName == "mipsallegrexel" ||
 279            ArchName == "psp")
 280     return mipsel;
 281   else if (ArchName == "sparc")
 282     return sparc;
 283   else if (ArchName == "sparcv9")
 284     return sparcv9;
 285   else if (ArchName == "s390x")
 286     return systemz;
 287   else if (ArchName == "tce")
 288     return tce;
 289   else if (ArchName == "xcore")
 290     return xcore;
 291   else if (ArchName == "ptx")
 292     return ptx;
 293   else
 294     return UnknownArch;
 295 }
 296
 297 Triple::VendorType Triple::ParseVendor(StringRef VendorName) {
 298   if (VendorName == "apple")
 299     return Apple;
 300   else if (VendorName == "pc")
 301     return PC;
 302   else if (VendorName == "scei")
 303     return SCEI;
 304   else
 305     return UnknownVendor;
 306 }
 307
 308 Triple::OSType Triple::ParseOS(StringRef OSName) {
 309   if (OSName.startswith("auroraux"))
 310     return AuroraUX;
 311   else if (OSName.startswith("cygwin"))
 312     return Cygwin;
 313   else if (OSName.startswith("darwin"))
 314     return Darwin;
 315   else if (OSName.startswith("dragonfly"))
 316     return DragonFly;
 317   else if (OSName.startswith("freebsd"))
 318     return FreeBSD;
 319   else if (OSName.startswith("ios"))
 320     return IOS;
 321   else if (OSName.startswith("linux"))
 322     return Linux;
 323   else if (OSName.startswith("lv2"))
 324     return Lv2;
 325   else if (OSName.startswith("macosx"))
 326     return MacOSX;
 327   else if (OSName.startswith("mingw32"))
 328     return MinGW32;
 329   else if (OSName.startswith("netbsd"))
 330     return NetBSD;
 331   else if (OSName.startswith("openbsd"))
 332     return OpenBSD;
 333   else if (OSName.startswith("psp"))
 334     return Psp;
 335   else if (OSName.startswith("solaris"))
 336     return Solaris;
 337   else if (OSName.startswith("win32"))
 338     return Win32;
 339   else if (OSName.startswith("haiku"))
 340     return Haiku;
 341   else if (OSName.startswith("minix"))
 342     return Minix;
 343   else
 344     return UnknownOS;
 345 }
 346
 347 Triple::EnvironmentType Triple::ParseEnvironment(StringRef EnvironmentName) {
 348   if (EnvironmentName.startswith("eabi"))
 349     return EABI;
 350   else if (EnvironmentName.startswith("gnueabi"))
 351     return GNUEABI;
 352   else if (EnvironmentName.startswith("gnu"))
 353     return GNU;
 354   else if (EnvironmentName.startswith("macho"))
 355     return MachO;
 356   else
 357     return UnknownEnvironment;
 358 }
 359
 360 void Triple::Parse() const {
 361   assert(!isInitialized() && "Invalid parse call.");
 362
 363   Arch = ParseArch(getArchName());
 364   Vendor = ParseVendor(getVendorName());
 365   OS = ParseOS(getOSName());
 366   Environment = ParseEnvironment(getEnvironmentName());
 367
 368   assert(isInitialized() && "Failed to initialize!");
 369 }
 370
 371 std::string Triple::normalize(StringRef Str) {
 372   // Parse into components.
 373   SmallVector<StringRef, 4> Components;
 374   for (size_t First = 0, Last = 0; Last != StringRef::npos; First = Last + 1) {
 375     Last = Str.find('-', First);
 376     Components.push_back(Str.slice(First, Last));
 377   }
 378
 379   // If the first component corresponds to a known architecture, preferentially
 380   // use it for the architecture.  If the second component corresponds to a
 381   // known vendor, preferentially use it for the vendor, etc.  This avoids silly
 382   // component movement when a component parses as (eg) both a valid arch and a
 383   // valid os.
 384   ArchType Arch = UnknownArch;
 385   if (Components.size() > 0)
 386     Arch = ParseArch(Components[0]);
 387   VendorType Vendor = UnknownVendor;
 388   if (Components.size() > 1)
 389     Vendor = ParseVendor(Components[1]);
 390   OSType OS = UnknownOS;
 391   if (Components.size() > 2)
 392     OS = ParseOS(Components[2]);
 393   EnvironmentType Environment = UnknownEnvironment;
 394   if (Components.size() > 3)
 395     Environment = ParseEnvironment(Components[3]);
 396
 397   // Note which components are already in their final position.  These will not
 398   // be moved.
 399   bool Found[4];
 400   Found[0] = Arch != UnknownArch;
 401   Found[1] = Vendor != UnknownVendor;
 402   Found[2] = OS != UnknownOS;
 403   Found[3] = Environment != UnknownEnvironment;
 404
 405   // If they are not there already, permute the components into their canonical
 406   // positions by seeing if they parse as a valid architecture, and if so moving
 407   // the component to the architecture position etc.
 408   for (unsigned Pos = 0; Pos != array_lengthof(Found); ++Pos) {
 409     if (Found[Pos])
 410       continue; // Already in the canonical position.
 411
 412     for (unsigned Idx = 0; Idx != Components.size(); ++Idx) {
 413       // Do not reparse any components that already matched.
 414       if (Idx < array_lengthof(Found) && Found[Idx])
 415         continue;
 416
 417       // Does this component parse as valid for the target position?
 418       bool Valid = false;
 419       StringRef Comp = Components[Idx];
 420       switch (Pos) {
 421       default:
 422         assert(false && "unexpected component type!");
 423       case 0:
 424         Arch = ParseArch(Comp);
 425         Valid = Arch != UnknownArch;
 426         break;
 427       case 1:
 428         Vendor = ParseVendor(Comp);
 429         Valid = Vendor != UnknownVendor;
 430         break;
 431       case 2:
 432         OS = ParseOS(Comp);
 433         Valid = OS != UnknownOS;
 434         break;
 435       case 3:
 436         Environment = ParseEnvironment(Comp);
 437         Valid = Environment != UnknownEnvironment;
 438         break;
 439       }
 440       if (!Valid)
 441         continue; // Nope, try the next component.
 442
 443       // Move the component to the target position, pushing any non-fixed
 444       // components that are in the way to the right.  This tends to give
 445       // good results in the common cases of a forgotten vendor component
 446       // or a wrongly positioned environment.
 447       if (Pos < Idx) {
 448         // Insert left, pushing the existing components to the right.  For
 449         // example, a-b-i386 -> i386-a-b when moving i386 to the front.
 450         StringRef CurrentComponent(""); // The empty component.
 451         // Replace the component we are moving with an empty component.
 452         std::swap(CurrentComponent, Components[Idx]);
 453         // Insert the component being moved at Pos, displacing any existing
 454         // components to the right.
 455         for (unsigned i = Pos; !CurrentComponent.empty(); ++i) {
 456           // Skip over any fixed components.
 457           while (i < array_lengthof(Found) && Found[i]) ++i;
 458           // Place the component at the new position, getting the component
 459           // that was at this position - it will be moved right.
 460           std::swap(CurrentComponent, Components[i]);
 461         }
 462       } else if (Pos > Idx) {
 463         // Push right by inserting empty components until the component at Idx
 464         // reaches the target position Pos.  For example, pc-a -> -pc-a when
 465         // moving pc to the second position.
 466         do {
 467           // Insert one empty component at Idx.
 468           StringRef CurrentComponent(""); // The empty component.
 469           for (unsigned i = Idx; i < Components.size();) {
 470             // Place the component at the new position, getting the component
 471             // that was at this position - it will be moved right.
 472             std::swap(CurrentComponent, Components[i]);
 473             // If it was placed on top of an empty component then we are done.
 474             if (CurrentComponent.empty())
 475               break;
 476             // Advance to the next component, skipping any fixed components.
 477             while (++i < array_lengthof(Found) && Found[i])
 478               ;
 479           }
 480           // The last component was pushed off the end - append it.
 481           if (!CurrentComponent.empty())
 482             Components.push_back(CurrentComponent);
 483
 484           // Advance Idx to the component's new position.
 485           while (++Idx < array_lengthof(Found) && Found[Idx]) {}
 486         } while (Idx < Pos); // Add more until the final position is reached.
 487       }
 488       assert(Pos < Components.size() && Components[Pos] == Comp &&
 489              "Component moved wrong!");
 490       Found[Pos] = true;
 491       break;
 492     }
 493   }
 494
 495   // Special case logic goes here.  At this point Arch, Vendor and OS have the
 496   // correct values for the computed components.
 497
 498   // Stick the corrected components back together to form the normalized string.
 499   std::string Normalized;
 500   for (unsigned i = 0, e = Components.size(); i != e; ++i) {
 501     if (i) Normalized += '-';
 502     Normalized += Components[i];
 503   }
 504   return Normalized;
 505 }
 506
 507 StringRef Triple::getArchName() const {
 508   return StringRef(Data).split('-').first;           // Isolate first component
 509 }
 510
 511 StringRef Triple::getVendorName() const {
 512   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
 513   return Tmp.split('-').first;                       // Isolate second component
 514 }
 515
 516 StringRef Triple::getOSName() const {
 517   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
 518   Tmp = Tmp.split('-').second;                       // Strip second component
 519   return Tmp.split('-').first;                       // Isolate third component
 520 }
 521
 522 StringRef Triple::getEnvironmentName() const {
 523   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
 524   Tmp = Tmp.split('-').second;                       // Strip second component
 525   return Tmp.split('-').second;                      // Strip third component
 526 }
 527
 528 StringRef Triple::getOSAndEnvironmentName() const {
 529   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
 530   return Tmp.split('-').second;                      // Strip second component
 531 }
 532
 533 static unsigned EatNumber(StringRef &Str) {
 534   assert(!Str.empty() && Str[0] >= '0' && Str[0] <= '9' && "Not a number");
 535   unsigned Result = 0;
 536
 537   do {
 538     // Consume the leading digit.
 539     Result = Result*10 + (Str[0] - '0');
 540
 541     // Eat the digit.
 542     Str = Str.substr(1);
 543   } while (!Str.empty() && Str[0] >= '0' && Str[0] <= '9');
 544
 545   return Result;
 546 }
 547
 548 void Triple::getOSVersion(unsigned &Major, unsigned &Minor,
 549                           unsigned &Micro) const {
 550   StringRef OSName = getOSName();
 551
 552   // Assume that the OS portion of the triple starts with the canonical name.
 553   StringRef OSTypeName = getOSTypeName(getOS());
 554   if (OSName.startswith(OSTypeName))
 555     OSName = OSName.substr(OSTypeName.size());
 556
 557   // Any unset version defaults to 0.
 558   Major = Minor = Micro = 0;
 559
 560   // Parse up to three components.
 561   unsigned *Components[3] = { &Major, &Minor, &Micro };
 562   for (unsigned i = 0; i != 3; ++i) {
 563     if (OSName.empty() || OSName[0] < '0' || OSName[0] > '9')
 564       break;
 565
 566     // Consume the leading number.
 567     *Components[i] = EatNumber(OSName);
 568
 569     // Consume the separator, if present.
 570     if (OSName.startswith("."))
 571       OSName = OSName.substr(1);
 572   }
 573 }
 574
 575 void Triple::setTriple(const Twine &Str) {
 576   Data = Str.str();
 577   Arch = InvalidArch;
 578 }
 579
 580 void Triple::setArch(ArchType Kind) {
 581   setArchName(getArchTypeName(Kind));
 582 }
 583
 584 void Triple::setVendor(VendorType Kind) {
 585   setVendorName(getVendorTypeName(Kind));
 586 }
 587
 588 void Triple::setOS(OSType Kind) {
 589   setOSName(getOSTypeName(Kind));
 590 }
 591
 592 void Triple::setEnvironment(EnvironmentType Kind) {
 593   setEnvironmentName(getEnvironmentTypeName(Kind));
 594 }
 595
 596 void Triple::setArchName(StringRef Str) {
 597   // Work around a miscompilation bug for Twines in gcc 4.0.3.
 598   SmallString<64> Triple;
 599   Triple += Str;
 600   Triple += "-";
 601   Triple += getVendorName();
 602   Triple += "-";
 603   Triple += getOSAndEnvironmentName();
 604   setTriple(Triple.str());
 605 }
 606
 607 void Triple::setVendorName(StringRef Str) {
 608   setTriple(getArchName() + "-" + Str + "-" + getOSAndEnvironmentName());
 609 }
 610
 611 void Triple::setOSName(StringRef Str) {
 612   if (hasEnvironment())
 613     setTriple(getArchName() + "-" + getVendorName() + "-" + Str +
 614               "-" + getEnvironmentName());
 615   else
 616     setTriple(getArchName() + "-" + getVendorName() + "-" + Str);
 617 }
 618
 619 void Triple::setEnvironmentName(StringRef Str) {
 620   setTriple(getArchName() + "-" + getVendorName() + "-" + getOSName() +
 621             "-" + Str);
 622 }
 623
 624 void Triple::setOSAndEnvironmentName(StringRef Str) {
 625   setTriple(getArchName() + "-" + getVendorName() + "-" + Str);
 626 }