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
 329     if (type == 'l') // 64-bit long
 330       s += "LLi";
 331     else
 332       s.push_back(type);
 333
 334     if (cnst)
 335       s.push_back('C');
 336     if (pntr)
 337       s.push_back('*');
 338     return s.str();
 339   }
 340
 341   // Since the return value must be one type, return a vector type of the
 342   // appropriate width which we will bitcast.  An exception is made for
 343   // returning structs of 2, 3, or 4 vectors which are returned in a sret-like
 344   // fashion, storing them to a pointer arg.
 345   if (ret) {
 346     if (mod >= '2' && mod <= '4')
 347       return "vv*"; // void result with void* first argument
 348     if (mod == 'f' || (ck != ClassB && type == 'f'))
 349       return quad ? "V4f" : "V2f";
 350     if (ck != ClassB && type == 's')
 351       return quad ? "V8s" : "V4s";
 352     if (ck != ClassB && type == 'i')
 353       return quad ? "V4i" : "V2i";
 354     if (ck != ClassB && type == 'l')
 355       return quad ? "V2LLi" : "V1LLi";
 356
 357     return quad ? "V16c" : "V8c";
 358   }
 359
 360   // Non-return array types are passed as individual vectors.
 361   if (mod == '2')
 362     return quad ? "V16cV16c" : "V8cV8c";
 363   if (mod == '3')
 364     return quad ? "V16cV16cV16c" : "V8cV8cV8c";
 365   if (mod == '4')
 366     return quad ? "V16cV16cV16cV16c" : "V8cV8cV8cV8c";
 367
 368   if (mod == 'f' || (ck != ClassB && type == 'f'))
 369     return quad ? "V4f" : "V2f";
 370   if (ck != ClassB && type == 's')
 371     return quad ? "V8s" : "V4s";
 372   if (ck != ClassB && type == 'i')
 373     return quad ? "V4i" : "V2i";
 374   if (ck != ClassB && type == 'l')
 375     return quad ? "V2LLi" : "V1LLi";
 376
 377   return quad ? "V16c" : "V8c";
 378 }
 379
 380 /// MangleName - Append a type or width suffix to a base neon function name,
 381 /// and insert a 'q' in the appropriate location if the operation works on
 382 /// 128b rather than 64b.   E.g. turn "vst2_lane" into "vst2q_lane_f32", etc.
 383 static std::string MangleName(const std::string &name, StringRef typestr,
 384                               ClassKind ck) {
 385   if (name == "vcvt_f32_f16")
 386     return name;
 387
 388   bool quad = false;
 389   bool poly = false;
 390   bool usgn = false;
 391   char type = ClassifyType(typestr, quad, poly, usgn);
 392
 393   std::string s = name;
 394
 395   switch (type) {
 396   case 'c':
 397     switch (ck) {
 398     case ClassS: s += poly ? "_p8" : usgn ? "_u8" : "_s8"; break;
 399     case ClassI: s += "_i8"; break;
 400     case ClassW: s += "_8"; break;
 401     default: break;
 402     }
 403     break;
 404   case 's':
 405     switch (ck) {
 406     case ClassS: s += poly ? "_p16" : usgn ? "_u16" : "_s16"; break;
 407     case ClassI: s += "_i16"; break;
 408     case ClassW: s += "_16"; break;
 409     default: break;
 410     }
 411     break;
 412   case 'i':
 413     switch (ck) {
 414     case ClassS: s += usgn ? "_u32" : "_s32"; break;
 415     case ClassI: s += "_i32"; break;
 416     case ClassW: s += "_32"; break;
 417     default: break;
 418     }
 419     break;
 420   case 'l':
 421     switch (ck) {
 422     case ClassS: s += usgn ? "_u64" : "_s64"; break;
 423     case ClassI: s += "_i64"; break;
 424     case ClassW: s += "_64"; break;
 425     default: break;
 426     }
 427     break;
 428   case 'h':
 429     switch (ck) {
 430     case ClassS:
 431     case ClassI: s += "_f16"; break;
 432     case ClassW: s += "_16"; break;
 433     default: break;
 434     }
 435     break;
 436   case 'f':
 437     switch (ck) {
 438     case ClassS:
 439     case ClassI: s += "_f32"; break;
 440     case ClassW: s += "_32"; break;
 441     default: break;
 442     }
 443     break;
 444   default:
 445     throw "unhandled type!";
 446     break;
 447   }
 448   if (ck == ClassB)
 449     s += "_v";
 450
 451   // Insert a 'q' before the first '_' character so that it ends up before
 452   // _lane or _n on vector-scalar operations.
 453   if (quad) {
 454     size_t pos = s.find('_');
 455     s = s.insert(pos, "q");
 456   }
 457   return s;
 458 }
 459
 460 // Generate the string "(argtype a, argtype b, ...)"
 461 static std::string GenArgs(const std::string &proto, StringRef typestr) {
 462   bool define = proto.find('i') != std::string::npos;
 463   char arg = 'a';
 464
 465   std::string s;
 466   s += "(";
 467
 468   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 469     if (!define) {
 470       s += TypeString(proto[i], typestr);
 471       s.push_back(' ');
 472     }
 473     s.push_back(arg);
 474     if ((i + 1) < e)
 475       s += ", ";
 476   }
 477
 478   s += ")";
 479   return s;
 480 }
 481
 482 static std::string Duplicate(unsigned nElts, StringRef typestr,
 483                              const std::string &a) {
 484   std::string s;
 485
 486   s = "(" + TypeString('d', typestr) + "){ ";
 487   for (unsigned i = 0; i != nElts; ++i) {
 488     s += a;
 489     if ((i + 1) < nElts)
 490       s += ", ";
 491   }
 492   s += " }";
 493
 494   return s;
 495 }
 496
 497 static unsigned GetNumElements(StringRef typestr, bool &quad) {
 498   quad = false;
 499   bool dummy = false;
 500   char type = ClassifyType(typestr, quad, dummy, dummy);
 501   unsigned nElts = 0;
 502   switch (type) {
 503   case 'c': nElts = 8; break;
 504   case 's': nElts = 4; break;
 505   case 'i': nElts = 2; break;
 506   case 'l': nElts = 1; break;
 507   case 'h': nElts = 4; break;
 508   case 'f': nElts = 2; break;
 509   default:
 510     throw "unhandled type!";
 511     break;
 512   }
 513   if (quad) nElts <<= 1;
 514   return nElts;
 515 }
 516
 517 // Generate the definition for this intrinsic, e.g. "a + b" for OpAdd.
 518 static std::string GenOpString(OpKind op, const std::string &proto,
 519                                StringRef typestr) {
 520   bool quad;
 521   unsigned nElts = GetNumElements(typestr, quad);
 522
 523   std::string ts = TypeString(proto[0], typestr);
 524   std::string s;
 525   if (op == OpHi || op == OpLo) {
 526     s = "union { " + ts + " r; double d; } u; u.d";
 527   } else {
 528     s = ts + " r; r";
 529   }
 530
 531   s += " = ";
 532
 533   switch(op) {
 534   case OpAdd:
 535     s += "a + b";
 536     break;
 537   case OpSub:
 538     s += "a - b";
 539     break;
 540   case OpMulN:
 541     s += "a * " + Duplicate(nElts, typestr, "b");
 542     break;
 543   case OpMul:
 544     s += "a * b";
 545     break;
 546   case OpMlaN:
 547     s += "a + (b * " + Duplicate(nElts, typestr, "c") + ")";
 548     break;
 549   case OpMla:
 550     s += "a + (b * c)";
 551     break;
 552   case OpMlsN:
 553     s += "a - (b * " + Duplicate(nElts, typestr, "c") + ")";
 554     break;
 555   case OpMls:
 556     s += "a - (b * c)";
 557     break;
 558   case OpEq:
 559     s += "(" + ts + ")(a == b)";
 560     break;
 561   case OpGe:
 562     s += "(" + ts + ")(a >= b)";
 563     break;
 564   case OpLe:
 565     s += "(" + ts + ")(a <= b)";
 566     break;
 567   case OpGt:
 568     s += "(" + ts + ")(a > b)";
 569     break;
 570   case OpLt:
 571     s += "(" + ts + ")(a < b)";
 572     break;
 573   case OpNeg:
 574     s += " -a";
 575     break;
 576   case OpNot:
 577     s += " ~a";
 578     break;
 579   case OpAnd:
 580     s += "a & b";
 581     break;
 582   case OpOr:
 583     s += "a | b";
 584     break;
 585   case OpXor:
 586     s += "a ^ b";
 587     break;
 588   case OpAndNot:
 589     s += "a & ~b";
 590     break;
 591   case OpOrNot:
 592     s += "a | ~b";
 593     break;
 594   case OpCast:
 595     s += "(" + ts + ")a";
 596     break;
 597   case OpConcat:
 598     s += "__builtin_shufflevector((int64x1_t)a";
 599     s += ", (int64x1_t)b, 0, 1)";
 600     break;
 601   case OpHi:
 602     s += "(((float64x2_t)a)[1])";
 603     break;
 604   case OpLo:
 605     s += "(((float64x2_t)a)[0])";
 606     break;
 607   case OpDup:
 608     s += Duplicate(nElts, typestr, "a");
 609     break;
 610   case OpSelect:
 611     // ((0 & 1) | (~0 & 2))
 612     ts = TypeString(proto[1], typestr);
 613     s += "(a & (" + ts + ")b) | ";
 614     s += "(~a & (" + ts + ")c)";
 615     break;
 616   case OpRev16:
 617     s += "__builtin_shufflevector(a, a";
 618     for (unsigned i = 2; i <= nElts; i += 2)
 619       for (unsigned j = 0; j != 2; ++j)
 620         s += ", " + utostr(i - j - 1);
 621     s += ")";
 622     break;
 623   case OpRev32: {
 624     unsigned WordElts = nElts >> (1 + (int)quad);
 625     s += "__builtin_shufflevector(a, a";
 626     for (unsigned i = WordElts; i <= nElts; i += WordElts)
 627       for (unsigned j = 0; j != WordElts; ++j)
 628         s += ", " + utostr(i - j - 1);
 629     s += ")";
 630     break;
 631   }
 632   case OpRev64: {
 633     unsigned DblWordElts = nElts >> (int)quad;
 634     s += "__builtin_shufflevector(a, a";
 635     for (unsigned i = DblWordElts; i <= nElts; i += DblWordElts)
 636       for (unsigned j = 0; j != DblWordElts; ++j)
 637         s += ", " + utostr(i - j - 1);
 638     s += ")";
 639     break;
 640   }
 641   default:
 642     throw "unknown OpKind!";
 643     break;
 644   }
 645   if (op == OpHi || op == OpLo)
 646     s += "; return u.r;";
 647   else
 648     s += "; return r;";
 649   return s;
 650 }
 651
 652 static unsigned GetNeonEnum(const std::string &proto, StringRef typestr) {
 653   unsigned mod = proto[0];
 654   unsigned ret = 0;
 655
 656   if (mod == 'v' || mod == 'f')
 657     mod = proto[1];
 658
 659   bool quad = false;
 660   bool poly = false;
 661   bool usgn = false;
 662   bool scal = false;
 663   bool cnst = false;
 664   bool pntr = false;
 665
 666   // Base type to get the type string for.
 667   char type = ClassifyType(typestr, quad, poly, usgn);
 668
 669   // Based on the modifying character, change the type and width if necessary.
 670   type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
 671
 672   if (usgn)
 673     ret |= 0x08;
 674   if (quad && proto[1] != 'g')
 675     ret |= 0x10;
 676
 677   switch (type) {
 678     case 'c':
 679       ret |= poly ? 5 : 0;
 680       break;
 681     case 's':
 682       ret |= poly ? 6 : 1;
 683       break;
 684     case 'i':
 685       ret |= 2;
 686       break;
 687     case 'l':
 688       ret |= 3;
 689       break;
 690     case 'h':
 691       ret |= 7;
 692       break;
 693     case 'f':
 694       ret |= 4;
 695       break;
 696     default:
 697       throw "unhandled type!";
 698       break;
 699   }
 700   return ret;
 701 }
 702
 703 // Generate the definition for this intrinsic, e.g. __builtin_neon_cls(a)
 704 static std::string GenBuiltin(const std::string &name, const std::string &proto,
 705                               StringRef typestr, ClassKind ck) {
 706   char arg = 'a';
 707   std::string s;
 708
 709   // If this builtin returns a struct 2, 3, or 4 vectors, pass it as an implicit
 710   // sret-like argument.
 711   bool sret = (proto[0] >= '2' && proto[0] <= '4');
 712
 713   // If this builtin takes an immediate argument, we need to #define it rather
 714   // than use a standard declaration, so that SemaChecking can range check
 715   // the immediate passed by the user.
 716   bool define = proto.find('i') != std::string::npos;
 717
 718   // Check if the prototype has a scalar operand with the type of the vector
 719   // elements.  If not, bitcasting the args will take care of arg checking.
 720   // The actual signedness etc. will be taken care of with special enums.
 721   if (proto.find('s') == std::string::npos)
 722     ck = ClassB;
 723
 724   if (proto[0] != 'v') {
 725     std::string ts = TypeString(proto[0], typestr);
 726
 727     if (define) {
 728       if (sret)
 729         s += "({ " + ts + " r; ";
 730       else
 731         s += "(" + ts + ")";
 732     } else if (sret) {
 733       s += ts + " r; ";
 734     } else {
 735       s += ts + " r; r = ";
 736     }
 737   }
 738
 739   bool splat = proto.find('a') != std::string::npos;
 740
 741   s += "__builtin_neon_";
 742   if (splat) {
 743     // Call the non-splat builtin: chop off the "_n" suffix from the name.
 744     std::string vname(name, 0, name.size()-2);
 745     s += MangleName(vname, typestr, ck);
 746   } else {
 747     s += MangleName(name, typestr, ck);
 748   }
 749   s += "(";
 750
 751   // Pass the address of the return variable as the first argument to sret-like
 752   // builtins.
 753   if (sret)
 754     s += "&r, ";
 755
 756   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 757     std::string args = std::string(&arg, 1);
 758
 759     // Wrap macro arguments in parenthesis.
 760     if (define)
 761       args = "(" + args + ")";
 762
 763     bool argQuad = false;
 764     bool argPoly = false;
 765     bool argUsgn = false;
 766     bool argScalar = false;
 767     bool dummy = false;
 768     char argType = ClassifyType(typestr, argQuad, argPoly, argUsgn);
 769     argType = ModType(proto[i], argType, argQuad, argPoly, argUsgn, argScalar,
 770                       dummy, dummy);
 771
 772     // Handle multiple-vector values specially, emitting each subvector as an
 773     // argument to the __builtin.
 774     if (proto[i] >= '2' && proto[i] <= '4') {
 775       // Check if an explicit cast is needed.
 776       if (argType != 'c' || argPoly || argUsgn)
 777         args = (argQuad ? "(int8x16_t)" : "(int8x8_t)") + args;
 778
 779       for (unsigned vi = 0, ve = proto[i] - '0'; vi != ve; ++vi) {
 780         s += args + ".val[" + utostr(vi) + "]";
 781         if ((vi + 1) < ve)
 782           s += ", ";
 783       }
 784       if ((i + 1) < e)
 785         s += ", ";
 786
 787       continue;
 788     }
 789
 790     // Check if an explicit cast is needed.
 791     if (!argScalar &&
 792         ((ck == ClassB && argType != 'c') || argPoly || argUsgn)) {
 793       std::string argTypeStr = "c";
 794       if (ck != ClassB)
 795         argTypeStr = argType;
 796       if (argQuad)
 797         argTypeStr = "Q" + argTypeStr;
 798       args = "(" + TypeString('d', argTypeStr) + ")" + args;
 799     }
 800
 801     if (splat && (i + 1) == e)
 802       s += Duplicate(GetNumElements(typestr, argQuad), typestr, args);
 803     else
 804       s += args;
 805     if ((i + 1) < e)
 806       s += ", ";
 807   }
 808
 809   // Extra constant integer to hold type class enum for this function, e.g. s8
 810   if (ck == ClassB)
 811     s += ", " + utostr(GetNeonEnum(proto, typestr));
 812
 813   if (define)
 814     s += ")";
 815   else
 816     s += ");";
 817
 818   if (proto[0] != 'v') {
 819     if (define) {
 820       if (sret)
 821         s += "; r; })";
 822     } else {
 823       s += " return r;";
 824     }
 825   }
 826   return s;
 827 }
 828
 829 static std::string GenBuiltinDef(const std::string &name,
 830                                  const std::string &proto,
 831                                  StringRef typestr, ClassKind ck) {
 832   std::string s("BUILTIN(__builtin_neon_");
 833
 834   // If all types are the same size, bitcasting the args will take care
 835   // of arg checking.  The actual signedness etc. will be taken care of with
 836   // special enums.
 837   if (proto.find('s') == std::string::npos)
 838     ck = ClassB;
 839
 840   s += MangleName(name, typestr, ck);
 841   s += ", \"";
 842
 843   for (unsigned i = 0, e = proto.size(); i != e; ++i)
 844     s += BuiltinTypeString(proto[i], typestr, ck, i == 0);
 845
 846   // Extra constant integer to hold type class enum for this function, e.g. s8
 847   if (ck == ClassB)
 848     s += "i";
 849
 850   s += "\", \"n\")";
 851   return s;
 852 }
 853
 854 /// run - Read the records in arm_neon.td and output arm_neon.h.  arm_neon.h
 855 /// is comprised of type definitions and function declarations.
 856 void NeonEmitter::run(raw_ostream &OS) {
 857   EmitSourceFileHeader("ARM NEON Header", OS);
 858
 859   // FIXME: emit license into file?
 860
 861   OS << "#ifndef __ARM_NEON_H\n";
 862   OS << "#define __ARM_NEON_H\n\n";
 863
 864   OS << "#ifndef __ARM_NEON__\n";
 865   OS << "#error \"NEON support not enabled\"\n";
 866   OS << "#endif\n\n";
 867
 868   OS << "#include <stdint.h>\n\n";
 869
 870   // Emit NEON-specific scalar typedefs.
 871   OS << "typedef float float32_t;\n";
 872   OS << "typedef int8_t poly8_t;\n";
 873   OS << "typedef int16_t poly16_t;\n";
 874   OS << "typedef uint16_t float16_t;\n";
 875
 876   // Emit Neon vector typedefs.
 877   std::string TypedefTypes("cQcsQsiQilQlUcQUcUsQUsUiQUiUlQUlhQhfQfPcQPcPsQPs");
 878   SmallVector<StringRef, 24> TDTypeVec;
 879   ParseTypes(0, TypedefTypes, TDTypeVec);
 880
 881   // Emit vector typedefs.
 882   for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
 883     bool dummy, quad = false, poly = false;
 884     (void) ClassifyType(TDTypeVec[i], quad, poly, dummy);
 885     if (poly)
 886       OS << "typedef __attribute__((neon_polyvector_type(";
 887     else
 888       OS << "typedef __attribute__((neon_vector_type(";
 889
 890     unsigned nElts = GetNumElements(TDTypeVec[i], quad);
 891     OS << utostr(nElts) << "))) ";
 892     if (nElts < 10)
 893       OS << " ";
 894
 895     OS << TypeString('s', TDTypeVec[i]);
 896     OS << " " << TypeString('d', TDTypeVec[i]) << ";\n";
 897   }
 898   OS << "\n";
 899   OS << "typedef __attribute__((__vector_size__(8)))  "
 900     "double float64x1_t;\n";
 901   OS << "typedef __attribute__((__vector_size__(16))) "
 902     "double float64x2_t;\n";
 903   OS << "\n";
 904
 905   // Emit struct typedefs.
 906   for (unsigned vi = 2; vi != 5; ++vi) {
 907     for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
 908       std::string ts = TypeString('d', TDTypeVec[i]);
 909       std::string vs = TypeString('0' + vi, TDTypeVec[i]);
 910       OS << "typedef struct " << vs << " {\n";
 911       OS << "  " << ts << " val";
 912       OS << "[" << utostr(vi) << "]";
 913       OS << ";\n} ";
 914       OS << vs << ";\n\n";
 915     }
 916   }
 917
 918   OS << "#define __ai static __attribute__((__always_inline__))\n\n";
 919
 920   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
 921
 922   // Unique the return+pattern types, and assign them.
 923   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
 924     Record *R = RV[i];
 925     std::string name = LowercaseString(R->getName());
 926     std::string Proto = R->getValueAsString("Prototype");
 927     std::string Types = R->getValueAsString("Types");
 928
 929     SmallVector<StringRef, 16> TypeVec;
 930     ParseTypes(R, Types, TypeVec);
 931
 932     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
 933
 934     bool define = Proto.find('i') != std::string::npos;
 935
 936     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
 937       assert(!Proto.empty() && "");
 938
 939       // static always inline + return type
 940       if (define)
 941         OS << "#define";
 942       else
 943         OS << "__ai " << TypeString(Proto[0], TypeVec[ti]);
 944
 945       // Function name with type suffix
 946       OS << " " << MangleName(name, TypeVec[ti], ClassS);
 947
 948       // Function arguments
 949       OS << GenArgs(Proto, TypeVec[ti]);
 950
 951       // Definition.
 952       if (define)
 953         OS << " ";
 954       else
 955         OS << " { ";
 956
 957       if (k != OpNone) {
 958         OS << GenOpString(k, Proto, TypeVec[ti]);
 959       } else {
 960         if (R->getSuperClasses().size() < 2)
 961           throw TGError(R->getLoc(), "Builtin has no class kind");
 962
 963         ClassKind ck = ClassMap[R->getSuperClasses()[1]];
 964
 965         if (ck == ClassNone)
 966           throw TGError(R->getLoc(), "Builtin has no class kind");
 967         OS << GenBuiltin(name, Proto, TypeVec[ti], ck);
 968       }
 969       if (!define)
 970         OS << " }";
 971       OS << "\n";
 972     }
 973     OS << "\n";
 974   }
 975   OS << "#undef __ai\n\n";
 976   OS << "#endif /* __ARM_NEON_H */\n";
 977 }
 978
 979 static unsigned RangeFromType(StringRef typestr) {
 980   // base type to get the type string for.
 981   bool quad = false, dummy = false;
 982   char type = ClassifyType(typestr, quad, dummy, dummy);
 983
 984   switch (type) {
 985     case 'c':
 986       return (8 << (int)quad) - 1;
 987     case 'h':
 988     case 's':
 989       return (4 << (int)quad) - 1;
 990     case 'f':
 991     case 'i':
 992       return (2 << (int)quad) - 1;
 993     case 'l':
 994       return (1 << (int)quad) - 1;
 995     default:
 996       throw "unhandled type!";
 997       break;
 998   }
 999   assert(0 && "unreachable");
1000   return 0;
1001 }
1002
1003 /// runHeader - Emit a file with sections defining:
1004 /// 1. the NEON section of BuiltinsARM.def.
1005 /// 2. the SemaChecking code for the type overload checking.
1006 /// 3. the SemaChecking code for validation of intrinsic immedate arguments.
1007 void NeonEmitter::runHeader(raw_ostream &OS) {
1008   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1009
1010   StringMap<OpKind> EmittedMap;
1011
1012   // Generate BuiltinsARM.def for NEON
1013   OS << "#ifdef GET_NEON_BUILTINS\n";
1014   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1015     Record *R = RV[i];
1016     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1017     if (k != OpNone)
1018       continue;
1019
1020     std::string Proto = R->getValueAsString("Prototype");
1021
1022     // Functions with 'a' (the splat code) in the type prototype should not get
1023     // their own builtin as they use the non-splat variant.
1024     if (Proto.find('a') != std::string::npos)
1025       continue;
1026
1027     std::string Types = R->getValueAsString("Types");
1028     SmallVector<StringRef, 16> TypeVec;
1029     ParseTypes(R, Types, TypeVec);
1030
1031     if (R->getSuperClasses().size() < 2)
1032       throw TGError(R->getLoc(), "Builtin has no class kind");
1033
1034     std::string name = LowercaseString(R->getName());
1035     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1036
1037     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1038       // Generate the BuiltinsARM.def declaration for this builtin, ensuring
1039       // that each unique BUILTIN() macro appears only once in the output
1040       // stream.
1041       std::string bd = GenBuiltinDef(name, Proto, TypeVec[ti], ck);
1042       if (EmittedMap.count(bd))
1043         continue;
1044
1045       EmittedMap[bd] = OpNone;
1046       OS << bd << "\n";
1047     }
1048   }
1049   OS << "#endif\n\n";
1050
1051   // Generate the overloaded type checking code for SemaChecking.cpp
1052   OS << "#ifdef GET_NEON_OVERLOAD_CHECK\n";
1053   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1054     Record *R = RV[i];
1055     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1056     if (k != OpNone)
1057       continue;
1058
1059     std::string Proto = R->getValueAsString("Prototype");
1060     std::string Types = R->getValueAsString("Types");
1061     std::string name = LowercaseString(R->getName());
1062
1063     // Functions with 'a' (the splat code) in the type prototype should not get
1064     // their own builtin as they use the non-splat variant.
1065     if (Proto.find('a') != std::string::npos)
1066       continue;
1067
1068     // Functions which have a scalar argument cannot be overloaded, no need to
1069     // check them if we are emitting the type checking code.
1070     if (Proto.find('s') != std::string::npos)
1071       continue;
1072
1073     SmallVector<StringRef, 16> TypeVec;
1074     ParseTypes(R, Types, TypeVec);
1075
1076     if (R->getSuperClasses().size() < 2)
1077       throw TGError(R->getLoc(), "Builtin has no class kind");
1078
1079     int si = -1, qi = -1;
1080     unsigned mask = 0, qmask = 0;
1081     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1082       // Generate the switch case(s) for this builtin for the type validation.
1083       bool quad = false, poly = false, usgn = false;
1084       (void) ClassifyType(TypeVec[ti], quad, poly, usgn);
1085
1086       if (quad) {
1087         qi = ti;
1088         qmask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1089       } else {
1090         si = ti;
1091         mask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1092       }
1093     }
1094     if (mask)
1095       OS << "case ARM::BI__builtin_neon_"
1096       << MangleName(name, TypeVec[si], ClassB)
1097       << ": mask = " << "0x" << utohexstr(mask) << "; break;\n";
1098     if (qmask)
1099       OS << "case ARM::BI__builtin_neon_"
1100       << MangleName(name, TypeVec[qi], ClassB)
1101       << ": mask = " << "0x" << utohexstr(qmask) << "; break;\n";
1102   }
1103   OS << "#endif\n\n";
1104
1105   // Generate the intrinsic range checking code for shift/lane immediates.
1106   OS << "#ifdef GET_NEON_IMMEDIATE_CHECK\n";
1107   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1108     Record *R = RV[i];
1109
1110     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1111     if (k != OpNone)
1112       continue;
1113
1114     std::string name = LowercaseString(R->getName());
1115     std::string Proto = R->getValueAsString("Prototype");
1116     std::string Types = R->getValueAsString("Types");
1117
1118     // Functions with 'a' (the splat code) in the type prototype should not get
1119     // their own builtin as they use the non-splat variant.
1120     if (Proto.find('a') != std::string::npos)
1121       continue;
1122
1123     // Functions which do not have an immediate do not need to have range
1124     // checking code emitted.
1125     if (Proto.find('i') == std::string::npos)
1126       continue;
1127
1128     SmallVector<StringRef, 16> TypeVec;
1129     ParseTypes(R, Types, TypeVec);
1130
1131     if (R->getSuperClasses().size() < 2)
1132       throw TGError(R->getLoc(), "Builtin has no class kind");
1133
1134     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1135
1136     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1137       std::string namestr, shiftstr, rangestr;
1138
1139       // Builtins which are overloaded by type will need to have their upper
1140       // bound computed at Sema time based on the type constant.
1141       if (Proto.find('s') == std::string::npos) {
1142         ck = ClassB;
1143         if (R->getValueAsBit("isShift")) {
1144           shiftstr = ", true";
1145
1146           // Right shifts have an 'r' in the name, left shifts do not.
1147           if (name.find('r') != std::string::npos)
1148             rangestr = "l = 1; ";
1149         }
1150         rangestr += "u = RFT(TV" + shiftstr + ")";
1151       } else {
1152         rangestr = "u = " + utostr(RangeFromType(TypeVec[ti]));
1153       }
1154       // Make sure cases appear only once by uniquing them in a string map.
1155       namestr = MangleName(name, TypeVec[ti], ck);
1156       if (EmittedMap.count(namestr))
1157         continue;
1158       EmittedMap[namestr] = OpNone;
1159
1160       // Calculate the index of the immediate that should be range checked.
1161       unsigned immidx = 0;
1162
1163       // Builtins that return a struct of multiple vectors have an extra
1164       // leading arg for the struct return.
1165       if (Proto[0] >= '2' && Proto[0] <= '4')
1166         ++immidx;
1167
1168       // Add one to the index for each argument until we reach the immediate
1169       // to be checked.  Structs of vectors are passed as multiple arguments.
1170       for (unsigned ii = 1, ie = Proto.size(); ii != ie; ++ii) {
1171         switch (Proto[ii]) {
1172           default:  immidx += 1; break;
1173           case '2': immidx += 2; break;
1174           case '3': immidx += 3; break;
1175           case '4': immidx += 4; break;
1176           case 'i': ie = ii + 1; break;
1177         }
1178       }
1179       OS << "case ARM::BI__builtin_neon_"  << MangleName(name, TypeVec[ti], ck)
1180          << ": i = " << immidx << "; " << rangestr << "; break;\n";
1181     }
1182   }
1183   OS << "#endif\n\n";
1184 }