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