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 "SetTheory.h"
41 #include "TGParser.h"
42 #include "llvm/ADT/OwningPtr.h"
43 #include "llvm/Support/CommandLine.h"
44 #include "llvm/Support/MemoryBuffer.h"
45 #include "llvm/Support/PrettyStackTrace.h"
46 #include "llvm/Support/ToolOutputFile.h"
47 #include "llvm/Support/Signals.h"
48 #include "llvm/Support/system_error.h"
49 #include <algorithm>
50 #include <cstdio>
51 using namespace llvm;
52 
53 enum ActionType {
54   PrintRecords,
55   GenEmitter,
56   GenRegisterEnums, GenRegister, GenRegisterHeader,
57   GenInstrEnums, GenInstrs, GenAsmWriter, GenAsmMatcher,
58   GenARMDecoder,
59   GenDisassembler,
60   GenCallingConv,
61   GenClangAttrClasses,
62   GenClangAttrImpl,
63   GenClangAttrList,
64   GenClangAttrPCHRead,
65   GenClangAttrPCHWrite,
66   GenClangAttrSpellingList,
67   GenClangDiagsDefs,
68   GenClangDiagGroups,
69   GenClangDiagsIndexName,
70   GenClangDeclNodes,
71   GenClangStmtNodes,
72   GenClangSACheckers,
73   GenDAGISel,
74   GenFastISel,
75   GenOptParserDefs, GenOptParserImpl,
76   GenSubtarget,
77   GenIntrinsic,
78   GenTgtIntrinsic,
79   GenLLVMCConf,
80   GenEDInfo,
81   GenArmNeon,
82   GenArmNeonSema,
83   GenArmNeonTest,
84   PrintEnums,
85   PrintSets
86 };
87 
88 namespace {
89   cl::opt<ActionType>
90   Action(cl::desc("Action to perform:"),
91          cl::values(clEnumValN(PrintRecords, "print-records",
92                                "Print all records to stdout (default)"),
93                     clEnumValN(GenEmitter, "gen-emitter",
94                                "Generate machine code emitter"),
95                     clEnumValN(GenRegisterEnums, "gen-register-enums",
96                                "Generate enum values for registers"),
97                     clEnumValN(GenRegister, "gen-register-desc",
98                                "Generate a register info description"),
99                     clEnumValN(GenRegisterHeader, "gen-register-desc-header",
100                                "Generate a register info description header"),
101                     clEnumValN(GenInstrEnums, "gen-instr-enums",
102                                "Generate enum values for instructions"),
103                     clEnumValN(GenInstrs, "gen-instr-desc",
104                                "Generate instruction descriptions"),
105                     clEnumValN(GenCallingConv, "gen-callingconv",
106                                "Generate calling convention descriptions"),
107                     clEnumValN(GenAsmWriter, "gen-asm-writer",
108                                "Generate assembly writer"),
109                     clEnumValN(GenARMDecoder, "gen-arm-decoder",
110                                "Generate decoders for ARM/Thumb"),
111                     clEnumValN(GenDisassembler, "gen-disassembler",
112                                "Generate disassembler"),
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 static SourceMgr SrcMgr;
198 
199 void llvm::PrintError(SMLoc ErrorLoc, const Twine &Msg) {
200   SrcMgr.PrintMessage(ErrorLoc, Msg, "error");
201 }
202 
203 int main(int argc, char **argv) {
204   RecordKeeper Records;
205 
206   sys::PrintStackTraceOnErrorSignal();
207   PrettyStackTraceProgram X(argc, argv);
208   cl::ParseCommandLineOptions(argc, argv);
209 
210 
211   try {
212     // Parse the input file.
213     OwningPtr<MemoryBuffer> File;
214     if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str(), File)) {
215       errs() << "Could not open input file '" << InputFilename << "': "
216              << ec.message() <<"\n";
217       return 1;
218     }
219     MemoryBuffer *F = File.take();
220 
221     // Tell SrcMgr about this buffer, which is what TGParser will pick up.
222     SrcMgr.AddNewSourceBuffer(F, SMLoc());
223 
224     // Record the location of the include directory so that the lexer can find
225     // it later.
226     SrcMgr.setIncludeDirs(IncludeDirs);
227 
228     TGParser Parser(SrcMgr, Records);
229 
230     if (Parser.ParseFile())
231       return 1;
232 
233     std::string Error;
234     tool_output_file Out(OutputFilename.c_str(), Error);
235     if (!Error.empty()) {
236       errs() << argv[0] << ": error opening " << OutputFilename
237         << ":" << Error << "\n";
238       return 1;
239     }
240     if (!DependFilename.empty()) {
241       if (OutputFilename == "-") {
242         errs() << argv[0] << ": the option -d must be used together with -o\n";
243         return 1;
244       }
245       tool_output_file DepOut(DependFilename.c_str(), Error);
246       if (!Error.empty()) {
247         errs() << argv[0] << ": error opening " << DependFilename
248           << ":" << Error << "\n";
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 
270     case GenRegisterEnums:
271       RegisterInfoEmitter(Records).runEnums(Out.os());
272       break;
273     case GenRegister:
274       RegisterInfoEmitter(Records).run(Out.os());
275       break;
276     case GenRegisterHeader:
277       RegisterInfoEmitter(Records).runHeader(Out.os());
278       break;
279     case GenInstrEnums:
280       InstrEnumEmitter(Records).run(Out.os());
281       break;
282     case GenInstrs:
283       InstrInfoEmitter(Records).run(Out.os());
284       break;
285     case GenCallingConv:
286       CallingConvEmitter(Records).run(Out.os());
287       break;
288     case GenAsmWriter:
289       AsmWriterEmitter(Records).run(Out.os());
290       break;
291     case GenARMDecoder:
292       ARMDecoderEmitter(Records).run(Out.os());
293       break;
294     case GenAsmMatcher:
295       AsmMatcherEmitter(Records).run(Out.os());
296       break;
297     case GenClangAttrClasses:
298       ClangAttrClassEmitter(Records).run(Out.os());
299       break;
300     case GenClangAttrImpl:
301       ClangAttrImplEmitter(Records).run(Out.os());
302       break;
303     case GenClangAttrList:
304       ClangAttrListEmitter(Records).run(Out.os());
305       break;
306     case GenClangAttrPCHRead:
307       ClangAttrPCHReadEmitter(Records).run(Out.os());
308       break;
309     case GenClangAttrPCHWrite:
310       ClangAttrPCHWriteEmitter(Records).run(Out.os());
311       break;
312     case GenClangAttrSpellingList:
313       ClangAttrSpellingListEmitter(Records).run(Out.os());
314       break;
315     case GenClangDiagsDefs:
316       ClangDiagsDefsEmitter(Records, ClangComponent).run(Out.os());
317       break;
318     case GenClangDiagGroups:
319       ClangDiagGroupsEmitter(Records).run(Out.os());
320       break;
321     case GenClangDiagsIndexName:
322       ClangDiagsIndexNameEmitter(Records).run(Out.os());
323       break;
324     case GenClangDeclNodes:
325       ClangASTNodesEmitter(Records, "Decl", "Decl").run(Out.os());
326       ClangDeclContextEmitter(Records).run(Out.os());
327       break;
328     case GenClangStmtNodes:
329       ClangASTNodesEmitter(Records, "Stmt", "").run(Out.os());
330       break;
331     case GenClangSACheckers:
332       ClangSACheckersEmitter(Records).run(Out.os());
333       break;
334     case GenDisassembler:
335       DisassemblerEmitter(Records).run(Out.os());
336       break;
337     case GenOptParserDefs:
338       OptParserEmitter(Records, true).run(Out.os());
339       break;
340     case GenOptParserImpl:
341       OptParserEmitter(Records, false).run(Out.os());
342       break;
343     case GenDAGISel:
344       DAGISelEmitter(Records).run(Out.os());
345       break;
346     case GenFastISel:
347       FastISelEmitter(Records).run(Out.os());
348       break;
349     case GenSubtarget:
350       SubtargetEmitter(Records).run(Out.os());
351       break;
352     case GenIntrinsic:
353       IntrinsicEmitter(Records).run(Out.os());
354       break;
355     case GenTgtIntrinsic:
356       IntrinsicEmitter(Records, true).run(Out.os());
357       break;
358     case GenLLVMCConf:
359       LLVMCConfigurationEmitter(Records).run(Out.os());
360       break;
361     case GenEDInfo:
362       EDEmitter(Records).run(Out.os());
363       break;
364     case GenArmNeon:
365       NeonEmitter(Records).run(Out.os());
366       break;
367     case GenArmNeonSema:
368       NeonEmitter(Records).runHeader(Out.os());
369       break;
370     case GenArmNeonTest:
371       NeonEmitter(Records).runTests(Out.os());
372       break;
373     case PrintEnums:
374     {
375       std::vector<Record*> Recs = Records.getAllDerivedDefinitions(Class);
376       for (unsigned i = 0, e = Recs.size(); i != e; ++i)
377         Out.os() << Recs[i]->getName() << ", ";
378       Out.os() << "\n";
379       break;
380     }
381     case PrintSets:
382     {
383       SetTheory Sets;
384       Sets.addFieldExpander("Set", "Elements");
385       std::vector<Record*> Recs = Records.getAllDerivedDefinitions("Set");
386       for (unsigned i = 0, e = Recs.size(); i != e; ++i) {
387         Out.os() << Recs[i]->getName() << " = [";
388         const std::vector<Record*> *Elts = Sets.expand(Recs[i]);
389         assert(Elts && "Couldn't expand Set instance");
390         for (unsigned ei = 0, ee = Elts->size(); ei != ee; ++ei)
391           Out.os() << ' ' << (*Elts)[ei]->getName();
392         Out.os() << " ]\n";
393       }
394       break;
395     }
396     default:
397       assert(1 && "Invalid Action");
398       return 1;
399     }
400 
401     // Declare success.
402     Out.keep();
403     return 0;
404 
405   } catch (const TGError &Error) {
406     errs() << argv[0] << ": error:\n";
407     PrintError(Error.getLoc(), Error.getMessage());
408 
409   } catch (const std::string &Error) {
410     errs() << argv[0] << ": " << Error << "\n";
411   } catch (const char *Error) {
412     errs() << argv[0] << ": " << Error << "\n";
413   } catch (...) {
414     errs() << argv[0] << ": Unknown unexpected exception occurred.\n";
415   }
416 
417   return 1;
418 }
419