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,
135 ImaginationTechnologies,
142 LastVendorType = Mesa
164 NaCl, // Native Client
165 CNK, // BG/P Compute-Node Kernel
169 NVCL, // NVIDIA OpenCL
170 AMDHSA, // AMD HSA Runtime
174 WatchOS, // Apple watchOS
179 enum EnvironmentType {
201 LastEnvironmentType = OpenCL
203 enum ObjectFormatType {
214 /// The parsed arch type.
217 /// The parsed subarchitecture type.
220 /// The parsed vendor type.
223 /// The parsed OS type.
226 /// The parsed Environment type.
227 EnvironmentType Environment;
229 /// The object format type.
230 ObjectFormatType ObjectFormat;
233 /// @name Constructors
236 /// Default constructor is the same as an empty string and leaves all
237 /// triple fields unknown.
238 Triple() : Data(), Arch(), Vendor(), OS(), Environment(), ObjectFormat() {}
240 explicit Triple(const Twine &Str);
241 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
242 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
243 const Twine &EnvironmentStr);
245 bool operator==(const Triple &Other) const {
246 return Arch == Other.Arch && SubArch == Other.SubArch &&
247 Vendor == Other.Vendor && OS == Other.OS &&
248 Environment == Other.Environment &&
249 ObjectFormat == Other.ObjectFormat;
253 /// @name Normalization
256 /// normalize - Turn an arbitrary machine specification into the canonical
257 /// triple form (or something sensible that the Triple class understands if
258 /// nothing better can reasonably be done). In particular, it handles the
259 /// common case in which otherwise valid components are in the wrong order.
260 static std::string normalize(StringRef Str);
262 /// Return the normalized form of this triple's string.
263 std::string normalize() const { return normalize(Data); }
266 /// @name Typed Component Access
269 /// getArch - Get the parsed architecture type of this triple.
270 ArchType getArch() const { return Arch; }
272 /// getSubArch - get the parsed subarchitecture type for this triple.
273 SubArchType getSubArch() const { return SubArch; }
275 /// getVendor - Get the parsed vendor type of this triple.
276 VendorType getVendor() const { return Vendor; }
278 /// getOS - Get the parsed operating system type of this triple.
279 OSType getOS() const { return OS; }
281 /// hasEnvironment - Does this triple have the optional environment
282 /// (fourth) component?
283 bool hasEnvironment() const {
284 return getEnvironmentName() != "";
287 /// getEnvironment - Get the parsed environment type of this triple.
288 EnvironmentType getEnvironment() const { return Environment; }
290 /// Parse the version number from the OS name component of the
291 /// triple, if present.
293 /// For example, "fooos1.2.3" would return (1, 2, 3).
295 /// If an entry is not defined, it will be returned as 0.
296 void getEnvironmentVersion(unsigned &Major, unsigned &Minor,
297 unsigned &Micro) const;
299 /// getFormat - Get the object format for this triple.
300 ObjectFormatType getObjectFormat() const { return ObjectFormat; }
302 /// getOSVersion - Parse the version number from the OS name component of the
303 /// triple, if present.
305 /// For example, "fooos1.2.3" would return (1, 2, 3).
307 /// If an entry is not defined, it will be returned as 0.
308 void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
310 /// getOSMajorVersion - Return just the major version number, this is
311 /// specialized because it is a common query.
312 unsigned getOSMajorVersion() const {
313 unsigned Maj, Min, Micro;
314 getOSVersion(Maj, Min, Micro);
318 /// getMacOSXVersion - Parse the version number as with getOSVersion and then
319 /// translate generic "darwin" versions to the corresponding OS X versions.
320 /// This may also be called with IOS triples but the OS X version number is
321 /// just set to a constant 10.4.0 in that case. Returns true if successful.
322 bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
323 unsigned &Micro) const;
325 /// getiOSVersion - Parse the version number as with getOSVersion. This should
326 /// only be called with IOS or generic triples.
327 void getiOSVersion(unsigned &Major, unsigned &Minor,
328 unsigned &Micro) const;
330 /// getWatchOSVersion - Parse the version number as with getOSVersion. This
331 /// should only be called with WatchOS or generic triples.
332 void getWatchOSVersion(unsigned &Major, unsigned &Minor,
333 unsigned &Micro) const;
336 /// @name Direct Component Access
339 const std::string &str() const { return Data; }
341 const std::string &getTriple() const { return Data; }
343 /// getArchName - Get the architecture (first) component of the
345 StringRef getArchName() const;
347 /// getVendorName - Get the vendor (second) component of the triple.
348 StringRef getVendorName() const;
350 /// getOSName - Get the operating system (third) component of the
352 StringRef getOSName() const;
354 /// getEnvironmentName - Get the optional environment (fourth)
355 /// component of the triple, or "" if empty.
356 StringRef getEnvironmentName() const;
358 /// getOSAndEnvironmentName - Get the operating system and optional
359 /// environment components as a single string (separated by a '-'
360 /// if the environment component is present).
361 StringRef getOSAndEnvironmentName() const;
364 /// @name Convenience Predicates
367 /// Test whether the architecture is 64-bit
369 /// Note that this tests for 64-bit pointer width, and nothing else. Note
370 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
371 /// 16-bit. The inner details of pointer width for particular architectures
372 /// is not summed up in the triple, and so only a coarse grained predicate
373 /// system is provided.
374 bool isArch64Bit() const;
376 /// Test whether the architecture is 32-bit
378 /// Note that this tests for 32-bit pointer width, and nothing else.
379 bool isArch32Bit() const;
381 /// Test whether the architecture is 16-bit
383 /// Note that this tests for 16-bit pointer width, and nothing else.
384 bool isArch16Bit() const;
386 /// isOSVersionLT - Helper function for doing comparisons against version
387 /// numbers included in the target triple.
388 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
389 unsigned Micro = 0) const {
391 getOSVersion(LHS[0], LHS[1], LHS[2]);
394 return LHS[0] < Major;
396 return LHS[1] < Minor;
398 return LHS[1] < Micro;
403 bool isOSVersionLT(const Triple &Other) const {
405 Other.getOSVersion(RHS[0], RHS[1], RHS[2]);
406 return isOSVersionLT(RHS[0], RHS[1], RHS[2]);
409 /// isMacOSXVersionLT - Comparison function for checking OS X version
410 /// compatibility, which handles supporting skewed version numbering schemes
411 /// used by the "darwin" triples.
412 bool isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
413 unsigned Micro = 0) const {
414 assert(isMacOSX() && "Not an OS X triple!");
416 // If this is OS X, expect a sane version number.
417 if (getOS() == Triple::MacOSX)
418 return isOSVersionLT(Major, Minor, Micro);
420 // Otherwise, compare to the "Darwin" number.
421 assert(Major == 10 && "Unexpected major version");
422 return isOSVersionLT(Minor + 4, Micro, 0);
425 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
426 /// "darwin" and "osx" as OS X triples.
427 bool isMacOSX() const {
428 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
431 /// Is this an iOS triple.
432 /// Note: This identifies tvOS as a variant of iOS. If that ever
433 /// changes, i.e., if the two operating systems diverge or their version
434 /// numbers get out of sync, that will need to be changed.
435 /// watchOS has completely different version numbers so it is not included.
437 return getOS() == Triple::IOS || isTvOS();
440 /// Is this an Apple tvOS triple.
441 bool isTvOS() const {
442 return getOS() == Triple::TvOS;
445 /// Is this an Apple watchOS triple.
446 bool isWatchOS() const {
447 return getOS() == Triple::WatchOS;
450 bool isWatchABI() const {
451 return getSubArch() == Triple::ARMSubArch_v7k;
454 /// isOSDarwin - Is this a "Darwin" OS (OS X, iOS, or watchOS).
455 bool isOSDarwin() const {
456 return isMacOSX() || isiOS() || isWatchOS();
459 bool isOSNetBSD() const {
460 return getOS() == Triple::NetBSD;
463 bool isOSOpenBSD() const {
464 return getOS() == Triple::OpenBSD;
467 bool isOSFreeBSD() const {
468 return getOS() == Triple::FreeBSD;
471 bool isOSFuchsia() const {
472 return getOS() == Triple::Fuchsia;
475 bool isOSDragonFly() const { return getOS() == Triple::DragonFly; }
477 bool isOSSolaris() const {
478 return getOS() == Triple::Solaris;
481 bool isOSBitrig() const {
482 return getOS() == Triple::Bitrig;
485 bool isOSIAMCU() const {
486 return getOS() == Triple::ELFIAMCU;
489 bool isGNUEnvironment() const {
490 EnvironmentType Env = getEnvironment();
491 return Env == Triple::GNU || Env == Triple::GNUABI64 ||
492 Env == Triple::GNUEABI || Env == Triple::GNUEABIHF ||
493 Env == Triple::GNUX32;
496 bool isOSContiki() const {
497 return getOS() == Triple::Contiki;
500 /// Checks if the environment could be MSVC.
501 bool isWindowsMSVCEnvironment() const {
502 return getOS() == Triple::Win32 &&
503 (getEnvironment() == Triple::UnknownEnvironment ||
504 getEnvironment() == Triple::MSVC);
507 /// Checks if the environment is MSVC.
508 bool isKnownWindowsMSVCEnvironment() const {
509 return getOS() == Triple::Win32 && getEnvironment() == Triple::MSVC;
512 bool isWindowsCoreCLREnvironment() const {
513 return getOS() == Triple::Win32 && getEnvironment() == Triple::CoreCLR;
516 bool isWindowsItaniumEnvironment() const {
517 return getOS() == Triple::Win32 && getEnvironment() == Triple::Itanium;
520 bool isWindowsCygwinEnvironment() const {
521 return getOS() == Triple::Win32 && getEnvironment() == Triple::Cygnus;
524 bool isWindowsGNUEnvironment() const {
525 return getOS() == Triple::Win32 && getEnvironment() == Triple::GNU;
528 /// Tests for either Cygwin or MinGW OS
529 bool isOSCygMing() const {
530 return isWindowsCygwinEnvironment() || isWindowsGNUEnvironment();
533 /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
534 bool isOSMSVCRT() const {
535 return isWindowsMSVCEnvironment() || isWindowsGNUEnvironment() ||
536 isWindowsItaniumEnvironment();
539 /// Tests whether the OS is Windows.
540 bool isOSWindows() const {
541 return getOS() == Triple::Win32;
544 /// Tests whether the OS is NaCl (Native Client)
545 bool isOSNaCl() const {
546 return getOS() == Triple::NaCl;
549 /// Tests whether the OS is Linux.
550 bool isOSLinux() const {
551 return getOS() == Triple::Linux;
554 /// Tests whether the OS is kFreeBSD.
555 bool isOSKFreeBSD() const {
556 return getOS() == Triple::KFreeBSD;
559 /// Tests whether the OS uses glibc.
560 bool isOSGlibc() const {
561 return getOS() == Triple::Linux || getOS() == Triple::KFreeBSD;
564 /// Tests whether the OS uses the ELF binary format.
565 bool isOSBinFormatELF() const {
566 return getObjectFormat() == Triple::ELF;
569 /// Tests whether the OS uses the COFF binary format.
570 bool isOSBinFormatCOFF() const {
571 return getObjectFormat() == Triple::COFF;
574 /// Tests whether the environment is MachO.
575 bool isOSBinFormatMachO() const {
576 return getObjectFormat() == Triple::MachO;
579 /// Tests whether the target is the PS4 CPU
580 bool isPS4CPU() const {
581 return getArch() == Triple::x86_64 &&
582 getVendor() == Triple::SCEI &&
583 getOS() == Triple::PS4;
586 /// Tests whether the target is the PS4 platform
588 return getVendor() == Triple::SCEI &&
589 getOS() == Triple::PS4;
592 /// Tests whether the target is Android
593 bool isAndroid() const { return getEnvironment() == Triple::Android; }
595 /// Tests whether the environment is musl-libc
596 bool isMusl() const {
597 return getEnvironment() == Triple::Musl ||
598 getEnvironment() == Triple::MuslEABI ||
599 getEnvironment() == Triple::MuslEABIHF;
602 /// Tests whether the target is NVPTX (32- or 64-bit).
603 bool isNVPTX() const {
604 return getArch() == Triple::nvptx || getArch() == Triple::nvptx64;
607 /// Tests wether the target supports comdat
608 bool supportsCOMDAT() const { return !isOSBinFormatMachO(); }
614 /// setArch - Set the architecture (first) component of the triple
616 void setArch(ArchType Kind);
618 /// setVendor - Set the vendor (second) component of the triple to a
620 void setVendor(VendorType Kind);
622 /// setOS - Set the operating system (third) component of the triple
624 void setOS(OSType Kind);
626 /// setEnvironment - Set the environment (fourth) component of the triple
628 void setEnvironment(EnvironmentType Kind);
630 /// setObjectFormat - Set the object file format
631 void setObjectFormat(ObjectFormatType Kind);
633 /// setTriple - Set all components to the new triple \p Str.
634 void setTriple(const Twine &Str);
636 /// setArchName - Set the architecture (first) component of the
638 void setArchName(StringRef Str);
640 /// setVendorName - Set the vendor (second) component of the triple
642 void setVendorName(StringRef Str);
644 /// setOSName - Set the operating system (third) component of the
646 void setOSName(StringRef Str);
648 /// setEnvironmentName - Set the optional environment (fourth)
649 /// component of the triple by name.
650 void setEnvironmentName(StringRef Str);
652 /// setOSAndEnvironmentName - Set the operating system and optional
653 /// environment components with a single string.
654 void setOSAndEnvironmentName(StringRef Str);
657 /// @name Helpers to build variants of a particular triple.
660 /// Form a triple with a 32-bit variant of the current architecture.
662 /// This can be used to move across "families" of architectures where useful.
664 /// \returns A new triple with a 32-bit architecture or an unknown
665 /// architecture if no such variant can be found.
666 llvm::Triple get32BitArchVariant() const;
668 /// Form a triple with a 64-bit variant of the current architecture.
670 /// This can be used to move across "families" of architectures where useful.
672 /// \returns A new triple with a 64-bit architecture or an unknown
673 /// architecture if no such variant can be found.
674 llvm::Triple get64BitArchVariant() const;
676 /// Form a triple with a big endian variant of the current architecture.
678 /// This can be used to move across "families" of architectures where useful.
680 /// \returns A new triple with a big endian architecture or an unknown
681 /// architecture if no such variant can be found.
682 llvm::Triple getBigEndianArchVariant() const;
684 /// Form a triple with a little endian variant of the current architecture.
686 /// This can be used to move across "families" of architectures where useful.
688 /// \returns A new triple with a little endian architecture or an unknown
689 /// architecture if no such variant can be found.
690 llvm::Triple getLittleEndianArchVariant() const;
692 /// Get the (LLVM) name of the minimum ARM CPU for the arch we are targeting.
694 /// \param Arch the architecture name (e.g., "armv7s"). If it is an empty
695 /// string then the triple's arch name is used.
696 StringRef getARMCPUForArch(StringRef Arch = StringRef()) const;
698 /// Tests whether the target triple is little endian.
700 /// \returns true if the triple is little endian, false otherwise.
701 bool isLittleEndian() const;
704 /// @name Static helpers for IDs.
707 /// getArchTypeName - Get the canonical name for the \p Kind architecture.
708 static StringRef getArchTypeName(ArchType Kind);
710 /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
711 /// architecture. This is the prefix used by the architecture specific
712 /// builtins, and is suitable for passing to \see
713 /// Intrinsic::getIntrinsicForGCCBuiltin().
715 /// \return - The architecture prefix, or 0 if none is defined.
716 static StringRef getArchTypePrefix(ArchType Kind);
718 /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
719 static StringRef getVendorTypeName(VendorType Kind);
721 /// getOSTypeName - Get the canonical name for the \p Kind operating system.
722 static StringRef getOSTypeName(OSType Kind);
724 /// getEnvironmentTypeName - Get the canonical name for the \p Kind
726 static StringRef getEnvironmentTypeName(EnvironmentType Kind);
729 /// @name Static helpers for converting alternate architecture names.
732 /// getArchTypeForLLVMName - The canonical type for the given LLVM
733 /// architecture name (e.g., "x86").
734 static ArchType getArchTypeForLLVMName(StringRef Str);
739 } // End llvm namespace