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