blob: 1c66399ce8b9fcd56bcfee8ce6f19c12ede6bad8 [file] [log] [blame]
Chris Lattner1d1adea2003-08-01 04:39:05 +00001//===- TableGen.cpp - Top-Level TableGen implementation -------------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
John Criswell01d45822003-10-20 20:20:30 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner30609102007-12-29 20:37:13 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
John Criswell01d45822003-10-20 20:20:30 +00008//===----------------------------------------------------------------------===//
Chris Lattner1d1adea2003-08-01 04:39:05 +00009//
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
Daniel Dunbard51ffcf2009-07-11 19:39:44 +000018#include "AsmMatcherEmitter.h"
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +000019#include "AsmWriterEmitter.h"
20#include "CallingConvEmitter.h"
21#include "ClangDiagnosticsEmitter.h"
22#include "CodeEmitterGen.h"
Chris Lattner4a24c642005-09-03 01:14:03 +000023#include "DAGISelEmitter.h"
Daniel Dunbar40588742009-11-25 02:13:23 +000024#include "DisassemblerEmitter.h"
Sean Callanan95fcebd2010-01-29 00:21:04 +000025#include "EDEmitter.h"
Dan Gohmanb0cf29c2008-08-13 20:19:35 +000026#include "FastISelEmitter.h"
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +000027#include "InstrEnumEmitter.h"
28#include "InstrInfoEmitter.h"
Chris Lattner9e493cf2006-03-03 02:32:46 +000029#include "IntrinsicEmitter.h"
Mikhail Glushenkovecbdcf22008-05-06 18:09:29 +000030#include "LLVMCConfigurationEmitter.h"
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +000031#include "OptParserEmitter.h"
32#include "Record.h"
33#include "RegisterInfoEmitter.h"
Johnny Chenb68a3ee2010-04-02 22:27:38 +000034#include "ARMDecoderEmitter.h"
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +000035#include "SubtargetEmitter.h"
36#include "TGParser.h"
Chris Lattner81cb8ca2009-07-08 18:44:05 +000037#include "llvm/Support/CommandLine.h"
Chris Lattner81cb8ca2009-07-08 18:44:05 +000038#include "llvm/Support/MemoryBuffer.h"
39#include "llvm/Support/PrettyStackTrace.h"
40#include "llvm/Support/raw_ostream.h"
41#include "llvm/System/Signals.h"
Chris Lattnere62c1182002-12-02 01:23:04 +000042#include <algorithm>
Misha Brukmanc3fe45b2003-08-14 16:05:35 +000043#include <cstdio>
Chris Lattner2082ebe2004-08-01 03:55:39 +000044using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000045
Chris Lattnerbc520132003-06-03 04:56:29 +000046enum ActionType {
47 PrintRecords,
48 GenEmitter,
Chris Lattner54d156d2003-08-01 05:59:20 +000049 GenRegisterEnums, GenRegister, GenRegisterHeader,
Daniel Dunbard51ffcf2009-07-11 19:39:44 +000050 GenInstrEnums, GenInstrs, GenAsmWriter, GenAsmMatcher,
Johnny Chenb68a3ee2010-04-02 22:27:38 +000051 GenARMDecoder,
Daniel Dunbar40588742009-11-25 02:13:23 +000052 GenDisassembler,
Chris Lattner50d45652007-02-27 22:08:27 +000053 GenCallingConv,
Ted Kremenek04a847e2009-03-13 22:21:17 +000054 GenClangDiagsDefs,
Chris Lattnerac9e7da2009-04-15 20:02:32 +000055 GenClangDiagGroups,
Chris Lattner4a24c642005-09-03 01:14:03 +000056 GenDAGISel,
Dan Gohmanb0cf29c2008-08-13 20:19:35 +000057 GenFastISel,
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +000058 GenOptParserDefs, GenOptParserImpl,
Jim Laskeyf5fc2cb2005-10-21 19:05:19 +000059 GenSubtarget,
Chris Lattner9e493cf2006-03-03 02:32:46 +000060 GenIntrinsic,
Dale Johannesen49de9822009-02-05 01:49:45 +000061 GenTgtIntrinsic,
Mikhail Glushenkov895820d2008-05-06 18:12:03 +000062 GenLLVMCConf,
Sean Callanan95fcebd2010-01-29 00:21:04 +000063 GenEDHeader, GenEDInfo,
Chris Lattner3b239722006-03-03 02:34:28 +000064 PrintEnums
Chris Lattnerbc520132003-06-03 04:56:29 +000065};
66
67namespace {
68 cl::opt<ActionType>
69 Action(cl::desc("Action to perform:"),
70 cl::values(clEnumValN(PrintRecords, "print-records",
Chris Lattner85df2252003-06-03 05:07:28 +000071 "Print all records to stdout (default)"),
Chris Lattnerbc520132003-06-03 04:56:29 +000072 clEnumValN(GenEmitter, "gen-emitter",
73 "Generate machine code emitter"),
Chris Lattner54d156d2003-08-01 05:59:20 +000074 clEnumValN(GenRegisterEnums, "gen-register-enums",
75 "Generate enum values for registers"),
Chris Lattner1d1adea2003-08-01 04:39:05 +000076 clEnumValN(GenRegister, "gen-register-desc",
77 "Generate a register info description"),
78 clEnumValN(GenRegisterHeader, "gen-register-desc-header",
79 "Generate a register info description header"),
Chris Lattner169e66b2003-08-03 17:24:20 +000080 clEnumValN(GenInstrEnums, "gen-instr-enums",
81 "Generate enum values for instructions"),
Chris Lattner15de32d2003-08-03 21:58:28 +000082 clEnumValN(GenInstrs, "gen-instr-desc",
83 "Generate instruction descriptions"),
Chris Lattner50d45652007-02-27 22:08:27 +000084 clEnumValN(GenCallingConv, "gen-callingconv",
85 "Generate calling convention descriptions"),
Chris Lattner2e1f51b2004-08-01 05:59:33 +000086 clEnumValN(GenAsmWriter, "gen-asm-writer",
87 "Generate assembly writer"),
Johnny Chenb68a3ee2010-04-02 22:27:38 +000088 clEnumValN(GenARMDecoder, "gen-arm-decoder",
89 "Generate decoders for ARM/Thumb"),
Daniel Dunbar40588742009-11-25 02:13:23 +000090 clEnumValN(GenDisassembler, "gen-disassembler",
91 "Generate disassembler"),
Daniel Dunbard51ffcf2009-07-11 19:39:44 +000092 clEnumValN(GenAsmMatcher, "gen-asm-matcher",
93 "Generate assembly instruction matcher"),
Chris Lattner4a24c642005-09-03 01:14:03 +000094 clEnumValN(GenDAGISel, "gen-dag-isel",
95 "Generate a DAG instruction selector"),
Dan Gohmanb0cf29c2008-08-13 20:19:35 +000096 clEnumValN(GenFastISel, "gen-fast-isel",
97 "Generate a \"fast\" instruction selector"),
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +000098 clEnumValN(GenOptParserDefs, "gen-opt-parser-defs",
99 "Generate option definitions"),
100 clEnumValN(GenOptParserImpl, "gen-opt-parser-impl",
101 "Generate option parser implementation"),
Jim Laskeyf5fc2cb2005-10-21 19:05:19 +0000102 clEnumValN(GenSubtarget, "gen-subtarget",
103 "Generate subtarget enumerations"),
Chris Lattner9e493cf2006-03-03 02:32:46 +0000104 clEnumValN(GenIntrinsic, "gen-intrinsic",
105 "Generate intrinsic information"),
Dale Johannesen49de9822009-02-05 01:49:45 +0000106 clEnumValN(GenTgtIntrinsic, "gen-tgt-intrinsic",
107 "Generate target intrinsic information"),
Ted Kremenek04a847e2009-03-13 22:21:17 +0000108 clEnumValN(GenClangDiagsDefs, "gen-clang-diags-defs",
109 "Generate Clang diagnostics definitions"),
Chris Lattnerac9e7da2009-04-15 20:02:32 +0000110 clEnumValN(GenClangDiagGroups, "gen-clang-diag-groups",
111 "Generate Clang diagnostic groups"),
Mikhail Glushenkov895820d2008-05-06 18:12:03 +0000112 clEnumValN(GenLLVMCConf, "gen-llvmc",
113 "Generate LLVMC configuration library"),
Sean Callanan95fcebd2010-01-29 00:21:04 +0000114 clEnumValN(GenEDHeader, "gen-enhanced-disassembly-header",
115 "Generate enhanced disassembly info header"),
116 clEnumValN(GenEDInfo, "gen-enhanced-disassembly-info",
117 "Generate enhanced disassembly info"),
Chris Lattnerbc520132003-06-03 04:56:29 +0000118 clEnumValN(PrintEnums, "print-enums",
119 "Print enum values for a class"),
Chris Lattnerbd935332004-07-16 00:02:21 +0000120 clEnumValEnd));
Chris Lattnerbc520132003-06-03 04:56:29 +0000121
122 cl::opt<std::string>
Chris Lattner85df2252003-06-03 05:07:28 +0000123 Class("class", cl::desc("Print Enum list for this class"),
124 cl::value_desc("class name"));
Chris Lattner9a886382003-06-03 05:04:42 +0000125
Chris Lattner90523902003-07-30 19:48:02 +0000126 cl::opt<std::string>
127 OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"),
128 cl::init("-"));
129
130 cl::opt<std::string>
131 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
John Criswell96b4bed2003-08-27 13:41:57 +0000132
Chris Lattnerd9f5d902006-03-03 01:47:14 +0000133 cl::list<std::string>
134 IncludeDirs("I", cl::desc("Directory of include files"),
Chris Lattnered542412006-03-03 01:53:40 +0000135 cl::value_desc("directory"), cl::Prefix);
Ted Kremenek557f7f82009-03-13 22:53:41 +0000136
137 cl::opt<std::string>
138 ClangComponent("clang-component",
139 cl::desc("Only use warnings from specified component"),
140 cl::value_desc("component"), cl::Hidden);
Chris Lattnerbc520132003-06-03 04:56:29 +0000141}
142
Chris Lattner7b9ffe42009-03-13 16:09:24 +0000143
144// FIXME: Eliminate globals from tblgen.
Chris Lattner2082ebe2004-08-01 03:55:39 +0000145RecordKeeper llvm::Records;
Chris Lattnere62c1182002-12-02 01:23:04 +0000146
Chris Lattner8070ea32009-06-21 03:41:50 +0000147static SourceMgr SrcMgr;
Chris Lattner7b9ffe42009-03-13 16:09:24 +0000148
Chris Lattner1e3a8a42009-06-21 03:39:35 +0000149void llvm::PrintError(SMLoc ErrorLoc, const std::string &Msg) {
Daniel Dunbar3fb76832009-06-30 00:49:23 +0000150 SrcMgr.PrintMessage(ErrorLoc, Msg, "error");
Chris Lattner7b9ffe42009-03-13 16:09:24 +0000151}
152
153
154
Chris Lattnerf4601652007-11-22 20:49:04 +0000155/// ParseFile - this function begins the parsing of the specified tablegen
156/// file.
Mikhail Glushenkovecbdcf22008-05-06 18:09:29 +0000157static bool ParseFile(const std::string &Filename,
Chris Lattneraa739d22009-03-13 07:05:43 +0000158 const std::vector<std::string> &IncludeDirs,
Chris Lattner8070ea32009-06-21 03:41:50 +0000159 SourceMgr &SrcMgr) {
Chris Lattnerf4601652007-11-22 20:49:04 +0000160 std::string ErrorStr;
Chris Lattner038112a2008-04-01 18:04:03 +0000161 MemoryBuffer *F = MemoryBuffer::getFileOrSTDIN(Filename.c_str(), &ErrorStr);
Chris Lattnerf4601652007-11-22 20:49:04 +0000162 if (F == 0) {
Chris Lattner81cb8ca2009-07-08 18:44:05 +0000163 errs() << "Could not open input file '" << Filename << "': "
Daniel Dunbar1a551802009-07-03 00:10:29 +0000164 << ErrorStr <<"\n";
Chris Lattnerf4601652007-11-22 20:49:04 +0000165 return true;
166 }
Chris Lattneraa739d22009-03-13 07:05:43 +0000167
168 // Tell SrcMgr about this buffer, which is what TGParser will pick up.
Chris Lattner1e3a8a42009-06-21 03:39:35 +0000169 SrcMgr.AddNewSourceBuffer(F, SMLoc());
Mikhail Glushenkovecbdcf22008-05-06 18:09:29 +0000170
Chris Lattnerf4601652007-11-22 20:49:04 +0000171 // Record the location of the include directory so that the lexer can find
172 // it later.
Chris Lattner7ee5d5f2009-06-21 05:06:04 +0000173 SrcMgr.setIncludeDirs(IncludeDirs);
174
175 TGParser Parser(SrcMgr);
Mikhail Glushenkovecbdcf22008-05-06 18:09:29 +0000176
Chris Lattnerf4601652007-11-22 20:49:04 +0000177 return Parser.ParseFile();
178}
179
Chris Lattnere62c1182002-12-02 01:23:04 +0000180int main(int argc, char **argv) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000181 sys::PrintStackTraceOnErrorSignal();
182 PrettyStackTraceProgram X(argc, argv);
Chris Lattnere62c1182002-12-02 01:23:04 +0000183 cl::ParseCommandLineOptions(argc, argv);
Chris Lattnerf4601652007-11-22 20:49:04 +0000184
Chris Lattneraa739d22009-03-13 07:05:43 +0000185
Chris Lattnerf4601652007-11-22 20:49:04 +0000186 // Parse the input file.
Chris Lattneraa739d22009-03-13 07:05:43 +0000187 if (ParseFile(InputFilename, IncludeDirs, SrcMgr))
Chris Lattnerf4601652007-11-22 20:49:04 +0000188 return 1;
Chris Lattnere62c1182002-12-02 01:23:04 +0000189
Daniel Dunbar1a551802009-07-03 00:10:29 +0000190 raw_ostream *Out = &outs();
Chris Lattner9a886382003-06-03 05:04:42 +0000191 if (OutputFilename != "-") {
Daniel Dunbar1a551802009-07-03 00:10:29 +0000192 std::string Error;
Dan Gohmanbaa26392009-08-25 15:34:52 +0000193 Out = new raw_fd_ostream(OutputFilename.c_str(), Error);
Chris Lattner9a886382003-06-03 05:04:42 +0000194
Daniel Dunbar1a551802009-07-03 00:10:29 +0000195 if (!Error.empty()) {
196 errs() << argv[0] << ": error opening " << OutputFilename
197 << ":" << Error << "\n";
Chris Lattner9a886382003-06-03 05:04:42 +0000198 return 1;
199 }
200
201 // Make sure the file gets removed if *gasp* tablegen crashes...
Reid Spencer227b6d02004-11-14 22:30:54 +0000202 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
Chris Lattner9a886382003-06-03 05:04:42 +0000203 }
204
Chris Lattner1d1adea2003-08-01 04:39:05 +0000205 try {
206 switch (Action) {
Chris Lattneraccd8ab2003-08-01 04:47:20 +0000207 case PrintRecords:
208 *Out << Records; // No argument, dump all contents
209 break;
Chris Lattner1d1adea2003-08-01 04:39:05 +0000210 case GenEmitter:
211 CodeEmitterGen(Records).run(*Out);
212 break;
Chris Lattner169e66b2003-08-03 17:24:20 +0000213
Chris Lattner54d156d2003-08-01 05:59:20 +0000214 case GenRegisterEnums:
215 RegisterInfoEmitter(Records).runEnums(*Out);
216 break;
Chris Lattner1d1adea2003-08-01 04:39:05 +0000217 case GenRegister:
218 RegisterInfoEmitter(Records).run(*Out);
219 break;
220 case GenRegisterHeader:
221 RegisterInfoEmitter(Records).runHeader(*Out);
222 break;
Chris Lattner169e66b2003-08-03 17:24:20 +0000223 case GenInstrEnums:
Chris Lattner7b117122008-01-06 00:49:05 +0000224 InstrEnumEmitter(Records).run(*Out);
Chris Lattner169e66b2003-08-03 17:24:20 +0000225 break;
Chris Lattner15de32d2003-08-03 21:58:28 +0000226 case GenInstrs:
227 InstrInfoEmitter(Records).run(*Out);
228 break;
Chris Lattner50d45652007-02-27 22:08:27 +0000229 case GenCallingConv:
230 CallingConvEmitter(Records).run(*Out);
231 break;
Chris Lattner2e1f51b2004-08-01 05:59:33 +0000232 case GenAsmWriter:
233 AsmWriterEmitter(Records).run(*Out);
234 break;
Johnny Chenb68a3ee2010-04-02 22:27:38 +0000235 case GenARMDecoder:
236 ARMDecoderEmitter(Records).run(*Out);
237 break;
Daniel Dunbard51ffcf2009-07-11 19:39:44 +0000238 case GenAsmMatcher:
239 AsmMatcherEmitter(Records).run(*Out);
240 break;
Ted Kremenek04a847e2009-03-13 22:21:17 +0000241 case GenClangDiagsDefs:
Ted Kremenek557f7f82009-03-13 22:53:41 +0000242 ClangDiagsDefsEmitter(Records, ClangComponent).run(*Out);
Ted Kremenek04a847e2009-03-13 22:21:17 +0000243 break;
Chris Lattnerac9e7da2009-04-15 20:02:32 +0000244 case GenClangDiagGroups:
245 ClangDiagGroupsEmitter(Records).run(*Out);
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +0000246 break;
Daniel Dunbar40588742009-11-25 02:13:23 +0000247 case GenDisassembler:
248 DisassemblerEmitter(Records).run(*Out);
249 break;
Daniel Dunbar2d6a8fb2009-11-18 21:29:51 +0000250 case GenOptParserDefs:
251 OptParserEmitter(Records, true).run(*Out);
252 break;
253 case GenOptParserImpl:
254 OptParserEmitter(Records, false).run(*Out);
255 break;
Chris Lattner4a24c642005-09-03 01:14:03 +0000256 case GenDAGISel:
257 DAGISelEmitter(Records).run(*Out);
258 break;
Dan Gohmanb0cf29c2008-08-13 20:19:35 +0000259 case GenFastISel:
260 FastISelEmitter(Records).run(*Out);
261 break;
Jim Laskeyf5fc2cb2005-10-21 19:05:19 +0000262 case GenSubtarget:
263 SubtargetEmitter(Records).run(*Out);
264 break;
Chris Lattner9e493cf2006-03-03 02:32:46 +0000265 case GenIntrinsic:
266 IntrinsicEmitter(Records).run(*Out);
267 break;
Dale Johannesen49de9822009-02-05 01:49:45 +0000268 case GenTgtIntrinsic:
269 IntrinsicEmitter(Records, true).run(*Out);
270 break;
Mikhail Glushenkov895820d2008-05-06 18:12:03 +0000271 case GenLLVMCConf:
272 LLVMCConfigurationEmitter(Records).run(*Out);
Anton Korobeynikovac67b7e2008-03-23 08:57:20 +0000273 break;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000274 case GenEDHeader:
275 EDEmitter(Records).runHeader(*Out);
276 break;
277 case GenEDInfo:
278 EDEmitter(Records).run(*Out);
279 break;
Chris Lattner1d1adea2003-08-01 04:39:05 +0000280 case PrintEnums:
Brian Gaeked0fde302003-11-11 22:41:34 +0000281 {
Chris Lattner1d1adea2003-08-01 04:39:05 +0000282 std::vector<Record*> Recs = Records.getAllDerivedDefinitions(Class);
Chris Lattner1d1adea2003-08-01 04:39:05 +0000283 for (unsigned i = 0, e = Recs.size(); i != e; ++i)
Chris Lattner7b9ee512004-02-06 03:19:17 +0000284 *Out << Recs[i]->getName() << ", ";
Chris Lattner1d1adea2003-08-01 04:39:05 +0000285 *Out << "\n";
286 break;
Chris Lattnere62c1182002-12-02 01:23:04 +0000287 }
Brian Gaeked0fde302003-11-11 22:41:34 +0000288 default:
289 assert(1 && "Invalid Action");
290 return 1;
291 }
Chris Lattnera14b1de2009-03-13 16:25:21 +0000292
Daniel Dunbar1a551802009-07-03 00:10:29 +0000293 if (Out != &outs())
Chris Lattnera14b1de2009-03-13 16:25:21 +0000294 delete Out; // Close the file
295 return 0;
296
297 } catch (const TGError &Error) {
Daniel Dunbar1a551802009-07-03 00:10:29 +0000298 errs() << argv[0] << ": error:\n";
Chris Lattnera14b1de2009-03-13 16:25:21 +0000299 PrintError(Error.getLoc(), Error.getMessage());
300
Chris Lattner1d1adea2003-08-01 04:39:05 +0000301 } catch (const std::string &Error) {
Daniel Dunbar1a551802009-07-03 00:10:29 +0000302 errs() << argv[0] << ": " << Error << "\n";
Dan Gohman212e6982008-11-07 21:01:13 +0000303 } catch (const char *Error) {
Daniel Dunbar1a551802009-07-03 00:10:29 +0000304 errs() << argv[0] << ": " << Error << "\n";
Reid Spencer23f7d512004-09-03 23:17:54 +0000305 } catch (...) {
Daniel Dunbar1a551802009-07-03 00:10:29 +0000306 errs() << argv[0] << ": Unknown unexpected exception occurred.\n";
Chris Lattnere62c1182002-12-02 01:23:04 +0000307 }
Chris Lattnera14b1de2009-03-13 16:25:21 +0000308
Daniel Dunbar1a551802009-07-03 00:10:29 +0000309 if (Out != &outs()) {
Chris Lattnera14b1de2009-03-13 16:25:21 +0000310 delete Out; // Close the file
311 std::remove(OutputFilename.c_str()); // Remove the file, it's broken
Chris Lattnere79c72d2003-08-01 20:35:01 +0000312 }
Chris Lattnera14b1de2009-03-13 16:25:21 +0000313 return 1;
Chris Lattnere62c1182002-12-02 01:23:04 +0000314}