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