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