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 (op == OpHi || op == OpLo) {
 580     s = "union { " + ts + " r; double d; } u; u.d = ";
 581   } else if (!define) {
 582     s = "return ";
 583   }
 584
 585   switch(op) {
 586   case OpAdd:
 587     s += "__a + __b;";
 588     break;
 589   case OpAddl:
 590     s += Extend(typestr, "__a") + " + " + Extend(typestr, "__b") + ";";
 591     break;
 592   case OpAddw:
 593     s += "__a + " + Extend(typestr, "__b") + ";";
 594     break;
 595   case OpSub:
 596     s += "__a - __b;";
 597     break;
 598   case OpSubl:
 599     s += Extend(typestr, "__a") + " - " + Extend(typestr, "__b") + ";";
 600     break;
 601   case OpSubw:
 602     s += "__a - " + Extend(typestr, "__b") + ";";
 603     break;
 604   case OpMulN:
 605     s += "__a * " + Duplicate(nElts, typestr, "__b") + ";";
 606     break;
 607   case OpMulLane:
 608     s += "__a * " + SplatLane(nElts, "__b", "__c") + ";";
 609     break;
 610   case OpMul:
 611     s += "__a * __b;";
 612     break;
 613   case OpMullN:
 614     s += Extend(typestr, "__a") + " * " +
 615       Extend(typestr, Duplicate(nElts << (int)quad, typestr, "__b")) + ";";
 616     break;
 617   case OpMullLane:
 618     s += Extend(typestr, "__a") + " * " +
 619       Extend(typestr, SplatLane(nElts, "__b", "__c")) + ";";
 620     break;
 621   case OpMull:
 622     s += Extend(typestr, "__a") + " * " + Extend(typestr, "__b") + ";";
 623     break;
 624   case OpMlaN:
 625     s += "__a + (__b * " + Duplicate(nElts, typestr, "__c") + ");";
 626     break;
 627   case OpMlaLane:
 628     s += "__a + (__b * " + SplatLane(nElts, "__c", "__d") + ");";
 629     break;
 630   case OpMla:
 631     s += "__a + (__b * __c);";
 632     break;
 633   case OpMlalN:
 634     s += "__a + (" + Extend(typestr, "__b") + " * " +
 635       Extend(typestr, Duplicate(nElts, typestr, "__c")) + ");";
 636     break;
 637   case OpMlalLane:
 638     s += "__a + (" + Extend(typestr, "__b") + " * " +
 639       Extend(typestr, SplatLane(nElts, "__c", "__d")) + ");";
 640     break;
 641   case OpMlal:
 642     s += "__a + (" + Extend(typestr, "__b") + " * " +
 643       Extend(typestr, "__c") + ");";
 644     break;
 645   case OpMlsN:
 646     s += "__a - (__b * " + Duplicate(nElts, typestr, "__c") + ");";
 647     break;
 648   case OpMlsLane:
 649     s += "__a - (__b * " + SplatLane(nElts, "__c", "__d") + ");";
 650     break;
 651   case OpMls:
 652     s += "__a - (__b * __c);";
 653     break;
 654   case OpMlslN:
 655     s += "__a - (" + Extend(typestr, "__b") + " * " +
 656       Extend(typestr, Duplicate(nElts, typestr, "__c")) + ");";
 657     break;
 658   case OpMlslLane:
 659     s += "__a - (" + Extend(typestr, "__b") + " * " +
 660       Extend(typestr, SplatLane(nElts, "__c", "__d")) + ");";
 661     break;
 662   case OpMlsl:
 663     s += "__a - (" + Extend(typestr, "__b") + " * " +
 664       Extend(typestr, "__c") + ");";
 665     break;
 666   case OpQDMullLane:
 667     s += MangleName("vqdmull", typestr, ClassS) + "(__a, " +
 668       SplatLane(nElts, "__b", "__c") + ");";
 669     break;
 670   case OpQDMlalLane:
 671     s += MangleName("vqdmlal", typestr, ClassS) + "(__a, __b, " +
 672       SplatLane(nElts, "__c", "__d") + ");";
 673     break;
 674   case OpQDMlslLane:
 675     s += MangleName("vqdmlsl", typestr, ClassS) + "(__a, __b, " +
 676       SplatLane(nElts, "__c", "__d") + ");";
 677     break;
 678   case OpQDMulhLane:
 679     s += MangleName("vqdmulh", typestr, ClassS) + "(__a, " +
 680       SplatLane(nElts, "__b", "__c") + ");";
 681     break;
 682   case OpQRDMulhLane:
 683     s += MangleName("vqrdmulh", typestr, ClassS) + "(__a, " +
 684       SplatLane(nElts, "__b", "__c") + ");";
 685     break;
 686   case OpEq:
 687     s += "(" + ts + ")(__a == __b);";
 688     break;
 689   case OpGe:
 690     s += "(" + ts + ")(__a >= __b);";
 691     break;
 692   case OpLe:
 693     s += "(" + ts + ")(__a <= __b);";
 694     break;
 695   case OpGt:
 696     s += "(" + ts + ")(__a > __b);";
 697     break;
 698   case OpLt:
 699     s += "(" + ts + ")(__a < __b);";
 700     break;
 701   case OpNeg:
 702     s += " -__a;";
 703     break;
 704   case OpNot:
 705     s += " ~__a;";
 706     break;
 707   case OpAnd:
 708     s += "__a & __b;";
 709     break;
 710   case OpOr:
 711     s += "__a | __b;";
 712     break;
 713   case OpXor:
 714     s += "__a ^ __b;";
 715     break;
 716   case OpAndNot:
 717     s += "__a & ~__b;";
 718     break;
 719   case OpOrNot:
 720     s += "__a | ~__b;";
 721     break;
 722   case OpCast:
 723     s += "(" + ts + ")__a;";
 724     break;
 725   case OpConcat:
 726     s += "(" + ts + ")__builtin_shufflevector((int64x1_t)__a";
 727     s += ", (int64x1_t)__b, 0, 1);";
 728     break;
 729   case OpHi:
 730     s += "(((float64x2_t)__a)[1]);";
 731     break;
 732   case OpLo:
 733     s += "(((float64x2_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   if (op == OpHi || op == OpLo) {
 808     if (!define)
 809       s += " return";
 810     s += " u.r;";
 811   }
 812   return s;
 813 }
 814
 815 static unsigned GetNeonEnum(const std::string &proto, StringRef typestr) {
 816   unsigned mod = proto[0];
 817   unsigned ret = 0;
 818
 819   if (mod == 'v' || mod == 'f')
 820     mod = proto[1];
 821
 822   bool quad = false;
 823   bool poly = false;
 824   bool usgn = false;
 825   bool scal = false;
 826   bool cnst = false;
 827   bool pntr = false;
 828
 829   // Base type to get the type string for.
 830   char type = ClassifyType(typestr, quad, poly, usgn);
 831
 832   // Based on the modifying character, change the type and width if necessary.
 833   type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
 834
 835   if (usgn)
 836     ret |= 0x08;
 837   if (quad && proto[1] != 'g')
 838     ret |= 0x10;
 839
 840   switch (type) {
 841     case 'c':
 842       ret |= poly ? 5 : 0;
 843       break;
 844     case 's':
 845       ret |= poly ? 6 : 1;
 846       break;
 847     case 'i':
 848       ret |= 2;
 849       break;
 850     case 'l':
 851       ret |= 3;
 852       break;
 853     case 'h':
 854       ret |= 7;
 855       break;
 856     case 'f':
 857       ret |= 4;
 858       break;
 859     default:
 860       throw "unhandled type!";
 861       break;
 862   }
 863   return ret;
 864 }
 865
 866 // Generate the definition for this intrinsic, e.g. __builtin_neon_cls(a)
 867 static std::string GenBuiltin(const std::string &name, const std::string &proto,
 868                               StringRef typestr, ClassKind ck) {
 869   std::string s;
 870
 871   // If this builtin returns a struct 2, 3, or 4 vectors, pass it as an implicit
 872   // sret-like argument.
 873   bool sret = (proto[0] >= '2' && proto[0] <= '4');
 874
 875   // If this builtin takes an immediate argument, we need to #define it rather
 876   // than use a standard declaration, so that SemaChecking can range check
 877   // the immediate passed by the user.
 878   bool define = proto.find('i') != std::string::npos;
 879
 880   // Check if the prototype has a scalar operand with the type of the vector
 881   // elements.  If not, bitcasting the args will take care of arg checking.
 882   // The actual signedness etc. will be taken care of with special enums.
 883   if (proto.find('s') == std::string::npos)
 884     ck = ClassB;
 885
 886   if (proto[0] != 'v') {
 887     std::string ts = TypeString(proto[0], typestr);
 888
 889     if (define) {
 890       if (sret)
 891         s += ts + " r; ";
 892       else
 893         s += "(" + ts + ")";
 894     } else if (sret) {
 895       s += ts + " r; ";
 896     } else {
 897       s += "return (" + ts + ")";
 898     }
 899   }
 900
 901   bool splat = proto.find('a') != std::string::npos;
 902
 903   s += "__builtin_neon_";
 904   if (splat) {
 905     // Call the non-splat builtin: chop off the "_n" suffix from the name.
 906     std::string vname(name, 0, name.size()-2);
 907     s += MangleName(vname, typestr, ck);
 908   } else {
 909     s += MangleName(name, typestr, ck);
 910   }
 911   s += "(";
 912
 913   // Pass the address of the return variable as the first argument to sret-like
 914   // builtins.
 915   if (sret)
 916     s += "&r, ";
 917
 918   char arg = 'a';
 919   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 920     std::string args = std::string(&arg, 1);
 921
 922     // Use the local temporaries instead of the macro arguments.
 923     args = "__" + args;
 924
 925     bool argQuad = false;
 926     bool argPoly = false;
 927     bool argUsgn = false;
 928     bool argScalar = false;
 929     bool dummy = false;
 930     char argType = ClassifyType(typestr, argQuad, argPoly, argUsgn);
 931     argType = ModType(proto[i], argType, argQuad, argPoly, argUsgn, argScalar,
 932                       dummy, dummy);
 933
 934     // Handle multiple-vector values specially, emitting each subvector as an
 935     // argument to the __builtin.
 936     if (proto[i] >= '2' && proto[i] <= '4') {
 937       // Check if an explicit cast is needed.
 938       if (argType != 'c' || argPoly || argUsgn)
 939         args = (argQuad ? "(int8x16_t)" : "(int8x8_t)") + args;
 940
 941       for (unsigned vi = 0, ve = proto[i] - '0'; vi != ve; ++vi) {
 942         s += args + ".val[" + utostr(vi) + "]";
 943         if ((vi + 1) < ve)
 944           s += ", ";
 945       }
 946       if ((i + 1) < e)
 947         s += ", ";
 948
 949       continue;
 950     }
 951
 952     if (splat && (i + 1) == e)
 953       args = Duplicate(GetNumElements(typestr, argQuad), typestr, args);
 954
 955     // Check if an explicit cast is needed.
 956     if ((splat || !argScalar) &&
 957         ((ck == ClassB && argType != 'c') || argPoly || argUsgn)) {
 958       std::string argTypeStr = "c";
 959       if (ck != ClassB)
 960         argTypeStr = argType;
 961       if (argQuad)
 962         argTypeStr = "Q" + argTypeStr;
 963       args = "(" + TypeString('d', argTypeStr) + ")" + args;
 964     }
 965
 966     s += args;
 967     if ((i + 1) < e)
 968       s += ", ";
 969   }
 970
 971   // Extra constant integer to hold type class enum for this function, e.g. s8
 972   if (ck == ClassB)
 973     s += ", " + utostr(GetNeonEnum(proto, typestr));
 974
 975   s += ");";
 976
 977   if (proto[0] != 'v' && sret) {
 978     if (define)
 979       s += " r;";
 980     else
 981       s += " return r;";
 982   }
 983   return s;
 984 }
 985
 986 static std::string GenBuiltinDef(const std::string &name,
 987                                  const std::string &proto,
 988                                  StringRef typestr, ClassKind ck) {
 989   std::string s("BUILTIN(__builtin_neon_");
 990
 991   // If all types are the same size, bitcasting the args will take care
 992   // of arg checking.  The actual signedness etc. will be taken care of with
 993   // special enums.
 994   if (proto.find('s') == std::string::npos)
 995     ck = ClassB;
 996
 997   s += MangleName(name, typestr, ck);
 998   s += ", \"";
 999
1000   for (unsigned i = 0, e = proto.size(); i != e; ++i)
1001     s += BuiltinTypeString(proto[i], typestr, ck, i == 0);
1002
1003   // Extra constant integer to hold type class enum for this function, e.g. s8
1004   if (ck == ClassB)
1005     s += "i";
1006
1007   s += "\", \"n\")";
1008   return s;
1009 }
1010
1011 static std::string GenIntrinsic(const std::string &name,
1012                                 const std::string &proto,
1013                                 StringRef outTypeStr, StringRef inTypeStr,
1014                                 OpKind kind, ClassKind classKind) {
1015   assert(!proto.empty() && "");
1016   bool define = proto.find('i') != std::string::npos;
1017   std::string s;
1018
1019   // static always inline + return type
1020   if (define)
1021     s += "#define ";
1022   else
1023     s += "__ai " + TypeString(proto[0], outTypeStr) + " ";
1024
1025   // Function name with type suffix
1026   std::string mangledName = MangleName(name, outTypeStr, ClassS);
1027   if (outTypeStr != inTypeStr) {
1028     // If the input type is different (e.g., for vreinterpret), append a suffix
1029     // for the input type.  String off a "Q" (quad) prefix so that MangleName
1030     // does not insert another "q" in the name.
1031     unsigned typeStrOff = (inTypeStr[0] == 'Q' ? 1 : 0);
1032     StringRef inTypeNoQuad = inTypeStr.substr(typeStrOff);
1033     mangledName = MangleName(mangledName, inTypeNoQuad, ClassS);
1034   }
1035   s += mangledName;
1036
1037   // Function arguments
1038   s += GenArgs(proto, inTypeStr);
1039
1040   // Definition.
1041   if (define) {
1042     s += " __extension__ ({ \\\n  ";
1043     s += GenMacroLocals(proto, inTypeStr);
1044   } else {
1045     s += " { \\\n  ";
1046   }
1047
1048   if (kind != OpNone)
1049     s += GenOpString(kind, proto, outTypeStr);
1050   else
1051     s += GenBuiltin(name, proto, outTypeStr, classKind);
1052   if (define)
1053     s += " })";
1054   else
1055     s += " }";
1056   s += "\n";
1057   return s;
1058 }
1059
1060 /// run - Read the records in arm_neon.td and output arm_neon.h.  arm_neon.h
1061 /// is comprised of type definitions and function declarations.
1062 void NeonEmitter::run(raw_ostream &OS) {
1063   OS <<
1064     "/*===---- arm_neon.h - ARM Neon intrinsics ------------------------------"
1065     "---===\n"
1066     " *\n"
1067     " * Permission is hereby granted, free of charge, to any person obtaining "
1068     "a copy\n"
1069     " * of this software and associated documentation files (the \"Software\"),"
1070     " to deal\n"
1071     " * in the Software without restriction, including without limitation the "
1072     "rights\n"
1073     " * to use, copy, modify, merge, publish, distribute, sublicense, "
1074     "and/or sell\n"
1075     " * copies of the Software, and to permit persons to whom the Software is\n"
1076     " * furnished to do so, subject to the following conditions:\n"
1077     " *\n"
1078     " * The above copyright notice and this permission notice shall be "
1079     "included in\n"
1080     " * all copies or substantial portions of the Software.\n"
1081     " *\n"
1082     " * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, "
1083     "EXPRESS OR\n"
1084     " * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF "
1085     "MERCHANTABILITY,\n"
1086     " * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT "
1087     "SHALL THE\n"
1088     " * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR "
1089     "OTHER\n"
1090     " * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, "
1091     "ARISING FROM,\n"
1092     " * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER "
1093     "DEALINGS IN\n"
1094     " * THE SOFTWARE.\n"
1095     " *\n"
1096     " *===--------------------------------------------------------------------"
1097     "---===\n"
1098     " */\n\n";
1099
1100   OS << "#ifndef __ARM_NEON_H\n";
1101   OS << "#define __ARM_NEON_H\n\n";
1102
1103   OS << "#ifndef __ARM_NEON__\n";
1104   OS << "#error \"NEON support not enabled\"\n";
1105   OS << "#endif\n\n";
1106
1107   OS << "#include <stdint.h>\n\n";
1108
1109   // Emit NEON-specific scalar typedefs.
1110   OS << "typedef float float32_t;\n";
1111   OS << "typedef int8_t poly8_t;\n";
1112   OS << "typedef int16_t poly16_t;\n";
1113   OS << "typedef uint16_t float16_t;\n";
1114
1115   // Emit Neon vector typedefs.
1116   std::string TypedefTypes("cQcsQsiQilQlUcQUcUsQUsUiQUiUlQUlhQhfQfPcQPcPsQPs");
1117   SmallVector<StringRef, 24> TDTypeVec;
1118   ParseTypes(0, TypedefTypes, TDTypeVec);
1119
1120   // Emit vector typedefs.
1121   for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1122     bool dummy, quad = false, poly = false;
1123     (void) ClassifyType(TDTypeVec[i], quad, poly, dummy);
1124     if (poly)
1125       OS << "typedef __attribute__((neon_polyvector_type(";
1126     else
1127       OS << "typedef __attribute__((neon_vector_type(";
1128
1129     unsigned nElts = GetNumElements(TDTypeVec[i], quad);
1130     OS << utostr(nElts) << "))) ";
1131     if (nElts < 10)
1132       OS << " ";
1133
1134     OS << TypeString('s', TDTypeVec[i]);
1135     OS << " " << TypeString('d', TDTypeVec[i]) << ";\n";
1136   }
1137   OS << "\n";
1138   OS << "typedef __attribute__((__vector_size__(8)))  "
1139     "double float64x1_t;\n";
1140   OS << "typedef __attribute__((__vector_size__(16))) "
1141     "double float64x2_t;\n";
1142   OS << "\n";
1143
1144   // Emit struct typedefs.
1145   for (unsigned vi = 2; vi != 5; ++vi) {
1146     for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1147       std::string ts = TypeString('d', TDTypeVec[i]);
1148       std::string vs = TypeString('0' + vi, TDTypeVec[i]);
1149       OS << "typedef struct " << vs << " {\n";
1150       OS << "  " << ts << " val";
1151       OS << "[" << utostr(vi) << "]";
1152       OS << ";\n} ";
1153       OS << vs << ";\n\n";
1154     }
1155   }
1156
1157   OS << "#define __ai static __attribute__((__always_inline__))\n\n";
1158
1159   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1160
1161   // Emit vmovl and vabd intrinsics first so they can be used by other
1162   // intrinsics.  (Some of the saturating multiply instructions are also
1163   // used to implement the corresponding "_lane" variants, but tablegen
1164   // sorts the records into alphabetical order so that the "_lane" variants
1165   // come after the intrinsics they use.)
1166   emitIntrinsic(OS, Records.getDef("VMOVL"));
1167   emitIntrinsic(OS, Records.getDef("VABD"));
1168
1169   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1170     Record *R = RV[i];
1171     if (R->getName() != "VMOVL" && R->getName() != "VABD")
1172       emitIntrinsic(OS, R);
1173   }
1174
1175   OS << "#undef __ai\n\n";
1176   OS << "#endif /* __ARM_NEON_H */\n";
1177 }
1178
1179 /// emitIntrinsic - Write out the arm_neon.h header file definitions for the
1180 /// intrinsics specified by record R.
1181 void NeonEmitter::emitIntrinsic(raw_ostream &OS, Record *R) {
1182   std::string name = R->getValueAsString("Name");
1183   std::string Proto = R->getValueAsString("Prototype");
1184   std::string Types = R->getValueAsString("Types");
1185
1186   SmallVector<StringRef, 16> TypeVec;
1187   ParseTypes(R, Types, TypeVec);
1188
1189   OpKind kind = OpMap[R->getValueAsDef("Operand")->getName()];
1190
1191   ClassKind classKind = ClassNone;
1192   if (R->getSuperClasses().size() >= 2)
1193     classKind = ClassMap[R->getSuperClasses()[1]];
1194   if (classKind == ClassNone && kind == OpNone)
1195     throw TGError(R->getLoc(), "Builtin has no class kind");
1196
1197   for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1198     if (kind == OpReinterpret) {
1199       bool outQuad = false;
1200       bool dummy = false;
1201       (void)ClassifyType(TypeVec[ti], outQuad, dummy, dummy);
1202       for (unsigned srcti = 0, srcte = TypeVec.size();
1203            srcti != srcte; ++srcti) {
1204         bool inQuad = false;
1205         (void)ClassifyType(TypeVec[srcti], inQuad, dummy, dummy);
1206         if (srcti == ti || inQuad != outQuad)
1207           continue;
1208         OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[srcti],
1209                            OpCast, ClassS);
1210       }
1211     } else {
1212       OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[ti],
1213                          kind, classKind);
1214     }
1215   }
1216   OS << "\n";
1217 }
1218
1219 static unsigned RangeFromType(const char mod, StringRef typestr) {
1220   // base type to get the type string for.
1221   bool quad = false, dummy = false;
1222   char type = ClassifyType(typestr, quad, dummy, dummy);
1223   type = ModType(mod, type, quad, dummy, dummy, dummy, dummy, dummy);
1224
1225   switch (type) {
1226     case 'c':
1227       return (8 << (int)quad) - 1;
1228     case 'h':
1229     case 's':
1230       return (4 << (int)quad) - 1;
1231     case 'f':
1232     case 'i':
1233       return (2 << (int)quad) - 1;
1234     case 'l':
1235       return (1 << (int)quad) - 1;
1236     default:
1237       throw "unhandled type!";
1238       break;
1239   }
1240   assert(0 && "unreachable");
1241   return 0;
1242 }
1243
1244 /// runHeader - Emit a file with sections defining:
1245 /// 1. the NEON section of BuiltinsARM.def.
1246 /// 2. the SemaChecking code for the type overload checking.
1247 /// 3. the SemaChecking code for validation of intrinsic immedate arguments.
1248 void NeonEmitter::runHeader(raw_ostream &OS) {
1249   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1250
1251   StringMap<OpKind> EmittedMap;
1252
1253   // Generate BuiltinsARM.def for NEON
1254   OS << "#ifdef GET_NEON_BUILTINS\n";
1255   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1256     Record *R = RV[i];
1257     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1258     if (k != OpNone)
1259       continue;
1260
1261     std::string Proto = R->getValueAsString("Prototype");
1262
1263     // Functions with 'a' (the splat code) in the type prototype should not get
1264     // their own builtin as they use the non-splat variant.
1265     if (Proto.find('a') != std::string::npos)
1266       continue;
1267
1268     std::string Types = R->getValueAsString("Types");
1269     SmallVector<StringRef, 16> TypeVec;
1270     ParseTypes(R, Types, TypeVec);
1271
1272     if (R->getSuperClasses().size() < 2)
1273       throw TGError(R->getLoc(), "Builtin has no class kind");
1274
1275     std::string name = R->getValueAsString("Name");
1276     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1277
1278     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1279       // Generate the BuiltinsARM.def declaration for this builtin, ensuring
1280       // that each unique BUILTIN() macro appears only once in the output
1281       // stream.
1282       std::string bd = GenBuiltinDef(name, Proto, TypeVec[ti], ck);
1283       if (EmittedMap.count(bd))
1284         continue;
1285
1286       EmittedMap[bd] = OpNone;
1287       OS << bd << "\n";
1288     }
1289   }
1290   OS << "#endif\n\n";
1291
1292   // Generate the overloaded type checking code for SemaChecking.cpp
1293   OS << "#ifdef GET_NEON_OVERLOAD_CHECK\n";
1294   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1295     Record *R = RV[i];
1296     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1297     if (k != OpNone)
1298       continue;
1299
1300     std::string Proto = R->getValueAsString("Prototype");
1301     std::string Types = R->getValueAsString("Types");
1302     std::string name = R->getValueAsString("Name");
1303
1304     // Functions with 'a' (the splat code) in the type prototype should not get
1305     // their own builtin as they use the non-splat variant.
1306     if (Proto.find('a') != std::string::npos)
1307       continue;
1308
1309     // Functions which have a scalar argument cannot be overloaded, no need to
1310     // check them if we are emitting the type checking code.
1311     if (Proto.find('s') != std::string::npos)
1312       continue;
1313
1314     SmallVector<StringRef, 16> TypeVec;
1315     ParseTypes(R, Types, TypeVec);
1316
1317     if (R->getSuperClasses().size() < 2)
1318       throw TGError(R->getLoc(), "Builtin has no class kind");
1319
1320     int si = -1, qi = -1;
1321     unsigned mask = 0, qmask = 0;
1322     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1323       // Generate the switch case(s) for this builtin for the type validation.
1324       bool quad = false, poly = false, usgn = false;
1325       (void) ClassifyType(TypeVec[ti], quad, poly, usgn);
1326
1327       if (quad) {
1328         qi = ti;
1329         qmask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1330       } else {
1331         si = ti;
1332         mask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1333       }
1334     }
1335     if (mask)
1336       OS << "case ARM::BI__builtin_neon_"
1337          << MangleName(name, TypeVec[si], ClassB)
1338          << ": mask = " << "0x" << utohexstr(mask) << "; break;\n";
1339     if (qmask)
1340       OS << "case ARM::BI__builtin_neon_"
1341          << MangleName(name, TypeVec[qi], ClassB)
1342          << ": mask = " << "0x" << utohexstr(qmask) << "; break;\n";
1343   }
1344   OS << "#endif\n\n";
1345
1346   // Generate the intrinsic range checking code for shift/lane immediates.
1347   OS << "#ifdef GET_NEON_IMMEDIATE_CHECK\n";
1348   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1349     Record *R = RV[i];
1350
1351     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1352     if (k != OpNone)
1353       continue;
1354
1355     std::string name = R->getValueAsString("Name");
1356     std::string Proto = R->getValueAsString("Prototype");
1357     std::string Types = R->getValueAsString("Types");
1358
1359     // Functions with 'a' (the splat code) in the type prototype should not get
1360     // their own builtin as they use the non-splat variant.
1361     if (Proto.find('a') != std::string::npos)
1362       continue;
1363
1364     // Functions which do not have an immediate do not need to have range
1365     // checking code emitted.
1366     size_t immPos = Proto.find('i');
1367     if (immPos == std::string::npos)
1368       continue;
1369
1370     SmallVector<StringRef, 16> TypeVec;
1371     ParseTypes(R, Types, TypeVec);
1372
1373     if (R->getSuperClasses().size() < 2)
1374       throw TGError(R->getLoc(), "Builtin has no class kind");
1375
1376     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1377
1378     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1379       std::string namestr, shiftstr, rangestr;
1380
1381       // Builtins which are overloaded by type will need to have their upper
1382       // bound computed at Sema time based on the type constant.
1383       if (Proto.find('s') == std::string::npos) {
1384         ck = ClassB;
1385         if (R->getValueAsBit("isShift")) {
1386           shiftstr = ", true";
1387
1388           // Right shifts have an 'r' in the name, left shifts do not.
1389           if (name.find('r') != std::string::npos)
1390             rangestr = "l = 1; ";
1391         }
1392         rangestr += "u = RFT(TV" + shiftstr + ")";
1393       } else {
1394         // The immediate generally refers to a lane in the preceding argument.
1395         assert(immPos > 0 && "unexpected immediate operand");
1396         rangestr = "u = " + utostr(RangeFromType(Proto[immPos-1], TypeVec[ti]));
1397       }
1398       // Make sure cases appear only once by uniquing them in a string map.
1399       namestr = MangleName(name, TypeVec[ti], ck);
1400       if (EmittedMap.count(namestr))
1401         continue;
1402       EmittedMap[namestr] = OpNone;
1403
1404       // Calculate the index of the immediate that should be range checked.
1405       unsigned immidx = 0;
1406
1407       // Builtins that return a struct of multiple vectors have an extra
1408       // leading arg for the struct return.
1409       if (Proto[0] >= '2' && Proto[0] <= '4')
1410         ++immidx;
1411
1412       // Add one to the index for each argument until we reach the immediate
1413       // to be checked.  Structs of vectors are passed as multiple arguments.
1414       for (unsigned ii = 1, ie = Proto.size(); ii != ie; ++ii) {
1415         switch (Proto[ii]) {
1416           default:  immidx += 1; break;
1417           case '2': immidx += 2; break;
1418           case '3': immidx += 3; break;
1419           case '4': immidx += 4; break;
1420           case 'i': ie = ii + 1; break;
1421         }
1422       }
1423       OS << "case ARM::BI__builtin_neon_" << MangleName(name, TypeVec[ti], ck)
1424          << ": i = " << immidx << "; " << rangestr << "; break;\n";
1425     }
1426   }
1427   OS << "#endif\n\n";
1428 }
1429
1430 /// GenTest - Write out a test for the intrinsic specified by the name and
1431 /// type strings, including the embedded patterns for FileCheck to match.
1432 static std::string GenTest(const std::string &name,
1433                            const std::string &proto,
1434                            StringRef outTypeStr, StringRef inTypeStr,
1435                            bool isShift) {
1436   assert(!proto.empty() && "");
1437   std::string s;
1438
1439   // Function name with type suffix
1440   std::string mangledName = MangleName(name, outTypeStr, ClassS);
1441   if (outTypeStr != inTypeStr) {
1442     // If the input type is different (e.g., for vreinterpret), append a suffix
1443     // for the input type.  String off a "Q" (quad) prefix so that MangleName
1444     // does not insert another "q" in the name.
1445     unsigned typeStrOff = (inTypeStr[0] == 'Q' ? 1 : 0);
1446     StringRef inTypeNoQuad = inTypeStr.substr(typeStrOff);
1447     mangledName = MangleName(mangledName, inTypeNoQuad, ClassS);
1448   }
1449
1450   // Emit the FileCheck patterns.
1451   s += "// CHECK: test_" + mangledName + "\n";
1452   // s += "// CHECK: \n"; // FIXME: + expected instruction opcode.
1453
1454   // Emit the start of the test function.
1455   s += TypeString(proto[0], outTypeStr) + " test_" + mangledName + "(";
1456   char arg = 'a';
1457   std::string comma;
1458   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
1459     // Do not create arguments for values that must be immediate constants.
1460     if (proto[i] == 'i')
1461       continue;
1462     s += comma + TypeString(proto[i], inTypeStr) + " ";
1463     s.push_back(arg);
1464     comma = ", ";
1465   }
1466   s += ") { \\\n  ";
1467
1468   if (proto[0] != 'v')
1469     s += "return ";
1470   s += mangledName + "(";
1471   arg = 'a';
1472   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
1473     if (proto[i] == 'i') {
1474       // For immediate operands, test the maximum value.
1475       if (isShift)
1476         s += "1"; // FIXME
1477       else
1478         // The immediate generally refers to a lane in the preceding argument.
1479         s += utostr(RangeFromType(proto[i-1], inTypeStr));
1480     } else {
1481       s.push_back(arg);
1482     }
1483     if ((i + 1) < e)
1484       s += ", ";
1485   }
1486   s += ");\n}\n\n";
1487   return s;
1488 }
1489
1490 /// runTests - Write out a complete set of tests for all of the Neon
1491 /// intrinsics.
1492 void NeonEmitter::runTests(raw_ostream &OS) {
1493   OS <<
1494     "// RUN: %clang_cc1 -triple thumbv7-apple-darwin \\\n"
1495     "// RUN:  -target-cpu cortex-a8 -ffreestanding -S -o - %s | FileCheck %s\n"
1496     "\n"
1497     "#include <arm_neon.h>\n"
1498     "\n";
1499
1500   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1501   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1502     Record *R = RV[i];
1503     std::string name = R->getValueAsString("Name");
1504     std::string Proto = R->getValueAsString("Prototype");
1505     std::string Types = R->getValueAsString("Types");
1506     bool isShift = R->getValueAsBit("isShift");
1507
1508     SmallVector<StringRef, 16> TypeVec;
1509     ParseTypes(R, Types, TypeVec);
1510
1511     OpKind kind = OpMap[R->getValueAsDef("Operand")->getName()];
1512     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1513       if (kind == OpReinterpret) {
1514         bool outQuad = false;
1515         bool dummy = false;
1516         (void)ClassifyType(TypeVec[ti], outQuad, dummy, dummy);
1517         for (unsigned srcti = 0, srcte = TypeVec.size();
1518              srcti != srcte; ++srcti) {
1519           bool inQuad = false;
1520           (void)ClassifyType(TypeVec[srcti], inQuad, dummy, dummy);
1521           if (srcti == ti || inQuad != outQuad)
1522             continue;
1523           OS << GenTest(name, Proto, TypeVec[ti], TypeVec[srcti], isShift);
1524         }
1525       } else {
1526         OS << GenTest(name, Proto, TypeVec[ti], TypeVec[ti], isShift);
1527       }
1528     }
1529     OS << "\n";
1530   }
1531 }
1532