1 //===-- llvm/ADT/Triple.h - Target triple helper class ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_ADT_TRIPLE_H
11 #define LLVM_ADT_TRIPLE_H
13 #include "llvm/ADT/Twine.h"
15 // Some system headers or GCC predefined macros conflict with identifiers in
16 // this file. Undefine them here.
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).
27 /// Configuration names are strings in the canonical form:
28 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
30 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
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.
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.
42 /// See autoconf/config.guess for a glimpse into what configuration names
43 /// look like in practice.
49 arm, // ARM (little endian): arm, armv.*, xscale
50 armeb, // ARM (big endian): armeb
51 aarch64, // AArch64 (little endian): aarch64
52 aarch64_be, // AArch64 (big endian): aarch64_be
53 bpfel, // eBPF or extended BPF or 64-bit BPF (little endian)
54 bpfeb, // eBPF or extended BPF or 64-bit BPF (big endian)
55 hexagon, // Hexagon: hexagon
56 mips, // MIPS: mips, mipsallegrex
57 mipsel, // MIPSEL: mipsel, mipsallegrexel
58 mips64, // MIPS64: mips64
59 mips64el, // MIPS64EL: mips64el
60 msp430, // MSP430: msp430
62 ppc64, // PPC64: powerpc64, ppu
63 ppc64le, // PPC64LE: powerpc64le
64 r600, // R600: AMD GPUs HD2XXX - HD6XXX
65 amdgcn, // AMDGCN: AMD GCN GPUs
66 sparc, // Sparc: sparc
67 sparcv9, // Sparcv9: Sparcv9
68 sparcel, // Sparc: (endianness = little). NB: 'Sparcle' is a CPU variant
69 systemz, // SystemZ: s390x
70 tce, // TCE (http://tce.cs.tut.fi/): tce
71 thumb, // Thumb (little endian): thumb, thumbv.*
72 thumbeb, // Thumb (big endian): thumbeb
74 x86_64, // X86-64: amd64, x86_64
75 xcore, // XCore: xcore
76 nvptx, // NVPTX: 32-bit
77 nvptx64, // NVPTX: 64-bit
78 le32, // le32: generic little-endian 32-bit CPU (PNaCl / Emscripten)
79 le64, // le64: generic little-endian 64-bit CPU (PNaCl / Emscripten)
81 amdil64, // AMDIL with 64-bit pointers
83 hsail64, // AMD HSAIL with 64-bit pointers
84 spir, // SPIR: standard portable IR for OpenCL 32-bit version
85 spir64, // SPIR: standard portable IR for OpenCL 64-bit version
86 kalimba, // Kalimba: generic kalimba
87 shave, // SHAVE: Movidius vector VLIW processors
88 wasm32, // WebAssembly with 32-bit pointers
89 wasm64, // WebAssembly with 64-bit pointers
123 ImaginationTechnologies,
148 NaCl, // Native Client
149 CNK, // BG/P Compute-Node Kernel
153 NVCL, // NVIDIA OpenCL
154 AMDHSA, // AMD HSA Runtime
158 enum EnvironmentType {
173 LastEnvironmentType = Cygnus
175 enum ObjectFormatType {
186 /// The parsed arch type.
189 /// The parsed subarchitecture type.
192 /// The parsed vendor type.
195 /// The parsed OS type.
198 /// The parsed Environment type.
199 EnvironmentType Environment;
201 /// The object format type.
202 ObjectFormatType ObjectFormat;
205 /// @name Constructors
208 /// \brief Default constructor is the same as an empty string and leaves all
209 /// triple fields unknown.
210 Triple() : Data(), Arch(), Vendor(), OS(), Environment(), ObjectFormat() {}
212 explicit Triple(const Twine &Str);
213 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
214 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
215 const Twine &EnvironmentStr);
217 bool operator==(const Triple &Other) const {
218 return Arch == Other.Arch && SubArch == Other.SubArch &&
219 Vendor == Other.Vendor && OS == Other.OS &&
220 Environment == Other.Environment &&
221 ObjectFormat == Other.ObjectFormat;
225 /// @name Normalization
228 /// normalize - Turn an arbitrary machine specification into the canonical
229 /// triple form (or something sensible that the Triple class understands if
230 /// nothing better can reasonably be done). In particular, it handles the
231 /// common case in which otherwise valid components are in the wrong order.
232 static std::string normalize(StringRef Str);
234 /// \brief Return the normalized form of this triple's string.
235 std::string normalize() const { return normalize(Data); }
238 /// @name Typed Component Access
241 /// getArch - Get the parsed architecture type of this triple.
242 ArchType getArch() const { return Arch; }
244 /// getSubArch - get the parsed subarchitecture type for this triple.
245 SubArchType getSubArch() const { return SubArch; }
247 /// getVendor - Get the parsed vendor type of this triple.
248 VendorType getVendor() const { return Vendor; }
250 /// getOS - Get the parsed operating system type of this triple.
251 OSType getOS() const { return OS; }
253 /// hasEnvironment - Does this triple have the optional environment
254 /// (fourth) component?
255 bool hasEnvironment() const {
256 return getEnvironmentName() != "";
259 /// getEnvironment - Get the parsed environment type of this triple.
260 EnvironmentType getEnvironment() const { return Environment; }
262 /// \brief Parse the version number from the OS name component of the
263 /// triple, if present.
265 /// For example, "fooos1.2.3" would return (1, 2, 3).
267 /// If an entry is not defined, it will be returned as 0.
268 void getEnvironmentVersion(unsigned &Major, unsigned &Minor,
269 unsigned &Micro) const;
271 /// getFormat - Get the object format for this triple.
272 ObjectFormatType getObjectFormat() const { return ObjectFormat; }
274 /// getOSVersion - Parse the version number from the OS name component of the
275 /// triple, if present.
277 /// For example, "fooos1.2.3" would return (1, 2, 3).
279 /// If an entry is not defined, it will be returned as 0.
280 void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
282 /// getOSMajorVersion - Return just the major version number, this is
283 /// specialized because it is a common query.
284 unsigned getOSMajorVersion() const {
285 unsigned Maj, Min, Micro;
286 getOSVersion(Maj, Min, Micro);
290 /// getMacOSXVersion - Parse the version number as with getOSVersion and then
291 /// translate generic "darwin" versions to the corresponding OS X versions.
292 /// This may also be called with IOS triples but the OS X version number is
293 /// just set to a constant 10.4.0 in that case. Returns true if successful.
294 bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
295 unsigned &Micro) const;
297 /// getiOSVersion - Parse the version number as with getOSVersion. This should
298 /// only be called with IOS triples.
299 void getiOSVersion(unsigned &Major, unsigned &Minor,
300 unsigned &Micro) const;
303 /// @name Direct Component Access
306 const std::string &str() const { return Data; }
308 const std::string &getTriple() const { return Data; }
310 /// getArchName - Get the architecture (first) component of the
312 StringRef getArchName() const;
314 /// getVendorName - Get the vendor (second) component of the triple.
315 StringRef getVendorName() const;
317 /// getOSName - Get the operating system (third) component of the
319 StringRef getOSName() const;
321 /// getEnvironmentName - Get the optional environment (fourth)
322 /// component of the triple, or "" if empty.
323 StringRef getEnvironmentName() const;
325 /// getOSAndEnvironmentName - Get the operating system and optional
326 /// environment components as a single string (separated by a '-'
327 /// if the environment component is present).
328 StringRef getOSAndEnvironmentName() const;
331 /// @name Convenience Predicates
334 /// \brief Test whether the architecture is 64-bit
336 /// Note that this tests for 64-bit pointer width, and nothing else. Note
337 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
338 /// 16-bit. The inner details of pointer width for particular architectures
339 /// is not summed up in the triple, and so only a coarse grained predicate
340 /// system is provided.
341 bool isArch64Bit() const;
343 /// \brief Test whether the architecture is 32-bit
345 /// Note that this tests for 32-bit pointer width, and nothing else.
346 bool isArch32Bit() const;
348 /// \brief Test whether the architecture is 16-bit
350 /// Note that this tests for 16-bit pointer width, and nothing else.
351 bool isArch16Bit() const;
353 /// isOSVersionLT - Helper function for doing comparisons against version
354 /// numbers included in the target triple.
355 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
356 unsigned Micro = 0) const {
358 getOSVersion(LHS[0], LHS[1], LHS[2]);
361 return LHS[0] < Major;
363 return LHS[1] < Minor;
365 return LHS[1] < Micro;
370 bool isOSVersionLT(const Triple &Other) const {
372 Other.getOSVersion(RHS[0], RHS[1], RHS[2]);
373 return isOSVersionLT(RHS[0], RHS[1], RHS[2]);
376 /// isMacOSXVersionLT - Comparison function for checking OS X version
377 /// compatibility, which handles supporting skewed version numbering schemes
378 /// used by the "darwin" triples.
379 unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
380 unsigned Micro = 0) const {
381 assert(isMacOSX() && "Not an OS X triple!");
383 // If this is OS X, expect a sane version number.
384 if (getOS() == Triple::MacOSX)
385 return isOSVersionLT(Major, Minor, Micro);
387 // Otherwise, compare to the "Darwin" number.
388 assert(Major == 10 && "Unexpected major version");
389 return isOSVersionLT(Minor + 4, Micro, 0);
392 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
393 /// "darwin" and "osx" as OS X triples.
394 bool isMacOSX() const {
395 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
398 /// Is this an iOS triple.
400 return getOS() == Triple::IOS;
403 /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
404 bool isOSDarwin() const {
405 return isMacOSX() || isiOS();
408 bool isOSNetBSD() const {
409 return getOS() == Triple::NetBSD;
412 bool isOSOpenBSD() const {
413 return getOS() == Triple::OpenBSD;
416 bool isOSFreeBSD() const {
417 return getOS() == Triple::FreeBSD;
420 bool isOSDragonFly() const { return getOS() == Triple::DragonFly; }
422 bool isOSSolaris() const {
423 return getOS() == Triple::Solaris;
426 bool isOSBitrig() const {
427 return getOS() == Triple::Bitrig;
430 bool isWindowsMSVCEnvironment() const {
431 return getOS() == Triple::Win32 &&
432 (getEnvironment() == Triple::UnknownEnvironment ||
433 getEnvironment() == Triple::MSVC);
436 bool isKnownWindowsMSVCEnvironment() const {
437 return getOS() == Triple::Win32 && getEnvironment() == Triple::MSVC;
440 bool isWindowsItaniumEnvironment() const {
441 return getOS() == Triple::Win32 && getEnvironment() == Triple::Itanium;
444 bool isWindowsCygwinEnvironment() const {
445 return getOS() == Triple::Win32 && getEnvironment() == Triple::Cygnus;
448 bool isWindowsGNUEnvironment() const {
449 return getOS() == Triple::Win32 && getEnvironment() == Triple::GNU;
452 /// \brief Tests for either Cygwin or MinGW OS
453 bool isOSCygMing() const {
454 return isWindowsCygwinEnvironment() || isWindowsGNUEnvironment();
457 /// \brief Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
458 bool isOSMSVCRT() const {
459 return isWindowsMSVCEnvironment() || isWindowsGNUEnvironment() ||
460 isWindowsItaniumEnvironment();
463 /// \brief Tests whether the OS is Windows.
464 bool isOSWindows() const {
465 return getOS() == Triple::Win32;
468 /// \brief Tests whether the OS is NaCl (Native Client)
469 bool isOSNaCl() const {
470 return getOS() == Triple::NaCl;
473 /// \brief Tests whether the OS is Linux.
474 bool isOSLinux() const {
475 return getOS() == Triple::Linux;
478 /// \brief Tests whether the OS uses the ELF binary format.
479 bool isOSBinFormatELF() const {
480 return getObjectFormat() == Triple::ELF;
483 /// \brief Tests whether the OS uses the COFF binary format.
484 bool isOSBinFormatCOFF() const {
485 return getObjectFormat() == Triple::COFF;
488 /// \brief Tests whether the environment is MachO.
489 bool isOSBinFormatMachO() const {
490 return getObjectFormat() == Triple::MachO;
493 /// \brief Tests whether the target is the PS4 CPU
494 bool isPS4CPU() const {
495 return getArch() == Triple::x86_64 &&
496 getVendor() == Triple::SCEI &&
497 getOS() == Triple::PS4;
500 /// \brief Tests whether the target is the PS4 platform
502 return getVendor() == Triple::SCEI &&
503 getOS() == Triple::PS4;
510 /// setArch - Set the architecture (first) component of the triple
512 void setArch(ArchType Kind);
514 /// setVendor - Set the vendor (second) component of the triple to a
516 void setVendor(VendorType Kind);
518 /// setOS - Set the operating system (third) component of the triple
520 void setOS(OSType Kind);
522 /// setEnvironment - Set the environment (fourth) component of the triple
524 void setEnvironment(EnvironmentType Kind);
526 /// setObjectFormat - Set the object file format
527 void setObjectFormat(ObjectFormatType Kind);
529 /// setTriple - Set all components to the new triple \p Str.
530 void setTriple(const Twine &Str);
532 /// setArchName - Set the architecture (first) component of the
534 void setArchName(StringRef Str);
536 /// setVendorName - Set the vendor (second) component of the triple
538 void setVendorName(StringRef Str);
540 /// setOSName - Set the operating system (third) component of the
542 void setOSName(StringRef Str);
544 /// setEnvironmentName - Set the optional environment (fourth)
545 /// component of the triple by name.
546 void setEnvironmentName(StringRef Str);
548 /// setOSAndEnvironmentName - Set the operating system and optional
549 /// environment components with a single string.
550 void setOSAndEnvironmentName(StringRef Str);
553 /// @name Helpers to build variants of a particular triple.
556 /// \brief Form a triple with a 32-bit variant of the current architecture.
558 /// This can be used to move across "families" of architectures where useful.
560 /// \returns A new triple with a 32-bit architecture or an unknown
561 /// architecture if no such variant can be found.
562 llvm::Triple get32BitArchVariant() const;
564 /// \brief Form a triple with a 64-bit variant of the current architecture.
566 /// This can be used to move across "families" of architectures where useful.
568 /// \returns A new triple with a 64-bit architecture or an unknown
569 /// architecture if no such variant can be found.
570 llvm::Triple get64BitArchVariant() const;
572 /// Get the (LLVM) name of the minimum ARM CPU for the arch we are targeting.
574 /// \param Arch the architecture name (e.g., "armv7s"). If it is an empty
575 /// string then the triple's arch name is used.
576 const char* getARMCPUForArch(StringRef Arch = StringRef()) const;
579 /// @name Static helpers for IDs.
582 /// getArchTypeName - Get the canonical name for the \p Kind architecture.
583 static const char *getArchTypeName(ArchType Kind);
585 /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
586 /// architecture. This is the prefix used by the architecture specific
587 /// builtins, and is suitable for passing to \see
588 /// Intrinsic::getIntrinsicForGCCBuiltin().
590 /// \return - The architecture prefix, or 0 if none is defined.
591 static const char *getArchTypePrefix(ArchType Kind);
593 /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
594 static const char *getVendorTypeName(VendorType Kind);
596 /// getOSTypeName - Get the canonical name for the \p Kind operating system.
597 static const char *getOSTypeName(OSType Kind);
599 /// getEnvironmentTypeName - Get the canonical name for the \p Kind
601 static const char *getEnvironmentTypeName(EnvironmentType Kind);
604 /// @name Static helpers for converting alternate architecture names.
607 /// getArchTypeForLLVMName - The canonical type for the given LLVM
608 /// architecture name (e.g., "x86").
609 static ArchType getArchTypeForLLVMName(StringRef Str);
614 } // End llvm namespace