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/StringRef.h"
16 // Some system headers or GCC predefined macros conflict with identifiers in
17 // this file. Undefine them here.
25 /// Triple - Helper class for working with target triples.
27 /// Target triples are strings in the format of:
28 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM
30 /// ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
32 /// This class is used for clients which want to support arbitrary
33 /// target triples, but also want to implement certain special
34 /// behavior for particular targets. This class isolates the mapping
35 /// from the components of the target triple to well known IDs.
37 /// At its core the Triple class is designed to be a wrapper for a triple
38 /// string; it does not normally change or normalize the triple string, instead
39 /// it provides additional APIs to parse normalized parts out of the triple.
41 /// One curiosity this implies is that for some odd triples the results of,
42 /// e.g., getOSName() can be very different from the result of getOS(). For
43 /// example, for 'i386-mingw32', getOS() will return MinGW32, but since
44 /// getOSName() is purely based on the string structure that will return the
47 /// Clients should generally avoid using getOSName() and related APIs unless
48 /// they are familiar with the triple format (this is particularly true when
49 /// rewriting a triple).
51 /// See autoconf/config.guess for a glimpse into what they look like in
58 alpha, // Alpha: alpha
59 arm, // ARM; arm, armv.*, xscale
60 bfin, // Blackfin: bfin
61 cellspu, // CellSPU: spu, cellspu
62 mips, // MIPS: mips, mipsallegrex
63 mipsel, // MIPSEL: mipsel, mipsallegrexel, psp
64 msp430, // MSP430: msp430
65 pic16, // PIC16: pic16
67 ppc64, // PPC64: powerpc64
68 sparc, // Sparc: sparc
69 systemz, // SystemZ: s390x
70 tce, // TCE (http://tce.cs.tut.fi/): tce
71 thumb, // Thumb: thumb, thumbv.*
73 x86_64, // X86-64: amd64, x86_64
74 xcore, // XCore: xcore
105 /// The parsed arch type (or InvalidArch if uninitialized).
106 mutable ArchType Arch;
108 /// The parsed vendor type.
109 mutable VendorType Vendor;
111 /// The parsed OS type.
114 bool isInitialized() const { return Arch != InvalidArch; }
118 /// @name Constructors
121 Triple() : Data(), Arch(InvalidArch) {}
122 explicit Triple(StringRef Str) : Data(Str), Arch(InvalidArch) {}
123 explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr)
124 : Data(ArchStr), Arch(InvalidArch) {
132 /// @name Typed Component Access
135 /// getArch - Get the parsed architecture type of this triple.
136 ArchType getArch() const {
137 if (!isInitialized()) Parse();
141 /// getVendor - Get the parsed vendor type of this triple.
142 VendorType getVendor() const {
143 if (!isInitialized()) Parse();
147 /// getOS - Get the parsed operating system type of this triple.
148 OSType getOS() const {
149 if (!isInitialized()) Parse();
153 /// hasEnvironment - Does this triple have the optional environment
154 /// (fourth) component?
155 bool hasEnvironment() const {
156 return getEnvironmentName() != "";
160 /// @name Direct Component Access
163 const std::string &str() const { return Data; }
165 const std::string &getTriple() const { return Data; }
167 /// getArchName - Get the architecture (first) component of the
169 StringRef getArchName() const;
171 /// getVendorName - Get the vendor (second) component of the triple.
172 StringRef getVendorName() const;
174 /// getOSName - Get the operating system (third) component of the
176 StringRef getOSName() const;
178 /// getEnvironmentName - Get the optional environment (fourth)
179 /// component of the triple, or "" if empty.
180 StringRef getEnvironmentName() const;
182 /// getOSAndEnvironmentName - Get the operating system and optional
183 /// environment components as a single string (separated by a '-'
184 /// if the environment component is present).
185 StringRef getOSAndEnvironmentName() const;
188 /// getDarwinNumber - Parse the 'darwin number' out of the specific target
189 /// triple. For example, if we have darwin8.5 return 8,5,0. If any entry is
190 /// not defined, return 0's. This requires that the triple have an OSType of
191 /// darwin before it is called.
192 void getDarwinNumber(unsigned &Maj, unsigned &Min, unsigned &Revision) const;
194 /// getDarwinMajorNumber - Return just the major version number, this is
195 /// specialized because it is a common query.
196 unsigned getDarwinMajorNumber() const {
197 unsigned Maj, Min, Rev;
198 getDarwinNumber(Maj, Min, Rev);
206 /// setArch - Set the architecture (first) component of the triple
208 void setArch(ArchType Kind);
210 /// setVendor - Set the vendor (second) component of the triple to a
212 void setVendor(VendorType Kind);
214 /// setOS - Set the operating system (third) component of the triple
216 void setOS(OSType Kind);
218 /// setTriple - Set all components to the new triple \arg Str.
219 void setTriple(const Twine &Str);
221 /// setArchName - Set the architecture (first) component of the
223 void setArchName(StringRef Str);
225 /// setVendorName - Set the vendor (second) component of the triple
227 void setVendorName(StringRef Str);
229 /// setOSName - Set the operating system (third) component of the
231 void setOSName(StringRef Str);
233 /// setEnvironmentName - Set the optional environment (fourth)
234 /// component of the triple by name.
235 void setEnvironmentName(StringRef Str);
237 /// setOSAndEnvironmentName - Set the operating system and optional
238 /// environment components with a single string.
239 void setOSAndEnvironmentName(StringRef Str);
242 /// @name Static helpers for IDs.
245 /// getArchTypeName - Get the canonical name for the \arg Kind
247 static const char *getArchTypeName(ArchType Kind);
249 /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
250 /// architecture. This is the prefix used by the architecture specific
251 /// builtins, and is suitable for passing to \see
252 /// Intrinsic::getIntrinsicForGCCBuiltin().
254 /// \return - The architecture prefix, or 0 if none is defined.
255 static const char *getArchTypePrefix(ArchType Kind);
257 /// getVendorTypeName - Get the canonical name for the \arg Kind
259 static const char *getVendorTypeName(VendorType Kind);
261 /// getOSTypeName - Get the canonical name for the \arg Kind vendor.
262 static const char *getOSTypeName(OSType Kind);
265 /// @name Static helpers for converting alternate architecture names.
268 /// getArchTypeForLLVMName - The canonical type for the given LLVM
269 /// architecture name (e.g., "x86").
270 static ArchType getArchTypeForLLVMName(StringRef Str);
272 /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
273 /// architecture name, for example as accepted by "gcc -arch" (see also
275 static ArchType getArchTypeForDarwinArchName(StringRef Str);
280 } // End llvm namespace