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.
22 /// Triple - Helper class for working with target triples.
24 /// Target triples are strings in the canonical form:
25 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
27 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
29 /// This class is used for clients which want to support arbitrary
30 /// target triples, but also want to implement certain special
31 /// behavior for particular targets. This class isolates the mapping
32 /// from the components of the target triple to well known IDs.
34 /// At its core the Triple class is designed to be a wrapper for a triple
35 /// string; the constructor does not change or normalize the triple string.
36 /// Clients that need to handle the non-canonical triples that users often
37 /// specify should use the normalize method.
39 /// See autoconf/config.guess for a glimpse into what triples look like in
46 arm, // ARM; arm, armv.*, xscale
47 hexagon, // Hexagon: hexagon
48 mips, // MIPS: mips, mipsallegrex
49 mipsel, // MIPSEL: mipsel, mipsallegrexel
50 mips64, // MIPS64: mips64
51 mips64el,// MIPS64EL: mips64el
52 msp430, // MSP430: msp430
54 ppc64, // PPC64: powerpc64, ppu
55 r600, // R600: AMD GPUs HD2XXX - HD6XXX
56 sparc, // Sparc: sparc
57 sparcv9, // Sparcv9: Sparcv9
58 tce, // TCE (http://tce.cs.tut.fi/): tce
59 thumb, // Thumb: thumb, thumbv.*
61 x86_64, // X86-64: amd64, x86_64
62 xcore, // XCore: xcore
63 mblaze, // MBlaze: mblaze
64 nvptx, // NVPTX: 32-bit
65 nvptx64, // NVPTX: 64-bit
66 le32, // le32: generic little-endian 32-bit CPU (PNaCl / Emscripten)
67 amdil, // amdil: amd IL
68 spir, // SPIR: standard portable IR for OpenCL 32-bit version
69 spir64 // SPIR: standard portable IR for OpenCL 64-bit version
95 MinGW32, // i*86-pc-mingw32, *-w64-mingw32
103 NaCl, // Native Client
104 CNK, // BG/P Compute-Node Kernel
108 enum EnvironmentType {
124 /// The parsed arch type.
127 /// The parsed vendor type.
130 /// The parsed OS type.
133 /// The parsed Environment type.
134 EnvironmentType Environment;
137 /// @name Constructors
140 /// \brief Default constructor is the same as an empty string and leaves all
141 /// triple fields unknown.
142 Triple() : Data(), Arch(), Vendor(), OS(), Environment() {}
144 explicit Triple(const Twine &Str);
145 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr);
146 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
147 const Twine &EnvironmentStr);
150 /// @name Normalization
153 /// normalize - Turn an arbitrary machine specification into the canonical
154 /// triple form (or something sensible that the Triple class understands if
155 /// nothing better can reasonably be done). In particular, it handles the
156 /// common case in which otherwise valid components are in the wrong order.
157 static std::string normalize(StringRef Str);
160 /// @name Typed Component Access
163 /// getArch - Get the parsed architecture type of this triple.
164 ArchType getArch() const { return Arch; }
166 /// getVendor - Get the parsed vendor type of this triple.
167 VendorType getVendor() const { return Vendor; }
169 /// getOS - Get the parsed operating system type of this triple.
170 OSType getOS() const { return OS; }
172 /// hasEnvironment - Does this triple have the optional environment
173 /// (fourth) component?
174 bool hasEnvironment() const {
175 return getEnvironmentName() != "";
178 /// getEnvironment - Get the parsed environment type of this triple.
179 EnvironmentType getEnvironment() const { return Environment; }
181 /// getOSVersion - Parse the version number from the OS name component of the
182 /// triple, if present.
184 /// For example, "fooos1.2.3" would return (1, 2, 3).
186 /// If an entry is not defined, it will be returned as 0.
187 void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
189 /// getOSMajorVersion - Return just the major version number, this is
190 /// specialized because it is a common query.
191 unsigned getOSMajorVersion() const {
192 unsigned Maj, Min, Micro;
193 getOSVersion(Maj, Min, Micro);
197 /// getMacOSXVersion - Parse the version number as with getOSVersion and then
198 /// translate generic "darwin" versions to the corresponding OS X versions.
199 /// This may also be called with IOS triples but the OS X version number is
200 /// just set to a constant 10.4.0 in that case. Returns true if successful.
201 bool getMacOSXVersion(unsigned &Major, unsigned &Minor,
202 unsigned &Micro) const;
204 /// getiOSVersion - Parse the version number as with getOSVersion. This should
205 /// only be called with IOS triples.
206 void getiOSVersion(unsigned &Major, unsigned &Minor,
207 unsigned &Micro) const;
210 /// @name Direct Component Access
213 const std::string &str() const { return Data; }
215 const std::string &getTriple() const { return Data; }
217 /// getArchName - Get the architecture (first) component of the
219 StringRef getArchName() const;
221 /// getVendorName - Get the vendor (second) component of the triple.
222 StringRef getVendorName() const;
224 /// getOSName - Get the operating system (third) component of the
226 StringRef getOSName() const;
228 /// getEnvironmentName - Get the optional environment (fourth)
229 /// component of the triple, or "" if empty.
230 StringRef getEnvironmentName() const;
232 /// getOSAndEnvironmentName - Get the operating system and optional
233 /// environment components as a single string (separated by a '-'
234 /// if the environment component is present).
235 StringRef getOSAndEnvironmentName() const;
238 /// @name Convenience Predicates
241 /// \brief Test whether the architecture is 64-bit
243 /// Note that this tests for 64-bit pointer width, and nothing else. Note
244 /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
245 /// 16-bit. The inner details of pointer width for particular architectures
246 /// is not summed up in the triple, and so only a coarse grained predicate
247 /// system is provided.
248 bool isArch64Bit() const;
250 /// \brief Test whether the architecture is 32-bit
252 /// Note that this tests for 32-bit pointer width, and nothing else.
253 bool isArch32Bit() const;
255 /// \brief Test whether the architecture is 16-bit
257 /// Note that this tests for 16-bit pointer width, and nothing else.
258 bool isArch16Bit() const;
260 /// isOSVersionLT - Helper function for doing comparisons against version
261 /// numbers included in the target triple.
262 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
263 unsigned Micro = 0) const {
265 getOSVersion(LHS[0], LHS[1], LHS[2]);
268 return LHS[0] < Major;
270 return LHS[1] < Minor;
272 return LHS[1] < Micro;
277 /// isMacOSXVersionLT - Comparison function for checking OS X version
278 /// compatibility, which handles supporting skewed version numbering schemes
279 /// used by the "darwin" triples.
280 unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
281 unsigned Micro = 0) const {
282 assert(isMacOSX() && "Not an OS X triple!");
284 // If this is OS X, expect a sane version number.
285 if (getOS() == Triple::MacOSX)
286 return isOSVersionLT(Major, Minor, Micro);
288 // Otherwise, compare to the "Darwin" number.
289 assert(Major == 10 && "Unexpected major version");
290 return isOSVersionLT(Minor + 4, Micro, 0);
293 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
294 /// "darwin" and "osx" as OS X triples.
295 bool isMacOSX() const {
296 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
299 /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
300 bool isOSDarwin() const {
301 return isMacOSX() || getOS() == Triple::IOS;
304 /// \brief Tests for either Cygwin or MinGW OS
305 bool isOSCygMing() const {
306 return getOS() == Triple::Cygwin || getOS() == Triple::MinGW32;
309 /// isOSWindows - Is this a "Windows" OS.
310 bool isOSWindows() const {
311 return getOS() == Triple::Win32 || isOSCygMing();
314 /// \brief Tests whether the OS is NaCl (Native Client)
315 bool isOSNaCl() const {
316 return getOS() == Triple::NaCl;
319 /// \brief Tests whether the OS uses the ELF binary format.
320 bool isOSBinFormatELF() const {
321 return !isOSDarwin() && !isOSWindows();
324 /// \brief Tests whether the OS uses the COFF binary format.
325 bool isOSBinFormatCOFF() const {
326 return isOSWindows();
329 /// \brief Tests whether the environment is MachO.
330 // FIXME: Should this be an OSBinFormat predicate?
331 bool isEnvironmentMachO() const {
332 return getEnvironment() == Triple::MachO || isOSDarwin();
339 /// setArch - Set the architecture (first) component of the triple
341 void setArch(ArchType Kind);
343 /// setVendor - Set the vendor (second) component of the triple to a
345 void setVendor(VendorType Kind);
347 /// setOS - Set the operating system (third) component of the triple
349 void setOS(OSType Kind);
351 /// setEnvironment - Set the environment (fourth) component of the triple
353 void setEnvironment(EnvironmentType Kind);
355 /// setTriple - Set all components to the new triple \p Str.
356 void setTriple(const Twine &Str);
358 /// setArchName - Set the architecture (first) component of the
360 void setArchName(StringRef Str);
362 /// setVendorName - Set the vendor (second) component of the triple
364 void setVendorName(StringRef Str);
366 /// setOSName - Set the operating system (third) component of the
368 void setOSName(StringRef Str);
370 /// setEnvironmentName - Set the optional environment (fourth)
371 /// component of the triple by name.
372 void setEnvironmentName(StringRef Str);
374 /// setOSAndEnvironmentName - Set the operating system and optional
375 /// environment components with a single string.
376 void setOSAndEnvironmentName(StringRef Str);
378 /// getArchNameForAssembler - Get an architecture name that is understood by
379 /// the target assembler.
380 const char *getArchNameForAssembler();
383 /// @name Helpers to build variants of a particular triple.
386 /// \brief Form a triple with a 32-bit variant of the current architecture.
388 /// This can be used to move across "families" of architectures where useful.
390 /// \returns A new triple with a 32-bit architecture or an unknown
391 /// architecture if no such variant can be found.
392 llvm::Triple get32BitArchVariant() const;
394 /// \brief Form a triple with a 64-bit variant of the current architecture.
396 /// This can be used to move across "families" of architectures where useful.
398 /// \returns A new triple with a 64-bit architecture or an unknown
399 /// architecture if no such variant can be found.
400 llvm::Triple get64BitArchVariant() const;
403 /// @name Static helpers for IDs.
406 /// getArchTypeName - Get the canonical name for the \p Kind architecture.
407 static const char *getArchTypeName(ArchType Kind);
409 /// getArchTypePrefix - Get the "prefix" canonical name for the \p Kind
410 /// architecture. This is the prefix used by the architecture specific
411 /// builtins, and is suitable for passing to \see
412 /// Intrinsic::getIntrinsicForGCCBuiltin().
414 /// \return - The architecture prefix, or 0 if none is defined.
415 static const char *getArchTypePrefix(ArchType Kind);
417 /// getVendorTypeName - Get the canonical name for the \p Kind vendor.
418 static const char *getVendorTypeName(VendorType Kind);
420 /// getOSTypeName - Get the canonical name for the \p Kind operating system.
421 static const char *getOSTypeName(OSType Kind);
423 /// getEnvironmentTypeName - Get the canonical name for the \p Kind
425 static const char *getEnvironmentTypeName(EnvironmentType Kind);
428 /// @name Static helpers for converting alternate architecture names.
431 /// getArchTypeForLLVMName - The canonical type for the given LLVM
432 /// architecture name (e.g., "x86").
433 static ArchType getArchTypeForLLVMName(StringRef Str);
438 } // End llvm namespace