Triple.h revision 6f72ac4799a1a20c07cd96cc994dd6394ebff9a2 
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/Twine.h"
14
15// Some system headers or GCC predefined macros conflict with identifiers in
16// this file.  Undefine them here.
17#undef mips
18#undef sparc
19
20namespace llvm {
21
22/// Triple - Helper class for working with target triples.
23///
24/// Target triples are strings in the canonical form:
25///   ARCHITECTURE-VENDOR-OPERATING_SYSTEM
26/// or
27///   ARCHITECTURE-VENDOR-OPERATING_SYSTEM-ENVIRONMENT
28///
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.
33///
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.
38///
39/// See autoconf/config.guess for a glimpse into what triples look like in
40/// practice.
41class Triple {
42public:
43  enum ArchType {
44    UnknownArch,
45
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
54    ppc,     // PPC: powerpc
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.*
60    x86,     // X86: i[3-9]86
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
68
69    InvalidArch
70  };
71  enum VendorType {
72    UnknownVendor,
73
74    Apple,
75    PC,
76    SCEI
77  };
78  enum OSType {
79    UnknownOS,
80
81    AuroraUX,
82    Cygwin,
83    Darwin,
84    DragonFly,
85    FreeBSD,
86    IOS,
87    KFreeBSD,
88    Linux,
89    Lv2,        // PS3
90    MacOSX,
91    MinGW32,    // i*86-pc-mingw32, *-w64-mingw32
92    NetBSD,
93    OpenBSD,
94    Psp,
95    Solaris,
96    Win32,
97    Haiku,
98    Minix,
99    RTEMS,
100    NativeClient
101  };
102  enum EnvironmentType {
103    UnknownEnvironment,
104
105    GNU,
106    GNUEABI,
107    GNUEABIHF,
108    EABI,
109    MachO,
110    ANDROIDEABI
111  };
112
113private:
114  std::string Data;
115
116  /// The parsed arch type (or InvalidArch if uninitialized).
117  mutable ArchType Arch;
118
119  /// The parsed vendor type.
120  mutable VendorType Vendor;
121
122  /// The parsed OS type.
123  mutable OSType OS;
124
125  /// The parsed Environment type.
126  mutable EnvironmentType Environment;
127
128  bool isInitialized() const { return Arch != InvalidArch; }
129  static ArchType ParseArch(StringRef ArchName);
130  static VendorType ParseVendor(StringRef VendorName);
131  static OSType ParseOS(StringRef OSName);
132  static EnvironmentType ParseEnvironment(StringRef EnvironmentName);
133  void Parse() const;
134
135public:
136  /// @name Constructors
137  /// @{
138
139  Triple() : Data(), Arch(InvalidArch) {}
140  explicit Triple(const Twine &Str) : Data(Str.str()), Arch(InvalidArch) {}
141  Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr)
142    : Data((ArchStr + Twine('-') + VendorStr + Twine('-') + OSStr).str()),
143      Arch(InvalidArch) {
144  }
145
146  Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
147         const Twine &EnvironmentStr)
148    : Data((ArchStr + Twine('-') + VendorStr + Twine('-') + OSStr + Twine('-') +
149            EnvironmentStr).str()), Arch(InvalidArch) {
150  }
151
152  /// @}
153  /// @name Normalization
154  /// @{
155
156  /// normalize - Turn an arbitrary machine specification into the canonical
157  /// triple form (or something sensible that the Triple class understands if
158  /// nothing better can reasonably be done).  In particular, it handles the
159  /// common case in which otherwise valid components are in the wrong order.
160  static std::string normalize(StringRef Str);
161
162  /// @}
163  /// @name Typed Component Access
164  /// @{
165
166  /// getArch - Get the parsed architecture type of this triple.
167  ArchType getArch() const {
168    if (!isInitialized()) Parse();
169    return Arch;
170  }
171
172  /// getVendor - Get the parsed vendor type of this triple.
173  VendorType getVendor() const {
174    if (!isInitialized()) Parse();
175    return Vendor;
176  }
177
178  /// getOS - Get the parsed operating system type of this triple.
179  OSType getOS() const {
180    if (!isInitialized()) Parse();
181    return OS;
182  }
183
184  /// hasEnvironment - Does this triple have the optional environment
185  /// (fourth) component?
186  bool hasEnvironment() const {
187    return getEnvironmentName() != "";
188  }
189
190  /// getEnvironment - Get the parsed environment type of this triple.
191  EnvironmentType getEnvironment() const {
192    if (!isInitialized()) Parse();
193    return Environment;
194  }
195
196  /// getOSVersion - Parse the version number from the OS name component of the
197  /// triple, if present.
198  ///
199  /// For example, "fooos1.2.3" would return (1, 2, 3).
200  ///
201  /// If an entry is not defined, it will be returned as 0.
202  void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
203
204  /// getOSMajorVersion - Return just the major version number, this is
205  /// specialized because it is a common query.
206  unsigned getOSMajorVersion() const {
207    unsigned Maj, Min, Micro;
208    getOSVersion(Maj, Min, Micro);
209    return Maj;
210  }
211
212  /// @}
213  /// @name Direct Component Access
214  /// @{
215
216  const std::string &str() const { return Data; }
217
218  const std::string &getTriple() const { return Data; }
219
220  /// getArchName - Get the architecture (first) component of the
221  /// triple.
222  StringRef getArchName() const;
223
224  /// getVendorName - Get the vendor (second) component of the triple.
225  StringRef getVendorName() const;
226
227  /// getOSName - Get the operating system (third) component of the
228  /// triple.
229  StringRef getOSName() const;
230
231  /// getEnvironmentName - Get the optional environment (fourth)
232  /// component of the triple, or "" if empty.
233  StringRef getEnvironmentName() const;
234
235  /// getOSAndEnvironmentName - Get the operating system and optional
236  /// environment components as a single string (separated by a '-'
237  /// if the environment component is present).
238  StringRef getOSAndEnvironmentName() const;
239
240  /// @}
241  /// @name Convenience Predicates
242  /// @{
243
244  /// \brief Test whether the architecture is 64-bit
245  ///
246  /// Note that this tests for 64-bit pointer width, and nothing else. Note
247  /// that we intentionally expose only three predicates, 64-bit, 32-bit, and
248  /// 16-bit. The inner details of pointer width for particular architectures
249  /// is not summed up in the triple, and so only a coarse grained predicate
250  /// system is provided.
251  bool isArch64Bit() const;
252
253  /// \brief Test whether the architecture is 32-bit
254  ///
255  /// Note that this tests for 32-bit pointer width, and nothing else.
256  bool isArch32Bit() const;
257
258  /// \brief Test whether the architecture is 16-bit
259  ///
260  /// Note that this tests for 16-bit pointer width, and nothing else.
261  bool isArch16Bit() const;
262
263  /// isOSVersionLT - Helper function for doing comparisons against version
264  /// numbers included in the target triple.
265  bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
266                     unsigned Micro = 0) const {
267    unsigned LHS[3];
268    getOSVersion(LHS[0], LHS[1], LHS[2]);
269
270    if (LHS[0] != Major)
271      return LHS[0] < Major;
272    if (LHS[1] != Minor)
273      return LHS[1] < Minor;
274    if (LHS[2] != Micro)
275      return LHS[1] < Micro;
276
277    return false;
278  }
279
280  /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
281  /// "darwin" and "osx" as OS X triples.
282  bool isMacOSX() const {
283    return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
284  }
285
286  /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
287  bool isOSDarwin() const {
288    return isMacOSX() || getOS() == Triple::IOS;
289  }
290
291  /// isOSWindows - Is this a "Windows" OS.
292  bool isOSWindows() const {
293    return getOS() == Triple::Win32 || getOS() == Triple::Cygwin ||
294      getOS() == Triple::MinGW32;
295  }
296
297  /// isMacOSXVersionLT - Comparison function for checking OS X version
298  /// compatibility, which handles supporting skewed version numbering schemes
299  /// used by the "darwin" triples.
300  unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
301			     unsigned Micro = 0) const {
302    assert(isMacOSX() && "Not an OS X triple!");
303
304    // If this is OS X, expect a sane version number.
305    if (getOS() == Triple::MacOSX)
306      return isOSVersionLT(Major, Minor, Micro);
307
308    // Otherwise, compare to the "Darwin" number.
309    assert(Major == 10 && "Unexpected major version");
310    return isOSVersionLT(Minor + 4, Micro, 0);
311  }
312
313  /// @}
314  /// @name Mutators
315  /// @{
316
317  /// setArch - Set the architecture (first) component of the triple
318  /// to a known type.
319  void setArch(ArchType Kind);
320
321  /// setVendor - Set the vendor (second) component of the triple to a
322  /// known type.
323  void setVendor(VendorType Kind);
324
325  /// setOS - Set the operating system (third) component of the triple
326  /// to a known type.
327  void setOS(OSType Kind);
328
329  /// setEnvironment - Set the environment (fourth) component of the triple
330  /// to a known type.
331  void setEnvironment(EnvironmentType Kind);
332
333  /// setTriple - Set all components to the new triple \arg Str.
334  void setTriple(const Twine &Str);
335
336  /// setArchName - Set the architecture (first) component of the
337  /// triple by name.
338  void setArchName(StringRef Str);
339
340  /// setVendorName - Set the vendor (second) component of the triple
341  /// by name.
342  void setVendorName(StringRef Str);
343
344  /// setOSName - Set the operating system (third) component of the
345  /// triple by name.
346  void setOSName(StringRef Str);
347
348  /// setEnvironmentName - Set the optional environment (fourth)
349  /// component of the triple by name.
350  void setEnvironmentName(StringRef Str);
351
352  /// setOSAndEnvironmentName - Set the operating system and optional
353  /// environment components with a single string.
354  void setOSAndEnvironmentName(StringRef Str);
355
356  /// getArchNameForAssembler - Get an architecture name that is understood by
357  /// the target assembler.
358  const char *getArchNameForAssembler();
359
360  /// @}
361  /// @name Static helpers for IDs.
362  /// @{
363
364  /// getArchTypeName - Get the canonical name for the \arg Kind
365  /// architecture.
366  static const char *getArchTypeName(ArchType Kind);
367
368  /// getArchTypePrefix - Get the "prefix" canonical name for the \arg Kind
369  /// architecture. This is the prefix used by the architecture specific
370  /// builtins, and is suitable for passing to \see
371  /// Intrinsic::getIntrinsicForGCCBuiltin().
372  ///
373  /// \return - The architecture prefix, or 0 if none is defined.
374  static const char *getArchTypePrefix(ArchType Kind);
375
376  /// getVendorTypeName - Get the canonical name for the \arg Kind
377  /// vendor.
378  static const char *getVendorTypeName(VendorType Kind);
379
380  /// getOSTypeName - Get the canonical name for the \arg Kind operating
381  /// system.
382  static const char *getOSTypeName(OSType Kind);
383
384  /// getEnvironmentTypeName - Get the canonical name for the \arg Kind
385  /// environment.
386  static const char *getEnvironmentTypeName(EnvironmentType Kind);
387
388  /// @}
389  /// @name Static helpers for converting alternate architecture names.
390  /// @{
391
392  /// getArchTypeForLLVMName - The canonical type for the given LLVM
393  /// architecture name (e.g., "x86").
394  static ArchType getArchTypeForLLVMName(StringRef Str);
395
396  /// getArchTypeForDarwinArchName - Get the architecture type for a "Darwin"
397  /// architecture name, for example as accepted by "gcc -arch" (see also
398  /// arch(3)).
399  static ArchType getArchTypeForDarwinArchName(StringRef Str);
400
401  /// @}
402};
403
404} // End llvm namespace
405
406
407#endif
408