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