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