Triple.h revision 51cdac02c4125b8545728eb30ab5f54e437d6377 
1//===-- llvm/ADT/Triple.h - Target triple helper class ----------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef LLVM_ADT_TRIPLE_H
11#define LLVM_ADT_TRIPLE_H
12
13#include "llvm/ADT/StringRef.h"
14#include <string>
15
16// Some system headers or GCC predefined macros conflict with identifiers in
17// this file.  Undefine them here.
18#undef mips
19#undef sparc
20
21namespace llvm {
22class StringRef;
23class Twine;
24
25/// Triple - Helper class for working with target triples.
26///
27/// Target triples are strings in the format of:
28///   ARCHITECTURE-VENDOR-OPERATING_SYSTEM
29/// or
30///   ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
31///
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.
36///
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.
40///
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
45/// empty string.
46///
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).
50///
51/// See autoconf/config.guess for a glimpse into what they look like in
52/// practice.
53class Triple {
54public:
55  enum ArchType {
56    UnknownArch,
57
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
66    ppc,     // PPC: powerpc
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.*
72    x86,     // X86: i[3-9]86
73    x86_64,  // X86-64: amd64, x86_64
74    xcore,   // XCore: xcore
75
76    InvalidArch
77  };
78  enum VendorType {
79    UnknownVendor,
80
81    Apple,
82    PC
83  };
84  enum OSType {
85    UnknownOS,
86
87    AuroraUX,
88    Cygwin,
89    Darwin,
90    DragonFly,
91    FreeBSD,
92    Linux,
93    MinGW32,
94    MinGW64,
95    NetBSD,
96    OpenBSD,
97    Psp,
98    Solaris,
99    Win32,
100    Haiku
101  };
102
103private:
104  std::string Data;
105
106  /// The parsed arch type (or InvalidArch if uninitialized).
107  mutable ArchType Arch;
108
109  /// The parsed vendor type.
110  mutable VendorType Vendor;
111
112  /// The parsed OS type.
113  mutable OSType OS;
114
115  bool isInitialized() const { return Arch != InvalidArch; }
116  void Parse() const;
117
118public:
119  /// @name Constructors
120  /// @{
121
122  Triple() : Data(), Arch(InvalidArch) {}
123  explicit Triple(StringRef Str) : Data(Str), Arch(InvalidArch) {}
124  explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr)
125    : Data(ArchStr), Arch(InvalidArch) {
126    Data += '-';
127    Data += VendorStr;
128    Data += '-';
129    Data += OSStr;
130  }
131
132  /// @}
133  /// @name Typed Component Access
134  /// @{
135
136  /// getArch - Get the parsed architecture type of this triple.
137  ArchType getArch() const {
138    if (!isInitialized()) Parse();
139    return Arch;
140  }
141
142  /// getVendor - Get the parsed vendor type of this triple.
143  VendorType getVendor() const {
144    if (!isInitialized()) Parse();
145    return Vendor;
146  }
147
148  /// getOS - Get the parsed operating system type of this triple.
149  OSType getOS() const {
150    if (!isInitialized()) Parse();
151    return OS;
152  }
153
154  /// hasEnvironment - Does this triple have the optional environment
155  /// (fourth) component?
156  bool hasEnvironment() const {
157    return getEnvironmentName() != "";
158  }
159
160  /// @}
161  /// @name Direct Component Access
162  /// @{
163
164  const std::string &str() const { return Data; }
165
166  const std::string &getTriple() const { return Data; }
167
168  /// getArchName - Get the architecture (first) component of the
169  /// triple.
170  StringRef getArchName() const;
171
172  /// getVendorName - Get the vendor (second) component of the triple.
173  StringRef getVendorName() const;
174
175  /// getOSName - Get the operating system (third) component of the
176  /// triple.
177  StringRef getOSName() const;
178
179  /// getEnvironmentName - Get the optional environment (fourth)
180  /// component of the triple, or "" if empty.
181  StringRef getEnvironmentName() const;
182
183  /// getOSAndEnvironmentName - Get the operating system and optional
184  /// environment components as a single string (separated by a '-'
185  /// if the environment component is present).
186  StringRef getOSAndEnvironmentName() const;
187
188
189  /// getDarwinNumber - Parse the 'darwin number' out of the specific target
190  /// triple.  For example, if we have darwin8.5 return 8,5,0.  If any entry is
191  /// not defined, return 0's.  This requires that the triple have an OSType of
192  /// darwin before it is called.
193  void getDarwinNumber(unsigned &Maj, unsigned &Min, unsigned &Revision) const;
194
195  /// getDarwinMajorNumber - Return just the major version number, this is
196  /// specialized because it is a common query.
197  unsigned getDarwinMajorNumber() const {
198    unsigned Maj, Min, Rev;
199    getDarwinNumber(Maj, Min, Rev);
200    return Maj;
201  }
202
203  /// @}
204  /// @name Mutators
205  /// @{
206
207  /// setArch - Set the architecture (first) component of the triple
208  /// to a known type.
209  void setArch(ArchType Kind);
210
211  /// setVendor - Set the vendor (second) component of the triple to a
212  /// known type.
213  void setVendor(VendorType Kind);
214
215  /// setOS - Set the operating system (third) component of the triple
216  /// to a known type.
217  void setOS(OSType Kind);
218
219  /// setTriple - Set all components to the new triple \arg Str.
220  void setTriple(const Twine &Str);
221
222  /// setArchName - Set the architecture (first) component of the
223  /// triple by name.
224  void setArchName(StringRef Str);
225
226  /// setVendorName - Set the vendor (second) component of the triple
227  /// by name.
228  void setVendorName(StringRef Str);
229
230  /// setOSName - Set the operating system (third) component of the
231  /// triple by name.
232  void setOSName(StringRef Str);
233
234  /// setEnvironmentName - Set the optional environment (fourth)
235  /// component of the triple by name.
236  void setEnvironmentName(StringRef Str);
237
238  /// setOSAndEnvironmentName - Set the operating system and optional
239  /// environment components with a single string.
240  void setOSAndEnvironmentName(StringRef Str);
241
242  /// getArchNameForAssembler - Get an architecture name that is understood by the
243  /// target assembler.
244  const char *getArchNameForAssembler();
245
246  /// @}
247  /// @name Static helpers for IDs.
248  /// @{
249
250  /// getArchTypeName - Get the canonical name for the \arg Kind
251  /// architecture.
252  static const char *getArchTypeName(ArchType Kind);
253
254  /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
255  /// architecture. This is the prefix used by the architecture specific
256  /// builtins, and is suitable for passing to \see
257  /// Intrinsic::getIntrinsicForGCCBuiltin().
258  ///
259  /// \return - The architecture prefix, or 0 if none is defined.
260  static const char *getArchTypePrefix(ArchType Kind);
261
262  /// getVendorTypeName - Get the canonical name for the \arg Kind
263  /// vendor.
264  static const char *getVendorTypeName(VendorType Kind);
265
266  /// getOSTypeName - Get the canonical name for the \arg Kind vendor.
267  static const char *getOSTypeName(OSType Kind);
268
269  /// @}
270  /// @name Static helpers for converting alternate architecture names.
271  /// @{
272
273  /// getArchTypeForLLVMName - The canonical type for the given LLVM
274  /// architecture name (e.g., "x86").
275  static ArchType getArchTypeForLLVMName(StringRef Str);
276
277  /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
278  /// architecture name, for example as accepted by "gcc -arch" (see also
279  /// arch(3)).
280  static ArchType getArchTypeForDarwinArchName(StringRef Str);
281
282  /// @}
283};
284
285} // End llvm namespace
286
287
288#endif
289