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