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