LLVM  9.0.0svn
Triple.h
Go to the documentation of this file.
1 //===-- llvm/ADT/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_ADT_TRIPLE_H
10 #define LLVM_ADT_TRIPLE_H
11 
12 #include "llvm/ADT/Twine.h"
13 
14 // Some system headers or GCC predefined macros conflict with identifiers in
15 // this file. Undefine them here.
16 #undef NetBSD
17 #undef mips
18 #undef sparc
19 
20 namespace llvm {
21 
22 /// Triple - Helper class for working with autoconf configuration names. For
23 /// historical reasons, we also call these 'triples' (they used to contain
24 /// exactly three fields).
25 ///
26 /// Configuration names are strings in the canonical form:
27 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
28 /// or
29 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
30 ///
31 /// This class is used for clients which want to support arbitrary
32 /// configuration names, but also want to implement certain special
33 /// behavior for particular configurations. This class isolates the mapping
34 /// from the components of the configuration name to well known IDs.
35 ///
36 /// At its core the Triple class is designed to be a wrapper for a triple
37 /// string; the constructor does not change or normalize the triple string.
38 /// Clients that need to handle the non-canonical triples that users often
39 /// specify should use the normalize method.
40 ///
41 /// See autoconf/config.guess for a glimpse into what configuration names
42 /// look like in practice.
43 class Triple {
44 public:
45  enum ArchType {
47 
48  arm, // ARM (little endian): arm, armv.*, xscale
49  armeb, // ARM (big endian): armeb
50  aarch64, // AArch64 (little endian): aarch64
51  aarch64_be, // AArch64 (big endian): aarch64_be
52  arc, // ARC: Synopsys ARC
53  avr, // AVR: Atmel AVR microcontroller
54  bpfel, // eBPF or extended BPF or 64-bit BPF (little endian)
55  bpfeb, // eBPF or extended BPF or 64-bit BPF (big endian)
56  hexagon, // Hexagon: hexagon
57  mips, // MIPS: mips, mipsallegrex, mipsr6
58  mipsel, // MIPSEL: mipsel, mipsallegrexe, mipsr6el
59  mips64, // MIPS64: mips64, mips64r6, mipsn32, mipsn32r6
60  mips64el, // MIPS64EL: mips64el, mips64r6el, mipsn32el, mipsn32r6el
61  msp430, // MSP430: msp430
62  ppc, // PPC: powerpc
63  ppc64, // PPC64: powerpc64, ppu
64  ppc64le, // PPC64LE: powerpc64le
65  r600, // R600: AMD GPUs HD2XXX - HD6XXX
66  amdgcn, // AMDGCN: AMD GCN GPUs
67  riscv32, // RISC-V (32-bit): riscv32
68  riscv64, // RISC-V (64-bit): riscv64
69  sparc, // Sparc: sparc
70  sparcv9, // Sparcv9: Sparcv9
71  sparcel, // Sparc: (endianness = little). NB: 'Sparcle' is a CPU variant
72  systemz, // SystemZ: s390x
73  tce, // TCE (http://tce.cs.tut.fi/): tce
74  tcele, // TCE little endian (http://tce.cs.tut.fi/): tcele
75  thumb, // Thumb (little endian): thumb, thumbv.*
76  thumbeb, // Thumb (big endian): thumbeb
77  x86, // X86: i[3-9]86
78  x86_64, // X86-64: amd64, x86_64
79  xcore, // XCore: xcore
80  nvptx, // NVPTX: 32-bit
81  nvptx64, // NVPTX: 64-bit
82  le32, // le32: generic little-endian 32-bit CPU (PNaCl)
83  le64, // le64: generic little-endian 64-bit CPU (PNaCl)
84  amdil, // AMDIL
85  amdil64, // AMDIL with 64-bit pointers
86  hsail, // AMD HSAIL
87  hsail64, // AMD HSAIL with 64-bit pointers
88  spir, // SPIR: standard portable IR for OpenCL 32-bit version
89  spir64, // SPIR: standard portable IR for OpenCL 64-bit version
90  kalimba, // Kalimba: generic kalimba
91  shave, // SHAVE: Movidius vector VLIW processors
92  lanai, // Lanai: Lanai 32-bit
93  wasm32, // WebAssembly with 32-bit pointers
94  wasm64, // WebAssembly with 64-bit pointers
95  renderscript32, // 32-bit RenderScript
96  renderscript64, // 64-bit RenderScript
98  };
99  enum SubArchType {
101 
124 
128 
130  };
131  enum VendorType {
133 
135  PC,
151  };
152  enum OSType {
154 
164  Lv2, // PS3
173  NaCl, // Native Client
174  CNK, // BG/P Compute-Node Kernel
176  CUDA, // NVIDIA CUDA
177  NVCL, // NVIDIA OpenCL
178  AMDHSA, // AMD HSA Runtime
181  TvOS, // Apple tvOS
182  WatchOS, // Apple watchOS
185  AMDPAL, // AMD PAL Runtime
186  HermitCore, // HermitCore Unikernel/Multikernel
187  Hurd, // GNU/Hurd
188  WASI, // Experimental WebAssembly OS
190  };
193 
207 
212  Simulator, // Simulator variants of other systems, e.g., Apple's iOS
214  };
217 
222  };
223 
224 private:
225  std::string Data;
226 
227  /// The parsed arch type.
228  ArchType Arch;
229 
230  /// The parsed subarchitecture type.
231  SubArchType SubArch;
232 
233  /// The parsed vendor type.
234  VendorType Vendor;
235 
236  /// The parsed OS type.
237  OSType OS;
238 
239  /// The parsed Environment type.
240  EnvironmentType Environment;
241 
242  /// The object format type.
243  ObjectFormatType ObjectFormat;
244 
245 public:
246  /// @name Constructors
247  /// @{
248 
249  /// Default constructor is the same as an empty string and leaves all
250  /// triple fields unknown.
252  : Data(), Arch(), SubArch(), Vendor(), OS(), Environment(),
253  ObjectFormat() {}
254 
255  explicit Triple(const Twine &Str);
256  Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
257  Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
258  const Twine &EnvironmentStr);
259 
260  bool operator==(const Triple &Other) const {
261  return Arch == Other.Arch && SubArch == Other.SubArch &&
262  Vendor == Other.Vendor && OS == Other.OS &&
263  Environment == Other.Environment &&
264  ObjectFormat == Other.ObjectFormat;
265  }
266 
267  bool operator!=(const Triple &Other) const {
268  return !(*this == Other);
269  }
270 
271  /// @}
272  /// @name Normalization
273  /// @{
274 
275  /// normalize - Turn an arbitrary machine specification into the canonical
276  /// triple form (or something sensible that the Triple class understands if
277  /// nothing better can reasonably be done). In particular, it handles the
278  /// common case in which otherwise valid components are in the wrong order.
279  static std::string normalize(StringRef Str);
280 
281  /// Return the normalized form of this triple's string.
282  std::string normalize() const { return normalize(Data); }
283 
284  /// @}
285  /// @name Typed Component Access
286  /// @{
287 
288  /// getArch - Get the parsed architecture type of this triple.
289  ArchType getArch() const { return Arch; }
290 
291  /// getSubArch - get the parsed subarchitecture type for this triple.
292  SubArchType getSubArch() const { return SubArch; }
293 
294  /// getVendor - Get the parsed vendor type of this triple.
295  VendorType getVendor() const { return Vendor; }
296 
297  /// getOS - Get the parsed operating system type of this triple.
298  OSType getOS() const { return OS; }
299 
300  /// hasEnvironment - Does this triple have the optional environment
301  /// (fourth) component?
302  bool hasEnvironment() const {
303  return getEnvironmentName() != "";
304  }
305 
306  /// getEnvironment - Get the parsed environment type of this triple.
307  EnvironmentType getEnvironment() const { return Environment; }
308 
309  /// Parse the version number from the OS name component of the
310  /// triple, if present.
311  ///
312  /// For example, "fooos1.2.3" would return (1, 2, 3).
313  ///
314  /// If an entry is not defined, it will be returned as 0.
315  void getEnvironmentVersion(unsigned &Major, unsigned &Minor,
316  unsigned &Micro) const;
317 
318  /// getFormat - Get the object format for this triple.
319  ObjectFormatType getObjectFormat() const { return ObjectFormat; }
320 
321  /// getOSVersion - Parse the version number from the OS name component of the
322  /// triple, if present.
323  ///
324  /// For example, "fooos1.2.3" would return (1, 2, 3).
325  ///
326  /// If an entry is not defined, it will be returned as 0.
327  void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
328 
329  /// getOSMajorVersion - Return just the major version number, this is
330  /// specialized because it is a common query.
331  unsigned getOSMajorVersion() const {
332  unsigned Maj, Min, Micro;
333  getOSVersion(Maj, Min, Micro);
334  return Maj;
335  }
336 
337  /// getMacOSXVersion - Parse the version number as with getOSVersion and then
338  /// translate generic "darwin" versions to the corresponding OS X versions.
339  /// This may also be called with IOS triples but the OS X version number is
340  /// just set to a constant 10.4.0 in that case. Returns true if successful.
341  bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
342  unsigned &Micro) const;
343 
344  /// getiOSVersion - Parse the version number as with getOSVersion. This should
345  /// only be called with IOS or generic triples.
346  void getiOSVersion(unsigned &Major, unsigned &Minor,
347  unsigned &Micro) const;
348 
349  /// getWatchOSVersion - Parse the version number as with getOSVersion. This
350  /// should only be called with WatchOS or generic triples.
351  void getWatchOSVersion(unsigned &Major, unsigned &Minor,
352  unsigned &Micro) const;
353 
354  /// @}
355  /// @name Direct Component Access
356  /// @{
357 
358  const std::string &str() const { return Data; }
359 
360  const std::string &getTriple() const { return Data; }
361 
362  /// getArchName - Get the architecture (first) component of the
363  /// triple.
364  StringRef getArchName() const;
365 
366  /// getVendorName - Get the vendor (second) component of the triple.
367  StringRef getVendorName() const;
368 
369  /// getOSName - Get the operating system (third) component of the
370  /// triple.
371  StringRef getOSName() const;
372 
373  /// getEnvironmentName - Get the optional environment (fourth)
374  /// component of the triple, or "" if empty.
376 
377  /// getOSAndEnvironmentName - Get the operating system and optional
378  /// environment components as a single string (separated by a '-'
379  /// if the environment component is present).
381 
382  /// @}
383  /// @name Convenience Predicates
384  /// @{
385 
386  /// Test whether the architecture is 64-bit
387  ///
388  /// Note that this tests for 64-bit pointer width, and nothing else. Note
389  /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
390  /// 16-bit. The inner details of pointer width for particular architectures
391  /// is not summed up in the triple, and so only a coarse grained predicate
392  /// system is provided.
393  bool isArch64Bit() const;
394 
395  /// Test whether the architecture is 32-bit
396  ///
397  /// Note that this tests for 32-bit pointer width, and nothing else.
398  bool isArch32Bit() const;
399 
400  /// Test whether the architecture is 16-bit
401  ///
402  /// Note that this tests for 16-bit pointer width, and nothing else.
403  bool isArch16Bit() const;
404 
405  /// isOSVersionLT - Helper function for doing comparisons against version
406  /// numbers included in the target triple.
407  bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
408  unsigned Micro = 0) const {
409  unsigned LHS[3];
410  getOSVersion(LHS[0], LHS[1], LHS[2]);
411 
412  if (LHS[0] != Major)
413  return LHS[0] < Major;
414  if (LHS[1] != Minor)
415  return LHS[1] < Minor;
416  if (LHS[2] != Micro)
417  return LHS[2] < Micro;
418 
419  return false;
420  }
421 
422  bool isOSVersionLT(const Triple &Other) const {
423  unsigned RHS[3];
424  Other.getOSVersion(RHS[0], RHS[1], RHS[2]);
425  return isOSVersionLT(RHS[0], RHS[1], RHS[2]);
426  }
427 
428  /// isMacOSXVersionLT - Comparison function for checking OS X version
429  /// compatibility, which handles supporting skewed version numbering schemes
430  /// used by the "darwin" triples.
431  bool isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
432  unsigned Micro = 0) const {
433  assert(isMacOSX() && "Not an OS X triple!");
434 
435  // If this is OS X, expect a sane version number.
436  if (getOS() == Triple::MacOSX)
437  return isOSVersionLT(Major, Minor, Micro);
438 
439  // Otherwise, compare to the "Darwin" number.
440  assert(Major == 10 && "Unexpected major version");
441  return isOSVersionLT(Minor + 4, Micro, 0);
442  }
443 
444  /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
445  /// "darwin" and "osx" as OS X triples.
446  bool isMacOSX() const {
447  return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
448  }
449 
450  /// Is this an iOS triple.
451  /// Note: This identifies tvOS as a variant of iOS. If that ever
452  /// changes, i.e., if the two operating systems diverge or their version
453  /// numbers get out of sync, that will need to be changed.
454  /// watchOS has completely different version numbers so it is not included.
455  bool isiOS() const {
456  return getOS() == Triple::IOS || isTvOS();
457  }
458 
459  /// Is this an Apple tvOS triple.
460  bool isTvOS() const {
461  return getOS() == Triple::TvOS;
462  }
463 
464  /// Is this an Apple watchOS triple.
465  bool isWatchOS() const {
466  return getOS() == Triple::WatchOS;
467  }
468 
469  bool isWatchABI() const {
471  }
472 
473  /// isOSDarwin - Is this a "Darwin" OS (OS X, iOS, or watchOS).
474  bool isOSDarwin() const {
475  return isMacOSX() || isiOS() || isWatchOS();
476  }
477 
478  bool isSimulatorEnvironment() const {
479  return getEnvironment() == Triple::Simulator;
480  }
481 
482  bool isOSNetBSD() const {
483  return getOS() == Triple::NetBSD;
484  }
485 
486  bool isOSOpenBSD() const {
487  return getOS() == Triple::OpenBSD;
488  }
489 
490  bool isOSFreeBSD() const {
491  return getOS() == Triple::FreeBSD;
492  }
493 
494  bool isOSFuchsia() const {
495  return getOS() == Triple::Fuchsia;
496  }
497 
498  bool isOSDragonFly() const { return getOS() == Triple::DragonFly; }
499 
500  bool isOSSolaris() const {
501  return getOS() == Triple::Solaris;
502  }
503 
504  bool isOSIAMCU() const {
505  return getOS() == Triple::ELFIAMCU;
506  }
507 
508  bool isOSUnknown() const { return getOS() == Triple::UnknownOS; }
509 
510  bool isGNUEnvironment() const {
512  return Env == Triple::GNU || Env == Triple::GNUABIN32 ||
513  Env == Triple::GNUABI64 || Env == Triple::GNUEABI ||
514  Env == Triple::GNUEABIHF || Env == Triple::GNUX32;
515  }
516 
517  bool isOSContiki() const {
518  return getOS() == Triple::Contiki;
519  }
520 
521  /// Tests whether the OS is Haiku.
522  bool isOSHaiku() const {
523  return getOS() == Triple::Haiku;
524  }
525 
526  /// Tests whether the OS is Windows.
527  bool isOSWindows() const {
528  return getOS() == Triple::Win32;
529  }
530 
531  /// Checks if the environment is MSVC.
533  return isOSWindows() && getEnvironment() == Triple::MSVC;
534  }
535 
536  /// Checks if the environment could be MSVC.
540  }
541 
543  return isOSWindows() && getEnvironment() == Triple::CoreCLR;
544  }
545 
547  return isOSWindows() && getEnvironment() == Triple::Itanium;
548  }
549 
551  return isOSWindows() && getEnvironment() == Triple::Cygnus;
552  }
553 
554  bool isWindowsGNUEnvironment() const {
555  return isOSWindows() && getEnvironment() == Triple::GNU;
556  }
557 
558  /// Tests for either Cygwin or MinGW OS
559  bool isOSCygMing() const {
561  }
562 
563  /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
564  bool isOSMSVCRT() const {
567  }
568 
569  /// Tests whether the OS is NaCl (Native Client)
570  bool isOSNaCl() const {
571  return getOS() == Triple::NaCl;
572  }
573 
574  /// Tests whether the OS is Linux.
575  bool isOSLinux() const {
576  return getOS() == Triple::Linux;
577  }
578 
579  /// Tests whether the OS is kFreeBSD.
580  bool isOSKFreeBSD() const {
581  return getOS() == Triple::KFreeBSD;
582  }
583 
584  /// Tests whether the OS is Hurd.
585  bool isOSHurd() const {
586  return getOS() == Triple::Hurd;
587  }
588 
589  /// Tests whether the OS is WASI.
590  bool isOSWASI() const {
591  return getOS() == Triple::WASI;
592  }
593 
594  /// Tests whether the OS uses glibc.
595  bool isOSGlibc() const {
596  return (getOS() == Triple::Linux || getOS() == Triple::KFreeBSD ||
597  getOS() == Triple::Hurd) &&
598  !isAndroid();
599  }
600 
601  /// Tests whether the OS uses the ELF binary format.
602  bool isOSBinFormatELF() const {
603  return getObjectFormat() == Triple::ELF;
604  }
605 
606  /// Tests whether the OS uses the COFF binary format.
607  bool isOSBinFormatCOFF() const {
608  return getObjectFormat() == Triple::COFF;
609  }
610 
611  /// Tests whether the environment is MachO.
612  bool isOSBinFormatMachO() const {
613  return getObjectFormat() == Triple::MachO;
614  }
615 
616  /// Tests whether the OS uses the Wasm binary format.
617  bool isOSBinFormatWasm() const {
618  return getObjectFormat() == Triple::Wasm;
619  }
620 
621  /// Tests whether the target is the PS4 CPU
622  bool isPS4CPU() const {
623  return getArch() == Triple::x86_64 &&
624  getVendor() == Triple::SCEI &&
625  getOS() == Triple::PS4;
626  }
627 
628  /// Tests whether the target is the PS4 platform
629  bool isPS4() const {
630  return getVendor() == Triple::SCEI &&
631  getOS() == Triple::PS4;
632  }
633 
634  /// Tests whether the target is Android
635  bool isAndroid() const { return getEnvironment() == Triple::Android; }
636 
637  bool isAndroidVersionLT(unsigned Major) const {
638  assert(isAndroid() && "Not an Android triple!");
639 
640  unsigned Env[3];
641  getEnvironmentVersion(Env[0], Env[1], Env[2]);
642 
643  // 64-bit targets did not exist before API level 21 (Lollipop).
644  if (isArch64Bit() && Env[0] < 21)
645  Env[0] = 21;
646 
647  return Env[0] < Major;
648  }
649 
650  /// Tests whether the environment is musl-libc
651  bool isMusl() const {
652  return getEnvironment() == Triple::Musl ||
655  }
656 
657  /// Tests whether the target is NVPTX (32- or 64-bit).
658  bool isNVPTX() const {
659  return getArch() == Triple::nvptx || getArch() == Triple::nvptx64;
660  }
661 
662  /// Tests whether the target is Thumb (little and big endian).
663  bool isThumb() const {
664  return getArch() == Triple::thumb || getArch() == Triple::thumbeb;
665  }
666 
667  /// Tests whether the target is ARM (little and big endian).
668  bool isARM() const {
669  return getArch() == Triple::arm || getArch() == Triple::armeb;
670  }
671 
672  /// Tests whether the target is AArch64 (little and big endian).
673  bool isAArch64() const {
675  }
676 
677  /// Tests whether the target is MIPS 32-bit (little and big endian).
678  bool isMIPS32() const {
679  return getArch() == Triple::mips || getArch() == Triple::mipsel;
680  }
681 
682  /// Tests whether the target is MIPS 64-bit (little and big endian).
683  bool isMIPS64() const {
684  return getArch() == Triple::mips64 || getArch() == Triple::mips64el;
685  }
686 
687  /// Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
688  bool isMIPS() const {
689  return isMIPS32() || isMIPS64();
690  }
691 
692  /// Tests whether the target supports comdat
693  bool supportsCOMDAT() const {
694  return !isOSBinFormatMachO();
695  }
696 
697  /// Tests whether the target uses emulated TLS as default.
698  bool hasDefaultEmulatedTLS() const {
700  }
701 
702  /// @}
703  /// @name Mutators
704  /// @{
705 
706  /// setArch - Set the architecture (first) component of the triple
707  /// to a known type.
708  void setArch(ArchType Kind);
709 
710  /// setVendor - Set the vendor (second) component of the triple to a
711  /// known type.
712  void setVendor(VendorType Kind);
713 
714  /// setOS - Set the operating system (third) component of the triple
715  /// to a known type.
716  void setOS(OSType Kind);
717 
718  /// setEnvironment - Set the environment (fourth) component of the triple
719  /// to a known type.
720  void setEnvironment(EnvironmentType Kind);
721 
722  /// setObjectFormat - Set the object file format
724 
725  /// setTriple - Set all components to the new triple \p Str.
726  void setTriple(const Twine &Str);
727 
728  /// setArchName - Set the architecture (first) component of the
729  /// triple by name.
730  void setArchName(StringRef Str);
731 
732  /// setVendorName - Set the vendor (second) component of the triple
733  /// by name.
734  void setVendorName(StringRef Str);
735 
736  /// setOSName - Set the operating system (third) component of the
737  /// triple by name.
738  void setOSName(StringRef Str);
739 
740  /// setEnvironmentName - Set the optional environment (fourth)
741  /// component of the triple by name.
742  void setEnvironmentName(StringRef Str);
743 
744  /// setOSAndEnvironmentName - Set the operating system and optional
745  /// environment components with a single string.
747 
748  /// @}
749  /// @name Helpers to build variants of a particular triple.
750  /// @{
751 
752  /// Form a triple with a 32-bit variant of the current architecture.
753  ///
754  /// This can be used to move across "families" of architectures where useful.
755  ///
756  /// \returns A new triple with a 32-bit architecture or an unknown
757  /// architecture if no such variant can be found.
759 
760  /// Form a triple with a 64-bit variant of the current architecture.
761  ///
762  /// This can be used to move across "families" of architectures where useful.
763  ///
764  /// \returns A new triple with a 64-bit architecture or an unknown
765  /// architecture if no such variant can be found.
767 
768  /// Form a triple with a big endian variant of the current architecture.
769  ///
770  /// This can be used to move across "families" of architectures where useful.
771  ///
772  /// \returns A new triple with a big endian architecture or an unknown
773  /// architecture if no such variant can be found.
775 
776  /// Form a triple with a little endian variant of the current architecture.
777  ///
778  /// This can be used to move across "families" of architectures where useful.
779  ///
780  /// \returns A new triple with a little endian architecture or an unknown
781  /// architecture if no such variant can be found.
783 
784  /// Get the (LLVM) name of the minimum ARM CPU for the arch we are targeting.
785  ///
786  /// \param Arch the architecture name (e.g., "armv7s"). If it is an empty
787  /// string then the triple's arch name is used.
789 
790  /// Tests whether the target triple is little endian.
791  ///
792  /// \returns true if the triple is little endian, false otherwise.
793  bool isLittleEndian() const;
794 
795  /// Test whether target triples are compatible.
796  bool isCompatibleWith(const Triple &Other) const;
797 
798  /// Merge target triples.
799  std::string merge(const Triple &Other) const;
800 
801  /// @}
802  /// @name Static helpers for IDs.
803  /// @{
804 
805  /// getArchTypeName - Get the canonical name for the \p Kind architecture.
806  static StringRef getArchTypeName(ArchType Kind);
807 
808  /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
809  /// architecture. This is the prefix used by the architecture specific
810  /// builtins, and is suitable for passing to \see
811  /// Intrinsic::getIntrinsicForGCCBuiltin().
812  ///
813  /// \return - The architecture prefix, or 0 if none is defined.
814  static StringRef getArchTypePrefix(ArchType Kind);
815 
816  /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
818 
819  /// getOSTypeName - Get the canonical name for the \p Kind operating system.
820  static StringRef getOSTypeName(OSType Kind);
821 
822  /// getEnvironmentTypeName - Get the canonical name for the \p Kind
823  /// environment.
825 
826  /// @}
827  /// @name Static helpers for converting alternate architecture names.
828  /// @{
829 
830  /// getArchTypeForLLVMName - The canonical type for the given LLVM
831  /// architecture name (e.g., "x86").
833 
834  /// @}
835 };
836 
837 } // End llvm namespace
838 
839 
840 #endif
bool isOSDarwin() const
isOSDarwin - Is this a "Darwin" OS (OS X, iOS, or watchOS).
Definition: Triple.h:474
bool isOSHaiku() const
Tests whether the OS is Haiku.
Definition: Triple.h:522
void getiOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const
getiOSVersion - Parse the version number as with getOSVersion.
Definition: Triple.cpp:1091
bool isMIPS64() const
Tests whether the target is MIPS 64-bit (little and big endian).
Definition: Triple.h:683
bool isOSMSVCRT() const
Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
Definition: Triple.h:564
bool supportsCOMDAT() const
Tests whether the target supports comdat.
Definition: Triple.h:693
static StringRef getVendorTypeName(VendorType Kind)
getVendorTypeName - Get the canonical name for the Kind vendor.
Definition: Triple.cpp:148
This class represents lattice values for constants.
Definition: AllocatorList.h:23
bool isMacOSX() const
isMacOSX - Is this a Mac OS X triple.
Definition: Triple.h:446
bool isOSBinFormatELF() const
Tests whether the OS uses the ELF binary format.
Definition: Triple.h:602
OSType getOS() const
getOS - Get the parsed operating system type of this triple.
Definition: Triple.h:298
void setVendor(VendorType Kind)
setVendor - Set the vendor (second) component of the triple to a known type.
Definition: Triple.cpp:1149
bool isArch16Bit() const
Test whether the architecture is 16-bit.
Definition: Triple.cpp:1276
bool isOSNaCl() const
Tests whether the OS is NaCl (Native Client)
Definition: Triple.h:570
bool isWatchOS() const
Is this an Apple watchOS triple.
Definition: Triple.h:465
bool hasEnvironment() const
hasEnvironment - Does this triple have the optional environment (fourth) component?
Definition: Triple.h:302
void setOS(OSType Kind)
setOS - Set the operating system (third) component of the triple to a known type. ...
Definition: Triple.cpp:1153
bool isOSFuchsia() const
Definition: Triple.h:494
void setEnvironment(EnvironmentType Kind)
setEnvironment - Set the environment (fourth) component of the triple to a known type.
Definition: Triple.cpp:1157
void getEnvironmentVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const
Parse the version number from the OS name component of the triple, if present.
Definition: Triple.cpp:1027
bool isWindowsCygwinEnvironment() const
Definition: Triple.h:550
StringRef getARMCPUForArch(StringRef Arch=StringRef()) const
Get the (LLVM) name of the minimum ARM CPU for the arch we are targeting.
Definition: Triple.cpp:1568
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
bool isAArch64() const
Tests whether the target is AArch64 (little and big endian).
Definition: Triple.h:673
static StringRef getArchTypeName(ArchType Kind)
getArchTypeName - Get the canonical name for the Kind architecture.
Definition: Triple.cpp:19
bool isKnownWindowsMSVCEnvironment() const
Checks if the environment is MSVC.
Definition: Triple.h:532
bool isOSHurd() const
Tests whether the OS is Hurd.
Definition: Triple.h:585
bool hasDefaultEmulatedTLS() const
Tests whether the target uses emulated TLS as default.
Definition: Triple.h:698
void setVendorName(StringRef Str)
setVendorName - Set the vendor (second) component of the triple by name.
Definition: Triple.cpp:1184
bool isOSSolaris() const
Definition: Triple.h:500
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:810
Triple()
Default constructor is the same as an empty string and leaves all triple fields unknown.
Definition: Triple.h:251
SubArchType getSubArch() const
getSubArch - get the parsed subarchitecture type for this triple.
Definition: Triple.h:292
ArchType getArch() const
getArch - Get the parsed architecture type of this triple.
Definition: Triple.h:289
bool isArch32Bit() const
Test whether the architecture is 32-bit.
Definition: Triple.cpp:1272
bool isiOS() const
Is this an iOS triple.
Definition: Triple.h:455
bool isPS4() const
Tests whether the target is the PS4 platform.
Definition: Triple.h:629
bool isOSWASI() const
Tests whether the OS is WASI.
Definition: Triple.h:590
bool isOSNetBSD() const
Definition: Triple.h:482
bool isWindowsItaniumEnvironment() const
Definition: Triple.h:546
bool isWindowsGNUEnvironment() const
Definition: Triple.h:554
static StringRef getOSTypeName(OSType Kind)
getOSTypeName - Get the canonical name for the Kind operating system.
Definition: Triple.cpp:173
bool isWindowsCoreCLREnvironment() const
Definition: Triple.h:542
const std::string & str() const
Definition: Triple.h:358
bool isOSDragonFly() const
Definition: Triple.h:498
bool isOSWindows() const
Tests whether the OS is Windows.
Definition: Triple.h:527
void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const
getOSVersion - Parse the version number from the OS name component of the triple, if present...
Definition: Triple.cpp:1037
bool isMusl() const
Tests whether the environment is musl-libc.
Definition: Triple.h:651
void setObjectFormat(ObjectFormatType Kind)
setObjectFormat - Set the object file format
Definition: Triple.cpp:1165
StringRef getOSAndEnvironmentName() const
getOSAndEnvironmentName - Get the operating system and optional environment components as a single st...
Definition: Triple.cpp:987
llvm::Triple get32BitArchVariant() const
Form a triple with a 32-bit variant of the current architecture.
Definition: Triple.cpp:1280
bool isLittleEndian() const
Tests whether the target triple is little endian.
Definition: Triple.cpp:1492
VendorType getVendor() const
getVendor - Get the parsed vendor type of this triple.
Definition: Triple.h:295
bool isOSBinFormatCOFF() const
Tests whether the OS uses the COFF binary format.
Definition: Triple.h:607
void setEnvironmentName(StringRef Str)
setEnvironmentName - Set the optional environment (fourth) component of the triple by name...
Definition: Triple.cpp:1196
bool isOSOpenBSD() const
Definition: Triple.h:486
llvm::Triple getBigEndianArchVariant() const
Form a triple with a big endian variant of the current architecture.
Definition: Triple.cpp:1406
bool isWatchABI() const
Definition: Triple.h:469
void setTriple(const Twine &Str)
setTriple - Set all components to the new triple Str.
Definition: Triple.cpp:1141
bool operator==(const Triple &Other) const
Definition: Triple.h:260
bool isCompatibleWith(const Triple &Other) const
Test whether target triples are compatible.
Definition: Triple.cpp:1535
static StringRef getArchTypePrefix(ArchType Kind)
getArchTypePrefix - Get the "prefix" canonical name for the Kind architecture.
Definition: Triple.cpp:77
bool operator!=(const Triple &Other) const
Definition: Triple.h:267
bool isAndroidVersionLT(unsigned Major) const
Definition: Triple.h:637
bool isPS4CPU() const
Tests whether the target is the PS4 CPU.
Definition: Triple.h:622
void getWatchOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const
getWatchOSVersion - Parse the version number as with getOSVersion.
Definition: Triple.cpp:1117
bool isOSKFreeBSD() const
Tests whether the OS is kFreeBSD.
Definition: Triple.h:580
void setArchName(StringRef Str)
setArchName - Set the architecture (first) component of the triple by name.
Definition: Triple.cpp:1173
bool isOSBinFormatMachO() const
Tests whether the environment is MachO.
Definition: Triple.h:612
void setOSName(StringRef Str)
setOSName - Set the operating system (third) component of the triple by name.
Definition: Triple.cpp:1188
unsigned getOSMajorVersion() const
getOSMajorVersion - Return just the major version number, this is specialized because it is a common ...
Definition: Triple.h:331
bool isOSUnknown() const
Definition: Triple.h:508
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:43
bool isOSIAMCU() const
Definition: Triple.h:504
StringRef getArchName() const
getArchName - Get the architecture (first) component of the triple.
Definition: Triple.cpp:966
bool getMacOSXVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const
getMacOSXVersion - Parse the version number as with getOSVersion and then translate generic "darwin" ...
Definition: Triple.cpp:1050
bool isOSContiki() const
Definition: Triple.h:517
static ArchType getArchTypeForLLVMName(StringRef Str)
getArchTypeForLLVMName - The canonical type for the given LLVM architecture name (e.g., "x86").
Definition: Triple.cpp:257
StringRef getOSName() const
getOSName - Get the operating system (third) component of the triple.
Definition: Triple.cpp:975
bool isOSLinux() const
Tests whether the OS is Linux.
Definition: Triple.h:575
EnvironmentType getEnvironment() const
getEnvironment - Get the parsed environment type of this triple.
Definition: Triple.h:307
std::string merge(const Triple &Other) const
Merge target triples.
Definition: Triple.cpp:1559
bool isOSVersionLT(const Triple &Other) const
Definition: Triple.h:422
bool isOSFreeBSD() const
Definition: Triple.h:490
std::string normalize() const
Return the normalized form of this triple&#39;s string.
Definition: Triple.h:282
StringRef getEnvironmentName() const
getEnvironmentName - Get the optional environment (fourth) component of the triple, or "" if empty.
Definition: Triple.cpp:981
bool isMIPS() const
Tests whether the target is MIPS (little and big endian, 32- or 64-bit).
Definition: Triple.h:688
bool isOSCygMing() const
Tests for either Cygwin or MinGW OS.
Definition: Triple.h:559
const std::string & getTriple() const
Definition: Triple.h:360
bool isMIPS32() const
Tests whether the target is MIPS 32-bit (little and big endian).
Definition: Triple.h:678
bool isOSGlibc() const
Tests whether the OS uses glibc.
Definition: Triple.h:595
llvm::Triple getLittleEndianArchVariant() const
Form a triple with a little endian variant of the current architecture.
Definition: Triple.cpp:1460
bool isThumb() const
Tests whether the target is Thumb (little and big endian).
Definition: Triple.h:663
ObjectFormatType getObjectFormat() const
getFormat - Get the object format for this triple.
Definition: Triple.h:319
void setOSAndEnvironmentName(StringRef Str)
setOSAndEnvironmentName - Set the operating system and optional environment components with a single ...
Definition: Triple.cpp:1201
bool isArch64Bit() const
Test whether the architecture is 64-bit.
Definition: Triple.cpp:1268
bool isGNUEnvironment() const
Definition: Triple.h:510
bool isMacOSXVersionLT(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
isMacOSXVersionLT - Comparison function for checking OS X version compatibility, which handles suppor...
Definition: Triple.h:431
StringRef getVendorName() const
getVendorName - Get the vendor (second) component of the triple.
Definition: Triple.cpp:970
const unsigned Kind
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
bool isSimulatorEnvironment() const
Definition: Triple.h:478
ObjectFormatType
Definition: Triple.h:215
bool isTvOS() const
Is this an Apple tvOS triple.
Definition: Triple.h:460
bool isAndroid() const
Tests whether the target is Android.
Definition: Triple.h:635
llvm::Triple get64BitArchVariant() const
Form a triple with a 64-bit variant of the current architecture.
Definition: Triple.cpp:1343
bool isNVPTX() const
Tests whether the target is NVPTX (32- or 64-bit).
Definition: Triple.h:658
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
bool isOSVersionLT(unsigned Major, unsigned Minor=0, unsigned Micro=0) const
isOSVersionLT - Helper function for doing comparisons against version numbers included in the target ...
Definition: Triple.h:407
bool isOSBinFormatWasm() const
Tests whether the OS uses the Wasm binary format.
Definition: Triple.h:617
bool isWindowsMSVCEnvironment() const
Checks if the environment could be MSVC.
Definition: Triple.h:537
bool isARM() const
Tests whether the target is ARM (little and big endian).
Definition: Triple.h:668
void setArch(ArchType Kind)
setArch - Set the architecture (first) component of the triple to a known type.
Definition: Triple.cpp:1145
static StringRef getEnvironmentTypeName(EnvironmentType Kind)
getEnvironmentTypeName - Get the canonical name for the Kind environment.
Definition: Triple.cpp:216