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 "AsmMatcherEmitter.h"
  19 #include "AsmWriterEmitter.h"
  20 #include "CallingConvEmitter.h"
  21 #include "ClangDiagnosticsEmitter.h"
  22 #include "CodeEmitterGen.h"
  23 #include "DAGISelEmitter.h"
  24 #include "DisassemblerEmitter.h"
  25 #include "EDEmitter.h"
  26 #include "FastISelEmitter.h"
  27 #include "InstrEnumEmitter.h"
  28 #include "InstrInfoEmitter.h"
  29 #include "IntrinsicEmitter.h"
  30 #include "LLVMCConfigurationEmitter.h"
  31 #include "OptParserEmitter.h"
  32 #include "Record.h"
  33 #include "RegisterInfoEmitter.h"
  34 #include "SubtargetEmitter.h"
  35 #include "TGParser.h"
  36 #include "llvm/Support/CommandLine.h"
  37 #include "llvm/Support/MemoryBuffer.h"
  38 #include "llvm/Support/PrettyStackTrace.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 #include "llvm/System/Signals.h"
  41 #include <algorithm>
  42 #include <cstdio>
  43 using namespace llvm;
  44
  45 enum ActionType {
  46   PrintRecords,
  47   GenEmitter,
  48   GenRegisterEnums, GenRegister, GenRegisterHeader,
  49   GenInstrEnums, GenInstrs, GenAsmWriter, GenAsmMatcher,
  50   GenDisassembler,
  51   GenCallingConv,
  52   GenClangDiagsDefs,
  53   GenClangDiagGroups,
  54   GenDAGISel,
  55   GenFastISel,
  56   GenOptParserDefs, GenOptParserImpl,
  57   GenSubtarget,
  58   GenIntrinsic,
  59   GenTgtIntrinsic,
  60   GenLLVMCConf,
  61   GenEDHeader, GenEDInfo,
  62   PrintEnums
  63 };
  64
  65 namespace {
  66   cl::opt<ActionType>
  67   Action(cl::desc("Action to perform:"),
  68          cl::values(clEnumValN(PrintRecords, "print-records",
  69                                "Print all records to stdout (default)"),
  70                     clEnumValN(GenEmitter, "gen-emitter",
  71                                "Generate machine code emitter"),
  72                     clEnumValN(GenRegisterEnums, "gen-register-enums",
  73                                "Generate enum values for registers"),
  74                     clEnumValN(GenRegister, "gen-register-desc",
  75                                "Generate a register info description"),
  76                     clEnumValN(GenRegisterHeader, "gen-register-desc-header",
  77                                "Generate a register info description header"),
  78                     clEnumValN(GenInstrEnums, "gen-instr-enums",
  79                                "Generate enum values for instructions"),
  80                     clEnumValN(GenInstrs, "gen-instr-desc",
  81                                "Generate instruction descriptions"),
  82                     clEnumValN(GenCallingConv, "gen-callingconv",
  83                                "Generate calling convention descriptions"),
  84                     clEnumValN(GenAsmWriter, "gen-asm-writer",
  85                                "Generate assembly writer"),
  86                     clEnumValN(GenDisassembler, "gen-disassembler",
  87                                "Generate disassembler"),
  88                     clEnumValN(GenAsmMatcher, "gen-asm-matcher",
  89                                "Generate assembly instruction matcher"),
  90                     clEnumValN(GenDAGISel, "gen-dag-isel",
  91                                "Generate a DAG instruction selector"),
  92                     clEnumValN(GenFastISel, "gen-fast-isel",
  93                                "Generate a \"fast\" instruction selector"),
  94                     clEnumValN(GenOptParserDefs, "gen-opt-parser-defs",
  95                                "Generate option definitions"),
  96                     clEnumValN(GenOptParserImpl, "gen-opt-parser-impl",
  97                                "Generate option parser implementation"),
  98                     clEnumValN(GenSubtarget, "gen-subtarget",
  99                                "Generate subtarget enumerations"),
 100                     clEnumValN(GenIntrinsic, "gen-intrinsic",
 101                                "Generate intrinsic information"),
 102                     clEnumValN(GenTgtIntrinsic, "gen-tgt-intrinsic",
 103                                "Generate target intrinsic information"),
 104                     clEnumValN(GenClangDiagsDefs, "gen-clang-diags-defs",
 105                                "Generate Clang diagnostics definitions"),
 106                     clEnumValN(GenClangDiagGroups, "gen-clang-diag-groups",
 107                                "Generate Clang diagnostic groups"),
 108                     clEnumValN(GenLLVMCConf, "gen-llvmc",
 109                                "Generate LLVMC configuration library"),
 110                     clEnumValN(GenEDHeader, "gen-enhanced-disassembly-header",
 111                                "Generate enhanced disassembly info header"),
 112                     clEnumValN(GenEDInfo, "gen-enhanced-disassembly-info",
 113                                "Generate enhanced disassembly info"),
 114                     clEnumValN(PrintEnums, "print-enums",
 115                                "Print enum values for a class"),
 116                     clEnumValEnd));
 117
 118   cl::opt<std::string>
 119   Class("class", cl::desc("Print Enum list for this class"),
 120         cl::value_desc("class name"));
 121
 122   cl::opt<std::string>
 123   OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"),
 124                  cl::init("-"));
 125
 126   cl::opt<std::string>
 127   InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
 128
 129   cl::list<std::string>
 130   IncludeDirs("I", cl::desc("Directory of include files"),
 131               cl::value_desc("directory"), cl::Prefix);
 132
 133   cl::opt<std::string>
 134   ClangComponent("clang-component",
 135                  cl::desc("Only use warnings from specified component"),
 136                  cl::value_desc("component"), cl::Hidden);
 137 }
 138
 139
 140 // FIXME: Eliminate globals from tblgen.
 141 RecordKeeper llvm::Records;
 142
 143 static SourceMgr SrcMgr;
 144
 145 void llvm::PrintError(SMLoc ErrorLoc, const std::string &Msg) {
 146   SrcMgr.PrintMessage(ErrorLoc, Msg, "error");
 147 }
 148
 149
 150
 151 /// ParseFile - this function begins the parsing of the specified tablegen
 152 /// file.
 153 static bool ParseFile(const std::string &Filename,
 154                       const std::vector<std::string> &IncludeDirs,
 155                       SourceMgr &SrcMgr) {
 156   std::string ErrorStr;
 157   MemoryBuffer *F = MemoryBuffer::getFileOrSTDIN(Filename.c_str(), &ErrorStr);
 158   if (F == 0) {
 159     errs() << "Could not open input file '" << Filename << "': "
 160            << ErrorStr <<"\n";
 161     return true;
 162   }
 163
 164   // Tell SrcMgr about this buffer, which is what TGParser will pick up.
 165   SrcMgr.AddNewSourceBuffer(F, SMLoc());
 166
 167   // Record the location of the include directory so that the lexer can find
 168   // it later.
 169   SrcMgr.setIncludeDirs(IncludeDirs);
 170
 171   TGParser Parser(SrcMgr);
 172
 173   return Parser.ParseFile();
 174 }
 175
 176 int main(int argc, char **argv) {
 177   sys::PrintStackTraceOnErrorSignal();
 178   PrettyStackTraceProgram X(argc, argv);
 179   cl::ParseCommandLineOptions(argc, argv);
 180
 181
 182   // Parse the input file.
 183   if (ParseFile(InputFilename, IncludeDirs, SrcMgr))
 184     return 1;
 185
 186   raw_ostream *Out = &outs();
 187   if (OutputFilename != "-") {
 188     std::string Error;
 189     Out = new raw_fd_ostream(OutputFilename.c_str(), Error);
 190
 191     if (!Error.empty()) {
 192       errs() << argv[0] << ": error opening " << OutputFilename
 193              << ":" << Error << "\n";
 194       return 1;
 195     }
 196
 197     // Make sure the file gets removed if *gasp* tablegen crashes...
 198     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 199   }
 200
 201   try {
 202     switch (Action) {
 203     case PrintRecords:
 204       *Out << Records;           // No argument, dump all contents
 205       break;
 206     case GenEmitter:
 207       CodeEmitterGen(Records).run(*Out);
 208       break;
 209
 210     case GenRegisterEnums:
 211       RegisterInfoEmitter(Records).runEnums(*Out);
 212       break;
 213     case GenRegister:
 214       RegisterInfoEmitter(Records).run(*Out);
 215       break;
 216     case GenRegisterHeader:
 217       RegisterInfoEmitter(Records).runHeader(*Out);
 218       break;
 219     case GenInstrEnums:
 220       InstrEnumEmitter(Records).run(*Out);
 221       break;
 222     case GenInstrs:
 223       InstrInfoEmitter(Records).run(*Out);
 224       break;
 225     case GenCallingConv:
 226       CallingConvEmitter(Records).run(*Out);
 227       break;
 228     case GenAsmWriter:
 229       AsmWriterEmitter(Records).run(*Out);
 230       break;
 231     case GenAsmMatcher:
 232       AsmMatcherEmitter(Records).run(*Out);
 233       break;
 234     case GenClangDiagsDefs:
 235       ClangDiagsDefsEmitter(Records, ClangComponent).run(*Out);
 236       break;
 237     case GenClangDiagGroups:
 238       ClangDiagGroupsEmitter(Records).run(*Out);
 239       break;
 240     case GenDisassembler:
 241       DisassemblerEmitter(Records).run(*Out);
 242       break;
 243     case GenOptParserDefs:
 244       OptParserEmitter(Records, true).run(*Out);
 245       break;
 246     case GenOptParserImpl:
 247       OptParserEmitter(Records, false).run(*Out);
 248       break;
 249     case GenDAGISel:
 250       DAGISelEmitter(Records).run(*Out);
 251       break;
 252     case GenFastISel:
 253       FastISelEmitter(Records).run(*Out);
 254       break;
 255     case GenSubtarget:
 256       SubtargetEmitter(Records).run(*Out);
 257       break;
 258     case GenIntrinsic:
 259       IntrinsicEmitter(Records).run(*Out);
 260       break;
 261     case GenTgtIntrinsic:
 262       IntrinsicEmitter(Records, true).run(*Out);
 263       break;
 264     case GenLLVMCConf:
 265       LLVMCConfigurationEmitter(Records).run(*Out);
 266       break;
 267     case GenEDHeader:
 268       EDEmitter(Records).runHeader(*Out);
 269       break;
 270     case GenEDInfo:
 271       EDEmitter(Records).run(*Out);
 272       break;
 273     case PrintEnums:
 274     {
 275       std::vector<Record*> Recs = Records.getAllDerivedDefinitions(Class);
 276       for (unsigned i = 0, e = Recs.size(); i != e; ++i)
 277         *Out << Recs[i]->getName() << ", ";
 278       *Out << "\n";
 279       break;
 280     }
 281     default:
 282       assert(1 && "Invalid Action");
 283       return 1;
 284     }
 285
 286     if (Out != &outs())
 287       delete Out;                               // Close the file
 288     return 0;
 289
 290   } catch (const TGError &Error) {
 291     errs() << argv[0] << ": error:\n";
 292     PrintError(Error.getLoc(), Error.getMessage());
 293
 294   } catch (const std::string &Error) {
 295     errs() << argv[0] << ": " << Error << "\n";
 296   } catch (const char *Error) {
 297     errs() << argv[0] << ": " << Error << "\n";
 298   } catch (...) {
 299     errs() << argv[0] << ": Unknown unexpected exception occurred.\n";
 300   }
 301
 302   if (Out != &outs()) {
 303     delete Out;                             // Close the file
 304     std::remove(OutputFilename.c_str());    // Remove the file, it's broken
 305   }
 306   return 1;
 307 }