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