1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
| //=== ClangOpcodesEmitter.cpp - constexpr interpreter opcodes ---*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// These tablegen backends emit Clang AST node tables
//
//===----------------------------------------------------------------------===//
#include "TableGenBackends.h"
#include "llvm/TableGen/Error.h"
#include "llvm/TableGen/Record.h"
#include "llvm/TableGen/StringMatcher.h"
#include "llvm/TableGen/TableGenBackend.h"
using namespace llvm;
namespace {
class ClangOpcodesEmitter {
RecordKeeper &Records;
Record Root;
unsigned NumTypes;
public:
ClangOpcodesEmitter(RecordKeeper &R)
: Records(R), Root("Opcode", SMLoc(), R),
NumTypes(Records.getAllDerivedDefinitions("Type").size()) {}
void run(raw_ostream &OS);
private:
/// Emits the opcode name for the opcode enum.
/// The name is obtained by concatenating the name with the list of types.
void EmitEnum(raw_ostream &OS, StringRef N, Record *R);
/// Emits the switch case and the invocation in the interpreter.
void EmitInterp(raw_ostream &OS, StringRef N, Record *R);
/// Emits the disassembler.
void EmitDisasm(raw_ostream &OS, StringRef N, Record *R);
/// Emits the byte code emitter method.
void EmitEmitter(raw_ostream &OS, StringRef N, Record *R);
/// Emits the prototype.
void EmitProto(raw_ostream &OS, StringRef N, Record *R);
/// Emits the prototype to dispatch from a type.
void EmitGroup(raw_ostream &OS, StringRef N, Record *R);
/// Emits the evaluator method.
void EmitEval(raw_ostream &OS, StringRef N, Record *R);
void PrintTypes(raw_ostream &OS, ArrayRef<Record *> Types);
};
void Enumerate(const Record *R,
StringRef N,
std::function<void(ArrayRef<Record *>, Twine)> &&F) {
llvm::SmallVector<Record *, 2> TypePath;
auto *Types = R->getValueAsListInit("Types");
std::function<void(size_t, const Twine &)> Rec;
Rec = [&TypePath, Types, &Rec, &F](size_t I, const Twine &ID) {
if (I >= Types->size()) {
F(TypePath, ID);
return;
}
if (auto *TypeClass = dyn_cast<DefInit>(Types->getElement(I))) {
for (auto *Type : TypeClass->getDef()->getValueAsListOfDefs("Types")) {
TypePath.push_back(Type);
Rec(I + 1, ID + Type->getName());
TypePath.pop_back();
}
} else {
PrintFatalError("Expected a type class");
}
};
Rec(0, N);
}
} // namespace
void ClangOpcodesEmitter::run(raw_ostream &OS) {
for (auto *Opcode : Records.getAllDerivedDefinitions(Root.getName())) {
// The name is the record name, unless overriden.
StringRef N = Opcode->getValueAsString("Name");
if (N.empty())
N = Opcode->getName();
EmitEnum(OS, N, Opcode);
EmitInterp(OS, N, Opcode);
EmitDisasm(OS, N, Opcode);
EmitProto(OS, N, Opcode);
EmitGroup(OS, N, Opcode);
EmitEmitter(OS, N, Opcode);
EmitEval(OS, N, Opcode);
}
}
void ClangOpcodesEmitter::EmitEnum(raw_ostream &OS, StringRef N, Record *R) {
OS << "#ifdef GET_OPCODE_NAMES\n";
Enumerate(R, N, [&OS](ArrayRef<Record *>, const Twine &ID) {
OS << "OP_" << ID << ",\n";
});
OS << "#endif\n";
}
void ClangOpcodesEmitter::EmitInterp(raw_ostream &OS, StringRef N, Record *R) {
OS << "#ifdef GET_INTERP\n";
Enumerate(R, N, [this, R, &OS, &N](ArrayRef<Record *> TS, const Twine &ID) {
bool CanReturn = R->getValueAsBit("CanReturn");
bool ChangesPC = R->getValueAsBit("ChangesPC");
auto Args = R->getValueAsListOfDefs("Args");
OS << "case OP_" << ID << ": {\n";
// Emit calls to read arguments.
for (size_t I = 0, N = Args.size(); I < N; ++I) {
OS << "\tauto V" << I;
OS << " = ";
OS << "PC.read<" << Args[I]->getValueAsString("Name") << ">();\n";
}
// Emit a call to the template method and pass arguments.
OS << "\tif (!" << N;
PrintTypes(OS, TS);
OS << "(S";
if (ChangesPC)
OS << ", PC";
else
OS << ", OpPC";
if (CanReturn)
OS << ", Result";
for (size_t I = 0, N = Args.size(); I < N; ++I)
OS << ", V" << I;
OS << "))\n";
OS << "\t\treturn false;\n";
// Bail out if interpreter returned.
if (CanReturn) {
OS << "\tif (!S.Current || S.Current->isRoot())\n";
OS << "\t\treturn true;\n";
}
OS << "\tcontinue;\n";
OS << "}\n";
});
OS << "#endif\n";
}
void ClangOpcodesEmitter::EmitDisasm(raw_ostream &OS, StringRef N, Record *R) {
OS << "#ifdef GET_DISASM\n";
Enumerate(R, N, [R, &OS](ArrayRef<Record *>, const Twine &ID) {
OS << "case OP_" << ID << ":\n";
OS << "\tPrintName(\"" << ID << "\");\n";
OS << "\tOS << \"\\t\"";
for (auto *Arg : R->getValueAsListOfDefs("Args"))
OS << " << PC.read<" << Arg->getValueAsString("Name") << ">() << \" \"";
OS << "<< \"\\n\";\n";
OS << "\tcontinue;\n";
});
OS << "#endif\n";
}
void ClangOpcodesEmitter::EmitEmitter(raw_ostream &OS, StringRef N, Record *R) {
if (R->getValueAsBit("HasCustomLink"))
return;
OS << "#ifdef GET_LINK_IMPL\n";
Enumerate(R, N, [R, &OS](ArrayRef<Record *>, const Twine &ID) {
auto Args = R->getValueAsListOfDefs("Args");
// Emit the list of arguments.
OS << "bool ByteCodeEmitter::emit" << ID << "(";
for (size_t I = 0, N = Args.size(); I < N; ++I)
OS << Args[I]->getValueAsString("Name") << " A" << I << ",";
OS << "const SourceInfo &L) {\n";
// Emit a call to write the opcodes.
OS << "\treturn emitOp<";
for (size_t I = 0, N = Args.size(); I < N; ++I) {
if (I != 0)
OS << ", ";
OS << Args[I]->getValueAsString("Name");
}
OS << ">(OP_" << ID;
for (size_t I = 0, N = Args.size(); I < N; ++I)
OS << ", A" << I;
OS << ", L);\n";
OS << "}\n";
});
OS << "#endif\n";
}
void ClangOpcodesEmitter::EmitProto(raw_ostream &OS, StringRef N, Record *R) {
OS << "#if defined(GET_EVAL_PROTO) || defined(GET_LINK_PROTO)\n";
auto Args = R->getValueAsListOfDefs("Args");
Enumerate(R, N, [&OS, &Args](ArrayRef<Record *> TS, const Twine &ID) {
OS << "bool emit" << ID << "(";
for (auto *Arg : Args)
OS << Arg->getValueAsString("Name") << ", ";
OS << "const SourceInfo &);\n";
});
// Emit a template method for custom emitters to have less to implement.
auto TypeCount = R->getValueAsListInit("Types")->size();
if (R->getValueAsBit("HasCustomEval") && TypeCount) {
OS << "#if defined(GET_EVAL_PROTO)\n";
OS << "template<";
for (size_t I = 0; I < TypeCount; ++I) {
if (I != 0)
OS << ", ";
OS << "PrimType";
}
OS << ">\n";
OS << "bool emit" << N << "(";
for (auto *Arg : Args)
OS << Arg->getValueAsString("Name") << ", ";
OS << "const SourceInfo &);\n";
OS << "#endif\n";
}
OS << "#endif\n";
}
void ClangOpcodesEmitter::EmitGroup(raw_ostream &OS, StringRef N, Record *R) {
if (!R->getValueAsBit("HasGroup"))
return;
auto *Types = R->getValueAsListInit("Types");
auto Args = R->getValueAsListOfDefs("Args");
// Emit the prototype of the group emitter in the header.
OS << "#if defined(GET_EVAL_PROTO) || defined(GET_LINK_PROTO)\n";
OS << "bool emit" << N << "(";
for (size_t I = 0, N = Types->size(); I < N; ++I)
OS << "PrimType, ";
for (auto *Arg : Args)
OS << Arg->getValueAsString("Name") << ", ";
OS << "const SourceInfo &I);\n";
OS << "#endif\n";
// Emit the dispatch implementation in the source.
OS << "#if defined(GET_EVAL_IMPL) || defined(GET_LINK_IMPL)\n";
OS << "bool \n";
OS << "#if defined(GET_EVAL_IMPL)\n";
OS << "EvalEmitter\n";
OS << "#else\n";
OS << "ByteCodeEmitter\n";
OS << "#endif\n";
OS << "::emit" << N << "(";
for (size_t I = 0, N = Types->size(); I < N; ++I)
OS << "PrimType T" << I << ", ";
for (size_t I = 0, N = Args.size(); I < N; ++I)
OS << Args[I]->getValueAsString("Name") << " A" << I << ", ";
OS << "const SourceInfo &I) {\n";
std::function<void(size_t, const Twine &)> Rec;
llvm::SmallVector<Record *, 2> TS;
Rec = [this, &Rec, &OS, Types, &Args, R, &TS, N](size_t I, const Twine &ID) {
if (I >= Types->size()) {
// Print a call to the emitter method.
// Custom evaluator methods dispatch to template methods.
if (R->getValueAsBit("HasCustomEval")) {
OS << "#ifdef GET_LINK_IMPL\n";
OS << "return emit" << ID << "\n";
OS << "#else\n";
OS << "return emit" << N;
PrintTypes(OS, TS);
OS << "\n#endif\n";
} else {
OS << "return emit" << ID;
}
OS << "(";
for (size_t I = 0; I < Args.size(); ++I) {
OS << "A" << I << ", ";
}
OS << "I);\n";
return;
}
// Print a switch statement selecting T.
if (auto *TypeClass = dyn_cast<DefInit>(Types->getElement(I))) {
OS << "switch (T" << I << "){\n";
auto Cases = TypeClass->getDef()->getValueAsListOfDefs("Types");
for (auto *Case : Cases) {
OS << "case PT_" << Case->getName() << ":\n";
TS.push_back(Case);
Rec(I + 1, ID + Case->getName());
TS.pop_back();
}
// Emit a default case if not all types are present.
if (Cases.size() < NumTypes)
OS << "default: llvm_unreachable(\"invalid type\");\n";
OS << "}\n";
OS << "llvm_unreachable(\"invalid enum value\");\n";
} else {
PrintFatalError("Expected a type class");
}
};
Rec(0, N);
OS << "}\n";
OS << "#endif\n";
}
void ClangOpcodesEmitter::EmitEval(raw_ostream &OS, StringRef N, Record *R) {
if (R->getValueAsBit("HasCustomEval"))
return;
OS << "#ifdef GET_EVAL_IMPL\n";
Enumerate(R, N, [this, R, &N, &OS](ArrayRef<Record *> TS, const Twine &ID) {
auto Args = R->getValueAsListOfDefs("Args");
OS << "bool EvalEmitter::emit" << ID << "(";
for (size_t I = 0, N = Args.size(); I < N; ++I)
OS << Args[I]->getValueAsString("Name") << " A" << I << ",";
OS << "const SourceInfo &L) {\n";
OS << "if (!isActive()) return true;\n";
OS << "CurrentSource = L;\n";
OS << "return " << N;
PrintTypes(OS, TS);
OS << "(S, OpPC";
for (size_t I = 0, N = Args.size(); I < N; ++I)
OS << ", A" << I;
OS << ");\n";
OS << "}\n";
});
OS << "#endif\n";
}
void ClangOpcodesEmitter::PrintTypes(raw_ostream &OS, ArrayRef<Record *> Types) {
if (Types.empty())
return;
OS << "<";
for (size_t I = 0, N = Types.size(); I < N; ++I) {
if (I != 0)
OS << ", ";
OS << "PT_" << Types[I]->getName();
}
OS << ">";
}
void clang::EmitClangOpcodes(RecordKeeper &Records, raw_ostream &OS) {
ClangOpcodesEmitter(Records).run(OS);
}
|