1 //===-- llvm/ADT/Triple.h - Target triple helper class ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_ADT_TRIPLE_H
11 #define LLVM_ADT_TRIPLE_H
13 #include "llvm/ADT/Twine.h"
15 // Some system headers or GCC predefined macros conflict with identifiers in
16 // this file. Undefine them here.
23 /// Triple - Helper class for working with autoconf configuration names. For
24 /// historical reasons, we also call these 'triples' (they used to contain
25 /// exactly three fields).
27 /// Configuration names are strings in the canonical form:
28 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
30 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
32 /// This class is used for clients which want to support arbitrary
33 /// configuration names, but also want to implement certain special
34 /// behavior for particular configurations. This class isolates the mapping
35 /// from the components of the configuration name to well known IDs.
37 /// At its core the Triple class is designed to be a wrapper for a triple
38 /// string; the constructor does not change or normalize the triple string.
39 /// Clients that need to handle the non-canonical triples that users often
40 /// specify should use the normalize method.
42 /// See autoconf/config.guess for a glimpse into what configuration names
43 /// look like in practice.
49 arm, // ARM (little endian): arm, armv.*, xscale
50 armeb, // ARM (big endian): armeb
52 aarch64, // AArch64 (little endian): aarch64
53 aarch64_be, // AArch64 (big endian): aarch64_be
54 hexagon, // Hexagon: hexagon
55 mips, // MIPS: mips, mipsallegrex
56 mipsel, // MIPSEL: mipsel, mipsallegrexel
57 mips64, // MIPS64: mips64
58 mips64el, // MIPS64EL: mips64el
59 msp430, // MSP430: msp430
61 ppc64, // PPC64: powerpc64, ppu
62 ppc64le, // PPC64LE: powerpc64le
63 r600, // R600: AMD GPUs HD2XXX - HD6XXX
64 sparc, // Sparc: sparc
65 sparcv9, // Sparcv9: Sparcv9
66 systemz, // SystemZ: s390x
67 tce, // TCE (http://tce.cs.tut.fi/): tce
68 thumb, // Thumb (little endian): thumb, thumbv.*
69 thumbeb, // Thumb (big endian): thumbeb
71 x86_64, // X86-64: amd64, x86_64
72 xcore, // XCore: xcore
73 nvptx, // NVPTX: 32-bit
74 nvptx64, // NVPTX: 64-bit
75 le32, // le32: generic little-endian 32-bit CPU (PNaCl / Emscripten)
76 amdil, // amdil: amd IL
77 spir, // SPIR: standard portable IR for OpenCL 32-bit version
78 spir64 // SPIR: standard portable IR for OpenCL 64-bit version
105 MinGW32, // i*86-pc-mingw32, *-w64-mingw32
113 NaCl, // Native Client
114 CNK, // BG/P Compute-Node Kernel
118 NVCL // NVIDIA OpenCL
120 enum EnvironmentType {
136 enum ObjectFormatType {
147 /// The parsed arch type.
150 /// The parsed vendor type.
153 /// The parsed OS type.
156 /// The parsed Environment type.
157 EnvironmentType Environment;
159 /// The object format type.
160 ObjectFormatType ObjectFormat;
163 /// @name Constructors
166 /// \brief Default constructor is the same as an empty string and leaves all
167 /// triple fields unknown.
168 Triple() : Data(), Arch(), Vendor(), OS(), Environment(), ObjectFormat() {}
170 explicit Triple(const Twine &Str);
171 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
172 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
173 const Twine &EnvironmentStr);
176 /// @name Normalization
179 /// normalize - Turn an arbitrary machine specification into the canonical
180 /// triple form (or something sensible that the Triple class understands if
181 /// nothing better can reasonably be done). In particular, it handles the
182 /// common case in which otherwise valid components are in the wrong order.
183 static std::string normalize(StringRef Str);
186 /// @name Typed Component Access
189 /// getArch - Get the parsed architecture type of this triple.
190 ArchType getArch() const { return Arch; }
192 /// getVendor - Get the parsed vendor type of this triple.
193 VendorType getVendor() const { return Vendor; }
195 /// getOS - Get the parsed operating system type of this triple.
196 OSType getOS() const { return OS; }
198 /// hasEnvironment - Does this triple have the optional environment
199 /// (fourth) component?
200 bool hasEnvironment() const {
201 return getEnvironmentName() != "";
204 /// getEnvironment - Get the parsed environment type of this triple.
205 EnvironmentType getEnvironment() const { return Environment; }
207 /// getFormat - Get the object format for this triple.
208 ObjectFormatType getObjectFormat() const { return ObjectFormat; }
210 /// getOSVersion - Parse the version number from the OS name component of the
211 /// triple, if present.
213 /// For example, "fooos1.2.3" would return (1, 2, 3).
215 /// If an entry is not defined, it will be returned as 0.
216 void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
218 /// getOSMajorVersion - Return just the major version number, this is
219 /// specialized because it is a common query.
220 unsigned getOSMajorVersion() const {
221 unsigned Maj, Min, Micro;
222 getOSVersion(Maj, Min, Micro);
226 /// getMacOSXVersion - Parse the version number as with getOSVersion and then
227 /// translate generic "darwin" versions to the corresponding OS X versions.
228 /// This may also be called with IOS triples but the OS X version number is
229 /// just set to a constant 10.4.0 in that case. Returns true if successful.
230 bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
231 unsigned &Micro) const;
233 /// getiOSVersion - Parse the version number as with getOSVersion. This should
234 /// only be called with IOS triples.
235 void getiOSVersion(unsigned &Major, unsigned &Minor,
236 unsigned &Micro) const;
239 /// @name Direct Component Access
242 const std::string &str() const { return Data; }
244 const std::string &getTriple() const { return Data; }
246 /// getArchName - Get the architecture (first) component of the
248 StringRef getArchName() const;
250 /// getVendorName - Get the vendor (second) component of the triple.
251 StringRef getVendorName() const;
253 /// getOSName - Get the operating system (third) component of the
255 StringRef getOSName() const;
257 /// getEnvironmentName - Get the optional environment (fourth)
258 /// component of the triple, or "" if empty.
259 StringRef getEnvironmentName() const;
261 /// getOSAndEnvironmentName - Get the operating system and optional
262 /// environment components as a single string (separated by a '-'
263 /// if the environment component is present).
264 StringRef getOSAndEnvironmentName() const;
267 /// @name Convenience Predicates
270 /// \brief Test whether the architecture is 64-bit
272 /// Note that this tests for 64-bit pointer width, and nothing else. Note
273 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
274 /// 16-bit. The inner details of pointer width for particular architectures
275 /// is not summed up in the triple, and so only a coarse grained predicate
276 /// system is provided.
277 bool isArch64Bit() const;
279 /// \brief Test whether the architecture is 32-bit
281 /// Note that this tests for 32-bit pointer width, and nothing else.
282 bool isArch32Bit() const;
284 /// \brief Test whether the architecture is 16-bit
286 /// Note that this tests for 16-bit pointer width, and nothing else.
287 bool isArch16Bit() const;
289 /// isOSVersionLT - Helper function for doing comparisons against version
290 /// numbers included in the target triple.
291 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
292 unsigned Micro = 0) const {
294 getOSVersion(LHS[0], LHS[1], LHS[2]);
297 return LHS[0] < Major;
299 return LHS[1] < Minor;
301 return LHS[1] < Micro;
306 /// isMacOSXVersionLT - Comparison function for checking OS X version
307 /// compatibility, which handles supporting skewed version numbering schemes
308 /// used by the "darwin" triples.
309 unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
310 unsigned Micro = 0) const {
311 assert(isMacOSX() && "Not an OS X triple!");
313 // If this is OS X, expect a sane version number.
314 if (getOS() == Triple::MacOSX)
315 return isOSVersionLT(Major, Minor, Micro);
317 // Otherwise, compare to the "Darwin" number.
318 assert(Major == 10 && "Unexpected major version");
319 return isOSVersionLT(Minor + 4, Micro, 0);
322 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
323 /// "darwin" and "osx" as OS X triples.
324 bool isMacOSX() const {
325 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
328 /// Is this an iOS triple.
330 return getOS() == Triple::IOS;
333 /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
334 bool isOSDarwin() const {
335 return isMacOSX() || isiOS();
338 bool isWindowsMSVCEnvironment() const {
339 return getOS() == Triple::Win32 &&
340 (getEnvironment() == Triple::UnknownEnvironment ||
341 getEnvironment() == Triple::MSVC);
344 bool isKnownWindowsMSVCEnvironment() const {
345 return getOS() == Triple::Win32 && getEnvironment() == Triple::MSVC;
348 bool isWindowsCygwinEnvironment() const {
349 return getOS() == Triple::Cygwin ||
350 (getOS() == Triple::Win32 && getEnvironment() == Triple::Cygnus);
353 bool isWindowsGNUEnvironment() const {
354 return getOS() == Triple::MinGW32 ||
355 (getOS() == Triple::Win32 && getEnvironment() == Triple::GNU);
358 /// \brief Tests for either Cygwin or MinGW OS
359 bool isOSCygMing() const {
360 return isWindowsCygwinEnvironment() || isWindowsGNUEnvironment();
363 /// \brief Is this a "Windows" OS targeting a "MSVCRT.dll" environment.
364 bool isOSMSVCRT() const {
365 return getOS() == Triple::Win32 || getOS() == Triple::MinGW32;
368 /// \brief Tests whether the OS is Windows.
369 bool isOSWindows() const {
370 return getOS() == Triple::Win32 || isOSCygMing();
373 /// \brief Tests whether the OS is NaCl (Native Client)
374 bool isOSNaCl() const {
375 return getOS() == Triple::NaCl;
378 /// \brief Tests whether the OS is Linux.
379 bool isOSLinux() const {
380 return getOS() == Triple::Linux;
383 /// \brief Tests whether the OS uses the ELF binary format.
384 bool isOSBinFormatELF() const {
385 return getObjectFormat() == Triple::ELF;
388 /// \brief Tests whether the OS uses the COFF binary format.
389 bool isOSBinFormatCOFF() const {
390 return getObjectFormat() == Triple::COFF;
393 /// \brief Tests whether the environment is MachO.
394 bool isOSBinFormatMachO() const {
395 return getObjectFormat() == Triple::MachO;
402 /// setArch - Set the architecture (first) component of the triple
404 void setArch(ArchType Kind);
406 /// setVendor - Set the vendor (second) component of the triple to a
408 void setVendor(VendorType Kind);
410 /// setOS - Set the operating system (third) component of the triple
412 void setOS(OSType Kind);
414 /// setEnvironment - Set the environment (fourth) component of the triple
416 void setEnvironment(EnvironmentType Kind);
418 /// setObjectFormat - Set the object file format
419 void setObjectFormat(ObjectFormatType Kind);
421 /// setTriple - Set all components to the new triple \p Str.
422 void setTriple(const Twine &Str);
424 /// setArchName - Set the architecture (first) component of the
426 void setArchName(StringRef Str);
428 /// setVendorName - Set the vendor (second) component of the triple
430 void setVendorName(StringRef Str);
432 /// setOSName - Set the operating system (third) component of the
434 void setOSName(StringRef Str);
436 /// setEnvironmentName - Set the optional environment (fourth)
437 /// component of the triple by name.
438 void setEnvironmentName(StringRef Str);
440 /// setOSAndEnvironmentName - Set the operating system and optional
441 /// environment components with a single string.
442 void setOSAndEnvironmentName(StringRef Str);
444 /// getArchNameForAssembler - Get an architecture name that is understood by
445 /// the target assembler.
446 const char *getArchNameForAssembler();
449 /// @name Helpers to build variants of a particular triple.
452 /// \brief Form a triple with a 32-bit variant of the current architecture.
454 /// This can be used to move across "families" of architectures where useful.
456 /// \returns A new triple with a 32-bit architecture or an unknown
457 /// architecture if no such variant can be found.
458 llvm::Triple get32BitArchVariant() const;
460 /// \brief Form a triple with a 64-bit variant of the current architecture.
462 /// This can be used to move across "families" of architectures where useful.
464 /// \returns A new triple with a 64-bit architecture or an unknown
465 /// architecture if no such variant can be found.
466 llvm::Triple get64BitArchVariant() const;
469 /// @name Static helpers for IDs.
472 /// getArchTypeName - Get the canonical name for the \p Kind architecture.
473 static const char *getArchTypeName(ArchType Kind);
475 /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
476 /// architecture. This is the prefix used by the architecture specific
477 /// builtins, and is suitable for passing to \see
478 /// Intrinsic::getIntrinsicForGCCBuiltin().
480 /// \return - The architecture prefix, or 0 if none is defined.
481 static const char *getArchTypePrefix(ArchType Kind);
483 /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
484 static const char *getVendorTypeName(VendorType Kind);
486 /// getOSTypeName - Get the canonical name for the \p Kind operating system.
487 static const char *getOSTypeName(OSType Kind);
489 /// getEnvironmentTypeName - Get the canonical name for the \p Kind
491 static const char *getEnvironmentTypeName(EnvironmentType Kind);
494 /// @name Static helpers for converting alternate architecture names.
497 /// getArchTypeForLLVMName - The canonical type for the given LLVM
498 /// architecture name (e.g., "x86").
499 static ArchType getArchTypeForLLVMName(StringRef Str);
504 } // End llvm namespace