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