include/llvm/ADT/Triple.h

   1 //===-- llvm/ADT/Triple.h - Target triple helper class ----------*- 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 #ifndef LLVM_ADT_TRIPLE_H
  11 #define LLVM_ADT_TRIPLE_H
  12
  13 #include "llvm/ADT/Twine.h"
  14
  15 // Some system headers or GCC predefined macros conflict with identifiers in
  16 // this file.  Undefine them here.
  17 #undef NetBSD
  18 #undef mips
  19 #undef sparc
  20
  21 namespace llvm {
  22
  23 /// Triple - Helper class for working with autoconf configuration names. For
  24 /// historical reasons, we also call these 'triples' (they used to contain
  25 /// exactly three fields).
  26 ///
  27 /// Configuration names are strings in the canonical form:
  28 ///   ARCHITECTURE-VENDOR-OPERATING_SYSTEM
  29 /// or
  30 ///   ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
  31 ///
  32 /// This class is used for clients which want to support arbitrary
  33 /// configuration names, but also want to implement certain special
  34 /// behavior for particular configurations. This class isolates the mapping
  35 /// from the components of the configuration name to well known IDs.
  36 ///
  37 /// At its core the Triple class is designed to be a wrapper for a triple
  38 /// string; the constructor does not change or normalize the triple string.
  39 /// Clients that need to handle the non-canonical triples that users often
  40 /// specify should use the normalize method.
  41 ///
  42 /// See autoconf/config.guess for a glimpse into what configuration names
  43 /// look like in practice.
  44 class Triple {
  45 public:
  46   enum ArchType {
  47     UnknownArch,
  48
  49     arm,        // ARM: arm, armv.*, xscale
  50     aarch64,    // AArch64 (little endian): aarch64
  51     aarch64_be, // AArch64 (big endian): aarch64_be
  52     hexagon,    // Hexagon: hexagon
  53     mips,       // MIPS: mips, mipsallegrex
  54     mipsel,     // MIPSEL: mipsel, mipsallegrexel
  55     mips64,     // MIPS64: mips64
  56     mips64el,   // MIPS64EL: mips64el
  57     msp430,     // MSP430: msp430
  58     ppc,        // PPC: powerpc
  59     ppc64,      // PPC64: powerpc64, ppu
  60     ppc64le,    // PPC64LE: powerpc64le
  61     r600,       // R600: AMD GPUs HD2XXX - HD6XXX
  62     sparc,      // Sparc: sparc
  63     sparcv9,    // Sparcv9: Sparcv9
  64     systemz,    // SystemZ: s390x
  65     tce,        // TCE (http://tce.cs.tut.fi/): tce
  66     thumb,      // Thumb: thumb, thumbv.*
  67     x86,        // X86: i[3-9]86
  68     x86_64,     // X86-64: amd64, x86_64
  69     xcore,      // XCore: xcore
  70     nvptx,      // NVPTX: 32-bit
  71     nvptx64,    // NVPTX: 64-bit
  72     le32,       // le32: generic little-endian 32-bit CPU (PNaCl / Emscripten)
  73     amdil,      // amdil: amd IL
  74     spir,       // SPIR: standard portable IR for OpenCL 32-bit version
  75     spir64      // SPIR: standard portable IR for OpenCL 64-bit version
  76   };
  77   enum VendorType {
  78     UnknownVendor,
  79
  80     Apple,
  81     PC,
  82     SCEI,
  83     BGP,
  84     BGQ,
  85     Freescale,
  86     IBM,
  87     NVIDIA
  88   };
  89   enum OSType {
  90     UnknownOS,
  91
  92     AuroraUX,
  93     Cygwin,
  94     Darwin,
  95     DragonFly,
  96     FreeBSD,
  97     IOS,
  98     KFreeBSD,
  99     Linux,
 100     Lv2,        // PS3
 101     MacOSX,
 102     MinGW32,    // i*86-pc-mingw32, *-w64-mingw32
 103     NetBSD,
 104     OpenBSD,
 105     Solaris,
 106     Win32,
 107     Haiku,
 108     Minix,
 109     RTEMS,
 110     NaCl,       // Native Client
 111     CNK,        // BG/P Compute-Node Kernel
 112     Bitrig,
 113     AIX,
 114     CUDA,       // NVIDIA CUDA
 115     NVCL        // NVIDIA OpenCL
 116   };
 117   enum EnvironmentType {
 118     UnknownEnvironment,
 119
 120     GNU,
 121     GNUEABI,
 122     GNUEABIHF,
 123     GNUX32,
 124     CODE16,
 125     EABI,
 126     EABIHF,
 127     MachO,
 128     Android,
 129     ELF
 130   };
 131
 132 private:
 133   std::string Data;
 134
 135   /// The parsed arch type.
 136   ArchType Arch;
 137
 138   /// The parsed vendor type.
 139   VendorType Vendor;
 140
 141   /// The parsed OS type.
 142   OSType OS;
 143
 144   /// The parsed Environment type.
 145   EnvironmentType Environment;
 146
 147 public:
 148   /// @name Constructors
 149   /// @{
 150
 151   /// \brief Default constructor is the same as an empty string and leaves all
 152   /// triple fields unknown.
 153   Triple() : Data(), Arch(), Vendor(), OS(), Environment() {}
 154
 155   explicit Triple(const Twine &Str);
 156   Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
 157   Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
 158          const Twine &EnvironmentStr);
 159
 160   /// @}
 161   /// @name Normalization
 162   /// @{
 163
 164   /// normalize - Turn an arbitrary machine specification into the canonical
 165   /// triple form (or something sensible that the Triple class understands if
 166   /// nothing better can reasonably be done).  In particular, it handles the
 167   /// common case in which otherwise valid components are in the wrong order.
 168   static std::string normalize(StringRef Str);
 169
 170   /// @}
 171   /// @name Typed Component Access
 172   /// @{
 173
 174   /// getArch - Get the parsed architecture type of this triple.
 175   ArchType getArch() const { return Arch; }
 176
 177   /// getVendor - Get the parsed vendor type of this triple.
 178   VendorType getVendor() const { return Vendor; }
 179
 180   /// getOS - Get the parsed operating system type of this triple.
 181   OSType getOS() const { return OS; }
 182
 183   /// hasEnvironment - Does this triple have the optional environment
 184   /// (fourth) component?
 185   bool hasEnvironment() const {
 186     return getEnvironmentName() != "";
 187   }
 188
 189   /// getEnvironment - Get the parsed environment type of this triple.
 190   EnvironmentType getEnvironment() const { return Environment; }
 191
 192   /// getOSVersion - Parse the version number from the OS name component of the
 193   /// triple, if present.
 194   ///
 195   /// For example, "fooos1.2.3" would return (1, 2, 3).
 196   ///
 197   /// If an entry is not defined, it will be returned as 0.
 198   void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
 199
 200   /// getOSMajorVersion - Return just the major version number, this is
 201   /// specialized because it is a common query.
 202   unsigned getOSMajorVersion() const {
 203     unsigned Maj, Min, Micro;
 204     getOSVersion(Maj, Min, Micro);
 205     return Maj;
 206   }
 207
 208   /// getMacOSXVersion - Parse the version number as with getOSVersion and then
 209   /// translate generic "darwin" versions to the corresponding OS X versions.
 210   /// This may also be called with IOS triples but the OS X version number is
 211   /// just set to a constant 10.4.0 in that case.  Returns true if successful.
 212   bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
 213                         unsigned &Micro) const;
 214
 215   /// getiOSVersion - Parse the version number as with getOSVersion.  This should
 216   /// only be called with IOS triples.
 217   void getiOSVersion(unsigned &Major, unsigned &Minor,
 218                      unsigned &Micro) const;
 219
 220   /// @}
 221   /// @name Direct Component Access
 222   /// @{
 223
 224   const std::string &str() const { return Data; }
 225
 226   const std::string &getTriple() const { return Data; }
 227
 228   /// getArchName - Get the architecture (first) component of the
 229   /// triple.
 230   StringRef getArchName() const;
 231
 232   /// getVendorName - Get the vendor (second) component of the triple.
 233   StringRef getVendorName() const;
 234
 235   /// getOSName - Get the operating system (third) component of the
 236   /// triple.
 237   StringRef getOSName() const;
 238
 239   /// getEnvironmentName - Get the optional environment (fourth)
 240   /// component of the triple, or "" if empty.
 241   StringRef getEnvironmentName() const;
 242
 243   /// getOSAndEnvironmentName - Get the operating system and optional
 244   /// environment components as a single string (separated by a '-'
 245   /// if the environment component is present).
 246   StringRef getOSAndEnvironmentName() const;
 247
 248   /// @}
 249   /// @name Convenience Predicates
 250   /// @{
 251
 252   /// \brief Test whether the architecture is 64-bit
 253   ///
 254   /// Note that this tests for 64-bit pointer width, and nothing else. Note
 255   /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
 256   /// 16-bit. The inner details of pointer width for particular architectures
 257   /// is not summed up in the triple, and so only a coarse grained predicate
 258   /// system is provided.
 259   bool isArch64Bit() const;
 260
 261   /// \brief Test whether the architecture is 32-bit
 262   ///
 263   /// Note that this tests for 32-bit pointer width, and nothing else.
 264   bool isArch32Bit() const;
 265
 266   /// \brief Test whether the architecture is 16-bit
 267   ///
 268   /// Note that this tests for 16-bit pointer width, and nothing else.
 269   bool isArch16Bit() const;
 270
 271   /// isOSVersionLT - Helper function for doing comparisons against version
 272   /// numbers included in the target triple.
 273   bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
 274                      unsigned Micro = 0) const {
 275     unsigned LHS[3];
 276     getOSVersion(LHS[0], LHS[1], LHS[2]);
 277
 278     if (LHS[0] != Major)
 279       return LHS[0] < Major;
 280     if (LHS[1] != Minor)
 281       return LHS[1] < Minor;
 282     if (LHS[2] != Micro)
 283       return LHS[1] < Micro;
 284
 285     return false;
 286   }
 287
 288   /// isMacOSXVersionLT - Comparison function for checking OS X version
 289   /// compatibility, which handles supporting skewed version numbering schemes
 290   /// used by the "darwin" triples.
 291   unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
 292                              unsigned Micro = 0) const {
 293     assert(isMacOSX() && "Not an OS X triple!");
 294
 295     // If this is OS X, expect a sane version number.
 296     if (getOS() == Triple::MacOSX)
 297       return isOSVersionLT(Major, Minor, Micro);
 298
 299     // Otherwise, compare to the "Darwin" number.
 300     assert(Major == 10 && "Unexpected major version");
 301     return isOSVersionLT(Minor + 4, Micro, 0);
 302   }
 303
 304   /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
 305   /// "darwin" and "osx" as OS X triples.
 306   bool isMacOSX() const {
 307     return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
 308   }
 309
 310   /// Is this an iOS triple.
 311   bool isiOS() const {
 312     return getOS() == Triple::IOS;
 313   }
 314
 315   /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
 316   bool isOSDarwin() const {
 317     return isMacOSX() || isiOS();
 318   }
 319
 320   /// \brief Tests for either Cygwin or MinGW OS
 321   bool isOSCygMing() const {
 322     return getOS() == Triple::Cygwin || getOS() == Triple::MinGW32;
 323   }
 324
 325   /// \brief Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
 326   bool isOSMSVCRT() const {
 327     return getOS() == Triple::Win32 || getOS() == Triple::MinGW32;
 328   }
 329
 330   /// \brief Tests whether the OS is Windows.
 331   bool isOSWindows() const {
 332     return getOS() == Triple::Win32 || isOSCygMing();
 333   }
 334
 335   /// \brief Tests whether the OS is NaCl (Native Client)
 336   bool isOSNaCl() const {
 337     return getOS() == Triple::NaCl;
 338   }
 339
 340   /// \brief Tests whether the OS is Linux.
 341   bool isOSLinux() const {
 342     return getOS() == Triple::Linux;
 343   }
 344
 345   /// \brief Tests whether the OS uses the ELF binary format.
 346   bool isOSBinFormatELF() const {
 347     return !isOSBinFormatMachO() && !isOSBinFormatCOFF();
 348   }
 349
 350   /// \brief Tests whether the OS uses the COFF binary format.
 351   bool isOSBinFormatCOFF() const {
 352     return getEnvironment() != Triple::ELF &&
 353            getEnvironment() != Triple::MachO && isOSWindows();
 354   }
 355
 356   /// \brief Tests whether the environment is MachO.
 357   bool isOSBinFormatMachO() const {
 358     return getEnvironment() == Triple::MachO || isOSDarwin();
 359   }
 360
 361   /// @}
 362   /// @name Mutators
 363   /// @{
 364
 365   /// setArch - Set the architecture (first) component of the triple
 366   /// to a known type.
 367   void setArch(ArchType Kind);
 368
 369   /// setVendor - Set the vendor (second) component of the triple to a
 370   /// known type.
 371   void setVendor(VendorType Kind);
 372
 373   /// setOS - Set the operating system (third) component of the triple
 374   /// to a known type.
 375   void setOS(OSType Kind);
 376
 377   /// setEnvironment - Set the environment (fourth) component of the triple
 378   /// to a known type.
 379   void setEnvironment(EnvironmentType Kind);
 380
 381   /// setTriple - Set all components to the new triple \p Str.
 382   void setTriple(const Twine &Str);
 383
 384   /// setArchName - Set the architecture (first) component of the
 385   /// triple by name.
 386   void setArchName(StringRef Str);
 387
 388   /// setVendorName - Set the vendor (second) component of the triple
 389   /// by name.
 390   void setVendorName(StringRef Str);
 391
 392   /// setOSName - Set the operating system (third) component of the
 393   /// triple by name.
 394   void setOSName(StringRef Str);
 395
 396   /// setEnvironmentName - Set the optional environment (fourth)
 397   /// component of the triple by name.
 398   void setEnvironmentName(StringRef Str);
 399
 400   /// setOSAndEnvironmentName - Set the operating system and optional
 401   /// environment components with a single string.
 402   void setOSAndEnvironmentName(StringRef Str);
 403
 404   /// getArchNameForAssembler - Get an architecture name that is understood by
 405   /// the target assembler.
 406   const char *getArchNameForAssembler();
 407
 408   /// @}
 409   /// @name Helpers to build variants of a particular triple.
 410   /// @{
 411
 412   /// \brief Form a triple with a 32-bit variant of the current architecture.
 413   ///
 414   /// This can be used to move across "families" of architectures where useful.
 415   ///
 416   /// \returns A new triple with a 32-bit architecture or an unknown
 417   ///          architecture if no such variant can be found.
 418   llvm::Triple get32BitArchVariant() const;
 419
 420   /// \brief Form a triple with a 64-bit variant of the current architecture.
 421   ///
 422   /// This can be used to move across "families" of architectures where useful.
 423   ///
 424   /// \returns A new triple with a 64-bit architecture or an unknown
 425   ///          architecture if no such variant can be found.
 426   llvm::Triple get64BitArchVariant() const;
 427
 428   /// @}
 429   /// @name Static helpers for IDs.
 430   /// @{
 431
 432   /// getArchTypeName - Get the canonical name for the \p Kind architecture.
 433   static const char *getArchTypeName(ArchType Kind);
 434
 435   /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
 436   /// architecture. This is the prefix used by the architecture specific
 437   /// builtins, and is suitable for passing to \see
 438   /// Intrinsic::getIntrinsicForGCCBuiltin().
 439   ///
 440   /// \return - The architecture prefix, or 0 if none is defined.
 441   static const char *getArchTypePrefix(ArchType Kind);
 442
 443   /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
 444   static const char *getVendorTypeName(VendorType Kind);
 445
 446   /// getOSTypeName - Get the canonical name for the \p Kind operating system.
 447   static const char *getOSTypeName(OSType Kind);
 448
 449   /// getEnvironmentTypeName - Get the canonical name for the \p Kind
 450   /// environment.
 451   static const char *getEnvironmentTypeName(EnvironmentType Kind);
 452
 453   /// @}
 454   /// @name Static helpers for converting alternate architecture names.
 455   /// @{
 456
 457   /// getArchTypeForLLVMName - The canonical type for the given LLVM
 458   /// architecture name (e.g., "x86").
 459   static ArchType getArchTypeForLLVMName(StringRef Str);
 460
 461   /// @}
 462 };
 463
 464 } // End llvm namespace
 465
 466
 467 #endif