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 "ClangDiagnosticsEmitter.h"
  22 #include "CodeEmitterGen.h"
  23 #include "DAGISelEmitter.h"
  24 #include "DisassemblerEmitter.h"
  25 #include "EDEmitter.h"
  26 #include "FastISelEmitter.h"
  27 #include "InstrEnumEmitter.h"
  28 #include "InstrInfoEmitter.h"
  29 #include "IntrinsicEmitter.h"
  30 #include "LLVMCConfigurationEmitter.h"
  31 #include "OptParserEmitter.h"
  32 #include "Record.h"
  33 #include "RegisterInfoEmitter.h"
  34 #include "ARMDecoderEmitter.h"
  35 #include "SubtargetEmitter.h"
  36 #include "TGParser.h"
  37 #include "llvm/Support/CommandLine.h"
  38 #include "llvm/Support/MemoryBuffer.h"
  39 #include "llvm/Support/PrettyStackTrace.h"
  40 #include "llvm/Support/raw_ostream.h"
  41 #include "llvm/System/Signals.h"
  42 #include <algorithm>
  43 #include <cstdio>
  44 using namespace llvm;
  45
  46 enum ActionType {
  47   PrintRecords,
  48   GenEmitter,
  49   GenRegisterEnums, GenRegister, GenRegisterHeader,
  50   GenInstrEnums, GenInstrs, GenAsmWriter, GenAsmMatcher,
  51   GenARMDecoder,
  52   GenDisassembler,
  53   GenCallingConv,
  54   GenClangDiagsDefs,
  55   GenClangDiagGroups,
  56   GenDAGISel,
  57   GenFastISel,
  58   GenOptParserDefs, GenOptParserImpl,
  59   GenSubtarget,
  60   GenIntrinsic,
  61   GenTgtIntrinsic,
  62   GenLLVMCConf,
  63   GenEDHeader, GenEDInfo,
  64   PrintEnums
  65 };
  66
  67 namespace {
  68   cl::opt<ActionType>
  69   Action(cl::desc("Action to perform:"),
  70          cl::values(clEnumValN(PrintRecords, "print-records",
  71                                "Print all records to stdout (default)"),
  72                     clEnumValN(GenEmitter, "gen-emitter",
  73                                "Generate machine code emitter"),
  74                     clEnumValN(GenRegisterEnums, "gen-register-enums",
  75                                "Generate enum values for registers"),
  76                     clEnumValN(GenRegister, "gen-register-desc",
  77                                "Generate a register info description"),
  78                     clEnumValN(GenRegisterHeader, "gen-register-desc-header",
  79                                "Generate a register info description header"),
  80                     clEnumValN(GenInstrEnums, "gen-instr-enums",
  81                                "Generate enum values for instructions"),
  82                     clEnumValN(GenInstrs, "gen-instr-desc",
  83                                "Generate instruction descriptions"),
  84                     clEnumValN(GenCallingConv, "gen-callingconv",
  85                                "Generate calling convention descriptions"),
  86                     clEnumValN(GenAsmWriter, "gen-asm-writer",
  87                                "Generate assembly writer"),
  88                     clEnumValN(GenARMDecoder, "gen-arm-decoder",
  89                                "Generate decoders for ARM/Thumb"),
  90                     clEnumValN(GenDisassembler, "gen-disassembler",
  91                                "Generate disassembler"),
  92                     clEnumValN(GenAsmMatcher, "gen-asm-matcher",
  93                                "Generate assembly instruction matcher"),
  94                     clEnumValN(GenDAGISel, "gen-dag-isel",
  95                                "Generate a DAG instruction selector"),
  96                     clEnumValN(GenFastISel, "gen-fast-isel",
  97                                "Generate a \"fast\" instruction selector"),
  98                     clEnumValN(GenOptParserDefs, "gen-opt-parser-defs",
  99                                "Generate option definitions"),
 100                     clEnumValN(GenOptParserImpl, "gen-opt-parser-impl",
 101                                "Generate option parser implementation"),
 102                     clEnumValN(GenSubtarget, "gen-subtarget",
 103                                "Generate subtarget enumerations"),
 104                     clEnumValN(GenIntrinsic, "gen-intrinsic",
 105                                "Generate intrinsic information"),
 106                     clEnumValN(GenTgtIntrinsic, "gen-tgt-intrinsic",
 107                                "Generate target intrinsic information"),
 108                     clEnumValN(GenClangDiagsDefs, "gen-clang-diags-defs",
 109                                "Generate Clang diagnostics definitions"),
 110                     clEnumValN(GenClangDiagGroups, "gen-clang-diag-groups",
 111                                "Generate Clang diagnostic groups"),
 112                     clEnumValN(GenLLVMCConf, "gen-llvmc",
 113                                "Generate LLVMC configuration library"),
 114                     clEnumValN(GenEDHeader, "gen-enhanced-disassembly-header",
 115                                "Generate enhanced disassembly info header"),
 116                     clEnumValN(GenEDInfo, "gen-enhanced-disassembly-info",
 117                                "Generate enhanced disassembly info"),
 118                     clEnumValN(PrintEnums, "print-enums",
 119                                "Print enum values for a class"),
 120                     clEnumValEnd));
 121
 122   cl::opt<std::string>
 123   Class("class", cl::desc("Print Enum list for this class"),
 124         cl::value_desc("class name"));
 125
 126   cl::opt<std::string>
 127   OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"),
 128                  cl::init("-"));
 129
 130   cl::opt<std::string>
 131   InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
 132
 133   cl::list<std::string>
 134   IncludeDirs("I", cl::desc("Directory of include files"),
 135               cl::value_desc("directory"), cl::Prefix);
 136
 137   cl::opt<std::string>
 138   ClangComponent("clang-component",
 139                  cl::desc("Only use warnings from specified component"),
 140                  cl::value_desc("component"), cl::Hidden);
 141 }
 142
 143
 144 // FIXME: Eliminate globals from tblgen.
 145 RecordKeeper llvm::Records;
 146
 147 static SourceMgr SrcMgr;
 148
 149 void llvm::PrintError(SMLoc ErrorLoc, const std::string &Msg) {
 150   SrcMgr.PrintMessage(ErrorLoc, Msg, "error");
 151 }
 152
 153
 154
 155 /// ParseFile - this function begins the parsing of the specified tablegen
 156 /// file.
 157 static bool ParseFile(const std::string &Filename,
 158                       const std::vector<std::string> &IncludeDirs,
 159                       SourceMgr &SrcMgr) {
 160   std::string ErrorStr;
 161   MemoryBuffer *F = MemoryBuffer::getFileOrSTDIN(Filename.c_str(), &ErrorStr);
 162   if (F == 0) {
 163     errs() << "Could not open input file '" << Filename << "': "
 164            << ErrorStr <<"\n";
 165     return true;
 166   }
 167
 168   // Tell SrcMgr about this buffer, which is what TGParser will pick up.
 169   SrcMgr.AddNewSourceBuffer(F, SMLoc());
 170
 171   // Record the location of the include directory so that the lexer can find
 172   // it later.
 173   SrcMgr.setIncludeDirs(IncludeDirs);
 174
 175   TGParser Parser(SrcMgr);
 176
 177   return Parser.ParseFile();
 178 }
 179
 180 int main(int argc, char **argv) {
 181   sys::PrintStackTraceOnErrorSignal();
 182   PrettyStackTraceProgram X(argc, argv);
 183   cl::ParseCommandLineOptions(argc, argv);
 184
 185
 186   // Parse the input file.
 187   if (ParseFile(InputFilename, IncludeDirs, SrcMgr))
 188     return 1;
 189
 190   raw_ostream *Out = &outs();
 191   if (OutputFilename != "-") {
 192     std::string Error;
 193     Out = new raw_fd_ostream(OutputFilename.c_str(), Error);
 194
 195     if (!Error.empty()) {
 196       errs() << argv[0] << ": error opening " << OutputFilename
 197              << ":" << Error << "\n";
 198       return 1;
 199     }
 200
 201     // Make sure the file gets removed if *gasp* tablegen crashes...
 202     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 203   }
 204
 205   try {
 206     switch (Action) {
 207     case PrintRecords:
 208       *Out << Records;           // No argument, dump all contents
 209       break;
 210     case GenEmitter:
 211       CodeEmitterGen(Records).run(*Out);
 212       break;
 213
 214     case GenRegisterEnums:
 215       RegisterInfoEmitter(Records).runEnums(*Out);
 216       break;
 217     case GenRegister:
 218       RegisterInfoEmitter(Records).run(*Out);
 219       break;
 220     case GenRegisterHeader:
 221       RegisterInfoEmitter(Records).runHeader(*Out);
 222       break;
 223     case GenInstrEnums:
 224       InstrEnumEmitter(Records).run(*Out);
 225       break;
 226     case GenInstrs:
 227       InstrInfoEmitter(Records).run(*Out);
 228       break;
 229     case GenCallingConv:
 230       CallingConvEmitter(Records).run(*Out);
 231       break;
 232     case GenAsmWriter:
 233       AsmWriterEmitter(Records).run(*Out);
 234       break;
 235     case GenARMDecoder:
 236       ARMDecoderEmitter(Records).run(*Out);
 237       break;
 238     case GenAsmMatcher:
 239       AsmMatcherEmitter(Records).run(*Out);
 240       break;
 241     case GenClangDiagsDefs:
 242       ClangDiagsDefsEmitter(Records, ClangComponent).run(*Out);
 243       break;
 244     case GenClangDiagGroups:
 245       ClangDiagGroupsEmitter(Records).run(*Out);
 246       break;
 247     case GenDisassembler:
 248       DisassemblerEmitter(Records).run(*Out);
 249       break;
 250     case GenOptParserDefs:
 251       OptParserEmitter(Records, true).run(*Out);
 252       break;
 253     case GenOptParserImpl:
 254       OptParserEmitter(Records, false).run(*Out);
 255       break;
 256     case GenDAGISel:
 257       DAGISelEmitter(Records).run(*Out);
 258       break;
 259     case GenFastISel:
 260       FastISelEmitter(Records).run(*Out);
 261       break;
 262     case GenSubtarget:
 263       SubtargetEmitter(Records).run(*Out);
 264       break;
 265     case GenIntrinsic:
 266       IntrinsicEmitter(Records).run(*Out);
 267       break;
 268     case GenTgtIntrinsic:
 269       IntrinsicEmitter(Records, true).run(*Out);
 270       break;
 271     case GenLLVMCConf:
 272       LLVMCConfigurationEmitter(Records).run(*Out);
 273       break;
 274     case GenEDHeader:
 275       EDEmitter(Records).runHeader(*Out);
 276       break;
 277     case GenEDInfo:
 278       EDEmitter(Records).run(*Out);
 279       break;
 280     case PrintEnums:
 281     {
 282       std::vector<Record*> Recs = Records.getAllDerivedDefinitions(Class);
 283       for (unsigned i = 0, e = Recs.size(); i != e; ++i)
 284         *Out << Recs[i]->getName() << ", ";
 285       *Out << "\n";
 286       break;
 287     }
 288     default:
 289       assert(1 && "Invalid Action");
 290       return 1;
 291     }
 292
 293     if (Out != &outs())
 294       delete Out;                               // Close the file
 295     return 0;
 296
 297   } catch (const TGError &Error) {
 298     errs() << argv[0] << ": error:\n";
 299     PrintError(Error.getLoc(), Error.getMessage());
 300
 301   } catch (const std::string &Error) {
 302     errs() << argv[0] << ": " << Error << "\n";
 303   } catch (const char *Error) {
 304     errs() << argv[0] << ": " << Error << "\n";
 305   } catch (...) {
 306     errs() << argv[0] << ": Unknown unexpected exception occurred.\n";
 307   }
 308
 309   if (Out != &outs()) {
 310     delete Out;                             // Close the file
 311     std::remove(OutputFilename.c_str());    // Remove the file, it's broken
 312   }
 313   return 1;
 314 }