1 //===-- llvm/ADT/Triple.h - Target triple helper class ----------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_ADT_TRIPLE_H
10 #define LLVM_ADT_TRIPLE_H
12 #include "llvm/ADT/Twine.h"
14 // Some system headers or GCC predefined macros conflict with identifiers in
15 // this file. Undefine them here.
22 /// Triple - Helper class for working with autoconf configuration names. For
23 /// historical reasons, we also call these 'triples' (they used to contain
24 /// exactly three fields).
26 /// Configuration names are strings in the canonical form:
27 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
29 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
31 /// This class is used for clients which want to support arbitrary
32 /// configuration names, but also want to implement certain special
33 /// behavior for particular configurations. This class isolates the mapping
34 /// from the components of the configuration name to well known IDs.
36 /// At its core the Triple class is designed to be a wrapper for a triple
37 /// string; the constructor does not change or normalize the triple string.
38 /// Clients that need to handle the non-canonical triples that users often
39 /// specify should use the normalize method.
41 /// See autoconf/config.guess for a glimpse into what configuration names
42 /// look like in practice.
48 arm
, // ARM (little endian): arm, armv.*, xscale
49 armeb
, // ARM (big endian): armeb
50 aarch64
, // AArch64 (little endian): aarch64
51 aarch64_be
, // AArch64 (big endian): aarch64_be
52 arc
, // ARC: Synopsys ARC
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, mipsr6
58 mipsel
, // MIPSEL: mipsel, mipsallegrexe, mipsr6el
59 mips64
, // MIPS64: mips64, mips64r6, mipsn32, mipsn32r6
60 mips64el
, // MIPS64EL: mips64el, mips64r6el, mipsn32el, mipsn32r6el
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
109 ARMSubArch_v8m_baseline
,
110 ARMSubArch_v8m_mainline
,
141 ImaginationTechnologies
,
150 LastVendorType
= OpenEmbedded
173 NaCl
, // Native Client
174 CNK
, // BG/P Compute-Node Kernel
177 NVCL
, // NVIDIA OpenCL
178 AMDHSA
, // AMD HSA Runtime
182 WatchOS
, // Apple watchOS
185 AMDPAL
, // AMD PAL Runtime
186 HermitCore
, // HermitCore Unikernel/Multikernel
188 WASI
, // Experimental WebAssembly OS
191 enum EnvironmentType
{
212 Simulator
, // Simulator variants of other systems, e.g., Apple's iOS
213 LastEnvironmentType
= Simulator
215 enum ObjectFormatType
{
227 /// The parsed arch type.
230 /// The parsed subarchitecture type.
233 /// The parsed vendor type.
236 /// The parsed OS type.
239 /// The parsed Environment type.
240 EnvironmentType Environment
;
242 /// The object format type.
243 ObjectFormatType ObjectFormat
;
246 /// @name Constructors
249 /// Default constructor is the same as an empty string and leaves all
250 /// triple fields unknown.
252 : Data(), Arch(), SubArch(), Vendor(), OS(), Environment(),
255 explicit Triple(const Twine
&Str
);
256 Triple(const Twine
&ArchStr
, const Twine
&VendorStr
, const Twine
&OSStr
);
257 Triple(const Twine
&ArchStr
, const Twine
&VendorStr
, const Twine
&OSStr
,
258 const Twine
&EnvironmentStr
);
260 bool operator==(const Triple
&Other
) const {
261 return Arch
== Other
.Arch
&& SubArch
== Other
.SubArch
&&
262 Vendor
== Other
.Vendor
&& OS
== Other
.OS
&&
263 Environment
== Other
.Environment
&&
264 ObjectFormat
== Other
.ObjectFormat
;
267 bool operator!=(const Triple
&Other
) const {
268 return !(*this == Other
);
272 /// @name Normalization
275 /// normalize - Turn an arbitrary machine specification into the canonical
276 /// triple form (or something sensible that the Triple class understands if
277 /// nothing better can reasonably be done). In particular, it handles the
278 /// common case in which otherwise valid components are in the wrong order.
279 static std::string
normalize(StringRef Str
);
281 /// Return the normalized form of this triple's string.
282 std::string
normalize() const { return normalize(Data
); }
285 /// @name Typed Component Access
288 /// getArch - Get the parsed architecture type of this triple.
289 ArchType
getArch() const { return Arch
; }
291 /// getSubArch - get the parsed subarchitecture type for this triple.
292 SubArchType
getSubArch() const { return SubArch
; }
294 /// getVendor - Get the parsed vendor type of this triple.
295 VendorType
getVendor() const { return Vendor
; }
297 /// getOS - Get the parsed operating system type of this triple.
298 OSType
getOS() const { return OS
; }
300 /// hasEnvironment - Does this triple have the optional environment
301 /// (fourth) component?
302 bool hasEnvironment() const {
303 return getEnvironmentName() != "";
306 /// getEnvironment - Get the parsed environment type of this triple.
307 EnvironmentType
getEnvironment() const { return Environment
; }
309 /// Parse the version number from the OS name component of the
310 /// triple, if present.
312 /// For example, "fooos1.2.3" would return (1, 2, 3).
314 /// If an entry is not defined, it will be returned as 0.
315 void getEnvironmentVersion(unsigned &Major
, unsigned &Minor
,
316 unsigned &Micro
) const;
318 /// getFormat - Get the object format for this triple.
319 ObjectFormatType
getObjectFormat() const { return ObjectFormat
; }
321 /// getOSVersion - Parse the version number from the OS name component of the
322 /// triple, if present.
324 /// For example, "fooos1.2.3" would return (1, 2, 3).
326 /// If an entry is not defined, it will be returned as 0.
327 void getOSVersion(unsigned &Major
, unsigned &Minor
, unsigned &Micro
) const;
329 /// getOSMajorVersion - Return just the major version number, this is
330 /// specialized because it is a common query.
331 unsigned getOSMajorVersion() const {
332 unsigned Maj
, Min
, Micro
;
333 getOSVersion(Maj
, Min
, Micro
);
337 /// getMacOSXVersion - Parse the version number as with getOSVersion and then
338 /// translate generic "darwin" versions to the corresponding OS X versions.
339 /// This may also be called with IOS triples but the OS X version number is
340 /// just set to a constant 10.4.0 in that case. Returns true if successful.
341 bool getMacOSXVersion(unsigned &Major
, unsigned &Minor
,
342 unsigned &Micro
) const;
344 /// getiOSVersion - Parse the version number as with getOSVersion. This should
345 /// only be called with IOS or generic triples.
346 void getiOSVersion(unsigned &Major
, unsigned &Minor
,
347 unsigned &Micro
) const;
349 /// getWatchOSVersion - Parse the version number as with getOSVersion. This
350 /// should only be called with WatchOS or generic triples.
351 void getWatchOSVersion(unsigned &Major
, unsigned &Minor
,
352 unsigned &Micro
) const;
355 /// @name Direct Component Access
358 const std::string
&str() const { return Data
; }
360 const std::string
&getTriple() const { return Data
; }
362 /// getArchName - Get the architecture (first) component of the
364 StringRef
getArchName() const;
366 /// getVendorName - Get the vendor (second) component of the triple.
367 StringRef
getVendorName() const;
369 /// getOSName - Get the operating system (third) component of the
371 StringRef
getOSName() const;
373 /// getEnvironmentName - Get the optional environment (fourth)
374 /// component of the triple, or "" if empty.
375 StringRef
getEnvironmentName() const;
377 /// getOSAndEnvironmentName - Get the operating system and optional
378 /// environment components as a single string (separated by a '-'
379 /// if the environment component is present).
380 StringRef
getOSAndEnvironmentName() const;
383 /// @name Convenience Predicates
386 /// Test whether the architecture is 64-bit
388 /// Note that this tests for 64-bit pointer width, and nothing else. Note
389 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
390 /// 16-bit. The inner details of pointer width for particular architectures
391 /// is not summed up in the triple, and so only a coarse grained predicate
392 /// system is provided.
393 bool isArch64Bit() const;
395 /// Test whether the architecture is 32-bit
397 /// Note that this tests for 32-bit pointer width, and nothing else.
398 bool isArch32Bit() const;
400 /// Test whether the architecture is 16-bit
402 /// Note that this tests for 16-bit pointer width, and nothing else.
403 bool isArch16Bit() const;
405 /// isOSVersionLT - Helper function for doing comparisons against version
406 /// numbers included in the target triple.
407 bool isOSVersionLT(unsigned Major
, unsigned Minor
= 0,
408 unsigned Micro
= 0) const {
410 getOSVersion(LHS
[0], LHS
[1], LHS
[2]);
413 return LHS
[0] < Major
;
415 return LHS
[1] < Minor
;
417 return LHS
[2] < Micro
;
422 bool isOSVersionLT(const Triple
&Other
) const {
424 Other
.getOSVersion(RHS
[0], RHS
[1], RHS
[2]);
425 return isOSVersionLT(RHS
[0], RHS
[1], RHS
[2]);
428 /// isMacOSXVersionLT - Comparison function for checking OS X version
429 /// compatibility, which handles supporting skewed version numbering schemes
430 /// used by the "darwin" triples.
431 bool isMacOSXVersionLT(unsigned Major
, unsigned Minor
= 0,
432 unsigned Micro
= 0) const {
433 assert(isMacOSX() && "Not an OS X triple!");
435 // If this is OS X, expect a sane version number.
436 if (getOS() == Triple::MacOSX
)
437 return isOSVersionLT(Major
, Minor
, Micro
);
439 // Otherwise, compare to the "Darwin" number.
440 assert(Major
== 10 && "Unexpected major version");
441 return isOSVersionLT(Minor
+ 4, Micro
, 0);
444 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
445 /// "darwin" and "osx" as OS X triples.
446 bool isMacOSX() const {
447 return getOS() == Triple::Darwin
|| getOS() == Triple::MacOSX
;
450 /// Is this an iOS triple.
451 /// Note: This identifies tvOS as a variant of iOS. If that ever
452 /// changes, i.e., if the two operating systems diverge or their version
453 /// numbers get out of sync, that will need to be changed.
454 /// watchOS has completely different version numbers so it is not included.
456 return getOS() == Triple::IOS
|| isTvOS();
459 /// Is this an Apple tvOS triple.
460 bool isTvOS() const {
461 return getOS() == Triple::TvOS
;
464 /// Is this an Apple watchOS triple.
465 bool isWatchOS() const {
466 return getOS() == Triple::WatchOS
;
469 bool isWatchABI() const {
470 return getSubArch() == Triple::ARMSubArch_v7k
;
473 /// isOSDarwin - Is this a "Darwin" OS (OS X, iOS, or watchOS).
474 bool isOSDarwin() const {
475 return isMacOSX() || isiOS() || isWatchOS();
478 bool isSimulatorEnvironment() const {
479 return getEnvironment() == Triple::Simulator
;
482 bool isOSNetBSD() const {
483 return getOS() == Triple::NetBSD
;
486 bool isOSOpenBSD() const {
487 return getOS() == Triple::OpenBSD
;
490 bool isOSFreeBSD() const {
491 return getOS() == Triple::FreeBSD
;
494 bool isOSFuchsia() const {
495 return getOS() == Triple::Fuchsia
;
498 bool isOSDragonFly() const { return getOS() == Triple::DragonFly
; }
500 bool isOSSolaris() const {
501 return getOS() == Triple::Solaris
;
504 bool isOSIAMCU() const {
505 return getOS() == Triple::ELFIAMCU
;
508 bool isOSUnknown() const { return getOS() == Triple::UnknownOS
; }
510 bool isGNUEnvironment() const {
511 EnvironmentType Env
= getEnvironment();
512 return Env
== Triple::GNU
|| Env
== Triple::GNUABIN32
||
513 Env
== Triple::GNUABI64
|| Env
== Triple::GNUEABI
||
514 Env
== Triple::GNUEABIHF
|| Env
== Triple::GNUX32
;
517 bool isOSContiki() const {
518 return getOS() == Triple::Contiki
;
521 /// Tests whether the OS is Haiku.
522 bool isOSHaiku() const {
523 return getOS() == Triple::Haiku
;
526 /// Tests whether the OS is Windows.
527 bool isOSWindows() const {
528 return getOS() == Triple::Win32
;
531 /// Checks if the environment is MSVC.
532 bool isKnownWindowsMSVCEnvironment() const {
533 return isOSWindows() && getEnvironment() == Triple::MSVC
;
536 /// Checks if the environment could be MSVC.
537 bool isWindowsMSVCEnvironment() const {
538 return isKnownWindowsMSVCEnvironment() ||
539 (isOSWindows() && getEnvironment() == Triple::UnknownEnvironment
);
542 bool isWindowsCoreCLREnvironment() const {
543 return isOSWindows() && getEnvironment() == Triple::CoreCLR
;
546 bool isWindowsItaniumEnvironment() const {
547 return isOSWindows() && getEnvironment() == Triple::Itanium
;
550 bool isWindowsCygwinEnvironment() const {
551 return isOSWindows() && getEnvironment() == Triple::Cygnus
;
554 bool isWindowsGNUEnvironment() const {
555 return isOSWindows() && getEnvironment() == Triple::GNU
;
558 /// Tests for either Cygwin or MinGW OS
559 bool isOSCygMing() const {
560 return isWindowsCygwinEnvironment() || isWindowsGNUEnvironment();
563 /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
564 bool isOSMSVCRT() const {
565 return isWindowsMSVCEnvironment() || isWindowsGNUEnvironment() ||
566 isWindowsItaniumEnvironment();
569 /// Tests whether the OS is NaCl (Native Client)
570 bool isOSNaCl() const {
571 return getOS() == Triple::NaCl
;
574 /// Tests whether the OS is Linux.
575 bool isOSLinux() const {
576 return getOS() == Triple::Linux
;
579 /// Tests whether the OS is kFreeBSD.
580 bool isOSKFreeBSD() const {
581 return getOS() == Triple::KFreeBSD
;
584 /// Tests whether the OS is Hurd.
585 bool isOSHurd() const {
586 return getOS() == Triple::Hurd
;
589 /// Tests whether the OS is WASI.
590 bool isOSWASI() const {
591 return getOS() == Triple::WASI
;
594 /// Tests whether the OS uses glibc.
595 bool isOSGlibc() const {
596 return (getOS() == Triple::Linux
|| getOS() == Triple::KFreeBSD
||
597 getOS() == Triple::Hurd
) &&
601 /// Tests whether the OS uses the ELF binary format.
602 bool isOSBinFormatELF() const {
603 return getObjectFormat() == Triple::ELF
;
606 /// Tests whether the OS uses the COFF binary format.
607 bool isOSBinFormatCOFF() const {
608 return getObjectFormat() == Triple::COFF
;
611 /// Tests whether the environment is MachO.
612 bool isOSBinFormatMachO() const {
613 return getObjectFormat() == Triple::MachO
;
616 /// Tests whether the OS uses the Wasm binary format.
617 bool isOSBinFormatWasm() const {
618 return getObjectFormat() == Triple::Wasm
;
621 /// Tests whether the target is the PS4 CPU
622 bool isPS4CPU() const {
623 return getArch() == Triple::x86_64
&&
624 getVendor() == Triple::SCEI
&&
625 getOS() == Triple::PS4
;
628 /// Tests whether the target is the PS4 platform
630 return getVendor() == Triple::SCEI
&&
631 getOS() == Triple::PS4
;
634 /// Tests whether the target is Android
635 bool isAndroid() const { return getEnvironment() == Triple::Android
; }
637 bool isAndroidVersionLT(unsigned Major
) const {
638 assert(isAndroid() && "Not an Android triple!");
641 getEnvironmentVersion(Env
[0], Env
[1], Env
[2]);
643 // 64-bit targets did not exist before API level 21 (Lollipop).
644 if (isArch64Bit() && Env
[0] < 21)
647 return Env
[0] < Major
;
650 /// Tests whether the environment is musl-libc
651 bool isMusl() const {
652 return getEnvironment() == Triple::Musl
||
653 getEnvironment() == Triple::MuslEABI
||
654 getEnvironment() == Triple::MuslEABIHF
;
657 /// Tests whether the target is NVPTX (32- or 64-bit).
658 bool isNVPTX() const {
659 return getArch() == Triple::nvptx
|| getArch() == Triple::nvptx64
;
662 /// Tests whether the target is Thumb (little and big endian).
663 bool isThumb() const {
664 return getArch() == Triple::thumb
|| getArch() == Triple::thumbeb
;
667 /// Tests whether the target is ARM (little and big endian).
669 return getArch() == Triple::arm
|| getArch() == Triple::armeb
;
672 /// Tests whether the target is AArch64 (little and big endian).
673 bool isAArch64() const {
674 return getArch() == Triple::aarch64
|| getArch() == Triple::aarch64_be
;
677 /// Tests whether the target is MIPS 32-bit (little and big endian).
678 bool isMIPS32() const {
679 return getArch() == Triple::mips
|| getArch() == Triple::mipsel
;
682 /// Tests whether the target is MIPS 64-bit (little and big endian).
683 bool isMIPS64() const {
684 return getArch() == Triple::mips64
|| getArch() == Triple::mips64el
;
687 /// Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
688 bool isMIPS() const {
689 return isMIPS32() || isMIPS64();
692 /// Tests whether the target supports comdat
693 bool supportsCOMDAT() const {
694 return !isOSBinFormatMachO();
697 /// Tests whether the target uses emulated TLS as default.
698 bool hasDefaultEmulatedTLS() const {
699 return isAndroid() || isOSOpenBSD() || isWindowsCygwinEnvironment();
706 /// setArch - Set the architecture (first) component of the triple
708 void setArch(ArchType Kind
);
710 /// setVendor - Set the vendor (second) component of the triple to a
712 void setVendor(VendorType Kind
);
714 /// setOS - Set the operating system (third) component of the triple
716 void setOS(OSType Kind
);
718 /// setEnvironment - Set the environment (fourth) component of the triple
720 void setEnvironment(EnvironmentType Kind
);
722 /// setObjectFormat - Set the object file format
723 void setObjectFormat(ObjectFormatType Kind
);
725 /// setTriple - Set all components to the new triple \p Str.
726 void setTriple(const Twine
&Str
);
728 /// setArchName - Set the architecture (first) component of the
730 void setArchName(StringRef Str
);
732 /// setVendorName - Set the vendor (second) component of the triple
734 void setVendorName(StringRef Str
);
736 /// setOSName - Set the operating system (third) component of the
738 void setOSName(StringRef Str
);
740 /// setEnvironmentName - Set the optional environment (fourth)
741 /// component of the triple by name.
742 void setEnvironmentName(StringRef Str
);
744 /// setOSAndEnvironmentName - Set the operating system and optional
745 /// environment components with a single string.
746 void setOSAndEnvironmentName(StringRef Str
);
749 /// @name Helpers to build variants of a particular triple.
752 /// Form a triple with a 32-bit variant of the current architecture.
754 /// This can be used to move across "families" of architectures where useful.
756 /// \returns A new triple with a 32-bit architecture or an unknown
757 /// architecture if no such variant can be found.
758 llvm::Triple
get32BitArchVariant() const;
760 /// Form a triple with a 64-bit variant of the current architecture.
762 /// This can be used to move across "families" of architectures where useful.
764 /// \returns A new triple with a 64-bit architecture or an unknown
765 /// architecture if no such variant can be found.
766 llvm::Triple
get64BitArchVariant() const;
768 /// Form a triple with a big endian variant of the current architecture.
770 /// This can be used to move across "families" of architectures where useful.
772 /// \returns A new triple with a big endian architecture or an unknown
773 /// architecture if no such variant can be found.
774 llvm::Triple
getBigEndianArchVariant() const;
776 /// Form a triple with a little endian variant of the current architecture.
778 /// This can be used to move across "families" of architectures where useful.
780 /// \returns A new triple with a little endian architecture or an unknown
781 /// architecture if no such variant can be found.
782 llvm::Triple
getLittleEndianArchVariant() const;
784 /// Get the (LLVM) name of the minimum ARM CPU for the arch we are targeting.
786 /// \param Arch the architecture name (e.g., "armv7s"). If it is an empty
787 /// string then the triple's arch name is used.
788 StringRef
getARMCPUForArch(StringRef Arch
= StringRef()) const;
790 /// Tests whether the target triple is little endian.
792 /// \returns true if the triple is little endian, false otherwise.
793 bool isLittleEndian() const;
795 /// Test whether target triples are compatible.
796 bool isCompatibleWith(const Triple
&Other
) const;
798 /// Merge target triples.
799 std::string
merge(const Triple
&Other
) const;
802 /// @name Static helpers for IDs.
805 /// getArchTypeName - Get the canonical name for the \p Kind architecture.
806 static StringRef
getArchTypeName(ArchType Kind
);
808 /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
809 /// architecture. This is the prefix used by the architecture specific
810 /// builtins, and is suitable for passing to \see
811 /// Intrinsic::getIntrinsicForGCCBuiltin().
813 /// \return - The architecture prefix, or 0 if none is defined.
814 static StringRef
getArchTypePrefix(ArchType Kind
);
816 /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
817 static StringRef
getVendorTypeName(VendorType Kind
);
819 /// getOSTypeName - Get the canonical name for the \p Kind operating system.
820 static StringRef
getOSTypeName(OSType Kind
);
822 /// getEnvironmentTypeName - Get the canonical name for the \p Kind
824 static StringRef
getEnvironmentTypeName(EnvironmentType Kind
);
827 /// @name Static helpers for converting alternate architecture names.
830 /// getArchTypeForLLVMName - The canonical type for the given LLVM
831 /// architecture name (e.g., "x86").
832 static ArchType
getArchTypeForLLVMName(StringRef Str
);
837 } // End llvm namespace