Add a 'normalize' method to the Triple class, which takes a mucked up
[oota-llvm.git] / lib / Support / Triple.cpp
1 //===--- Triple.cpp - Target triple helper class --------------------------===//
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 #include "llvm/ADT/Triple.h"
11
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/Twine.h"
14 #include <cassert>
15 #include <cstring>
16 using namespace llvm;
17
18 //
19
20 const char *Triple::getArchTypeName(ArchType Kind) {
21   switch (Kind) {
22   case InvalidArch: return "<invalid>";
23   case UnknownArch: return "unknown";
24     
25   case alpha:   return "alpha";
26   case arm:     return "arm";
27   case bfin:    return "bfin";
28   case cellspu: return "cellspu";
29   case mips:    return "mips";
30   case mipsel:  return "mipsel";
31   case msp430:  return "msp430";
32   case pic16:   return "pic16";
33   case ppc64:   return "powerpc64";
34   case ppc:     return "powerpc";
35   case sparc:   return "sparc";
36   case sparcv9: return "sparcv9";
37   case systemz: return "s390x";
38   case tce:     return "tce";
39   case thumb:   return "thumb";
40   case x86:     return "i386";
41   case x86_64:  return "x86_64";
42   case xcore:   return "xcore";
43   case mblaze:  return "mblaze";
44   }
45
46   return "<invalid>";
47 }
48
49 const char *Triple::getArchTypePrefix(ArchType Kind) {
50   switch (Kind) {
51   default:
52     return 0;
53
54   case alpha:   return "alpha";
55
56   case arm:
57   case thumb:   return "arm";
58
59   case bfin:    return "bfin";
60
61   case cellspu: return "spu";
62
63   case ppc64:
64   case ppc:     return "ppc";
65
66   case mblaze:  return "mblaze";
67
68   case sparcv9:
69   case sparc:   return "sparc";
70
71   case x86:
72   case x86_64:  return "x86";
73   case xcore:   return "xcore";
74   }
75 }
76
77 const char *Triple::getVendorTypeName(VendorType Kind) {
78   switch (Kind) {
79   case UnknownVendor: return "unknown";
80
81   case Apple: return "apple";
82   case PC: return "pc";
83   }
84
85   return "<invalid>";
86 }
87
88 const char *Triple::getOSTypeName(OSType Kind) {
89   switch (Kind) {
90   case UnknownOS: return "unknown";
91
92   case AuroraUX: return "auroraux";
93   case Cygwin: return "cygwin";
94   case Darwin: return "darwin";
95   case DragonFly: return "dragonfly";
96   case FreeBSD: return "freebsd";
97   case Linux: return "linux";
98   case Lv2: return "lv2";
99   case MinGW32: return "mingw32";
100   case MinGW64: return "mingw64";
101   case NetBSD: return "netbsd";
102   case OpenBSD: return "openbsd";
103   case Psp: return "psp";
104   case Solaris: return "solaris";
105   case Win32: return "win32";
106   case Haiku: return "haiku";
107   case Minix: return "minix";
108   }
109
110   return "<invalid>";
111 }
112
113 Triple::ArchType Triple::getArchTypeForLLVMName(StringRef Name) {
114   if (Name == "alpha")
115     return alpha;
116   if (Name == "arm")
117     return arm;
118   if (Name == "bfin")
119     return bfin;
120   if (Name == "cellspu")
121     return cellspu;
122   if (Name == "mips")
123     return mips;
124   if (Name == "mipsel")
125     return mipsel;
126   if (Name == "msp430")
127     return msp430;
128   if (Name == "pic16")
129     return pic16;
130   if (Name == "ppc64")
131     return ppc64;
132   if (Name == "ppc")
133     return ppc;
134   if (Name == "mblaze")
135     return mblaze;
136   if (Name == "sparc")
137     return sparc;
138   if (Name == "sparcv9")
139     return sparcv9;
140   if (Name == "systemz")
141     return systemz;
142   if (Name == "tce")
143     return tce;
144   if (Name == "thumb")
145     return thumb;
146   if (Name == "x86")
147     return x86;
148   if (Name == "x86-64")
149     return x86_64;
150   if (Name == "xcore")
151     return xcore;
152
153   return UnknownArch;
154 }
155
156 Triple::ArchType Triple::getArchTypeForDarwinArchName(StringRef Str) {
157   // See arch(3) and llvm-gcc's driver-driver.c. We don't implement support for
158   // archs which Darwin doesn't use.
159
160   // The matching this routine does is fairly pointless, since it is neither the
161   // complete architecture list, nor a reasonable subset. The problem is that
162   // historically the driver driver accepts this and also ties its -march=
163   // handling to the architecture name, so we need to be careful before removing
164   // support for it.
165
166   // This code must be kept in sync with Clang's Darwin specific argument
167   // translation.
168
169   if (Str == "ppc" || Str == "ppc601" || Str == "ppc603" || Str == "ppc604" ||
170       Str == "ppc604e" || Str == "ppc750" || Str == "ppc7400" ||
171       Str == "ppc7450" || Str == "ppc970")
172     return Triple::ppc;
173
174   if (Str == "ppc64")
175     return Triple::ppc64;
176
177   if (Str == "i386" || Str == "i486" || Str == "i486SX" || Str == "pentium" ||
178       Str == "i586" || Str == "pentpro" || Str == "i686" || Str == "pentIIm3" ||
179       Str == "pentIIm5" || Str == "pentium4")
180     return Triple::x86;
181
182   if (Str == "x86_64")
183     return Triple::x86_64;
184
185   // This is derived from the driver driver.
186   if (Str == "arm" || Str == "armv4t" || Str == "armv5" || Str == "xscale" ||
187       Str == "armv6" || Str == "armv7")
188     return Triple::arm;
189
190   return Triple::UnknownArch;
191 }
192
193 // Returns architecture name that is understood by the target assembler.
194 const char *Triple::getArchNameForAssembler() {
195   if (getOS() != Triple::Darwin && getVendor() != Triple::Apple)
196     return NULL;
197
198   StringRef Str = getArchName();
199   if (Str == "i386")
200     return "i386";
201   if (Str == "x86_64")
202     return "x86_64";
203   if (Str == "powerpc")
204     return "ppc";
205   if (Str == "powerpc64")
206     return "ppc64";
207   if (Str == "mblaze" || Str == "microblaze")
208     return "mblaze";
209   if (Str == "arm")
210     return "arm";
211   if (Str == "armv4t" || Str == "thumbv4t")
212     return "armv4t";
213   if (Str == "armv5" || Str == "armv5e" || Str == "thumbv5" || Str == "thumbv5e")
214     return "armv5";
215   if (Str == "armv6" || Str == "thumbv6")
216     return "armv6";
217   if (Str == "armv7" || Str == "thumbv7")
218     return "armv7";
219   return NULL;
220 }
221
222 //
223
224 Triple::ArchType Triple::ParseArch(StringRef ArchName) {
225   if (ArchName.size() == 4 && ArchName[0] == 'i' && 
226       ArchName[2] == '8' && ArchName[3] == '6' && 
227       ArchName[1] - '3' < 6) // i[3-9]86
228     return x86;
229   else if (ArchName == "amd64" || ArchName == "x86_64")
230     return x86_64;
231   else if (ArchName == "bfin")
232     return bfin;
233   else if (ArchName == "pic16")
234     return pic16;
235   else if (ArchName == "powerpc")
236     return ppc;
237   else if ((ArchName == "powerpc64") || (ArchName == "ppu"))
238     return ppc64;
239   else if (ArchName == "mblaze")
240     return mblaze;
241   else if (ArchName == "arm" ||
242            ArchName.startswith("armv") ||
243            ArchName == "xscale")
244     return arm;
245   else if (ArchName == "thumb" ||
246            ArchName.startswith("thumbv"))
247     return thumb;
248   else if (ArchName.startswith("alpha"))
249     return alpha;
250   else if (ArchName == "spu" || ArchName == "cellspu")
251     return cellspu;
252   else if (ArchName == "msp430")
253     return msp430;
254   else if (ArchName == "mips" || ArchName == "mipsallegrex")
255     return mips;
256   else if (ArchName == "mipsel" || ArchName == "mipsallegrexel" ||
257            ArchName == "psp")
258     return mipsel;
259   else if (ArchName == "sparc")
260     return sparc;
261   else if (ArchName == "sparcv9")
262     return sparcv9;
263   else if (ArchName == "s390x")
264     return systemz;
265   else if (ArchName == "tce")
266     return tce;
267   else if (ArchName == "xcore")
268     return xcore;
269   else
270     return UnknownArch;
271 }
272
273 Triple::VendorType Triple::ParseVendor(StringRef VendorName) {
274   if (VendorName == "apple")
275     return Apple;
276   else if (VendorName == "pc")
277     return PC;
278   else
279     return UnknownVendor;
280 }
281
282 Triple::OSType Triple::ParseOS(StringRef OSName) {
283   if (OSName.startswith("auroraux"))
284     return AuroraUX;
285   else if (OSName.startswith("cygwin"))
286     return Cygwin;
287   else if (OSName.startswith("darwin"))
288     return Darwin;
289   else if (OSName.startswith("dragonfly"))
290     return DragonFly;
291   else if (OSName.startswith("freebsd"))
292     return FreeBSD;
293   else if (OSName.startswith("linux"))
294     return Linux;
295   else if (OSName.startswith("lv2"))
296     return Lv2;
297   else if (OSName.startswith("mingw32"))
298     return MinGW32;
299   else if (OSName.startswith("mingw64"))
300     return MinGW64;
301   else if (OSName.startswith("netbsd"))
302     return NetBSD;
303   else if (OSName.startswith("openbsd"))
304     return OpenBSD;
305   else if (OSName.startswith("psp"))
306     return Psp;
307   else if (OSName.startswith("solaris"))
308     return Solaris;
309   else if (OSName.startswith("win32"))
310     return Win32;
311   else if (OSName.startswith("haiku"))
312     return Haiku;
313   else if (OSName.startswith("minix"))
314     return Minix;
315   else
316     return UnknownOS;
317 }
318
319 void Triple::Parse() const {
320   assert(!isInitialized() && "Invalid parse call.");
321
322   Arch = ParseArch(getArchName());
323   Vendor = ParseVendor(getVendorName());
324   OS = ParseOS(getOSName());
325
326   // Handle some exceptional cases where the OS / environment components are
327   // stuck into the vendor field.
328   // TODO: Remove this logic and have places that need it use 'normalize'.
329   if (StringRef(getTriple()).count('-') == 1) {
330     StringRef VendorName = getVendorName();
331
332     if (VendorName.startswith("mingw32")) { // 'i386-mingw32', etc.
333       Vendor = PC;
334       OS = MinGW32;
335       return;
336     }
337
338     // arm-elf is another example, but we don't currently parse anything about
339     // the environment.
340   }
341
342   assert(isInitialized() && "Failed to initialize!");
343 }
344
345 std::string Triple::normalize(StringRef Str) {
346   // Parse into components.
347   SmallVector<StringRef, 4> Components;
348   for (size_t First = 0, Last = 0; Last != StringRef::npos; First = Last + 1) {
349     Last = Str.find('-', First);
350     Components.push_back(Str.slice(First, Last));
351   }
352
353   // If the first component corresponds to a known architecture, preferentially
354   // use it for the architecture.  If the second component corresponds to a
355   // known vendor, preferentially use it for the vendor, etc.  This avoids silly
356   // component movement when a component parses as (eg) both a valid arch and a
357   // valid os.
358   ArchType Arch = UnknownArch;
359   if (Components.size() > 0)
360     Arch = ParseArch(Components[0]);
361   VendorType Vendor = UnknownVendor;
362   if (Components.size() > 1)
363     Vendor = ParseVendor(Components[1]);
364   OSType OS = UnknownOS;
365   if (Components.size() > 2)
366     OS = ParseOS(Components[2]);
367
368   // Note which components are already in their final position.  These will not
369   // be moved.
370   bool Found[3];
371   Found[0] = Arch != UnknownArch;
372   Found[1] = Vendor != UnknownVendor;
373   Found[2] = OS != UnknownOS;
374
375   // If they are not there already, permute the components into their canonical
376   // positions by seeing if they parse as a valid architecture, and if so moving
377   // the component to the architecture position etc.
378   for (unsigned Pos = 0; Pos != 3; ++Pos) {
379     if (Found[Pos])
380       continue; // Already in the canonical position.
381
382     for (unsigned Idx = 0; Idx != Components.size(); ++Idx) {
383       // Do not reparse any components that already matched.
384       if (Idx < 3 && Found[Idx])
385         continue;
386
387       // Does this component parse as valid for the target position?
388       bool Valid = false;
389       StringRef Comp = Components[Idx];
390       switch (Pos) {
391       default:
392         assert(false && "unexpected component type!");
393       case 0:
394         Arch = ParseArch(Comp);
395         Valid = Arch != UnknownArch;
396         break;
397       case 1:
398         Vendor = ParseVendor(Comp);
399         Valid = Vendor != UnknownVendor;
400         break;
401       case 2:
402         OS = ParseOS(Comp);
403         Valid = OS != UnknownOS;
404         break;
405       }
406       if (!Valid)
407         continue; // Nope, try the next component.
408
409       // Move the component to the target position, pushing any non-fixed
410       // components that are in the way to the right.  This tends to give
411       // good results in the common cases of a forgotten vendor component
412       // or a wrongly positioned environment.
413       if (Pos < Idx) {
414         // Insert left, pushing the existing components to the right.  For
415         // example, a-b-i386 -> i386-a-b when moving i386 to the front.
416         StringRef CurrentComponent(""); // The empty component.
417         // Replace the component we are moving with an empty component.
418         std::swap(CurrentComponent, Components[Idx]);
419         // Insert the component being moved at Pos, displacing any existing
420         // components to the right.
421         for (unsigned i = Pos; !CurrentComponent.empty(); ++i) {
422           // Skip over any fixed components.
423           while (i < 3 && Found[i]) ++i;
424           // Place the component at the new position, getting the component
425           // that was at this position - it will be moved right.
426           std::swap(CurrentComponent, Components[i]);
427         }
428       } else if (Pos > Idx) {
429         // Push right by inserting empty components until the component at Idx
430         // reaches the target position Pos.  For example, pc-a -> -pc-a when
431         // moving pc to the second position.
432         do {
433           // Insert one empty component at Idx.
434           StringRef CurrentComponent(""); // The empty component.
435           for (unsigned i = Idx; i < Components.size(); ++i) {
436             // Skip over any fixed components.
437             while (i < 3 && Found[i]) ++i;
438             // Place the component at the new position, getting the component
439             // that was at this position - it will be moved right.
440             std::swap(CurrentComponent, Components[i]);
441             // If it was placed on top of an empty component then we are done.
442             if (CurrentComponent.empty())
443               break;
444           }
445           // The last component was pushed off the end - append it.
446           if (!CurrentComponent.empty())
447             Components.push_back(CurrentComponent);
448
449           // Advance Idx to the component's new position.
450           while (++Idx < 3 && Found[Idx]) {}
451         } while (Idx < Pos); // Add more until the final position is reached.
452       }
453       assert(Pos < Components.size() && Components[Pos] == Comp &&
454              "Component moved wrong!");
455       Found[Pos] = true;
456       break;
457     }
458   }
459
460   // Special case logic goes here.  At this point Arch, Vendor and OS have the
461   // correct values for the computed components.
462
463   // Stick the corrected components back together to form the normalized string.
464   std::string Normalized;
465   for (unsigned i = 0, e = Components.size(); i != e; ++i) {
466     if (i) Normalized += '-';
467     Normalized += Components[i];
468   }
469   return Normalized;
470 }
471
472 StringRef Triple::getArchName() const {
473   return StringRef(Data).split('-').first;           // Isolate first component
474 }
475
476 StringRef Triple::getVendorName() const {
477   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
478   return Tmp.split('-').first;                       // Isolate second component
479 }
480
481 StringRef Triple::getOSName() const {
482   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
483   Tmp = Tmp.split('-').second;                       // Strip second component
484   return Tmp.split('-').first;                       // Isolate third component
485 }
486
487 StringRef Triple::getEnvironmentName() const {
488   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
489   Tmp = Tmp.split('-').second;                       // Strip second component
490   return Tmp.split('-').second;                      // Strip third component
491 }
492
493 StringRef Triple::getOSAndEnvironmentName() const {
494   StringRef Tmp = StringRef(Data).split('-').second; // Strip first component
495   return Tmp.split('-').second;                      // Strip second component
496 }
497
498 static unsigned EatNumber(StringRef &Str) {
499   assert(!Str.empty() && Str[0] >= '0' && Str[0] <= '9' && "Not a number");
500   unsigned Result = Str[0]-'0';
501   
502   // Eat the digit.
503   Str = Str.substr(1);
504   
505   // Handle "darwin11".
506   if (Result == 1 && !Str.empty() && Str[0] >= '0' && Str[0] <= '9') {
507     Result = Result*10 + (Str[0] - '0');
508     // Eat the digit.
509     Str = Str.substr(1);
510   }
511   
512   return Result;
513 }
514
515 /// getDarwinNumber - Parse the 'darwin number' out of the specific target
516 /// triple.  For example, if we have darwin8.5 return 8,5,0.  If any entry is
517 /// not defined, return 0's.  This requires that the triple have an OSType of
518 /// darwin before it is called.
519 void Triple::getDarwinNumber(unsigned &Maj, unsigned &Min,
520                              unsigned &Revision) const {
521   assert(getOS() == Darwin && "Not a darwin target triple!");
522   StringRef OSName = getOSName();
523   assert(OSName.startswith("darwin") && "Unknown darwin target triple!");
524   
525   // Strip off "darwin".
526   OSName = OSName.substr(6);
527   
528   Maj = Min = Revision = 0;
529
530   if (OSName.empty() || OSName[0] < '0' || OSName[0] > '9')
531     return;
532
533   // The major version is the first digit.
534   Maj = EatNumber(OSName);
535   if (OSName.empty()) return;
536   
537   // Handle minor version: 10.4.9 -> darwin8.9.
538   if (OSName[0] != '.')
539     return;
540   
541   // Eat the '.'.
542   OSName = OSName.substr(1);
543
544   if (OSName.empty() || OSName[0] < '0' || OSName[0] > '9')
545     return;
546   
547   Min = EatNumber(OSName);
548   if (OSName.empty()) return;
549
550   // Handle revision darwin8.9.1
551   if (OSName[0] != '.')
552     return;
553   
554   // Eat the '.'.
555   OSName = OSName.substr(1);
556   
557   if (OSName.empty() || OSName[0] < '0' || OSName[0] > '9')
558     return;
559
560   Revision = EatNumber(OSName);
561 }
562
563 void Triple::setTriple(const Twine &Str) {
564   Data = Str.str();
565   Arch = InvalidArch;
566 }
567
568 void Triple::setArch(ArchType Kind) {
569   setArchName(getArchTypeName(Kind));
570 }
571
572 void Triple::setVendor(VendorType Kind) {
573   setVendorName(getVendorTypeName(Kind));
574 }
575
576 void Triple::setOS(OSType Kind) {
577   setOSName(getOSTypeName(Kind));
578 }
579
580 void Triple::setArchName(StringRef Str) {
581   // Work around a miscompilation bug for Twines in gcc 4.0.3.
582   SmallString<64> Triple;
583   Triple += Str;
584   Triple += "-";
585   Triple += getVendorName();
586   Triple += "-";
587   Triple += getOSAndEnvironmentName();
588   setTriple(Triple.str());
589 }
590
591 void Triple::setVendorName(StringRef Str) {
592   setTriple(getArchName() + "-" + Str + "-" + getOSAndEnvironmentName());
593 }
594
595 void Triple::setOSName(StringRef Str) {
596   if (hasEnvironment())
597     setTriple(getArchName() + "-" + getVendorName() + "-" + Str +
598               "-" + getEnvironmentName());
599   else
600     setTriple(getArchName() + "-" + getVendorName() + "-" + Str);
601 }
602
603 void Triple::setEnvironmentName(StringRef Str) {
604   setTriple(getArchName() + "-" + getVendorName() + "-" + getOSName() +
605             "-" + Str);
606 }
607
608 void Triple::setOSAndEnvironmentName(StringRef Str) {
609   setTriple(getArchName() + "-" + getVendorName() + "-" + Str);
610 }