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