1 //===- TableGen.cpp - Top-Level TableGen implementation for LLVM ----------===//
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
7 //===----------------------------------------------------------------------===//
9 // This file contains the main function for LLVM's TableGen.
11 //===----------------------------------------------------------------------===//
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"
60 /// Storage for TimeRegionsOpt as a global so that backends aren't required to
61 /// include CommandLine.h
62 bool TimeRegions = false;
63 } // end namespace llvm
66 cl::opt<ActionType> Action(
67 cl::desc("Action to perform:"),
69 clEnumValN(PrintRecords, "print-records",
70 "Print all records to stdout (default)"),
71 clEnumValN(DumpJSON, "dump-json",
72 "Dump all records as machine-readable JSON"),
73 clEnumValN(GenEmitter, "gen-emitter", "Generate machine code emitter"),
74 clEnumValN(GenRegisterInfo, "gen-register-info",
75 "Generate registers and register classes info"),
76 clEnumValN(GenInstrInfo, "gen-instr-info",
77 "Generate instruction descriptions"),
78 clEnumValN(GenInstrDocs, "gen-instr-docs",
79 "Generate instruction documentation"),
80 clEnumValN(GenCallingConv, "gen-callingconv",
81 "Generate calling convention descriptions"),
82 clEnumValN(GenAsmWriter, "gen-asm-writer", "Generate assembly writer"),
83 clEnumValN(GenDisassembler, "gen-disassembler",
84 "Generate disassembler"),
85 clEnumValN(GenPseudoLowering, "gen-pseudo-lowering",
86 "Generate pseudo instruction lowering"),
87 clEnumValN(GenCompressInst, "gen-compress-inst-emitter",
88 "Generate RISCV compressed instructions."),
89 clEnumValN(GenAsmMatcher, "gen-asm-matcher",
90 "Generate assembly instruction matcher"),
91 clEnumValN(GenDAGISel, "gen-dag-isel",
92 "Generate a DAG instruction selector"),
93 clEnumValN(GenDFAPacketizer, "gen-dfa-packetizer",
94 "Generate DFA Packetizer for VLIW targets"),
95 clEnumValN(GenFastISel, "gen-fast-isel",
96 "Generate a \"fast\" instruction selector"),
97 clEnumValN(GenSubtarget, "gen-subtarget",
98 "Generate subtarget enumerations"),
99 clEnumValN(GenIntrinsicEnums, "gen-intrinsic-enums",
100 "Generate intrinsic enums"),
101 clEnumValN(GenIntrinsicImpl, "gen-intrinsic-impl",
102 "Generate intrinsic information"),
103 clEnumValN(PrintEnums, "print-enums", "Print enum values for a class"),
104 clEnumValN(PrintSets, "print-sets",
105 "Print expanded sets for testing DAG exprs"),
106 clEnumValN(GenOptParserDefs, "gen-opt-parser-defs",
107 "Generate option definitions"),
108 clEnumValN(GenOptRST, "gen-opt-rst", "Generate option RST"),
109 clEnumValN(GenCTags, "gen-ctags", "Generate ctags-compatible index"),
110 clEnumValN(GenAttributes, "gen-attrs", "Generate attributes"),
111 clEnumValN(GenSearchableTables, "gen-searchable-tables",
112 "Generate generic binary-searchable table"),
113 clEnumValN(GenGlobalISel, "gen-global-isel",
114 "Generate GlobalISel selector"),
115 clEnumValN(GenGICombiner, "gen-global-isel-combiner",
116 "Generate GlobalISel combiner"),
117 clEnumValN(GenX86EVEX2VEXTables, "gen-x86-EVEX2VEX-tables",
118 "Generate X86 EVEX to VEX compress tables"),
119 clEnumValN(GenX86FoldTables, "gen-x86-fold-tables",
120 "Generate X86 fold tables"),
121 clEnumValN(GenRegisterBank, "gen-register-bank",
122 "Generate registers bank descriptions"),
123 clEnumValN(GenExegesis, "gen-exegesis",
124 "Generate llvm-exegesis tables"),
125 clEnumValN(GenAutomata, "gen-automata", "Generate generic automata")));
127 cl::OptionCategory PrintEnumsCat("Options for -print-enums");
128 cl::opt<std::string> Class("class", cl::desc("Print Enum list for this class"),
129 cl::value_desc("class name"),
130 cl::cat(PrintEnumsCat));
133 TimeRegionsOpt("time-regions",
134 cl::desc("Time regions of tablegens execution"),
135 cl::location(TimeRegions));
137 bool LLVMTableGenMain(raw_ostream &OS, RecordKeeper &Records) {
140 OS << Records; // No argument, dump all contents
143 EmitJSON(Records, OS);
146 EmitCodeEmitter(Records, OS);
148 case GenRegisterInfo:
149 EmitRegisterInfo(Records, OS);
152 EmitInstrInfo(Records, OS);
155 EmitInstrDocs(Records, OS);
158 EmitCallingConv(Records, OS);
161 EmitAsmWriter(Records, OS);
164 EmitAsmMatcher(Records, OS);
166 case GenDisassembler:
167 EmitDisassembler(Records, OS);
169 case GenPseudoLowering:
170 EmitPseudoLowering(Records, OS);
172 case GenCompressInst:
173 EmitCompressInst(Records, OS);
176 EmitDAGISel(Records, OS);
178 case GenDFAPacketizer:
179 EmitDFAPacketizer(Records, OS);
182 EmitFastISel(Records, OS);
185 EmitSubtarget(Records, OS);
187 case GenIntrinsicEnums:
188 EmitIntrinsicEnums(Records, OS);
190 case GenIntrinsicImpl:
191 EmitIntrinsicImpl(Records, OS);
193 case GenOptParserDefs:
194 EmitOptParser(Records, OS);
197 EmitOptRST(Records, OS);
201 for (Record *Rec : Records.getAllDerivedDefinitions(Class))
202 OS << Rec->getName() << ", ";
209 Sets.addFieldExpander("Set", "Elements");
210 for (Record *Rec : Records.getAllDerivedDefinitions("Set")) {
211 OS << Rec->getName() << " = [";
212 const std::vector<Record*> *Elts = Sets.expand(Rec);
213 assert(Elts && "Couldn't expand Set instance");
214 for (Record *Elt : *Elts)
215 OS << ' ' << Elt->getName();
221 EmitCTags(Records, OS);
224 EmitAttributes(Records, OS);
226 case GenSearchableTables:
227 EmitSearchableTables(Records, OS);
230 EmitGlobalISel(Records, OS);
233 EmitGICombiner(Records, OS);
235 case GenRegisterBank:
236 EmitRegisterBank(Records, OS);
238 case GenX86EVEX2VEXTables:
239 EmitX86EVEX2VEXTables(Records, OS);
241 case GenX86FoldTables:
242 EmitX86FoldTables(Records, OS);
245 EmitExegesis(Records, OS);
248 EmitAutomata(Records, OS);
256 int main(int argc, char **argv) {
257 sys::PrintStackTraceOnErrorSignal(argv[0]);
258 PrettyStackTraceProgram X(argc, argv);
259 cl::ParseCommandLineOptions(argc, argv);
263 return TableGenMain(argv[0], &LLVMTableGenMain);
266 #ifndef __has_feature
267 #define __has_feature(x) 0
270 #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__) || \
271 __has_feature(leak_sanitizer)
273 #include <sanitizer/lsan_interface.h>
274 // Disable LeakSanitizer for this binary as it has too many leaks that are not
275 // very interesting to fix. See compiler-rt/include/sanitizer/lsan_interface.h .
276 LLVM_ATTRIBUTE_USED int __lsan_is_turned_off() { return 1; }