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/StringRef.h"
  14 #include <string>
  15
  16 // Some system headers or GCC predefined macros conflict with identifiers in
  17 // this file.  Undefine them here.
  18 #undef mips
  19 #undef sparc
  20
  21 namespace llvm {
  22 class StringRef;
  23 class Twine;
  24
  25 /// Triple - Helper class for working with target triples.
  26 ///
  27 /// Target triples 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 /// target triples, but also want to implement certain special
  34 /// behavior for particular targets. This class isolates the mapping
  35 /// from the components of the target triple 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 triples look like in
  43 /// practice.
  44 class Triple {
  45 public:
  46   enum ArchType {
  47     UnknownArch,
  48
  49     alpha,   // Alpha: alpha
  50     arm,     // ARM; arm, armv.*, xscale
  51     bfin,    // Blackfin: bfin
  52     cellspu, // CellSPU: spu, cellspu
  53     mips,    // MIPS: mips, mipsallegrex
  54     mipsel,  // MIPSEL: mipsel, mipsallegrexel, psp
  55     msp430,  // MSP430: msp430
  56     ppc,     // PPC: powerpc
  57     ppc64,   // PPC64: powerpc64, ppu
  58     sparc,   // Sparc: sparc
  59     sparcv9, // Sparcv9: Sparcv9
  60     systemz, // SystemZ: s390x
  61     tce,     // TCE (http://tce.cs.tut.fi/): tce
  62     thumb,   // Thumb: thumb, thumbv.*
  63     x86,     // X86: i[3-9]86
  64     x86_64,  // X86-64: amd64, x86_64
  65     xcore,   // XCore: xcore
  66     mblaze,  // MBlaze: mblaze
  67     ptx,     // PTX: ptx
  68
  69     InvalidArch
  70   };
  71   enum VendorType {
  72     UnknownVendor,
  73
  74     Apple,
  75     PC,
  76     SCEI
  77   };
  78   enum OSType {
  79     UnknownOS,
  80
  81     AuroraUX,
  82     Cygwin,
  83     Darwin,
  84     DragonFly,
  85     FreeBSD,
  86     IOS,
  87     Linux,
  88     Lv2,        // PS3
  89     MinGW32,    // i*86-pc-mingw32, *-w64-mingw32
  90     NetBSD,
  91     OSX,
  92     OpenBSD,
  93     Psp,
  94     Solaris,
  95     Win32,
  96     Haiku,
  97     Minix
  98   };
  99   enum EnvironmentType {
 100     UnknownEnvironment,
 101
 102     GNU,
 103     GNUEABI,
 104     EABI,
 105     MachO
 106   };
 107
 108 private:
 109   std::string Data;
 110
 111   /// The parsed arch type (or InvalidArch if uninitialized).
 112   mutable ArchType Arch;
 113
 114   /// The parsed vendor type.
 115   mutable VendorType Vendor;
 116
 117   /// The parsed OS type.
 118   mutable OSType OS;
 119
 120   /// The parsed Environment type.
 121   mutable EnvironmentType Environment;
 122
 123   bool isInitialized() const { return Arch != InvalidArch; }
 124   static ArchType ParseArch(StringRef ArchName);
 125   static VendorType ParseVendor(StringRef VendorName);
 126   static OSType ParseOS(StringRef OSName);
 127   static EnvironmentType ParseEnvironment(StringRef EnvironmentName);
 128   void Parse() const;
 129
 130 public:
 131   /// @name Constructors
 132   /// @{
 133
 134   Triple() : Data(), Arch(InvalidArch) {}
 135   explicit Triple(StringRef Str) : Data(Str), Arch(InvalidArch) {}
 136   explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr)
 137     : Data(ArchStr), Arch(InvalidArch) {
 138     Data += '-';
 139     Data += VendorStr;
 140     Data += '-';
 141     Data += OSStr;
 142   }
 143
 144   explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr,
 145     StringRef EnvironmentStr)
 146     : Data(ArchStr), Arch(InvalidArch) {
 147     Data += '-';
 148     Data += VendorStr;
 149     Data += '-';
 150     Data += OSStr;
 151     Data += '-';
 152     Data += EnvironmentStr;
 153   }
 154
 155   /// @}
 156   /// @name Normalization
 157   /// @{
 158
 159   /// normalize - Turn an arbitrary machine specification into the canonical
 160   /// triple form (or something sensible that the Triple class understands if
 161   /// nothing better can reasonably be done).  In particular, it handles the
 162   /// common case in which otherwise valid components are in the wrong order.
 163   static std::string normalize(StringRef Str);
 164
 165   /// @}
 166   /// @name Typed Component Access
 167   /// @{
 168
 169   /// getArch - Get the parsed architecture type of this triple.
 170   ArchType getArch() const {
 171     if (!isInitialized()) Parse();
 172     return Arch;
 173   }
 174
 175   /// getVendor - Get the parsed vendor type of this triple.
 176   VendorType getVendor() const {
 177     if (!isInitialized()) Parse();
 178     return Vendor;
 179   }
 180
 181   /// getOS - Get the parsed operating system type of this triple.
 182   OSType getOS() const {
 183     if (!isInitialized()) Parse();
 184     return OS;
 185   }
 186
 187   /// hasEnvironment - Does this triple have the optional environment
 188   /// (fourth) component?
 189   bool hasEnvironment() const {
 190     return getEnvironmentName() != "";
 191   }
 192
 193   /// getEnvironment - Get the parsed environment type of this triple.
 194   EnvironmentType getEnvironment() const {
 195     if (!isInitialized()) Parse();
 196     return Environment;
 197   }
 198
 199   /// @}
 200   /// @name Direct Component Access
 201   /// @{
 202
 203   const std::string &str() const { return Data; }
 204
 205   const std::string &getTriple() const { return Data; }
 206
 207   /// getArchName - Get the architecture (first) component of the
 208   /// triple.
 209   StringRef getArchName() const;
 210
 211   /// getVendorName - Get the vendor (second) component of the triple.
 212   StringRef getVendorName() const;
 213
 214   /// getOSName - Get the operating system (third) component of the
 215   /// triple.
 216   StringRef getOSName() const;
 217
 218   /// getEnvironmentName - Get the optional environment (fourth)
 219   /// component of the triple, or "" if empty.
 220   StringRef getEnvironmentName() const;
 221
 222   /// getOSAndEnvironmentName - Get the operating system and optional
 223   /// environment components as a single string (separated by a '-'
 224   /// if the environment component is present).
 225   StringRef getOSAndEnvironmentName() const;
 226
 227   /// getOSNumber - Parse the version number from the OS name component of the
 228   /// triple, if present.
 229   ///
 230   /// For example, "fooos1.2.3" would return (1, 2, 3).
 231   ///
 232   /// If an entry is not defined, it will be returned as 0.
 233   void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
 234
 235   /// getOSMajorVersion - Return just the major version number, this is
 236   /// specialized because it is a common query.
 237   unsigned getOSMajorVersion() const {
 238     unsigned Maj, Min, Micro;
 239     getDarwinNumber(Maj, Min, Micro);
 240     return Maj;
 241   }
 242
 243   void getDarwinNumber(unsigned &Major, unsigned &Minor,
 244                        unsigned &Micro) const {
 245     return getOSVersion(Major, Minor, Micro);
 246   }
 247
 248   unsigned getDarwinMajorNumber() const {
 249     return getOSMajorVersion();
 250   }
 251
 252   bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
 253                      unsigned Micro = 0) const {
 254     unsigned LHS[3];
 255     getOSVersion(LHS[0], LHS[1], LHS[2]);
 256
 257     if (LHS[0] != Major)
 258       return LHS[0] < Major;
 259     if (LHS[1] != Minor)
 260       return LHS[1] < Minor;
 261     if (LHS[2] != Micro)
 262       return LHS[1] < Micro;
 263
 264     return false;
 265   }
 266
 267   /// isOSX - Is this an OS X triple. For legacy reasons, we support both
 268   /// "darwin" and "osx" as OS X triples.
 269   bool isOSX() const {
 270     return getOS() == Triple::Darwin || getOS() == Triple::OSX;
 271   }
 272
 273   /// isOSXVersionLT - Comparison function for checking OS X version
 274   /// compatibility, which handles supporting skewed version numbering schemes
 275   /// used by the "darwin" triples.
 276   unsigned isOSXVersionLT(unsigned Major, unsigned Minor = 0,
 277                           unsigned Micro = 0) const {
 278     assert(isOSX() && "Not an OS X triple!");
 279
 280     // If this is OS X, expect a sane version number.
 281     if (getOS() == Triple::OSX)
 282       return isOSVersionLT(Major, Minor, Micro);
 283
 284     // Otherwise, compare to the "Darwin" number.
 285     assert(Major == 10 && "Unexpected major version");
 286     return isOSVersionLT(Minor + 4, Micro, 0);
 287   }
 288
 289   /// @}
 290   /// @name Mutators
 291   /// @{
 292
 293   /// setArch - Set the architecture (first) component of the triple
 294   /// to a known type.
 295   void setArch(ArchType Kind);
 296
 297   /// setVendor - Set the vendor (second) component of the triple to a
 298   /// known type.
 299   void setVendor(VendorType Kind);
 300
 301   /// setOS - Set the operating system (third) component of the triple
 302   /// to a known type.
 303   void setOS(OSType Kind);
 304
 305   /// setEnvironment - Set the environment (fourth) component of the triple
 306   /// to a known type.
 307   void setEnvironment(EnvironmentType Kind);
 308
 309   /// setTriple - Set all components to the new triple \arg Str.
 310   void setTriple(const Twine &Str);
 311
 312   /// setArchName - Set the architecture (first) component of the
 313   /// triple by name.
 314   void setArchName(StringRef Str);
 315
 316   /// setVendorName - Set the vendor (second) component of the triple
 317   /// by name.
 318   void setVendorName(StringRef Str);
 319
 320   /// setOSName - Set the operating system (third) component of the
 321   /// triple by name.
 322   void setOSName(StringRef Str);
 323
 324   /// setEnvironmentName - Set the optional environment (fourth)
 325   /// component of the triple by name.
 326   void setEnvironmentName(StringRef Str);
 327
 328   /// setOSAndEnvironmentName - Set the operating system and optional
 329   /// environment components with a single string.
 330   void setOSAndEnvironmentName(StringRef Str);
 331
 332   /// getArchNameForAssembler - Get an architecture name that is understood by
 333   /// the target assembler.
 334   const char *getArchNameForAssembler();
 335
 336   /// @}
 337   /// @name Static helpers for IDs.
 338   /// @{
 339
 340   /// getArchTypeName - Get the canonical name for the \arg Kind
 341   /// architecture.
 342   static const char *getArchTypeName(ArchType Kind);
 343
 344   /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
 345   /// architecture. This is the prefix used by the architecture specific
 346   /// builtins, and is suitable for passing to \see
 347   /// Intrinsic::getIntrinsicForGCCBuiltin().
 348   ///
 349   /// \return - The architecture prefix, or 0 if none is defined.
 350   static const char *getArchTypePrefix(ArchType Kind);
 351
 352   /// getVendorTypeName - Get the canonical name for the \arg Kind
 353   /// vendor.
 354   static const char *getVendorTypeName(VendorType Kind);
 355
 356   /// getOSTypeName - Get the canonical name for the \arg Kind operating
 357   /// system.
 358   static const char *getOSTypeName(OSType Kind);
 359
 360   /// getEnvironmentTypeName - Get the canonical name for the \arg Kind
 361   /// environment.
 362   static const char *getEnvironmentTypeName(EnvironmentType Kind);
 363
 364   /// @}
 365   /// @name Static helpers for converting alternate architecture names.
 366   /// @{
 367
 368   /// getArchTypeForLLVMName - The canonical type for the given LLVM
 369   /// architecture name (e.g., "x86").
 370   static ArchType getArchTypeForLLVMName(StringRef Str);
 371
 372   /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
 373   /// architecture name, for example as accepted by "gcc -arch" (see also
 374   /// arch(3)).
 375   static ArchType getArchTypeForDarwinArchName(StringRef Str);
 376
 377   /// @}
 378 };
 379
 380 } // End llvm namespace
 381
 382
 383 #endif