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 cellspu, // CellSPU: spu, cellspu
48 hexagon, // Hexagon: hexagon
49 mips, // MIPS: mips, mipsallegrex
50 mipsel, // MIPSEL: mipsel, mipsallegrexel, psp
51 mips64, // MIPS64: mips64
52 mips64el,// MIPS64EL: mips64el
53 msp430, // MSP430: msp430
55 ppc64, // PPC64: powerpc64, ppu
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 ptx32, // PTX: ptx (32-bit)
65 ptx64, // PTX: ptx (64-bit)
66 le32, // le32: generic little-endian 32-bit CPU (PNaCl / Emscripten)
67 amdil, // amdil: amd IL
91 MinGW32, // i*86-pc-mingw32, *-w64-mingw32
102 enum EnvironmentType {
115 /// The parsed arch type (or InvalidArch if uninitialized).
116 mutable ArchType Arch;
118 /// The parsed vendor type.
119 mutable VendorType Vendor;
121 /// The parsed OS type.
124 /// The parsed Environment type.
125 mutable EnvironmentType Environment;
127 bool isInitialized() const { return Arch != InvalidArch; }
128 static ArchType ParseArch(StringRef ArchName);
129 static VendorType ParseVendor(StringRef VendorName);
130 static OSType ParseOS(StringRef OSName);
131 static EnvironmentType ParseEnvironment(StringRef EnvironmentName);
135 /// @name Constructors
138 Triple() : Data(), Arch(InvalidArch) {}
139 explicit Triple(const Twine &Str) : Data(Str.str()), Arch(InvalidArch) {}
140 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr)
141 : Data((ArchStr + Twine('-') + VendorStr + Twine('-') + OSStr).str()),
145 Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
146 const Twine &EnvironmentStr)
147 : Data((ArchStr + Twine('-') + VendorStr + Twine('-') + OSStr + Twine('-') +
148 EnvironmentStr).str()), Arch(InvalidArch) {
152 /// @name Normalization
155 /// normalize - Turn an arbitrary machine specification into the canonical
156 /// triple form (or something sensible that the Triple class understands if
157 /// nothing better can reasonably be done). In particular, it handles the
158 /// common case in which otherwise valid components are in the wrong order.
159 static std::string normalize(StringRef Str);
162 /// @name Typed Component Access
165 /// getArch - Get the parsed architecture type of this triple.
166 ArchType getArch() const {
167 if (!isInitialized()) Parse();
171 /// getVendor - Get the parsed vendor type of this triple.
172 VendorType getVendor() const {
173 if (!isInitialized()) Parse();
177 /// getOS - Get the parsed operating system type of this triple.
178 OSType getOS() const {
179 if (!isInitialized()) Parse();
183 /// hasEnvironment - Does this triple have the optional environment
184 /// (fourth) component?
185 bool hasEnvironment() const {
186 return getEnvironmentName() != "";
189 /// getEnvironment - Get the parsed environment type of this triple.
190 EnvironmentType getEnvironment() const {
191 if (!isInitialized()) Parse();
196 /// @name Direct Component Access
199 const std::string &str() const { return Data; }
201 const std::string &getTriple() const { return Data; }
203 /// getArchName - Get the architecture (first) component of the
205 StringRef getArchName() const;
207 /// getVendorName - Get the vendor (second) component of the triple.
208 StringRef getVendorName() const;
210 /// getOSName - Get the operating system (third) component of the
212 StringRef getOSName() const;
214 /// getEnvironmentName - Get the optional environment (fourth)
215 /// component of the triple, or "" if empty.
216 StringRef getEnvironmentName() const;
218 /// getOSAndEnvironmentName - Get the operating system and optional
219 /// environment components as a single string (separated by a '-'
220 /// if the environment component is present).
221 StringRef getOSAndEnvironmentName() const;
223 /// getOSVersion - Parse the version number from the OS name component of the
224 /// triple, if present.
226 /// For example, "fooos1.2.3" would return (1, 2, 3).
228 /// If an entry is not defined, it will be returned as 0.
229 void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
231 /// getOSMajorVersion - Return just the major version number, this is
232 /// specialized because it is a common query.
233 unsigned getOSMajorVersion() const {
234 unsigned Maj, Min, Micro;
235 getOSVersion(Maj, Min, Micro);
239 /// isOSVersionLT - Helper function for doing comparisons against version
240 /// numbers included in the target triple.
241 bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
242 unsigned Micro = 0) const {
244 getOSVersion(LHS[0], LHS[1], LHS[2]);
247 return LHS[0] < Major;
249 return LHS[1] < Minor;
251 return LHS[1] < Micro;
256 /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
257 /// "darwin" and "osx" as OS X triples.
258 bool isMacOSX() const {
259 return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
262 /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
263 bool isOSDarwin() const {
264 return isMacOSX() || getOS() == Triple::IOS;
267 /// isOSWindows - Is this a "Windows" OS.
268 bool isOSWindows() const {
269 return getOS() == Triple::Win32 || getOS() == Triple::Cygwin ||
270 getOS() == Triple::MinGW32;
273 /// isMacOSXVersionLT - Comparison function for checking OS X version
274 /// compatibility, which handles supporting skewed version numbering schemes
275 /// used by the "darwin" triples.
276 unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
277 unsigned Micro = 0) const {
278 assert(isMacOSX() && "Not an OS X triple!");
280 // If this is OS X, expect a sane version number.
281 if (getOS() == Triple::MacOSX)
282 return isOSVersionLT(Major, Minor, Micro);
284 // Otherwise, compare to the "Darwin" number.
285 assert(Major == 10 && "Unexpected major version");
286 return isOSVersionLT(Minor + 4, Micro, 0);
293 /// setArch - Set the architecture (first) component of the triple
295 void setArch(ArchType Kind);
297 /// setVendor - Set the vendor (second) component of the triple to a
299 void setVendor(VendorType Kind);
301 /// setOS - Set the operating system (third) component of the triple
303 void setOS(OSType Kind);
305 /// setEnvironment - Set the environment (fourth) component of the triple
307 void setEnvironment(EnvironmentType Kind);
309 /// setTriple - Set all components to the new triple \arg Str.
310 void setTriple(const Twine &Str);
312 /// setArchName - Set the architecture (first) component of the
314 void setArchName(StringRef Str);
316 /// setVendorName - Set the vendor (second) component of the triple
318 void setVendorName(StringRef Str);
320 /// setOSName - Set the operating system (third) component of the
322 void setOSName(StringRef Str);
324 /// setEnvironmentName - Set the optional environment (fourth)
325 /// component of the triple by name.
326 void setEnvironmentName(StringRef Str);
328 /// setOSAndEnvironmentName - Set the operating system and optional
329 /// environment components with a single string.
330 void setOSAndEnvironmentName(StringRef Str);
332 /// getArchNameForAssembler - Get an architecture name that is understood by
333 /// the target assembler.
334 const char *getArchNameForAssembler();
337 /// @name Static helpers for IDs.
340 /// getArchTypeName - Get the canonical name for the \arg Kind
342 static const char *getArchTypeName(ArchType Kind);
344 /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
345 /// architecture. This is the prefix used by the architecture specific
346 /// builtins, and is suitable for passing to \see
347 /// Intrinsic::getIntrinsicForGCCBuiltin().
349 /// \return - The architecture prefix, or 0 if none is defined.
350 static const char *getArchTypePrefix(ArchType Kind);
352 /// getVendorTypeName - Get the canonical name for the \arg Kind
354 static const char *getVendorTypeName(VendorType Kind);
356 /// getOSTypeName - Get the canonical name for the \arg Kind operating
358 static const char *getOSTypeName(OSType Kind);
360 /// getEnvironmentTypeName - Get the canonical name for the \arg Kind
362 static const char *getEnvironmentTypeName(EnvironmentType Kind);
365 /// @name Static helpers for converting alternate architecture names.
368 /// getArchTypeForLLVMName - The canonical type for the given LLVM
369 /// architecture name (e.g., "x86").
370 static ArchType getArchTypeForLLVMName(StringRef Str);
372 /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
373 /// architecture name, for example as accepted by "gcc -arch" (see also
375 static ArchType getArchTypeForDarwinArchName(StringRef Str);
380 } // End llvm namespace