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 "ClangSACheckersEmitter.h"
  25 #include "CodeEmitterGen.h"
  26 #include "DAGISelEmitter.h"
  27 #include "DisassemblerEmitter.h"
  28 #include "EDEmitter.h"
  29 #include "Error.h"
  30 #include "FastISelEmitter.h"
  31 #include "InstrEnumEmitter.h"
  32 #include "InstrInfoEmitter.h"
  33 #include "IntrinsicEmitter.h"
  34 #include "LLVMCConfigurationEmitter.h"
  35 #include "NeonEmitter.h"
  36 #include "OptParserEmitter.h"
  37 #include "Record.h"
  38 #include "RegisterInfoEmitter.h"
  39 #include "ARMDecoderEmitter.h"
  40 #include "SubtargetEmitter.h"
  41 #include "SetTheory.h"
  42 #include "TGParser.h"
  43 #include "llvm/ADT/OwningPtr.h"
  44 #include "llvm/Support/CommandLine.h"
  45 #include "llvm/Support/MemoryBuffer.h"
  46 #include "llvm/Support/PrettyStackTrace.h"
  47 #include "llvm/Support/ToolOutputFile.h"
  48 #include "llvm/Support/Signals.h"
  49 #include "llvm/Support/system_error.h"
  50 #include <algorithm>
  51 #include <cstdio>
  52 using namespace llvm;
  53
  54 enum ActionType {
  55   PrintRecords,
  56   GenEmitter,
  57   GenRegisterEnums, GenRegister, GenRegisterHeader,
  58   GenInstrEnums, GenInstrs, GenAsmWriter, GenAsmMatcher,
  59   GenARMDecoder,
  60   GenDisassembler,
  61   GenCallingConv,
  62   GenClangAttrClasses,
  63   GenClangAttrImpl,
  64   GenClangAttrList,
  65   GenClangAttrPCHRead,
  66   GenClangAttrPCHWrite,
  67   GenClangAttrSpellingList,
  68   GenClangDiagsDefs,
  69   GenClangDiagGroups,
  70   GenClangDiagsIndexName,
  71   GenClangDeclNodes,
  72   GenClangStmtNodes,
  73   GenClangSACheckers,
  74   GenDAGISel,
  75   GenFastISel,
  76   GenOptParserDefs, GenOptParserImpl,
  77   GenSubtarget,
  78   GenIntrinsic,
  79   GenTgtIntrinsic,
  80   GenLLVMCConf,
  81   GenEDInfo,
  82   GenArmNeon,
  83   GenArmNeonSema,
  84   GenArmNeonTest,
  85   PrintEnums,
  86   PrintSets
  87 };
  88
  89 namespace {
  90   cl::opt<ActionType>
  91   Action(cl::desc("Action to perform:"),
  92          cl::values(clEnumValN(PrintRecords, "print-records",
  93                                "Print all records to stdout (default)"),
  94                     clEnumValN(GenEmitter, "gen-emitter",
  95                                "Generate machine code emitter"),
  96                     clEnumValN(GenRegisterEnums, "gen-register-enums",
  97                                "Generate enum values for registers"),
  98                     clEnumValN(GenRegister, "gen-register-desc",
  99                                "Generate a register info description"),
 100                     clEnumValN(GenRegisterHeader, "gen-register-desc-header",
 101                                "Generate a register info description header"),
 102                     clEnumValN(GenInstrEnums, "gen-instr-enums",
 103                                "Generate enum values for instructions"),
 104                     clEnumValN(GenInstrs, "gen-instr-desc",
 105                                "Generate instruction descriptions"),
 106                     clEnumValN(GenCallingConv, "gen-callingconv",
 107                                "Generate calling convention descriptions"),
 108                     clEnumValN(GenAsmWriter, "gen-asm-writer",
 109                                "Generate assembly writer"),
 110                     clEnumValN(GenARMDecoder, "gen-arm-decoder",
 111                                "Generate decoders for ARM/Thumb"),
 112                     clEnumValN(GenDisassembler, "gen-disassembler",
 113                                "Generate disassembler"),
 114                     clEnumValN(GenAsmMatcher, "gen-asm-matcher",
 115                                "Generate assembly instruction matcher"),
 116                     clEnumValN(GenDAGISel, "gen-dag-isel",
 117                                "Generate a DAG instruction selector"),
 118                     clEnumValN(GenFastISel, "gen-fast-isel",
 119                                "Generate a \"fast\" instruction selector"),
 120                     clEnumValN(GenOptParserDefs, "gen-opt-parser-defs",
 121                                "Generate option definitions"),
 122                     clEnumValN(GenOptParserImpl, "gen-opt-parser-impl",
 123                                "Generate option parser implementation"),
 124                     clEnumValN(GenSubtarget, "gen-subtarget",
 125                                "Generate subtarget enumerations"),
 126                     clEnumValN(GenIntrinsic, "gen-intrinsic",
 127                                "Generate intrinsic information"),
 128                     clEnumValN(GenTgtIntrinsic, "gen-tgt-intrinsic",
 129                                "Generate target intrinsic information"),
 130                     clEnumValN(GenClangAttrClasses, "gen-clang-attr-classes",
 131                                "Generate clang attribute clases"),
 132                     clEnumValN(GenClangAttrImpl, "gen-clang-attr-impl",
 133                                "Generate clang attribute implementations"),
 134                     clEnumValN(GenClangAttrList, "gen-clang-attr-list",
 135                                "Generate a clang attribute list"),
 136                     clEnumValN(GenClangAttrPCHRead, "gen-clang-attr-pch-read",
 137                                "Generate clang PCH attribute reader"),
 138                     clEnumValN(GenClangAttrPCHWrite, "gen-clang-attr-pch-write",
 139                                "Generate clang PCH attribute writer"),
 140                     clEnumValN(GenClangAttrSpellingList,
 141                                "gen-clang-attr-spelling-list",
 142                                "Generate a clang attribute spelling list"),
 143                     clEnumValN(GenClangDiagsDefs, "gen-clang-diags-defs",
 144                                "Generate Clang diagnostics definitions"),
 145                     clEnumValN(GenClangDiagGroups, "gen-clang-diag-groups",
 146                                "Generate Clang diagnostic groups"),
 147                     clEnumValN(GenClangDiagsIndexName,
 148                                "gen-clang-diags-index-name",
 149                                "Generate Clang diagnostic name index"),
 150                     clEnumValN(GenClangDeclNodes, "gen-clang-decl-nodes",
 151                                "Generate Clang AST declaration nodes"),
 152                     clEnumValN(GenClangStmtNodes, "gen-clang-stmt-nodes",
 153                                "Generate Clang AST statement nodes"),
 154                     clEnumValN(GenClangSACheckers, "gen-clang-sa-checkers",
 155                                "Generate Clang Static Analyzer checkers"),
 156                     clEnumValN(GenLLVMCConf, "gen-llvmc",
 157                                "Generate LLVMC configuration library"),
 158                     clEnumValN(GenEDInfo, "gen-enhanced-disassembly-info",
 159                                "Generate enhanced disassembly info"),
 160                     clEnumValN(GenArmNeon, "gen-arm-neon",
 161                                "Generate arm_neon.h for clang"),
 162                     clEnumValN(GenArmNeonSema, "gen-arm-neon-sema",
 163                                "Generate ARM NEON sema support for clang"),
 164                     clEnumValN(GenArmNeonTest, "gen-arm-neon-test",
 165                                "Generate ARM NEON tests for clang"),
 166                     clEnumValN(PrintEnums, "print-enums",
 167                                "Print enum values for a class"),
 168                     clEnumValN(PrintSets, "print-sets",
 169                                "Print expanded sets for testing DAG exprs"),
 170                     clEnumValEnd));
 171
 172   cl::opt<std::string>
 173   Class("class", cl::desc("Print Enum list for this class"),
 174         cl::value_desc("class name"));
 175
 176   cl::opt<std::string>
 177   OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"),
 178                  cl::init("-"));
 179
 180   cl::opt<std::string>
 181   DependFilename("d", cl::desc("Dependency filename"), cl::value_desc("filename"),
 182                  cl::init(""));
 183
 184   cl::opt<std::string>
 185   InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
 186
 187   cl::list<std::string>
 188   IncludeDirs("I", cl::desc("Directory of include files"),
 189               cl::value_desc("directory"), cl::Prefix);
 190
 191   cl::opt<std::string>
 192   ClangComponent("clang-component",
 193                  cl::desc("Only use warnings from specified component"),
 194                  cl::value_desc("component"), cl::Hidden);
 195 }
 196
 197
 198 int main(int argc, char **argv) {
 199   RecordKeeper Records;
 200
 201   sys::PrintStackTraceOnErrorSignal();
 202   PrettyStackTraceProgram X(argc, argv);
 203   cl::ParseCommandLineOptions(argc, argv);
 204
 205
 206   try {
 207     // Parse the input file.
 208     OwningPtr<MemoryBuffer> File;
 209     if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str(), File)) {
 210       errs() << "Could not open input file '" << InputFilename << "': "
 211              << ec.message() <<"\n";
 212       return 1;
 213     }
 214     MemoryBuffer *F = File.take();
 215
 216     // Tell SrcMgr about this buffer, which is what TGParser will pick up.
 217     SrcMgr.AddNewSourceBuffer(F, SMLoc());
 218
 219     // Record the location of the include directory so that the lexer can find
 220     // it later.
 221     SrcMgr.setIncludeDirs(IncludeDirs);
 222
 223     TGParser Parser(SrcMgr, Records);
 224
 225     if (Parser.ParseFile())
 226       return 1;
 227
 228     std::string Error;
 229     tool_output_file Out(OutputFilename.c_str(), Error);
 230     if (!Error.empty()) {
 231       errs() << argv[0] << ": error opening " << OutputFilename
 232         << ":" << Error << "\n";
 233       return 1;
 234     }
 235     if (!DependFilename.empty()) {
 236       if (OutputFilename == "-") {
 237         errs() << argv[0] << ": the option -d must be used together with -o\n";
 238         return 1;
 239       }
 240       tool_output_file DepOut(DependFilename.c_str(), Error);
 241       if (!Error.empty()) {
 242         errs() << argv[0] << ": error opening " << DependFilename
 243           << ":" << Error << "\n";
 244         return 1;
 245       }
 246       DepOut.os() << DependFilename << ":";
 247       const std::vector<std::string> &Dependencies = Parser.getDependencies();
 248       for (std::vector<std::string>::const_iterator I = Dependencies.begin(),
 249                                                           E = Dependencies.end();
 250            I != E; ++I) {
 251         DepOut.os() << " " << (*I);
 252       }
 253       DepOut.os() << "\n";
 254       DepOut.keep();
 255     }
 256
 257     switch (Action) {
 258     case PrintRecords:
 259       Out.os() << Records;           // No argument, dump all contents
 260       break;
 261     case GenEmitter:
 262       CodeEmitterGen(Records).run(Out.os());
 263       break;
 264
 265     case GenRegisterEnums:
 266       RegisterInfoEmitter(Records).runEnums(Out.os());
 267       break;
 268     case GenRegister:
 269       RegisterInfoEmitter(Records).run(Out.os());
 270       break;
 271     case GenRegisterHeader:
 272       RegisterInfoEmitter(Records).runHeader(Out.os());
 273       break;
 274     case GenInstrEnums:
 275       InstrEnumEmitter(Records).run(Out.os());
 276       break;
 277     case GenInstrs:
 278       InstrInfoEmitter(Records).run(Out.os());
 279       break;
 280     case GenCallingConv:
 281       CallingConvEmitter(Records).run(Out.os());
 282       break;
 283     case GenAsmWriter:
 284       AsmWriterEmitter(Records).run(Out.os());
 285       break;
 286     case GenARMDecoder:
 287       ARMDecoderEmitter(Records).run(Out.os());
 288       break;
 289     case GenAsmMatcher:
 290       AsmMatcherEmitter(Records).run(Out.os());
 291       break;
 292     case GenClangAttrClasses:
 293       ClangAttrClassEmitter(Records).run(Out.os());
 294       break;
 295     case GenClangAttrImpl:
 296       ClangAttrImplEmitter(Records).run(Out.os());
 297       break;
 298     case GenClangAttrList:
 299       ClangAttrListEmitter(Records).run(Out.os());
 300       break;
 301     case GenClangAttrPCHRead:
 302       ClangAttrPCHReadEmitter(Records).run(Out.os());
 303       break;
 304     case GenClangAttrPCHWrite:
 305       ClangAttrPCHWriteEmitter(Records).run(Out.os());
 306       break;
 307     case GenClangAttrSpellingList:
 308       ClangAttrSpellingListEmitter(Records).run(Out.os());
 309       break;
 310     case GenClangDiagsDefs:
 311       ClangDiagsDefsEmitter(Records, ClangComponent).run(Out.os());
 312       break;
 313     case GenClangDiagGroups:
 314       ClangDiagGroupsEmitter(Records).run(Out.os());
 315       break;
 316     case GenClangDiagsIndexName:
 317       ClangDiagsIndexNameEmitter(Records).run(Out.os());
 318       break;
 319     case GenClangDeclNodes:
 320       ClangASTNodesEmitter(Records, "Decl", "Decl").run(Out.os());
 321       ClangDeclContextEmitter(Records).run(Out.os());
 322       break;
 323     case GenClangStmtNodes:
 324       ClangASTNodesEmitter(Records, "Stmt", "").run(Out.os());
 325       break;
 326     case GenClangSACheckers:
 327       ClangSACheckersEmitter(Records).run(Out.os());
 328       break;
 329     case GenDisassembler:
 330       DisassemblerEmitter(Records).run(Out.os());
 331       break;
 332     case GenOptParserDefs:
 333       OptParserEmitter(Records, true).run(Out.os());
 334       break;
 335     case GenOptParserImpl:
 336       OptParserEmitter(Records, false).run(Out.os());
 337       break;
 338     case GenDAGISel:
 339       DAGISelEmitter(Records).run(Out.os());
 340       break;
 341     case GenFastISel:
 342       FastISelEmitter(Records).run(Out.os());
 343       break;
 344     case GenSubtarget:
 345       SubtargetEmitter(Records).run(Out.os());
 346       break;
 347     case GenIntrinsic:
 348       IntrinsicEmitter(Records).run(Out.os());
 349       break;
 350     case GenTgtIntrinsic:
 351       IntrinsicEmitter(Records, true).run(Out.os());
 352       break;
 353     case GenLLVMCConf:
 354       LLVMCConfigurationEmitter(Records).run(Out.os());
 355       break;
 356     case GenEDInfo:
 357       EDEmitter(Records).run(Out.os());
 358       break;
 359     case GenArmNeon:
 360       NeonEmitter(Records).run(Out.os());
 361       break;
 362     case GenArmNeonSema:
 363       NeonEmitter(Records).runHeader(Out.os());
 364       break;
 365     case GenArmNeonTest:
 366       NeonEmitter(Records).runTests(Out.os());
 367       break;
 368     case PrintEnums:
 369     {
 370       std::vector<Record*> Recs = Records.getAllDerivedDefinitions(Class);
 371       for (unsigned i = 0, e = Recs.size(); i != e; ++i)
 372         Out.os() << Recs[i]->getName() << ", ";
 373       Out.os() << "\n";
 374       break;
 375     }
 376     case PrintSets:
 377     {
 378       SetTheory Sets;
 379       Sets.addFieldExpander("Set", "Elements");
 380       std::vector<Record*> Recs = Records.getAllDerivedDefinitions("Set");
 381       for (unsigned i = 0, e = Recs.size(); i != e; ++i) {
 382         Out.os() << Recs[i]->getName() << " = [";
 383         const std::vector<Record*> *Elts = Sets.expand(Recs[i]);
 384         assert(Elts && "Couldn't expand Set instance");
 385         for (unsigned ei = 0, ee = Elts->size(); ei != ee; ++ei)
 386           Out.os() << ' ' << (*Elts)[ei]->getName();
 387         Out.os() << " ]\n";
 388       }
 389       break;
 390     }
 391     default:
 392       assert(1 && "Invalid Action");
 393       return 1;
 394     }
 395
 396     // Declare success.
 397     Out.keep();
 398     return 0;
 399
 400   } catch (const TGError &Error) {
 401     PrintError(Error);
 402   } catch (const std::string &Error) {
 403     PrintError(Error);
 404   } catch (const char *Error) {
 405     PrintError(Error);
 406   } catch (...) {
 407     errs() << argv[0] << ": Unknown unexpected exception occurred.\n";
 408   }
 409
 410   return 1;
 411 }