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