LLVM 23.0.0git
Triple.h
Go to the documentation of this file.
1//===-- llvm/TargetParser/Triple.h - Target triple helper class--*- C++ -*-===//
2//
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
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_TARGETPARSER_TRIPLE_H
10#define LLVM_TARGETPARSER_TRIPLE_H
11
12#include "llvm/ADT/StringRef.h"
15
16// Some system headers or GCC predefined macros conflict with identifiers in
17// this file. Undefine them here.
18#undef NetBSD
19#undef mips
20#undef sparc
21
22namespace llvm {
23enum class ExceptionHandling;
24class Twine;
25
26/// Triple - Helper class for working with autoconf configuration names. For
27/// historical reasons, we also call these 'triples' (they used to contain
28/// exactly three fields).
29///
30/// Configuration names are strings in the canonical form:
31/// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
32/// or
33/// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
34///
35/// This class is used for clients which want to support arbitrary
36/// configuration names, but also want to implement certain special
37/// behavior for particular configurations. This class isolates the mapping
38/// from the components of the configuration name to well known IDs.
39///
40/// At its core the Triple class is designed to be a wrapper for a triple
41/// string; the constructor does not change or normalize the triple string.
42/// Clients that need to handle the non-canonical triples that users often
43/// specify should use the normalize method.
44///
45/// See autoconf/config.guess for a glimpse into what configuration names
46/// look like in practice.
47class Triple {
48public:
49 enum ArchType {
51
52 arm, // ARM (little endian): arm, armv.*, xscale
53 armeb, // ARM (big endian): armeb
54 aarch64, // AArch64 (little endian): aarch64
55 aarch64_be, // AArch64 (big endian): aarch64_be
56 aarch64_32, // AArch64 (little endian) ILP32: aarch64_32
57 arc, // ARC: Synopsys ARC
58 avr, // AVR: Atmel AVR microcontroller
59 bpfel, // eBPF or extended BPF or 64-bit BPF (little endian)
60 bpfeb, // eBPF or extended BPF or 64-bit BPF (big endian)
61 csky, // CSKY: csky
62 dxil, // DXIL 32-bit DirectX bytecode
63 hexagon, // Hexagon: hexagon
64 loongarch32, // LoongArch (32-bit): loongarch32
65 loongarch64, // LoongArch (64-bit): loongarch64
66 m68k, // M68k: Motorola 680x0 family
67 mips, // MIPS: mips, mipsallegrex, mipsr6
68 mipsel, // MIPSEL: mipsel, mipsallegrexe, mipsr6el
69 mips64, // MIPS64: mips64, mips64r6, mipsn32, mipsn32r6
70 mips64el, // MIPS64EL: mips64el, mips64r6el, mipsn32el, mipsn32r6el
71 msp430, // MSP430: msp430
72 ppc, // PPC: powerpc
73 ppcle, // PPCLE: powerpc (little endian)
74 ppc64, // PPC64: powerpc64, ppu
75 ppc64le, // PPC64LE: powerpc64le
76 r600, // R600: AMD GPUs HD2XXX - HD6XXX
77 amdgcn, // AMDGCN: AMD GCN GPUs
78 riscv32, // RISC-V (32-bit, little endian): riscv32
79 riscv64, // RISC-V (64-bit, little endian): riscv64
80 riscv32be, // RISC-V (32-bit, big endian): riscv32be
81 riscv64be, // RISC-V (64-bit, big endian): riscv64be
82 sparc, // Sparc: sparc
83 sparcv9, // Sparcv9: Sparcv9
84 sparcel, // Sparc: (endianness = little). NB: 'Sparcle' is a CPU variant
85 systemz, // SystemZ: s390x
86 tce, // TCE (http://tce.cs.tut.fi/): tce
87 tcele, // TCE little endian (http://tce.cs.tut.fi/): tcele
88 thumb, // Thumb (little endian): thumb, thumbv.*
89 thumbeb, // Thumb (big endian): thumbeb
90 x86, // X86: i[3-9]86
91 x86_64, // X86-64: amd64, x86_64
92 xcore, // XCore: xcore
93 xtensa, // Tensilica: Xtensa
94 nvptx, // NVPTX: 32-bit
95 nvptx64, // NVPTX: 64-bit
96 amdil, // AMDIL
97 amdil64, // AMDIL with 64-bit pointers
98 hsail, // AMD HSAIL
99 hsail64, // AMD HSAIL with 64-bit pointers
100 spir, // SPIR: standard portable IR for OpenCL 32-bit version
101 spir64, // SPIR: standard portable IR for OpenCL 64-bit version
102 spirv, // SPIR-V with logical memory layout.
103 spirv32, // SPIR-V with 32-bit pointers
104 spirv64, // SPIR-V with 64-bit pointers
105 kalimba, // Kalimba: generic kalimba
106 shave, // SHAVE: Movidius vector VLIW processors
107 lanai, // Lanai: Lanai 32-bit
108 wasm32, // WebAssembly with 32-bit pointers
109 wasm64, // WebAssembly with 64-bit pointers
110 renderscript32, // 32-bit RenderScript
111 renderscript64, // 64-bit RenderScript
112 ve, // NEC SX-Aurora Vector Engine
114 };
117
153
157
161
163
165
166 // SPIR-V sub-arch corresponds to its version.
174
175 // DXIL sub-arch corresponds to its version.
187 };
208 enum OSType {
210
218 Lv2, // PS3
230 CUDA, // NVIDIA CUDA
231 NVCL, // NVIDIA OpenCL
232 AMDHSA, // AMD HSA Runtime
236 TvOS, // Apple tvOS
237 WatchOS, // Apple watchOS
238 BridgeOS, // Apple bridgeOS
239 DriverKit, // Apple DriverKit
240 XROS, // Apple XROS
242 AMDPAL, // AMD PAL Runtime
243 HermitCore, // HermitCore Unikernel/Multikernel
244 Hurd, // GNU/Hurd
245 WASI, // Deprecated alias of WASI 0.1; in the future will be WASI 1.0.
246 WASIp1, // WASI 0.1
247 WASIp2, // WASI 0.2
248 WASIp3, // WASI 0.3
250 ShaderModel, // DirectX ShaderModel
253 Vulkan, // Vulkan SPIR-V
260 };
263
291
296 Simulator, // Simulator variants of other systems, e.g., Apple's iOS
297 MacABI, // Mac Catalyst variant of Apple's iOS deployment target.
298
299 // Shader Stages
300 // The order of these values matters, and must be kept in sync with the
301 // language options enum in Clang. The ordering is enforced in
302 // static_asserts in Triple.cpp and in Clang.
321
325 };
338
339private:
340 std::string Data;
341
342 /// The parsed arch type.
343 ArchType Arch{};
344
345 /// The parsed subarchitecture type.
346 SubArchType SubArch{};
347
348 /// The parsed vendor type.
349 VendorType Vendor{};
350
351 /// The parsed OS type.
352 OSType OS{};
353
354 /// The parsed Environment type.
355 EnvironmentType Environment{};
356
357 /// The object format type.
358 ObjectFormatType ObjectFormat{};
359
360public:
361 /// @name Constructors
362 /// @{
363
364 /// Default constructor is the same as an empty string and leaves all
365 /// triple fields unknown.
366 Triple() = default;
367
368 LLVM_ABI explicit Triple(std::string &&Str);
369 explicit Triple(StringRef Str) : Triple(Str.str()) {}
370 explicit Triple(const char *Str) : Triple(std::string(Str)) {}
371 explicit Triple(const std::string &Str) : Triple(std::string(Str)) {}
372 LLVM_ABI explicit Triple(const Twine &Str);
373
374 LLVM_ABI Triple(const Twine &ArchStr, const Twine &VendorStr,
375 const Twine &OSStr);
376 LLVM_ABI Triple(const Twine &ArchStr, const Twine &VendorStr,
377 const Twine &OSStr, const Twine &EnvironmentStr);
378
379 bool operator==(const Triple &Other) const {
380 return Arch == Other.Arch && SubArch == Other.SubArch &&
381 Vendor == Other.Vendor && OS == Other.OS &&
382 Environment == Other.Environment &&
383 ObjectFormat == Other.ObjectFormat;
384 }
385
386 bool operator!=(const Triple &Other) const { return !(*this == Other); }
387
388 bool operator<(const Triple &Other) const {
389 return std::tie(Arch, SubArch, Vendor, OS, Environment, ObjectFormat,
390 Data) < std::tie(Other.Arch, Other.SubArch, Other.Vendor,
391 Other.OS, Other.Environment,
392 Other.ObjectFormat, Other.Data);
393 }
394
395 /// @}
396 /// @name Normalization
397 /// @{
398
399 /// Canonical form
400 enum class CanonicalForm {
401 ANY = 0,
402 THREE_IDENT = 3, // ARCHITECTURE-VENDOR-OPERATING_SYSTEM
403 FOUR_IDENT = 4, // ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
404 FIVE_IDENT = 5, // ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT-FORMAT
405 };
406
407 /// Turn an arbitrary machine specification into the canonical triple form (or
408 /// something sensible that the Triple class understands if nothing better can
409 /// reasonably be done). In particular, it handles the common case in which
410 /// otherwise valid components are in the wrong order. \p Form is used to
411 /// specify the output canonical form.
412 LLVM_ABI static std::string
414
415 /// Return the normalized form of this triple's string.
416 std::string normalize(CanonicalForm Form = CanonicalForm::ANY) const {
417 return normalize(Data, Form);
418 }
419
420 /// @}
421 /// @name Typed Component Access
422 /// @{
423
424 /// Get the parsed architecture type of this triple.
425 ArchType getArch() const { return Arch; }
426
427 /// get the parsed subarchitecture type for this triple.
428 SubArchType getSubArch() const { return SubArch; }
429
430 /// Get the parsed vendor type of this triple.
431 VendorType getVendor() const { return Vendor; }
432
433 /// Get the parsed operating system type of this triple.
434 OSType getOS() const { return OS; }
435
436 /// Does this triple have the optional environment (fourth) component?
437 bool hasEnvironment() const { return getEnvironmentName() != ""; }
438
439 /// Get the parsed environment type of this triple.
440 EnvironmentType getEnvironment() const { return Environment; }
441
442 /// Parse the version number from the OS name component of the
443 /// triple, if present.
444 ///
445 /// For example, "fooos1.2.3" would return (1, 2, 3).
447
448 /// Get the object format for this triple.
449 ObjectFormatType getObjectFormat() const { return ObjectFormat; }
450
451 /// Parse the version number from the OS name component of the triple, if
452 /// present.
453 ///
454 /// For example, "fooos1.2.3" would return (1, 2, 3).
456
457 /// Return just the major version number, this is specialized because it is a
458 /// common query.
459 unsigned getOSMajorVersion() const { return getOSVersion().getMajor(); }
460
461 /// Parse the version number as with getOSVersion and then translate generic
462 /// "darwin" versions to the corresponding OS X versions. This may also be
463 /// called with IOS triples but the OS X version number is just set to a
464 /// constant 10.4.0 in that case. Returns true if successful.
466
467 /// Parse the version number as with getOSVersion. This should only be called
468 /// with IOS or generic triples.
470
471 /// Parse the version number as with getOSVersion. This should only be called
472 /// with WatchOS or generic triples.
474
475 /// Parse the version number as with getOSVersion.
477
478 /// Parse the Vulkan version number from the OSVersion and SPIR-V version
479 /// (SubArch). This should only be called with Vulkan SPIR-V triples.
481
482 /// Parse the DXIL version number from the OSVersion and DXIL version
483 /// (SubArch). This should only be called with DXIL triples.
485
486 /// @}
487 /// @name Direct Component Access
488 /// @{
489
490 const std::string &str() const { return Data; }
491
492 const std::string &getTriple() const { return Data; }
493
494 /// Whether the triple is empty / default constructed.
495 bool empty() const { return Data.empty(); }
496
497 /// Get the architecture (first) component of the triple.
499
500 /// Get the vendor (second) component of the triple.
502
503 /// Get the operating system (third) component of the triple.
505
506 /// Get the optional environment (fourth) component of the triple, or "" if
507 /// empty.
509
510 /// Get the operating system and optional environment components as a single
511 /// string (separated by a '-' if the environment component is present).
513
514 /// Get the version component of the environment component as a single
515 /// string (the version after the environment).
516 ///
517 /// For example, "fooos1.2.3" would return "1.2.3".
519
520 /// @}
521 /// @name Convenience Predicates
522 /// @{
523
524 /// Returns the pointer width of this architecture.
526
527 /// Returns the pointer width of this architecture.
528 unsigned getArchPointerBitWidth() const {
530 }
531
532 /// Returns the trampoline size in bytes for this configuration.
533 LLVM_ABI unsigned getTrampolineSize() const;
534
535 /// Test whether the architecture is 64-bit
536 ///
537 /// Note that this tests for 64-bit pointer width, and nothing else. Note
538 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
539 /// 16-bit. The inner details of pointer width for particular architectures
540 /// is not summed up in the triple, and so only a coarse grained predicate
541 /// system is provided.
542 LLVM_ABI bool isArch64Bit() const;
543
544 /// Test whether the architecture is 32-bit
545 ///
546 /// Note that this tests for 32-bit pointer width, and nothing else.
547 LLVM_ABI bool isArch32Bit() const;
548
549 /// Test whether the architecture is 16-bit
550 ///
551 /// Note that this tests for 16-bit pointer width, and nothing else.
552 LLVM_ABI bool isArch16Bit() const;
553
554 /// Helper function for doing comparisons against version numbers included in
555 /// the target triple.
556 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
557 unsigned Micro = 0) const {
558 if (Minor == 0) {
559 return getOSVersion() < VersionTuple(Major);
560 }
561 if (Micro == 0) {
562 return getOSVersion() < VersionTuple(Major, Minor);
563 }
564 return getOSVersion() < VersionTuple(Major, Minor, Micro);
565 }
566
567 bool isOSVersionGE(unsigned Major, unsigned Minor = 0,
568 unsigned Micro = 0) const {
569 return !isOSVersionLT(Major, Minor, Micro);
570 }
571
572 bool isOSVersionLT(const Triple &Other) const {
573 return getOSVersion() < Other.getOSVersion();
574 }
575
576 bool isOSVersionGE(const Triple &Other) const {
577 return getOSVersion() >= Other.getOSVersion();
578 }
579
580 /// Comparison function for checking OS X version compatibility, which handles
581 /// supporting skewed version numbering schemes used by the "darwin" triples.
582 LLVM_ABI bool isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
583 unsigned Micro = 0) const;
584
585 bool isMacOSXVersionGE(unsigned Major, unsigned Minor = 0,
586 unsigned Micro = 0) const {
587 return !isMacOSXVersionLT(Major, Minor, Micro);
588 }
589
590 /// Is this a Mac OS X triple. For legacy reasons, we support both "darwin"
591 /// and "osx" as OS X triples.
592 bool isMacOSX() const {
593 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
594 }
595
596 /// Is this an iOS triple.
597 /// Note: This identifies tvOS as a variant of iOS. If that ever
598 /// changes, i.e., if the two operating systems diverge or their version
599 /// numbers get out of sync, that will need to be changed.
600 /// watchOS has completely different version numbers so it is not included.
601 bool isiOS() const { return getOS() == Triple::IOS || isTvOS(); }
602
603 /// Is this an Apple tvOS triple.
604 bool isTvOS() const { return getOS() == Triple::TvOS; }
605
606 /// Is this an Apple watchOS triple.
607 bool isWatchOS() const { return getOS() == Triple::WatchOS; }
608
609 bool isWatchABI() const { return getSubArch() == Triple::ARMSubArch_v7k; }
610
611 /// Is this an Apple XROS triple.
612 bool isXROS() const { return getOS() == Triple::XROS; }
613
614 /// Is this an Apple BridgeOS triple.
615 bool isBridgeOS() const { return getOS() == Triple::BridgeOS; }
616
617 /// Is this an Apple DriverKit triple.
618 bool isDriverKit() const { return getOS() == Triple::DriverKit; }
619
620 bool isOSzOS() const { return getOS() == Triple::ZOS; }
621
622 /// Is this an Apple MachO triple.
623 bool isAppleMachO() const {
624 return (getVendor() == Triple::Apple) && isOSBinFormatMachO();
625 }
626
627 /// Is this an Apple firmware triple.
628 bool isAppleFirmware() const {
629 return (getVendor() == Triple::Apple) && isOSFirmware();
630 }
631
632 /// Is this a "Darwin" OS (macOS, iOS, tvOS, watchOS, DriverKit, XROS, or
633 /// bridgeOS).
634 bool isOSDarwin() const {
635 return isMacOSX() || isiOS() || isWatchOS() || isDriverKit() || isXROS() ||
637 // Apple firmware isn't necessarily a Darwin based OS, but for most intents
638 // and purposes it can be treated like a Darwin OS in the compiler.
639 }
640
643 }
644
646 return getEnvironment() == Triple::MacABI;
647 }
648
649 /// Returns true for targets that run on a macOS machine.
650 bool isTargetMachineMac() const {
651 return isMacOSX() || (isOSDarwin() && (isSimulatorEnvironment() ||
653 }
654
655 bool isOSNetBSD() const { return getOS() == Triple::NetBSD; }
656
657 bool isOSOpenBSD() const { return getOS() == Triple::OpenBSD; }
658
659 bool isOSFreeBSD() const { return getOS() == Triple::FreeBSD; }
660
661 bool isOSFuchsia() const { return getOS() == Triple::Fuchsia; }
662
663 bool isOSDragonFly() const { return getOS() == Triple::DragonFly; }
664
665 bool isOSSolaris() const { return getOS() == Triple::Solaris; }
666
667 bool isOSIAMCU() const { return getOS() == Triple::ELFIAMCU; }
668
669 bool isOSUnknown() const { return getOS() == Triple::UnknownOS; }
670
671 bool isGNUEnvironment() const {
673 return Env == Triple::GNU || Env == Triple::GNUT64 ||
674 Env == Triple::GNUABIN32 || Env == Triple::GNUABI64 ||
675 Env == Triple::GNUEABI || Env == Triple::GNUEABIT64 ||
676 Env == Triple::GNUEABIHF || Env == Triple::GNUEABIHFT64 ||
677 Env == Triple::GNUF32 || Env == Triple::GNUF64 ||
678 Env == Triple::GNUSF || Env == Triple::GNUX32;
679 }
680
681 /// Tests whether the OS is Haiku.
682 bool isOSHaiku() const { return getOS() == Triple::Haiku; }
683
684 /// Tests whether the OS is UEFI.
685 bool isUEFI() const { return getOS() == Triple::UEFI; }
686
687 /// Tests whether the OS is Windows.
688 bool isOSWindows() const { return getOS() == Triple::Win32; }
689
690 /// Checks if the environment is MSVC.
692 return isOSWindows() && getEnvironment() == Triple::MSVC;
693 }
694
695 /// Checks if the environment could be MSVC.
700
701 // Checks if we're using the Windows Arm64EC ABI.
702 bool isWindowsArm64EC() const {
703 return getArch() == Triple::aarch64 &&
705 }
706
709 }
710
713 }
714
717 }
718
720 return isOSWindows() && getEnvironment() == Triple::GNU;
721 }
722
723 /// Tests for either Cygwin or MinGW OS
724 bool isOSCygMing() const {
726 }
727
728 /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
733
734 /// Tests whether the OS is Linux.
735 bool isOSLinux() const { return getOS() == Triple::Linux; }
736
737 /// Tests whether the OS is kFreeBSD.
738 bool isOSKFreeBSD() const { return getOS() == Triple::KFreeBSD; }
739
740 /// Tests whether the OS is Hurd.
741 bool isOSHurd() const { return getOS() == Triple::Hurd; }
742
743 /// Tests whether the OS is WASI.
744 bool isOSWASI() const {
745 return getOS() == Triple::WASI || getOS() == Triple::WASIp1 ||
747 }
748
749 /// Tests whether the OS is Emscripten.
750 bool isOSEmscripten() const { return getOS() == Triple::Emscripten; }
751
752 /// Tests whether the OS uses glibc.
753 bool isOSGlibc() const {
754 return (getOS() == Triple::Linux || getOS() == Triple::KFreeBSD ||
755 getOS() == Triple::Hurd) &&
757 }
758
759 /// Tests whether the OS is AIX.
760 bool isOSAIX() const { return getOS() == Triple::AIX; }
761
762 bool isOSSerenity() const { return getOS() == Triple::Serenity; }
763
764 /// Tests whether the OS is QURT.
765 bool isOSQurt() const { return getOS() == Triple::QURT; }
766
767 /// Tests whether the OS uses the ELF binary format.
768 bool isOSBinFormatELF() const { return getObjectFormat() == Triple::ELF; }
769
770 /// Tests whether the OS uses the COFF binary format.
771 bool isOSBinFormatCOFF() const { return getObjectFormat() == Triple::COFF; }
772
773 /// Tests whether the OS uses the GOFF binary format.
774 bool isOSBinFormatGOFF() const { return getObjectFormat() == Triple::GOFF; }
775
776 /// Tests whether the environment is MachO.
778
779 /// Tests whether the OS uses the Wasm binary format.
780 bool isOSBinFormatWasm() const { return getObjectFormat() == Triple::Wasm; }
781
782 /// Tests whether the OS uses the XCOFF binary format.
784
785 /// Tests whether the OS uses the DXContainer binary format.
788 }
789
790 /// Tests whether the target uses WALI Wasm
791 bool isWALI() const {
792 return getArch() == Triple::wasm32 && isOSLinux() &&
794 }
795
796 /// Tests whether the target is the PS4 platform.
797 bool isPS4() const {
798 return getArch() == Triple::x86_64 && getVendor() == Triple::SCEI &&
799 getOS() == Triple::PS4;
800 }
801
802 /// Tests whether the target is the PS5 platform.
803 bool isPS5() const {
804 return getArch() == Triple::x86_64 && getVendor() == Triple::SCEI &&
805 getOS() == Triple::PS5;
806 }
807
808 /// Tests whether the target is the PS4 or PS5 platform.
809 bool isPS() const { return isPS4() || isPS5(); }
810
811 /// Tests whether the target is Android
812 bool isAndroid() const { return getEnvironment() == Triple::Android; }
813
814 bool isAndroidVersionLT(unsigned Major) const {
815 assert(isAndroid() && "Not an Android triple!");
816
818
819 // 64-bit targets did not exist before API level 21 (Lollipop).
820 if (isArch64Bit() && Version.getMajor() < 21)
821 return VersionTuple(21) < VersionTuple(Major);
822
823 return Version < VersionTuple(Major);
824 }
825
826 /// Tests whether the environment is musl-libc
839
840 /// Tests whether the target is OHOS
841 /// LiteOS default enviroment is also OHOS, but omited on triple.
842 bool isOHOSFamily() const { return isOpenHOS() || isOSLiteOS(); }
843
844 bool isOpenHOS() const { return getEnvironment() == Triple::OpenHOS; }
845
846 bool isOSLiteOS() const { return getOS() == Triple::LiteOS; }
847
848 /// Tests whether the target is DXIL.
849 bool isDXIL() const { return getArch() == Triple::dxil; }
850
851 bool isShaderModelOS() const { return getOS() == Triple::ShaderModel; }
852
853 bool isVulkanOS() const { return getOS() == Triple::Vulkan; }
854
855 bool isOSManagarm() const { return getOS() == Triple::Managarm; }
856
857 bool isOSFirmware() const { return getOS() == Triple::Firmware; }
858
861 return Env == Triple::Pixel || Env == Triple::Vertex ||
862 Env == Triple::Geometry || Env == Triple::Hull ||
863 Env == Triple::Domain || Env == Triple::Compute ||
864 Env == Triple::Library || Env == Triple::RayGeneration ||
865 Env == Triple::Intersection || Env == Triple::AnyHit ||
866 Env == Triple::ClosestHit || Env == Triple::Miss ||
867 Env == Triple::Callable || Env == Triple::Mesh ||
869 }
870
871 /// Tests whether the target is SPIR (32- or 64-bit).
872 bool isSPIR() const {
873 return getArch() == Triple::spir || getArch() == Triple::spir64;
874 }
875
876 /// Tests whether the target is SPIR-V (32/64-bit/Logical).
877 bool isSPIRV() const {
878 return getArch() == Triple::spirv32 || getArch() == Triple::spirv64 ||
880 }
881
882 // Tests whether the target is SPIR-V or SPIR.
883 bool isSPIROrSPIRV() const { return isSPIR() || isSPIRV(); }
884
885 /// Tests whether the target is SPIR-V Logical
886 bool isSPIRVLogical() const { return getArch() == Triple::spirv; }
887
888 /// Tests whether the target is NVPTX (32- or 64-bit).
889 bool isNVPTX() const {
890 return getArch() == Triple::nvptx || getArch() == Triple::nvptx64;
891 }
892
893 /// Tests whether the target is AMDGCN
894 bool isAMDGCN() const { return getArch() == Triple::amdgcn; }
895
896 bool isAMDGPU() const { return getArch() == Triple::r600 || isAMDGCN(); }
897
898 /// Tests whether the target is Thumb (little and big endian).
899 bool isThumb() const {
900 return getArch() == Triple::thumb || getArch() == Triple::thumbeb;
901 }
902
903 /// Tests whether the target is ARM (little and big endian).
904 bool isARM() const {
905 return getArch() == Triple::arm || getArch() == Triple::armeb;
906 }
907
908 /// Tests whether the target is LFI.
909 bool isLFI() const {
910 return getArch() == Triple::aarch64 &&
912 }
913
914 /// Tests whether the target supports the EHABI exception
915 /// handling standard.
930
931 // ARM EABI is the bare-metal EABI described in ARM ABI documents and
932 // can be accessed via -target arm-none-eabi. This is NOT GNUEABI.
933 // FIXME: Add a flag for bare-metal for that target and set Triple::EABI
934 // even for GNUEABI, so we can make a distinction here and still conform to
935 // the EABI on GNU (and Android) mode. This requires change in Clang, too.
936 // FIXME: The Darwin exception is temporary, while we move users to
937 // "*-*-*-macho" triples as quickly as possible.
938 bool isTargetAEABI() const {
939 return (getEnvironment() == Triple::EABI ||
941 !isOSDarwin() && !isOSWindows();
942 }
943
951
952 bool isTargetMuslAEABI() const {
953 return (getEnvironment() == Triple::MuslEABI ||
956 !isOSDarwin() && !isOSWindows();
957 }
958
959 /// Tests whether the target is T32.
960 bool isArmT32() const {
961 switch (getSubArch()) {
973 return false;
974 default:
975 return true;
976 }
977 }
978
979 /// Tests whether the target is an M-class.
980 bool isArmMClass() const {
981 switch (getSubArch()) {
988 return true;
989 default:
990 return false;
991 }
992 }
993
994 /// Tests whether the target is AArch64 (little and big endian).
995 bool isAArch64() const {
998 }
999
1000 /// Tests whether the target is AArch64 and pointers are the size specified by
1001 /// \p PointerWidth.
1002 bool isAArch64(int PointerWidth) const {
1003 assert(PointerWidth == 64 || PointerWidth == 32);
1004 if (!isAArch64())
1005 return false;
1006 return getArch() == Triple::aarch64_32 ||
1008 ? PointerWidth == 32
1009 : PointerWidth == 64;
1010 }
1011
1012 bool isAVR() const { return getArch() == Triple::avr; }
1013
1014 /// Tests whether the target is 32-bit LoongArch.
1015 bool isLoongArch32() const { return getArch() == Triple::loongarch32; }
1016
1017 /// Tests whether the target is 64-bit LoongArch.
1018 bool isLoongArch64() const { return getArch() == Triple::loongarch64; }
1019
1020 /// Tests whether the target is LoongArch (32- and 64-bit).
1021 bool isLoongArch() const { return isLoongArch32() || isLoongArch64(); }
1022
1023 /// Tests whether the target is MIPS 32-bit (little and big endian).
1024 bool isMIPS32() const {
1025 return getArch() == Triple::mips || getArch() == Triple::mipsel;
1026 }
1027
1028 /// Tests whether the target is MIPS 64-bit (little and big endian).
1029 bool isMIPS64() const {
1030 return getArch() == Triple::mips64 || getArch() == Triple::mips64el;
1031 }
1032
1033 /// Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
1034 bool isMIPS() const { return isMIPS32() || isMIPS64(); }
1035
1036 /// Tests whether the target is PowerPC (32- or 64-bit LE or BE).
1037 bool isPPC() const {
1038 return getArch() == Triple::ppc || getArch() == Triple::ppc64 ||
1040 }
1041
1042 /// Tests whether the target is 32-bit PowerPC (little and big endian).
1043 bool isPPC32() const {
1044 return getArch() == Triple::ppc || getArch() == Triple::ppcle;
1045 }
1046
1047 /// Tests whether the target is 64-bit PowerPC (little and big endian).
1048 bool isPPC64() const {
1049 return getArch() == Triple::ppc64 || getArch() == Triple::ppc64le;
1050 }
1051
1052 /// Tests whether the target 64-bit PowerPC big endian ABI is ELFv2.
1053 bool isPPC64ELFv2ABI() const {
1054 return (getArch() == Triple::ppc64 &&
1055 ((getOS() == Triple::FreeBSD &&
1056 (getOSMajorVersion() >= 13 || getOSVersion().empty())) ||
1057 getOS() == Triple::OpenBSD || isMusl()));
1058 }
1059
1060 /// Tests whether the target 32-bit PowerPC uses Secure PLT.
1061 bool isPPC32SecurePlt() const {
1062 return ((getArch() == Triple::ppc || getArch() == Triple::ppcle) &&
1063 ((getOS() == Triple::FreeBSD &&
1064 (getOSMajorVersion() >= 13 || getOSVersion().empty())) ||
1066 isMusl()));
1067 }
1068
1069 /// Tests whether the target is 32-bit RISC-V.
1070 bool isRISCV32() const {
1072 }
1073
1074 /// Tests whether the target is 64-bit RISC-V.
1075 bool isRISCV64() const {
1077 }
1078
1079 /// Tests whether the target is RISC-V (32- and 64-bit).
1080 bool isRISCV() const { return isRISCV32() || isRISCV64(); }
1081
1082 /// Tests whether the target is 32-bit SPARC (little and big endian).
1083 bool isSPARC32() const {
1084 return getArch() == Triple::sparc || getArch() == Triple::sparcel;
1085 }
1086
1087 /// Tests whether the target is 64-bit SPARC (big endian).
1088 bool isSPARC64() const { return getArch() == Triple::sparcv9; }
1089
1090 /// Tests whether the target is SPARC.
1091 bool isSPARC() const { return isSPARC32() || isSPARC64(); }
1092
1093 /// Tests whether the target is SystemZ.
1094 bool isSystemZ() const { return getArch() == Triple::systemz; }
1095
1096 /// Tests whether the target is x86 (32- or 64-bit).
1097 bool isX86() const {
1098 return getArch() == Triple::x86 || getArch() == Triple::x86_64;
1099 }
1100
1101 /// Tests whether the target is x86 (32-bit).
1102 bool isX86_32() const { return getArch() == Triple::x86; }
1103
1104 /// Tests whether the target is x86 (64-bit).
1105 bool isX86_64() const { return getArch() == Triple::x86_64; }
1106
1107 /// Tests whether the target is VE
1108 bool isVE() const { return getArch() == Triple::ve; }
1109
1110 /// Tests whether the target is wasm (32- and 64-bit).
1111 bool isWasm() const {
1112 return getArch() == Triple::wasm32 || getArch() == Triple::wasm64;
1113 }
1114
1115 // Tests whether the target is CSKY
1116 bool isCSKY() const { return getArch() == Triple::csky; }
1117
1118 /// Tests whether the target is the Apple "arm64e" AArch64 subarch.
1119 bool isArm64e() const {
1120 return getArch() == Triple::aarch64 &&
1122 }
1123
1124 // Tests whether the target is N32.
1125 bool isABIN32() const {
1127 return Env == Triple::GNUABIN32 || Env == Triple::MuslABIN32;
1128 }
1129
1130 /// Tests whether the target is X32.
1131 bool isX32() const {
1133 return Env == Triple::GNUX32 || Env == Triple::MuslX32;
1134 }
1135
1136 /// Tests whether the target is eBPF.
1137 bool isBPF() const {
1138 return getArch() == Triple::bpfel || getArch() == Triple::bpfeb;
1139 }
1140
1141 /// Tests whether MSVC linker or UEFI targets.
1142 /// Used to default to -mincremental-linker-compatible if we are
1143 /// targeting the MSVC linker or *-uefi triples.
1147
1148 /// Tests if the target forces 64-bit time_t on a 32-bit architecture.
1149 bool isTime64ABI() const {
1151 return Env == Triple::GNUT64 || Env == Triple::GNUEABIT64 ||
1152 Env == Triple::GNUEABIHFT64;
1153 }
1154
1155 /// Tests if the target forces hardfloat.
1156 bool isHardFloatABI() const {
1158 return Env == llvm::Triple::GNUEABIHF ||
1161 }
1162
1163 /// Tests whether the target supports comdat
1164 bool supportsCOMDAT() const {
1165 return !(isOSBinFormatMachO() || isOSBinFormatXCOFF() ||
1167 }
1168
1169 /// Tests whether the target uses emulated TLS as default.
1170 ///
1171 /// Note: Android API level 29 (10) introduced ELF TLS.
1173 return (isAndroid() && isAndroidVersionLT(29)) || isOSOpenBSD() ||
1175 }
1176
1177 /// True if the target uses TLSDESC by default.
1178 bool hasDefaultTLSDESC() const {
1179 return isAArch64() || (isAndroid() && isRISCV64()) || isOSFuchsia();
1180 }
1181
1182 /// Tests whether the target uses -data-sections as default.
1184 return isOSBinFormatXCOFF() || isWasm();
1185 }
1186
1187 /// Returns the default wchar_t size (in bytes) for this target triple.
1188 unsigned getDefaultWCharSize() const;
1189
1190 /// Tests if the environment supports dllimport/export annotations.
1191 bool hasDLLImportExport() const { return isOSWindows() || isPS(); }
1192
1193 /// @}
1194 /// @name Mutators
1195 /// @{
1196
1197 /// Set the architecture (first) component of the triple to a known type.
1198 LLVM_ABI void setArch(ArchType Kind, SubArchType SubArch = NoSubArch);
1199
1200 /// Set the vendor (second) component of the triple to a known type.
1201 LLVM_ABI void setVendor(VendorType Kind);
1202
1203 /// Set the operating system (third) component of the triple to a known type.
1204 LLVM_ABI void setOS(OSType Kind);
1205
1206 /// Set the environment (fourth) component of the triple to a known type.
1207 LLVM_ABI void setEnvironment(EnvironmentType Kind);
1208
1209 /// Set the object file format.
1210 LLVM_ABI void setObjectFormat(ObjectFormatType Kind);
1211
1212 /// Set all components to the new triple \p Str.
1213 LLVM_ABI void setTriple(const Twine &Str);
1214
1215 /// Set the architecture (first) component of the triple by name.
1216 LLVM_ABI void setArchName(StringRef Str);
1217
1218 /// Set the vendor (second) component of the triple by name.
1220
1221 /// Set the operating system (third) component of the triple by name.
1222 LLVM_ABI void setOSName(StringRef Str);
1223
1224 /// Set the optional environment (fourth) component of the triple by name.
1226
1227 /// Set the operating system and optional environment components with a single
1228 /// string.
1230
1231 /// @}
1232 /// @name Helpers to build variants of a particular triple.
1233 /// @{
1234
1235 /// Form a triple with a 32-bit variant of the current architecture.
1236 ///
1237 /// This can be used to move across "families" of architectures where useful.
1238 ///
1239 /// \returns A new triple with a 32-bit architecture or an unknown
1240 /// architecture if no such variant can be found.
1242
1243 /// Form a triple with a 64-bit variant of the current architecture.
1244 ///
1245 /// This can be used to move across "families" of architectures where useful.
1246 ///
1247 /// \returns A new triple with a 64-bit architecture or an unknown
1248 /// architecture if no such variant can be found.
1250
1251 /// Form a triple with a big endian variant of the current architecture.
1252 ///
1253 /// This can be used to move across "families" of architectures where useful.
1254 ///
1255 /// \returns A new triple with a big endian architecture or an unknown
1256 /// architecture if no such variant can be found.
1258
1259 /// Form a triple with a little endian variant of the current architecture.
1260 ///
1261 /// This can be used to move across "families" of architectures where useful.
1262 ///
1263 /// \returns A new triple with a little endian architecture or an unknown
1264 /// architecture if no such variant can be found.
1266
1267 /// Tests whether the target triple is little endian.
1268 ///
1269 /// \returns true if the triple is little endian, false otherwise.
1270 LLVM_ABI bool isLittleEndian() const;
1271
1272 /// Test whether target triples are compatible.
1273 LLVM_ABI bool isCompatibleWith(const Triple &Other) const;
1274
1275 /// Test whether the target triple is for a GPU.
1276 bool isGPU() const { return isSPIRV() || isNVPTX() || isAMDGPU(); }
1277
1278 /// Merge target triples.
1279 LLVM_ABI std::string merge(const Triple &Other) const;
1280
1281 /// Some platforms have different minimum supported OS versions that
1282 /// varies by the architecture specified in the triple. This function
1283 /// returns the minimum supported OS version for this triple if one an exists,
1284 /// or an invalid version tuple if this triple doesn't have one.
1286
1287 /// @}
1288 /// @name Static helpers for IDs.
1289 /// @{
1290
1291 /// Get the canonical name for the \p Kind architecture.
1292 LLVM_ABI static StringRef getArchTypeName(ArchType Kind);
1293
1294 /// Get the architecture name based on \p Kind and \p SubArch.
1295 LLVM_ABI static StringRef getArchName(ArchType Kind,
1296 SubArchType SubArch = NoSubArch);
1297
1298 /// Get the "prefix" canonical name for the \p Kind architecture. This is the
1299 /// prefix used by the architecture specific builtins, and is suitable for
1300 /// passing to \see Intrinsic::getIntrinsicForClangBuiltin().
1301 ///
1302 /// \return - The architecture prefix, or 0 if none is defined.
1303 LLVM_ABI static StringRef getArchTypePrefix(ArchType Kind);
1304
1305 /// Get the canonical name for the \p Kind vendor.
1306 LLVM_ABI static StringRef getVendorTypeName(VendorType Kind);
1307
1308 /// Get the canonical name for the \p Kind operating system.
1309 LLVM_ABI static StringRef getOSTypeName(OSType Kind);
1310
1311 /// Get the canonical name for the \p Kind environment.
1312 LLVM_ABI static StringRef getEnvironmentTypeName(EnvironmentType Kind);
1313
1314 /// Get the name for the \p Object format.
1315 LLVM_ABI static StringRef
1316 getObjectFormatTypeName(ObjectFormatType ObjectFormat);
1317
1318 /// @}
1319 /// @name Static helpers for converting alternate architecture names.
1320 /// @{
1321
1322 /// The canonical type for the given LLVM architecture name (e.g., "x86").
1323 LLVM_ABI static ArchType getArchTypeForLLVMName(StringRef Str);
1324
1325 /// Parse anything recognized as an architecture for the first field of the
1326 /// triple.
1327 LLVM_ABI static ArchType parseArch(StringRef Str);
1328
1329 /// @}
1330
1331 /// Returns a canonicalized OS version number for the specified OS.
1332 LLVM_ABI static VersionTuple
1333 getCanonicalVersionForOS(OSType OSKind, const VersionTuple &Version,
1334 bool IsInValidRange);
1335
1336 /// Returns whether an OS version is invalid and would not map to an Apple OS.
1337 LLVM_ABI static bool isValidVersionForOS(OSType OSKind,
1338 const VersionTuple &Version);
1339
1341
1342 /// Compute the LLVM IR data layout string based on the triple. Some targets
1343 /// customize the layout based on the ABIName string.
1344 LLVM_ABI std::string computeDataLayout(StringRef ABIName = "") const;
1345};
1346
1347} // namespace llvm
1348
1349#endif
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
#define LLVM_ABI
Definition Compiler.h:213
Defines the llvm::VersionTuple class, which represents a version in the form major[....
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
LLVM_ABI bool isMacOSXVersionLT(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Comparison function for checking OS X version compatibility, which handles supporting skewed version ...
Definition Triple.cpp:2506
LLVM_ABI VersionTuple getOSVersion() const
Parse the version number from the OS name component of the triple, if present.
Definition Triple.cpp:1680
bool isPPC() const
Tests whether the target is PowerPC (32- or 64-bit LE or BE).
Definition Triple.h:1037
bool isOSDragonFly() const
Definition Triple.h:663
LLVM_ABI StringRef getVendorName() const
Get the vendor (second) component of the triple.
Definition Triple.cpp:1625
LLVM_ABI VersionTuple getWatchOSVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1797
LLVM_ABI void setArchName(StringRef Str)
Set the architecture (first) component of the triple by name.
Definition Triple.cpp:1905
bool isTargetMachineMac() const
Returns true for targets that run on a macOS machine.
Definition Triple.h:650
bool isArmT32() const
Tests whether the target is T32.
Definition Triple.h:960
LLVM_ABI void setObjectFormat(ObjectFormatType Kind)
Set the object file format.
Definition Triple.cpp:1896
bool isAndroidVersionLT(unsigned Major) const
Definition Triple.h:814
LLVM_ABI llvm::Triple get32BitArchVariant() const
Form a triple with a 32-bit variant of the current architecture.
Definition Triple.cpp:2035
bool isOSCygMing() const
Tests for either Cygwin or MinGW OS.
Definition Triple.h:724
bool isWatchABI() const
Definition Triple.h:609
Triple()=default
Default constructor is the same as an empty string and leaves all triple fields unknown.
@ RayGeneration
Definition Triple.h:310
@ LastEnvironmentType
Definition Triple.h:324
@ UnknownEnvironment
Definition Triple.h:262
@ RootSignature
Definition Triple.h:318
@ Amplification
Definition Triple.h:317
bool isThumb() const
Tests whether the target is Thumb (little and big endian).
Definition Triple.h:899
bool isPS4() const
Tests whether the target is the PS4 platform.
Definition Triple.h:797
bool isX86_64() const
Tests whether the target is x86 (64-bit).
Definition Triple.h:1105
bool isPPC64ELFv2ABI() const
Tests whether the target 64-bit PowerPC big endian ABI is ELFv2.
Definition Triple.h:1053
static LLVM_ABI VersionTuple getCanonicalVersionForOS(OSType OSKind, const VersionTuple &Version, bool IsInValidRange)
Returns a canonicalized OS version number for the specified OS.
Definition Triple.cpp:2560
bool isOSWASI() const
Tests whether the OS is WASI.
Definition Triple.h:744
bool isSPIR() const
Tests whether the target is SPIR (32- or 64-bit).
Definition Triple.h:872
CanonicalForm
Canonical form.
Definition Triple.h:400
bool isOSBinFormatWasm() const
Tests whether the OS uses the Wasm binary format.
Definition Triple.h:780
bool isOSQurt() const
Tests whether the OS is QURT.
Definition Triple.h:765
bool isDriverKit() const
Is this an Apple DriverKit triple.
Definition Triple.h:618
unsigned getArchPointerBitWidth() const
Returns the pointer width of this architecture.
Definition Triple.h:528
LLVM_ABI llvm::Triple getLittleEndianArchVariant() const
Form a triple with a little endian variant of the current architecture.
Definition Triple.cpp:2345
bool isOSHurd() const
Tests whether the OS is Hurd.
Definition Triple.h:741
bool isHardFloatABI() const
Tests if the target forces hardfloat.
Definition Triple.h:1156
bool isBPF() const
Tests whether the target is eBPF.
Definition Triple.h:1137
bool isX32() const
Tests whether the target is X32.
Definition Triple.h:1131
static LLVM_ABI StringRef getVendorTypeName(VendorType Kind)
Get the canonical name for the Kind vendor.
Definition Triple.cpp:355
Triple(const char *Str)
Definition Triple.h:370
ObjectFormatType getObjectFormat() const
Get the object format for this triple.
Definition Triple.h:449
bool isAArch64(int PointerWidth) const
Tests whether the target is AArch64 and pointers are the size specified by PointerWidth.
Definition Triple.h:1002
SubArchType getSubArch() const
get the parsed subarchitecture type for this triple.
Definition Triple.h:428
bool isX86() const
Tests whether the target is x86 (32- or 64-bit).
Definition Triple.h:1097
bool isArm64e() const
Tests whether the target is the Apple "arm64e" AArch64 subarch.
Definition Triple.h:1119
std::string normalize(CanonicalForm Form=CanonicalForm::ANY) const
Return the normalized form of this triple's string.
Definition Triple.h:416
bool isTargetEHABICompatible() const
Tests whether the target supports the EHABI exception handling standard.
Definition Triple.h:916
bool isOSBinFormatGOFF() const
Tests whether the OS uses the GOFF binary format.
Definition Triple.h:774
bool isWindowsGNUEnvironment() const
Definition Triple.h:719
LLVM_ABI void setVendorName(StringRef Str)
Set the vendor (second) component of the triple by name.
Definition Triple.cpp:1909
bool isOSNetBSD() const
Definition Triple.h:655
LLVM_ABI std::string computeDataLayout(StringRef ABIName="") const
Compute the LLVM IR data layout string based on the triple.
LLVM_ABI void setOSAndEnvironmentName(StringRef Str)
Set the operating system and optional environment components with a single string.
Definition Triple.cpp:1926
bool isAndroid() const
Tests whether the target is Android.
Definition Triple.h:812
bool hasDefaultTLSDESC() const
True if the target uses TLSDESC by default.
Definition Triple.h:1178
bool isLFI() const
Tests whether the target is LFI.
Definition Triple.h:909
LLVM_ABI llvm::Triple get64BitArchVariant() const
Form a triple with a 64-bit variant of the current architecture.
Definition Triple.cpp:2146
bool isOSMSVCRT() const
Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
Definition Triple.h:729
bool isOSBinFormatMachO() const
Tests whether the environment is MachO.
Definition Triple.h:777
LLVM_ABI bool isLittleEndian() const
Tests whether the target triple is little endian.
Definition Triple.cpp:2400
LLVM_ABI void setEnvironment(EnvironmentType Kind)
Set the environment (fourth) component of the triple to a known type.
Definition Triple.cpp:1887
bool isABIN32() const
Definition Triple.h:1125
LLVM_ABI StringRef getOSName() const
Get the operating system (third) component of the triple.
Definition Triple.cpp:1630
bool isAVR() const
Definition Triple.h:1012
bool supportsCOMDAT() const
Tests whether the target supports comdat.
Definition Triple.h:1164
bool isWindowsCoreCLREnvironment() const
Definition Triple.h:707
bool isSPIROrSPIRV() const
Definition Triple.h:883
LLVM_ABI ExceptionHandling getDefaultExceptionHandling() const
Definition Triple.cpp:2642
bool isMIPS64() const
Tests whether the target is MIPS 64-bit (little and big endian).
Definition Triple.h:1029
@ loongarch32
Definition Triple.h:64
@ renderscript64
Definition Triple.h:111
@ UnknownArch
Definition Triple.h:50
@ loongarch64
Definition Triple.h:65
@ renderscript32
Definition Triple.h:110
bool hasDefaultDataSections() const
Tests whether the target uses -data-sections as default.
Definition Triple.h:1183
bool isTargetGNUAEABI() const
Definition Triple.h:944
bool isOSSolaris() const
Definition Triple.h:665
bool isRISCV32() const
Tests whether the target is 32-bit RISC-V.
Definition Triple.h:1070
bool isOSKFreeBSD() const
Tests whether the OS is kFreeBSD.
Definition Triple.h:738
LLVM_ABI void setTriple(const Twine &Str)
Set all components to the new triple Str.
Definition Triple.cpp:1875
OSType getOS() const
Get the parsed operating system type of this triple.
Definition Triple.h:434
LLVM_ABI VersionTuple getEnvironmentVersion() const
Parse the version number from the OS name component of the triple, if present.
Definition Triple.cpp:1653
static LLVM_ABI std::string normalize(StringRef Str, CanonicalForm Form=CanonicalForm::ANY)
Turn an arbitrary machine specification into the canonical triple form (or something sensible that th...
Definition Triple.cpp:1390
static LLVM_ABI ArchType getArchTypeForLLVMName(StringRef Str)
The canonical type for the given LLVM architecture name (e.g., "x86").
Definition Triple.cpp:655
bool isOSVersionLT(const Triple &Other) const
Definition Triple.h:572
bool isPPC32() const
Tests whether the target is 32-bit PowerPC (little and big endian).
Definition Triple.h:1043
ArchType getArch() const
Get the parsed architecture type of this triple.
Definition Triple.h:425
LLVM_ABI unsigned getTrampolineSize() const
Returns the trampoline size in bytes for this configuration.
Definition Triple.cpp:2005
bool isOSBinFormatCOFF() const
Tests whether the OS uses the COFF binary format.
Definition Triple.h:771
bool isRISCV64() const
Tests whether the target is 64-bit RISC-V.
Definition Triple.h:1075
bool isCSKY() const
Definition Triple.h:1116
bool isLoongArch64() const
Tests whether the target is 64-bit LoongArch.
Definition Triple.h:1018
LLVM_ABI StringRef getEnvironmentName() const
Get the optional environment (fourth) component of the triple, or "" if empty.
Definition Triple.cpp:1636
bool isSPARC32() const
Tests whether the target is 32-bit SPARC (little and big endian).
Definition Triple.h:1083
bool isSimulatorEnvironment() const
Definition Triple.h:641
LLVM_ABI VersionTuple getDXILVersion() const
Parse the DXIL version number from the OSVersion and DXIL version (SubArch).
Definition Triple.cpp:1862
const std::string & str() const
Definition Triple.h:490
bool isOSzOS() const
Definition Triple.h:620
bool isOSSerenity() const
Definition Triple.h:762
bool isOHOSFamily() const
Tests whether the target is OHOS LiteOS default enviroment is also OHOS, but omited on triple.
Definition Triple.h:842
EnvironmentType getEnvironment() const
Get the parsed environment type of this triple.
Definition Triple.h:440
bool isOSOpenBSD() const
Definition Triple.h:657
LLVM_ABI VersionTuple getVulkanVersion() const
Parse the Vulkan version number from the OSVersion and SPIR-V version (SubArch).
Definition Triple.cpp:1837
bool isOSUnknown() const
Definition Triple.h:669
LLVM_ABI VersionTuple getDriverKitVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1825
static LLVM_ABI ArchType parseArch(StringRef Str)
Parse anything recognized as an architecture for the first field of the triple.
Definition Triple.cpp:792
bool isMIPS32() const
Tests whether the target is MIPS 32-bit (little and big endian).
Definition Triple.h:1024
bool isShaderModelOS() const
Definition Triple.h:851
bool isUEFI() const
Tests whether the OS is UEFI.
Definition Triple.h:685
bool isOSWindows() const
Tests whether the OS is Windows.
Definition Triple.h:688
bool isOSFirmware() const
Definition Triple.h:857
bool isMusl() const
Tests whether the environment is musl-libc.
Definition Triple.h:827
const std::string & getTriple() const
Definition Triple.h:492
static LLVM_ABI StringRef getArchTypeName(ArchType Kind)
Get the canonical name for the Kind architecture.
Definition Triple.cpp:24
bool isOSVersionGE(const Triple &Other) const
Definition Triple.h:576
bool isOSBinFormatDXContainer() const
Tests whether the OS uses the DXContainer binary format.
Definition Triple.h:786
bool isGPU() const
Test whether the target triple is for a GPU.
Definition Triple.h:1276
bool isOSBinFormatXCOFF() const
Tests whether the OS uses the XCOFF binary format.
Definition Triple.h:783
static LLVM_ABI StringRef getOSTypeName(OSType Kind)
Get the canonical name for the Kind operating system.
Definition Triple.cpp:395
bool isTargetMuslAEABI() const
Definition Triple.h:952
@ UnknownObjectFormat
Definition Triple.h:327
bool isARM() const
Tests whether the target is ARM (little and big endian).
Definition Triple.h:904
LLVM_ABI std::string merge(const Triple &Other) const
Merge target triples.
Definition Triple.cpp:2497
bool isArmMClass() const
Tests whether the target is an M-class.
Definition Triple.h:980
bool isOSLinux() const
Tests whether the OS is Linux.
Definition Triple.h:735
bool isBridgeOS() const
Is this an Apple BridgeOS triple.
Definition Triple.h:615
bool isOSManagarm() const
Definition Triple.h:855
bool isRISCV() const
Tests whether the target is RISC-V (32- and 64-bit).
Definition Triple.h:1080
bool isAMDGCN() const
Tests whether the target is AMDGCN.
Definition Triple.h:894
bool isAMDGPU() const
Definition Triple.h:896
bool isLoongArch32() const
Tests whether the target is 32-bit LoongArch.
Definition Triple.h:1015
bool isOSLiteOS() const
Definition Triple.h:846
@ UnknownVendor
Definition Triple.h:189
@ ImaginationTechnologies
Definition Triple.h:196
@ LastVendorType
Definition Triple.h:206
@ MipsTechnologies
Definition Triple.h:197
bool isNVPTX() const
Tests whether the target is NVPTX (32- or 64-bit).
Definition Triple.h:889
bool isOSAIX() const
Tests whether the OS is AIX.
Definition Triple.h:760
LLVM_ABI VersionTuple getMinimumSupportedOSVersion() const
Some platforms have different minimum supported OS versions that varies by the architecture specified...
Definition Triple.cpp:2523
LLVM_ABI bool isArch64Bit() const
Test whether the architecture is 64-bit.
Definition Triple.cpp:2023
LLVM_ABI StringRef getOSAndEnvironmentName() const
Get the operating system and optional environment components as a single string (separated by a '-' i...
Definition Triple.cpp:1642
@ ARMSubArch_v6t2
Definition Triple.h:149
@ MipsSubArch_r6
Definition Triple.h:162
@ DXILSubArch_v1_2
Definition Triple.h:178
@ ARMSubArch_v7
Definition Triple.h:140
@ ARMSubArch_v8m_mainline
Definition Triple.h:138
@ ARMSubArch_v9_6a
Definition Triple.h:119
@ ARMSubArch_v8r
Definition Triple.h:136
@ ARMSubArch_v9_1a
Definition Triple.h:124
@ DXILSubArch_v1_1
Definition Triple.h:177
@ LatestDXILSubArch
Definition Triple.h:186
@ SPIRVSubArch_v10
Definition Triple.h:167
@ SPIRVSubArch_v13
Definition Triple.h:170
@ ARMSubArch_v7k
Definition Triple.h:144
@ ARMSubArch_v8_7a
Definition Triple.h:128
@ ARMSubArch_v8
Definition Triple.h:135
@ SPIRVSubArch_v16
Definition Triple.h:173
@ ARMSubArch_v8_1a
Definition Triple.h:134
@ ARMSubArch_v9_2a
Definition Triple.h:123
@ DXILSubArch_v1_3
Definition Triple.h:179
@ SPIRVSubArch_v15
Definition Triple.h:172
@ ARMSubArch_v7m
Definition Triple.h:142
@ ARMSubArch_v9_7a
Definition Triple.h:118
@ ARMSubArch_v6k
Definition Triple.h:148
@ ARMSubArch_v5
Definition Triple.h:150
@ AArch64SubArch_arm64e
Definition Triple.h:154
@ ARMSubArch_v6
Definition Triple.h:146
@ ARMSubArch_v9_5a
Definition Triple.h:120
@ ARMSubArch_v7ve
Definition Triple.h:145
@ ARMSubArch_v8m_baseline
Definition Triple.h:137
@ ARMSubArch_v8_8a
Definition Triple.h:127
@ ARMSubArch_v8_2a
Definition Triple.h:133
@ ARMSubArch_v7s
Definition Triple.h:143
@ DXILSubArch_v1_0
Definition Triple.h:176
@ DXILSubArch_v1_7
Definition Triple.h:183
@ KalimbaSubArch_v3
Definition Triple.h:158
@ DXILSubArch_v1_5
Definition Triple.h:181
@ ARMSubArch_v8_4a
Definition Triple.h:131
@ ARMSubArch_v8_9a
Definition Triple.h:126
@ ARMSubArch_v7em
Definition Triple.h:141
@ SPIRVSubArch_v12
Definition Triple.h:169
@ SPIRVSubArch_v14
Definition Triple.h:171
@ KalimbaSubArch_v4
Definition Triple.h:159
@ ARMSubArch_v8_1m_mainline
Definition Triple.h:139
@ ARMSubArch_v8_3a
Definition Triple.h:132
@ AArch64SubArch_arm64ec
Definition Triple.h:155
@ ARMSubArch_v8_6a
Definition Triple.h:129
@ ARMSubArch_v5te
Definition Triple.h:151
@ KalimbaSubArch_v5
Definition Triple.h:160
@ ARMSubArch_v4t
Definition Triple.h:152
@ DXILSubArch_v1_6
Definition Triple.h:182
@ DXILSubArch_v1_8
Definition Triple.h:184
@ ARMSubArch_v9_4a
Definition Triple.h:121
@ ARMSubArch_v8_5a
Definition Triple.h:130
@ AArch64SubArch_lfi
Definition Triple.h:156
@ ARMSubArch_v6m
Definition Triple.h:147
@ ARMSubArch_v9_3a
Definition Triple.h:122
@ DXILSubArch_v1_9
Definition Triple.h:185
@ ARMSubArch_v9
Definition Triple.h:125
@ DXILSubArch_v1_4
Definition Triple.h:180
@ SPIRVSubArch_v11
Definition Triple.h:168
@ PPCSubArch_spe
Definition Triple.h:164
LLVM_ABI bool getMacOSXVersion(VersionTuple &Version) const
Parse the version number as with getOSVersion and then translate generic "darwin" versions to the cor...
Definition Triple.cpp:1694
bool isSPARC64() const
Tests whether the target is 64-bit SPARC (big endian).
Definition Triple.h:1088
bool isWindowsCygwinEnvironment() const
Definition Triple.h:715
static LLVM_ABI bool isValidVersionForOS(OSType OSKind, const VersionTuple &Version)
Returns whether an OS version is invalid and would not map to an Apple OS.
Definition Triple.cpp:2611
Triple(StringRef Str)
Definition Triple.h:369
bool isMacOSX() const
Is this a Mac OS X triple.
Definition Triple.h:592
Triple(const std::string &Str)
Definition Triple.h:371
bool isOSFreeBSD() const
Definition Triple.h:659
bool isXROS() const
Is this an Apple XROS triple.
Definition Triple.h:612
LLVM_ABI void setEnvironmentName(StringRef Str)
Set the optional environment (fourth) component of the triple by name.
Definition Triple.cpp:1921
LLVM_ABI void setOS(OSType Kind)
Set the operating system (third) component of the triple to a known type.
Definition Triple.cpp:1885
bool isX86_32() const
Tests whether the target is x86 (32-bit).
Definition Triple.h:1102
bool operator<(const Triple &Other) const
Definition Triple.h:388
LLVM_ABI void setOSName(StringRef Str)
Set the operating system (third) component of the triple by name.
Definition Triple.cpp:1913
bool isAppleFirmware() const
Is this an Apple firmware triple.
Definition Triple.h:628
bool isDefaultIncrementalLinkerCompatibleByDefault() const
Tests whether MSVC linker or UEFI targets.
Definition Triple.h:1144
VendorType getVendor() const
Get the parsed vendor type of this triple.
Definition Triple.h:431
bool isSPARC() const
Tests whether the target is SPARC.
Definition Triple.h:1091
bool isPPC64() const
Tests whether the target is 64-bit PowerPC (little and big endian).
Definition Triple.h:1048
bool isOSDarwin() const
Is this a "Darwin" OS (macOS, iOS, tvOS, watchOS, DriverKit, XROS, or bridgeOS).
Definition Triple.h:634
bool hasDLLImportExport() const
Tests if the environment supports dllimport/export annotations.
Definition Triple.h:1191
bool isSPIRVLogical() const
Tests whether the target is SPIR-V Logical.
Definition Triple.h:886
static LLVM_ABI StringRef getEnvironmentTypeName(EnvironmentType Kind)
Get the canonical name for the Kind environment.
Definition Triple.cpp:501
bool isOSVersionLT(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Helper function for doing comparisons against version numbers included in the target triple.
Definition Triple.h:556
bool isTvOS() const
Is this an Apple tvOS triple.
Definition Triple.h:604
bool isOSEmscripten() const
Tests whether the OS is Emscripten.
Definition Triple.h:750
bool isWindowsArm64EC() const
Definition Triple.h:702
bool isOSVersionGE(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Definition Triple.h:567
bool operator==(const Triple &Other) const
Definition Triple.h:379
bool isWatchOS() const
Is this an Apple watchOS triple.
Definition Triple.h:607
bool empty() const
Whether the triple is empty / default constructed.
Definition Triple.h:495
bool isiOS() const
Is this an iOS triple.
Definition Triple.h:601
bool isMIPS() const
Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
Definition Triple.h:1034
bool isMacOSXVersionGE(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Definition Triple.h:585
bool isWALI() const
Tests whether the target uses WALI Wasm.
Definition Triple.h:791
bool isOSGlibc() const
Tests whether the OS uses glibc.
Definition Triple.h:753
bool isTargetAEABI() const
Definition Triple.h:938
bool isPS() const
Tests whether the target is the PS4 or PS5 platform.
Definition Triple.h:809
bool isWasm() const
Tests whether the target is wasm (32- and 64-bit).
Definition Triple.h:1111
bool isVulkanOS() const
Definition Triple.h:853
LLVM_ABI StringRef getArchName() const
Get the architecture (first) component of the triple.
Definition Triple.cpp:1621
bool isOSIAMCU() const
Definition Triple.h:667
bool isOpenHOS() const
Definition Triple.h:844
bool isMacCatalystEnvironment() const
Definition Triple.h:645
bool isPS5() const
Tests whether the target is the PS5 platform.
Definition Triple.h:803
bool isSPIRV() const
Tests whether the target is SPIR-V (32/64-bit/Logical).
Definition Triple.h:877
bool isAArch64() const
Tests whether the target is AArch64 (little and big endian).
Definition Triple.h:995
static LLVM_ABI StringRef getObjectFormatTypeName(ObjectFormatType ObjectFormat)
Get the name for the Object format.
Definition Triple.cpp:616
bool isAppleMachO() const
Is this an Apple MachO triple.
Definition Triple.h:623
LLVM_ABI bool isArch16Bit() const
Test whether the architecture is 16-bit.
Definition Triple.cpp:2031
LLVM_ABI llvm::Triple getBigEndianArchVariant() const
Form a triple with a big endian variant of the current architecture.
Definition Triple.cpp:2263
LLVM_ABI VersionTuple getiOSVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1745
bool hasDefaultEmulatedTLS() const
Tests whether the target uses emulated TLS as default.
Definition Triple.h:1172
bool isSystemZ() const
Tests whether the target is SystemZ.
Definition Triple.h:1094
LLVM_ABI StringRef getEnvironmentVersionString() const
Get the version component of the environment component as a single string (the version after the envi...
Definition Triple.cpp:1657
bool isPPC32SecurePlt() const
Tests whether the target 32-bit PowerPC uses Secure PLT.
Definition Triple.h:1061
bool isTime64ABI() const
Tests if the target forces 64-bit time_t on a 32-bit architecture.
Definition Triple.h:1149
LLVM_ABI bool isArch32Bit() const
Test whether the architecture is 32-bit.
Definition Triple.cpp:2027
bool operator!=(const Triple &Other) const
Definition Triple.h:386
unsigned getOSMajorVersion() const
Return just the major version number, this is specialized because it is a common query.
Definition Triple.h:459
LLVM_ABI bool isCompatibleWith(const Triple &Other) const
Test whether target triples are compatible.
Definition Triple.cpp:2462
bool isOSFuchsia() const
Definition Triple.h:661
bool isOSBinFormatELF() const
Tests whether the OS uses the ELF binary format.
Definition Triple.h:768
bool isWindowsMSVCEnvironment() const
Checks if the environment could be MSVC.
Definition Triple.h:696
bool hasEnvironment() const
Does this triple have the optional environment (fourth) component?
Definition Triple.h:437
unsigned getDefaultWCharSize() const
Returns the default wchar_t size (in bytes) for this target triple.
Definition Triple.cpp:2452
bool isKnownWindowsMSVCEnvironment() const
Checks if the environment is MSVC.
Definition Triple.h:691
static LLVM_ABI StringRef getArchTypePrefix(ArchType Kind)
Get the "prefix" canonical name for the Kind architecture.
Definition Triple.cpp:235
bool isOSHaiku() const
Tests whether the OS is Haiku.
Definition Triple.h:682
LLVM_ABI void setArch(ArchType Kind, SubArchType SubArch=NoSubArch)
Set the architecture (first) component of the triple to a known type.
Definition Triple.cpp:1877
bool isDXIL() const
Tests whether the target is DXIL.
Definition Triple.h:849
LLVM_ABI void setVendor(VendorType Kind)
Set the vendor (second) component of the triple to a known type.
Definition Triple.cpp:1881
bool isGNUEnvironment() const
Definition Triple.h:671
bool isLoongArch() const
Tests whether the target is LoongArch (32- and 64-bit).
Definition Triple.h:1021
bool isShaderStageEnvironment() const
Definition Triple.h:859
bool isWindowsItaniumEnvironment() const
Definition Triple.h:711
bool isVE() const
Tests whether the target is VE.
Definition Triple.h:1108
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
Represents a version number in the form major[.minor[.subminor[.build]]].
unsigned getMajor() const
Retrieve the major version number.
This is an optimization pass for GlobalISel generic memory operations.
ExceptionHandling
Definition CodeGen.h:53
FunctionAddr VTableAddr uintptr_t uintptr_t Version
Definition InstrProf.h:334
@ Other
Any other memory.
Definition ModRef.h:68
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:221
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:870