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