utils/TableGen/IntrinsicEmitter.cpp

   1 //===- IntrinsicEmitter.cpp - Generate intrinsic information --------------===//
   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 emits information about intrinsic functions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "CodeGenIntrinsics.h"
  15 #include "CodeGenTarget.h"
  16 #include "SequenceToOffsetTable.h"
  17 #include "TableGenBackends.h"
  18 #include "llvm/ADT/StringExtras.h"
  19 #include "llvm/TableGen/Error.h"
  20 #include "llvm/TableGen/Record.h"
  21 #include "llvm/TableGen/StringMatcher.h"
  22 #include "llvm/TableGen/TableGenBackend.h"
  23 #include <algorithm>
  24 using namespace llvm;
  25
  26 namespace {
  27 class IntrinsicEmitter {
  28   RecordKeeper &Records;
  29   bool TargetOnly;
  30   std::string TargetPrefix;
  31
  32 public:
  33   IntrinsicEmitter(RecordKeeper &R, bool T)
  34     : Records(R), TargetOnly(T) {}
  35
  36   void run(raw_ostream &OS);
  37
  38   void EmitPrefix(raw_ostream &OS);
  39
  40   void EmitEnumInfo(const std::vector<CodeGenIntrinsic> &Ints,
  41                     raw_ostream &OS);
  42
  43   void EmitFnNameRecognizer(const std::vector<CodeGenIntrinsic> &Ints,
  44                             raw_ostream &OS);
  45   void EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
  46                                 raw_ostream &OS);
  47   void EmitIntrinsicToOverloadTable(const std::vector<CodeGenIntrinsic> &Ints,
  48                                     raw_ostream &OS);
  49   void EmitGenerator(const std::vector<CodeGenIntrinsic> &Ints,
  50                      raw_ostream &OS);
  51   void EmitAttributes(const std::vector<CodeGenIntrinsic> &Ints,
  52                       raw_ostream &OS);
  53   void EmitModRefBehavior(const std::vector<CodeGenIntrinsic> &Ints,
  54                           raw_ostream &OS);
  55   void EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
  56                                     raw_ostream &OS);
  57   void EmitIntrinsicToMSBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
  58                                    raw_ostream &OS);
  59   void EmitSuffix(raw_ostream &OS);
  60 };
  61 } // End anonymous namespace
  62
  63 //===----------------------------------------------------------------------===//
  64 // IntrinsicEmitter Implementation
  65 //===----------------------------------------------------------------------===//
  66
  67 void IntrinsicEmitter::run(raw_ostream &OS) {
  68   emitSourceFileHeader("Intrinsic Function Source Fragment", OS);
  69
  70   std::vector<CodeGenIntrinsic> Ints = LoadIntrinsics(Records, TargetOnly);
  71
  72   if (TargetOnly && !Ints.empty())
  73     TargetPrefix = Ints[0].TargetPrefix;
  74
  75   EmitPrefix(OS);
  76
  77   // Emit the enum information.
  78   EmitEnumInfo(Ints, OS);
  79
  80   // Emit the intrinsic ID -> name table.
  81   EmitIntrinsicToNameTable(Ints, OS);
  82
  83   // Emit the intrinsic ID -> overload table.
  84   EmitIntrinsicToOverloadTable(Ints, OS);
  85
  86   // Emit the function name recognizer.
  87   EmitFnNameRecognizer(Ints, OS);
  88
  89   // Emit the intrinsic declaration generator.
  90   EmitGenerator(Ints, OS);
  91
  92   // Emit the intrinsic parameter attributes.
  93   EmitAttributes(Ints, OS);
  94
  95   // Emit intrinsic alias analysis mod/ref behavior.
  96   EmitModRefBehavior(Ints, OS);
  97
  98   // Emit code to translate GCC builtins into LLVM intrinsics.
  99   EmitIntrinsicToGCCBuiltinMap(Ints, OS);
 100
 101   // Emit code to translate MS builtins into LLVM intrinsics.
 102   EmitIntrinsicToMSBuiltinMap(Ints, OS);
 103
 104   EmitSuffix(OS);
 105 }
 106
 107 void IntrinsicEmitter::EmitPrefix(raw_ostream &OS) {
 108   OS << "// VisualStudio defines setjmp as _setjmp\n"
 109         "#if defined(_MSC_VER) && defined(setjmp) && \\\n"
 110         "                         !defined(setjmp_undefined_for_msvc)\n"
 111         "#  pragma push_macro(\"setjmp\")\n"
 112         "#  undef setjmp\n"
 113         "#  define setjmp_undefined_for_msvc\n"
 114         "#endif\n\n";
 115 }
 116
 117 void IntrinsicEmitter::EmitSuffix(raw_ostream &OS) {
 118   OS << "#if defined(_MSC_VER) && defined(setjmp_undefined_for_msvc)\n"
 119         "// let's return it to _setjmp state\n"
 120         "#  pragma pop_macro(\"setjmp\")\n"
 121         "#  undef setjmp_undefined_for_msvc\n"
 122         "#endif\n\n";
 123 }
 124
 125 void IntrinsicEmitter::EmitEnumInfo(const std::vector<CodeGenIntrinsic> &Ints,
 126                                     raw_ostream &OS) {
 127   OS << "// Enum values for Intrinsics.h\n";
 128   OS << "#ifdef GET_INTRINSIC_ENUM_VALUES\n";
 129   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 130     OS << "    " << Ints[i].EnumName;
 131     OS << ((i != e-1) ? ", " : "  ");
 132     if (Ints[i].EnumName.size() < 40)
 133       OS << std::string(40-Ints[i].EnumName.size(), ' ');
 134     OS << " // " << Ints[i].Name << "\n";
 135   }
 136   OS << "#endif\n\n";
 137 }
 138
 139 void IntrinsicEmitter::
 140 EmitFnNameRecognizer(const std::vector<CodeGenIntrinsic> &Ints,
 141                      raw_ostream &OS) {
 142   // Build a 'first character of function name' -> intrinsic # mapping.
 143   std::map<char, std::vector<unsigned> > IntMapping;
 144   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 145     IntMapping[Ints[i].Name[5]].push_back(i);
 146
 147   OS << "// Function name -> enum value recognizer code.\n";
 148   OS << "#ifdef GET_FUNCTION_RECOGNIZER\n";
 149   OS << "  StringRef NameR(Name+6, Len-6);   // Skip over 'llvm.'\n";
 150   OS << "  switch (Name[5]) {                  // Dispatch on first letter.\n";
 151   OS << "  default: break;\n";
 152   // Emit the intrinsic matching stuff by first letter.
 153   for (std::map<char, std::vector<unsigned> >::iterator I = IntMapping.begin(),
 154        E = IntMapping.end(); I != E; ++I) {
 155     OS << "  case '" << I->first << "':\n";
 156     std::vector<unsigned> &IntList = I->second;
 157
 158     // Sort in reverse order of intrinsic name so "abc.def" appears after
 159     // "abd.def.ghi" in the overridden name matcher
 160     std::sort(IntList.begin(), IntList.end(), [&](unsigned i, unsigned j) {
 161       return Ints[i].Name > Ints[j].Name;
 162     });
 163
 164     // Emit all the overloaded intrinsics first, build a table of the
 165     // non-overloaded ones.
 166     std::vector<StringMatcher::StringPair> MatchTable;
 167
 168     for (unsigned i = 0, e = IntList.size(); i != e; ++i) {
 169       unsigned IntNo = IntList[i];
 170       std::string Result = "return " + TargetPrefix + "Intrinsic::" +
 171         Ints[IntNo].EnumName + ";";
 172
 173       if (!Ints[IntNo].isOverloaded) {
 174         MatchTable.push_back(std::make_pair(Ints[IntNo].Name.substr(6),Result));
 175         continue;
 176       }
 177
 178       // For overloaded intrinsics, only the prefix needs to match
 179       std::string TheStr = Ints[IntNo].Name.substr(6);
 180       TheStr += '.';  // Require "bswap." instead of bswap.
 181       OS << "    if (NameR.startswith(\"" << TheStr << "\")) "
 182          << Result << '\n';
 183     }
 184
 185     // Emit the matcher logic for the fixed length strings.
 186     StringMatcher("NameR", MatchTable, OS).Emit(1);
 187     OS << "    break;  // end of '" << I->first << "' case.\n";
 188   }
 189
 190   OS << "  }\n";
 191   OS << "#endif\n\n";
 192 }
 193
 194 void IntrinsicEmitter::
 195 EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
 196                          raw_ostream &OS) {
 197   OS << "// Intrinsic ID to name table\n";
 198   OS << "#ifdef GET_INTRINSIC_NAME_TABLE\n";
 199   OS << "  // Note that entry #0 is the invalid intrinsic!\n";
 200   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 201     OS << "  \"" << Ints[i].Name << "\",\n";
 202   OS << "#endif\n\n";
 203 }
 204
 205 void IntrinsicEmitter::
 206 EmitIntrinsicToOverloadTable(const std::vector<CodeGenIntrinsic> &Ints,
 207                          raw_ostream &OS) {
 208   OS << "// Intrinsic ID to overload bitset\n";
 209   OS << "#ifdef GET_INTRINSIC_OVERLOAD_TABLE\n";
 210   OS << "static const uint8_t OTable[] = {\n";
 211   OS << "  0";
 212   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 213     // Add one to the index so we emit a null bit for the invalid #0 intrinsic.
 214     if ((i+1)%8 == 0)
 215       OS << ",\n  0";
 216     if (Ints[i].isOverloaded)
 217       OS << " | (1<<" << (i+1)%8 << ')';
 218   }
 219   OS << "\n};\n\n";
 220   // OTable contains a true bit at the position if the intrinsic is overloaded.
 221   OS << "return (OTable[id/8] & (1 << (id%8))) != 0;\n";
 222   OS << "#endif\n\n";
 223 }
 224
 225
 226 // NOTE: This must be kept in synch with the copy in lib/VMCore/Function.cpp!
 227 enum IIT_Info {
 228   // Common values should be encoded with 0-15.
 229   IIT_Done = 0,
 230   IIT_I1   = 1,
 231   IIT_I8   = 2,
 232   IIT_I16  = 3,
 233   IIT_I32  = 4,
 234   IIT_I64  = 5,
 235   IIT_F16  = 6,
 236   IIT_F32  = 7,
 237   IIT_F64  = 8,
 238   IIT_V2   = 9,
 239   IIT_V4   = 10,
 240   IIT_V8   = 11,
 241   IIT_V16  = 12,
 242   IIT_V32  = 13,
 243   IIT_PTR  = 14,
 244   IIT_ARG  = 15,
 245
 246   // Values from 16+ are only encodable with the inefficient encoding.
 247   IIT_V64  = 16,
 248   IIT_MMX  = 17,
 249   IIT_TOKEN = 18,
 250   IIT_METADATA = 19,
 251   IIT_EMPTYSTRUCT = 20,
 252   IIT_STRUCT2 = 21,
 253   IIT_STRUCT3 = 22,
 254   IIT_STRUCT4 = 23,
 255   IIT_STRUCT5 = 24,
 256   IIT_EXTEND_ARG = 25,
 257   IIT_TRUNC_ARG = 26,
 258   IIT_ANYPTR = 27,
 259   IIT_V1   = 28,
 260   IIT_VARARG = 29,
 261   IIT_HALF_VEC_ARG = 30,
 262   IIT_SAME_VEC_WIDTH_ARG = 31,
 263   IIT_PTR_TO_ARG = 32,
 264   IIT_VEC_OF_PTRS_TO_ELT = 33,
 265   IIT_I128 = 34
 266 };
 267
 268
 269 static void EncodeFixedValueType(MVT::SimpleValueType VT,
 270                                  std::vector<unsigned char> &Sig) {
 271   if (MVT(VT).isInteger()) {
 272     unsigned BitWidth = MVT(VT).getSizeInBits();
 273     switch (BitWidth) {
 274     default: PrintFatalError("unhandled integer type width in intrinsic!");
 275     case 1: return Sig.push_back(IIT_I1);
 276     case 8: return Sig.push_back(IIT_I8);
 277     case 16: return Sig.push_back(IIT_I16);
 278     case 32: return Sig.push_back(IIT_I32);
 279     case 64: return Sig.push_back(IIT_I64);
 280     case 128: return Sig.push_back(IIT_I128);
 281     }
 282   }
 283
 284   switch (VT) {
 285   default: PrintFatalError("unhandled MVT in intrinsic!");
 286   case MVT::f16: return Sig.push_back(IIT_F16);
 287   case MVT::f32: return Sig.push_back(IIT_F32);
 288   case MVT::f64: return Sig.push_back(IIT_F64);
 289   case MVT::token: return Sig.push_back(IIT_TOKEN);
 290   case MVT::Metadata: return Sig.push_back(IIT_METADATA);
 291   case MVT::x86mmx: return Sig.push_back(IIT_MMX);
 292   // MVT::OtherVT is used to mean the empty struct type here.
 293   case MVT::Other: return Sig.push_back(IIT_EMPTYSTRUCT);
 294   // MVT::isVoid is used to represent varargs here.
 295   case MVT::isVoid: return Sig.push_back(IIT_VARARG);
 296   }
 297 }
 298
 299 #if defined(_MSC_VER) && !defined(__clang__)
 300 #pragma optimize("",off) // MSVC 2010 optimizer can't deal with this function.
 301 #endif
 302
 303 static void EncodeFixedType(Record *R, std::vector<unsigned char> &ArgCodes,
 304                             std::vector<unsigned char> &Sig) {
 305
 306   if (R->isSubClassOf("LLVMMatchType")) {
 307     unsigned Number = R->getValueAsInt("Number");
 308     assert(Number < ArgCodes.size() && "Invalid matching number!");
 309     if (R->isSubClassOf("LLVMExtendedType"))
 310       Sig.push_back(IIT_EXTEND_ARG);
 311     else if (R->isSubClassOf("LLVMTruncatedType"))
 312       Sig.push_back(IIT_TRUNC_ARG);
 313     else if (R->isSubClassOf("LLVMHalfElementsVectorType"))
 314       Sig.push_back(IIT_HALF_VEC_ARG);
 315     else if (R->isSubClassOf("LLVMVectorSameWidth")) {
 316       Sig.push_back(IIT_SAME_VEC_WIDTH_ARG);
 317       Sig.push_back((Number << 3) | ArgCodes[Number]);
 318       MVT::SimpleValueType VT = getValueType(R->getValueAsDef("ElTy"));
 319       EncodeFixedValueType(VT, Sig);
 320       return;
 321     }
 322     else if (R->isSubClassOf("LLVMPointerTo"))
 323       Sig.push_back(IIT_PTR_TO_ARG);
 324     else if (R->isSubClassOf("LLVMVectorOfPointersToElt"))
 325       Sig.push_back(IIT_VEC_OF_PTRS_TO_ELT);
 326     else
 327       Sig.push_back(IIT_ARG);
 328     return Sig.push_back((Number << 3) | ArgCodes[Number]);
 329   }
 330
 331   MVT::SimpleValueType VT = getValueType(R->getValueAsDef("VT"));
 332
 333   unsigned Tmp = 0;
 334   switch (VT) {
 335   default: break;
 336   case MVT::iPTRAny: ++Tmp; // FALL THROUGH.
 337   case MVT::vAny: ++Tmp; // FALL THROUGH.
 338   case MVT::fAny: ++Tmp; // FALL THROUGH.
 339   case MVT::iAny: ++Tmp; // FALL THROUGH.
 340   case MVT::Any: {
 341     // If this is an "any" valuetype, then the type is the type of the next
 342     // type in the list specified to getIntrinsic().
 343     Sig.push_back(IIT_ARG);
 344
 345     // Figure out what arg # this is consuming, and remember what kind it was.
 346     unsigned ArgNo = ArgCodes.size();
 347     ArgCodes.push_back(Tmp);
 348
 349     // Encode what sort of argument it must be in the low 3 bits of the ArgNo.
 350     return Sig.push_back((ArgNo << 3) | Tmp);
 351   }
 352
 353   case MVT::iPTR: {
 354     unsigned AddrSpace = 0;
 355     if (R->isSubClassOf("LLVMQualPointerType")) {
 356       AddrSpace = R->getValueAsInt("AddrSpace");
 357       assert(AddrSpace < 256 && "Address space exceeds 255");
 358     }
 359     if (AddrSpace) {
 360       Sig.push_back(IIT_ANYPTR);
 361       Sig.push_back(AddrSpace);
 362     } else {
 363       Sig.push_back(IIT_PTR);
 364     }
 365     return EncodeFixedType(R->getValueAsDef("ElTy"), ArgCodes, Sig);
 366   }
 367   }
 368
 369   if (MVT(VT).isVector()) {
 370     MVT VVT = VT;
 371     switch (VVT.getVectorNumElements()) {
 372     default: PrintFatalError("unhandled vector type width in intrinsic!");
 373     case 1: Sig.push_back(IIT_V1); break;
 374     case 2: Sig.push_back(IIT_V2); break;
 375     case 4: Sig.push_back(IIT_V4); break;
 376     case 8: Sig.push_back(IIT_V8); break;
 377     case 16: Sig.push_back(IIT_V16); break;
 378     case 32: Sig.push_back(IIT_V32); break;
 379     case 64: Sig.push_back(IIT_V64); break;
 380     }
 381
 382     return EncodeFixedValueType(VVT.getVectorElementType().SimpleTy, Sig);
 383   }
 384
 385   EncodeFixedValueType(VT, Sig);
 386 }
 387
 388 #if defined(_MSC_VER) && !defined(__clang__)
 389 #pragma optimize("",on)
 390 #endif
 391
 392 /// ComputeFixedEncoding - If we can encode the type signature for this
 393 /// intrinsic into 32 bits, return it.  If not, return ~0U.
 394 static void ComputeFixedEncoding(const CodeGenIntrinsic &Int,
 395                                  std::vector<unsigned char> &TypeSig) {
 396   std::vector<unsigned char> ArgCodes;
 397
 398   if (Int.IS.RetVTs.empty())
 399     TypeSig.push_back(IIT_Done);
 400   else if (Int.IS.RetVTs.size() == 1 &&
 401            Int.IS.RetVTs[0] == MVT::isVoid)
 402     TypeSig.push_back(IIT_Done);
 403   else {
 404     switch (Int.IS.RetVTs.size()) {
 405       case 1: break;
 406       case 2: TypeSig.push_back(IIT_STRUCT2); break;
 407       case 3: TypeSig.push_back(IIT_STRUCT3); break;
 408       case 4: TypeSig.push_back(IIT_STRUCT4); break;
 409       case 5: TypeSig.push_back(IIT_STRUCT5); break;
 410       default: llvm_unreachable("Unhandled case in struct");
 411     }
 412
 413     for (unsigned i = 0, e = Int.IS.RetVTs.size(); i != e; ++i)
 414       EncodeFixedType(Int.IS.RetTypeDefs[i], ArgCodes, TypeSig);
 415   }
 416
 417   for (unsigned i = 0, e = Int.IS.ParamTypeDefs.size(); i != e; ++i)
 418     EncodeFixedType(Int.IS.ParamTypeDefs[i], ArgCodes, TypeSig);
 419 }
 420
 421 static void printIITEntry(raw_ostream &OS, unsigned char X) {
 422   OS << (unsigned)X;
 423 }
 424
 425 void IntrinsicEmitter::EmitGenerator(const std::vector<CodeGenIntrinsic> &Ints,
 426                                      raw_ostream &OS) {
 427   // If we can compute a 32-bit fixed encoding for this intrinsic, do so and
 428   // capture it in this vector, otherwise store a ~0U.
 429   std::vector<unsigned> FixedEncodings;
 430
 431   SequenceToOffsetTable<std::vector<unsigned char> > LongEncodingTable;
 432
 433   std::vector<unsigned char> TypeSig;
 434
 435   // Compute the unique argument type info.
 436   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 437     // Get the signature for the intrinsic.
 438     TypeSig.clear();
 439     ComputeFixedEncoding(Ints[i], TypeSig);
 440
 441     // Check to see if we can encode it into a 32-bit word.  We can only encode
 442     // 8 nibbles into a 32-bit word.
 443     if (TypeSig.size() <= 8) {
 444       bool Failed = false;
 445       unsigned Result = 0;
 446       for (unsigned i = 0, e = TypeSig.size(); i != e; ++i) {
 447         // If we had an unencodable argument, bail out.
 448         if (TypeSig[i] > 15) {
 449           Failed = true;
 450           break;
 451         }
 452         Result = (Result << 4) | TypeSig[e-i-1];
 453       }
 454
 455       // If this could be encoded into a 31-bit word, return it.
 456       if (!Failed && (Result >> 31) == 0) {
 457         FixedEncodings.push_back(Result);
 458         continue;
 459       }
 460     }
 461
 462     // Otherwise, we're going to unique the sequence into the
 463     // LongEncodingTable, and use its offset in the 32-bit table instead.
 464     LongEncodingTable.add(TypeSig);
 465
 466     // This is a placehold that we'll replace after the table is laid out.
 467     FixedEncodings.push_back(~0U);
 468   }
 469
 470   LongEncodingTable.layout();
 471
 472   OS << "// Global intrinsic function declaration type table.\n";
 473   OS << "#ifdef GET_INTRINSIC_GENERATOR_GLOBAL\n";
 474
 475   OS << "static const unsigned IIT_Table[] = {\n  ";
 476
 477   for (unsigned i = 0, e = FixedEncodings.size(); i != e; ++i) {
 478     if ((i & 7) == 7)
 479       OS << "\n  ";
 480
 481     // If the entry fit in the table, just emit it.
 482     if (FixedEncodings[i] != ~0U) {
 483       OS << "0x" << utohexstr(FixedEncodings[i]) << ", ";
 484       continue;
 485     }
 486
 487     TypeSig.clear();
 488     ComputeFixedEncoding(Ints[i], TypeSig);
 489
 490
 491     // Otherwise, emit the offset into the long encoding table.  We emit it this
 492     // way so that it is easier to read the offset in the .def file.
 493     OS << "(1U<<31) | " << LongEncodingTable.get(TypeSig) << ", ";
 494   }
 495
 496   OS << "0\n};\n\n";
 497
 498   // Emit the shared table of register lists.
 499   OS << "static const unsigned char IIT_LongEncodingTable[] = {\n";
 500   if (!LongEncodingTable.empty())
 501     LongEncodingTable.emit(OS, printIITEntry);
 502   OS << "  255\n};\n\n";
 503
 504   OS << "#endif\n\n";  // End of GET_INTRINSIC_GENERATOR_GLOBAL
 505 }
 506
 507 namespace {
 508 struct AttributeComparator {
 509   bool operator()(const CodeGenIntrinsic *L, const CodeGenIntrinsic *R) const {
 510     // Sort throwing intrinsics after non-throwing intrinsics.
 511     if (L->canThrow != R->canThrow)
 512       return R->canThrow;
 513
 514     if (L->isNoDuplicate != R->isNoDuplicate)
 515       return R->isNoDuplicate;
 516
 517     if (L->isNoReturn != R->isNoReturn)
 518       return R->isNoReturn;
 519
 520     if (L->isConvergent != R->isConvergent)
 521       return R->isConvergent;
 522
 523     // Try to order by readonly/readnone attribute.
 524     CodeGenIntrinsic::ModRefKind LK = L->ModRef;
 525     CodeGenIntrinsic::ModRefKind RK = R->ModRef;
 526     if (LK != RK) return (LK > RK);
 527
 528     // Order by argument attributes.
 529     // This is reliable because each side is already sorted internally.
 530     return (L->ArgumentAttributes < R->ArgumentAttributes);
 531   }
 532 };
 533 } // End anonymous namespace
 534
 535 /// EmitAttributes - This emits the Intrinsic::getAttributes method.
 536 void IntrinsicEmitter::
 537 EmitAttributes(const std::vector<CodeGenIntrinsic> &Ints, raw_ostream &OS) {
 538   OS << "// Add parameter attributes that are not common to all intrinsics.\n";
 539   OS << "#ifdef GET_INTRINSIC_ATTRIBUTES\n";
 540   if (TargetOnly)
 541     OS << "static AttributeSet getAttributes(LLVMContext &C, " << TargetPrefix
 542        << "Intrinsic::ID id) {\n";
 543   else
 544     OS << "AttributeSet Intrinsic::getAttributes(LLVMContext &C, ID id) {\n";
 545
 546   // Compute the maximum number of attribute arguments and the map
 547   typedef std::map<const CodeGenIntrinsic*, unsigned,
 548                    AttributeComparator> UniqAttrMapTy;
 549   UniqAttrMapTy UniqAttributes;
 550   unsigned maxArgAttrs = 0;
 551   unsigned AttrNum = 0;
 552   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 553     const CodeGenIntrinsic &intrinsic = Ints[i];
 554     maxArgAttrs =
 555       std::max(maxArgAttrs, unsigned(intrinsic.ArgumentAttributes.size()));
 556     unsigned &N = UniqAttributes[&intrinsic];
 557     if (N) continue;
 558     assert(AttrNum < 256 && "Too many unique attributes for table!");
 559     N = ++AttrNum;
 560   }
 561
 562   // Emit an array of AttributeSet.  Most intrinsics will have at least one
 563   // entry, for the function itself (index ~1), which is usually nounwind.
 564   OS << "  static const uint8_t IntrinsicsToAttributesMap[] = {\n";
 565
 566   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 567     const CodeGenIntrinsic &intrinsic = Ints[i];
 568
 569     OS << "    " << UniqAttributes[&intrinsic] << ", // "
 570        << intrinsic.Name << "\n";
 571   }
 572   OS << "  };\n\n";
 573
 574   OS << "  AttributeSet AS[" << maxArgAttrs+1 << "];\n";
 575   OS << "  unsigned NumAttrs = 0;\n";
 576   OS << "  if (id != 0) {\n";
 577   OS << "    switch(IntrinsicsToAttributesMap[id - ";
 578   if (TargetOnly)
 579     OS << "Intrinsic::num_intrinsics";
 580   else
 581     OS << "1";
 582   OS << "]) {\n";
 583   OS << "    default: llvm_unreachable(\"Invalid attribute number\");\n";
 584   for (UniqAttrMapTy::const_iterator I = UniqAttributes.begin(),
 585        E = UniqAttributes.end(); I != E; ++I) {
 586     OS << "    case " << I->second << ": {\n";
 587
 588     const CodeGenIntrinsic &intrinsic = *(I->first);
 589
 590     // Keep track of the number of attributes we're writing out.
 591     unsigned numAttrs = 0;
 592
 593     // The argument attributes are alreadys sorted by argument index.
 594     unsigned ai = 0, ae = intrinsic.ArgumentAttributes.size();
 595     if (ae) {
 596       while (ai != ae) {
 597         unsigned argNo = intrinsic.ArgumentAttributes[ai].first;
 598
 599         OS <<  "      const Attribute::AttrKind AttrParam" << argNo + 1 <<"[]= {";
 600         bool addComma = false;
 601
 602         do {
 603           switch (intrinsic.ArgumentAttributes[ai].second) {
 604           case CodeGenIntrinsic::NoCapture:
 605             if (addComma)
 606               OS << ",";
 607             OS << "Attribute::NoCapture";
 608             addComma = true;
 609             break;
 610           case CodeGenIntrinsic::ReadOnly:
 611             if (addComma)
 612               OS << ",";
 613             OS << "Attribute::ReadOnly";
 614             addComma = true;
 615             break;
 616           case CodeGenIntrinsic::ReadNone:
 617             if (addComma)
 618               OS << ",";
 619             OS << "Attribute::ReadNone";
 620             addComma = true;
 621             break;
 622           }
 623
 624           ++ai;
 625         } while (ai != ae && intrinsic.ArgumentAttributes[ai].first == argNo);
 626         OS << "};\n";
 627         OS << "      AS[" << numAttrs++ << "] = AttributeSet::get(C, "
 628            << argNo+1 << ", AttrParam" << argNo +1 << ");\n";
 629       }
 630     }
 631
 632     if (!intrinsic.canThrow ||
 633         intrinsic.ModRef != CodeGenIntrinsic::ReadWriteMem ||
 634         intrinsic.isNoReturn || intrinsic.isNoDuplicate ||
 635         intrinsic.isConvergent) {
 636       OS << "      const Attribute::AttrKind Atts[] = {";
 637       bool addComma = false;
 638       if (!intrinsic.canThrow) {
 639         OS << "Attribute::NoUnwind";
 640         addComma = true;
 641       }
 642       if (intrinsic.isNoReturn) {
 643         if (addComma)
 644           OS << ",";
 645         OS << "Attribute::NoReturn";
 646         addComma = true;
 647       }
 648       if (intrinsic.isNoDuplicate) {
 649         if (addComma)
 650           OS << ",";
 651         OS << "Attribute::NoDuplicate";
 652         addComma = true;
 653       }
 654       if (intrinsic.isConvergent) {
 655         if (addComma)
 656           OS << ",";
 657         OS << "Attribute::Convergent";
 658         addComma = true;
 659       }
 660
 661       switch (intrinsic.ModRef) {
 662       case CodeGenIntrinsic::NoMem:
 663         if (addComma)
 664           OS << ",";
 665         OS << "Attribute::ReadNone";
 666         break;
 667       case CodeGenIntrinsic::ReadArgMem:
 668         if (addComma)
 669           OS << ",";
 670         OS << "Attribute::ReadOnly,";
 671         OS << "Attribute::ArgMemOnly";
 672         break;
 673       case CodeGenIntrinsic::ReadMem:
 674         if (addComma)
 675           OS << ",";
 676         OS << "Attribute::ReadOnly";
 677         break;
 678       case CodeGenIntrinsic::ReadWriteArgMem:
 679         if (addComma)
 680           OS << ",";
 681         OS << "Attribute::ArgMemOnly";
 682         break;
 683       case CodeGenIntrinsic::ReadWriteMem:
 684         break;
 685       }
 686       OS << "};\n";
 687       OS << "      AS[" << numAttrs++ << "] = AttributeSet::get(C, "
 688          << "AttributeSet::FunctionIndex, Atts);\n";
 689     }
 690
 691     if (numAttrs) {
 692       OS << "      NumAttrs = " << numAttrs << ";\n";
 693       OS << "      break;\n";
 694       OS << "      }\n";
 695     } else {
 696       OS << "      return AttributeSet();\n";
 697       OS << "      }\n";
 698     }
 699   }
 700
 701   OS << "    }\n";
 702   OS << "  }\n";
 703   OS << "  return AttributeSet::get(C, makeArrayRef(AS, NumAttrs));\n";
 704   OS << "}\n";
 705   OS << "#endif // GET_INTRINSIC_ATTRIBUTES\n\n";
 706 }
 707
 708 /// EmitModRefBehavior - Determine intrinsic alias analysis mod/ref behavior.
 709 void IntrinsicEmitter::
 710 EmitModRefBehavior(const std::vector<CodeGenIntrinsic> &Ints, raw_ostream &OS){
 711   OS << "// Determine intrinsic alias analysis mod/ref behavior.\n"
 712      << "#ifdef GET_INTRINSIC_MODREF_BEHAVIOR\n"
 713      << "assert(iid <= Intrinsic::" << Ints.back().EnumName << " && "
 714      << "\"Unknown intrinsic.\");\n\n";
 715
 716   OS << "static const uint8_t IntrinsicModRefBehavior[] = {\n"
 717      << "  /* invalid */ FMRB_UnknownModRefBehavior,\n";
 718   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 719     OS << "  /* " << TargetPrefix << Ints[i].EnumName << " */ ";
 720     switch (Ints[i].ModRef) {
 721     case CodeGenIntrinsic::NoMem:
 722       OS << "FMRB_DoesNotAccessMemory,\n";
 723       break;
 724     case CodeGenIntrinsic::ReadArgMem:
 725       OS << "FMRB_OnlyReadsArgumentPointees,\n";
 726       break;
 727     case CodeGenIntrinsic::ReadMem:
 728       OS << "FMRB_OnlyReadsMemory,\n";
 729       break;
 730     case CodeGenIntrinsic::ReadWriteArgMem:
 731       OS << "FMRB_OnlyAccessesArgumentPointees,\n";
 732       break;
 733     case CodeGenIntrinsic::ReadWriteMem:
 734       OS << "FMRB_UnknownModRefBehavior,\n";
 735       break;
 736     }
 737   }
 738   OS << "};\n\n"
 739      << "return "
 740         "static_cast<FunctionModRefBehavior>(IntrinsicModRefBehavior[iid]);\n"
 741      << "#endif // GET_INTRINSIC_MODREF_BEHAVIOR\n\n";
 742 }
 743
 744 /// EmitTargetBuiltins - All of the builtins in the specified map are for the
 745 /// same target, and we already checked it.
 746 static void EmitTargetBuiltins(const std::map<std::string, std::string> &BIM,
 747                                const std::string &TargetPrefix,
 748                                raw_ostream &OS) {
 749
 750   std::vector<StringMatcher::StringPair> Results;
 751
 752   for (std::map<std::string, std::string>::const_iterator I = BIM.begin(),
 753        E = BIM.end(); I != E; ++I) {
 754     std::string ResultCode =
 755     "return " + TargetPrefix + "Intrinsic::" + I->second + ";";
 756     Results.emplace_back(I->first, ResultCode);
 757   }
 758
 759   StringMatcher("BuiltinName", Results, OS).Emit();
 760 }
 761
 762
 763 void IntrinsicEmitter::
 764 EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
 765                              raw_ostream &OS) {
 766   typedef std::map<std::string, std::map<std::string, std::string> > BIMTy;
 767   BIMTy BuiltinMap;
 768   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 769     if (!Ints[i].GCCBuiltinName.empty()) {
 770       // Get the map for this target prefix.
 771       std::map<std::string, std::string> &BIM =BuiltinMap[Ints[i].TargetPrefix];
 772
 773       if (!BIM.insert(std::make_pair(Ints[i].GCCBuiltinName,
 774                                      Ints[i].EnumName)).second)
 775         PrintFatalError("Intrinsic '" + Ints[i].TheDef->getName() +
 776               "': duplicate GCC builtin name!");
 777     }
 778   }
 779
 780   OS << "// Get the LLVM intrinsic that corresponds to a GCC builtin.\n";
 781   OS << "// This is used by the C front-end.  The GCC builtin name is passed\n";
 782   OS << "// in as BuiltinName, and a target prefix (e.g. 'ppc') is passed\n";
 783   OS << "// in as TargetPrefix.  The result is assigned to 'IntrinsicID'.\n";
 784   OS << "#ifdef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN\n";
 785
 786   if (TargetOnly) {
 787     OS << "static " << TargetPrefix << "Intrinsic::ID "
 788        << "getIntrinsicForGCCBuiltin(const char "
 789        << "*TargetPrefixStr, const char *BuiltinNameStr) {\n";
 790   } else {
 791     OS << "Intrinsic::ID Intrinsic::getIntrinsicForGCCBuiltin(const char "
 792        << "*TargetPrefixStr, const char *BuiltinNameStr) {\n";
 793   }
 794
 795   OS << "  StringRef BuiltinName(BuiltinNameStr);\n";
 796   OS << "  StringRef TargetPrefix(TargetPrefixStr);\n\n";
 797
 798   // Note: this could emit significantly better code if we cared.
 799   for (BIMTy::iterator I = BuiltinMap.begin(), E = BuiltinMap.end();I != E;++I){
 800     OS << "  ";
 801     if (!I->first.empty())
 802       OS << "if (TargetPrefix == \"" << I->first << "\") ";
 803     else
 804       OS << "/* Target Independent Builtins */ ";
 805     OS << "{\n";
 806
 807     // Emit the comparisons for this target prefix.
 808     EmitTargetBuiltins(I->second, TargetPrefix, OS);
 809     OS << "  }\n";
 810   }
 811   OS << "  return ";
 812   if (!TargetPrefix.empty())
 813     OS << "(" << TargetPrefix << "Intrinsic::ID)";
 814   OS << "Intrinsic::not_intrinsic;\n";
 815   OS << "}\n";
 816   OS << "#endif\n\n";
 817 }
 818
 819 void IntrinsicEmitter::
 820 EmitIntrinsicToMSBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
 821                             raw_ostream &OS) {
 822   std::map<std::string, std::map<std::string, std::string>> TargetBuiltins;
 823
 824   for (const auto &Intrinsic : Ints) {
 825     if (Intrinsic.MSBuiltinName.empty())
 826       continue;
 827
 828     auto &Builtins = TargetBuiltins[Intrinsic.TargetPrefix];
 829     if (!Builtins.insert(std::make_pair(Intrinsic.MSBuiltinName,
 830                                         Intrinsic.EnumName)).second)
 831       PrintFatalError("Intrinsic '" + Intrinsic.TheDef->getName() + "': "
 832                       "duplicate MS builtin name!");
 833   }
 834
 835   OS << "// Get the LLVM intrinsic that corresponds to a MS builtin.\n"
 836         "// This is used by the C front-end.  The MS builtin name is passed\n"
 837         "// in as a BuiltinName, and a target prefix (e.g. 'arm') is passed\n"
 838         "// in as a TargetPrefix.  The result is assigned to 'IntrinsicID'.\n"
 839         "#ifdef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN\n";
 840
 841   OS << (TargetOnly ? "static " + TargetPrefix : "") << "Intrinsic::ID "
 842      << (TargetOnly ? "" : "Intrinsic::")
 843      << "getIntrinsicForMSBuiltin(const char *TP, const char *BN) {\n";
 844   OS << "  StringRef BuiltinName(BN);\n"
 845         "  StringRef TargetPrefix(TP);\n"
 846         "\n";
 847
 848   for (const auto &Builtins : TargetBuiltins) {
 849     OS << "  ";
 850     if (Builtins.first.empty())
 851       OS << "/* Target Independent Builtins */ ";
 852     else
 853       OS << "if (TargetPrefix == \"" << Builtins.first << "\") ";
 854     OS << "{\n";
 855     EmitTargetBuiltins(Builtins.second, TargetPrefix, OS);
 856     OS << "}";
 857   }
 858
 859   OS << "  return ";
 860   if (!TargetPrefix.empty())
 861     OS << "(" << TargetPrefix << "Intrinsic::ID)";
 862   OS << "Intrinsic::not_intrinsic;\n";
 863   OS << "}\n";
 864
 865   OS << "#endif\n\n";
 866 }
 867
 868 void llvm::EmitIntrinsics(RecordKeeper &RK, raw_ostream &OS, bool TargetOnly) {
 869   IntrinsicEmitter(RK, TargetOnly).run(OS);
 870 }