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
257 };
260
288
293 Simulator, // Simulator variants of other systems, e.g., Apple's iOS
294 MacABI, // Mac Catalyst variant of Apple's iOS deployment target.
295
296 // Shader Stages
297 // The order of these values matters, and must be kept in sync with the
298 // language options enum in Clang. The ordering is enforced in
299 // static_asserts in Triple.cpp and in Clang.
319
323 };
336
337private:
338 std::string Data;
339
340 /// The parsed arch type.
341 ArchType Arch{};
342
343 /// The parsed subarchitecture type.
344 SubArchType SubArch{};
345
346 /// The parsed vendor type.
347 VendorType Vendor{};
348
349 /// The parsed OS type.
350 OSType OS{};
351
352 /// The parsed Environment type.
353 EnvironmentType Environment{};
354
355 /// The object format type.
356 ObjectFormatType ObjectFormat{};
357
358public:
359 /// @name Constructors
360 /// @{
361
362 /// Default constructor is the same as an empty string and leaves all
363 /// triple fields unknown.
364 Triple() = default;
365
366 LLVM_ABI explicit Triple(std::string &&Str);
367 explicit Triple(StringRef Str) : Triple(Str.str()) {}
368 explicit Triple(const char *Str) : Triple(std::string(Str)) {}
369 explicit Triple(const std::string &Str) : Triple(std::string(Str)) {}
370 LLVM_ABI explicit Triple(const Twine &Str);
371
372 LLVM_ABI Triple(const Twine &ArchStr, const Twine &VendorStr,
373 const Twine &OSStr);
374 LLVM_ABI Triple(const Twine &ArchStr, const Twine &VendorStr,
375 const Twine &OSStr, const Twine &EnvironmentStr);
376
377 bool operator==(const Triple &Other) const {
378 return Arch == Other.Arch && SubArch == Other.SubArch &&
379 Vendor == Other.Vendor && OS == Other.OS &&
380 Environment == Other.Environment &&
381 ObjectFormat == Other.ObjectFormat;
382 }
383
384 bool operator!=(const Triple &Other) const {
385 return !(*this == Other);
386 }
387
388 /// @}
389 /// @name Normalization
390 /// @{
391
392 /// Canonical form
393 enum class CanonicalForm {
394 ANY = 0,
395 THREE_IDENT = 3, // ARCHITECTURE-VENDOR-OPERATING_SYSTEM
396 FOUR_IDENT = 4, // ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
397 FIVE_IDENT = 5, // ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT-FORMAT
398 };
399
400 /// Turn an arbitrary machine specification into the canonical triple form (or
401 /// something sensible that the Triple class understands if nothing better can
402 /// reasonably be done). In particular, it handles the common case in which
403 /// otherwise valid components are in the wrong order. \p Form is used to
404 /// specify the output canonical form.
405 LLVM_ABI static std::string
407
408 /// Return the normalized form of this triple's string.
409 std::string normalize(CanonicalForm Form = CanonicalForm::ANY) const {
410 return normalize(Data, Form);
411 }
412
413 /// @}
414 /// @name Typed Component Access
415 /// @{
416
417 /// Get the parsed architecture type of this triple.
418 ArchType getArch() const { return Arch; }
419
420 /// get the parsed subarchitecture type for this triple.
421 SubArchType getSubArch() const { return SubArch; }
422
423 /// Get the parsed vendor type of this triple.
424 VendorType getVendor() const { return Vendor; }
425
426 /// Get the parsed operating system type of this triple.
427 OSType getOS() const { return OS; }
428
429 /// Does this triple have the optional environment (fourth) component?
430 bool hasEnvironment() const {
431 return getEnvironmentName() != "";
432 }
433
434 /// Get the parsed environment type of this triple.
435 EnvironmentType getEnvironment() const { return Environment; }
436
437 /// Parse the version number from the OS name component of the
438 /// triple, if present.
439 ///
440 /// For example, "fooos1.2.3" would return (1, 2, 3).
442
443 /// Get the object format for this triple.
444 ObjectFormatType getObjectFormat() const { return ObjectFormat; }
445
446 /// Parse the version number from the OS name component of the triple, if
447 /// present.
448 ///
449 /// For example, "fooos1.2.3" would return (1, 2, 3).
451
452 /// Return just the major version number, this is specialized because it is a
453 /// common query.
454 unsigned getOSMajorVersion() const { return getOSVersion().getMajor(); }
455
456 /// Parse the version number as with getOSVersion and then translate generic
457 /// "darwin" versions to the corresponding OS X versions. This may also be
458 /// called with IOS triples but the OS X version number is just set to a
459 /// constant 10.4.0 in that case. Returns true if successful.
461
462 /// Parse the version number as with getOSVersion. This should only be called
463 /// with IOS or generic triples.
465
466 /// Parse the version number as with getOSVersion. This should only be called
467 /// with WatchOS or generic triples.
469
470 /// Parse the version number as with getOSVersion.
472
473 /// Parse the Vulkan version number from the OSVersion and SPIR-V version
474 /// (SubArch). This should only be called with Vulkan SPIR-V triples.
476
477 /// Parse the DXIL version number from the OSVersion and DXIL version
478 /// (SubArch). This should only be called with DXIL triples.
480
481 /// @}
482 /// @name Direct Component Access
483 /// @{
484
485 const std::string &str() const { return Data; }
486
487 const std::string &getTriple() const { return Data; }
488
489 /// Whether the triple is empty / default constructed.
490 bool empty() const { return Data.empty(); }
491
492 /// Get the architecture (first) component of the triple.
494
495 /// Get the vendor (second) component of the triple.
497
498 /// Get the operating system (third) component of the triple.
500
501 /// Get the optional environment (fourth) component of the triple, or "" if
502 /// empty.
504
505 /// Get the operating system and optional environment components as a single
506 /// string (separated by a '-' if the environment component is present).
508
509 /// Get the version component of the environment component as a single
510 /// string (the version after the environment).
511 ///
512 /// For example, "fooos1.2.3" would return "1.2.3".
514
515 /// @}
516 /// @name Convenience Predicates
517 /// @{
518
519 /// Returns the pointer width of this architecture.
521
522 /// Returns the pointer width of this architecture.
523 unsigned getArchPointerBitWidth() const {
525 }
526
527 /// Returns the trampoline size in bytes for this configuration.
528 LLVM_ABI unsigned getTrampolineSize() const;
529
530 /// Test whether the architecture is 64-bit
531 ///
532 /// Note that this tests for 64-bit pointer width, and nothing else. Note
533 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
534 /// 16-bit. The inner details of pointer width for particular architectures
535 /// is not summed up in the triple, and so only a coarse grained predicate
536 /// system is provided.
537 LLVM_ABI bool isArch64Bit() const;
538
539 /// Test whether the architecture is 32-bit
540 ///
541 /// Note that this tests for 32-bit pointer width, and nothing else.
542 LLVM_ABI bool isArch32Bit() const;
543
544 /// Test whether the architecture is 16-bit
545 ///
546 /// Note that this tests for 16-bit pointer width, and nothing else.
547 LLVM_ABI bool isArch16Bit() const;
548
549 /// Helper function for doing comparisons against version numbers included in
550 /// the target triple.
551 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
552 unsigned Micro = 0) const {
553 if (Minor == 0) {
554 return getOSVersion() < VersionTuple(Major);
555 }
556 if (Micro == 0) {
557 return getOSVersion() < VersionTuple(Major, Minor);
558 }
559 return getOSVersion() < VersionTuple(Major, Minor, Micro);
560 }
561
562 bool isOSVersionGE(unsigned Major, unsigned Minor = 0,
563 unsigned Micro = 0) const {
564 return !isOSVersionLT(Major, Minor, Micro);
565 }
566
567 bool isOSVersionLT(const Triple &Other) const {
568 return getOSVersion() < Other.getOSVersion();
569 }
570
571 bool isOSVersionGE(const Triple &Other) const {
572 return getOSVersion() >= Other.getOSVersion();
573 }
574
575 /// Comparison function for checking OS X version compatibility, which handles
576 /// supporting skewed version numbering schemes used by the "darwin" triples.
577 LLVM_ABI bool isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
578 unsigned Micro = 0) const;
579
580 bool isMacOSXVersionGE(unsigned Major, unsigned Minor = 0,
581 unsigned Micro = 0) const {
582 return !isMacOSXVersionLT(Major, Minor, Micro);
583 }
584
585 /// Is this a Mac OS X triple. For legacy reasons, we support both "darwin"
586 /// and "osx" as OS X triples.
587 bool isMacOSX() const {
588 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
589 }
590
591 /// Is this an iOS triple.
592 /// Note: This identifies tvOS as a variant of iOS. If that ever
593 /// changes, i.e., if the two operating systems diverge or their version
594 /// numbers get out of sync, that will need to be changed.
595 /// watchOS has completely different version numbers so it is not included.
596 bool isiOS() const {
597 return getOS() == Triple::IOS || isTvOS();
598 }
599
600 /// Is this an Apple tvOS triple.
601 bool isTvOS() const {
602 return getOS() == Triple::TvOS;
603 }
604
605 /// Is this an Apple watchOS triple.
606 bool isWatchOS() const {
607 return getOS() == Triple::WatchOS;
608 }
609
610 bool isWatchABI() const {
612 }
613
614 /// Is this an Apple XROS triple.
615 bool isXROS() const { return getOS() == Triple::XROS; }
616
617 /// Is this an Apple BridgeOS triple.
618 bool isBridgeOS() const { return getOS() == Triple::BridgeOS; }
619
620 /// Is this an Apple DriverKit triple.
621 bool isDriverKit() const { return getOS() == Triple::DriverKit; }
622
623 bool isOSzOS() const { return getOS() == Triple::ZOS; }
624
625 /// Is this an Apple MachO triple.
626 bool isAppleMachO() const {
627 return (getVendor() == Triple::Apple) && isOSBinFormatMachO();
628 }
629
630 /// Is this a "Darwin" OS (macOS, iOS, tvOS, watchOS, DriverKit, XROS, or
631 /// bridgeOS).
632 bool isOSDarwin() const {
633 return isMacOSX() || isiOS() || isWatchOS() || isDriverKit() || isXROS() ||
634 isBridgeOS();
635 }
636
639 }
640
642 return getEnvironment() == Triple::MacABI;
643 }
644
645 /// Returns true for targets that run on a macOS machine.
646 bool isTargetMachineMac() const {
647 return isMacOSX() || (isOSDarwin() && (isSimulatorEnvironment() ||
649 }
650
651 bool isOSNetBSD() const {
652 return getOS() == Triple::NetBSD;
653 }
654
655 bool isOSOpenBSD() const {
656 return getOS() == Triple::OpenBSD;
657 }
658
659 bool isOSFreeBSD() const {
660 return getOS() == Triple::FreeBSD;
661 }
662
663 bool isOSFuchsia() const {
664 return getOS() == Triple::Fuchsia;
665 }
666
667 bool isOSDragonFly() const { return getOS() == Triple::DragonFly; }
668
669 bool isOSSolaris() const {
670 return getOS() == Triple::Solaris;
671 }
672
673 bool isOSIAMCU() const {
674 return getOS() == Triple::ELFIAMCU;
675 }
676
677 bool isOSUnknown() const { return getOS() == Triple::UnknownOS; }
678
679 bool isGNUEnvironment() const {
681 return Env == Triple::GNU || Env == Triple::GNUT64 ||
682 Env == Triple::GNUABIN32 || Env == Triple::GNUABI64 ||
683 Env == Triple::GNUEABI || Env == Triple::GNUEABIT64 ||
684 Env == Triple::GNUEABIHF || Env == Triple::GNUEABIHFT64 ||
685 Env == Triple::GNUF32 || Env == Triple::GNUF64 ||
686 Env == Triple::GNUSF || Env == Triple::GNUX32;
687 }
688
689 /// Tests whether the OS is Haiku.
690 bool isOSHaiku() const {
691 return getOS() == Triple::Haiku;
692 }
693
694 /// Tests whether the OS is UEFI.
695 bool isUEFI() const {
696 return getOS() == Triple::UEFI;
697 }
698
699 /// Tests whether the OS is Windows.
700 bool isOSWindows() const {
701 return getOS() == Triple::Win32;
702 }
703
704 /// Checks if the environment is MSVC.
706 return isOSWindows() && getEnvironment() == Triple::MSVC;
707 }
708
709 /// Checks if the environment could be MSVC.
714
715 // Checks if we're using the Windows Arm64EC ABI.
716 bool isWindowsArm64EC() const {
717 return getArch() == Triple::aarch64 &&
719 }
720
723 }
724
727 }
728
731 }
732
734 return isOSWindows() && getEnvironment() == Triple::GNU;
735 }
736
737 /// Tests for either Cygwin or MinGW OS
738 bool isOSCygMing() const {
740 }
741
742 /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
747
748 /// Tests whether the OS is Linux.
749 bool isOSLinux() const {
750 return getOS() == Triple::Linux;
751 }
752
753 /// Tests whether the OS is kFreeBSD.
754 bool isOSKFreeBSD() const {
755 return getOS() == Triple::KFreeBSD;
756 }
757
758 /// Tests whether the OS is Hurd.
759 bool isOSHurd() const {
760 return getOS() == Triple::Hurd;
761 }
762
763 /// Tests whether the OS is WASI.
764 bool isOSWASI() const {
765 return getOS() == Triple::WASI || getOS() == Triple::WASIp1 ||
767 }
768
769 /// Tests whether the OS is Emscripten.
770 bool isOSEmscripten() const {
771 return getOS() == Triple::Emscripten;
772 }
773
774 /// Tests whether the OS uses glibc.
775 bool isOSGlibc() const {
776 return (getOS() == Triple::Linux || getOS() == Triple::KFreeBSD ||
777 getOS() == Triple::Hurd) &&
779 }
780
781 /// Tests whether the OS is AIX.
782 bool isOSAIX() const {
783 return getOS() == Triple::AIX;
784 }
785
786 bool isOSSerenity() const {
787 return getOS() == Triple::Serenity;
788 }
789
790 /// Tests whether the OS uses the ELF binary format.
791 bool isOSBinFormatELF() const {
792 return getObjectFormat() == Triple::ELF;
793 }
794
795 /// Tests whether the OS uses the COFF binary format.
796 bool isOSBinFormatCOFF() const {
797 return getObjectFormat() == Triple::COFF;
798 }
799
800 /// Tests whether the OS uses the GOFF binary format.
801 bool isOSBinFormatGOFF() const { return getObjectFormat() == Triple::GOFF; }
802
803 /// Tests whether the environment is MachO.
804 bool isOSBinFormatMachO() const {
805 return getObjectFormat() == Triple::MachO;
806 }
807
808 /// Tests whether the OS uses the Wasm binary format.
809 bool isOSBinFormatWasm() const {
810 return getObjectFormat() == Triple::Wasm;
811 }
812
813 /// Tests whether the OS uses the XCOFF binary format.
814 bool isOSBinFormatXCOFF() const {
815 return getObjectFormat() == Triple::XCOFF;
816 }
817
818 /// Tests whether the OS uses the DXContainer binary format.
821 }
822
823 /// Tests whether the target uses WALI Wasm
824 bool isWALI() const {
825 return getArch() == Triple::wasm32 && isOSLinux() &&
827 }
828
829 /// Tests whether the target is the PS4 platform.
830 bool isPS4() const {
831 return getArch() == Triple::x86_64 &&
832 getVendor() == Triple::SCEI &&
833 getOS() == Triple::PS4;
834 }
835
836 /// Tests whether the target is the PS5 platform.
837 bool isPS5() const {
838 return getArch() == Triple::x86_64 &&
839 getVendor() == Triple::SCEI &&
840 getOS() == Triple::PS5;
841 }
842
843 /// Tests whether the target is the PS4 or PS5 platform.
844 bool isPS() const { return isPS4() || isPS5(); }
845
846 /// Tests whether the target is Android
847 bool isAndroid() const { return getEnvironment() == Triple::Android; }
848
849 bool isAndroidVersionLT(unsigned Major) const {
850 assert(isAndroid() && "Not an Android triple!");
851
853
854 // 64-bit targets did not exist before API level 21 (Lollipop).
855 if (isArch64Bit() && Version.getMajor() < 21)
856 return VersionTuple(21) < VersionTuple(Major);
857
858 return Version < VersionTuple(Major);
859 }
860
861 /// Tests whether the environment is musl-libc
874
875 /// Tests whether the target is OHOS
876 /// LiteOS default enviroment is also OHOS, but omited on triple.
877 bool isOHOSFamily() const { return isOpenHOS() || isOSLiteOS(); }
878
879 bool isOpenHOS() const { return getEnvironment() == Triple::OpenHOS; }
880
881 bool isOSLiteOS() const { return getOS() == Triple::LiteOS; }
882
883 /// Tests whether the target is DXIL.
884 bool isDXIL() const {
885 return getArch() == Triple::dxil;
886 }
887
888 bool isShaderModelOS() const {
889 return getOS() == Triple::ShaderModel;
890 }
891
892 bool isVulkanOS() const { return getOS() == Triple::Vulkan; }
893
894 bool isOSManagarm() const { return getOS() == Triple::Managarm; }
895
898 return Env == Triple::Pixel || Env == Triple::Vertex ||
899 Env == Triple::Geometry || Env == Triple::Hull ||
900 Env == Triple::Domain || Env == Triple::Compute ||
901 Env == Triple::Library || Env == Triple::RayGeneration ||
902 Env == Triple::Intersection || Env == Triple::AnyHit ||
903 Env == Triple::ClosestHit || Env == Triple::Miss ||
904 Env == Triple::Callable || Env == Triple::Mesh ||
906 }
907
908 /// Tests whether the target is SPIR (32- or 64-bit).
909 bool isSPIR() const {
910 return getArch() == Triple::spir || getArch() == Triple::spir64;
911 }
912
913 /// Tests whether the target is SPIR-V (32/64-bit/Logical).
914 bool isSPIRV() const {
915 return getArch() == Triple::spirv32 || getArch() == Triple::spirv64 ||
917 }
918
919 // Tests whether the target is SPIR-V or SPIR.
920 bool isSPIROrSPIRV() const { return isSPIR() || isSPIRV(); }
921
922 /// Tests whether the target is SPIR-V Logical
923 bool isSPIRVLogical() const {
924 return getArch() == Triple::spirv;
925 }
926
927 /// Tests whether the target is NVPTX (32- or 64-bit).
928 bool isNVPTX() const {
929 return getArch() == Triple::nvptx || getArch() == Triple::nvptx64;
930 }
931
932 /// Tests whether the target is AMDGCN
933 bool isAMDGCN() const { return getArch() == Triple::amdgcn; }
934
935 bool isAMDGPU() const { return getArch() == Triple::r600 || isAMDGCN(); }
936
937 /// Tests whether the target is Thumb (little and big endian).
938 bool isThumb() const {
939 return getArch() == Triple::thumb || getArch() == Triple::thumbeb;
940 }
941
942 /// Tests whether the target is ARM (little and big endian).
943 bool isARM() const {
944 return getArch() == Triple::arm || getArch() == Triple::armeb;
945 }
946
947 /// Tests whether the target is LFI.
948 bool isLFI() const {
949 return getArch() == Triple::aarch64 &&
951 }
952
953 /// Tests whether the target supports the EHABI exception
954 /// handling standard.
969
970 // ARM EABI is the bare-metal EABI described in ARM ABI documents and
971 // can be accessed via -target arm-none-eabi. This is NOT GNUEABI.
972 // FIXME: Add a flag for bare-metal for that target and set Triple::EABI
973 // even for GNUEABI, so we can make a distinction here and still conform to
974 // the EABI on GNU (and Android) mode. This requires change in Clang, too.
975 // FIXME: The Darwin exception is temporary, while we move users to
976 // "*-*-*-macho" triples as quickly as possible.
977 bool isTargetAEABI() const {
978 return (getEnvironment() == Triple::EABI ||
980 !isOSDarwin() && !isOSWindows();
981 }
982
990
991 bool isTargetMuslAEABI() const {
992 return (getEnvironment() == Triple::MuslEABI ||
995 !isOSDarwin() && !isOSWindows();
996 }
997
998 /// Tests whether the target is T32.
999 bool isArmT32() const {
1000 switch (getSubArch()) {
1012 return false;
1013 default:
1014 return true;
1015 }
1016 }
1017
1018 /// Tests whether the target is an M-class.
1019 bool isArmMClass() const {
1020 switch (getSubArch()) {
1027 return true;
1028 default:
1029 return false;
1030 }
1031 }
1032
1033 /// Tests whether the target is AArch64 (little and big endian).
1034 bool isAArch64() const {
1035 return getArch() == Triple::aarch64 || getArch() == Triple::aarch64_be ||
1037 }
1038
1039 /// Tests whether the target is AArch64 and pointers are the size specified by
1040 /// \p PointerWidth.
1041 bool isAArch64(int PointerWidth) const {
1042 assert(PointerWidth == 64 || PointerWidth == 32);
1043 if (!isAArch64())
1044 return false;
1045 return getArch() == Triple::aarch64_32 ||
1047 ? PointerWidth == 32
1048 : PointerWidth == 64;
1049 }
1050
1051 /// Tests whether the target is 32-bit LoongArch.
1052 bool isLoongArch32() const { return getArch() == Triple::loongarch32; }
1053
1054 /// Tests whether the target is 64-bit LoongArch.
1055 bool isLoongArch64() const { return getArch() == Triple::loongarch64; }
1056
1057 /// Tests whether the target is LoongArch (32- and 64-bit).
1058 bool isLoongArch() const { return isLoongArch32() || isLoongArch64(); }
1059
1060 /// Tests whether the target is MIPS 32-bit (little and big endian).
1061 bool isMIPS32() const {
1062 return getArch() == Triple::mips || getArch() == Triple::mipsel;
1063 }
1064
1065 /// Tests whether the target is MIPS 64-bit (little and big endian).
1066 bool isMIPS64() const {
1067 return getArch() == Triple::mips64 || getArch() == Triple::mips64el;
1068 }
1069
1070 /// Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
1071 bool isMIPS() const {
1072 return isMIPS32() || isMIPS64();
1073 }
1074
1075 /// Tests whether the target is PowerPC (32- or 64-bit LE or BE).
1076 bool isPPC() const {
1077 return getArch() == Triple::ppc || getArch() == Triple::ppc64 ||
1079 }
1080
1081 /// Tests whether the target is 32-bit PowerPC (little and big endian).
1082 bool isPPC32() const {
1083 return getArch() == Triple::ppc || getArch() == Triple::ppcle;
1084 }
1085
1086 /// Tests whether the target is 64-bit PowerPC (little and big endian).
1087 bool isPPC64() const {
1088 return getArch() == Triple::ppc64 || getArch() == Triple::ppc64le;
1089 }
1090
1091 /// Tests whether the target 64-bit PowerPC big endian ABI is ELFv2.
1092 bool isPPC64ELFv2ABI() const {
1093 return (getArch() == Triple::ppc64 &&
1094 ((getOS() == Triple::FreeBSD &&
1095 (getOSMajorVersion() >= 13 || getOSVersion().empty())) ||
1096 getOS() == Triple::OpenBSD || isMusl()));
1097 }
1098
1099 /// Tests whether the target 32-bit PowerPC uses Secure PLT.
1100 bool isPPC32SecurePlt() const {
1101 return ((getArch() == Triple::ppc || getArch() == Triple::ppcle) &&
1102 ((getOS() == Triple::FreeBSD &&
1103 (getOSMajorVersion() >= 13 || getOSVersion().empty())) ||
1105 isMusl()));
1106 }
1107
1108 /// Tests whether the target is 32-bit RISC-V.
1109 bool isRISCV32() const {
1111 }
1112
1113 /// Tests whether the target is 64-bit RISC-V.
1114 bool isRISCV64() const {
1116 }
1117
1118 /// Tests whether the target is RISC-V (32- and 64-bit).
1119 bool isRISCV() const { return isRISCV32() || isRISCV64(); }
1120
1121 /// Tests whether the target is 32-bit SPARC (little and big endian).
1122 bool isSPARC32() const {
1123 return getArch() == Triple::sparc || getArch() == Triple::sparcel;
1124 }
1125
1126 /// Tests whether the target is 64-bit SPARC (big endian).
1127 bool isSPARC64() const { return getArch() == Triple::sparcv9; }
1128
1129 /// Tests whether the target is SPARC.
1130 bool isSPARC() const { return isSPARC32() || isSPARC64(); }
1131
1132 /// Tests whether the target is SystemZ.
1133 bool isSystemZ() const {
1134 return getArch() == Triple::systemz;
1135 }
1136
1137 /// Tests whether the target is x86 (32- or 64-bit).
1138 bool isX86() const {
1139 return getArch() == Triple::x86 || getArch() == Triple::x86_64;
1140 }
1141
1142 /// Tests whether the target is x86 (32-bit).
1143 bool isX86_32() const { return getArch() == Triple::x86; }
1144
1145 /// Tests whether the target is x86 (64-bit).
1146 bool isX86_64() const { return getArch() == Triple::x86_64; }
1147
1148 /// Tests whether the target is VE
1149 bool isVE() const {
1150 return getArch() == Triple::ve;
1151 }
1152
1153 /// Tests whether the target is wasm (32- and 64-bit).
1154 bool isWasm() const {
1155 return getArch() == Triple::wasm32 || getArch() == Triple::wasm64;
1156 }
1157
1158 // Tests whether the target is CSKY
1159 bool isCSKY() const {
1160 return getArch() == Triple::csky;
1161 }
1162
1163 /// Tests whether the target is the Apple "arm64e" AArch64 subarch.
1164 bool isArm64e() const {
1165 return getArch() == Triple::aarch64 &&
1167 }
1168
1169 // Tests whether the target is N32.
1170 bool isABIN32() const {
1172 return Env == Triple::GNUABIN32 || Env == Triple::MuslABIN32;
1173 }
1174
1175 /// Tests whether the target is X32.
1176 bool isX32() const {
1178 return Env == Triple::GNUX32 || Env == Triple::MuslX32;
1179 }
1180
1181 /// Tests whether the target is eBPF.
1182 bool isBPF() const {
1183 return getArch() == Triple::bpfel || getArch() == Triple::bpfeb;
1184 }
1185
1186 /// Tests if the target forces 64-bit time_t on a 32-bit architecture.
1187 bool isTime64ABI() const {
1189 return Env == Triple::GNUT64 || Env == Triple::GNUEABIT64 ||
1190 Env == Triple::GNUEABIHFT64;
1191 }
1192
1193 /// Tests if the target forces hardfloat.
1194 bool isHardFloatABI() const {
1196 return Env == llvm::Triple::GNUEABIHF ||
1198 Env == llvm::Triple::MuslEABIHF ||
1199 Env == llvm::Triple::EABIHF;
1200 }
1201
1202 /// Tests whether the target supports comdat
1203 bool supportsCOMDAT() const {
1204 return !(isOSBinFormatMachO() || isOSBinFormatXCOFF() ||
1206 }
1207
1208 /// Tests whether the target uses emulated TLS as default.
1209 ///
1210 /// Note: Android API level 29 (10) introduced ELF TLS.
1212 return (isAndroid() && isAndroidVersionLT(29)) || isOSOpenBSD() ||
1214 }
1215
1216 /// True if the target uses TLSDESC by default.
1217 bool hasDefaultTLSDESC() const {
1218 return isAArch64() || (isAndroid() && isRISCV64()) || isOSFuchsia();
1219 }
1220
1221 /// Tests whether the target uses -data-sections as default.
1223 return isOSBinFormatXCOFF() || isWasm();
1224 }
1225
1226 /// Tests if the environment supports dllimport/export annotations.
1227 bool hasDLLImportExport() const { return isOSWindows() || isPS(); }
1228
1229 /// @}
1230 /// @name Mutators
1231 /// @{
1232
1233 /// Set the architecture (first) component of the triple to a known type.
1234 LLVM_ABI void setArch(ArchType Kind, SubArchType SubArch = NoSubArch);
1235
1236 /// Set the vendor (second) component of the triple to a known type.
1237 LLVM_ABI void setVendor(VendorType Kind);
1238
1239 /// Set the operating system (third) component of the triple to a known type.
1240 LLVM_ABI void setOS(OSType Kind);
1241
1242 /// Set the environment (fourth) component of the triple to a known type.
1243 LLVM_ABI void setEnvironment(EnvironmentType Kind);
1244
1245 /// Set the object file format.
1246 LLVM_ABI void setObjectFormat(ObjectFormatType Kind);
1247
1248 /// Set all components to the new triple \p Str.
1249 LLVM_ABI void setTriple(const Twine &Str);
1250
1251 /// Set the architecture (first) component of the triple by name.
1252 LLVM_ABI void setArchName(StringRef Str);
1253
1254 /// Set the vendor (second) component of the triple by name.
1256
1257 /// Set the operating system (third) component of the triple by name.
1258 LLVM_ABI void setOSName(StringRef Str);
1259
1260 /// Set the optional environment (fourth) component of the triple by name.
1262
1263 /// Set the operating system and optional environment components with a single
1264 /// string.
1266
1267 /// @}
1268 /// @name Helpers to build variants of a particular triple.
1269 /// @{
1270
1271 /// Form a triple with a 32-bit variant of the current architecture.
1272 ///
1273 /// This can be used to move across "families" of architectures where useful.
1274 ///
1275 /// \returns A new triple with a 32-bit architecture or an unknown
1276 /// architecture if no such variant can be found.
1278
1279 /// Form a triple with a 64-bit variant of the current architecture.
1280 ///
1281 /// This can be used to move across "families" of architectures where useful.
1282 ///
1283 /// \returns A new triple with a 64-bit architecture or an unknown
1284 /// architecture if no such variant can be found.
1286
1287 /// Form a triple with a big endian variant of the current architecture.
1288 ///
1289 /// This can be used to move across "families" of architectures where useful.
1290 ///
1291 /// \returns A new triple with a big endian architecture or an unknown
1292 /// architecture if no such variant can be found.
1294
1295 /// Form a triple with a little endian variant of the current architecture.
1296 ///
1297 /// This can be used to move across "families" of architectures where useful.
1298 ///
1299 /// \returns A new triple with a little endian architecture or an unknown
1300 /// architecture if no such variant can be found.
1302
1303 /// Tests whether the target triple is little endian.
1304 ///
1305 /// \returns true if the triple is little endian, false otherwise.
1306 LLVM_ABI bool isLittleEndian() const;
1307
1308 /// Test whether target triples are compatible.
1309 LLVM_ABI bool isCompatibleWith(const Triple &Other) const;
1310
1311 /// Test whether the target triple is for a GPU.
1312 bool isGPU() const { return isSPIRV() || isNVPTX() || isAMDGPU(); }
1313
1314 /// Merge target triples.
1315 LLVM_ABI std::string merge(const Triple &Other) const;
1316
1317 /// Some platforms have different minimum supported OS versions that
1318 /// varies by the architecture specified in the triple. This function
1319 /// returns the minimum supported OS version for this triple if one an exists,
1320 /// or an invalid version tuple if this triple doesn't have one.
1322
1323 /// @}
1324 /// @name Static helpers for IDs.
1325 /// @{
1326
1327 /// Get the canonical name for the \p Kind architecture.
1328 LLVM_ABI static StringRef getArchTypeName(ArchType Kind);
1329
1330 /// Get the architecture name based on \p Kind and \p SubArch.
1331 LLVM_ABI static StringRef getArchName(ArchType Kind,
1332 SubArchType SubArch = NoSubArch);
1333
1334 /// Get the "prefix" canonical name for the \p Kind architecture. This is the
1335 /// prefix used by the architecture specific builtins, and is suitable for
1336 /// passing to \see Intrinsic::getIntrinsicForClangBuiltin().
1337 ///
1338 /// \return - The architecture prefix, or 0 if none is defined.
1339 LLVM_ABI static StringRef getArchTypePrefix(ArchType Kind);
1340
1341 /// Get the canonical name for the \p Kind vendor.
1342 LLVM_ABI static StringRef getVendorTypeName(VendorType Kind);
1343
1344 /// Get the canonical name for the \p Kind operating system.
1345 LLVM_ABI static StringRef getOSTypeName(OSType Kind);
1346
1347 /// Get the canonical name for the \p Kind environment.
1348 LLVM_ABI static StringRef getEnvironmentTypeName(EnvironmentType Kind);
1349
1350 /// Get the name for the \p Object format.
1351 LLVM_ABI static StringRef
1352 getObjectFormatTypeName(ObjectFormatType ObjectFormat);
1353
1354 /// @}
1355 /// @name Static helpers for converting alternate architecture names.
1356 /// @{
1357
1358 /// The canonical type for the given LLVM architecture name (e.g., "x86").
1359 LLVM_ABI static ArchType getArchTypeForLLVMName(StringRef Str);
1360
1361 /// @}
1362
1363 /// Returns a canonicalized OS version number for the specified OS.
1364 LLVM_ABI static VersionTuple
1365 getCanonicalVersionForOS(OSType OSKind, const VersionTuple &Version,
1366 bool IsInValidRange);
1367
1368 /// Returns whether an OS version is invalid and would not map to an Apple OS.
1369 LLVM_ABI static bool isValidVersionForOS(OSType OSKind,
1370 const VersionTuple &Version);
1371
1373
1374 /// Compute the LLVM IR data layout string based on the triple. Some targets
1375 /// customize the layout based on the ABIName string.
1376 LLVM_ABI std::string computeDataLayout(StringRef ABIName = "") const;
1377};
1378
1379} // End llvm namespace
1380
1381
1382#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:2196
LLVM_ABI VersionTuple getOSVersion() const
Parse the version number from the OS name component of the triple, if present.
Definition Triple.cpp:1473
bool isPPC() const
Tests whether the target is PowerPC (32- or 64-bit LE or BE).
Definition Triple.h:1076
bool isOSDragonFly() const
Definition Triple.h:667
LLVM_ABI StringRef getVendorName() const
Get the vendor (second) component of the triple.
Definition Triple.cpp:1418
LLVM_ABI VersionTuple getWatchOSVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1584
LLVM_ABI void setArchName(StringRef Str)
Set the architecture (first) component of the triple by name.
Definition Triple.cpp:1691
bool isTargetMachineMac() const
Returns true for targets that run on a macOS machine.
Definition Triple.h:646
bool isArmT32() const
Tests whether the target is T32.
Definition Triple.h:999
LLVM_ABI void setObjectFormat(ObjectFormatType Kind)
Set the object file format.
Definition Triple.cpp:1683
bool isAndroidVersionLT(unsigned Major) const
Definition Triple.h:849
LLVM_ABI llvm::Triple get32BitArchVariant() const
Form a triple with a 32-bit variant of the current architecture.
Definition Triple.cpp:1821
bool isOSCygMing() const
Tests for either Cygwin or MinGW OS.
Definition Triple.h:738
bool isWatchABI() const
Definition Triple.h:610
Triple()=default
Default constructor is the same as an empty string and leaves all triple fields unknown.
@ RayGeneration
Definition Triple.h:307
@ LastEnvironmentType
Definition Triple.h:322
@ UnknownEnvironment
Definition Triple.h:259
@ RootSignature
Definition Triple.h:315
@ Amplification
Definition Triple.h:314
bool isThumb() const
Tests whether the target is Thumb (little and big endian).
Definition Triple.h:938
bool isPS4() const
Tests whether the target is the PS4 platform.
Definition Triple.h:830
bool isX86_64() const
Tests whether the target is x86 (64-bit).
Definition Triple.h:1146
bool isPPC64ELFv2ABI() const
Tests whether the target 64-bit PowerPC big endian ABI is ELFv2.
Definition Triple.h:1092
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:2250
bool isOSWASI() const
Tests whether the OS is WASI.
Definition Triple.h:764
bool isSPIR() const
Tests whether the target is SPIR (32- or 64-bit).
Definition Triple.h:909
CanonicalForm
Canonical form.
Definition Triple.h:393
bool isOSBinFormatWasm() const
Tests whether the OS uses the Wasm binary format.
Definition Triple.h:809
bool isDriverKit() const
Is this an Apple DriverKit triple.
Definition Triple.h:621
unsigned getArchPointerBitWidth() const
Returns the pointer width of this architecture.
Definition Triple.h:523
LLVM_ABI llvm::Triple getLittleEndianArchVariant() const
Form a triple with a little endian variant of the current architecture.
Definition Triple.cpp:2057
bool isOSHurd() const
Tests whether the OS is Hurd.
Definition Triple.h:759
bool isHardFloatABI() const
Tests if the target forces hardfloat.
Definition Triple.h:1194
bool isBPF() const
Tests whether the target is eBPF.
Definition Triple.h:1182
bool isX32() const
Tests whether the target is X32.
Definition Triple.h:1176
static LLVM_ABI StringRef getVendorTypeName(VendorType Kind)
Get the canonical name for the Kind vendor.
Definition Triple.cpp:265
Triple(const char *Str)
Definition Triple.h:368
ObjectFormatType getObjectFormat() const
Get the object format for this triple.
Definition Triple.h:444
bool isAArch64(int PointerWidth) const
Tests whether the target is AArch64 and pointers are the size specified by PointerWidth.
Definition Triple.h:1041
SubArchType getSubArch() const
get the parsed subarchitecture type for this triple.
Definition Triple.h:421
bool isX86() const
Tests whether the target is x86 (32- or 64-bit).
Definition Triple.h:1138
bool isArm64e() const
Tests whether the target is the Apple "arm64e" AArch64 subarch.
Definition Triple.h:1164
std::string normalize(CanonicalForm Form=CanonicalForm::ANY) const
Return the normalized form of this triple's string.
Definition Triple.h:409
bool isTargetEHABICompatible() const
Tests whether the target supports the EHABI exception handling standard.
Definition Triple.h:955
bool isOSBinFormatGOFF() const
Tests whether the OS uses the GOFF binary format.
Definition Triple.h:801
bool isWindowsGNUEnvironment() const
Definition Triple.h:733
LLVM_ABI void setVendorName(StringRef Str)
Set the vendor (second) component of the triple by name.
Definition Triple.cpp:1695
bool isOSNetBSD() const
Definition Triple.h:651
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:1712
bool isAndroid() const
Tests whether the target is Android.
Definition Triple.h:847
bool hasDefaultTLSDESC() const
True if the target uses TLSDESC by default.
Definition Triple.h:1217
bool isLFI() const
Tests whether the target is LFI.
Definition Triple.h:948
LLVM_ABI llvm::Triple get64BitArchVariant() const
Form a triple with a 64-bit variant of the current architecture.
Definition Triple.cpp:1904
bool isOSMSVCRT() const
Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
Definition Triple.h:743
bool isOSBinFormatMachO() const
Tests whether the environment is MachO.
Definition Triple.h:804
LLVM_ABI bool isLittleEndian() const
Tests whether the target triple is little endian.
Definition Triple.cpp:2100
LLVM_ABI void setEnvironment(EnvironmentType Kind)
Set the environment (fourth) component of the triple to a known type.
Definition Triple.cpp:1675
bool isABIN32() const
Definition Triple.h:1170
LLVM_ABI StringRef getOSName() const
Get the operating system (third) component of the triple.
Definition Triple.cpp:1423
bool supportsCOMDAT() const
Tests whether the target supports comdat.
Definition Triple.h:1203
bool isWindowsCoreCLREnvironment() const
Definition Triple.h:721
bool isSPIROrSPIRV() const
Definition Triple.h:920
LLVM_ABI ExceptionHandling getDefaultExceptionHandling() const
Definition Triple.cpp:2332
bool isMIPS64() const
Tests whether the target is MIPS 64-bit (little and big endian).
Definition Triple.h:1066
@ 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:1222
bool isTargetGNUAEABI() const
Definition Triple.h:983
bool isOSSolaris() const
Definition Triple.h:669
bool isRISCV32() const
Tests whether the target is 32-bit RISC-V.
Definition Triple.h:1109
bool isOSKFreeBSD() const
Tests whether the OS is kFreeBSD.
Definition Triple.h:754
LLVM_ABI void setTriple(const Twine &Str)
Set all components to the new triple Str.
Definition Triple.cpp:1659
OSType getOS() const
Get the parsed operating system type of this triple.
Definition Triple.h:427
LLVM_ABI VersionTuple getEnvironmentVersion() const
Parse the version number from the OS name component of the triple, if present.
Definition Triple.cpp:1446
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:1190
static LLVM_ABI ArchType getArchTypeForLLVMName(StringRef Str)
The canonical type for the given LLVM architecture name (e.g., "x86").
Definition Triple.cpp:454
bool isOSVersionLT(const Triple &Other) const
Definition Triple.h:567
bool isPPC32() const
Tests whether the target is 32-bit PowerPC (little and big endian).
Definition Triple.h:1082
ArchType getArch() const
Get the parsed architecture type of this triple.
Definition Triple.h:418
LLVM_ABI unsigned getTrampolineSize() const
Returns the trampoline size in bytes for this configuration.
Definition Triple.cpp:1791
bool isOSBinFormatCOFF() const
Tests whether the OS uses the COFF binary format.
Definition Triple.h:796
bool isRISCV64() const
Tests whether the target is 64-bit RISC-V.
Definition Triple.h:1114
bool isCSKY() const
Definition Triple.h:1159
bool isLoongArch64() const
Tests whether the target is 64-bit LoongArch.
Definition Triple.h:1055
LLVM_ABI StringRef getEnvironmentName() const
Get the optional environment (fourth) component of the triple, or "" if empty.
Definition Triple.cpp:1429
bool isSPARC32() const
Tests whether the target is 32-bit SPARC (little and big endian).
Definition Triple.h:1122
bool isSimulatorEnvironment() const
Definition Triple.h:637
LLVM_ABI VersionTuple getDXILVersion() const
Parse the DXIL version number from the OSVersion and DXIL version (SubArch).
Definition Triple.cpp:1646
const std::string & str() const
Definition Triple.h:485
bool isOSzOS() const
Definition Triple.h:623
bool isOSSerenity() const
Definition Triple.h:786
bool isOHOSFamily() const
Tests whether the target is OHOS LiteOS default enviroment is also OHOS, but omited on triple.
Definition Triple.h:877
EnvironmentType getEnvironment() const
Get the parsed environment type of this triple.
Definition Triple.h:435
bool isOSOpenBSD() const
Definition Triple.h:655
LLVM_ABI VersionTuple getVulkanVersion() const
Parse the Vulkan version number from the OSVersion and SPIR-V version (SubArch).
Definition Triple.cpp:1621
bool isOSUnknown() const
Definition Triple.h:677
LLVM_ABI VersionTuple getDriverKitVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1609
bool isMIPS32() const
Tests whether the target is MIPS 32-bit (little and big endian).
Definition Triple.h:1061
bool isShaderModelOS() const
Definition Triple.h:888
bool isUEFI() const
Tests whether the OS is UEFI.
Definition Triple.h:695
bool isOSWindows() const
Tests whether the OS is Windows.
Definition Triple.h:700
bool isMusl() const
Tests whether the environment is musl-libc.
Definition Triple.h:862
const std::string & getTriple() const
Definition Triple.h:487
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:571
bool isOSBinFormatDXContainer() const
Tests whether the OS uses the DXContainer binary format.
Definition Triple.h:819
bool isGPU() const
Test whether the target triple is for a GPU.
Definition Triple.h:1312
bool isOSBinFormatXCOFF() const
Tests whether the OS uses the XCOFF binary format.
Definition Triple.h:814
static LLVM_ABI StringRef getOSTypeName(OSType Kind)
Get the canonical name for the Kind operating system.
Definition Triple.cpp:291
bool isTargetMuslAEABI() const
Definition Triple.h:991
@ UnknownObjectFormat
Definition Triple.h:325
bool isARM() const
Tests whether the target is ARM (little and big endian).
Definition Triple.h:943
LLVM_ABI std::string merge(const Triple &Other) const
Merge target triples.
Definition Triple.cpp:2187
bool isArmMClass() const
Tests whether the target is an M-class.
Definition Triple.h:1019
bool isOSLinux() const
Tests whether the OS is Linux.
Definition Triple.h:749
bool isBridgeOS() const
Is this an Apple BridgeOS triple.
Definition Triple.h:618
bool isOSManagarm() const
Definition Triple.h:894
bool isRISCV() const
Tests whether the target is RISC-V (32- and 64-bit).
Definition Triple.h:1119
bool isAMDGCN() const
Tests whether the target is AMDGCN.
Definition Triple.h:933
bool isAMDGPU() const
Definition Triple.h:935
bool isLoongArch32() const
Tests whether the target is 32-bit LoongArch.
Definition Triple.h:1052
bool isOSLiteOS() const
Definition Triple.h:881
@ 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:928
bool isOSAIX() const
Tests whether the OS is AIX.
Definition Triple.h:782
LLVM_ABI VersionTuple getMinimumSupportedOSVersion() const
Some platforms have different minimum supported OS versions that varies by the architecture specified...
Definition Triple.cpp:2213
LLVM_ABI bool isArch64Bit() const
Test whether the architecture is 64-bit.
Definition Triple.cpp:1809
LLVM_ABI StringRef getOSAndEnvironmentName() const
Get the operating system and optional environment components as a single string (separated by a '-' i...
Definition Triple.cpp:1435
@ 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:1487
bool isSPARC64() const
Tests whether the target is 64-bit SPARC (big endian).
Definition Triple.h:1127
bool isWindowsCygwinEnvironment() const
Definition Triple.h:729
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:2301
Triple(StringRef Str)
Definition Triple.h:367
bool isMacOSX() const
Is this a Mac OS X triple.
Definition Triple.h:587
Triple(const std::string &Str)
Definition Triple.h:369
bool isOSFreeBSD() const
Definition Triple.h:659
bool isXROS() const
Is this an Apple XROS triple.
Definition Triple.h:615
LLVM_ABI void setEnvironmentName(StringRef Str)
Set the optional environment (fourth) component of the triple by name.
Definition Triple.cpp:1707
LLVM_ABI void setOS(OSType Kind)
Set the operating system (third) component of the triple to a known type.
Definition Triple.cpp:1671
bool isX86_32() const
Tests whether the target is x86 (32-bit).
Definition Triple.h:1143
LLVM_ABI void setOSName(StringRef Str)
Set the operating system (third) component of the triple by name.
Definition Triple.cpp:1699
VendorType getVendor() const
Get the parsed vendor type of this triple.
Definition Triple.h:424
bool isSPARC() const
Tests whether the target is SPARC.
Definition Triple.h:1130
bool isPPC64() const
Tests whether the target is 64-bit PowerPC (little and big endian).
Definition Triple.h:1087
bool isOSDarwin() const
Is this a "Darwin" OS (macOS, iOS, tvOS, watchOS, DriverKit, XROS, or bridgeOS).
Definition Triple.h:632
bool hasDLLImportExport() const
Tests if the environment supports dllimport/export annotations.
Definition Triple.h:1227
bool isSPIRVLogical() const
Tests whether the target is SPIR-V Logical.
Definition Triple.h:923
static LLVM_ABI StringRef getEnvironmentTypeName(EnvironmentType Kind)
Get the canonical name for the Kind environment.
Definition Triple.cpp:351
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:551
bool isTvOS() const
Is this an Apple tvOS triple.
Definition Triple.h:601
bool isOSEmscripten() const
Tests whether the OS is Emscripten.
Definition Triple.h:770
bool isWindowsArm64EC() const
Definition Triple.h:716
bool isOSVersionGE(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Definition Triple.h:562
bool operator==(const Triple &Other) const
Definition Triple.h:377
bool isWatchOS() const
Is this an Apple watchOS triple.
Definition Triple.h:606
bool empty() const
Whether the triple is empty / default constructed.
Definition Triple.h:490
bool isiOS() const
Is this an iOS triple.
Definition Triple.h:596
bool isMIPS() const
Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
Definition Triple.h:1071
bool isMacOSXVersionGE(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Definition Triple.h:580
bool isWALI() const
Tests whether the target uses WALI Wasm.
Definition Triple.h:824
bool isOSGlibc() const
Tests whether the OS uses glibc.
Definition Triple.h:775
bool isTargetAEABI() const
Definition Triple.h:977
bool isPS() const
Tests whether the target is the PS4 or PS5 platform.
Definition Triple.h:844
bool isWasm() const
Tests whether the target is wasm (32- and 64-bit).
Definition Triple.h:1154
bool isVulkanOS() const
Definition Triple.h:892
LLVM_ABI StringRef getArchName() const
Get the architecture (first) component of the triple.
Definition Triple.cpp:1414
bool isOSIAMCU() const
Definition Triple.h:673
bool isOpenHOS() const
Definition Triple.h:879
bool isMacCatalystEnvironment() const
Definition Triple.h:641
bool isPS5() const
Tests whether the target is the PS5 platform.
Definition Triple.h:837
bool isSPIRV() const
Tests whether the target is SPIR-V (32/64-bit/Logical).
Definition Triple.h:914
bool isAArch64() const
Tests whether the target is AArch64 (little and big endian).
Definition Triple.h:1034
static LLVM_ABI StringRef getObjectFormatTypeName(ObjectFormatType ObjectFormat)
Get the name for the Object format.
Definition Triple.cpp:424
bool isAppleMachO() const
Is this an Apple MachO triple.
Definition Triple.h:626
LLVM_ABI bool isArch16Bit() const
Test whether the architecture is 16-bit.
Definition Triple.cpp:1817
LLVM_ABI llvm::Triple getBigEndianArchVariant() const
Form a triple with a big endian variant of the current architecture.
Definition Triple.cpp:1987
LLVM_ABI VersionTuple getiOSVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1535
bool hasDefaultEmulatedTLS() const
Tests whether the target uses emulated TLS as default.
Definition Triple.h:1211
bool isSystemZ() const
Tests whether the target is SystemZ.
Definition Triple.h:1133
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:1450
bool isPPC32SecurePlt() const
Tests whether the target 32-bit PowerPC uses Secure PLT.
Definition Triple.h:1100
bool isTime64ABI() const
Tests if the target forces 64-bit time_t on a 32-bit architecture.
Definition Triple.h:1187
LLVM_ABI bool isArch32Bit() const
Test whether the architecture is 32-bit.
Definition Triple.cpp:1813
bool operator!=(const Triple &Other) const
Definition Triple.h:384
unsigned getOSMajorVersion() const
Return just the major version number, this is specialized because it is a common query.
Definition Triple.h:454
LLVM_ABI bool isCompatibleWith(const Triple &Other) const
Test whether target triples are compatible.
Definition Triple.cpp:2152
bool isOSFuchsia() const
Definition Triple.h:663
bool isOSBinFormatELF() const
Tests whether the OS uses the ELF binary format.
Definition Triple.h:791
bool isWindowsMSVCEnvironment() const
Checks if the environment could be MSVC.
Definition Triple.h:710
bool hasEnvironment() const
Does this triple have the optional environment (fourth) component?
Definition Triple.h:430
bool isKnownWindowsMSVCEnvironment() const
Checks if the environment is MSVC.
Definition Triple.h:705
static LLVM_ABI StringRef getArchTypePrefix(ArchType Kind)
Get the "prefix" canonical name for the Kind architecture.
Definition Triple.cpp:175
bool isOSHaiku() const
Tests whether the OS is Haiku.
Definition Triple.h:690
LLVM_ABI void setArch(ArchType Kind, SubArchType SubArch=NoSubArch)
Set the architecture (first) component of the triple to a known type.
Definition Triple.cpp:1663
bool isDXIL() const
Tests whether the target is DXIL.
Definition Triple.h:884
LLVM_ABI void setVendor(VendorType Kind)
Set the vendor (second) component of the triple to a known type.
Definition Triple.cpp:1667
bool isGNUEnvironment() const
Definition Triple.h:679
bool isLoongArch() const
Tests whether the target is LoongArch (32- and 64-bit).
Definition Triple.h:1058
bool isShaderStageEnvironment() const
Definition Triple.h:896
bool isWindowsItaniumEnvironment() const
Definition Triple.h:725
bool isVE() const
Tests whether the target is VE.
Definition Triple.h:1149
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.
Definition Types.h:26
ExceptionHandling
Definition CodeGen.h:53
FunctionAddr VTableAddr uintptr_t uintptr_t Version
Definition InstrProf.h:302
@ Other
Any other memory.
Definition ModRef.h:68
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:189
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:870