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, SplatLane(nElts, "__b", "__c")) + ";";
 607     break;
 608   case OpMull:
 609     s += Extend(proto, typestr, "__a") + " * " +
 610       Extend(proto, typestr, "__b") + ";";
 611     break;
 612   case OpMlaN:
 613     s += "__a + (__b * " + Duplicate(nElts, typestr, "__c") + ");";
 614     break;
 615   case OpMlaLane:
 616     s += "__a + (__b * " + SplatLane(nElts, "__c", "__d") + ");";
 617     break;
 618   case OpMla:
 619     s += "__a + (__b * __c);";
 620     break;
 621   case OpMlalN:
 622     s += "__a + (" + Extend(proto, typestr, "__b") + " * " +
 623       Extend(proto, typestr, Duplicate(nElts, typestr, "__c")) + ");";
 624     break;
 625   case OpMlalLane:
 626     s += "__a + (" + Extend(proto, typestr, "__b") + " * " +
 627       Extend(proto, typestr, SplatLane(nElts, "__c", "__d")) + ");";
 628     break;
 629   case OpMlal:
 630     s += "__a + (" + Extend(proto, typestr, "__b") + " * " +
 631       Extend(proto, typestr, "__c") + ");";
 632     break;
 633   case OpMlsN:
 634     s += "__a - (__b * " + Duplicate(nElts, typestr, "__c") + ");";
 635     break;
 636   case OpMlsLane:
 637     s += "__a - (__b * " + SplatLane(nElts, "__c", "__d") + ");";
 638     break;
 639   case OpMls:
 640     s += "__a - (__b * __c);";
 641     break;
 642   case OpMlslN:
 643     s += "__a - (" + Extend(proto, typestr, "__b") + " * " +
 644       Extend(proto, typestr, Duplicate(nElts, typestr, "__c")) + ");";
 645     break;
 646   case OpMlslLane:
 647     s += "__a - (" + Extend(proto, typestr, "__b") + " * " +
 648       Extend(proto, typestr, SplatLane(nElts, "__c", "__d")) + ");";
 649     break;
 650   case OpMlsl:
 651     s += "__a - (" + Extend(proto, typestr, "__b") + " * " +
 652       Extend(proto, typestr, "__c") + ");";
 653     break;
 654   case OpEq:
 655     s += "(" + ts + ")(__a == __b);";
 656     break;
 657   case OpGe:
 658     s += "(" + ts + ")(__a >= __b);";
 659     break;
 660   case OpLe:
 661     s += "(" + ts + ")(__a <= __b);";
 662     break;
 663   case OpGt:
 664     s += "(" + ts + ")(__a > __b);";
 665     break;
 666   case OpLt:
 667     s += "(" + ts + ")(__a < __b);";
 668     break;
 669   case OpNeg:
 670     s += " -__a;";
 671     break;
 672   case OpNot:
 673     s += " ~__a;";
 674     break;
 675   case OpAnd:
 676     s += "__a & __b;";
 677     break;
 678   case OpOr:
 679     s += "__a | __b;";
 680     break;
 681   case OpXor:
 682     s += "__a ^ __b;";
 683     break;
 684   case OpAndNot:
 685     s += "__a & ~__b;";
 686     break;
 687   case OpOrNot:
 688     s += "__a | ~__b;";
 689     break;
 690   case OpCast:
 691     s += "(" + ts + ")__a;";
 692     break;
 693   case OpConcat:
 694     s += "(" + ts + ")__builtin_shufflevector((int64x1_t)__a";
 695     s += ", (int64x1_t)__b, 0, 1);";
 696     break;
 697   case OpHi:
 698     s += "(((float64x2_t)__a)[1]);";
 699     break;
 700   case OpLo:
 701     s += "(((float64x2_t)__a)[0]);";
 702     break;
 703   case OpDup:
 704     s += Duplicate(nElts, typestr, "__a") + ";";
 705     break;
 706   case OpDupLane:
 707     s += SplatLane(nElts, "__a", "__b") + ";";
 708     break;
 709   case OpSelect:
 710     // ((0 & 1) | (~0 & 2))
 711     s += "(" + ts + ")";
 712     ts = TypeString(proto[1], typestr);
 713     s += "((__a & (" + ts + ")__b) | ";
 714     s += "(~__a & (" + ts + ")__c));";
 715     break;
 716   case OpRev16:
 717     s += "__builtin_shufflevector(__a, __a";
 718     for (unsigned i = 2; i <= nElts; i += 2)
 719       for (unsigned j = 0; j != 2; ++j)
 720         s += ", " + utostr(i - j - 1);
 721     s += ");";
 722     break;
 723   case OpRev32: {
 724     unsigned WordElts = nElts >> (1 + (int)quad);
 725     s += "__builtin_shufflevector(__a, __a";
 726     for (unsigned i = WordElts; i <= nElts; i += WordElts)
 727       for (unsigned j = 0; j != WordElts; ++j)
 728         s += ", " + utostr(i - j - 1);
 729     s += ");";
 730     break;
 731   }
 732   case OpRev64: {
 733     unsigned DblWordElts = nElts >> (int)quad;
 734     s += "__builtin_shufflevector(__a, __a";
 735     for (unsigned i = DblWordElts; i <= nElts; i += DblWordElts)
 736       for (unsigned j = 0; j != DblWordElts; ++j)
 737         s += ", " + utostr(i - j - 1);
 738     s += ");";
 739     break;
 740   }
 741   default:
 742     throw "unknown OpKind!";
 743     break;
 744   }
 745   if (op == OpHi || op == OpLo) {
 746     if (!define)
 747       s += " return";
 748     s += " u.r;";
 749   }
 750   return s;
 751 }
 752
 753 static unsigned GetNeonEnum(const std::string &proto, StringRef typestr) {
 754   unsigned mod = proto[0];
 755   unsigned ret = 0;
 756
 757   if (mod == 'v' || mod == 'f')
 758     mod = proto[1];
 759
 760   bool quad = false;
 761   bool poly = false;
 762   bool usgn = false;
 763   bool scal = false;
 764   bool cnst = false;
 765   bool pntr = false;
 766
 767   // Base type to get the type string for.
 768   char type = ClassifyType(typestr, quad, poly, usgn);
 769
 770   // Based on the modifying character, change the type and width if necessary.
 771   type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
 772
 773   if (usgn)
 774     ret |= 0x08;
 775   if (quad && proto[1] != 'g')
 776     ret |= 0x10;
 777
 778   switch (type) {
 779     case 'c':
 780       ret |= poly ? 5 : 0;
 781       break;
 782     case 's':
 783       ret |= poly ? 6 : 1;
 784       break;
 785     case 'i':
 786       ret |= 2;
 787       break;
 788     case 'l':
 789       ret |= 3;
 790       break;
 791     case 'h':
 792       ret |= 7;
 793       break;
 794     case 'f':
 795       ret |= 4;
 796       break;
 797     default:
 798       throw "unhandled type!";
 799       break;
 800   }
 801   return ret;
 802 }
 803
 804 // Generate the definition for this intrinsic, e.g. __builtin_neon_cls(a)
 805 static std::string GenBuiltin(const std::string &name, const std::string &proto,
 806                               StringRef typestr, ClassKind ck) {
 807   std::string s;
 808
 809   // If this builtin returns a struct 2, 3, or 4 vectors, pass it as an implicit
 810   // sret-like argument.
 811   bool sret = (proto[0] >= '2' && proto[0] <= '4');
 812
 813   // If this builtin takes an immediate argument, we need to #define it rather
 814   // than use a standard declaration, so that SemaChecking can range check
 815   // the immediate passed by the user.
 816   bool define = proto.find('i') != std::string::npos;
 817
 818   // Check if the prototype has a scalar operand with the type of the vector
 819   // elements.  If not, bitcasting the args will take care of arg checking.
 820   // The actual signedness etc. will be taken care of with special enums.
 821   if (proto.find('s') == std::string::npos)
 822     ck = ClassB;
 823
 824   if (proto[0] != 'v') {
 825     std::string ts = TypeString(proto[0], typestr);
 826
 827     if (define) {
 828       if (sret)
 829         s += ts + " r; ";
 830       else
 831         s += "(" + ts + ")";
 832     } else if (sret) {
 833       s += ts + " r; ";
 834     } else {
 835       s += "return (" + ts + ")";
 836     }
 837   }
 838
 839   bool splat = proto.find('a') != std::string::npos;
 840
 841   s += "__builtin_neon_";
 842   if (splat) {
 843     // Call the non-splat builtin: chop off the "_n" suffix from the name.
 844     std::string vname(name, 0, name.size()-2);
 845     s += MangleName(vname, typestr, ck);
 846   } else {
 847     s += MangleName(name, typestr, ck);
 848   }
 849   s += "(";
 850
 851   // Pass the address of the return variable as the first argument to sret-like
 852   // builtins.
 853   if (sret)
 854     s += "&r, ";
 855
 856   char arg = 'a';
 857   for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
 858     std::string args = std::string(&arg, 1);
 859
 860     // Use the local temporaries instead of the macro arguments.
 861     args = "__" + args;
 862
 863     bool argQuad = false;
 864     bool argPoly = false;
 865     bool argUsgn = false;
 866     bool argScalar = false;
 867     bool dummy = false;
 868     char argType = ClassifyType(typestr, argQuad, argPoly, argUsgn);
 869     argType = ModType(proto[i], argType, argQuad, argPoly, argUsgn, argScalar,
 870                       dummy, dummy);
 871
 872     // Handle multiple-vector values specially, emitting each subvector as an
 873     // argument to the __builtin.
 874     if (proto[i] >= '2' && proto[i] <= '4') {
 875       // Check if an explicit cast is needed.
 876       if (argType != 'c' || argPoly || argUsgn)
 877         args = (argQuad ? "(int8x16_t)" : "(int8x8_t)") + args;
 878
 879       for (unsigned vi = 0, ve = proto[i] - '0'; vi != ve; ++vi) {
 880         s += args + ".val[" + utostr(vi) + "]";
 881         if ((vi + 1) < ve)
 882           s += ", ";
 883       }
 884       if ((i + 1) < e)
 885         s += ", ";
 886
 887       continue;
 888     }
 889
 890     if (splat && (i + 1) == e)
 891       args = Duplicate(GetNumElements(typestr, argQuad), typestr, args);
 892
 893     // Check if an explicit cast is needed.
 894     if ((splat || !argScalar) &&
 895         ((ck == ClassB && argType != 'c') || argPoly || argUsgn)) {
 896       std::string argTypeStr = "c";
 897       if (ck != ClassB)
 898         argTypeStr = argType;
 899       if (argQuad)
 900         argTypeStr = "Q" + argTypeStr;
 901       args = "(" + TypeString('d', argTypeStr) + ")" + args;
 902     }
 903
 904     s += args;
 905     if ((i + 1) < e)
 906       s += ", ";
 907   }
 908
 909   // Extra constant integer to hold type class enum for this function, e.g. s8
 910   if (ck == ClassB)
 911     s += ", " + utostr(GetNeonEnum(proto, typestr));
 912
 913   s += ");";
 914
 915   if (proto[0] != 'v' && sret) {
 916     if (define)
 917       s += " r;";
 918     else
 919       s += " return r;";
 920   }
 921   return s;
 922 }
 923
 924 static std::string GenBuiltinDef(const std::string &name,
 925                                  const std::string &proto,
 926                                  StringRef typestr, ClassKind ck) {
 927   std::string s("BUILTIN(__builtin_neon_");
 928
 929   // If all types are the same size, bitcasting the args will take care
 930   // of arg checking.  The actual signedness etc. will be taken care of with
 931   // special enums.
 932   if (proto.find('s') == std::string::npos)
 933     ck = ClassB;
 934
 935   s += MangleName(name, typestr, ck);
 936   s += ", \"";
 937
 938   for (unsigned i = 0, e = proto.size(); i != e; ++i)
 939     s += BuiltinTypeString(proto[i], typestr, ck, i == 0);
 940
 941   // Extra constant integer to hold type class enum for this function, e.g. s8
 942   if (ck == ClassB)
 943     s += "i";
 944
 945   s += "\", \"n\")";
 946   return s;
 947 }
 948
 949 static std::string GenIntrinsic(const std::string &name,
 950                                 const std::string &proto,
 951                                 StringRef outTypeStr, StringRef inTypeStr,
 952                                 OpKind kind, ClassKind classKind) {
 953   assert(!proto.empty() && "");
 954   bool define = proto.find('i') != std::string::npos;
 955   std::string s;
 956
 957   // static always inline + return type
 958   if (define)
 959     s += "#define ";
 960   else
 961     s += "__ai " + TypeString(proto[0], outTypeStr) + " ";
 962
 963   // Function name with type suffix
 964   std::string mangledName = MangleName(name, outTypeStr, ClassS);
 965   if (outTypeStr != inTypeStr) {
 966     // If the input type is different (e.g., for vreinterpret), append a suffix
 967     // for the input type.  String off a "Q" (quad) prefix so that MangleName
 968     // does not insert another "q" in the name.
 969     unsigned typeStrOff = (inTypeStr[0] == 'Q' ? 1 : 0);
 970     StringRef inTypeNoQuad = inTypeStr.substr(typeStrOff);
 971     mangledName = MangleName(mangledName, inTypeNoQuad, ClassS);
 972   }
 973   s += mangledName;
 974
 975   // Function arguments
 976   s += GenArgs(proto, inTypeStr);
 977
 978   // Definition.
 979   if (define) {
 980     s += " __extension__ ({ \\\n  ";
 981     s += GenMacroLocals(proto, inTypeStr);
 982   } else {
 983     s += " { \\\n  ";
 984   }
 985
 986   if (kind != OpNone)
 987     s += GenOpString(kind, proto, outTypeStr);
 988   else
 989     s += GenBuiltin(name, proto, outTypeStr, classKind);
 990   if (define)
 991     s += " })";
 992   else
 993     s += " }";
 994   s += "\n";
 995   return s;
 996 }
 997
 998 /// run - Read the records in arm_neon.td and output arm_neon.h.  arm_neon.h
 999 /// is comprised of type definitions and function declarations.
