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 "CodeGenTarget.h"
  15 #include "IntrinsicEmitter.h"
  16 #include "Record.h"
  17 #include "llvm/ADT/StringExtras.h"
  18 #include <algorithm>
  19 using namespace llvm;
  20
  21 //===----------------------------------------------------------------------===//
  22 // IntrinsicEmitter Implementation
  23 //===----------------------------------------------------------------------===//
  24
  25 void IntrinsicEmitter::run(std::ostream &OS) {
  26   EmitSourceFileHeader("Intrinsic Function Source Fragment", OS);
  27
  28   std::vector<CodeGenIntrinsic> Ints = LoadIntrinsics(Records);
  29
  30   // Emit the enum information.
  31   EmitEnumInfo(Ints, OS);
  32
  33   // Emit the intrinsic ID -> name table.
  34   EmitIntrinsicToNameTable(Ints, OS);
  35
  36   // Emit the function name recognizer.
  37   EmitFnNameRecognizer(Ints, OS);
  38
  39   // Emit the intrinsic verifier.
  40   EmitVerifier(Ints, OS);
  41
  42   // Emit the intrinsic declaration generator.
  43   EmitGenerator(Ints, OS);
  44
  45   // Emit the intrinsic parameter attributes.
  46   EmitAttributes(Ints, OS);
  47
  48   // Emit a list of intrinsics with corresponding GCC builtins.
  49   EmitGCCBuiltinList(Ints, OS);
  50
  51   // Emit code to translate GCC builtins into LLVM intrinsics.
  52   EmitIntrinsicToGCCBuiltinMap(Ints, OS);
  53 }
  54
  55 void IntrinsicEmitter::EmitEnumInfo(const std::vector<CodeGenIntrinsic> &Ints,
  56                                     std::ostream &OS) {
  57   OS << "// Enum values for Intrinsics.h\n";
  58   OS << "#ifdef GET_INTRINSIC_ENUM_VALUES\n";
  59   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
  60     OS << "    " << Ints[i].EnumName;
  61     OS << ((i != e-1) ? ", " : "  ");
  62     OS << std::string(40-Ints[i].EnumName.size(), ' ')
  63       << "// " << Ints[i].Name << "\n";
  64   }
  65   OS << "#endif\n\n";
  66 }
  67
  68 void IntrinsicEmitter::
  69 EmitFnNameRecognizer(const std::vector<CodeGenIntrinsic> &Ints,
  70                      std::ostream &OS) {
  71   // Build a function name -> intrinsic name mapping.
  72   std::map<std::string, unsigned> IntMapping;
  73   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
  74     IntMapping[Ints[i].Name] = i;
  75
  76   OS << "// Function name -> enum value recognizer code.\n";
  77   OS << "#ifdef GET_FUNCTION_RECOGNIZER\n";
  78   OS << "  switch (Name[5]) {\n";
  79   OS << "  default:\n";
  80   // Emit the intrinsics in sorted order.
  81   char LastChar = 0;
  82   for (std::map<std::string, unsigned>::iterator I = IntMapping.begin(),
  83        E = IntMapping.end(); I != E; ++I) {
  84     if (I->first[5] != LastChar) {
  85       LastChar = I->first[5];
  86       OS << "    break;\n";
  87       OS << "  case '" << LastChar << "':\n";
  88     }
  89
  90     // For overloaded intrinsics, only the prefix needs to match
  91     if (Ints[I->second].isOverloaded)
  92       OS << "    if (Len > " << I->first.size()
  93        << " && !memcmp(Name, \"" << I->first << ".\", "
  94        << (I->first.size() + 1) << ")) return Intrinsic::"
  95        << Ints[I->second].EnumName << ";\n";
  96     else
  97       OS << "    if (Len == " << I->first.size()
  98          << " && !memcmp(Name, \"" << I->first << "\", "
  99          << I->first.size() << ")) return Intrinsic::"
 100          << Ints[I->second].EnumName << ";\n";
 101   }
 102   OS << "  }\n";
 103   OS << "#endif\n\n";
 104 }
 105
 106 void IntrinsicEmitter::
 107 EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
 108                          std::ostream &OS) {
 109   OS << "// Intrinsic ID to name table\n";
 110   OS << "#ifdef GET_INTRINSIC_NAME_TABLE\n";
 111   OS << "  // Note that entry #0 is the invalid intrinsic!\n";
 112   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 113     OS << "  \"" << Ints[i].Name << "\",\n";
 114   OS << "#endif\n\n";
 115 }
 116
 117 static void EmitTypeForValueType(std::ostream &OS, MVT::SimpleValueType VT) {
 118   if (MVT(VT).isInteger()) {
 119     unsigned BitWidth = MVT(VT).getSizeInBits();
 120     OS << "IntegerType::get(" << BitWidth << ")";
 121   } else if (VT == MVT::Other) {
 122     // MVT::OtherVT is used to mean the empty struct type here.
 123     OS << "StructType::get(std::vector<const Type *>())";
 124   } else if (VT == MVT::f32) {
 125     OS << "Type::FloatTy";
 126   } else if (VT == MVT::f64) {
 127     OS << "Type::DoubleTy";
 128   } else if (VT == MVT::f80) {
 129     OS << "Type::X86_FP80Ty";
 130   } else if (VT == MVT::f128) {
 131     OS << "Type::FP128Ty";
 132   } else if (VT == MVT::ppcf128) {
 133     OS << "Type::PPC_FP128Ty";
 134   } else if (VT == MVT::isVoid) {
 135     OS << "Type::VoidTy";
 136   } else {
 137     assert(false && "Unsupported ValueType!");
 138   }
 139 }
 140
 141 static void EmitTypeGenerate(std::ostream &OS, Record *ArgType,
 142                              unsigned &ArgNo) {
 143   MVT::SimpleValueType VT = getValueType(ArgType->getValueAsDef("VT"));
 144
 145   if (ArgType->isSubClassOf("LLVMMatchType")) {
 146     unsigned Number = ArgType->getValueAsInt("Number");
 147     assert(Number < ArgNo && "Invalid matching number!");
 148     OS << "Tys[" << Number << "]";
 149   } else if (VT == MVT::iAny || VT == MVT::fAny) {
 150     // NOTE: The ArgNo variable here is not the absolute argument number, it is
 151     // the index of the "arbitrary" type in the Tys array passed to the
 152     // Intrinsic::getDeclaration function. Consequently, we only want to
 153     // increment it when we actually hit an overloaded type. Getting this wrong
 154     // leads to very subtle bugs!
 155     OS << "Tys[" << ArgNo++ << "]";
 156   } else if (MVT(VT).isVector()) {
 157     MVT VVT = VT;
 158     OS << "VectorType::get(";
 159     EmitTypeForValueType(OS, VVT.getVectorElementType().getSimpleVT());
 160     OS << ", " << VVT.getVectorNumElements() << ")";
 161   } else if (VT == MVT::iPTR) {
 162     OS << "PointerType::getUnqual(";
 163     EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"), ArgNo);
 164     OS << ")";
 165   } else if (VT == MVT::iPTRAny) {
 166     // Make sure the user has passed us an argument type to overload. If not,
 167     // treat it as an ordinary (not overloaded) intrinsic.
 168     OS << "(" << ArgNo << " < numTys) ? Tys[" << ArgNo
 169     << "] : PointerType::getUnqual(";
 170     EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"), ArgNo);
 171     OS << ")";
 172     ++ArgNo;
 173   } else if (VT == MVT::isVoid) {
 174     if (ArgNo == 0)
 175       OS << "Type::VoidTy";
 176     else
 177       // MVT::isVoid is used to mean varargs here.
 178       OS << "...";
 179   } else {
 180     EmitTypeForValueType(OS, VT);
 181   }
 182 }
 183
 184 /// RecordListComparator - Provide a determinstic comparator for lists of
 185 /// records.
 186 namespace {
 187   struct RecordListComparator {
 188     bool operator()(const std::vector<Record*> &LHS,
 189                     const std::vector<Record*> &RHS) const {
 190       unsigned i = 0;
 191       do {
 192         if (i == RHS.size()) return false;  // RHS is shorter than LHS.
 193         if (LHS[i] != RHS[i])
 194           return LHS[i]->getName() < RHS[i]->getName();
 195       } while (++i != LHS.size());
 196
 197       return i != RHS.size();
 198     }
 199   };
 200 }
 201
 202 void IntrinsicEmitter::EmitVerifier(const std::vector<CodeGenIntrinsic> &Ints,
 203                                     std::ostream &OS) {
 204   OS << "// Verifier::visitIntrinsicFunctionCall code.\n";
 205   OS << "#ifdef GET_INTRINSIC_VERIFIER\n";
 206   OS << "  switch (ID) {\n";
 207   OS << "  default: assert(0 && \"Invalid intrinsic!\");\n";
 208
 209   // This checking can emit a lot of very common code.  To reduce the amount of
 210   // code that we emit, batch up cases that have identical types.  This avoids
 211   // problems where GCC can run out of memory compiling Verifier.cpp.
 212   typedef std::map<std::vector<Record*>, std::vector<unsigned>,
 213     RecordListComparator> MapTy;
 214   MapTy UniqueArgInfos;
 215
 216   // Compute the unique argument type info.
 217   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 218     UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
 219
 220   // Loop through the array, emitting one comparison for each batch.
 221   for (MapTy::iterator I = UniqueArgInfos.begin(),
 222        E = UniqueArgInfos.end(); I != E; ++I) {
 223     for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
 224       OS << "  case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
 225          << Ints[I->second[i]].Name << "\n";
 226     }
 227
 228     const std::vector<Record*> &ArgTypes = I->first;
 229     OS << "    VerifyIntrinsicPrototype(ID, IF, " << ArgTypes.size() << ", ";
 230     for (unsigned j = 0; j != ArgTypes.size(); ++j) {
 231       Record *ArgType = ArgTypes[j];
 232       if (ArgType->isSubClassOf("LLVMMatchType")) {
 233         unsigned Number = ArgType->getValueAsInt("Number");
 234         assert(Number < j && "Invalid matching number!");
 235         OS << "~" << Number;
 236       } else {
 237         MVT::SimpleValueType VT = getValueType(ArgType->getValueAsDef("VT"));
 238         OS << getEnumName(VT);
 239         if (VT == MVT::isVoid && j != 0 && j != ArgTypes.size()-1)
 240           throw "Var arg type not last argument";
 241       }
 242       if (j != ArgTypes.size()-1)
 243         OS << ", ";
 244     }
 245
 246     OS << ");\n";
 247     OS << "    break;\n";
 248   }
 249   OS << "  }\n";
 250   OS << "#endif\n\n";
 251 }
 252
 253 void IntrinsicEmitter::EmitGenerator(const std::vector<CodeGenIntrinsic> &Ints,
 254                                      std::ostream &OS) {
 255   OS << "// Code for generating Intrinsic function declarations.\n";
 256   OS << "#ifdef GET_INTRINSIC_GENERATOR\n";
 257   OS << "  switch (id) {\n";
 258   OS << "  default: assert(0 && \"Invalid intrinsic!\");\n";
 259
 260   // Similar to GET_INTRINSIC_VERIFIER, batch up cases that have identical
 261   // types.
 262   typedef std::map<std::vector<Record*>, std::vector<unsigned>,
 263     RecordListComparator> MapTy;
 264   MapTy UniqueArgInfos;
 265
 266   // Compute the unique argument type info.
 267   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 268     UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
 269
 270   // Loop through the array, emitting one generator for each batch.
 271   for (MapTy::iterator I = UniqueArgInfos.begin(),
 272        E = UniqueArgInfos.end(); I != E; ++I) {
 273     for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
 274       OS << "  case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
 275          << Ints[I->second[i]].Name << "\n";
 276     }
 277
 278     const std::vector<Record*> &ArgTypes = I->first;
 279     unsigned N = ArgTypes.size();
 280
 281     if (N > 1 &&
 282         getValueType(ArgTypes[N-1]->getValueAsDef("VT")) == MVT::isVoid) {
 283       OS << "    IsVarArg = true;\n";
 284       --N;
 285     }
 286
 287     unsigned ArgNo = 0;
 288     OS << "    ResultTy = ";
 289     EmitTypeGenerate(OS, ArgTypes[0], ArgNo);
 290     OS << ";\n";
 291
 292     for (unsigned j = 1; j != N; ++j) {
 293       OS << "    ArgTys.push_back(";
 294       EmitTypeGenerate(OS, ArgTypes[j], ArgNo);
 295       OS << ");\n";
 296     }
 297     OS << "    break;\n";
 298   }
 299   OS << "  }\n";
 300   OS << "#endif\n\n";
 301 }
 302
 303 void IntrinsicEmitter::
 304 EmitAttributes(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS) {
 305   OS << "// Add parameter attributes that are not common to all intrinsics.\n";
 306   OS << "#ifdef GET_INTRINSIC_ATTRIBUTES\n";
 307   OS << "  switch (id) {\n";
 308   OS << "  default: break;\n";
 309   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 310     switch (Ints[i].ModRef) {
 311     default: break;
 312     case CodeGenIntrinsic::NoMem:
 313       OS << "  case Intrinsic::" << Ints[i].EnumName << ":\n";
 314       break;
 315     }
 316   }
 317   OS << "    Attr |= Attribute::ReadNone; // These do not access memory.\n";
 318   OS << "    break;\n";
 319   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 320     switch (Ints[i].ModRef) {
 321     default: break;
 322     case CodeGenIntrinsic::ReadArgMem:
 323     case CodeGenIntrinsic::ReadMem:
 324       OS << "  case Intrinsic::" << Ints[i].EnumName << ":\n";
 325       break;
 326     }
 327   }
 328   OS << "    Attr |= Attribute::ReadOnly; // These do not write memory.\n";
 329   OS << "    break;\n";
 330   OS << "  }\n";
 331   OS << "#endif\n\n";
 332 }
 333
 334 void IntrinsicEmitter::
 335 EmitGCCBuiltinList(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
 336   OS << "// Get the GCC builtin that corresponds to an LLVM intrinsic.\n";
 337   OS << "#ifdef GET_GCC_BUILTIN_NAME\n";
 338   OS << "  switch (F->getIntrinsicID()) {\n";
 339   OS << "  default: BuiltinName = \"\"; break;\n";
 340   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 341     if (!Ints[i].GCCBuiltinName.empty()) {
 342       OS << "  case Intrinsic::" << Ints[i].EnumName << ": BuiltinName = \""
 343          << Ints[i].GCCBuiltinName << "\"; break;\n";
 344     }
 345   }
 346   OS << "  }\n";
 347   OS << "#endif\n\n";
 348 }
 349
 350 /// EmitBuiltinComparisons - Emit comparisons to determine whether the specified
 351 /// sorted range of builtin names is equal to the current builtin.  This breaks
 352 /// it down into a simple tree.
 353 ///
 354 /// At this point, we know that all the builtins in the range have the same name
 355 /// for the first 'CharStart' characters.  Only the end of the name needs to be
 356 /// discriminated.
 357 typedef std::map<std::string, std::string>::const_iterator StrMapIterator;
 358 static void EmitBuiltinComparisons(StrMapIterator Start, StrMapIterator End,
 359                                    unsigned CharStart, unsigned Indent,
 360                                    std::ostream &OS) {
 361   if (Start == End) return; // empty range.
 362
 363   // Determine what, if anything, is the same about all these strings.
 364   std::string CommonString = Start->first;
 365   unsigned NumInRange = 0;
 366   for (StrMapIterator I = Start; I != End; ++I, ++NumInRange) {
 367     // Find the first character that doesn't match.
 368     const std::string &ThisStr = I->first;
 369     unsigned NonMatchChar = CharStart;
 370     while (NonMatchChar < CommonString.size() &&
 371            NonMatchChar < ThisStr.size() &&
 372            CommonString[NonMatchChar] == ThisStr[NonMatchChar])
 373       ++NonMatchChar;
 374     // Truncate off pieces that don't match.
 375     CommonString.resize(NonMatchChar);
 376   }
 377
 378   // Just compare the rest of the string.
 379   if (NumInRange == 1) {
 380     if (CharStart != CommonString.size()) {
 381       OS << std::string(Indent*2, ' ') << "if (!memcmp(BuiltinName";
 382       if (CharStart) OS << "+" << CharStart;
 383       OS << ", \"" << (CommonString.c_str()+CharStart) << "\", ";
 384       OS << CommonString.size() - CharStart << "))\n";
 385       ++Indent;
 386     }
 387     OS << std::string(Indent*2, ' ') << "IntrinsicID = Intrinsic::";
 388     OS << Start->second << ";\n";
 389     return;
 390   }
 391
 392   // At this point, we potentially have a common prefix for these builtins, emit
 393   // a check for this common prefix.
 394   if (CommonString.size() != CharStart) {
 395     OS << std::string(Indent*2, ' ') << "if (!memcmp(BuiltinName";
 396     if (CharStart) OS << "+" << CharStart;
 397     OS << ", \"" << (CommonString.c_str()+CharStart) << "\", ";
 398     OS << CommonString.size()-CharStart << ")) {\n";
 399
 400     EmitBuiltinComparisons(Start, End, CommonString.size(), Indent+1, OS);
 401     OS << std::string(Indent*2, ' ') << "}\n";
 402     return;
 403   }
 404
 405   // Output a switch on the character that differs across the set.
 406   OS << std::string(Indent*2, ' ') << "switch (BuiltinName[" << CharStart
 407       << "]) {";
 408   if (CharStart)
 409     OS << "  // \"" << std::string(Start->first.begin(),
 410                                    Start->first.begin()+CharStart) << "\"";
 411   OS << "\n";
 412
 413   for (StrMapIterator I = Start; I != End; ) {
 414     char ThisChar = I->first[CharStart];
 415     OS << std::string(Indent*2, ' ') << "case '" << ThisChar << "':\n";
 416     // Figure out the range that has this common character.
 417     StrMapIterator NextChar = I;
 418     for (++NextChar; NextChar != End && NextChar->first[CharStart] == ThisChar;
 419          ++NextChar)
 420       /*empty*/;
 421     EmitBuiltinComparisons(I, NextChar, CharStart+1, Indent+1, OS);
 422     OS << std::string(Indent*2, ' ') << "  break;\n";
 423     I = NextChar;
 424   }
 425   OS << std::string(Indent*2, ' ') << "}\n";
 426 }
 427
 428 /// EmitTargetBuiltins - All of the builtins in the specified map are for the
 429 /// same target, and we already checked it.
 430 static void EmitTargetBuiltins(const std::map<std::string, std::string> &BIM,
 431                                std::ostream &OS) {
 432   // Rearrange the builtins by length.
 433   std::vector<std::map<std::string, std::string> > BuiltinsByLen;
 434   BuiltinsByLen.reserve(100);
 435
 436   for (StrMapIterator I = BIM.begin(), E = BIM.end(); I != E; ++I) {
 437     if (I->first.size() >= BuiltinsByLen.size())
 438       BuiltinsByLen.resize(I->first.size()+1);
 439     BuiltinsByLen[I->first.size()].insert(*I);
 440   }
 441
 442   // Now that we have all the builtins by their length, emit a switch stmt.
 443   OS << "    switch (strlen(BuiltinName)) {\n";
 444   OS << "    default: break;\n";
 445   for (unsigned i = 0, e = BuiltinsByLen.size(); i != e; ++i) {
 446     if (BuiltinsByLen[i].empty()) continue;
 447     OS << "    case " << i << ":\n";
 448     EmitBuiltinComparisons(BuiltinsByLen[i].begin(), BuiltinsByLen[i].end(),
 449                            0, 3, OS);
 450     OS << "      break;\n";
 451   }
 452   OS << "    }\n";
 453 }
 454
 455
 456 void IntrinsicEmitter::
 457 EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
 458                              std::ostream &OS) {
 459   typedef std::map<std::string, std::map<std::string, std::string> > BIMTy;
 460   BIMTy BuiltinMap;
 461   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 462     if (!Ints[i].GCCBuiltinName.empty()) {
 463       // Get the map for this target prefix.
 464       std::map<std::string, std::string> &BIM =BuiltinMap[Ints[i].TargetPrefix];
 465
 466       if (!BIM.insert(std::make_pair(Ints[i].GCCBuiltinName,
 467                                      Ints[i].EnumName)).second)
 468         throw "Intrinsic '" + Ints[i].TheDef->getName() +
 469               "': duplicate GCC builtin name!";
 470     }
 471   }
 472
 473   OS << "// Get the LLVM intrinsic that corresponds to a GCC builtin.\n";
 474   OS << "// This is used by the C front-end.  The GCC builtin name is passed\n";
 475   OS << "// in as BuiltinName, and a target prefix (e.g. 'ppc') is passed\n";
 476   OS << "// in as TargetPrefix.  The result is assigned to 'IntrinsicID'.\n";
 477   OS << "#ifdef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN\n";
 478   OS << "  IntrinsicID = Intrinsic::not_intrinsic;\n";
 479
 480   // Note: this could emit significantly better code if we cared.
 481   for (BIMTy::iterator I = BuiltinMap.begin(), E = BuiltinMap.end();I != E;++I){
 482     OS << "  ";
 483     if (!I->first.empty())
 484       OS << "if (!strcmp(TargetPrefix, \"" << I->first << "\")) ";
 485     else
 486       OS << "/* Target Independent Builtins */ ";
 487     OS << "{\n";
 488
 489     // Emit the comparisons for this target prefix.
 490     EmitTargetBuiltins(I->second, OS);
 491     OS << "  }\n";
 492   }
 493   OS << "#endif\n\n";
 494 }