1 //===- TableGen.cpp - Top-Level TableGen implementation for LLVM ----------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the main function for LLVM's TableGen.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "TableGenBackends.h" // Declares all backends.
14 #include "llvm/Support/CommandLine.h"
15 #include "llvm/Support/ManagedStatic.h"
16 #include "llvm/Support/PrettyStackTrace.h"
17 #include "llvm/Support/Signals.h"
18 #include "llvm/TableGen/Main.h"
19 #include "llvm/TableGen/Record.h"
20 #include "llvm/TableGen/SetTheory.h"
21 
22 using namespace llvm;
23 
24 enum ActionType {
25   PrintRecords,
26   DumpJSON,
27   GenEmitter,
28   GenRegisterInfo,
29   GenInstrInfo,
30   GenInstrDocs,
31   GenAsmWriter,
32   GenAsmMatcher,
33   GenDisassembler,
34   GenPseudoLowering,
35   GenCompressInst,
36   GenCallingConv,
37   GenDAGISel,
38   GenDFAPacketizer,
39   GenFastISel,
40   GenSubtarget,
41   GenIntrinsicEnums,
42   GenIntrinsicImpl,
43   PrintEnums,
44   PrintSets,
45   GenOptParserDefs,
46   GenOptRST,
47   GenCTags,
48   GenAttributes,
49   GenSearchableTables,
50   GenGlobalISel,
51   GenGICombiner,
52   GenX86EVEX2VEXTables,
53   GenX86FoldTables,
54   GenRegisterBank,
55   GenExegesis,
56   GenAutomata,
57 };
58 
59 namespace llvm {
60 /// Storage for TimeRegionsOpt as a global so that backends aren't required to
61 /// include CommandLine.h
62 bool TimeRegions = false;
63 cl::opt<bool> EmitLongStrLiterals(
64     "long-string-literals",
65     cl::desc("when emitting large string tables, prefer string literals over "
66              "comma-separated char literals. This can be a readability and "
67              "compile-time performance win, but upsets some compilers"),
68     cl::Hidden, cl::init(true));
69 } // end namespace llvm
70 
71 namespace {
72 cl::opt<ActionType> Action(
73     cl::desc("Action to perform:"),
74     cl::values(
75         clEnumValN(PrintRecords, "print-records",
76                    "Print all records to stdout (default)"),
77         clEnumValN(DumpJSON, "dump-json",
78                    "Dump all records as machine-readable JSON"),
79         clEnumValN(GenEmitter, "gen-emitter", "Generate machine code emitter"),
80         clEnumValN(GenRegisterInfo, "gen-register-info",
81                    "Generate registers and register classes info"),
82         clEnumValN(GenInstrInfo, "gen-instr-info",
83                    "Generate instruction descriptions"),
84         clEnumValN(GenInstrDocs, "gen-instr-docs",
85                    "Generate instruction documentation"),
86         clEnumValN(GenCallingConv, "gen-callingconv",
87                    "Generate calling convention descriptions"),
88         clEnumValN(GenAsmWriter, "gen-asm-writer", "Generate assembly writer"),
89         clEnumValN(GenDisassembler, "gen-disassembler",
90                    "Generate disassembler"),
91         clEnumValN(GenPseudoLowering, "gen-pseudo-lowering",
92                    "Generate pseudo instruction lowering"),
93         clEnumValN(GenCompressInst, "gen-compress-inst-emitter",
94                    "Generate RISCV compressed instructions."),
95         clEnumValN(GenAsmMatcher, "gen-asm-matcher",
96                    "Generate assembly instruction matcher"),
97         clEnumValN(GenDAGISel, "gen-dag-isel",
98                    "Generate a DAG instruction selector"),
99         clEnumValN(GenDFAPacketizer, "gen-dfa-packetizer",
100                    "Generate DFA Packetizer for VLIW targets"),
101         clEnumValN(GenFastISel, "gen-fast-isel",
102                    "Generate a \"fast\" instruction selector"),
103         clEnumValN(GenSubtarget, "gen-subtarget",
104                    "Generate subtarget enumerations"),
105         clEnumValN(GenIntrinsicEnums, "gen-intrinsic-enums",
106                    "Generate intrinsic enums"),
107         clEnumValN(GenIntrinsicImpl, "gen-intrinsic-impl",
108                    "Generate intrinsic information"),
109         clEnumValN(PrintEnums, "print-enums", "Print enum values for a class"),
110         clEnumValN(PrintSets, "print-sets",
111                    "Print expanded sets for testing DAG exprs"),
112         clEnumValN(GenOptParserDefs, "gen-opt-parser-defs",
113                    "Generate option definitions"),
114         clEnumValN(GenOptRST, "gen-opt-rst", "Generate option RST"),
115         clEnumValN(GenCTags, "gen-ctags", "Generate ctags-compatible index"),
116         clEnumValN(GenAttributes, "gen-attrs", "Generate attributes"),
117         clEnumValN(GenSearchableTables, "gen-searchable-tables",
118                    "Generate generic binary-searchable table"),
119         clEnumValN(GenGlobalISel, "gen-global-isel",
120                    "Generate GlobalISel selector"),
121         clEnumValN(GenGICombiner, "gen-global-isel-combiner",
122                    "Generate GlobalISel combiner"),
123         clEnumValN(GenX86EVEX2VEXTables, "gen-x86-EVEX2VEX-tables",
124                    "Generate X86 EVEX to VEX compress tables"),
125         clEnumValN(GenX86FoldTables, "gen-x86-fold-tables",
126                    "Generate X86 fold tables"),
127         clEnumValN(GenRegisterBank, "gen-register-bank",
128                    "Generate registers bank descriptions"),
129         clEnumValN(GenExegesis, "gen-exegesis",
130                    "Generate llvm-exegesis tables"),
131         clEnumValN(GenAutomata, "gen-automata", "Generate generic automata")));
132 
133 cl::OptionCategory PrintEnumsCat("Options for -print-enums");
134 cl::opt<std::string> Class("class", cl::desc("Print Enum list for this class"),
135                            cl::value_desc("class name"),
136                            cl::cat(PrintEnumsCat));
137 
138 cl::opt<bool, true>
139     TimeRegionsOpt("time-regions",
140                    cl::desc("Time regions of tablegens execution"),
141                    cl::location(TimeRegions));
142 
143 bool LLVMTableGenMain(raw_ostream &OS, RecordKeeper &Records) {
144   switch (Action) {
145   case PrintRecords:
146     OS << Records;           // No argument, dump all contents
147     break;
148   case DumpJSON:
149     EmitJSON(Records, OS);
150     break;
151   case GenEmitter:
152     EmitCodeEmitter(Records, OS);
153     break;
154   case GenRegisterInfo:
155     EmitRegisterInfo(Records, OS);
156     break;
157   case GenInstrInfo:
158     EmitInstrInfo(Records, OS);
159     break;
160   case GenInstrDocs:
161     EmitInstrDocs(Records, OS);
162     break;
163   case GenCallingConv:
164     EmitCallingConv(Records, OS);
165     break;
166   case GenAsmWriter:
167     EmitAsmWriter(Records, OS);
168     break;
169   case GenAsmMatcher:
170     EmitAsmMatcher(Records, OS);
171     break;
172   case GenDisassembler:
173     EmitDisassembler(Records, OS);
174     break;
175   case GenPseudoLowering:
176     EmitPseudoLowering(Records, OS);
177     break;
178   case GenCompressInst:
179     EmitCompressInst(Records, OS);
180     break;
181   case GenDAGISel:
182     EmitDAGISel(Records, OS);
183     break;
184   case GenDFAPacketizer:
185     EmitDFAPacketizer(Records, OS);
186     break;
187   case GenFastISel:
188     EmitFastISel(Records, OS);
189     break;
190   case GenSubtarget:
191     EmitSubtarget(Records, OS);
192     break;
193   case GenIntrinsicEnums:
194     EmitIntrinsicEnums(Records, OS);
195     break;
196   case GenIntrinsicImpl:
197     EmitIntrinsicImpl(Records, OS);
198     break;
199   case GenOptParserDefs:
200     EmitOptParser(Records, OS);
201     break;
202   case GenOptRST:
203     EmitOptRST(Records, OS);
204     break;
205   case PrintEnums:
206   {
207     for (Record *Rec : Records.getAllDerivedDefinitions(Class))
208       OS << Rec->getName() << ", ";
209     OS << "\n";
210     break;
211   }
212   case PrintSets:
213   {
214     SetTheory Sets;
215     Sets.addFieldExpander("Set", "Elements");
216     for (Record *Rec : Records.getAllDerivedDefinitions("Set")) {
217       OS << Rec->getName() << " = [";
218       const std::vector<Record*> *Elts = Sets.expand(Rec);
219       assert(Elts && "Couldn't expand Set instance");
220       for (Record *Elt : *Elts)
221         OS << ' ' << Elt->getName();
222       OS << " ]\n";
223     }
224     break;
225   }
226   case GenCTags:
227     EmitCTags(Records, OS);
228     break;
229   case GenAttributes:
230     EmitAttributes(Records, OS);
231     break;
232   case GenSearchableTables:
233     EmitSearchableTables(Records, OS);
234     break;
235   case GenGlobalISel:
236     EmitGlobalISel(Records, OS);
237     break;
238   case GenGICombiner:
239     EmitGICombiner(Records, OS);
240     break;
241   case GenRegisterBank:
242     EmitRegisterBank(Records, OS);
243     break;
244   case GenX86EVEX2VEXTables:
245     EmitX86EVEX2VEXTables(Records, OS);
246     break;
247   case GenX86FoldTables:
248     EmitX86FoldTables(Records, OS);
249     break;
250   case GenExegesis:
251     EmitExegesis(Records, OS);
252     break;
253   case GenAutomata:
254     EmitAutomata(Records, OS);
255     break;
256   }
257 
258   return false;
259 }
260 }
261 
262 int main(int argc, char **argv) {
263   sys::PrintStackTraceOnErrorSignal(argv[0]);
264   PrettyStackTraceProgram X(argc, argv);
265   cl::ParseCommandLineOptions(argc, argv);
266 
267   llvm_shutdown_obj Y;
268 
269   return TableGenMain(argv[0], &LLVMTableGenMain);
270 }
271 
272 #ifndef __has_feature
273 #define __has_feature(x) 0
274 #endif
275 
276 #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__) ||       \
277     __has_feature(leak_sanitizer)
278 
279 #include <sanitizer/lsan_interface.h>
280 // Disable LeakSanitizer for this binary as it has too many leaks that are not
281 // very interesting to fix. See compiler-rt/include/sanitizer/lsan_interface.h .
282 LLVM_ATTRIBUTE_USED int __lsan_is_turned_off() { return 1; }
283 
284 #endif
285