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