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