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