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 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 /// 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; 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 triples look like in
49 alpha, // Alpha: alpha
50 arm, // ARM; arm, armv.*, xscale
51 bfin, // Blackfin: bfin
52 cellspu, // CellSPU: spu, cellspu
53 mips, // MIPS: mips, mipsallegrex
54 mipsel, // MIPSEL: mipsel, mipsallegrexel, psp
55 msp430, // MSP430: msp430
57 ppc64, // PPC64: powerpc64, ppu
58 sparc, // Sparc: sparc
59 sparcv9, // Sparcv9: Sparcv9
60 systemz, // SystemZ: s390x
61 tce, // TCE (http://tce.cs.tut.fi/): tce
62 thumb, // Thumb: thumb, thumbv.*
64 x86_64, // X86-64: amd64, x86_64
65 xcore, // XCore: xcore
66 mblaze, // MBlaze: mblaze
99 enum EnvironmentType {
111 /// The parsed arch type (or InvalidArch if uninitialized).
112 mutable ArchType Arch;
114 /// The parsed vendor type.
115 mutable VendorType Vendor;
117 /// The parsed OS type.
120 /// The parsed Environment type.
121 mutable EnvironmentType Environment;
123 bool isInitialized() const { return Arch != InvalidArch; }
124 static ArchType ParseArch(StringRef ArchName);
125 static VendorType ParseVendor(StringRef VendorName);
126 static OSType ParseOS(StringRef OSName);
127 static EnvironmentType ParseEnvironment(StringRef EnvironmentName);
131 /// @name Constructors
134 Triple() : Data(), Arch(InvalidArch) {}
135 explicit Triple(StringRef Str) : Data(Str), Arch(InvalidArch) {}
136 explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr)
137 : Data(ArchStr), Arch(InvalidArch) {
144 explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr,
145 StringRef EnvironmentStr)
146 : Data(ArchStr), Arch(InvalidArch) {
152 Data += EnvironmentStr;
156 /// @name Normalization
159 /// normalize - Turn an arbitrary machine specification into the canonical
160 /// triple form (or something sensible that the Triple class understands if
161 /// nothing better can reasonably be done). In particular, it handles the
162 /// common case in which otherwise valid components are in the wrong order.
163 static std::string normalize(StringRef Str);
166 /// @name Typed Component Access
169 /// getArch - Get the parsed architecture type of this triple.
170 ArchType getArch() const {
171 if (!isInitialized()) Parse();
175 /// getVendor - Get the parsed vendor type of this triple.
176 VendorType getVendor() const {
177 if (!isInitialized()) Parse();
181 /// getOS - Get the parsed operating system type of this triple.
182 OSType getOS() const {
183 if (!isInitialized()) Parse();
187 /// hasEnvironment - Does this triple have the optional environment
188 /// (fourth) component?
189 bool hasEnvironment() const {
190 return getEnvironmentName() != "";
193 /// getEnvironment - Get the parsed environment type of this triple.
194 EnvironmentType getEnvironment() const {
195 if (!isInitialized()) Parse();
200 /// @name Direct Component Access
203 const std::string &str() const { return Data; }
205 const std::string &getTriple() const { return Data; }
207 /// getArchName - Get the architecture (first) component of the
209 StringRef getArchName() const;
211 /// getVendorName - Get the vendor (second) component of the triple.
212 StringRef getVendorName() const;
214 /// getOSName - Get the operating system (third) component of the
216 StringRef getOSName() const;
218 /// getEnvironmentName - Get the optional environment (fourth)
219 /// component of the triple, or "" if empty.
220 StringRef getEnvironmentName() const;
222 /// getOSAndEnvironmentName - Get the operating system and optional
223 /// environment components as a single string (separated by a '-'
224 /// if the environment component is present).
225 StringRef getOSAndEnvironmentName() const;
228 /// getDarwinNumber - Parse the 'darwin number' out of the specific target
229 /// triple. For example, if we have darwin8.5 return 8,5,0. If any entry is
230 /// not defined, return 0's. This requires that the triple have an OSType of
231 /// darwin before it is called.
232 void getDarwinNumber(unsigned &Maj, unsigned &Min, unsigned &Revision) const;
234 /// getDarwinMajorNumber - Return just the major version number, this is
235 /// specialized because it is a common query.
236 unsigned getDarwinMajorNumber() const {
237 unsigned Maj, Min, Rev;
238 getDarwinNumber(Maj, Min, Rev);
246 /// setArch - Set the architecture (first) component of the triple
248 void setArch(ArchType Kind);
250 /// setVendor - Set the vendor (second) component of the triple to a
252 void setVendor(VendorType Kind);
254 /// setOS - Set the operating system (third) component of the triple
256 void setOS(OSType Kind);
258 /// setEnvironment - Set the environment (fourth) component of the triple
260 void setEnvironment(EnvironmentType Kind);
262 /// setTriple - Set all components to the new triple \arg Str.
263 void setTriple(const Twine &Str);
265 /// setArchName - Set the architecture (first) component of the
267 void setArchName(StringRef Str);
269 /// setVendorName - Set the vendor (second) component of the triple
271 void setVendorName(StringRef Str);
273 /// setOSName - Set the operating system (third) component of the
275 void setOSName(StringRef Str);
277 /// setEnvironmentName - Set the optional environment (fourth)
278 /// component of the triple by name.
279 void setEnvironmentName(StringRef Str);
281 /// setOSAndEnvironmentName - Set the operating system and optional
282 /// environment components with a single string.
283 void setOSAndEnvironmentName(StringRef Str);
285 /// getArchNameForAssembler - Get an architecture name that is understood by
286 /// the target assembler.
287 const char *getArchNameForAssembler();
290 /// @name Static helpers for IDs.
293 /// getArchTypeName - Get the canonical name for the \arg Kind
295 static const char *getArchTypeName(ArchType Kind);
297 /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
298 /// architecture. This is the prefix used by the architecture specific
299 /// builtins, and is suitable for passing to \see
300 /// Intrinsic::getIntrinsicForGCCBuiltin().
302 /// \return - The architecture prefix, or 0 if none is defined.
303 static const char *getArchTypePrefix(ArchType Kind);
305 /// getVendorTypeName - Get the canonical name for the \arg Kind
307 static const char *getVendorTypeName(VendorType Kind);
309 /// getOSTypeName - Get the canonical name for the \arg Kind operating
311 static const char *getOSTypeName(OSType Kind);
313 /// getEnvironmentTypeName - Get the canonical name for the \arg Kind
315 static const char *getEnvironmentTypeName(EnvironmentType Kind);
318 /// @name Static helpers for converting alternate architecture names.
321 /// getArchTypeForLLVMName - The canonical type for the given LLVM
322 /// architecture name (e.g., "x86").
323 static ArchType getArchTypeForLLVMName(StringRef Str);
325 /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
326 /// architecture name, for example as accepted by "gcc -arch" (see also
328 static ArchType getArchTypeForDarwinArchName(StringRef Str);
333 } // End llvm namespace