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
104 /// The parsed arch type (or InvalidArch if uninitialized).
105 mutable ArchType Arch;
107 /// The parsed vendor type.
108 mutable VendorType Vendor;
110 /// The parsed OS type.
113 bool isInitialized() const { return Arch != InvalidArch; }
117 /// @name Constructors
120 Triple() : Data(), Arch(InvalidArch) {}
121 explicit Triple(StringRef Str) : Data(Str), Arch(InvalidArch) {}
122 explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr)
123 : Data(ArchStr), Arch(InvalidArch) {
131 /// @name Typed Component Access
134 /// getArch - Get the parsed architecture type of this triple.
135 ArchType getArch() const {
136 if (!isInitialized()) Parse();
140 /// getVendor - Get the parsed vendor type of this triple.
141 VendorType getVendor() const {
142 if (!isInitialized()) Parse();
146 /// getOS - Get the parsed operating system type of this triple.
147 OSType getOS() const {
148 if (!isInitialized()) Parse();
152 /// hasEnvironment - Does this triple have the optional environment
153 /// (fourth) component?
154 bool hasEnvironment() const {
155 return getEnvironmentName() != "";
159 /// @name Direct Component Access
162 const std::string &getTriple() const { return Data; }
164 /// getArchName - Get the architecture (first) component of the
166 StringRef getArchName() const;
168 /// getVendorName - Get the vendor (second) component of the triple.
169 StringRef getVendorName() const;
171 /// getOSName - Get the operating system (third) component of the
173 StringRef getOSName() const;
175 /// getEnvironmentName - Get the optional environment (fourth)
176 /// component of the triple, or "" if empty.
177 StringRef getEnvironmentName() const;
179 /// getOSAndEnvironmentName - Get the operating system and optional
180 /// environment components as a single string (separated by a '-'
181 /// if the environment component is present).
182 StringRef getOSAndEnvironmentName() const;
185 /// getDarwinNumber - Parse the 'darwin number' out of the specific target
186 /// triple. For example, if we have darwin8.5 return 8,5,0. If any entry is
187 /// not defined, return 0's. This requires that the triple have an OSType of
188 /// darwin before it is called.
189 void getDarwinNumber(unsigned &Maj, unsigned &Min, unsigned &Revision) const;
191 /// getDarwinMajorNumber - Return just the major version number, this is
192 /// specialized because it is a common query.
193 unsigned getDarwinMajorNumber() const {
194 unsigned Maj, Min, Rev;
195 getDarwinNumber(Maj, Min, Rev);
203 /// setArch - Set the architecture (first) component of the triple
205 void setArch(ArchType Kind);
207 /// setVendor - Set the vendor (second) component of the triple to a
209 void setVendor(VendorType Kind);
211 /// setOS - Set the operating system (third) component of the triple
213 void setOS(OSType Kind);
215 /// setTriple - Set all components to the new triple \arg Str.
216 void setTriple(const Twine &Str);
218 /// setArchName - Set the architecture (first) component of the
220 void setArchName(const StringRef &Str);
222 /// setVendorName - Set the vendor (second) component of the triple
224 void setVendorName(const StringRef &Str);
226 /// setOSName - Set the operating system (third) component of the
228 void setOSName(const StringRef &Str);
230 /// setEnvironmentName - Set the optional environment (fourth)
231 /// component of the triple by name.
232 void setEnvironmentName(const StringRef &Str);
234 /// setOSAndEnvironmentName - Set the operating system and optional
235 /// environment components with a single string.
236 void setOSAndEnvironmentName(const StringRef &Str);
239 /// @name Static helpers for IDs.
242 /// getArchTypeName - Get the canonical name for the \arg Kind
244 static const char *getArchTypeName(ArchType Kind);
246 /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
247 /// architecture. This is the prefix used by the architecture specific
248 /// builtins, and is suitable for passing to \see
249 /// Intrinsic::getIntrinsicForGCCBuiltin().
251 /// \return - The architecture prefix, or 0 if none is defined.
252 static const char *getArchTypePrefix(ArchType Kind);
254 /// getVendorTypeName - Get the canonical name for the \arg Kind
256 static const char *getVendorTypeName(VendorType Kind);
258 /// getOSTypeName - Get the canonical name for the \arg Kind vendor.
259 static const char *getOSTypeName(OSType Kind);
262 /// @name Static helpers for converting alternate architecture names.
265 /// getArchTypeForLLVMName - The canonical type for the given LLVM
266 /// architecture name (e.g., "x86").
267 static ArchType getArchTypeForLLVMName(const StringRef &Str);
269 /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
270 /// architecture name, for example as accepted by "gcc -arch" (see also
272 static ArchType getArchTypeForDarwinArchName(const StringRef &Str);
277 } // End llvm namespace