utils/TableGen/NeonEmitter.cpp

   1 //===- NeonEmitter.cpp - Generate arm_neon.h for use with clang -*- 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 // This tablegen backend is responsible for emitting arm_neon.h, which includes
  11 // a declaration and definition of each function specified by the ARM NEON
  12 // compiler interface.  See ARM document DUI0348B.
  13 //
  14 // Each NEON instruction is implemented in terms of 1 or more functions which
  15 // are suffixed with the element type of the input vectors.  Functions may be
  16 // implemented in terms of generic vector operations such as +, *, -, etc. or
  17 // by calling a __builtin_-prefixed function which will be handled by clang's
  18 // CodeGen library.
  19 //
  20 // Additional validation code can be generated by this file when runHeader() is
  21 // called, rather than the normal run() entry point.  A complete set of tests
  22 // for Neon intrinsics can be generated by calling the runTests() entry point.
  23 //
  24 //===----------------------------------------------------------------------===//
  25
  26 #include "NeonEmitter.h"
  27 #include "llvm/ADT/SmallString.h"
  28 #include "llvm/ADT/SmallVector.h"
  29 #include "llvm/ADT/StringExtras.h"
  30 #include <string>
  31
  32 using namespace llvm;
  33
  34 /// ParseTypes - break down a string such as "fQf" into a vector of StringRefs,
  35 /// which each StringRef representing a single type declared in the string.
  36 /// for "fQf" we would end up with 2 StringRefs, "f", and "Qf", representing
  37 /// 2xfloat and 4xfloat respectively.
  38 static void ParseTypes(Record *r, std::string &s,
  39                        SmallVectorImpl<StringRef> &TV) {
  40   const char *data = s.data();
  41   int len = 0;
  42
  43   for (unsigned i = 0, e = s.size(); i != e; ++i, ++len) {
  44     if (data[len] == 'P' || data[len] == 'Q' || data[len] == 'U')
  45       continue;
  46
  47     switch (data[len]) {
  48       case 'c':
  49       case 's':
  50       case 'i':
  51       case 'l':
  52       case 'h':
  53       case 'f':
  54         break;
  55       default:
  56         throw TGError(r->getLoc(),
  57                       "Unexpected letter: " + std::string(data + len, 1));
  58         break;
  59     }
  60     TV.push_back(StringRef(data, len + 1));
  61     data += len + 1;
  62     len = -1;
  63   }
  64 }
  65
  66 /// Widen - Convert a type code into the next wider type.  char -> short,
  67 /// short -> int, etc.
  68 static char Widen(const char t) {
  69   switch (t) {
  70     case 'c':
  71       return 's';
  72     case 's':
  73       return 'i';
  74     case 'i':
  75       return 'l';
  76     case 'h':
  77       return 'f';
  78     default: throw "unhandled type in widen!";
  79   }
  80   return '\0';
  81 }
  82
  83 /// Narrow - Convert a type code into the next smaller type.  short -> char,
  84 /// float -> half float, etc.
  85 static char Narrow(const char t) {
  86   switch (t) {
  87     case 's':
  88       return 'c';
  89     case 'i':
  90       return 's';
  91     case 'l':
  92       return 'i';
  93     case 'f':
  94       return 'h';
  95     default: throw "unhandled type in narrow!";
  96   }
  97   return '\0';
  98 }
  99
 100 /// For a particular StringRef, return the base type code, and whether it has
 101 /// the quad-vector, polynomial, or unsigned modifiers set.
 102 static char ClassifyType(StringRef ty, bool &quad, bool &poly, bool &usgn) {
 103   unsigned off = 0;
 104
 105   // remember quad.
 106   if (ty[off] == 'Q') {
 107     quad = true;
 108     ++off;
 109   }
 110
 111   // remember poly.
 112   if (ty[off] == 'P') {
 113     poly = true;
 114     ++off;
 115   }
 116
 117   // remember unsigned.
 118   if (ty[off] == 'U') {
 119     usgn = true;
 120     ++off;
 121   }
 122
 123   // base type to get the type string for.
 124   return ty[off];
 125 }
 126
 127 /// ModType - Transform a type code and its modifiers based on a mod code. The
 128 /// mod code definitions may be found at the top of arm_neon.td.
 129 static char ModType(const char mod, char type, bool &quad, bool &poly,
 130                     bool &usgn, bool &scal, bool &cnst, bool &pntr) {
 131   switch (mod) {
 132     case 't':
 133       if (poly) {
 134         poly = false;
 135         usgn = true;
 136       }
 137       break;
 138     case 'u':
 139       usgn = true;
 140       poly = false;
 141       if (type == 'f')
 142         type = 'i';
 143       break;
 144     case 'x':
 145       usgn = false;
 146       poly = false;
 147       if (type == 'f')
 148         type = 'i';
 149       break;
 150     case 'f':
 151       if (type == 'h')
 152         quad = true;
 153       type = 'f';
 154       usgn = false;
 155       break;
 156     case 'g':
 157       quad = false;
 158       break;
 159     case 'w':
 160       type = Widen(type);
 161       quad = true;
 162       break;
 163     case 'n':
 164       type = Widen(type);
 165       break;
 166     case 'i':
 167       type = 'i';
 168       scal = true;
 169       break;
 170     case 'l':
 171       type = 'l';
 172       scal = true;
 173       usgn = true;
 174       break;
 175     case 's':
 176     case 'a':
 177       scal = true;
 178       break;
 179     case 'k':
 180       quad = true;
 181       break;
 182     case 'c':
 183       cnst = true;
 184     case 'p':
 185       pntr = true;
 186       scal = true;
 187       break;
 188     case 'h':
 189       type = Narrow(type);
 190       if (type == 'h')
 191         quad = false;
 192       break;
 193     case 'e':
 194       type = Narrow(type);
 195       usgn = true;
 196       break;
 197     default:
 198       break;
 199   }
 200   return type;
 201 }
 202
 203 /// TypeString - for a modifier and type, generate the name of the typedef for
 204 /// that type.  QUc -> uint8x8_t.
 205 static std::string TypeString(const char mod, StringRef typestr) {
 206   bool quad = false;
 207   bool poly = false;
 208   bool usgn = false;
 209   bool scal = false;
 210   bool cnst = false;
 211   bool pntr = false;
 212
 213   if (mod == 'v')
 214     return "void";
 215   if (mod == 'i')
 216     return "int";
 217
 218   // base type to get the type string for.
 219   char type = ClassifyType(typestr, quad, poly, usgn);
 220
 221   // Based on the modifying character, change the type and width if necessary.
 222   type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
 223
 224   SmallString<128> s;
 225
 226   if (usgn)
 227     s.push_back('u');
 228
 229   switch (type) {
 230     case 'c':
 231       s += poly ? "poly8" : "int8";
 232       if (scal)
 233         break;
 234       s += quad ? "x16" : "x8";
 235       break;
 236     case 's':
 237       s += poly ? "poly16" : "int16";
 238       if (scal)
 239         break;
 240       s += quad ? "x8" : "x4";
 241       break;
 242     case 'i':
 243       s += "int32";
 244       if (scal)
 245         break;
 246       s += quad ? "x4" : "x2";
 247       break;
 248     case 'l':
 249       s += "int64";
 250       if (scal)
 251         break;
 252       s += quad ? "x2" : "x1";
 253       break;
 254     case 'h':
 255       s += "float16";
 256       if (scal)
 257         break;
 258       s += quad ? "x8" : "x4";
 259       break;
 260     case 'f':
 261       s += "float32";
 262       if (scal)
 263         break;
 264       s += quad ? "x4" : "x2";
 265       break;
 266     default:
 267       throw "unhandled type!";
 268       break;
 269   }
 270
 271   if (mod == '2')
 272     s += "x2";
 273   if (mod == '3')
 274     s += "x3";
 275   if (mod == '4')
 276     s += "x4";
 277
 278   // Append _t, finishing the type string typedef type.
 279   s += "_t";
 280
 281   if (cnst)
 282     s += " const";
 283
 284   if (pntr)
 285     s += " *";
 286
 287   return s.str();
 288 }
 289
 290 /// BuiltinTypeString - for a modifier and type, generate the clang
 291 /// BuiltinsARM.def prototype code for the function.  See the top of clang's
 292 /// Builtins.def for a description of the type strings.
 293 static std::string BuiltinTypeString(const char mod, StringRef typestr,
 294                                      ClassKind ck, bool ret) {
 295   bool quad = false;
 296   bool poly = false;
 297   bool usgn = false;
 298   bool scal = false;
 299   bool cnst = false;
 300   bool pntr = false;
 301
 302   if (mod == 'v')
 303     return "v"; // void
 304   if (mod == 'i')
 305     return "i"; // int
 306
 307   // base type to get the type string for.
 308   char type = ClassifyType(typestr, quad, poly, usgn);
 309
 310   // Based on the modifying character, change the type and width if necessary.
 311   type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
 312
 313   // All pointers are void* pointers.  Change type to 'v' now.
 314   if (pntr) {
 315     usgn = false;
 316     poly = false;
 317     type = 'v';
 318   }
 319   // Treat half-float ('h') types as unsigned short ('s') types.
 320   if (type == 'h') {
 321     type = 's';
 322     usgn = true;
 323   }
 324   usgn = usgn | poly | ((ck == ClassI || ck == ClassW) && scal && type != 'f');
 325
 326   if (scal) {
 327     SmallString<128> s;
 328
 329     if (usgn)
 330       s.push_back('U');
 331     else if (type == 'c')
 332       s.push_back('S'); // make chars explicitly signed
 333
 334     if (type == 'l') // 64-bit long
 335       s += "LLi";
 336     else
 337       s.push_back(type);
 338
 339     if (cnst)
 340       s.push_back('C');
 341     if (pntr)
 342       s.push_back('*');
 343     return s.str();
 344   }
 345
 346   // Since the return value must be one type, return a vector type of the
 347   // appropriate width which we will bitcast.  An exception is made for
 348   // returning structs of 2, 3, or 4 vectors which are returned in a sret-like
 349   // fashion, storing them to a pointer arg.
 350   if (ret) {
 351     if (mod >= '2' && mod <= '4')
 352       return "vv*"; // void result with void* first argument
 353     if (mod == 'f' || (ck != ClassB && type == 'f'))
 354       return quad ? "V4f" : "V2f";
 355     if (ck != ClassB && type == 's')
 356       return quad ? "V8s" : "V4s";
 357     if (ck != ClassB && type == 'i')
 358       return quad ? "V4i" : "V2i";
 359     if (ck != ClassB && type == 'l')
 360       return quad ? "V2LLi" : "V1LLi";
 361
 362     return quad ? "V16Sc" : "V8Sc";
 363   }
 364
 365   // Non-return array types are passed as individual vectors.
 366   if (mod == '2')
 367     return quad ? "V16ScV16Sc" : "V8ScV8Sc";
 368   if (mod == '3')
 369     return quad ? "V16ScV16ScV16Sc" : "V8ScV8ScV8Sc";
 370   if (mod == '4')
 371     return quad ? "V16ScV16ScV16ScV16Sc" : "V8ScV8ScV8ScV8Sc";
 372
 373   if (mod == 'f' || (ck != ClassB && type == 'f'))
 374     return quad ? "V4f" : "V2f";
 375   if (ck != ClassB && type == 's')
 376     return quad ? "V8s" : "V4s";
 377   if (ck != ClassB && type == 'i')
 378     return quad ? "V4i" : "V2i";
 379   if (ck != ClassB && type == 'l')
 380     return quad ? "V2LLi" : "V1LLi";
 381
 382   return quad ? "V16Sc" : "V8Sc";
 383 }
 384
 385 /// MangleName - Append a type or width suffix to a base neon function name,
 386 /// and insert a 'q' in the appropriate location if the operation works on
 387 /// 128b rather than 64b.   E.g. turn "vst2_lane" into "vst2q_lane_f32", etc.
 388 static std::string MangleName(const std::string &name, StringRef typestr,
 389                               ClassKind ck) {
 390   if (name == "vcvt_f32_f16")
 391     return name;
 392
 393   bool quad = false;
 394   bool poly = false;
 395   bool usgn = false;
 396   char type = ClassifyType(typestr, quad, poly, usgn);
 397
 398   std::string s = name;
 399
 400   switch (type) {
 401   case 'c':
 402     switch (ck) {
 403     case ClassS: s += poly ? "_p8" : usgn ? "_u8" : "_s8"; break;
 404     case ClassI: s += "_i8"; break;
 405     case ClassW: s += "_8"; break;
 406     default: break;
 407     }
 408     break;
 409   case 's':
 410     switch (ck) {
 411     case ClassS: s += poly ? "_p16" : usgn ? "_u16" : "_s16"; break;
 412     case ClassI: s += "_i16"; break;
 413     case ClassW: s += "_16"; break;
 414     default: break;
 415     }
 416     break;
 417   case 'i':
 418     switch (ck) {
 419     case ClassS: s += usgn ? "_u32" : "_s32"; break;
 420     case ClassI: s += "_i32"; break;
 421     case ClassW: s += "_32"; break;
 422     default: break;
 423     }
 424     break;
 425   case 'l':
 426     switch (ck) {
 427     case ClassS: s += usgn ? "_u64" : "_s64"; break;
 428     case ClassI: s += "_i64"; break;
 429     case ClassW: s += "_64"; break;
 430     default: break;
 431     }
 432     break;
 433   case 'h':
 434     switch (ck) {
 435     case ClassS:
 436     case ClassI: s += "_f16"; break;
 437     case ClassW: s += "_16"; break;
 438     default: break;
 439     }
 440     break;
 441   case 'f':
 442     switch (ck) {
 443     case ClassS:
 444     case ClassI: s += "_f32"; break;
 445     case ClassW: s += "_32"; break;
 446     default: break;
 447     }
 448     break;
 449   default:
 450     throw "unhandled type!";
 451     break;
 452   }
 453   if (ck == ClassB)
 454     s += "_v";
 455
 456   // Insert a 'q' before the first '_' character so that it ends up before
 457   // _lane or _n on vector-scalar operations.
 458   if (quad) {
 459     size_t pos = s.find('_');
 460     s = s.insert(pos, "q");
 461   }
 462   return s;
 463 }
 464
 465 // Generate the string "(argtype a, argtype b, ...)"
 466 static std::string GenArgs(const std::string &proto, StringRef typestr) {
 467   bool define = proto.find('i') != std::string::npos;
 468   char arg = 'a';
 469
 470   std::string s;
 471   s += "(";
 472
 473   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 474     if (define) {
 475       // Immediate macro arguments are used directly instead of being assigned
 476       // to local temporaries; prepend an underscore prefix to make their
 477       // names consistent with the local temporaries.
 478       if (proto[i] == 'i')
 479         s += "__";
 480     } else {
 481       s += TypeString(proto[i], typestr) + " __";
 482     }
 483     s.push_back(arg);
 484     if ((i + 1) < e)
 485       s += ", ";
 486   }
 487
 488   s += ")";
 489   return s;
 490 }
 491
 492 // Macro arguments are not type-checked like inline function arguments, so
 493 // assign them to local temporaries to get the right type checking.
 494 static std::string GenMacroLocals(const std::string &proto, StringRef typestr) {
 495   char arg = 'a';
 496   std::string s;
 497
 498   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 499     // Do not create a temporary for an immediate argument.
 500     // That would defeat the whole point of using a macro!
 501     if (proto[i] == 'i') continue;
 502
 503     s += TypeString(proto[i], typestr) + " __";
 504     s.push_back(arg);
 505     s += " = (";
 506     s.push_back(arg);
 507     s += "); ";
 508   }
 509
 510   s += "\\\n  ";
 511   return s;
 512 }
 513
 514 // Use the vmovl builtin to sign-extend or zero-extend a vector.
 515 static std::string Extend(StringRef typestr, const std::string &a) {
 516   std::string s;
 517   s = MangleName("vmovl", typestr, ClassS);
 518   s += "(" + a + ")";
 519   return s;
 520 }
 521
 522 static std::string Duplicate(unsigned nElts, StringRef typestr,
 523                              const std::string &a) {
 524   std::string s;
 525
 526   s = "(" + TypeString('d', typestr) + "){ ";
 527   for (unsigned i = 0; i != nElts; ++i) {
 528     s += a;
 529     if ((i + 1) < nElts)
 530       s += ", ";
 531   }
 532   s += " }";
 533
 534   return s;
 535 }
 536
 537 static std::string SplatLane(unsigned nElts, const std::string &vec,
 538                              const std::string &lane) {
 539   std::string s = "__builtin_shufflevector(" + vec + ", " + vec;
 540   for (unsigned i = 0; i < nElts; ++i)
 541     s += ", " + lane;
 542   s += ")";
 543   return s;
 544 }
 545
 546 static unsigned GetNumElements(StringRef typestr, bool &quad) {
 547   quad = false;
 548   bool dummy = false;
 549   char type = ClassifyType(typestr, quad, dummy, dummy);
 550   unsigned nElts = 0;
 551   switch (type) {
 552   case 'c': nElts = 8; break;
 553   case 's': nElts = 4; break;
 554   case 'i': nElts = 2; break;
 555   case 'l': nElts = 1; break;
 556   case 'h': nElts = 4; break;
 557   case 'f': nElts = 2; break;
 558   default:
 559     throw "unhandled type!";
 560     break;
 561   }
 562   if (quad) nElts <<= 1;
 563   return nElts;
 564 }
 565
 566 // Generate the definition for this intrinsic, e.g. "a + b" for OpAdd.
 567 static std::string GenOpString(OpKind op, const std::string &proto,
 568                                StringRef typestr) {
 569   bool quad;
 570   unsigned nElts = GetNumElements(typestr, quad);
 571
 572   // If this builtin takes an immediate argument, we need to #define it rather
 573   // than use a standard declaration, so that SemaChecking can range check
 574   // the immediate passed by the user.
 575   bool define = proto.find('i') != std::string::npos;
 576
 577   std::string ts = TypeString(proto[0], typestr);
 578   std::string s;
 579   if (!define) {
 580     s = "return ";
 581   }
 582
 583   switch(op) {
 584   case OpAdd:
 585     s += "__a + __b;";
 586     break;
 587   case OpAddl:
 588     s += Extend(typestr, "__a") + " + " + Extend(typestr, "__b") + ";";
 589     break;
 590   case OpAddw:
 591     s += "__a + " + Extend(typestr, "__b") + ";";
 592     break;
 593   case OpSub:
 594     s += "__a - __b;";
 595     break;
 596   case OpSubl:
 597     s += Extend(typestr, "__a") + " - " + Extend(typestr, "__b") + ";";
 598     break;
 599   case OpSubw:
 600     s += "__a - " + Extend(typestr, "__b") + ";";
 601     break;
 602   case OpMulN:
 603     s += "__a * " + Duplicate(nElts, typestr, "__b") + ";";
 604     break;
 605   case OpMulLane:
 606     s += "__a * " + SplatLane(nElts, "__b", "__c") + ";";
 607     break;
 608   case OpMul:
 609     s += "__a * __b;";
 610     break;
 611   case OpMullN:
 612     s += Extend(typestr, "__a") + " * " +
 613       Extend(typestr, Duplicate(nElts << (int)quad, typestr, "__b")) + ";";
 614     break;
 615   case OpMullLane:
 616     s += Extend(typestr, "__a") + " * " +
 617       Extend(typestr, SplatLane(nElts, "__b", "__c")) + ";";
 618     break;
 619   case OpMull:
 620     s += Extend(typestr, "__a") + " * " + Extend(typestr, "__b") + ";";
 621     break;
 622   case OpMlaN:
 623     s += "__a + (__b * " + Duplicate(nElts, typestr, "__c") + ");";
 624     break;
 625   case OpMlaLane:
 626     s += "__a + (__b * " + SplatLane(nElts, "__c", "__d") + ");";
 627     break;
 628   case OpMla:
 629     s += "__a + (__b * __c);";
 630     break;
 631   case OpMlalN:
 632     s += "__a + (" + Extend(typestr, "__b") + " * " +
 633       Extend(typestr, Duplicate(nElts, typestr, "__c")) + ");";
 634     break;
 635   case OpMlalLane:
 636     s += "__a + (" + Extend(typestr, "__b") + " * " +
 637       Extend(typestr, SplatLane(nElts, "__c", "__d")) + ");";
 638     break;
 639   case OpMlal:
 640     s += "__a + (" + Extend(typestr, "__b") + " * " +
 641       Extend(typestr, "__c") + ");";
 642     break;
 643   case OpMlsN:
 644     s += "__a - (__b * " + Duplicate(nElts, typestr, "__c") + ");";
 645     break;
 646   case OpMlsLane:
 647     s += "__a - (__b * " + SplatLane(nElts, "__c", "__d") + ");";
 648     break;
 649   case OpMls:
 650     s += "__a - (__b * __c);";
 651     break;
 652   case OpMlslN:
 653     s += "__a - (" + Extend(typestr, "__b") + " * " +
 654       Extend(typestr, Duplicate(nElts, typestr, "__c")) + ");";
 655     break;
 656   case OpMlslLane:
 657     s += "__a - (" + Extend(typestr, "__b") + " * " +
 658       Extend(typestr, SplatLane(nElts, "__c", "__d")) + ");";
 659     break;
 660   case OpMlsl:
 661     s += "__a - (" + Extend(typestr, "__b") + " * " +
 662       Extend(typestr, "__c") + ");";
 663     break;
 664   case OpQDMullLane:
 665     s += MangleName("vqdmull", typestr, ClassS) + "(__a, " +
 666       SplatLane(nElts, "__b", "__c") + ");";
 667     break;
 668   case OpQDMlalLane:
 669     s += MangleName("vqdmlal", typestr, ClassS) + "(__a, __b, " +
 670       SplatLane(nElts, "__c", "__d") + ");";
 671     break;
 672   case OpQDMlslLane:
 673     s += MangleName("vqdmlsl", typestr, ClassS) + "(__a, __b, " +
 674       SplatLane(nElts, "__c", "__d") + ");";
 675     break;
 676   case OpQDMulhLane:
 677     s += MangleName("vqdmulh", typestr, ClassS) + "(__a, " +
 678       SplatLane(nElts, "__b", "__c") + ");";
 679     break;
 680   case OpQRDMulhLane:
 681     s += MangleName("vqrdmulh", typestr, ClassS) + "(__a, " +
 682       SplatLane(nElts, "__b", "__c") + ");";
 683     break;
 684   case OpEq:
 685     s += "(" + ts + ")(__a == __b);";
 686     break;
 687   case OpGe:
 688     s += "(" + ts + ")(__a >= __b);";
 689     break;
 690   case OpLe:
 691     s += "(" + ts + ")(__a <= __b);";
 692     break;
 693   case OpGt:
 694     s += "(" + ts + ")(__a > __b);";
 695     break;
 696   case OpLt:
 697     s += "(" + ts + ")(__a < __b);";
 698     break;
 699   case OpNeg:
 700     s += " -__a;";
 701     break;
 702   case OpNot:
 703     s += " ~__a;";
 704     break;
 705   case OpAnd:
 706     s += "__a & __b;";
 707     break;
 708   case OpOr:
 709     s += "__a | __b;";
 710     break;
 711   case OpXor:
 712     s += "__a ^ __b;";
 713     break;
 714   case OpAndNot:
 715     s += "__a & ~__b;";
 716     break;
 717   case OpOrNot:
 718     s += "__a | ~__b;";
 719     break;
 720   case OpCast:
 721     s += "(" + ts + ")__a;";
 722     break;
 723   case OpConcat:
 724     s += "(" + ts + ")__builtin_shufflevector((int64x1_t)__a";
 725     s += ", (int64x1_t)__b, 0, 1);";
 726     break;
 727   case OpHi:
 728     s += "(" + ts +
 729       ")__builtin_shufflevector((int64x2_t)__a, (int64x2_t)__a, 1);";
 730     break;
 731   case OpLo:
 732     s += "(" + ts +
 733       ")__builtin_shufflevector((int64x2_t)__a, (int64x2_t)__a, 0);";
 734     break;
 735   case OpDup:
 736     s += Duplicate(nElts, typestr, "__a") + ";";
 737     break;
 738   case OpDupLane:
 739     s += SplatLane(nElts, "__a", "__b") + ";";
 740     break;
 741   case OpSelect:
 742     // ((0 & 1) | (~0 & 2))
 743     s += "(" + ts + ")";
 744     ts = TypeString(proto[1], typestr);
 745     s += "((__a & (" + ts + ")__b) | ";
 746     s += "(~__a & (" + ts + ")__c));";
 747     break;
 748   case OpRev16:
 749     s += "__builtin_shufflevector(__a, __a";
 750     for (unsigned i = 2; i <= nElts; i += 2)
 751       for (unsigned j = 0; j != 2; ++j)
 752         s += ", " + utostr(i - j - 1);
 753     s += ");";
 754     break;
 755   case OpRev32: {
 756     unsigned WordElts = nElts >> (1 + (int)quad);
 757     s += "__builtin_shufflevector(__a, __a";
 758     for (unsigned i = WordElts; i <= nElts; i += WordElts)
 759       for (unsigned j = 0; j != WordElts; ++j)
 760         s += ", " + utostr(i - j - 1);
 761     s += ");";
 762     break;
 763   }
 764   case OpRev64: {
 765     unsigned DblWordElts = nElts >> (int)quad;
 766     s += "__builtin_shufflevector(__a, __a";
 767     for (unsigned i = DblWordElts; i <= nElts; i += DblWordElts)
 768       for (unsigned j = 0; j != DblWordElts; ++j)
 769         s += ", " + utostr(i - j - 1);
 770     s += ");";
 771     break;
 772   }
 773   case OpAbdl: {
 774     std::string abd = MangleName("vabd", typestr, ClassS) + "(__a, __b)";
 775     if (typestr[0] != 'U') {
 776       // vabd results are always unsigned and must be zero-extended.
 777       std::string utype = "U" + typestr.str();
 778       s += "(" + TypeString(proto[0], typestr) + ")";
 779       abd = "(" + TypeString('d', utype) + ")" + abd;
 780       s += Extend(utype, abd) + ";";
 781     } else {
 782       s += Extend(typestr, abd) + ";";
 783     }
 784     break;
 785   }
 786   case OpAba:
 787     s += "__a + " + MangleName("vabd", typestr, ClassS) + "(__b, __c);";
 788     break;
 789   case OpAbal: {
 790     s += "__a + ";
 791     std::string abd = MangleName("vabd", typestr, ClassS) + "(__b, __c)";
 792     if (typestr[0] != 'U') {
 793       // vabd results are always unsigned and must be zero-extended.
 794       std::string utype = "U" + typestr.str();
 795       s += "(" + TypeString(proto[0], typestr) + ")";
 796       abd = "(" + TypeString('d', utype) + ")" + abd;
 797       s += Extend(utype, abd) + ";";
 798     } else {
 799       s += Extend(typestr, abd) + ";";
 800     }
 801     break;
 802   }
 803   default:
 804     throw "unknown OpKind!";
 805     break;
 806   }
 807   return s;
 808 }
 809
 810 static unsigned GetNeonEnum(const std::string &proto, StringRef typestr) {
 811   unsigned mod = proto[0];
 812   unsigned ret = 0;
 813
 814   if (mod == 'v' || mod == 'f')
 815     mod = proto[1];
 816
 817   bool quad = false;
 818   bool poly = false;
 819   bool usgn = false;
 820   bool scal = false;
 821   bool cnst = false;
 822   bool pntr = false;
 823
 824   // Base type to get the type string for.
 825   char type = ClassifyType(typestr, quad, poly, usgn);
 826
 827   // Based on the modifying character, change the type and width if necessary.
 828   type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
 829
 830   if (usgn)
 831     ret |= 0x08;
 832   if (quad && proto[1] != 'g')
 833     ret |= 0x10;
 834
 835   switch (type) {
 836     case 'c':
 837       ret |= poly ? 5 : 0;
 838       break;
 839     case 's':
 840       ret |= poly ? 6 : 1;
 841       break;
 842     case 'i':
 843       ret |= 2;
 844       break;
 845     case 'l':
 846       ret |= 3;
 847       break;
 848     case 'h':
 849       ret |= 7;
 850       break;
 851     case 'f':
 852       ret |= 4;
 853       break;
 854     default:
 855       throw "unhandled type!";
 856       break;
 857   }
 858   return ret;
 859 }
 860
 861 // Generate the definition for this intrinsic, e.g. __builtin_neon_cls(a)
 862 static std::string GenBuiltin(const std::string &name, const std::string &proto,
 863                               StringRef typestr, ClassKind ck) {
 864   std::string s;
 865
 866   // If this builtin returns a struct 2, 3, or 4 vectors, pass it as an implicit
 867   // sret-like argument.
 868   bool sret = (proto[0] >= '2' && proto[0] <= '4');
 869
 870   // If this builtin takes an immediate argument, we need to #define it rather
 871   // than use a standard declaration, so that SemaChecking can range check
 872   // the immediate passed by the user.
 873   bool define = proto.find('i') != std::string::npos;
 874
 875   // Check if the prototype has a scalar operand with the type of the vector
 876   // elements.  If not, bitcasting the args will take care of arg checking.
 877   // The actual signedness etc. will be taken care of with special enums.
 878   if (proto.find('s') == std::string::npos)
 879     ck = ClassB;
 880
 881   if (proto[0] != 'v') {
 882     std::string ts = TypeString(proto[0], typestr);
 883
 884     if (define) {
 885       if (sret)
 886         s += ts + " r; ";
 887       else
 888         s += "(" + ts + ")";
 889     } else if (sret) {
 890       s += ts + " r; ";
 891     } else {
 892       s += "return (" + ts + ")";
 893     }
 894   }
 895
 896   bool splat = proto.find('a') != std::string::npos;
 897
 898   s += "__builtin_neon_";
 899   if (splat) {
 900     // Call the non-splat builtin: chop off the "_n" suffix from the name.
 901     std::string vname(name, 0, name.size()-2);
 902     s += MangleName(vname, typestr, ck);
 903   } else {
 904     s += MangleName(name, typestr, ck);
 905   }
 906   s += "(";
 907
 908   // Pass the address of the return variable as the first argument to sret-like
 909   // builtins.
 910   if (sret)
 911     s += "&r, ";
 912
 913   char arg = 'a';
 914   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 915     std::string args = std::string(&arg, 1);
 916
 917     // Use the local temporaries instead of the macro arguments.
 918     args = "__" + args;
 919
 920     bool argQuad = false;
 921     bool argPoly = false;
 922     bool argUsgn = false;
 923     bool argScalar = false;
 924     bool dummy = false;
 925     char argType = ClassifyType(typestr, argQuad, argPoly, argUsgn);
 926     argType = ModType(proto[i], argType, argQuad, argPoly, argUsgn, argScalar,
 927                       dummy, dummy);
 928
 929     // Handle multiple-vector values specially, emitting each subvector as an
 930     // argument to the __builtin.
 931     if (proto[i] >= '2' && proto[i] <= '4') {
 932       // Check if an explicit cast is needed.
 933       if (argType != 'c' || argPoly || argUsgn)
 934         args = (argQuad ? "(int8x16_t)" : "(int8x8_t)") + args;
 935
 936       for (unsigned vi = 0, ve = proto[i] - '0'; vi != ve; ++vi) {
 937         s += args + ".val[" + utostr(vi) + "]";
 938         if ((vi + 1) < ve)
 939           s += ", ";
 940       }
 941       if ((i + 1) < e)
 942         s += ", ";
 943
 944       continue;
 945     }
 946
 947     if (splat && (i + 1) == e)
 948       args = Duplicate(GetNumElements(typestr, argQuad), typestr, args);
 949
 950     // Check if an explicit cast is needed.
 951     if ((splat || !argScalar) &&
 952         ((ck == ClassB && argType != 'c') || argPoly || argUsgn)) {
 953       std::string argTypeStr = "c";
 954       if (ck != ClassB)
 955         argTypeStr = argType;
 956       if (argQuad)
 957         argTypeStr = "Q" + argTypeStr;
 958       args = "(" + TypeString('d', argTypeStr) + ")" + args;
 959     }
 960
 961     s += args;
 962     if ((i + 1) < e)
 963       s += ", ";
 964   }
 965
 966   // Extra constant integer to hold type class enum for this function, e.g. s8
 967   if (ck == ClassB)
 968     s += ", " + utostr(GetNeonEnum(proto, typestr));
 969
 970   s += ");";
 971
 972   if (proto[0] != 'v' && sret) {
 973     if (define)
 974       s += " r;";
 975     else
 976       s += " return r;";
 977   }
 978   return s;
 979 }
 980
 981 static std::string GenBuiltinDef(const std::string &name,
 982                                  const std::string &proto,
 983                                  StringRef typestr, ClassKind ck) {
 984   std::string s("BUILTIN(__builtin_neon_");
 985
 986   // If all types are the same size, bitcasting the args will take care
 987   // of arg checking.  The actual signedness etc. will be taken care of with
 988   // special enums.
 989   if (proto.find('s') == std::string::npos)
 990     ck = ClassB;
 991
 992   s += MangleName(name, typestr, ck);
 993   s += ", \"";
 994
 995   for (unsigned i = 0, e = proto.size(); i != e; ++i)
 996     s += BuiltinTypeString(proto[i], typestr, ck, i == 0);
 997
 998   // Extra constant integer to hold type class enum for this function, e.g. s8
 999   if (ck == ClassB)
1000     s += "i";
1001
1002   s += "\", \"n\")";
1003   return s;
1004 }
1005
1006 static std::string GenIntrinsic(const std::string &name,
1007                                 const std::string &proto,
1008                                 StringRef outTypeStr, StringRef inTypeStr,
1009                                 OpKind kind, ClassKind classKind) {
1010   assert(!proto.empty() && "");
1011   bool define = proto.find('i') != std::string::npos;
1012   std::string s;
1013
1014   // static always inline + return type
1015   if (define)
1016     s += "#define ";
1017   else
1018     s += "__ai " + TypeString(proto[0], outTypeStr) + " ";
1019
1020   // Function name with type suffix
1021   std::string mangledName = MangleName(name, outTypeStr, ClassS);
1022   if (outTypeStr != inTypeStr) {
1023     // If the input type is different (e.g., for vreinterpret), append a suffix
1024     // for the input type.  String off a "Q" (quad) prefix so that MangleName
1025     // does not insert another "q" in the name.
1026     unsigned typeStrOff = (inTypeStr[0] == 'Q' ? 1 : 0);
1027     StringRef inTypeNoQuad = inTypeStr.substr(typeStrOff);
1028     mangledName = MangleName(mangledName, inTypeNoQuad, ClassS);
1029   }
1030   s += mangledName;
1031
1032   // Function arguments
1033   s += GenArgs(proto, inTypeStr);
1034
1035   // Definition.
1036   if (define) {
1037     s += " __extension__ ({ \\\n  ";
1038     s += GenMacroLocals(proto, inTypeStr);
1039   } else {
1040     s += " { \\\n  ";
1041   }
1042
1043   if (kind != OpNone)
1044     s += GenOpString(kind, proto, outTypeStr);
1045   else
1046     s += GenBuiltin(name, proto, outTypeStr, classKind);
1047   if (define)
1048     s += " })";
1049   else
1050     s += " }";
1051   s += "\n";
1052   return s;
1053 }
1054
1055 /// run - Read the records in arm_neon.td and output arm_neon.h.  arm_neon.h
1056 /// is comprised of type definitions and function declarations.
1057 void NeonEmitter::run(raw_ostream &OS) {
1058   OS <<
1059     "/*===---- arm_neon.h - ARM Neon intrinsics ------------------------------"
1060     "---===\n"
1061     " *\n"
1062     " * Permission is hereby granted, free of charge, to any person obtaining "
1063     "a copy\n"
1064     " * of this software and associated documentation files (the \"Software\"),"
1065     " to deal\n"
1066     " * in the Software without restriction, including without limitation the "
1067     "rights\n"
1068     " * to use, copy, modify, merge, publish, distribute, sublicense, "
1069     "and/or sell\n"
1070     " * copies of the Software, and to permit persons to whom the Software is\n"
1071     " * furnished to do so, subject to the following conditions:\n"
1072     " *\n"
1073     " * The above copyright notice and this permission notice shall be "
1074     "included in\n"
1075     " * all copies or substantial portions of the Software.\n"
1076     " *\n"
1077     " * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, "
1078     "EXPRESS OR\n"
1079     " * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF "
1080     "MERCHANTABILITY,\n"
1081     " * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT "
1082     "SHALL THE\n"
1083     " * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR "
1084     "OTHER\n"
1085     " * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, "
1086     "ARISING FROM,\n"
1087     " * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER "
1088     "DEALINGS IN\n"
1089     " * THE SOFTWARE.\n"
1090     " *\n"
1091     " *===--------------------------------------------------------------------"
1092     "---===\n"
1093     " */\n\n";
1094
1095   OS << "#ifndef __ARM_NEON_H\n";
1096   OS << "#define __ARM_NEON_H\n\n";
1097
1098   OS << "#ifndef __ARM_NEON__\n";
1099   OS << "#error \"NEON support not enabled\"\n";
1100   OS << "#endif\n\n";
1101
1102   OS << "#include <stdint.h>\n\n";
1103
1104   // Emit NEON-specific scalar typedefs.
1105   OS << "typedef float float32_t;\n";
1106   OS << "typedef int8_t poly8_t;\n";
1107   OS << "typedef int16_t poly16_t;\n";
1108   OS << "typedef uint16_t float16_t;\n";
1109
1110   // Emit Neon vector typedefs.
1111   std::string TypedefTypes("cQcsQsiQilQlUcQUcUsQUsUiQUiUlQUlhQhfQfPcQPcPsQPs");
1112   SmallVector<StringRef, 24> TDTypeVec;
1113   ParseTypes(0, TypedefTypes, TDTypeVec);
1114
1115   // Emit vector typedefs.
1116   for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1117     bool dummy, quad = false, poly = false;
1118     (void) ClassifyType(TDTypeVec[i], quad, poly, dummy);
1119     if (poly)
1120       OS << "typedef __attribute__((neon_polyvector_type(";
1121     else
1122       OS << "typedef __attribute__((neon_vector_type(";
1123
1124     unsigned nElts = GetNumElements(TDTypeVec[i], quad);
1125     OS << utostr(nElts) << "))) ";
1126     if (nElts < 10)
1127       OS << " ";
1128
1129     OS << TypeString('s', TDTypeVec[i]);
1130     OS << " " << TypeString('d', TDTypeVec[i]) << ";\n";
1131   }
1132   OS << "\n";
1133
1134   // Emit struct typedefs.
1135   for (unsigned vi = 2; vi != 5; ++vi) {
1136     for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1137       std::string ts = TypeString('d', TDTypeVec[i]);
1138       std::string vs = TypeString('0' + vi, TDTypeVec[i]);
1139       OS << "typedef struct " << vs << " {\n";
1140       OS << "  " << ts << " val";
1141       OS << "[" << utostr(vi) << "]";
1142       OS << ";\n} ";
1143       OS << vs << ";\n\n";
1144     }
1145   }
1146
1147   OS << "#define __ai static __attribute__((__always_inline__))\n\n";
1148
1149   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1150
1151   // Emit vmovl and vabd intrinsics first so they can be used by other
1152   // intrinsics.  (Some of the saturating multiply instructions are also
1153   // used to implement the corresponding "_lane" variants, but tablegen
1154   // sorts the records into alphabetical order so that the "_lane" variants
1155   // come after the intrinsics they use.)
1156   emitIntrinsic(OS, Records.getDef("VMOVL"));
1157   emitIntrinsic(OS, Records.getDef("VABD"));
1158
1159   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1160     Record *R = RV[i];
1161     if (R->getName() != "VMOVL" && R->getName() != "VABD")
1162       emitIntrinsic(OS, R);
1163   }
1164
1165   OS << "#undef __ai\n\n";
1166   OS << "#endif /* __ARM_NEON_H */\n";
1167 }
1168
1169 /// emitIntrinsic - Write out the arm_neon.h header file definitions for the
1170 /// intrinsics specified by record R.
1171 void NeonEmitter::emitIntrinsic(raw_ostream &OS, Record *R) {
1172   std::string name = R->getValueAsString("Name");
1173   std::string Proto = R->getValueAsString("Prototype");
1174   std::string Types = R->getValueAsString("Types");
1175
1176   SmallVector<StringRef, 16> TypeVec;
1177   ParseTypes(R, Types, TypeVec);
1178
1179   OpKind kind = OpMap[R->getValueAsDef("Operand")->getName()];
1180
1181   ClassKind classKind = ClassNone;
1182   if (R->getSuperClasses().size() >= 2)
1183     classKind = ClassMap[R->getSuperClasses()[1]];
1184   if (classKind == ClassNone && kind == OpNone)
1185     throw TGError(R->getLoc(), "Builtin has no class kind");
1186
1187   for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1188     if (kind == OpReinterpret) {
1189       bool outQuad = false;
1190       bool dummy = false;
1191       (void)ClassifyType(TypeVec[ti], outQuad, dummy, dummy);
1192       for (unsigned srcti = 0, srcte = TypeVec.size();
1193            srcti != srcte; ++srcti) {
1194         bool inQuad = false;
1195         (void)ClassifyType(TypeVec[srcti], inQuad, dummy, dummy);
1196         if (srcti == ti || inQuad != outQuad)
1197           continue;
1198         OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[srcti],
1199                            OpCast, ClassS);
1200       }
1201     } else {
1202       OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[ti],
1203                          kind, classKind);
1204     }
1205   }
1206   OS << "\n";
1207 }
1208
1209 static unsigned RangeFromType(const char mod, StringRef typestr) {
1210   // base type to get the type string for.
1211   bool quad = false, dummy = false;
1212   char type = ClassifyType(typestr, quad, dummy, dummy);
1213   type = ModType(mod, type, quad, dummy, dummy, dummy, dummy, dummy);
1214
1215   switch (type) {
1216     case 'c':
1217       return (8 << (int)quad) - 1;
1218     case 'h':
1219     case 's':
1220       return (4 << (int)quad) - 1;
1221     case 'f':
1222     case 'i':
1223       return (2 << (int)quad) - 1;
1224     case 'l':
1225       return (1 << (int)quad) - 1;
1226     default:
1227       throw "unhandled type!";
1228       break;
1229   }
1230   assert(0 && "unreachable");
1231   return 0;
1232 }
1233
1234 /// runHeader - Emit a file with sections defining:
1235 /// 1. the NEON section of BuiltinsARM.def.
1236 /// 2. the SemaChecking code for the type overload checking.
1237 /// 3. the SemaChecking code for validation of intrinsic immedate arguments.
1238 void NeonEmitter::runHeader(raw_ostream &OS) {
1239   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1240
1241   StringMap<OpKind> EmittedMap;
1242
1243   // Generate BuiltinsARM.def for NEON
1244   OS << "#ifdef GET_NEON_BUILTINS\n";
1245   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1246     Record *R = RV[i];
1247     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1248     if (k != OpNone)
1249       continue;
1250
1251     std::string Proto = R->getValueAsString("Prototype");
1252
1253     // Functions with 'a' (the splat code) in the type prototype should not get
1254     // their own builtin as they use the non-splat variant.
1255     if (Proto.find('a') != std::string::npos)
1256       continue;
1257
1258     std::string Types = R->getValueAsString("Types");
1259     SmallVector<StringRef, 16> TypeVec;
1260     ParseTypes(R, Types, TypeVec);
1261
1262     if (R->getSuperClasses().size() < 2)
1263       throw TGError(R->getLoc(), "Builtin has no class kind");
1264
1265     std::string name = R->getValueAsString("Name");
1266     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1267
1268     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1269       // Generate the BuiltinsARM.def declaration for this builtin, ensuring
1270       // that each unique BUILTIN() macro appears only once in the output
1271       // stream.
1272       std::string bd = GenBuiltinDef(name, Proto, TypeVec[ti], ck);
1273       if (EmittedMap.count(bd))
1274         continue;
1275
1276       EmittedMap[bd] = OpNone;
1277       OS << bd << "\n";
1278     }
1279   }
1280   OS << "#endif\n\n";
1281
1282   // Generate the overloaded type checking code for SemaChecking.cpp
1283   OS << "#ifdef GET_NEON_OVERLOAD_CHECK\n";
1284   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1285     Record *R = RV[i];
1286     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1287     if (k != OpNone)
1288       continue;
1289
1290     std::string Proto = R->getValueAsString("Prototype");
1291     std::string Types = R->getValueAsString("Types");
1292     std::string name = R->getValueAsString("Name");
1293
1294     // Functions with 'a' (the splat code) in the type prototype should not get
1295     // their own builtin as they use the non-splat variant.
1296     if (Proto.find('a') != std::string::npos)
1297       continue;
1298
1299     // Functions which have a scalar argument cannot be overloaded, no need to
1300     // check them if we are emitting the type checking code.
1301     if (Proto.find('s') != std::string::npos)
1302       continue;
1303
1304     SmallVector<StringRef, 16> TypeVec;
1305     ParseTypes(R, Types, TypeVec);
1306
1307     if (R->getSuperClasses().size() < 2)
1308       throw TGError(R->getLoc(), "Builtin has no class kind");
1309
1310     int si = -1, qi = -1;
1311     unsigned mask = 0, qmask = 0;
1312     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1313       // Generate the switch case(s) for this builtin for the type validation.
1314       bool quad = false, poly = false, usgn = false;
1315       (void) ClassifyType(TypeVec[ti], quad, poly, usgn);
1316
1317       if (quad) {
1318         qi = ti;
1319         qmask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1320       } else {
1321         si = ti;
1322         mask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1323       }
1324     }
1325     if (mask)
1326       OS << "case ARM::BI__builtin_neon_"
1327          << MangleName(name, TypeVec[si], ClassB)
1328          << ": mask = " << "0x" << utohexstr(mask) << "; break;\n";
1329     if (qmask)
1330       OS << "case ARM::BI__builtin_neon_"
1331          << MangleName(name, TypeVec[qi], ClassB)
1332          << ": mask = " << "0x" << utohexstr(qmask) << "; break;\n";
1333   }
1334   OS << "#endif\n\n";
1335
1336   // Generate the intrinsic range checking code for shift/lane immediates.
1337   OS << "#ifdef GET_NEON_IMMEDIATE_CHECK\n";
1338   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1339     Record *R = RV[i];
1340
1341     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1342     if (k != OpNone)
1343       continue;
1344
1345     std::string name = R->getValueAsString("Name");
1346     std::string Proto = R->getValueAsString("Prototype");
1347     std::string Types = R->getValueAsString("Types");
1348
1349     // Functions with 'a' (the splat code) in the type prototype should not get
1350     // their own builtin as they use the non-splat variant.
1351     if (Proto.find('a') != std::string::npos)
1352       continue;
1353
1354     // Functions which do not have an immediate do not need to have range
1355     // checking code emitted.
1356     size_t immPos = Proto.find('i');
1357     if (immPos == std::string::npos)
1358       continue;
1359
1360     SmallVector<StringRef, 16> TypeVec;
1361     ParseTypes(R, Types, TypeVec);
1362
1363     if (R->getSuperClasses().size() < 2)
1364       throw TGError(R->getLoc(), "Builtin has no class kind");
1365
1366     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1367
1368     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1369       std::string namestr, shiftstr, rangestr;
1370
1371       // Builtins which are overloaded by type will need to have their upper
1372       // bound computed at Sema time based on the type constant.
1373       if (Proto.find('s') == std::string::npos) {
1374         ck = ClassB;
1375         if (R->getValueAsBit("isShift")) {
1376           shiftstr = ", true";
1377
1378           // Right shifts have an 'r' in the name, left shifts do not.
1379           if (name.find('r') != std::string::npos)
1380             rangestr = "l = 1; ";
1381         }
1382         rangestr += "u = RFT(TV" + shiftstr + ")";
1383       } else {
1384         // The immediate generally refers to a lane in the preceding argument.
1385         assert(immPos > 0 && "unexpected immediate operand");
1386         rangestr = "u = " + utostr(RangeFromType(Proto[immPos-1], TypeVec[ti]));
1387       }
1388       // Make sure cases appear only once by uniquing them in a string map.
1389       namestr = MangleName(name, TypeVec[ti], ck);
1390       if (EmittedMap.count(namestr))
1391         continue;
1392       EmittedMap[namestr] = OpNone;
1393
1394       // Calculate the index of the immediate that should be range checked.
1395       unsigned immidx = 0;
1396
1397       // Builtins that return a struct of multiple vectors have an extra
1398       // leading arg for the struct return.
1399       if (Proto[0] >= '2' && Proto[0] <= '4')
1400         ++immidx;
1401
1402       // Add one to the index for each argument until we reach the immediate
1403       // to be checked.  Structs of vectors are passed as multiple arguments.
1404       for (unsigned ii = 1, ie = Proto.size(); ii != ie; ++ii) {
1405         switch (Proto[ii]) {
1406           default:  immidx += 1; break;
1407           case '2': immidx += 2; break;
1408           case '3': immidx += 3; break;
1409           case '4': immidx += 4; break;
1410           case 'i': ie = ii + 1; break;
1411         }
1412       }
1413       OS << "case ARM::BI__builtin_neon_" << MangleName(name, TypeVec[ti], ck)
1414          << ": i = " << immidx << "; " << rangestr << "; break;\n";
1415     }
1416   }
1417   OS << "#endif\n\n";
1418 }
1419
1420 /// GenTest - Write out a test for the intrinsic specified by the name and
1421 /// type strings, including the embedded patterns for FileCheck to match.
1422 static std::string GenTest(const std::string &name,
1423                            const std::string &proto,
1424                            StringRef outTypeStr, StringRef inTypeStr,
1425                            bool isShift) {
1426   assert(!proto.empty() && "");
1427   std::string s;
1428
1429   // Function name with type suffix
1430   std::string mangledName = MangleName(name, outTypeStr, ClassS);
1431   if (outTypeStr != inTypeStr) {
1432     // If the input type is different (e.g., for vreinterpret), append a suffix
1433     // for the input type.  String off a "Q" (quad) prefix so that MangleName
1434     // does not insert another "q" in the name.
1435     unsigned typeStrOff = (inTypeStr[0] == 'Q' ? 1 : 0);
1436     StringRef inTypeNoQuad = inTypeStr.substr(typeStrOff);
1437     mangledName = MangleName(mangledName, inTypeNoQuad, ClassS);
1438   }
1439
1440   // Emit the FileCheck patterns.
1441   s += "// CHECK: test_" + mangledName + "\n";
1442   // s += "// CHECK: \n"; // FIXME: + expected instruction opcode.
1443
1444   // Emit the start of the test function.
1445   s += TypeString(proto[0], outTypeStr) + " test_" + mangledName + "(";
1446   char arg = 'a';
1447   std::string comma;
1448   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
1449     // Do not create arguments for values that must be immediate constants.
1450     if (proto[i] == 'i')
1451       continue;
1452     s += comma + TypeString(proto[i], inTypeStr) + " ";
1453     s.push_back(arg);
1454     comma = ", ";
1455   }
1456   s += ") { \\\n  ";
1457
1458   if (proto[0] != 'v')
1459     s += "return ";
1460   s += mangledName + "(";
1461   arg = 'a';
1462   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
1463     if (proto[i] == 'i') {
1464       // For immediate operands, test the maximum value.
1465       if (isShift)
1466         s += "1"; // FIXME
1467       else
1468         // The immediate generally refers to a lane in the preceding argument.
1469         s += utostr(RangeFromType(proto[i-1], inTypeStr));
1470     } else {
1471       s.push_back(arg);
1472     }
1473     if ((i + 1) < e)
1474       s += ", ";
1475   }
1476   s += ");\n}\n\n";
1477   return s;
1478 }
1479
1480 /// runTests - Write out a complete set of tests for all of the Neon
1481 /// intrinsics.
1482 void NeonEmitter::runTests(raw_ostream &OS) {
1483   OS <<
1484     "// RUN: %clang_cc1 -triple thumbv7-apple-darwin \\\n"
1485     "// RUN:  -target-cpu cortex-a9 -ffreestanding -S -o - %s | FileCheck %s\n"
1486     "\n"
1487     "#include <arm_neon.h>\n"
1488     "\n";
1489
1490   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1491   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1492     Record *R = RV[i];
1493     std::string name = R->getValueAsString("Name");
1494     std::string Proto = R->getValueAsString("Prototype");
1495     std::string Types = R->getValueAsString("Types");
1496     bool isShift = R->getValueAsBit("isShift");
1497
1498     SmallVector<StringRef, 16> TypeVec;
1499     ParseTypes(R, Types, TypeVec);
1500
1501     OpKind kind = OpMap[R->getValueAsDef("Operand")->getName()];
1502     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1503       if (kind == OpReinterpret) {
1504         bool outQuad = false;
1505         bool dummy = false;
1506         (void)ClassifyType(TypeVec[ti], outQuad, dummy, dummy);
1507         for (unsigned srcti = 0, srcte = TypeVec.size();
1508              srcti != srcte; ++srcti) {
1509           bool inQuad = false;
1510           (void)ClassifyType(TypeVec[srcti], inQuad, dummy, dummy);
1511           if (srcti == ti || inQuad != outQuad)
1512             continue;
1513           OS << GenTest(name, Proto, TypeVec[ti], TypeVec[srcti], isShift);
1514         }
1515       } else {
1516         OS << GenTest(name, Proto, TypeVec[ti], TypeVec[ti], isShift);
1517       }
1518     }
1519     OS << "\n";
1520   }
1521 }
1522