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