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 // OpenASIP (http://openasip.org) / big endian 32b targets: tce
88 // OpenASIP (http://openasip.org) / little endian 32b targets: tcele
90 // OpenASIP (http://openasip.org) / little endian 64b targets: tcele
92 thumb, // Thumb (little endian): thumb, thumbv.*
93 thumbeb, // Thumb (big endian): thumbeb
94 x86, // X86: i[3-9]86
95 x86_64, // X86-64: amd64, x86_64
96 xcore, // XCore: xcore
97 xtensa, // Tensilica: Xtensa
98 nvptx, // NVPTX: 32-bit
99 nvptx64, // NVPTX: 64-bit
100 amdil, // AMDIL
101 amdil64, // AMDIL with 64-bit pointers
102 hsail, // AMD HSAIL
103 hsail64, // AMD HSAIL with 64-bit pointers
104 spir, // SPIR: standard portable IR for OpenCL 32-bit version
105 spir64, // SPIR: standard portable IR for OpenCL 64-bit version
106 spirv, // SPIR-V with logical memory layout.
107 spirv32, // SPIR-V with 32-bit pointers
108 spirv64, // SPIR-V with 64-bit pointers
109 kalimba, // Kalimba: generic kalimba
110 shave, // SHAVE: Movidius vector VLIW processors
111 lanai, // Lanai: Lanai 32-bit
112 wasm32, // WebAssembly with 32-bit pointers
113 wasm64, // WebAssembly with 64-bit pointers
114 renderscript32, // 32-bit RenderScript
115 renderscript64, // 64-bit RenderScript
116 ve, // NEC SX-Aurora Vector Engine
118 };
121
157
161
165
167
169
170 // SPIR-V sub-arch corresponds to its version.
178
179 // DXIL sub-arch corresponds to its version.
191 };
212 enum OSType {
214
222 Lv2, // PS3
234 CUDA, // NVIDIA CUDA
235 NVCL, // NVIDIA OpenCL
236 AMDHSA, // AMD HSA Runtime
240 TvOS, // Apple tvOS
241 WatchOS, // Apple watchOS
242 BridgeOS, // Apple bridgeOS
243 DriverKit, // Apple DriverKit
244 XROS, // Apple XROS
246 AMDPAL, // AMD PAL Runtime
247 HermitCore, // HermitCore Unikernel/Multikernel
248 Hurd, // GNU/Hurd
249 WASI, // Deprecated alias of WASI 0.1; in the future will be WASI 1.0.
250 WASIp1, // WASI 0.1
251 WASIp2, // WASI 0.2
252 WASIp3, // WASI 0.3
254 ShaderModel, // DirectX ShaderModel
257 Vulkan, // Vulkan SPIR-V
265 };
268
296
301 Simulator, // Simulator variants of other systems, e.g., Apple's iOS
302 MacABI, // Mac Catalyst variant of Apple's iOS deployment target.
303
304 // Shader Stages
305 // The order of these values matters, and must be kept in sync with the
306 // language options enum in Clang. The ordering is enforced in
307 // static_asserts in Triple.cpp and in Clang.
326
330 };
343
344private:
345 std::string Data;
346
347 /// The parsed arch type.
348 ArchType Arch{};
349
350 /// The parsed subarchitecture type.
351 SubArchType SubArch{};
352
353 /// The parsed vendor type.
354 VendorType Vendor{};
355
356 /// The parsed OS type.
357 OSType OS{};
358
359 /// The parsed Environment type.
360 EnvironmentType Environment{};
361
362 /// The object format type.
363 ObjectFormatType ObjectFormat{};
364
365public:
366 /// @name Constructors
367 /// @{
368
369 /// Default constructor is the same as an empty string and leaves all
370 /// triple fields unknown.
371 Triple() = default;
372
373 LLVM_ABI explicit Triple(std::string &&Str);
374 explicit Triple(StringRef Str) : Triple(Str.str()) {}
375 explicit Triple(const char *Str) : Triple(std::string(Str)) {}
376 explicit Triple(const std::string &Str) : Triple(std::string(Str)) {}
377 LLVM_ABI explicit Triple(const Twine &Str);
378
379 LLVM_ABI Triple(const Twine &ArchStr, const Twine &VendorStr,
380 const Twine &OSStr);
381 LLVM_ABI Triple(const Twine &ArchStr, const Twine &VendorStr,
382 const Twine &OSStr, const Twine &EnvironmentStr);
383 LLVM_ABI Triple(ArchType A, SubArchType SA = NoSubArch,
384 VendorType V = UnknownVendor, OSType OS = UnknownOS);
385 LLVM_ABI Triple(ArchType A, SubArchType SA, VendorType V, OSType OS,
386 EnvironmentType E);
387 LLVM_ABI Triple(ArchType A, SubArchType SA, VendorType V, OSType OS,
388 EnvironmentType E, ObjectFormatType OF);
389
390 LLVM_ABI bool operator==(const Triple &Other) const;
391 bool operator!=(const Triple &Other) const { return !(*this == Other); }
392
393 LLVM_ABI bool operator<(const Triple &Other) const;
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 /// Tests whether the OS is Windows or UEFI. These targets generally share
691 /// Windows low-level platform ABI conventions, but this does not imply
692 /// support for a hosted Windows environment or its runtime libraries. Use
693 /// object format or environment predicates when those properties matter.
694 bool isOSWindowsOrUEFI() const { return isOSWindows() || isUEFI(); }
695
696 /// Checks if the environment is MSVC.
698 return isOSWindows() && getEnvironment() == Triple::MSVC;
699 }
700
701 /// Checks if the environment could be MSVC.
706
707 // Checks if we're using the Windows Arm64EC ABI.
708 bool isWindowsArm64EC() const {
709 return getArch() == Triple::aarch64 &&
711 }
712
715 }
716
719 }
720
723 }
724
726 return isOSWindows() && getEnvironment() == Triple::GNU;
727 }
728
729 /// Tests for either Cygwin or MinGW OS
730 bool isOSCygMing() const {
732 }
733
734 /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
739
740 /// Tests whether the OS is Linux.
741 bool isOSLinux() const { return getOS() == Triple::Linux; }
742
743 /// Tests whether the OS is kFreeBSD.
744 bool isOSKFreeBSD() const { return getOS() == Triple::KFreeBSD; }
745
746 /// Tests whether the OS is Hurd.
747 bool isOSHurd() const { return getOS() == Triple::Hurd; }
748
749 /// Tests whether the OS is WASI.
750 bool isOSWASI() const {
751 return getOS() == Triple::WASI || getOS() == Triple::WASIp1 ||
753 }
754
755 /// Tests whether the OS is Emscripten.
756 bool isOSEmscripten() const { return getOS() == Triple::Emscripten; }
757
758 /// Tests whether the OS uses glibc.
759 bool isOSGlibc() const {
760 return (getOS() == Triple::Linux || getOS() == Triple::KFreeBSD ||
761 getOS() == Triple::Hurd) &&
763 }
764
765 /// Tests whether the OS is AIX.
766 bool isOSAIX() const { return getOS() == Triple::AIX; }
767
768 bool isOSSerenity() const { return getOS() == Triple::Serenity; }
769
770 /// Tests whether the OS is QURT.
771 bool isOSQurt() const { return getOS() == Triple::QURT; }
772
773 /// Tests whether the OS is H2.
774 bool isOSH2() const { return getOS() == Triple::H2; }
775
776 /// Tests whether the OS uses the ELF binary format.
777 bool isOSBinFormatELF() const { return getObjectFormat() == Triple::ELF; }
778
779 /// Tests whether the OS uses the COFF binary format.
780 bool isOSBinFormatCOFF() const { return getObjectFormat() == Triple::COFF; }
781
782 /// Tests whether the OS uses the GOFF binary format.
783 bool isOSBinFormatGOFF() const { return getObjectFormat() == Triple::GOFF; }
784
785 /// Tests whether the environment is MachO.
787
788 /// Tests whether the OS uses the Wasm binary format.
789 bool isOSBinFormatWasm() const { return getObjectFormat() == Triple::Wasm; }
790
791 /// Tests whether the OS uses the XCOFF binary format.
793
794 /// Tests whether the OS uses the DXContainer binary format.
797 }
798
799 /// Tests whether the target uses WALI Wasm
800 bool isWALI() const {
801 return getArch() == Triple::wasm32 && isOSLinux() &&
803 }
804
805 /// Tests whether the target is the PS4 platform.
806 bool isPS4() const {
807 return getArch() == Triple::x86_64 && getVendor() == Triple::SCEI &&
808 getOS() == Triple::PS4;
809 }
810
811 /// Tests whether the target is the PS5 platform.
812 bool isPS5() const {
813 return getArch() == Triple::x86_64 && getVendor() == Triple::SCEI &&
814 getOS() == Triple::PS5;
815 }
816
817 /// Tests whether the target is the PS4 or PS5 platform.
818 bool isPS() const { return isPS4() || isPS5(); }
819
820 /// Tests whether the target is Android
821 bool isAndroid() const { return getEnvironment() == Triple::Android; }
822
823 bool isAndroidVersionLT(unsigned Major) const {
824 assert(isAndroid() && "Not an Android triple!");
825
827
828 // 64-bit targets did not exist before API level 21 (Lollipop).
829 if (isArch64Bit() && Version.getMajor() < 21)
830 return VersionTuple(21) < VersionTuple(Major);
831
832 return Version < VersionTuple(Major);
833 }
834
835 /// Tests whether the environment is musl-libc
848
849 /// Tests whether the target is OHOS
850 /// LiteOS default enviroment is also OHOS, but omited on triple.
851 bool isOHOSFamily() const { return isOpenHOS() || isOSLiteOS(); }
852
853 bool isOpenHOS() const { return getEnvironment() == Triple::OpenHOS; }
854
855 bool isOSLiteOS() const { return getOS() == Triple::LiteOS; }
856
857 /// Tests whether the target is DXIL.
858 bool isDXIL() const { return getArch() == Triple::dxil; }
859
860 bool isShaderModelOS() const { return getOS() == Triple::ShaderModel; }
861
862 bool isVulkanOS() const { return getOS() == Triple::Vulkan; }
863
864 bool isOSManagarm() const { return getOS() == Triple::Managarm; }
865
866 bool isOSFirmware() const { return getOS() == Triple::Firmware; }
867
870 return Env == Triple::Pixel || Env == Triple::Vertex ||
871 Env == Triple::Geometry || Env == Triple::Hull ||
872 Env == Triple::Domain || Env == Triple::Compute ||
873 Env == Triple::Library || Env == Triple::RayGeneration ||
874 Env == Triple::Intersection || Env == Triple::AnyHit ||
875 Env == Triple::ClosestHit || Env == Triple::Miss ||
876 Env == Triple::Callable || Env == Triple::Mesh ||
878 }
879
880 /// Tests whether the target is SPIR (32- or 64-bit).
881 bool isSPIR() const {
882 return getArch() == Triple::spir || getArch() == Triple::spir64;
883 }
884
885 /// Tests whether the target is SPIR-V (32/64-bit/Logical).
886 bool isSPIRV() const {
887 return getArch() == Triple::spirv32 || getArch() == Triple::spirv64 ||
889 }
890
891 // Tests whether the target is SPIR-V or SPIR.
892 bool isSPIROrSPIRV() const { return isSPIR() || isSPIRV(); }
893
894 /// Tests whether the target is SPIR-V Logical
895 bool isSPIRVLogical() const { return getArch() == Triple::spirv; }
896
897 /// Tests whether the target is NVPTX (32- or 64-bit).
898 bool isNVPTX() const {
899 return getArch() == Triple::nvptx || getArch() == Triple::nvptx64;
900 }
901
902 /// Tests whether the target is AMDGCN
903 bool isAMDGCN() const { return getArch() == Triple::amdgcn; }
904
905 bool isAMDGPU() const { return getArch() == Triple::r600 || isAMDGCN(); }
906
907 /// Tests whether the target is Thumb (little and big endian).
908 bool isThumb() const {
909 return getArch() == Triple::thumb || getArch() == Triple::thumbeb;
910 }
911
912 /// Tests whether the target is ARM (little and big endian).
913 bool isARM() const {
914 return getArch() == Triple::arm || getArch() == Triple::armeb;
915 }
916
917 /// Tests whether the target is LFI.
918 bool isLFI() const {
919 return getArch() == Triple::aarch64 &&
921 }
922
923 /// Tests whether the target supports the EHABI exception
924 /// handling standard.
939
940 // ARM EABI is the bare-metal EABI described in ARM ABI documents and
941 // can be accessed via -target arm-none-eabi. This is NOT GNUEABI.
942 // FIXME: Add a flag for bare-metal for that target and set Triple::EABI
943 // even for GNUEABI, so we can make a distinction here and still conform to
944 // the EABI on GNU (and Android) mode. This requires change in Clang, too.
945 // FIXME: The Darwin exception is temporary, while we move users to
946 // "*-*-*-macho" triples as quickly as possible.
947 bool isTargetAEABI() const {
948 return (getEnvironment() == Triple::EABI ||
950 !isOSDarwin() && !isOSWindows();
951 }
952
960
961 bool isTargetMuslAEABI() const {
962 return (getEnvironment() == Triple::MuslEABI ||
965 !isOSDarwin() && !isOSWindows();
966 }
967
968 /// Tests whether the target is T32.
969 bool isArmT32() const {
970 switch (getSubArch()) {
982 return false;
983 default:
984 return true;
985 }
986 }
987
988 /// Tests whether the target is an M-class.
989 bool isArmMClass() const {
990 switch (getSubArch()) {
997 return true;
998 default:
999 return false;
1000 }
1001 }
1002
1003 /// Tests whether the target is AArch64 (little and big endian).
1004 bool isAArch64() const {
1005 return getArch() == Triple::aarch64 || getArch() == Triple::aarch64_be ||
1007 }
1008
1009 /// Tests whether the target is AArch64 and pointers are the size specified by
1010 /// \p PointerWidth.
1011 bool isAArch64(int PointerWidth) const {
1012 assert(PointerWidth == 64 || PointerWidth == 32);
1013 if (!isAArch64())
1014 return false;
1015 return getArch() == Triple::aarch64_32 ||
1017 ? PointerWidth == 32
1018 : PointerWidth == 64;
1019 }
1020
1021 bool isAVR() const { return getArch() == Triple::avr; }
1022
1023 /// Tests whether the target is 32-bit LoongArch.
1024 bool isLoongArch32() const { return getArch() == Triple::loongarch32; }
1025
1026 /// Tests whether the target is 64-bit LoongArch.
1027 bool isLoongArch64() const { return getArch() == Triple::loongarch64; }
1028
1029 /// Tests whether the target is LoongArch (32- and 64-bit).
1030 bool isLoongArch() const { return isLoongArch32() || isLoongArch64(); }
1031
1032 /// Tests whether the target is MIPS 32-bit (little and big endian).
1033 bool isMIPS32() const {
1034 return getArch() == Triple::mips || getArch() == Triple::mipsel;
1035 }
1036
1037 /// Tests whether the target is MIPS 64-bit (little and big endian).
1038 bool isMIPS64() const {
1039 return getArch() == Triple::mips64 || getArch() == Triple::mips64el;
1040 }
1041
1042 /// Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
1043 bool isMIPS() const { return isMIPS32() || isMIPS64(); }
1044
1045 /// Tests whether the target is PowerPC (32- or 64-bit LE or BE).
1046 bool isPPC() const {
1047 return getArch() == Triple::ppc || getArch() == Triple::ppc64 ||
1049 }
1050
1051 /// Tests whether the target is 32-bit PowerPC (little and big endian).
1052 bool isPPC32() const {
1053 return getArch() == Triple::ppc || getArch() == Triple::ppcle;
1054 }
1055
1056 /// Tests whether the target is 64-bit PowerPC (little and big endian).
1057 bool isPPC64() const {
1058 return getArch() == Triple::ppc64 || getArch() == Triple::ppc64le;
1059 }
1060
1061 /// Tests whether the target 64-bit PowerPC big endian ABI is ELFv2.
1062 bool isPPC64ELFv2ABI() const {
1063 return (getArch() == Triple::ppc64 &&
1064 ((getOS() == Triple::FreeBSD &&
1065 (getOSMajorVersion() >= 13 || getOSVersion().empty())) ||
1066 getOS() == Triple::OpenBSD || isMusl()));
1067 }
1068
1069 /// Tests whether the target 32-bit PowerPC uses Secure PLT.
1070 bool isPPC32SecurePlt() const {
1071 return ((getArch() == Triple::ppc || getArch() == Triple::ppcle) &&
1072 ((getOS() == Triple::FreeBSD &&
1073 (getOSMajorVersion() >= 13 || getOSVersion().empty())) ||
1075 isMusl()));
1076 }
1077
1078 /// Tests whether the target is 32-bit RISC-V.
1079 bool isRISCV32() const {
1081 }
1082
1083 /// Tests whether the target is 64-bit RISC-V.
1084 bool isRISCV64() const {
1086 }
1087
1088 /// Tests whether the target is RISC-V (32- and 64-bit).
1089 bool isRISCV() const { return isRISCV32() || isRISCV64(); }
1090
1091 /// Tests whether the target is 32-bit SPARC (little and big endian).
1092 bool isSPARC32() const {
1093 return getArch() == Triple::sparc || getArch() == Triple::sparcel;
1094 }
1095
1096 /// Tests whether the target is 64-bit SPARC (big endian).
1097 bool isSPARC64() const { return getArch() == Triple::sparcv9; }
1098
1099 /// Tests whether the target is SPARC.
1100 bool isSPARC() const { return isSPARC32() || isSPARC64(); }
1101
1102 /// Tests whether the target is SystemZ.
1103 bool isSystemZ() const { return getArch() == Triple::systemz; }
1104
1105 /// Tests whether the target is x86 (32- or 64-bit).
1106 bool isX86() const {
1107 return getArch() == Triple::x86 || getArch() == Triple::x86_64;
1108 }
1109
1110 /// Tests whether the target is x86 (32-bit).
1111 bool isX86_32() const { return getArch() == Triple::x86; }
1112
1113 /// Tests whether the target is x86 (64-bit).
1114 bool isX86_64() const { return getArch() == Triple::x86_64; }
1115
1116 /// Tests whether the target is VE
1117 bool isVE() const { return getArch() == Triple::ve; }
1118
1119 /// Tests whether the target is wasm (32- and 64-bit).
1120 bool isWasm() const {
1121 return getArch() == Triple::wasm32 || getArch() == Triple::wasm64;
1122 }
1123
1124 // Tests whether the target is CSKY
1125 bool isCSKY() const { return getArch() == Triple::csky; }
1126
1127 /// Tests whether the target is the Apple "arm64e" AArch64 subarch.
1128 bool isArm64e() const {
1129 return getArch() == Triple::aarch64 &&
1131 }
1132
1133 // Tests whether the target is N32.
1134 bool isABIN32() const {
1136 return Env == Triple::GNUABIN32 || Env == Triple::MuslABIN32;
1137 }
1138
1139 /// Tests whether the target is X32.
1140 bool isX32() const {
1142 return Env == Triple::GNUX32 || Env == Triple::MuslX32;
1143 }
1144
1145 /// Tests whether the target is eBPF.
1146 bool isBPF() const {
1147 return getArch() == Triple::bpfel || getArch() == Triple::bpfeb;
1148 }
1149
1150 /// Tests whether MSVC linker or UEFI targets.
1151 /// Used to default to -mincremental-linker-compatible if we are
1152 /// targeting the MSVC linker or *-uefi triples.
1156
1157 /// Tests if the target forces 64-bit time_t on a 32-bit architecture.
1158 bool isTime64ABI() const {
1160 return Env == Triple::GNUT64 || Env == Triple::GNUEABIT64 ||
1161 Env == Triple::GNUEABIHFT64;
1162 }
1163
1164 /// Tests if the target forces hardfloat.
1165 bool isHardFloatABI() const {
1167 return Env == llvm::Triple::GNUEABIHF ||
1170 }
1171
1172 /// Tests whether the target supports comdat
1173 bool supportsCOMDAT() const {
1174 return !(isOSBinFormatMachO() || isOSBinFormatXCOFF() ||
1176 }
1177
1178 /// Tests whether the target uses emulated TLS as default.
1179 ///
1180 /// Note: Android API level 29 (10) introduced ELF TLS.
1182 return (isAndroid() && isAndroidVersionLT(29)) || isOSOpenBSD() ||
1184 }
1185
1186 /// True if the target uses TLSDESC by default.
1187 bool hasDefaultTLSDESC() const {
1188 return isAArch64() || (isAndroid() && isRISCV64()) || isOSFuchsia();
1189 }
1190
1191 /// Tests whether the target uses -data-sections as default.
1193 return isOSBinFormatXCOFF() || isWasm();
1194 }
1195
1196 /// Returns the default wchar_t size (in bytes) for this target triple.
1197 LLVM_ABI unsigned getDefaultWCharSize() const;
1198
1199 /// Tests if the environment supports dllimport/export annotations.
1200 bool hasDLLImportExport() const { return isOSWindows() || isPS(); }
1201
1202 /// @}
1203 /// @name Mutators
1204 /// @{
1205
1206 /// Set the architecture (first) component of the triple to a known type.
1207 LLVM_ABI void setArch(ArchType Kind, SubArchType SubArch = NoSubArch);
1208
1209 /// Set the vendor (second) component of the triple to a known type.
1210 LLVM_ABI void setVendor(VendorType Kind);
1211
1212 /// Set the operating system (third) component of the triple to a known type.
1213 LLVM_ABI void setOS(OSType Kind);
1214
1215 /// Set the environment (fourth) component of the triple to a known type.
1216 LLVM_ABI void setEnvironment(EnvironmentType Kind);
1217
1218 /// Set the object file format.
1219 LLVM_ABI void setObjectFormat(ObjectFormatType Kind);
1220
1221 /// Set all components to the new triple \p Str.
1222 LLVM_ABI void setTriple(const Twine &Str);
1223
1224 /// Set the architecture (first) component of the triple by name.
1225 LLVM_ABI void setArchName(StringRef Str);
1226
1227 /// Set the vendor (second) component of the triple by name.
1229
1230 /// Set the operating system (third) component of the triple by name.
1231 LLVM_ABI void setOSName(StringRef Str);
1232
1233 /// Set the optional environment (fourth) component of the triple by name.
1235
1236 /// Set the operating system and optional environment components with a single
1237 /// string.
1239
1240 /// @}
1241 /// @name Helpers to build variants of a particular triple.
1242 /// @{
1243
1244 /// Form a triple with a 32-bit variant of the current architecture.
1245 ///
1246 /// This can be used to move across "families" of architectures where useful.
1247 ///
1248 /// \returns A new triple with a 32-bit architecture or an unknown
1249 /// architecture if no such variant can be found.
1251
1252 /// Form a triple with a 64-bit variant of the current architecture.
1253 ///
1254 /// This can be used to move across "families" of architectures where useful.
1255 ///
1256 /// \returns A new triple with a 64-bit architecture or an unknown
1257 /// architecture if no such variant can be found.
1259
1260 /// Form a triple with a big endian variant of the current architecture.
1261 ///
1262 /// This can be used to move across "families" of architectures where useful.
1263 ///
1264 /// \returns A new triple with a big endian architecture or an unknown
1265 /// architecture if no such variant can be found.
1267
1268 /// Form a triple with a little endian variant of the current architecture.
1269 ///
1270 /// This can be used to move across "families" of architectures where useful.
1271 ///
1272 /// \returns A new triple with a little endian architecture or an unknown
1273 /// architecture if no such variant can be found.
1275
1276 /// Tests whether the target triple is little endian.
1277 ///
1278 /// \returns true if the triple is little endian, false otherwise.
1279 LLVM_ABI bool isLittleEndian() const;
1280
1281 /// Test whether target triples are compatible.
1282 LLVM_ABI bool isCompatibleWith(const Triple &Other) const;
1283
1284 /// Test whether the target triple is for a GPU.
1285 bool isGPU() const { return isSPIROrSPIRV() || isNVPTX() || isAMDGPU(); }
1286
1287 /// Merge target triples.
1288 LLVM_ABI std::string merge(const Triple &Other) const;
1289
1290 /// Some platforms have different minimum supported OS versions that
1291 /// varies by the architecture specified in the triple. This function
1292 /// returns the minimum supported OS version for this triple if one an exists,
1293 /// or an invalid version tuple if this triple doesn't have one.
1295
1296 /// @}
1297 /// @name Static helpers for IDs.
1298 /// @{
1299
1300 /// Get the canonical name for the \p Kind architecture.
1301 LLVM_ABI static StringRef getArchTypeName(ArchType Kind);
1302
1303 /// Get the architecture name based on \p Kind and \p SubArch.
1304 LLVM_ABI static StringRef getArchName(ArchType Kind,
1305 SubArchType SubArch = NoSubArch);
1306
1307 /// Get the "prefix" canonical name for the \p Kind architecture. This is the
1308 /// prefix used by the architecture specific builtins, and is suitable for
1309 /// passing to \see Intrinsic::getIntrinsicForClangBuiltin().
1310 ///
1311 /// \return - The architecture prefix, or 0 if none is defined.
1312 LLVM_ABI static StringRef getArchTypePrefix(ArchType Kind);
1313
1314 /// Get the canonical name for the \p Kind vendor.
1315 LLVM_ABI static StringRef getVendorTypeName(VendorType Kind);
1316
1317 /// Get the canonical name for the \p Kind operating system.
1318 LLVM_ABI static StringRef getOSTypeName(OSType Kind);
1319
1320 /// Get the canonical name for the \p Kind environment.
1321 LLVM_ABI static StringRef getEnvironmentTypeName(EnvironmentType Kind);
1322
1323 /// Get the name for the \p Object format.
1324 LLVM_ABI static StringRef
1325 getObjectFormatTypeName(ObjectFormatType ObjectFormat);
1326
1327 /// @}
1328 /// @name Static helpers for converting alternate architecture names.
1329 /// @{
1330
1331 /// The canonical type for the given LLVM architecture name (e.g., "x86").
1332 LLVM_ABI static ArchType getArchTypeForLLVMName(StringRef Str);
1333
1334 /// Parse anything recognized as an architecture for the first field of the
1335 /// triple.
1336 LLVM_ABI static ArchType parseArch(StringRef Str);
1337
1338 /// @}
1339
1340 /// Returns a canonicalized OS version number for the specified OS.
1341 LLVM_ABI static VersionTuple
1342 getCanonicalVersionForOS(OSType OSKind, const VersionTuple &Version,
1343 bool IsInValidRange);
1344
1345 /// Returns whether an OS version is invalid and would not map to an Apple OS.
1346 LLVM_ABI static bool isValidVersionForOS(OSType OSKind,
1347 const VersionTuple &Version);
1348
1350
1351 /// Compute the LLVM IR data layout string based on the triple. Some targets
1352 /// customize the layout based on the ABIName string.
1353 LLVM_ABI std::string computeDataLayout(StringRef ABIName = "") const;
1354};
1355
1356} // namespace llvm
1357
1358#endif
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define LLVM_ABI
Definition Compiler.h:215
Defines the llvm::VersionTuple class, which represents a version in the form major[....
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
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:2564
LLVM_ABI VersionTuple getOSVersion() const
Parse the version number from the OS name component of the triple, if present.
Definition Triple.cpp:1726
bool isPPC() const
Tests whether the target is PowerPC (32- or 64-bit LE or BE).
Definition Triple.h:1046
bool isOSDragonFly() const
Definition Triple.h:663
LLVM_ABI StringRef getVendorName() const
Get the vendor (second) component of the triple.
Definition Triple.cpp:1671
LLVM_ABI VersionTuple getWatchOSVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1846
LLVM_ABI void setArchName(StringRef Str)
Set the architecture (first) component of the triple by name.
Definition Triple.cpp:1954
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:969
LLVM_ABI void setObjectFormat(ObjectFormatType Kind)
Set the object file format.
Definition Triple.cpp:1945
bool isAndroidVersionLT(unsigned Major) const
Definition Triple.h:823
LLVM_ABI llvm::Triple get32BitArchVariant() const
Form a triple with a 32-bit variant of the current architecture.
Definition Triple.cpp:2085
bool isOSCygMing() const
Tests for either Cygwin or MinGW OS.
Definition Triple.h:730
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:315
@ LastEnvironmentType
Definition Triple.h:329
@ UnknownEnvironment
Definition Triple.h:267
@ RootSignature
Definition Triple.h:323
@ Amplification
Definition Triple.h:322
bool isThumb() const
Tests whether the target is Thumb (little and big endian).
Definition Triple.h:908
bool isPS4() const
Tests whether the target is the PS4 platform.
Definition Triple.h:806
bool isX86_64() const
Tests whether the target is x86 (64-bit).
Definition Triple.h:1114
bool isPPC64ELFv2ABI() const
Tests whether the target 64-bit PowerPC big endian ABI is ELFv2.
Definition Triple.h:1062
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:2618
bool isOSWASI() const
Tests whether the OS is WASI.
Definition Triple.h:750
bool isSPIR() const
Tests whether the target is SPIR (32- or 64-bit).
Definition Triple.h:881
CanonicalForm
Canonical form.
Definition Triple.h:400
bool isOSBinFormatWasm() const
Tests whether the OS uses the Wasm binary format.
Definition Triple.h:789
bool isOSQurt() const
Tests whether the OS is QURT.
Definition Triple.h:771
LLVM_ABI bool operator<(const Triple &Other) const
Definition Triple.cpp:30
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:2402
bool isOSHurd() const
Tests whether the OS is Hurd.
Definition Triple.h:747
bool isHardFloatABI() const
Tests if the target forces hardfloat.
Definition Triple.h:1165
bool isBPF() const
Tests whether the target is eBPF.
Definition Triple.h:1146
bool isX32() const
Tests whether the target is X32.
Definition Triple.h:1140
static LLVM_ABI StringRef getVendorTypeName(VendorType Kind)
Get the canonical name for the Kind vendor.
Definition Triple.cpp:369
Triple(const char *Str)
Definition Triple.h:375
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:1011
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:1106
bool isArm64e() const
Tests whether the target is the Apple "arm64e" AArch64 subarch.
Definition Triple.h:1128
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:925
bool isOSBinFormatGOFF() const
Tests whether the OS uses the GOFF binary format.
Definition Triple.h:783
bool isWindowsGNUEnvironment() const
Definition Triple.h:725
LLVM_ABI void setVendorName(StringRef Str)
Set the vendor (second) component of the triple by name.
Definition Triple.cpp:1958
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:1975
bool isAndroid() const
Tests whether the target is Android.
Definition Triple.h:821
bool hasDefaultTLSDESC() const
True if the target uses TLSDESC by default.
Definition Triple.h:1187
bool isLFI() const
Tests whether the target is LFI.
Definition Triple.h:918
LLVM_ABI llvm::Triple get64BitArchVariant() const
Form a triple with a 64-bit variant of the current architecture.
Definition Triple.cpp:2199
bool isOSMSVCRT() const
Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
Definition Triple.h:735
bool isOSBinFormatMachO() const
Tests whether the environment is MachO.
Definition Triple.h:786
LLVM_ABI bool isLittleEndian() const
Tests whether the target triple is little endian.
Definition Triple.cpp:2457
LLVM_ABI void setEnvironment(EnvironmentType Kind)
Set the environment (fourth) component of the triple to a known type.
Definition Triple.cpp:1936
bool isABIN32() const
Definition Triple.h:1134
LLVM_ABI StringRef getOSName() const
Get the operating system (third) component of the triple.
Definition Triple.cpp:1676
bool isAVR() const
Definition Triple.h:1021
bool supportsCOMDAT() const
Tests whether the target supports comdat.
Definition Triple.h:1173
bool isWindowsCoreCLREnvironment() const
Definition Triple.h:713
bool isSPIROrSPIRV() const
Definition Triple.h:892
LLVM_ABI ExceptionHandling getDefaultExceptionHandling() const
Definition Triple.cpp:2706
bool isMIPS64() const
Tests whether the target is MIPS 64-bit (little and big endian).
Definition Triple.h:1038
@ loongarch32
Definition Triple.h:64
@ renderscript64
Definition Triple.h:115
@ UnknownArch
Definition Triple.h:50
@ loongarch64
Definition Triple.h:65
@ renderscript32
Definition Triple.h:114
bool hasDefaultDataSections() const
Tests whether the target uses -data-sections as default.
Definition Triple.h:1192
bool isTargetGNUAEABI() const
Definition Triple.h:953
bool isOSSolaris() const
Definition Triple.h:665
bool isOSH2() const
Tests whether the OS is H2.
Definition Triple.h:774
bool isRISCV32() const
Tests whether the target is 32-bit RISC-V.
Definition Triple.h:1079
bool isOSKFreeBSD() const
Tests whether the OS is kFreeBSD.
Definition Triple.h:744
LLVM_ABI void setTriple(const Twine &Str)
Set all components to the new triple Str.
Definition Triple.cpp:1924
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:1699
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:1436
static LLVM_ABI ArchType getArchTypeForLLVMName(StringRef Str)
The canonical type for the given LLVM architecture name (e.g., "x86").
Definition Triple.cpp:671
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:1052
ArchType getArch() const
Get the parsed architecture type of this triple.
Definition Triple.h:425
LLVM_ABI bool operator==(const Triple &Other) const
Definition Triple.cpp:24
LLVM_ABI unsigned getTrampolineSize() const
Returns the trampoline size in bytes for this configuration.
Definition Triple.cpp:2055
bool isOSBinFormatCOFF() const
Tests whether the OS uses the COFF binary format.
Definition Triple.h:780
bool isRISCV64() const
Tests whether the target is 64-bit RISC-V.
Definition Triple.h:1084
bool isCSKY() const
Definition Triple.h:1125
bool isLoongArch64() const
Tests whether the target is 64-bit LoongArch.
Definition Triple.h:1027
LLVM_ABI StringRef getEnvironmentName() const
Get the optional environment (fourth) component of the triple, or "" if empty.
Definition Triple.cpp:1682
bool isSPARC32() const
Tests whether the target is 32-bit SPARC (little and big endian).
Definition Triple.h:1092
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:1911
const std::string & str() const
Definition Triple.h:490
bool isOSzOS() const
Definition Triple.h:620
bool isOSSerenity() const
Definition Triple.h:768
bool isOHOSFamily() const
Tests whether the target is OHOS LiteOS default enviroment is also OHOS, but omited on triple.
Definition Triple.h:851
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:1886
bool isOSUnknown() const
Definition Triple.h:669
LLVM_ABI VersionTuple getDriverKitVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1874
static LLVM_ABI ArchType parseArch(StringRef Str)
Parse anything recognized as an architecture for the first field of the triple.
Definition Triple.cpp:809
bool isMIPS32() const
Tests whether the target is MIPS 32-bit (little and big endian).
Definition Triple.h:1033
bool isShaderModelOS() const
Definition Triple.h:860
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:866
bool isMusl() const
Tests whether the environment is musl-libc.
Definition Triple.h:836
const std::string & getTriple() const
Definition Triple.h:492
bool isOSWindowsOrUEFI() const
Tests whether the OS is Windows or UEFI.
Definition Triple.h:694
static LLVM_ABI StringRef getArchTypeName(ArchType Kind)
Get the canonical name for the Kind architecture.
Definition Triple.cpp:36
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:795
bool isGPU() const
Test whether the target triple is for a GPU.
Definition Triple.h:1285
bool isOSBinFormatXCOFF() const
Tests whether the OS uses the XCOFF binary format.
Definition Triple.h:792
static LLVM_ABI StringRef getOSTypeName(OSType Kind)
Get the canonical name for the Kind operating system.
Definition Triple.cpp:409
bool isTargetMuslAEABI() const
Definition Triple.h:961
@ UnknownObjectFormat
Definition Triple.h:332
bool isARM() const
Tests whether the target is ARM (little and big endian).
Definition Triple.h:913
LLVM_ABI std::string merge(const Triple &Other) const
Merge target triples.
Definition Triple.cpp:2555
bool isArmMClass() const
Tests whether the target is an M-class.
Definition Triple.h:989
bool isOSLinux() const
Tests whether the OS is Linux.
Definition Triple.h:741
bool isBridgeOS() const
Is this an Apple BridgeOS triple.
Definition Triple.h:615
bool isOSManagarm() const
Definition Triple.h:864
bool isRISCV() const
Tests whether the target is RISC-V (32- and 64-bit).
Definition Triple.h:1089
bool isAMDGCN() const
Tests whether the target is AMDGCN.
Definition Triple.h:903
bool isAMDGPU() const
Definition Triple.h:905
bool isLoongArch32() const
Tests whether the target is 32-bit LoongArch.
Definition Triple.h:1024
bool isOSLiteOS() const
Definition Triple.h:855
@ UnknownVendor
Definition Triple.h:193
@ ImaginationTechnologies
Definition Triple.h:200
@ LastVendorType
Definition Triple.h:210
@ MipsTechnologies
Definition Triple.h:201
bool isNVPTX() const
Tests whether the target is NVPTX (32- or 64-bit).
Definition Triple.h:898
bool isOSAIX() const
Tests whether the OS is AIX.
Definition Triple.h:766
LLVM_ABI VersionTuple getMinimumSupportedOSVersion() const
Some platforms have different minimum supported OS versions that varies by the architecture specified...
Definition Triple.cpp:2581
LLVM_ABI bool isArch64Bit() const
Test whether the architecture is 64-bit.
Definition Triple.cpp:2073
LLVM_ABI StringRef getOSAndEnvironmentName() const
Get the operating system and optional environment components as a single string (separated by a '-' i...
Definition Triple.cpp:1688
@ ARMSubArch_v6t2
Definition Triple.h:153
@ MipsSubArch_r6
Definition Triple.h:166
@ DXILSubArch_v1_2
Definition Triple.h:182
@ ARMSubArch_v7
Definition Triple.h:144
@ ARMSubArch_v8m_mainline
Definition Triple.h:142
@ ARMSubArch_v9_6a
Definition Triple.h:123
@ ARMSubArch_v8r
Definition Triple.h:140
@ ARMSubArch_v9_1a
Definition Triple.h:128
@ DXILSubArch_v1_1
Definition Triple.h:181
@ LatestDXILSubArch
Definition Triple.h:190
@ SPIRVSubArch_v10
Definition Triple.h:171
@ SPIRVSubArch_v13
Definition Triple.h:174
@ ARMSubArch_v7k
Definition Triple.h:148
@ ARMSubArch_v8_7a
Definition Triple.h:132
@ ARMSubArch_v8
Definition Triple.h:139
@ SPIRVSubArch_v16
Definition Triple.h:177
@ ARMSubArch_v8_1a
Definition Triple.h:138
@ ARMSubArch_v9_2a
Definition Triple.h:127
@ DXILSubArch_v1_3
Definition Triple.h:183
@ SPIRVSubArch_v15
Definition Triple.h:176
@ ARMSubArch_v7m
Definition Triple.h:146
@ ARMSubArch_v9_7a
Definition Triple.h:122
@ ARMSubArch_v6k
Definition Triple.h:152
@ ARMSubArch_v5
Definition Triple.h:154
@ AArch64SubArch_arm64e
Definition Triple.h:158
@ ARMSubArch_v6
Definition Triple.h:150
@ ARMSubArch_v9_5a
Definition Triple.h:124
@ ARMSubArch_v7ve
Definition Triple.h:149
@ ARMSubArch_v8m_baseline
Definition Triple.h:141
@ ARMSubArch_v8_8a
Definition Triple.h:131
@ ARMSubArch_v8_2a
Definition Triple.h:137
@ ARMSubArch_v7s
Definition Triple.h:147
@ DXILSubArch_v1_0
Definition Triple.h:180
@ DXILSubArch_v1_7
Definition Triple.h:187
@ KalimbaSubArch_v3
Definition Triple.h:162
@ DXILSubArch_v1_5
Definition Triple.h:185
@ ARMSubArch_v8_4a
Definition Triple.h:135
@ ARMSubArch_v8_9a
Definition Triple.h:130
@ ARMSubArch_v7em
Definition Triple.h:145
@ SPIRVSubArch_v12
Definition Triple.h:173
@ SPIRVSubArch_v14
Definition Triple.h:175
@ KalimbaSubArch_v4
Definition Triple.h:163
@ ARMSubArch_v8_1m_mainline
Definition Triple.h:143
@ ARMSubArch_v8_3a
Definition Triple.h:136
@ AArch64SubArch_arm64ec
Definition Triple.h:159
@ ARMSubArch_v8_6a
Definition Triple.h:133
@ ARMSubArch_v5te
Definition Triple.h:155
@ KalimbaSubArch_v5
Definition Triple.h:164
@ ARMSubArch_v4t
Definition Triple.h:156
@ DXILSubArch_v1_6
Definition Triple.h:186
@ DXILSubArch_v1_8
Definition Triple.h:188
@ ARMSubArch_v9_4a
Definition Triple.h:125
@ ARMSubArch_v8_5a
Definition Triple.h:134
@ AArch64SubArch_lfi
Definition Triple.h:160
@ ARMSubArch_v6m
Definition Triple.h:151
@ ARMSubArch_v9_3a
Definition Triple.h:126
@ DXILSubArch_v1_9
Definition Triple.h:189
@ ARMSubArch_v9
Definition Triple.h:129
@ DXILSubArch_v1_4
Definition Triple.h:184
@ SPIRVSubArch_v11
Definition Triple.h:172
@ PPCSubArch_spe
Definition Triple.h:168
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:1740
bool isSPARC64() const
Tests whether the target is 64-bit SPARC (big endian).
Definition Triple.h:1097
bool isWindowsCygwinEnvironment() const
Definition Triple.h:721
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:2675
Triple(StringRef Str)
Definition Triple.h:374
bool isMacOSX() const
Is this a Mac OS X triple.
Definition Triple.h:592
Triple(const std::string &Str)
Definition Triple.h:376
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:1970
LLVM_ABI void setOS(OSType Kind)
Set the operating system (third) component of the triple to a known type.
Definition Triple.cpp:1934
bool isX86_32() const
Tests whether the target is x86 (32-bit).
Definition Triple.h:1111
LLVM_ABI void setOSName(StringRef Str)
Set the operating system (third) component of the triple by name.
Definition Triple.cpp:1962
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:1153
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:1100
bool isPPC64() const
Tests whether the target is 64-bit PowerPC (little and big endian).
Definition Triple.h:1057
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:1200
bool isSPIRVLogical() const
Tests whether the target is SPIR-V Logical.
Definition Triple.h:895
static LLVM_ABI StringRef getEnvironmentTypeName(EnvironmentType Kind)
Get the canonical name for the Kind environment.
Definition Triple.cpp:517
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:756
bool isWindowsArm64EC() const
Definition Triple.h:708
bool isOSVersionGE(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
Definition Triple.h:567
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:1043
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:800
bool isOSGlibc() const
Tests whether the OS uses glibc.
Definition Triple.h:759
bool isTargetAEABI() const
Definition Triple.h:947
bool isPS() const
Tests whether the target is the PS4 or PS5 platform.
Definition Triple.h:818
bool isWasm() const
Tests whether the target is wasm (32- and 64-bit).
Definition Triple.h:1120
bool isVulkanOS() const
Definition Triple.h:862
LLVM_ABI StringRef getArchName() const
Get the architecture (first) component of the triple.
Definition Triple.cpp:1667
bool isOSIAMCU() const
Definition Triple.h:667
bool isOpenHOS() const
Definition Triple.h:853
bool isMacCatalystEnvironment() const
Definition Triple.h:645
bool isPS5() const
Tests whether the target is the PS5 platform.
Definition Triple.h:812
bool isSPIRV() const
Tests whether the target is SPIR-V (32/64-bit/Logical).
Definition Triple.h:886
bool isAArch64() const
Tests whether the target is AArch64 (little and big endian).
Definition Triple.h:1004
static LLVM_ABI StringRef getObjectFormatTypeName(ObjectFormatType ObjectFormat)
Get the name for the Object format.
Definition Triple.cpp:632
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:2081
LLVM_ABI llvm::Triple getBigEndianArchVariant() const
Form a triple with a big endian variant of the current architecture.
Definition Triple.cpp:2319
LLVM_ABI VersionTuple getiOSVersion() const
Parse the version number as with getOSVersion.
Definition Triple.cpp:1794
bool hasDefaultEmulatedTLS() const
Tests whether the target uses emulated TLS as default.
Definition Triple.h:1181
bool isSystemZ() const
Tests whether the target is SystemZ.
Definition Triple.h:1103
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:1703
bool isPPC32SecurePlt() const
Tests whether the target 32-bit PowerPC uses Secure PLT.
Definition Triple.h:1070
bool isTime64ABI() const
Tests if the target forces 64-bit time_t on a 32-bit architecture.
Definition Triple.h:1158
LLVM_ABI bool isArch32Bit() const
Test whether the architecture is 32-bit.
Definition Triple.cpp:2077
bool operator!=(const Triple &Other) const
Definition Triple.h:391
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:2520
bool isOSFuchsia() const
Definition Triple.h:661
bool isOSBinFormatELF() const
Tests whether the OS uses the ELF binary format.
Definition Triple.h:777
bool isWindowsMSVCEnvironment() const
Checks if the environment could be MSVC.
Definition Triple.h:702
bool hasEnvironment() const
Does this triple have the optional environment (fourth) component?
Definition Triple.h:437
LLVM_ABI unsigned getDefaultWCharSize() const
Returns the default wchar_t size (in bytes) for this target triple.
Definition Triple.cpp:2510
bool isKnownWindowsMSVCEnvironment() const
Checks if the environment is MSVC.
Definition Triple.h:697
static LLVM_ABI StringRef getArchTypePrefix(ArchType Kind)
Get the "prefix" canonical name for the Kind architecture.
Definition Triple.cpp:249
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:1926
bool isDXIL() const
Tests whether the target is DXIL.
Definition Triple.h:858
LLVM_ABI void setVendor(VendorType Kind)
Set the vendor (second) component of the triple to a known type.
Definition Triple.cpp:1930
bool isGNUEnvironment() const
Definition Triple.h:671
bool isLoongArch() const
Tests whether the target is LoongArch (32- and 64-bit).
Definition Triple.h:1030
bool isShaderStageEnvironment() const
Definition Triple.h:868
bool isWindowsItaniumEnvironment() const
Definition Triple.h:717
bool isVE() const
Tests whether the target is VE.
Definition Triple.h:1117
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
@ Other
Any other memory.
Definition ModRef.h:68
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:860