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