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 avr, // AVR: Atmel AVR microcontroller
54 bpfel, // eBPF or extended BPF or 64-bit BPF (little endian)
55 bpfeb, // eBPF or extended BPF or 64-bit BPF (big endian)
56 hexagon, // Hexagon: hexagon
57 mips, // MIPS: mips, mipsallegrex
58 mipsel, // MIPSEL: mipsel, mipsallegrexel
59 mips64, // MIPS64: mips64
60 mips64el, // MIPS64EL: mips64el
61 msp430, // MSP430: msp430
63 ppc64, // PPC64: powerpc64, ppu
64 ppc64le, // PPC64LE: powerpc64le
65 r600, // R600: AMD GPUs HD2XXX - HD6XXX
66 amdgcn, // AMDGCN: AMD GCN GPUs
67 riscv32, // RISC-V (32-bit): riscv32
68 riscv64, // RISC-V (64-bit): riscv64
69 sparc, // Sparc: sparc
70 sparcv9, // Sparcv9: Sparcv9
71 sparcel, // Sparc: (endianness = little). NB: 'Sparcle' is a CPU variant
72 systemz, // SystemZ: s390x
73 tce, // TCE (http://tce.cs.tut.fi/): tce
74 tcele, // TCE little endian (http://tce.cs.tut.fi/): tcele
75 thumb, // Thumb (little endian): thumb, thumbv.*
76 thumbeb, // Thumb (big endian): thumbeb
78 x86_64, // X86-64: amd64, x86_64
79 xcore, // XCore: xcore
80 nvptx, // NVPTX: 32-bit
81 nvptx64, // NVPTX: 64-bit
82 le32, // le32: generic little-endian 32-bit CPU (PNaCl)
83 le64, // le64: generic little-endian 64-bit CPU (PNaCl)
85 amdil64, // AMDIL with 64-bit pointers
87 hsail64, // AMD HSAIL with 64-bit pointers
88 spir, // SPIR: standard portable IR for OpenCL 32-bit version
89 spir64, // SPIR: standard portable IR for OpenCL 64-bit version
90 kalimba, // Kalimba: generic kalimba
91 shave, // SHAVE: Movidius vector VLIW processors
92 lanai, // Lanai: Lanai 32-bit
93 wasm32, // WebAssembly with 32-bit pointers
94 wasm64, // WebAssembly with 64-bit pointers
95 renderscript32, // 32-bit RenderScript
96 renderscript64, // 64-bit RenderScript
97 LastArchType = renderscript64
106 ARMSubArch_v8m_baseline,
107 ARMSubArch_v8m_mainline,
136 ImaginationTechnologies,
143 LastVendorType = Mesa
165 NaCl, // Native Client
166 CNK, // BG/P Compute-Node Kernel
170 NVCL, // NVIDIA OpenCL
171 AMDHSA, // AMD HSA Runtime
175 WatchOS, // Apple watchOS
180 enum EnvironmentType {
202 LastEnvironmentType = OpenCL
204 enum ObjectFormatType {
216 /// The parsed arch type.
219 /// The parsed subarchitecture type.
222 /// The parsed vendor type.
225 /// The parsed OS type.
228 /// The parsed Environment type.
229 EnvironmentType Environment;
231 /// The object format type.
232 ObjectFormatType ObjectFormat;
235 /// @name Constructors
238 /// Default constructor is the same as an empty string and leaves all
239 /// triple fields unknown.
240 Triple() : Data(), Arch(), Vendor(), OS(), Environment(), ObjectFormat() {}
242 explicit Triple(const Twine &Str);
243 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
244 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
245 const Twine &EnvironmentStr);
247 bool operator==(const Triple &Other) const {
248 return Arch == Other.Arch && SubArch == Other.SubArch &&
249 Vendor == Other.Vendor && OS == Other.OS &&
250 Environment == Other.Environment &&
251 ObjectFormat == Other.ObjectFormat;
255 /// @name Normalization
258 /// normalize - Turn an arbitrary machine specification into the canonical
259 /// triple form (or something sensible that the Triple class understands if
260 /// nothing better can reasonably be done). In particular, it handles the
261 /// common case in which otherwise valid components are in the wrong order.
262 static std::string normalize(StringRef Str);
264 /// Return the normalized form of this triple's string.
265 std::string normalize() const { return normalize(Data); }
268 /// @name Typed Component Access
271 /// getArch - Get the parsed architecture type of this triple.
272 ArchType getArch() const { return Arch; }
274 /// getSubArch - get the parsed subarchitecture type for this triple.
275 SubArchType getSubArch() const { return SubArch; }
277 /// getVendor - Get the parsed vendor type of this triple.
278 VendorType getVendor() const { return Vendor; }
280 /// getOS - Get the parsed operating system type of this triple.
281 OSType getOS() const { return OS; }
283 /// hasEnvironment - Does this triple have the optional environment
284 /// (fourth) component?
285 bool hasEnvironment() const {
286 return getEnvironmentName() != "";
289 /// getEnvironment - Get the parsed environment type of this triple.
290 EnvironmentType getEnvironment() const { return Environment; }
292 /// Parse the version number from the OS name component of the
293 /// triple, if present.
295 /// For example, "fooos1.2.3" would return (1, 2, 3).
297 /// If an entry is not defined, it will be returned as 0.
298 void getEnvironmentVersion(unsigned &Major, unsigned &Minor,
299 unsigned &Micro) const;
301 /// getFormat - Get the object format for this triple.
302 ObjectFormatType getObjectFormat() const { return ObjectFormat; }
304 /// getOSVersion - Parse the version number from the OS name component of the
305 /// triple, if present.
307 /// For example, "fooos1.2.3" would return (1, 2, 3).
309 /// If an entry is not defined, it will be returned as 0.
310 void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
312 /// getOSMajorVersion - Return just the major version number, this is
313 /// specialized because it is a common query.
314 unsigned getOSMajorVersion() const {
315 unsigned Maj, Min, Micro;
316 getOSVersion(Maj, Min, Micro);
320 /// getMacOSXVersion - Parse the version number as with getOSVersion and then
321 /// translate generic "darwin" versions to the corresponding OS X versions.
322 /// This may also be called with IOS triples but the OS X version number is
323 /// just set to a constant 10.4.0 in that case. Returns true if successful.
324 bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
325 unsigned &Micro) const;
327 /// getiOSVersion - Parse the version number as with getOSVersion. This should
328 /// only be called with IOS or generic triples.
329 void getiOSVersion(unsigned &Major, unsigned &Minor,
330 unsigned &Micro) const;
332 /// getWatchOSVersion - Parse the version number as with getOSVersion. This
333 /// should only be called with WatchOS or generic triples.
334 void getWatchOSVersion(unsigned &Major, unsigned &Minor,
335 unsigned &Micro) const;
338 /// @name Direct Component Access
341 const std::string &str() const { return Data; }
343 const std::string &getTriple() const { return Data; }
345 /// getArchName - Get the architecture (first) component of the
347 StringRef getArchName() const;
349 /// getVendorName - Get the vendor (second) component of the triple.
350 StringRef getVendorName() const;
352 /// getOSName - Get the operating system (third) component of the
354 StringRef getOSName() const;
356 /// getEnvironmentName - Get the optional environment (fourth)
357 /// component of the triple, or "" if empty.
358 StringRef getEnvironmentName() const;
360 /// getOSAndEnvironmentName - Get the operating system and optional
361 /// environment components as a single string (separated by a '-'
362 /// if the environment component is present).
363 StringRef getOSAndEnvironmentName() const;
366 /// @name Convenience Predicates
369 /// Test whether the architecture is 64-bit
371 /// Note that this tests for 64-bit pointer width, and nothing else. Note
372 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
373 /// 16-bit. The inner details of pointer width for particular architectures
374 /// is not summed up in the triple, and so only a coarse grained predicate
375 /// system is provided.
376 bool isArch64Bit() const;
378 /// Test whether the architecture is 32-bit
380 /// Note that this tests for 32-bit pointer width, and nothing else.
381 bool isArch32Bit() const;
383 /// Test whether the architecture is 16-bit
385 /// Note that this tests for 16-bit pointer width, and nothing else.
386 bool isArch16Bit() const;
388 /// isOSVersionLT - Helper function for doing comparisons against version
389 /// numbers included in the target triple.
390 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
391 unsigned Micro = 0) const {
393 getOSVersion(LHS[0], LHS[1], LHS[2]);
396 return LHS[0] < Major;
398 return LHS[1] < Minor;
400 return LHS[1] < Micro;
405 bool isOSVersionLT(const Triple &Other) const {
407 Other.getOSVersion(RHS[0], RHS[1], RHS[2]);
408 return isOSVersionLT(RHS[0], RHS[1], RHS[2]);
411 /// isMacOSXVersionLT - Comparison function for checking OS X version
412 /// compatibility, which handles supporting skewed version numbering schemes
413 /// used by the "darwin" triples.
414 bool isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
415 unsigned Micro = 0) const {
416 assert(isMacOSX() && "Not an OS X triple!");
418 // If this is OS X, expect a sane version number.
419 if (getOS() == Triple::MacOSX)
420 return isOSVersionLT(Major, Minor, Micro);
422 // Otherwise, compare to the "Darwin" number.
423 assert(Major == 10 && "Unexpected major version");
424 return isOSVersionLT(Minor + 4, Micro, 0);
427 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
428 /// "darwin" and "osx" as OS X triples.
429 bool isMacOSX() const {
430 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
433 /// Is this an iOS triple.
434 /// Note: This identifies tvOS as a variant of iOS. If that ever
435 /// changes, i.e., if the two operating systems diverge or their version
436 /// numbers get out of sync, that will need to be changed.
437 /// watchOS has completely different version numbers so it is not included.
439 return getOS() == Triple::IOS || isTvOS();
442 /// Is this an Apple tvOS triple.
443 bool isTvOS() const {
444 return getOS() == Triple::TvOS;
447 /// Is this an Apple watchOS triple.
448 bool isWatchOS() const {
449 return getOS() == Triple::WatchOS;
452 bool isWatchABI() const {
453 return getSubArch() == Triple::ARMSubArch_v7k;
456 /// isOSDarwin - Is this a "Darwin" OS (OS X, iOS, or watchOS).
457 bool isOSDarwin() const {
458 return isMacOSX() || isiOS() || isWatchOS();
461 bool isOSNetBSD() const {
462 return getOS() == Triple::NetBSD;
465 bool isOSOpenBSD() const {
466 return getOS() == Triple::OpenBSD;
469 bool isOSFreeBSD() const {
470 return getOS() == Triple::FreeBSD;
473 bool isOSFuchsia() const {
474 return getOS() == Triple::Fuchsia;
477 bool isOSDragonFly() const { return getOS() == Triple::DragonFly; }
479 bool isOSSolaris() const {
480 return getOS() == Triple::Solaris;
483 bool isOSBitrig() const {
484 return getOS() == Triple::Bitrig;
487 bool isOSIAMCU() const {
488 return getOS() == Triple::ELFIAMCU;
491 bool isGNUEnvironment() const {
492 EnvironmentType Env = getEnvironment();
493 return Env == Triple::GNU || Env == Triple::GNUABI64 ||
494 Env == Triple::GNUEABI || Env == Triple::GNUEABIHF ||
495 Env == Triple::GNUX32;
498 bool isOSContiki() const {
499 return getOS() == Triple::Contiki;
502 /// Checks if the environment could be MSVC.
503 bool isWindowsMSVCEnvironment() const {
504 return getOS() == Triple::Win32 &&
505 (getEnvironment() == Triple::UnknownEnvironment ||
506 getEnvironment() == Triple::MSVC);
509 /// Checks if the environment is MSVC.
510 bool isKnownWindowsMSVCEnvironment() const {
511 return getOS() == Triple::Win32 && getEnvironment() == Triple::MSVC;
514 bool isWindowsCoreCLREnvironment() const {
515 return getOS() == Triple::Win32 && getEnvironment() == Triple::CoreCLR;
518 bool isWindowsItaniumEnvironment() const {
519 return getOS() == Triple::Win32 && getEnvironment() == Triple::Itanium;
522 bool isWindowsCygwinEnvironment() const {
523 return getOS() == Triple::Win32 && getEnvironment() == Triple::Cygnus;
526 bool isWindowsGNUEnvironment() const {
527 return getOS() == Triple::Win32 && getEnvironment() == Triple::GNU;
530 /// Tests for either Cygwin or MinGW OS
531 bool isOSCygMing() const {
532 return isWindowsCygwinEnvironment() || isWindowsGNUEnvironment();
535 /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
536 bool isOSMSVCRT() const {
537 return isWindowsMSVCEnvironment() || isWindowsGNUEnvironment() ||
538 isWindowsItaniumEnvironment();
541 /// Tests whether the OS is Windows.
542 bool isOSWindows() const {
543 return getOS() == Triple::Win32;
546 /// Tests whether the OS is NaCl (Native Client)
547 bool isOSNaCl() const {
548 return getOS() == Triple::NaCl;
551 /// Tests whether the OS is Linux.
552 bool isOSLinux() const {
553 return getOS() == Triple::Linux;
556 /// Tests whether the OS is kFreeBSD.
557 bool isOSKFreeBSD() const {
558 return getOS() == Triple::KFreeBSD;
561 /// Tests whether the OS uses glibc.
562 bool isOSGlibc() const {
563 return (getOS() == Triple::Linux || getOS() == Triple::KFreeBSD) &&
567 /// Tests whether the OS uses the ELF binary format.
568 bool isOSBinFormatELF() const {
569 return getObjectFormat() == Triple::ELF;
572 /// Tests whether the OS uses the COFF binary format.
573 bool isOSBinFormatCOFF() const {
574 return getObjectFormat() == Triple::COFF;
577 /// Tests whether the environment is MachO.
578 bool isOSBinFormatMachO() const {
579 return getObjectFormat() == Triple::MachO;
582 /// Tests whether the OS uses the Wasm binary format.
583 bool isOSBinFormatWasm() const {
584 return getObjectFormat() == Triple::Wasm;
587 /// Tests whether the target is the PS4 CPU
588 bool isPS4CPU() const {
589 return getArch() == Triple::x86_64 &&
590 getVendor() == Triple::SCEI &&
591 getOS() == Triple::PS4;
594 /// Tests whether the target is the PS4 platform
596 return getVendor() == Triple::SCEI &&
597 getOS() == Triple::PS4;
600 /// Tests whether the target is Android
601 bool isAndroid() const { return getEnvironment() == Triple::Android; }
603 bool isAndroidVersionLT(unsigned Major) const {
604 assert(isAndroid() && "Not an Android triple!");
607 getEnvironmentVersion(Env[0], Env[1], Env[2]);
609 // 64-bit targets did not exist before API level 21 (Lollipop).
610 if (isArch64Bit() && Env[0] < 21)
613 return Env[0] < Major;
616 /// Tests whether the environment is musl-libc
617 bool isMusl() const {
618 return getEnvironment() == Triple::Musl ||
619 getEnvironment() == Triple::MuslEABI ||
620 getEnvironment() == Triple::MuslEABIHF;
623 /// Tests whether the target is NVPTX (32- or 64-bit).
624 bool isNVPTX() const {
625 return getArch() == Triple::nvptx || getArch() == Triple::nvptx64;
628 /// Tests wether the target supports comdat
629 bool supportsCOMDAT() const { return !isOSBinFormatMachO(); }
635 /// setArch - Set the architecture (first) component of the triple
637 void setArch(ArchType Kind);
639 /// setVendor - Set the vendor (second) component of the triple to a
641 void setVendor(VendorType Kind);
643 /// setOS - Set the operating system (third) component of the triple
645 void setOS(OSType Kind);
647 /// setEnvironment - Set the environment (fourth) component of the triple
649 void setEnvironment(EnvironmentType Kind);
651 /// setObjectFormat - Set the object file format
652 void setObjectFormat(ObjectFormatType Kind);
654 /// setTriple - Set all components to the new triple \p Str.
655 void setTriple(const Twine &Str);
657 /// setArchName - Set the architecture (first) component of the
659 void setArchName(StringRef Str);
661 /// setVendorName - Set the vendor (second) component of the triple
663 void setVendorName(StringRef Str);
665 /// setOSName - Set the operating system (third) component of the
667 void setOSName(StringRef Str);
669 /// setEnvironmentName - Set the optional environment (fourth)
670 /// component of the triple by name.
671 void setEnvironmentName(StringRef Str);
673 /// setOSAndEnvironmentName - Set the operating system and optional
674 /// environment components with a single string.
675 void setOSAndEnvironmentName(StringRef Str);
678 /// @name Helpers to build variants of a particular triple.
681 /// Form a triple with a 32-bit variant of the current architecture.
683 /// This can be used to move across "families" of architectures where useful.
685 /// \returns A new triple with a 32-bit architecture or an unknown
686 /// architecture if no such variant can be found.
687 llvm::Triple get32BitArchVariant() const;
689 /// Form a triple with a 64-bit variant of the current architecture.
691 /// This can be used to move across "families" of architectures where useful.
693 /// \returns A new triple with a 64-bit architecture or an unknown
694 /// architecture if no such variant can be found.
695 llvm::Triple get64BitArchVariant() const;
697 /// Form a triple with a big endian variant of the current architecture.
699 /// This can be used to move across "families" of architectures where useful.
701 /// \returns A new triple with a big endian architecture or an unknown
702 /// architecture if no such variant can be found.
703 llvm::Triple getBigEndianArchVariant() const;
705 /// Form a triple with a little endian variant of the current architecture.
707 /// This can be used to move across "families" of architectures where useful.
709 /// \returns A new triple with a little endian architecture or an unknown
710 /// architecture if no such variant can be found.
711 llvm::Triple getLittleEndianArchVariant() const;
713 /// Get the (LLVM) name of the minimum ARM CPU for the arch we are targeting.
715 /// \param Arch the architecture name (e.g., "armv7s"). If it is an empty
716 /// string then the triple's arch name is used.
717 StringRef getARMCPUForArch(StringRef Arch = StringRef()) const;
719 /// Tests whether the target triple is little endian.
721 /// \returns true if the triple is little endian, false otherwise.
722 bool isLittleEndian() const;
725 /// @name Static helpers for IDs.
728 /// getArchTypeName - Get the canonical name for the \p Kind architecture.
729 static StringRef getArchTypeName(ArchType Kind);
731 /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
732 /// architecture. This is the prefix used by the architecture specific
733 /// builtins, and is suitable for passing to \see
734 /// Intrinsic::getIntrinsicForGCCBuiltin().
736 /// \return - The architecture prefix, or 0 if none is defined.
737 static StringRef getArchTypePrefix(ArchType Kind);
739 /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
740 static StringRef getVendorTypeName(VendorType Kind);
742 /// getOSTypeName - Get the canonical name for the \p Kind operating system.
743 static StringRef getOSTypeName(OSType Kind);
745 /// getEnvironmentTypeName - Get the canonical name for the \p Kind
747 static StringRef getEnvironmentTypeName(EnvironmentType Kind);
750 /// @name Static helpers for converting alternate architecture names.
753 /// getArchTypeForLLVMName - The canonical type for the given LLVM
754 /// architecture name (e.g., "x86").
755 static ArchType getArchTypeForLLVMName(StringRef Str);
760 } // End llvm namespace