utils/TableGen/TableGen.cpp

   1 //===- TableGen.cpp - Top-Level TableGen implementation -------------------===//
   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 // TableGen is a tool which can be used to build up a description of something,
  11 // then invoke one or more "tablegen backends" to emit information about the
  12 // description in some predefined format.  In practice, this is used by the LLVM
  13 // code generators to automate generation of a code generator through a
  14 // high-level description of the target.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "Record.h"
  19 #include "TGParser.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Support/Streams.h"
  22 #include "llvm/System/Signals.h"
  23 #include "llvm/Support/FileUtilities.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/PrettyStackTrace.h"
  26 #include "CallingConvEmitter.h"
  27 #include "CodeEmitterGen.h"
  28 #include "RegisterInfoEmitter.h"
  29 #include "InstrInfoEmitter.h"
  30 #include "InstrEnumEmitter.h"
  31 #include "AsmWriterEmitter.h"
  32 #include "DAGISelEmitter.h"
  33 #include "FastISelEmitter.h"
  34 #include "SubtargetEmitter.h"
  35 #include "IntrinsicEmitter.h"
  36 #include "LLVMCConfigurationEmitter.h"
  37 #include <algorithm>
  38 #include <cstdio>
  39 #include <fstream>
  40 #include <ios>
  41 using namespace llvm;
  42
  43 enum ActionType {
  44   PrintRecords,
  45   GenEmitter,
  46   GenRegisterEnums, GenRegister, GenRegisterHeader,
  47   GenInstrEnums, GenInstrs, GenAsmWriter,
  48   GenCallingConv,
  49   GenDAGISel,
  50   GenFastISel,
  51   GenSubtarget,
  52   GenIntrinsic,
  53   GenTgtIntrinsic,
  54   GenLLVMCConf,
  55   PrintEnums
  56 };
  57
  58 namespace {
  59   cl::opt<ActionType>
  60   Action(cl::desc("Action to perform:"),
  61          cl::values(clEnumValN(PrintRecords, "print-records",
  62                                "Print all records to stdout (default)"),
  63                     clEnumValN(GenEmitter, "gen-emitter",
  64                                "Generate machine code emitter"),
  65                     clEnumValN(GenRegisterEnums, "gen-register-enums",
  66                                "Generate enum values for registers"),
  67                     clEnumValN(GenRegister, "gen-register-desc",
  68                                "Generate a register info description"),
  69                     clEnumValN(GenRegisterHeader, "gen-register-desc-header",
  70                                "Generate a register info description header"),
  71                     clEnumValN(GenInstrEnums, "gen-instr-enums",
  72                                "Generate enum values for instructions"),
  73                     clEnumValN(GenInstrs, "gen-instr-desc",
  74                                "Generate instruction descriptions"),
  75                     clEnumValN(GenCallingConv, "gen-callingconv",
  76                                "Generate calling convention descriptions"),
  77                     clEnumValN(GenAsmWriter, "gen-asm-writer",
  78                                "Generate assembly writer"),
  79                     clEnumValN(GenDAGISel, "gen-dag-isel",
  80                                "Generate a DAG instruction selector"),
  81                     clEnumValN(GenFastISel, "gen-fast-isel",
  82                                "Generate a \"fast\" instruction selector"),
  83                     clEnumValN(GenSubtarget, "gen-subtarget",
  84                                "Generate subtarget enumerations"),
  85                     clEnumValN(GenIntrinsic, "gen-intrinsic",
  86                                "Generate intrinsic information"),
  87                     clEnumValN(GenTgtIntrinsic, "gen-tgt-intrinsic",
  88                                "Generate target intrinsic information"),
  89                     clEnumValN(GenLLVMCConf, "gen-llvmc",
  90                                "Generate LLVMC configuration library"),
  91                     clEnumValN(PrintEnums, "print-enums",
  92                                "Print enum values for a class"),
  93                     clEnumValEnd));
  94
  95   cl::opt<std::string>
  96   Class("class", cl::desc("Print Enum list for this class"),
  97         cl::value_desc("class name"));
  98
  99   cl::opt<std::string>
 100   OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"),
 101                  cl::init("-"));
 102
 103   cl::opt<std::string>
 104   InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
 105
 106   cl::list<std::string>
 107   IncludeDirs("I", cl::desc("Directory of include files"),
 108               cl::value_desc("directory"), cl::Prefix);
 109 }
 110
 111 RecordKeeper llvm::Records;
 112
 113 /// ParseFile - this function begins the parsing of the specified tablegen
 114 /// file.
 115 static bool ParseFile(const std::string &Filename,
 116                       const std::vector<std::string> &IncludeDirs) {
 117   std::string ErrorStr;
 118   MemoryBuffer *F = MemoryBuffer::getFileOrSTDIN(Filename.c_str(), &ErrorStr);
 119   if (F == 0) {
 120     cerr << "Could not open input file '" + Filename + "': " << ErrorStr <<"\n";
 121     return true;
 122   }
 123
 124   TGParser Parser(F);
 125
 126   // Record the location of the include directory so that the lexer can find
 127   // it later.
 128   Parser.setIncludeDirs(IncludeDirs);
 129
 130   return Parser.ParseFile();
 131 }
 132
 133 int main(int argc, char **argv) {
 134   sys::PrintStackTraceOnErrorSignal();
 135   PrettyStackTraceProgram X(argc, argv);
 136   cl::ParseCommandLineOptions(argc, argv);
 137
 138   // Parse the input file.
 139   if (ParseFile(InputFilename, IncludeDirs))
 140     return 1;
 141
 142   std::ostream *Out = cout.stream();
 143   if (OutputFilename != "-") {
 144     Out = new std::ofstream(OutputFilename.c_str());
 145
 146     if (!Out->good()) {
 147       cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 148       return 1;
 149     }
 150
 151     // Make sure the file gets removed if *gasp* tablegen crashes...
 152     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 153   }
 154
 155   try {
 156     switch (Action) {
 157     case PrintRecords:
 158       *Out << Records;           // No argument, dump all contents
 159       break;
 160     case GenEmitter:
 161       CodeEmitterGen(Records).run(*Out);
 162       break;
 163
 164     case GenRegisterEnums:
 165       RegisterInfoEmitter(Records).runEnums(*Out);
 166       break;
 167     case GenRegister:
 168       RegisterInfoEmitter(Records).run(*Out);
 169       break;
 170     case GenRegisterHeader:
 171       RegisterInfoEmitter(Records).runHeader(*Out);
 172       break;
 173
 174     case GenInstrEnums:
 175       InstrEnumEmitter(Records).run(*Out);
 176       break;
 177     case GenInstrs:
 178       InstrInfoEmitter(Records).run(*Out);
 179       break;
 180     case GenCallingConv:
 181       CallingConvEmitter(Records).run(*Out);
 182       break;
 183     case GenAsmWriter:
 184       AsmWriterEmitter(Records).run(*Out);
 185       break;
 186
 187     case GenDAGISel:
 188       DAGISelEmitter(Records).run(*Out);
 189       break;
 190     case GenFastISel:
 191       FastISelEmitter(Records).run(*Out);
 192       break;
 193     case GenSubtarget:
 194       SubtargetEmitter(Records).run(*Out);
 195       break;
 196     case GenIntrinsic:
 197       IntrinsicEmitter(Records).run(*Out);
 198       break;
 199     case GenTgtIntrinsic:
 200       IntrinsicEmitter(Records, true).run(*Out);
 201       break;
 202     case GenLLVMCConf:
 203       LLVMCConfigurationEmitter(Records).run(*Out);
 204       break;
 205     case PrintEnums:
 206     {
 207       std::vector<Record*> Recs = Records.getAllDerivedDefinitions(Class);
 208       for (unsigned i = 0, e = Recs.size(); i != e; ++i)
 209         *Out << Recs[i]->getName() << ", ";
 210       *Out << "\n";
 211       break;
 212     }
 213     default:
 214       assert(1 && "Invalid Action");
 215       return 1;
 216     }
 217   } catch (const std::string &Error) {
 218     cerr << argv[0] << ": " << Error << "\n";
 219     if (Out != cout.stream()) {
 220       delete Out;                             // Close the file
 221       std::remove(OutputFilename.c_str());    // Remove the file, it's broken
 222     }
 223     return 1;
 224   } catch (const char *Error) {
 225     cerr << argv[0] << ": " << Error << "\n";
 226     if (Out != cout.stream()) {
 227       delete Out;                             // Close the file
 228       std::remove(OutputFilename.c_str());    // Remove the file, it's broken
 229     }
 230     return 1;
 231   } catch (...) {
 232     cerr << argv[0] << ": Unknown unexpected exception occurred.\n";
 233     if (Out != cout.stream()) {
 234       delete Out;                             // Close the file
 235       std::remove(OutputFilename.c_str());    // Remove the file, it's broken
 236     }
 237     return 2;
 238   }
 239
 240   if (Out != cout.stream()) {
 241     delete Out;                               // Close the file
 242   }
 243   return 0;
 244 }