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