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