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