Triple.h revision 832a9d1a76d30ffd295453e93e8eb52948e5813e 
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    glulx,   // Glulx: glulx, glulx1, glulx2, glulx3
54    mips,    // MIPS: mips, mipsallegrex
55    mipsel,  // MIPSEL: mipsel, mipsallegrexel, psp
56    msp430,  // MSP430: msp430
57    ppc,     // PPC: powerpc
58    ppc64,   // PPC64: powerpc64, ppu
59    sparc,   // Sparc: sparc
60    sparcv9, // Sparcv9: Sparcv9
61    systemz, // SystemZ: s390x
62    tce,     // TCE (http://tce.cs.tut.fi/): tce
63    thumb,   // Thumb: thumb, thumbv.*
64    x86,     // X86: i[3-9]86
65    x86_64,  // X86-64: amd64, x86_64
66    xcore,   // XCore: xcore
67    mblaze,  // MBlaze: mblaze
68    ptx32,   // PTX: ptx (32-bit)
69    ptx64,   // PTX: ptx (64-bit)
70
71    InvalidArch
72  };
73  enum VendorType {
74    UnknownVendor,
75
76    Apple,
77    PC,
78    SCEI
79  };
80  enum OSType {
81    UnknownOS,
82
83    AuroraUX,
84    Cygwin,
85    Darwin,
86    DragonFly,
87    FreeBSD,
88    IOS,
89    Linux,
90    Lv2,        // PS3
91    MacOSX,
92    MinGW32,    // i*86-pc-mingw32, *-w64-mingw32
93    NetBSD,
94    OpenBSD,
95    Psp,
96    Solaris,
97    Win32,
98    Haiku,
99    Minix
100  };
101  enum EnvironmentType {
102    UnknownEnvironment,
103
104    GNU,
105    GNUEABI,
106    EABI,
107    MachO
108  };
109
110private:
111  std::string Data;
112
113  /// The parsed arch type (or InvalidArch if uninitialized).
114  mutable ArchType Arch;
115
116  /// The parsed vendor type.
117  mutable VendorType Vendor;
118
119  /// The parsed OS type.
120  mutable OSType OS;
121
122  /// The parsed Environment type.
123  mutable EnvironmentType Environment;
124
125  bool isInitialized() const { return Arch != InvalidArch; }
126  static ArchType ParseArch(StringRef ArchName);
127  static VendorType ParseVendor(StringRef VendorName);
128  static OSType ParseOS(StringRef OSName);
129  static EnvironmentType ParseEnvironment(StringRef EnvironmentName);
130  void Parse() const;
131
132public:
133  /// @name Constructors
134  /// @{
135
136  Triple() : Data(), Arch(InvalidArch) {}
137  explicit Triple(StringRef Str) : Data(Str), Arch(InvalidArch) {}
138  explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr)
139    : Data(ArchStr), Arch(InvalidArch) {
140    Data += '-';
141    Data += VendorStr;
142    Data += '-';
143    Data += OSStr;
144  }
145
146  explicit Triple(StringRef ArchStr, StringRef VendorStr, StringRef OSStr,
147    StringRef EnvironmentStr)
148    : Data(ArchStr), Arch(InvalidArch) {
149    Data += '-';
150    Data += VendorStr;
151    Data += '-';
152    Data += OSStr;
153    Data += '-';
154    Data += EnvironmentStr;
155  }
156
157  /// @}
158  /// @name Normalization
159  /// @{
160
161  /// normalize - Turn an arbitrary machine specification into the canonical
162  /// triple form (or something sensible that the Triple class understands if
163  /// nothing better can reasonably be done).  In particular, it handles the
164  /// common case in which otherwise valid components are in the wrong order.
165  static std::string normalize(StringRef Str);
166
167  /// @}
168  /// @name Typed Component Access
169  /// @{
170
171  /// getArch - Get the parsed architecture type of this triple.
172  ArchType getArch() const {
173    if (!isInitialized()) Parse();
174    return Arch;
175  }
176
177  /// getVendor - Get the parsed vendor type of this triple.
178  VendorType getVendor() const {
179    if (!isInitialized()) Parse();
180    return Vendor;
181  }
182
183  /// getOS - Get the parsed operating system type of this triple.
184  OSType getOS() const {
185    if (!isInitialized()) Parse();
186    return OS;
187  }
188
189  /// hasEnvironment - Does this triple have the optional environment
190  /// (fourth) component?
191  bool hasEnvironment() const {
192    return getEnvironmentName() != "";
193  }
194
195  /// getEnvironment - Get the parsed environment type of this triple.
196  EnvironmentType getEnvironment() const {
197    if (!isInitialized()) Parse();
198    return Environment;
199  }
200
201  /// @}
202  /// @name Direct Component Access
203  /// @{
204
205  const std::string &str() const { return Data; }
206
207  const std::string &getTriple() const { return Data; }
208
209  /// getArchName - Get the architecture (first) component of the
210  /// triple.
211  StringRef getArchName() const;
212
213  /// getVendorName - Get the vendor (second) component of the triple.
214  StringRef getVendorName() const;
215
216  /// getOSName - Get the operating system (third) component of the
217  /// triple.
218  StringRef getOSName() const;
219
220  /// getEnvironmentName - Get the optional environment (fourth)
221  /// component of the triple, or "" if empty.
222  StringRef getEnvironmentName() const;
223
224  /// getOSAndEnvironmentName - Get the operating system and optional
225  /// environment components as a single string (separated by a '-'
226  /// if the environment component is present).
227  StringRef getOSAndEnvironmentName() const;
228
229  /// getOSVersion - Parse the version number from the OS name component of the
230  /// triple, if present.
231  ///
232  /// For example, "fooos1.2.3" would return (1, 2, 3).
233  ///
234  /// If an entry is not defined, it will be returned as 0.
235  void getOSVersion(unsigned &Major, unsigned &Minor, unsigned &Micro) const;
236
237  /// getOSMajorVersion - Return just the major version number, this is
238  /// specialized because it is a common query.
239  unsigned getOSMajorVersion() const {
240    unsigned Maj, Min, Micro;
241    getDarwinNumber(Maj, Min, Micro);
242    return Maj;
243  }
244
245  void getDarwinNumber(unsigned &Major, unsigned &Minor,
246                       unsigned &Micro) const {
247    return getOSVersion(Major, Minor, Micro);
248  }
249
250  unsigned getDarwinMajorNumber() const {
251    return getOSMajorVersion();
252  }
253
254  /// isOSVersionLT - Helper function for doing comparisons against version
255  /// numbers included in the target triple.
256  bool isOSVersionLT(unsigned Major, unsigned Minor = 0,
257                     unsigned Micro = 0) const {
258    unsigned LHS[3];
259    getOSVersion(LHS[0], LHS[1], LHS[2]);
260
261    if (LHS[0] != Major)
262      return LHS[0] < Major;
263    if (LHS[1] != Minor)
264      return LHS[1] < Minor;
265    if (LHS[2] != Micro)
266      return LHS[1] < Micro;
267
268    return false;
269  }
270
271  /// isMacOSX - Is this a Mac OS X triple. For legacy reasons, we support both
272  /// "darwin" and "osx" as OS X triples.
273  bool isMacOSX() const {
274    return getOS() == Triple::Darwin || getOS() == Triple::MacOSX;
275  }
276
277  /// isOSDarwin - Is this a "Darwin" OS (OS X or iOS).
278  bool isOSDarwin() const {
279    return isMacOSX() ||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  /// isMacOSXVersionLT - Comparison function for checking OS X version
289  /// compatibility, which handles supporting skewed version numbering schemes
290  /// used by the "darwin" triples.
291  unsigned isMacOSXVersionLT(unsigned Major, unsigned Minor = 0,
292                          unsigned Micro = 0) const {
293    assert(isMacOSX() && "Not an OS X triple!");
294
295    // If this is OS X, expect a sane version number.
296    if (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