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 the intrinsic declaration generator.
  42   EmitGenerator(Ints, OS);
  43
  44   // Emit mod/ref info for each function.
  45   EmitModRefInfo(Ints, OS);
  46
  47   // Emit table of non-memory accessing intrinsics.
  48   EmitNoMemoryInfo(Ints, OS);
  49
  50   // Emit side effect info for each intrinsic.
  51   EmitSideEffectInfo(Ints, OS);
  52
  53   // Emit a list of intrinsics with corresponding GCC builtins.
  54   EmitGCCBuiltinList(Ints, OS);
  55
  56   // Emit code to translate GCC builtins into LLVM intrinsics.
  57   EmitIntrinsicToGCCBuiltinMap(Ints, OS);
  58 }
  59
  60 void IntrinsicEmitter::EmitEnumInfo(const std::vector<CodeGenIntrinsic> &Ints,
  61                                     std::ostream &OS) {
  62   OS << "// Enum values for Intrinsics.h\n";
  63   OS << "#ifdef GET_INTRINSIC_ENUM_VALUES\n";
  64   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
  65     OS << "    " << Ints[i].EnumName;
  66     OS << ((i != e-1) ? ", " : "  ");
  67     OS << std::string(40-Ints[i].EnumName.size(), ' ')
  68       << "// " << Ints[i].Name << "\n";
  69   }
  70   OS << "#endif\n\n";
  71 }
  72
  73 void IntrinsicEmitter::
  74 EmitFnNameRecognizer(const std::vector<CodeGenIntrinsic> &Ints,
  75                      std::ostream &OS) {
  76   // Build a function name -> intrinsic name mapping.
  77   std::map<std::string, std::string> IntMapping;
  78   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
  79     IntMapping[Ints[i].Name] = Ints[i].EnumName;
  80
  81   OS << "// Function name -> enum value recognizer code.\n";
  82   OS << "#ifdef GET_FUNCTION_RECOGNIZER\n";
  83   OS << "  switch (Name[5]) {\n";
  84   OS << "  default:\n";
  85   // Emit the intrinsics in sorted order.
  86   char LastChar = 0;
  87   for (std::map<std::string, std::string>::iterator I = IntMapping.begin(),
  88        E = IntMapping.end(); I != E; ++I) {
  89     if (I->first[5] != LastChar) {
  90       LastChar = I->first[5];
  91       OS << "    break;\n";
  92       OS << "  case '" << LastChar << "':\n";
  93     }
  94
  95     OS << "    if (Len == " << I->first.size()
  96        << " && !memcmp(Name, \"" << I->first << "\", Len)) return Intrinsic::"
  97        << I->second << ";\n";
  98   }
  99   OS << "  }\n";
 100   OS << "  // The 'llvm.' namespace is reserved!\n";
 101   OS << "  assert(0 && \"Unknown LLVM intrinsic function!\");\n";
 102   OS << "#endif\n\n";
 103 }
 104
 105 void IntrinsicEmitter::
 106 EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
 107                          std::ostream &OS) {
 108   OS << "// Intrinsic ID to name table\n";
 109   OS << "#ifdef GET_INTRINSIC_NAME_TABLE\n";
 110   OS << "  // Note that entry #0 is the invalid intrinsic!\n";
 111   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 112     OS << "  \"" << Ints[i].Name << "\",\n";
 113   OS << "#endif\n\n";
 114 }
 115
 116 static bool EmitTypeVerify(std::ostream &OS, Record *ArgType) {
 117   if (ArgType->getValueAsString("TypeVal") == "...")  return true;
 118
 119   OS << "(int)" << ArgType->getValueAsString("TypeVal") << ", ";
 120   // If this is an integer type, check the width is correct.
 121   if (ArgType->isSubClassOf("LLVMIntegerType"))
 122     OS << ArgType->getValueAsInt("Width") << ", ";
 123
 124   // If this is a vector type, check that the subtype and size are correct.
 125   else if (ArgType->isSubClassOf("LLVMVectorType")) {
 126     EmitTypeVerify(OS, ArgType->getValueAsDef("ElTy"));
 127     OS << ArgType->getValueAsInt("NumElts") << ", ";
 128   }
 129
 130   return false;
 131 }
 132
 133 static void EmitTypeGenerate(std::ostream &OS, Record *ArgType) {
 134   if (ArgType->isSubClassOf("LLVMIntegerType")) {
 135     OS << "IntegerType::get(" << ArgType->getValueAsInt("Width") << ")";
 136   } else if (ArgType->isSubClassOf("LLVMVectorType")) {
 137     OS << "VectorType::get(";
 138     EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"));
 139     OS << ", " << ArgType->getValueAsInt("NumElts") << ")";
 140   } else if (ArgType->isSubClassOf("LLVMPointerType")) {
 141     OS << "PointerType::get(";
 142     EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"));
 143     OS << ")";
 144   } else if (ArgType->isSubClassOf("LLVMEmptyStructType")) {
 145     OS << "StructType::get(std::vector<const Type *>())";
 146   } else {
 147     OS << "Type::getPrimitiveType(";
 148     OS << ArgType->getValueAsString("TypeVal") << ")";
 149   }
 150 }
 151
 152 /// RecordListComparator - Provide a determinstic comparator for lists of
 153 /// records.
 154 namespace {
 155   struct RecordListComparator {
 156     bool operator()(const std::vector<Record*> &LHS,
 157                     const std::vector<Record*> &RHS) const {
 158       unsigned i = 0;
 159       do {
 160         if (i == RHS.size()) return false;  // RHS is shorter than LHS.
 161         if (LHS[i] != RHS[i])
 162           return LHS[i]->getName() < RHS[i]->getName();
 163       } while (++i != LHS.size());
 164
 165       return i != RHS.size();
 166     }
 167   };
 168 }
 169
 170 void IntrinsicEmitter::EmitVerifier(const std::vector<CodeGenIntrinsic> &Ints,
 171                                     std::ostream &OS) {
 172   OS << "// Verifier::visitIntrinsicFunctionCall code.\n";
 173   OS << "#ifdef GET_INTRINSIC_VERIFIER\n";
 174   OS << "  switch (ID) {\n";
 175   OS << "  default: assert(0 && \"Invalid intrinsic!\");\n";
 176
 177   // This checking can emit a lot of very common code.  To reduce the amount of
 178   // code that we emit, batch up cases that have identical types.  This avoids
 179   // problems where GCC can run out of memory compiling Verifier.cpp.
 180   typedef std::map<std::vector<Record*>, std::vector<unsigned>,
 181     RecordListComparator> MapTy;
 182   MapTy UniqueArgInfos;
 183
 184   // Compute the unique argument type info.
 185   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 186     UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
 187
 188   // Loop through the array, emitting one comparison for each batch.
 189   for (MapTy::iterator I = UniqueArgInfos.begin(),
 190        E = UniqueArgInfos.end(); I != E; ++I) {
 191     for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
 192       OS << "  case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
 193          << Ints[I->second[i]].Name << "\n";
 194     }
 195
 196     const std::vector<Record*> &ArgTypes = I->first;
 197     OS << "    VerifyIntrinsicPrototype(IF, ";
 198     bool VarArg = false;
 199     for (unsigned j = 0; j != ArgTypes.size(); ++j) {
 200       VarArg = EmitTypeVerify(OS, ArgTypes[j]);
 201       if (VarArg) {
 202         if ((j+1) != ArgTypes.size())
 203           throw "Var arg type not last argument";
 204         break;
 205       }
 206     }
 207
 208     OS << (VarArg ? "-2);\n" : "-1);\n");
 209     OS << "    break;\n";
 210   }
 211   OS << "  }\n";
 212   OS << "#endif\n\n";
 213 }
 214
 215 void IntrinsicEmitter::EmitGenerator(const std::vector<CodeGenIntrinsic> &Ints,
 216                                      std::ostream &OS) {
 217   OS << "// Code for generating Intrinsic function declarations.\n";
 218   OS << "#ifdef GET_INTRINSIC_GENERATOR\n";
 219   OS << "  switch (id) {\n";
 220   OS << "  default: assert(0 && \"Invalid intrinsic!\");\n";
 221
 222   // Similar to GET_INTRINSIC_VERIFIER, batch up cases that have identical
 223   // types.
 224   typedef std::map<std::vector<Record*>, std::vector<unsigned>,
 225     RecordListComparator> MapTy;
 226   MapTy UniqueArgInfos;
 227
 228   // Compute the unique argument type info.
 229   for (unsigned i = 0, e = Ints.size(); i != e; ++i)
 230     UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
 231
 232   // Loop through the array, emitting one generator for each batch.
 233   for (MapTy::iterator I = UniqueArgInfos.begin(),
 234        E = UniqueArgInfos.end(); I != E; ++I) {
 235     for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
 236       OS << "  case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
 237          << Ints[I->second[i]].Name << "\n";
 238     }
 239
 240     const std::vector<Record*> &ArgTypes = I->first;
 241     unsigned N = ArgTypes.size();
 242
 243     if (ArgTypes[N-1]->getValueAsString("TypeVal") == "...") {
 244       OS << "    IsVarArg = true;\n";
 245       --N;
 246     }
 247
 248     OS << "    ResultTy = ";
 249     EmitTypeGenerate(OS, ArgTypes[0]);
 250     OS << ";\n";
 251
 252     for (unsigned j = 1; j != N; ++j) {
 253       OS << "    ArgTys.push_back(";
 254       EmitTypeGenerate(OS, ArgTypes[j]);
 255       OS << ");\n";
 256     }
 257
 258     OS << "    break;\n";
 259   }
 260   OS << "  }\n";
 261   OS << "#endif\n\n";
 262 }
 263
 264 void IntrinsicEmitter::EmitModRefInfo(const std::vector<CodeGenIntrinsic> &Ints,
 265                                       std::ostream &OS) {
 266   OS << "// BasicAliasAnalysis code.\n";
 267   OS << "#ifdef GET_MODREF_BEHAVIOR\n";
 268   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 269     switch (Ints[i].ModRef) {
 270     default: break;
 271     case CodeGenIntrinsic::NoMem:
 272       OS << "  NoMemoryTable->push_back(\"" << Ints[i].Name << "\");\n";
 273       break;
 274     case CodeGenIntrinsic::ReadArgMem:
 275     case CodeGenIntrinsic::ReadMem:
 276       OS << "  OnlyReadsMemoryTable->push_back(\"" << Ints[i].Name << "\");\n";
 277       break;
 278     }
 279   }
 280   OS << "#endif\n\n";
 281 }
 282
 283 void IntrinsicEmitter::
 284 EmitNoMemoryInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS) {
 285   OS << "// SelectionDAGIsel code.\n";
 286   OS << "#ifdef GET_NO_MEMORY_INTRINSICS\n";
 287   OS << "  switch (IntrinsicID) {\n";
 288   OS << "  default: break;\n";
 289   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 290     switch (Ints[i].ModRef) {
 291     default: break;
 292     case CodeGenIntrinsic::NoMem:
 293       OS << "  case Intrinsic::" << Ints[i].EnumName << ":\n";
 294       break;
 295     }
 296   }
 297   OS << "    return true; // These intrinsics have no side effects.\n";
 298   OS << "  }\n";
 299   OS << "#endif\n\n";
 300 }
 301
 302 void IntrinsicEmitter::
 303 EmitSideEffectInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
 304   OS << "// Return true if doesn't access or only reads memory.\n";
 305   OS << "#ifdef GET_SIDE_EFFECT_INFO\n";
 306   OS << "  switch (IntrinsicID) {\n";
 307   OS << "  default: break;\n";
 308   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 309     switch (Ints[i].ModRef) {
 310     default: break;
 311     case CodeGenIntrinsic::NoMem:
 312     case CodeGenIntrinsic::ReadArgMem:
 313     case CodeGenIntrinsic::ReadMem:
 314       OS << "  case Intrinsic::" << Ints[i].EnumName << ":\n";
 315       break;
 316     }
 317   }
 318   OS << "    return true; // These intrinsics have no side effects.\n";
 319   OS << "  }\n";
 320   OS << "#endif\n\n";
 321 }
 322
 323 void IntrinsicEmitter::
 324 EmitGCCBuiltinList(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
 325   OS << "// Get the GCC builtin that corresponds to an LLVM intrinsic.\n";
 326   OS << "#ifdef GET_GCC_BUILTIN_NAME\n";
 327   OS << "  switch (F->getIntrinsicID()) {\n";
 328   OS << "  default: BuiltinName = \"\"; break;\n";
 329   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 330     if (!Ints[i].GCCBuiltinName.empty()) {
 331       OS << "  case Intrinsic::" << Ints[i].EnumName << ": BuiltinName = \""
 332          << Ints[i].GCCBuiltinName << "\"; break;\n";
 333     }
 334   }
 335   OS << "  }\n";
 336   OS << "#endif\n\n";
 337 }
 338
 339 void IntrinsicEmitter::
 340 EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
 341                              std::ostream &OS) {
 342   typedef std::map<std::pair<std::string, std::string>, std::string> BIMTy;
 343   BIMTy BuiltinMap;
 344   for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
 345     if (!Ints[i].GCCBuiltinName.empty()) {
 346       std::pair<std::string, std::string> Key(Ints[i].GCCBuiltinName,
 347                                               Ints[i].TargetPrefix);
 348       if (!BuiltinMap.insert(std::make_pair(Key, Ints[i].EnumName)).second)
 349         throw "Intrinsic '" + Ints[i].TheDef->getName() +
 350               "': duplicate GCC builtin name!";
 351     }
 352   }
 353
 354   OS << "// Get the LLVM intrinsic that corresponds to a GCC builtin.\n";
 355   OS << "// This is used by the C front-end.  The GCC builtin name is passed\n";
 356   OS << "// in as BuiltinName, and a target prefix (e.g. 'ppc') is passed\n";
 357   OS << "// in as TargetPrefix.  The result is assigned to 'IntrinsicID'.\n";
 358   OS << "#ifdef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN\n";
 359   OS << "  if (0);\n";
 360   // Note: this could emit significantly better code if we cared.
 361   for (BIMTy::iterator I = BuiltinMap.begin(), E = BuiltinMap.end();I != E;++I){
 362     OS << "  else if (";
 363     if (!I->first.second.empty()) {
 364       // Emit this as a strcmp, so it can be constant folded by the FE.
 365       OS << "!strcmp(TargetPrefix, \"" << I->first.second << "\") &&\n"
 366          << "           ";
 367     }
 368     OS << "!strcmp(BuiltinName, \"" << I->first.first << "\"))\n";
 369     OS << "    IntrinsicID = Intrinsic::" << I->second << ";\n";
 370   }
 371   OS << "  else\n";
 372   OS << "    IntrinsicID = Intrinsic::not_intrinsic;\n";
 373   OS << "#endif\n\n";
 374 }