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