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