utils/TableGen/IntrinsicEmitter.cpp

   1 //===- IntrinsicEmitter.cpp - Generate intrinsic information --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tablegen backend emits information about intrinsic functions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "IntrinsicEmitter.h"
  15 #include "Record.h"
  16 #include "llvm/ADT/StringExtras.h"
  17 #include <algorithm>
  18 using namespace llvm;
  19
  20 //===----------------------------------------------------------------------===//
  21 // IntrinsicEmitter Implementation
  22 //===----------------------------------------------------------------------===//
  23
  24 void IntrinsicEmitter::run(std::ostream &OS) {
  25   EmitSourceFileHeader("Intrinsic Function Source Fragment", OS);
  26
  27   std::vector<CodeGenIntrinsic> Ints = LoadIntrinsics(Records);
  28
  29   // Emit the enum information.
  30   EmitEnumInfo(Ints, OS);
  31
  32   // Emit the intrinsic ID -> name table.
  33   EmitIntrinsicToNameTable(Ints, OS);
  34
  35   // Emit the function name recognizer.
  36   EmitFnNameRecognizer(Ints, OS);
  37
  38   // Emit the intrinsic verifier.
  39   EmitVerifier(Ints, OS);
  40
  41   // Emit mod/ref info for each function.
  42   EmitModRefInfo(Ints, OS);
  43
  44   // Emit table of non-memory accessing intrinsics.
  45   EmitNoMemoryInfo(Ints, OS);
  46
  47   // Emit side effect info for each intrinsic.
  48   EmitSideEffectInfo(Ints, OS);
  49
  50   // Emit a list of intrinsics with corresponding GCC builtins.
  51   EmitGCCBuiltinList(Ints, OS);
  52
  53   // Emit code to translate GCC builtins into LLVM intrinsics.
  54   EmitIntrinsicToGCCBuiltinMap(Ints, OS);
  55 }
  56
  57 void IntrinsicEmitter::EmitEnumInfo(const std::vector<CodeGenIntrinsic> &Ints,
  58                                     std::ostream &OS) {
  59   OS << "// Enum values for Intrinsics.h\n";
  60   OS << "#ifdef GET_INTRINSIC_ENUM_VALUES\n";
  61   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
  62     OS << "    " << Ints[i].EnumName;
  63     OS << ((i != e-1) ? ", " : "  ");
  64     OS << std::string(40-Ints[i].EnumName.size(), ' ')
  65       << "// " << Ints[i].Name << "\n";
  66   }
  67   OS << "#endif\n\n";
  68 }
  69
  70 void IntrinsicEmitter::
  71 EmitFnNameRecognizer(const std::vector<CodeGenIntrinsic> &Ints,
  72                      std::ostream &OS) {
  73   // Build a function name -> intrinsic name mapping.
  74   std::map<std::string, std::string> IntMapping;
  75   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
  76     IntMapping[Ints[i].Name] = Ints[i].EnumName;
  77
  78   OS << "// Function name -> enum value recognizer code.\n";
  79   OS << "#ifdef GET_FUNCTION_RECOGNIZER\n";
  80   OS << "  switch (Name[5]) {\n";
  81   OS << "  default: break;\n";
  82   // Emit the intrinsics in sorted order.
  83   char LastChar = 0;
  84   for (std::map<std::string, std::string>::iterator I = IntMapping.begin(),
  85        E = IntMapping.end(); I != E; ++I) {
  86     if (I->first[5] != LastChar) {
  87       LastChar = I->first[5];
  88       OS << "  case '" << LastChar << "':\n";
  89     }
  90
  91     OS << "    if (Name == \"" << I->first << "\") return Intrinsic::"
  92        << I->second << ";\n";
  93   }
  94   OS << "  }\n";
  95   OS << "  // The 'llvm.' namespace is reserved!\n";
  96   OS << "  assert(0 && \"Unknown LLVM intrinsic function!\");\n";
  97   OS << "#endif\n\n";
  98 }
  99
 100 void IntrinsicEmitter::
 101 EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
 102                          std::ostream &OS) {
 103   OS << "// Intrinsic ID to name table\n";
 104   OS << "#ifdef GET_INTRINSIC_NAME_TABLE\n";
 105   OS << "  // Note that entry #0 is the invalid intrinsic!\n";
 106   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 107     OS << "  \"" << Ints[i].Name << "\",\n";
 108   OS << "#endif\n\n";
 109 }
 110
 111 static void EmitTypeVerify(std::ostream &OS, const std::string &Val,
 112                            Record *ArgType) {
 113   OS << "    Assert1(" << Val << "->getTypeID() == "
 114      << ArgType->getValueAsString("TypeVal") << ",\n"
 115      << "            \"Illegal intrinsic type!\", IF);\n";
 116
 117   // If this is a packed type, check that the subtype and size are correct.
 118   if (ArgType->isSubClassOf("LLVMPackedType")) {
 119     Record *SubType = ArgType->getValueAsDef("ElTy");
 120     OS << "    Assert1(cast<PackedType>(" << Val
 121        << ")->getElementType()->getTypeID() == "
 122        << SubType->getValueAsString("TypeVal") << ",\n"
 123        << "            \"Illegal intrinsic type!\", IF);\n";
 124     OS << "    Assert1(cast<PackedType>(" << Val << ")->getNumElements() == "
 125        << ArgType->getValueAsInt("NumElts") << ",\n"
 126        << "            \"Illegal intrinsic type!\", IF);\n";
 127   }
 128 }
 129
 130 /// RecordListComparator - Provide a determinstic comparator for lists of
 131 /// records.
 132 namespace {
 133   struct RecordListComparator {
 134     bool operator()(const std::vector<Record*> &LHS,
 135                     const std::vector<Record*> &RHS) const {
 136       unsigned i = 0;
 137       do {
 138         if (i == RHS.size()) return false;  // RHS is shorter than LHS.
 139         if (LHS[i] != RHS[i])
 140           return LHS[i]->getName() < RHS[i]->getName();
 141       } while (++i != LHS.size());
 142
 143       return i != RHS.size();
 144     }
 145   };
 146 }
 147
 148 void IntrinsicEmitter::EmitVerifier(const std::vector<CodeGenIntrinsic> &Ints,
 149                                     std::ostream &OS) {
 150   OS << "// Verifier::visitIntrinsicFunctionCall code.\n";
 151   OS << "#ifdef GET_INTRINSIC_VERIFIER\n";
 152   OS << "  switch (ID) {\n";
 153   OS << "  default: assert(0 && \"Invalid intrinsic!\");\n";
 154
 155   // This checking can emit a lot of very common code.  To reduce the amount of
 156   // code that we emit, batch up cases that have identical types.  This avoids
 157   // problems where GCC can run out of memory compiling Verifier.cpp.
 158   typedef std::map<std::vector<Record*>, std::vector<unsigned>,
 159     RecordListComparator> MapTy;
 160   MapTy UniqueArgInfos;
 161
 162   // Compute the unique argument type info.
 163   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 164     UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
 165
 166   // Loop through the array, emitting one comparison for each batch.
 167   for (MapTy::iterator I = UniqueArgInfos.begin(),
 168        E = UniqueArgInfos.end(); I != E; ++I) {
 169     for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
 170       OS << "  case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
 171          << Ints[I->second[i]].Name << "\n";
 172     }
 173     const std::vector<Record*> &ArgTypes = I->first;
 174     OS << "    Assert1(FTy->getNumParams() == " << ArgTypes.size()-1 << ",\n"
 175        << "            \"Illegal # arguments for intrinsic function!\", IF);\n";
 176     EmitTypeVerify(OS, "FTy->getReturnType()", ArgTypes[0]);
 177     for (unsigned j = 1; j != ArgTypes.size(); ++j)
 178       EmitTypeVerify(OS, "FTy->getParamType(" + utostr(j-1) + ")", ArgTypes[j]);
 179     OS << "    break;\n";
 180   }
 181   OS << "  }\n";
 182   OS << "#endif\n\n";
 183 }
 184
 185 void IntrinsicEmitter::EmitModRefInfo(const std::vector<CodeGenIntrinsic> &Ints,
 186                                       std::ostream &OS) {
 187   OS << "// BasicAliasAnalysis code.\n";
 188   OS << "#ifdef GET_MODREF_BEHAVIOR\n";
 189   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 190     switch (Ints[i].ModRef) {
 191     default: break;
 192     case CodeGenIntrinsic::NoMem:
 193       OS << "  NoMemoryTable.push_back(\"" << Ints[i].Name << "\");\n";
 194       break;
 195     case CodeGenIntrinsic::ReadArgMem:
 196     case CodeGenIntrinsic::ReadMem:
 197       OS << "  OnlyReadsMemoryTable.push_back(\"" << Ints[i].Name << "\");\n";
 198       break;
 199     }
 200   }
 201   OS << "#endif\n\n";
 202 }
 203
 204 void IntrinsicEmitter::
 205 EmitNoMemoryInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS) {
 206   OS << "// SelectionDAGIsel code.\n";
 207   OS << "#ifdef GET_NO_MEMORY_INTRINSICS\n";
 208   OS << "  switch (IntrinsicID) {\n";
 209   OS << "  default: break;\n";
 210   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 211     switch (Ints[i].ModRef) {
 212     default: break;
 213     case CodeGenIntrinsic::NoMem:
 214       OS << "  case Intrinsic::" << Ints[i].EnumName << ":\n";
 215       break;
 216     }
 217   }
 218   OS << "    return true; // These intrinsics have no side effects.\n";
 219   OS << "  }\n";
 220   OS << "#endif\n\n";
 221 }
 222
 223 void IntrinsicEmitter::
 224 EmitSideEffectInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
 225   OS << "// isInstructionTriviallyDead code.\n";
 226   OS << "#ifdef GET_SIDE_EFFECT_INFO\n";
 227   OS << "  switch (F->getIntrinsicID()) {\n";
 228   OS << "  default: break;\n";
 229   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 230     switch (Ints[i].ModRef) {
 231     default: break;
 232     case CodeGenIntrinsic::NoMem:
 233     case CodeGenIntrinsic::ReadArgMem:
 234     case CodeGenIntrinsic::ReadMem:
 235       OS << "  case Intrinsic::" << Ints[i].EnumName << ":\n";
 236       break;
 237     }
 238   }
 239   OS << "    return true; // These intrinsics have no side effects.\n";
 240   OS << "  }\n";
 241   OS << "#endif\n\n";
 242 }
 243
 244 void IntrinsicEmitter::
 245 EmitGCCBuiltinList(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
 246   OS << "// Get the GCC builtin that corresponds to an LLVM intrinsic.\n";
 247   OS << "#ifdef GET_GCC_BUILTIN_NAME\n";
 248   OS << "  switch (F->getIntrinsicID()) {\n";
 249   OS << "  default: BuiltinName = \"\"; break;\n";
 250   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 251     if (!Ints[i].GCCBuiltinName.empty()) {
 252       OS << "  case Intrinsic::" << Ints[i].EnumName << ": BuiltinName = \""
 253          << Ints[i].GCCBuiltinName << "\"; break;\n";
 254     }
 255   }
 256   OS << "  }\n";
 257   OS << "#endif\n\n";
 258 }
 259
 260 void IntrinsicEmitter::
 261 EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
 262                              std::ostream &OS) {
 263   typedef std::map<std::pair<std::string, std::string>, std::string> BIMTy;
 264   BIMTy BuiltinMap;
 265   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 266     if (!Ints[i].GCCBuiltinName.empty()) {
 267       std::pair<std::string, std::string> Key(Ints[i].GCCBuiltinName,
 268                                               Ints[i].TargetPrefix);
 269       if (!BuiltinMap.insert(std::make_pair(Key, Ints[i].EnumName)).second)
 270         throw "Intrinsic '" + Ints[i].TheDef->getName() +
 271               "': duplicate GCC builtin name!";
 272     }
 273   }
 274
 275   OS << "// Get the LLVM intrinsic that corresponds to a GCC builtin.\n";
 276   OS << "// This is used by the C front-end.  The GCC builtin name is passed\n";
 277   OS << "// in as BuiltinName, and a target prefix (e.g. 'ppc') is passed\n";
 278   OS << "// in as TargetPrefix.  The result is assigned to 'IntrinsicID'.\n";
 279   OS << "#ifdef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN\n";
 280   OS << "  if (0);\n";
 281   // Note: this could emit significantly better code if we cared.
 282   for (BIMTy::iterator I = BuiltinMap.begin(), E = BuiltinMap.end();I != E;++I){
 283     OS << "  else if (";
 284     if (!I->first.second.empty()) {
 285       // Emit this as a strcmp, so it can be constant folded by the FE.
 286       OS << "!strcmp(TargetPrefix, \"" << I->first.second << "\") &&\n"
 287          << "           ";
 288     }
 289     OS << "!strcmp(BuiltinName, \"" << I->first.first << "\"))\n";
 290     OS << "    IntrinsicID = Intrinsic::" << I->second << ";\n";
 291   }
 292   OS << "  else\n";
 293   OS << "    IntrinsicID = Intrinsic::not_intrinsic;\n";
 294   OS << "#endif\n\n";
 295 }