1000 void NeonEmitter::run(raw_ostream &OS) {
1001   EmitSourceFileHeader("ARM NEON Header", OS);
1002
1003   // FIXME: emit license into file?
1004
1005   OS << "#ifndef __ARM_NEON_H\n";
1006   OS << "#define __ARM_NEON_H\n\n";
1007
1008   OS << "#ifndef __ARM_NEON__\n";
1009   OS << "#error \"NEON support not enabled\"\n";
1010   OS << "#endif\n\n";
1011
1012   OS << "#include <stdint.h>\n\n";
1013
1014   // Emit NEON-specific scalar typedefs.
1015   OS << "typedef float float32_t;\n";
1016   OS << "typedef int8_t poly8_t;\n";
1017   OS << "typedef int16_t poly16_t;\n";
1018   OS << "typedef uint16_t float16_t;\n";
1019
1020   // Emit Neon vector typedefs.
1021   std::string TypedefTypes("cQcsQsiQilQlUcQUcUsQUsUiQUiUlQUlhQhfQfPcQPcPsQPs");
1022   SmallVector<StringRef, 24> TDTypeVec;
1023   ParseTypes(0, TypedefTypes, TDTypeVec);
1024
1025   // Emit vector typedefs.
1026   for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1027     bool dummy, quad = false, poly = false;
1028     (void) ClassifyType(TDTypeVec[i], quad, poly, dummy);
1029     if (poly)
1030       OS << "typedef __attribute__((neon_polyvector_type(";
1031     else
1032       OS << "typedef __attribute__((neon_vector_type(";
1033
1034     unsigned nElts = GetNumElements(TDTypeVec[i], quad);
1035     OS << utostr(nElts) << "))) ";
1036     if (nElts < 10)
1037       OS << " ";
1038
1039     OS << TypeString('s', TDTypeVec[i]);
1040     OS << " " << TypeString('d', TDTypeVec[i]) << ";\n";
1041   }
1042   OS << "\n";
1043   OS << "typedef __attribute__((__vector_size__(8)))  "
1044     "double float64x1_t;\n";
1045   OS << "typedef __attribute__((__vector_size__(16))) "
1046     "double float64x2_t;\n";
1047   OS << "\n";
1048
1049   // Emit struct typedefs.
1050   for (unsigned vi = 2; vi != 5; ++vi) {
1051     for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1052       std::string ts = TypeString('d', TDTypeVec[i]);
1053       std::string vs = TypeString('0' + vi, TDTypeVec[i]);
1054       OS << "typedef struct " << vs << " {\n";
1055       OS << "  " << ts << " val";
1056       OS << "[" << utostr(vi) << "]";
1057       OS << ";\n} ";
1058       OS << vs << ";\n\n";
1059     }
1060   }
1061
1062   OS << "#define __ai static __attribute__((__always_inline__))\n\n";
1063
1064   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1065
1066   // Emit vmovl intrinsics first so they can be used by other intrinsics.
1067   emitIntrinsic(OS, Records.getDef("VMOVL"));
1068
1069   // Unique the return+pattern types, and assign them.
1070   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1071     Record *R = RV[i];
1072     if (R->getName() != "VMOVL")
1073       emitIntrinsic(OS, R);
1074   }
1075
1076   OS << "#undef __ai\n\n";
1077   OS << "#endif /* __ARM_NEON_H */\n";
1078 }
1079
1080 /// emitIntrinsic - Write out the arm_neon.h header file definitions for the
1081 /// intrinsics specified by record R.
1082 void NeonEmitter::emitIntrinsic(raw_ostream &OS, Record *R) {
1083   std::string name = R->getValueAsString("Name");
1084   std::string Proto = R->getValueAsString("Prototype");
1085   std::string Types = R->getValueAsString("Types");
1086
1087   SmallVector<StringRef, 16> TypeVec;
1088   ParseTypes(R, Types, TypeVec);
1089
1090   OpKind kind = OpMap[R->getValueAsDef("Operand")->getName()];
1091
1092   ClassKind classKind = ClassNone;
1093   if (R->getSuperClasses().size() >= 2)
1094     classKind = ClassMap[R->getSuperClasses()[1]];
1095   if (classKind == ClassNone && kind == OpNone)
1096     throw TGError(R->getLoc(), "Builtin has no class kind");
1097
1098   for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1099     if (kind == OpReinterpret) {
1100       bool outQuad = false;
1101       bool dummy = false;
1102       (void)ClassifyType(TypeVec[ti], outQuad, dummy, dummy);
1103       for (unsigned srcti = 0, srcte = TypeVec.size();
1104            srcti != srcte; ++srcti) {
1105         bool inQuad = false;
1106         (void)ClassifyType(TypeVec[srcti], inQuad, dummy, dummy);
1107         if (srcti == ti || inQuad != outQuad)
1108           continue;
1109         OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[srcti],
1110                            OpCast, ClassS);
1111       }
1112     } else {
1113       OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[ti],
1114                          kind, classKind);
1115     }
1116   }
1117   OS << "\n";
1118 }
1119
1120 static unsigned RangeFromType(StringRef typestr) {
1121   // base type to get the type string for.
1122   bool quad = false, dummy = false;
1123   char type = ClassifyType(typestr, quad, dummy, dummy);
1124
1125   switch (type) {
1126     case 'c':
1127       return (8 << (int)quad) - 1;
1128     case 'h':
1129     case 's':
1130       return (4 << (int)quad) - 1;
1131     case 'f':
1132     case 'i':
1133       return (2 << (int)quad) - 1;
1134     case 'l':
1135       return (1 << (int)quad) - 1;
1136     default:
1137       throw "unhandled type!";
1138       break;
1139   }
1140   assert(0 && "unreachable");
1141   return 0;
1142 }
1143
1144 /// runHeader - Emit a file with sections defining:
1145 /// 1. the NEON section of BuiltinsARM.def.
1146 /// 2. the SemaChecking code for the type overload checking.
1147 /// 3. the SemaChecking code for validation of intrinsic immedate arguments.
1148 void NeonEmitter::runHeader(raw_ostream &OS) {
1149   std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1150
1151   StringMap<OpKind> EmittedMap;
1152
1153   // Generate BuiltinsARM.def for NEON
1154   OS << "#ifdef GET_NEON_BUILTINS\n";
1155   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1156     Record *R = RV[i];
1157     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1158     if (k != OpNone)
1159       continue;
1160
1161     std::string Proto = R->getValueAsString("Prototype");
1162
1163     // Functions with 'a' (the splat code) in the type prototype should not get
1164     // their own builtin as they use the non-splat variant.
1165     if (Proto.find('a') != std::string::npos)
1166       continue;
1167
1168     std::string Types = R->getValueAsString("Types");
1169     SmallVector<StringRef, 16> TypeVec;
1170     ParseTypes(R, Types, TypeVec);
1171
1172     if (R->getSuperClasses().size() < 2)
1173       throw TGError(R->getLoc(), "Builtin has no class kind");
1174
1175     std::string name = R->getValueAsString("Name");
1176     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1177
1178     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1179       // Generate the BuiltinsARM.def declaration for this builtin, ensuring
1180       // that each unique BUILTIN() macro appears only once in the output
1181       // stream.
1182       std::string bd = GenBuiltinDef(name, Proto, TypeVec[ti], ck);
1183       if (EmittedMap.count(bd))
1184         continue;
1185
1186       EmittedMap[bd] = OpNone;
1187       OS << bd << "\n";
1188     }
1189   }
1190   OS << "#endif\n\n";
1191
1192   // Generate the overloaded type checking code for SemaChecking.cpp
1193   OS << "#ifdef GET_NEON_OVERLOAD_CHECK\n";
1194   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1195     Record *R = RV[i];
1196     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1197     if (k != OpNone)
1198       continue;
1199
1200     std::string Proto = R->getValueAsString("Prototype");
1201     std::string Types = R->getValueAsString("Types");
1202     std::string name = R->getValueAsString("Name");
1203
1204     // Functions with 'a' (the splat code) in the type prototype should not get
1205     // their own builtin as they use the non-splat variant.
1206     if (Proto.find('a') != std::string::npos)
1207       continue;
1208
1209     // Functions which have a scalar argument cannot be overloaded, no need to
1210     // check them if we are emitting the type checking code.
1211     if (Proto.find('s') != std::string::npos)
1212       continue;
1213
1214     SmallVector<StringRef, 16> TypeVec;
1215     ParseTypes(R, Types, TypeVec);
1216
1217     if (R->getSuperClasses().size() < 2)
1218       throw TGError(R->getLoc(), "Builtin has no class kind");
1219
1220     int si = -1, qi = -1;
1221     unsigned mask = 0, qmask = 0;
1222     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1223       // Generate the switch case(s) for this builtin for the type validation.
1224       bool quad = false, poly = false, usgn = false;
1225       (void) ClassifyType(TypeVec[ti], quad, poly, usgn);
1226
1227       if (quad) {
1228         qi = ti;
1229         qmask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1230       } else {
1231         si = ti;
1232         mask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1233       }
1234     }
1235     if (mask)
1236       OS << "case ARM::BI__builtin_neon_"
1237          << MangleName(name, TypeVec[si], ClassB)
1238          << ": mask = " << "0x" << utohexstr(mask) << "; break;\n";
1239     if (qmask)
1240       OS << "case ARM::BI__builtin_neon_"
1241          << MangleName(name, TypeVec[qi], ClassB)
1242          << ": mask = " << "0x" << utohexstr(qmask) << "; break;\n";
1243   }
1244   OS << "#endif\n\n";
1245
1246   // Generate the intrinsic range checking code for shift/lane immediates.
1247   OS << "#ifdef GET_NEON_IMMEDIATE_CHECK\n";
1248   for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1249     Record *R = RV[i];
1250
1251     OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1252     if (k != OpNone)
1253       continue;
1254
1255     std::string name = R->getValueAsString("Name");
1256     std::string Proto = R->getValueAsString("Prototype");
1257     std::string Types = R->getValueAsString("Types");
1258
1259     // Functions with 'a' (the splat code) in the type prototype should not get
1260     // their own builtin as they use the non-splat variant.
1261     if (Proto.find('a') != std::string::npos)
1262       continue;
1263
1264     // Functions which do not have an immediate do not need to have range
1265     // checking code emitted.
1266     if (Proto.find('i') == std::string::npos)
1267       continue;
1268
1269     SmallVector<StringRef, 16> TypeVec;
1270     ParseTypes(R, Types, TypeVec);
1271
1272     if (R->getSuperClasses().size() < 2)
1273       throw TGError(R->getLoc(), "Builtin has no class kind");
1274
1275     ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1276
1277     for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1278       std::string namestr, shiftstr, rangestr;
1279
1280       // Builtins which are overloaded by type will need to have their upper
1281       // bound computed at Sema time based on the type constant.
1282       if (Proto.find('s') == std::string::npos) {
1283         ck = ClassB;
1284         if (R->getValueAsBit("isShift")) {
1285           shiftstr = ", true";
1286
1287           // Right shifts have an 'r' in the name, left shifts do not.
1288           if (name.find('r') != std::string::npos)
1289             rangestr = "l = 1; ";
1290         }
1291         rangestr += "u = RFT(TV" + shiftstr + ")";
1292       } else {
1293         rangestr = "u = " + utostr(RangeFromType(TypeVec[ti]));
1294       }
1295       // Make sure cases appear only once by uniquing them in a string map.
1296       namestr = MangleName(name, TypeVec[ti], ck);
1297       if (EmittedMap.count(namestr))
1298         continue;
1299       EmittedMap[namestr] = OpNone;
1300
1301       // Calculate the index of the immediate that should be range checked.
1302       unsigned immidx = 0;
1303
1304       // Builtins that return a struct of multiple vectors have an extra
1305       // leading arg for the struct return.
1306       if (Proto[0] >= '2' && Proto[0] <= '4')
1307         ++immidx;
1308
1309       // Add one to the index for each argument until we reach the immediate
1310       // to be checked.  Structs of vectors are passed as multiple arguments.
1311       for (unsigned ii = 1, ie = Proto.size(); ii != ie; ++ii) {
1312         switch (Proto[ii]) {
1313           default:  immidx += 1; break;
1314           case '2': immidx += 2; break;
1315           case '3': immidx += 3; break;
1316           case '4': immidx += 4; break;
1317           case 'i': ie = ii + 1; break;
1318         }
1319       }
1320       OS << "case ARM::BI__builtin_neon_" << MangleName(name, TypeVec[ti], ck)
1321          << ": i = " << immidx << "; " << rangestr << "; break;\n";
1322     }
1323   }
1324   OS << "#endif\n\n";
1325 }