blob: 589d81c4eb2a66e382fbc6322607fe7b26b01818 [file] [log] [blame]
Daniel Dunbar3085b572009-07-11 19:39:44 +00001//===- AsmMatcherEmitter.cpp - Generate an assembly matcher ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This tablegen backend emits a target specifier matcher for converting parsed
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +000011// assembly operands in the MCInst structures. It also emits a matcher for
12// custom operand parsing.
13//
14// Converting assembly operands into MCInst structures
15// ---------------------------------------------------
Daniel Dunbar3085b572009-07-11 19:39:44 +000016//
Daniel Dunbare10787e2009-08-07 08:26:05 +000017// The input to the target specific matcher is a list of literal tokens and
18// operands. The target specific parser should generally eliminate any syntax
19// which is not relevant for matching; for example, comma tokens should have
20// already been consumed and eliminated by the parser. Most instructions will
21// end up with a single literal token (the instruction name) and some number of
22// operands.
23//
24// Some example inputs, for X86:
25// 'addl' (immediate ...) (register ...)
26// 'add' (immediate ...) (memory ...)
Jim Grosbach0eccfc22010-10-29 22:13:48 +000027// 'call' '*' %epc
Daniel Dunbare10787e2009-08-07 08:26:05 +000028//
29// The assembly matcher is responsible for converting this input into a precise
30// machine instruction (i.e., an instruction with a well defined encoding). This
31// mapping has several properties which complicate matching:
32//
33// - It may be ambiguous; many architectures can legally encode particular
34// variants of an instruction in different ways (for example, using a smaller
35// encoding for small immediates). Such ambiguities should never be
36// arbitrarily resolved by the assembler, the assembler is always responsible
37// for choosing the "best" available instruction.
38//
39// - It may depend on the subtarget or the assembler context. Instructions
40// which are invalid for the current mode, but otherwise unambiguous (e.g.,
41// an SSE instruction in a file being assembled for i486) should be accepted
42// and rejected by the assembler front end. However, if the proper encoding
43// for an instruction is dependent on the assembler context then the matcher
44// is responsible for selecting the correct machine instruction for the
45// current mode.
46//
47// The core matching algorithm attempts to exploit the regularity in most
48// instruction sets to quickly determine the set of possibly matching
49// instructions, and the simplify the generated code. Additionally, this helps
50// to ensure that the ambiguities are intentionally resolved by the user.
51//
52// The matching is divided into two distinct phases:
53//
54// 1. Classification: Each operand is mapped to the unique set which (a)
55// contains it, and (b) is the largest such subset for which a single
56// instruction could match all members.
57//
58// For register classes, we can generate these subgroups automatically. For
59// arbitrary operands, we expect the user to define the classes and their
60// relations to one another (for example, 8-bit signed immediates as a
61// subset of 32-bit immediates).
62//
63// By partitioning the operands in this way, we guarantee that for any
64// tuple of classes, any single instruction must match either all or none
65// of the sets of operands which could classify to that tuple.
66//
67// In addition, the subset relation amongst classes induces a partial order
68// on such tuples, which we use to resolve ambiguities.
69//
Daniel Dunbare10787e2009-08-07 08:26:05 +000070// 2. The input can now be treated as a tuple of classes (static tokens are
71// simple singleton sets). Each such tuple should generally map to a single
72// instruction (we currently ignore cases where this isn't true, whee!!!),
73// which we can emit a simple matcher for.
74//
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +000075// Custom Operand Parsing
76// ----------------------
77//
78// Some targets need a custom way to parse operands, some specific instructions
79// can contain arguments that can represent processor flags and other kinds of
Craig Topperaae8fb82012-09-18 01:13:36 +000080// identifiers that need to be mapped to specific values in the final encoded
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +000081// instructions. The target specific custom operand parsing works in the
82// following way:
83//
84// 1. A operand match table is built, each entry contains a mnemonic, an
85// operand class, a mask for all operand positions for that same
86// class/mnemonic and target features to be checked while trying to match.
87//
88// 2. The operand matcher will try every possible entry with the same
89// mnemonic and will check if the target feature for this mnemonic also
90// matches. After that, if the operand to be matched has its index
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000091// present in the mask, a successful match occurs. Otherwise, fallback
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +000092// to the regular operand parsing.
93//
94// 3. For a match success, each operand class that has a 'ParserMethod'
95// becomes part of a switch from where the custom method is called.
96//
Daniel Dunbar3085b572009-07-11 19:39:44 +000097//===----------------------------------------------------------------------===//
98
Daniel Dunbar3085b572009-07-11 19:39:44 +000099#include "CodeGenTarget.h"
Chris Lattner4efe13d2010-11-04 02:11:18 +0000100#include "llvm/ADT/PointerUnion.h"
Chandler Carruth91d19d82012-12-04 10:37:14 +0000101#include "llvm/ADT/STLExtras.h"
Chris Lattnerf7a01e92010-11-01 01:47:07 +0000102#include "llvm/ADT/SmallPtrSet.h"
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +0000103#include "llvm/ADT/SmallVector.h"
Daniel Dunbare10787e2009-08-07 08:26:05 +0000104#include "llvm/ADT/StringExtras.h"
105#include "llvm/Support/CommandLine.h"
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +0000106#include "llvm/Support/Debug.h"
Craig Topperc4965bc2012-02-05 07:21:30 +0000107#include "llvm/Support/ErrorHandling.h"
Peter Collingbourne84c287e2011-10-01 16:41:13 +0000108#include "llvm/TableGen/Error.h"
109#include "llvm/TableGen/Record.h"
Douglas Gregor12c1cd32012-05-02 17:32:48 +0000110#include "llvm/TableGen/StringMatcher.h"
Craig Topper3e1d5da2013-08-29 05:09:55 +0000111#include "llvm/TableGen/StringToOffsetTable.h"
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000112#include "llvm/TableGen/TableGenBackend.h"
113#include <cassert>
Will Dietz981af002013-10-12 00:55:57 +0000114#include <cctype>
Daniel Dunbar71330282009-08-08 05:24:34 +0000115#include <map>
116#include <set>
Aaron Ballmane59e3582013-07-15 16:53:32 +0000117#include <sstream>
David Blaikied749e342014-11-28 20:35:57 +0000118#include <forward_list>
Eugene Zelenkoecefe5a2016-02-02 18:20:45 +0000119
Daniel Dunbar3085b572009-07-11 19:39:44 +0000120using namespace llvm;
121
Chandler Carruthe96dd892014-04-21 22:55:11 +0000122#define DEBUG_TYPE "asm-matcher-emitter"
123
Daniel Dunbar15b80372009-08-07 20:33:39 +0000124static cl::opt<std::string>
Daniel Dunbar3239f022009-08-09 04:00:06 +0000125MatchPrefix("match-prefix", cl::init(""),
126 cl::desc("Only match instructions with the given prefix"));
Daniel Dunbare10787e2009-08-07 08:26:05 +0000127
Daniel Dunbare10787e2009-08-07 08:26:05 +0000128namespace {
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000129class AsmMatcherInfo;
Daniel Dunbareefe8612010-07-19 05:44:09 +0000130struct SubtargetFeatureInfo;
131
Tim Northoverc74e6912013-09-16 16:43:19 +0000132// Register sets are used as keys in some second-order sets TableGen creates
133// when generating its data structures. This means that the order of two
134// RegisterSets can be seen in the outputted AsmMatcher tables occasionally, and
135// can even affect compiler output (at least seen in diagnostics produced when
136// all matches fail). So we use a type that sorts them consistently.
137typedef std::set<Record*, LessRecordByID> RegisterSet;
138
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000139class AsmMatcherEmitter {
140 RecordKeeper &Records;
141public:
142 AsmMatcherEmitter(RecordKeeper &R) : Records(R) {}
143
144 void run(raw_ostream &o);
145};
146
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000147/// ClassInfo - Helper class for storing the information about a particular
148/// class of operands which can be matched.
149struct ClassInfo {
Daniel Dunbar3239f022009-08-09 04:00:06 +0000150 enum ClassInfoKind {
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000151 /// Invalid kind, for use as a sentinel value.
152 Invalid = 0,
153
154 /// The class for a particular token.
155 Token,
156
157 /// The (first) register class, subsequent register classes are
158 /// RegisterClass0+1, and so on.
159 RegisterClass0,
160
161 /// The (first) user defined class, subsequent user defined classes are
162 /// UserClass0+1, and so on.
163 UserClass0 = 1<<16
Daniel Dunbar3239f022009-08-09 04:00:06 +0000164 };
165
166 /// Kind - The class kind, which is either a predefined kind, or (UserClass0 +
167 /// N) for the Nth user defined class.
168 unsigned Kind;
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000169
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000170 /// SuperClasses - The super classes of this class. Note that for simplicities
171 /// sake user operands only record their immediate super class, while register
172 /// operands include all superclasses.
173 std::vector<ClassInfo*> SuperClasses;
Daniel Dunbar8e33cb22009-08-09 07:20:21 +0000174
Daniel Dunbarc32aa062009-08-09 05:18:30 +0000175 /// Name - The full class name, suitable for use in an enum.
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000176 std::string Name;
177
Daniel Dunbarc32aa062009-08-09 05:18:30 +0000178 /// ClassName - The unadorned generic name for this class (e.g., Token).
179 std::string ClassName;
180
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000181 /// ValueName - The name of the value this class represents; for a token this
182 /// is the literal token string, for an operand it is the TableGen class (or
183 /// empty if this is a derived class).
184 std::string ValueName;
185
186 /// PredicateMethod - The name of the operand method to test whether the
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000187 /// operand matches this class; this is not valid for Token or register kinds.
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000188 std::string PredicateMethod;
189
190 /// RenderMethod - The name of the operand method to add this operand to an
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000191 /// MCInst; this is not valid for Token or register kinds.
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000192 std::string RenderMethod;
Daniel Dunbar3239f022009-08-09 04:00:06 +0000193
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000194 /// ParserMethod - The name of the operand method to do a target specific
195 /// parsing on the operand.
196 std::string ParserMethod;
197
Eric Christopher650c8f22014-05-20 17:11:11 +0000198 /// For register classes: the records for all the registers in this class.
Tim Northoverc74e6912013-09-16 16:43:19 +0000199 RegisterSet Registers;
Daniel Dunbar34c87912009-08-11 20:10:07 +0000200
Eric Christopher650c8f22014-05-20 17:11:11 +0000201 /// For custom match classes: the diagnostic kind for when the predicate fails.
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +0000202 std::string DiagnosticType;
Tom Stellardb9f235e2016-02-05 19:59:33 +0000203
204 /// Is this operand optional and not always required.
205 bool IsOptional;
206
Daniel Dunbar34c87912009-08-11 20:10:07 +0000207public:
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000208 /// isRegisterClass() - Check if this is a register class.
209 bool isRegisterClass() const {
210 return Kind >= RegisterClass0 && Kind < UserClass0;
211 }
212
Daniel Dunbar8e33cb22009-08-09 07:20:21 +0000213 /// isUserClass() - Check if this is a user defined class.
214 bool isUserClass() const {
215 return Kind >= UserClass0;
216 }
217
Dmitri Gribenko8d302402012-09-15 20:22:05 +0000218 /// isRelatedTo - Check whether this class is "related" to \p RHS. Classes
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000219 /// are related if they are in the same class hierarchy.
220 bool isRelatedTo(const ClassInfo &RHS) const {
221 // Tokens are only related to tokens.
222 if (Kind == Token || RHS.Kind == Token)
223 return Kind == Token && RHS.Kind == Token;
224
Daniel Dunbar34c87912009-08-11 20:10:07 +0000225 // Registers classes are only related to registers classes, and only if
226 // their intersection is non-empty.
227 if (isRegisterClass() || RHS.isRegisterClass()) {
228 if (!isRegisterClass() || !RHS.isRegisterClass())
229 return false;
230
Tim Northoverc74e6912013-09-16 16:43:19 +0000231 RegisterSet Tmp;
232 std::insert_iterator<RegisterSet> II(Tmp, Tmp.begin());
Jim Grosbach0eccfc22010-10-29 22:13:48 +0000233 std::set_intersection(Registers.begin(), Registers.end(),
Daniel Dunbar34c87912009-08-11 20:10:07 +0000234 RHS.Registers.begin(), RHS.Registers.end(),
Tim Northoverc74e6912013-09-16 16:43:19 +0000235 II, LessRecordByID());
Daniel Dunbar34c87912009-08-11 20:10:07 +0000236
237 return !Tmp.empty();
238 }
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000239
240 // Otherwise we have two users operands; they are related if they are in the
241 // same class hierarchy.
Daniel Dunbar34c87912009-08-11 20:10:07 +0000242 //
243 // FIXME: This is an oversimplification, they should only be related if they
244 // intersect, however we don't have that information.
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000245 assert(isUserClass() && RHS.isUserClass() && "Unexpected class!");
246 const ClassInfo *Root = this;
247 while (!Root->SuperClasses.empty())
248 Root = Root->SuperClasses.front();
249
Daniel Dunbar34c87912009-08-11 20:10:07 +0000250 const ClassInfo *RHSRoot = &RHS;
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000251 while (!RHSRoot->SuperClasses.empty())
252 RHSRoot = RHSRoot->SuperClasses.front();
Jim Grosbach0eccfc22010-10-29 22:13:48 +0000253
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000254 return Root == RHSRoot;
255 }
256
Dmitri Gribenko8d302402012-09-15 20:22:05 +0000257 /// isSubsetOf - Test whether this class is a subset of \p RHS.
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000258 bool isSubsetOf(const ClassInfo &RHS) const {
259 // This is a subset of RHS if it is the same class...
260 if (this == &RHS)
261 return true;
262
263 // ... or if any of its super classes are a subset of RHS.
Craig Topper03ec8012014-11-25 20:11:31 +0000264 for (const ClassInfo *CI : SuperClasses)
265 if (CI->isSubsetOf(RHS))
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000266 return true;
267
268 return false;
Daniel Dunbar8e33cb22009-08-09 07:20:21 +0000269 }
270
Oliver Stannard7772f022016-01-25 10:20:19 +0000271 int getTreeDepth() const {
272 int Depth = 0;
273 const ClassInfo *Root = this;
274 while (!Root->SuperClasses.empty()) {
275 Depth++;
276 Root = Root->SuperClasses.front();
277 }
278 return Depth;
279 }
280
281 const ClassInfo *findRoot() const {
282 const ClassInfo *Root = this;
283 while (!Root->SuperClasses.empty())
284 Root = Root->SuperClasses.front();
285 return Root;
286 }
287
288 /// Compare two classes. This does not produce a total ordering, but does
289 /// guarantee that subclasses are sorted before their parents, and that the
290 /// ordering is transitive.
Daniel Dunbar3239f022009-08-09 04:00:06 +0000291 bool operator<(const ClassInfo &RHS) const {
Daniel Dunbar97ac3af2010-05-27 05:31:32 +0000292 if (this == &RHS)
293 return false;
294
Oliver Stannard7772f022016-01-25 10:20:19 +0000295 // First, enforce the ordering between the three different types of class.
296 // Tokens sort before registers, which sort before user classes.
297 if (Kind == Token) {
298 if (RHS.Kind != Token)
Duncan Sands41b4a6b2010-07-12 08:16:59 +0000299 return true;
Oliver Stannard7772f022016-01-25 10:20:19 +0000300 assert(RHS.Kind == Token);
301 } else if (isRegisterClass()) {
302 if (RHS.Kind == Token)
Duncan Sands41b4a6b2010-07-12 08:16:59 +0000303 return false;
Oliver Stannard7772f022016-01-25 10:20:19 +0000304 else if (RHS.isUserClass())
305 return true;
306 assert(RHS.isRegisterClass());
307 } else if (isUserClass()) {
308 if (!RHS.isUserClass())
309 return false;
310 assert(RHS.isUserClass());
311 } else {
312 llvm_unreachable("Unknown ClassInfoKind");
Daniel Dunbar3239f022009-08-09 04:00:06 +0000313 }
Oliver Stannard7772f022016-01-25 10:20:19 +0000314
315 if (Kind == Token || isUserClass()) {
316 // Related tokens and user classes get sorted by depth in the inheritence
317 // tree (so that subclasses are before their parents).
318 if (isRelatedTo(RHS)) {
319 if (getTreeDepth() > RHS.getTreeDepth())
320 return true;
321 if (getTreeDepth() < RHS.getTreeDepth())
322 return false;
323 } else {
324 // Unrelated tokens and user classes are ordered by the name of their
325 // root nodes, so that there is a consistent ordering between
326 // unconnected trees.
327 return findRoot()->ValueName < RHS.findRoot()->ValueName;
328 }
329 } else if (isRegisterClass()) {
330 // For register sets, sort by number of registers. This guarantees that
331 // a set will always sort before all of it's strict supersets.
332 if (Registers.size() != RHS.Registers.size())
333 return Registers.size() < RHS.Registers.size();
334 } else {
335 llvm_unreachable("Unknown ClassInfoKind");
336 }
337
338 // FIXME: We should be able to just return false here, as we only need a
339 // partial order (we use stable sorts, so this is deterministic) and the
340 // name of a class shouldn't be significant. However, some of the backends
341 // accidentally rely on this behaviour, so it will have to stay like this
342 // until they are fixed.
343 return ValueName < RHS.ValueName;
Daniel Dunbar3239f022009-08-09 04:00:06 +0000344 }
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000345};
346
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000347class AsmVariantInfo {
348public:
Craig Topperc8b5b252015-12-30 06:00:18 +0000349 std::string RegisterPrefix;
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000350 std::string TokenizingCharacters;
351 std::string SeparatorCharacters;
352 std::string BreakCharacters;
Craig Topperc8b5b252015-12-30 06:00:18 +0000353 int AsmVariantNo;
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000354};
355
Chris Lattnerad776812010-11-01 05:06:45 +0000356/// MatchableInfo - Helper class for storing the necessary information for an
357/// instruction or alias which is capable of being matched.
358struct MatchableInfo {
Chris Lattner896cf042010-11-03 19:47:34 +0000359 struct AsmOperand {
Chris Lattner28ea9b12010-11-02 17:30:52 +0000360 /// Token - This is the token that the operand came from.
361 StringRef Token;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000362
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000363 /// The unique class instance this operand should match.
364 ClassInfo *Class;
Daniel Dunbare10787e2009-08-07 08:26:05 +0000365
Chris Lattner7108dad2010-11-04 01:42:59 +0000366 /// The operand name this is, if anything.
367 StringRef SrcOpName;
Bob Wilsonb9b24222011-01-26 19:44:55 +0000368
369 /// The suboperand index within SrcOpName, or -1 for the entire operand.
370 int SubOpIdx;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000371
Ahmed Bougachaeb4dbd82015-05-29 01:03:37 +0000372 /// Whether the token is "isolated", i.e., it is preceded and followed
373 /// by separators.
374 bool IsIsolatedToken;
375
Devang Patel6d676e42012-01-07 01:33:34 +0000376 /// Register record if this token is singleton register.
377 Record *SingletonReg;
378
Ahmed Bougachaeb4dbd82015-05-29 01:03:37 +0000379 explicit AsmOperand(bool IsIsolatedToken, StringRef T)
380 : Token(T), Class(nullptr), SubOpIdx(-1),
381 IsIsolatedToken(IsIsolatedToken), SingletonReg(nullptr) {}
Daniel Dunbare10787e2009-08-07 08:26:05 +0000382 };
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000383
Chris Lattner743081d2010-11-04 00:43:46 +0000384 /// ResOperand - This represents a single operand in the result instruction
385 /// generated by the match. In cases (like addressing modes) where a single
386 /// assembler operand expands to multiple MCOperands, this represents the
387 /// single assembler operand, not the MCOperand.
388 struct ResOperand {
389 enum {
390 /// RenderAsmOperand - This represents an operand result that is
391 /// generated by calling the render method on the assembly operand. The
392 /// corresponding AsmOperand is specified by AsmOperandNum.
393 RenderAsmOperand,
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000394
Chris Lattner743081d2010-11-04 00:43:46 +0000395 /// TiedOperand - This represents a result operand that is a duplicate of
396 /// a previous result operand.
Chris Lattnerb6f8e822010-11-06 19:25:43 +0000397 TiedOperand,
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000398
Chris Lattnerb6f8e822010-11-06 19:25:43 +0000399 /// ImmOperand - This represents an immediate value that is dumped into
400 /// the operand.
Chris Lattner4869d342010-11-06 19:57:21 +0000401 ImmOperand,
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000402
Chris Lattner4869d342010-11-06 19:57:21 +0000403 /// RegOperand - This represents a fixed register that is dumped in.
404 RegOperand
Chris Lattner743081d2010-11-04 00:43:46 +0000405 } Kind;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000406
Chris Lattner743081d2010-11-04 00:43:46 +0000407 union {
408 /// This is the operand # in the AsmOperands list that this should be
409 /// copied from.
410 unsigned AsmOperandNum;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000411
Chris Lattner743081d2010-11-04 00:43:46 +0000412 /// TiedOperandNum - This is the (earlier) result operand that should be
413 /// copied from.
414 unsigned TiedOperandNum;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000415
Chris Lattnerb6f8e822010-11-06 19:25:43 +0000416 /// ImmVal - This is the immediate value added to the instruction.
417 int64_t ImmVal;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000418
Chris Lattner4869d342010-11-06 19:57:21 +0000419 /// Register - This is the register record.
420 Record *Register;
Chris Lattner743081d2010-11-04 00:43:46 +0000421 };
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000422
Bob Wilsonb9b24222011-01-26 19:44:55 +0000423 /// MINumOperands - The number of MCInst operands populated by this
424 /// operand.
425 unsigned MINumOperands;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000426
Bob Wilsonb9b24222011-01-26 19:44:55 +0000427 static ResOperand getRenderedOp(unsigned AsmOpNum, unsigned NumOperands) {
Chris Lattner743081d2010-11-04 00:43:46 +0000428 ResOperand X;
429 X.Kind = RenderAsmOperand;
430 X.AsmOperandNum = AsmOpNum;
Bob Wilsonb9b24222011-01-26 19:44:55 +0000431 X.MINumOperands = NumOperands;
Chris Lattner743081d2010-11-04 00:43:46 +0000432 return X;
433 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000434
Bob Wilsonb9b24222011-01-26 19:44:55 +0000435 static ResOperand getTiedOp(unsigned TiedOperandNum) {
Chris Lattner743081d2010-11-04 00:43:46 +0000436 ResOperand X;
437 X.Kind = TiedOperand;
438 X.TiedOperandNum = TiedOperandNum;
Bob Wilsonb9b24222011-01-26 19:44:55 +0000439 X.MINumOperands = 1;
Chris Lattner743081d2010-11-04 00:43:46 +0000440 return X;
441 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000442
Bob Wilsonb9b24222011-01-26 19:44:55 +0000443 static ResOperand getImmOp(int64_t Val) {
Chris Lattnerb6f8e822010-11-06 19:25:43 +0000444 ResOperand X;
445 X.Kind = ImmOperand;
446 X.ImmVal = Val;
Bob Wilsonb9b24222011-01-26 19:44:55 +0000447 X.MINumOperands = 1;
Chris Lattnerb6f8e822010-11-06 19:25:43 +0000448 return X;
449 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000450
Bob Wilsonb9b24222011-01-26 19:44:55 +0000451 static ResOperand getRegOp(Record *Reg) {
Chris Lattner4869d342010-11-06 19:57:21 +0000452 ResOperand X;
453 X.Kind = RegOperand;
454 X.Register = Reg;
Bob Wilsonb9b24222011-01-26 19:44:55 +0000455 X.MINumOperands = 1;
Chris Lattner4869d342010-11-06 19:57:21 +0000456 return X;
457 }
Chris Lattner743081d2010-11-04 00:43:46 +0000458 };
Daniel Dunbare10787e2009-08-07 08:26:05 +0000459
Devang Patel9bdc5052012-01-10 17:50:43 +0000460 /// AsmVariantID - Target's assembly syntax variant no.
461 int AsmVariantID;
462
David Blaikieba4e00f2014-12-22 21:26:26 +0000463 /// AsmString - The assembly string for this instruction (with variants
464 /// removed), e.g. "movsx $src, $dst".
465 std::string AsmString;
466
Chris Lattnera7a903e2010-11-02 17:34:28 +0000467 /// TheDef - This is the definition of the instruction or InstAlias that this
468 /// matchable came from.
Chris Lattner39bc53b2010-11-01 04:34:44 +0000469 Record *const TheDef;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000470
Chris Lattner4efe13d2010-11-04 02:11:18 +0000471 /// DefRec - This is the definition that it came from.
472 PointerUnion<const CodeGenInstruction*, const CodeGenInstAlias*> DefRec;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000473
Chris Lattnerfecdad62010-11-06 07:14:44 +0000474 const CodeGenInstruction *getResultInst() const {
475 if (DefRec.is<const CodeGenInstruction*>())
476 return DefRec.get<const CodeGenInstruction*>();
477 return DefRec.get<const CodeGenInstAlias*>()->ResultInst;
478 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000479
Chris Lattner743081d2010-11-04 00:43:46 +0000480 /// ResOperands - This is the operand list that should be built for the result
481 /// MCInst.
Jim Grosbacha37e2292012-04-19 17:52:34 +0000482 SmallVector<ResOperand, 8> ResOperands;
Daniel Dunbare10787e2009-08-07 08:26:05 +0000483
Chris Lattner28ea9b12010-11-02 17:30:52 +0000484 /// Mnemonic - This is the first token of the matched instruction, its
485 /// mnemonic.
486 StringRef Mnemonic;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000487
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000488 /// AsmOperands - The textual operands that this instruction matches,
Chris Lattnera7a903e2010-11-02 17:34:28 +0000489 /// annotated with a class and where in the OperandList they were defined.
490 /// This directly corresponds to the tokenized AsmString after the mnemonic is
491 /// removed.
Jim Grosbacha37e2292012-04-19 17:52:34 +0000492 SmallVector<AsmOperand, 8> AsmOperands;
Daniel Dunbare10787e2009-08-07 08:26:05 +0000493
Daniel Dunbareefe8612010-07-19 05:44:09 +0000494 /// Predicates - The required subtarget features to match this instruction.
David Blaikie9a9da992014-11-28 22:15:06 +0000495 SmallVector<const SubtargetFeatureInfo *, 4> RequiredFeatures;
Daniel Dunbareefe8612010-07-19 05:44:09 +0000496
Daniel Dunbar71330282009-08-08 05:24:34 +0000497 /// ConversionFnKind - The enum value which is passed to the generated
Chad Rosierba284b92012-09-05 01:02:38 +0000498 /// convertToMCInst to convert parsed operands into an MCInst for this
Daniel Dunbar71330282009-08-08 05:24:34 +0000499 /// function.
500 std::string ConversionFnKind;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000501
Joey Gouly0e76fa72013-09-12 10:28:05 +0000502 /// If this instruction is deprecated in some form.
503 bool HasDeprecation;
504
Tom Stellard74c87c82015-05-26 15:55:50 +0000505 /// If this is an alias, this is use to determine whether or not to using
506 /// the conversion function defined by the instruction's AsmMatchConverter
507 /// or to use the function generated by the alias.
508 bool UseInstAsmMatchConverter;
509
Chris Lattnerad776812010-11-01 05:06:45 +0000510 MatchableInfo(const CodeGenInstruction &CGI)
Tom Stellard74c87c82015-05-26 15:55:50 +0000511 : AsmVariantID(0), AsmString(CGI.AsmString), TheDef(CGI.TheDef), DefRec(&CGI),
512 UseInstAsmMatchConverter(true) {
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +0000513 }
Chris Lattner39bc53b2010-11-01 04:34:44 +0000514
David Blaikieba4e00f2014-12-22 21:26:26 +0000515 MatchableInfo(std::unique_ptr<const CodeGenInstAlias> Alias)
Tom Stellard74c87c82015-05-26 15:55:50 +0000516 : AsmVariantID(0), AsmString(Alias->AsmString), TheDef(Alias->TheDef),
517 DefRec(Alias.release()),
518 UseInstAsmMatchConverter(
519 TheDef->getValueAsBit("UseInstAsmMatchConverter")) {
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +0000520 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000521
David Blaikie6e48a812015-08-01 01:08:30 +0000522 // Could remove this and the dtor if PointerUnion supported unique_ptr
523 // elements with a dynamic failure/assertion (like the one below) in the case
524 // where it was copied while being in an owning state.
525 MatchableInfo(const MatchableInfo &RHS)
526 : AsmVariantID(RHS.AsmVariantID), AsmString(RHS.AsmString),
527 TheDef(RHS.TheDef), DefRec(RHS.DefRec), ResOperands(RHS.ResOperands),
528 Mnemonic(RHS.Mnemonic), AsmOperands(RHS.AsmOperands),
529 RequiredFeatures(RHS.RequiredFeatures),
530 ConversionFnKind(RHS.ConversionFnKind),
531 HasDeprecation(RHS.HasDeprecation),
532 UseInstAsmMatchConverter(RHS.UseInstAsmMatchConverter) {
533 assert(!DefRec.is<const CodeGenInstAlias *>());
534 }
535
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +0000536 ~MatchableInfo() {
David Blaikieba4e00f2014-12-22 21:26:26 +0000537 delete DefRec.dyn_cast<const CodeGenInstAlias*>();
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +0000538 }
Craig Topperce274892014-11-28 05:01:21 +0000539
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000540 // Two-operand aliases clone from the main matchable, but mark the second
541 // operand as a tied operand of the first for purposes of the assembler.
542 void formTwoOperandAlias(StringRef Constraint);
543
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000544 void initialize(const AsmMatcherInfo &Info,
Craig Topper71b7b682014-08-21 05:55:13 +0000545 SmallPtrSetImpl<Record*> &SingletonRegisters,
Craig Topperfd2c6a32015-12-31 08:18:23 +0000546 AsmVariantInfo const &Variant,
547 bool HasMnemonicFirst);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000548
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000549 /// validate - Return true if this matchable is a valid thing to match against
Chris Lattnerad776812010-11-01 05:06:45 +0000550 /// and perform a bunch of validity checking.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000551 bool validate(StringRef CommentDelimiter, bool Hack) const;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000552
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000553 /// findAsmOperand - Find the AsmOperand with the specified name and
Bob Wilsonb9b24222011-01-26 19:44:55 +0000554 /// suboperand index.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000555 int findAsmOperand(StringRef N, int SubOpIdx) const {
Craig Topper58a0e7a2016-01-03 07:33:36 +0000556 auto I = std::find_if(AsmOperands.begin(), AsmOperands.end(),
557 [&](const AsmOperand &Op) {
558 return Op.SrcOpName == N && Op.SubOpIdx == SubOpIdx;
559 });
560 return (I != AsmOperands.end()) ? I - AsmOperands.begin() : -1;
Bob Wilsonb9b24222011-01-26 19:44:55 +0000561 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000562
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000563 /// findAsmOperandNamed - Find the first AsmOperand with the specified name.
Bob Wilsonb9b24222011-01-26 19:44:55 +0000564 /// This does not check the suboperand index.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000565 int findAsmOperandNamed(StringRef N) const {
Craig Topper58a0e7a2016-01-03 07:33:36 +0000566 auto I = std::find_if(AsmOperands.begin(), AsmOperands.end(),
567 [&](const AsmOperand &Op) {
568 return Op.SrcOpName == N;
569 });
570 return (I != AsmOperands.end()) ? I - AsmOperands.begin() : -1;
Chris Lattner897a1402010-11-04 01:55:23 +0000571 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000572
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000573 void buildInstructionResultOperands();
574 void buildAliasResultOperands();
Chris Lattner743081d2010-11-04 00:43:46 +0000575
Chris Lattnerad776812010-11-01 05:06:45 +0000576 /// operator< - Compare two matchables.
577 bool operator<(const MatchableInfo &RHS) const {
Chris Lattner82d88ce2010-09-06 21:01:37 +0000578 // The primary comparator is the instruction mnemonic.
Chris Lattner28ea9b12010-11-02 17:30:52 +0000579 if (Mnemonic != RHS.Mnemonic)
580 return Mnemonic < RHS.Mnemonic;
Jim Grosbach0eccfc22010-10-29 22:13:48 +0000581
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000582 if (AsmOperands.size() != RHS.AsmOperands.size())
583 return AsmOperands.size() < RHS.AsmOperands.size();
Daniel Dunbar3239f022009-08-09 04:00:06 +0000584
Daniel Dunbard9631912009-08-09 08:23:23 +0000585 // Compare lexicographically by operand. The matcher validates that other
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000586 // orderings wouldn't be ambiguous using \see couldMatchAmbiguouslyWith().
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000587 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
588 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
Daniel Dunbar3239f022009-08-09 04:00:06 +0000589 return true;
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000590 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
Daniel Dunbard9631912009-08-09 08:23:23 +0000591 return false;
592 }
593
Andrew Trick818f5ac2012-08-29 03:52:57 +0000594 // Give matches that require more features higher precedence. This is useful
595 // because we cannot define AssemblerPredicates with the negation of
596 // processor features. For example, ARM v6 "nop" may be either a HINT or
597 // MOV. With v6, we want to match HINT. The assembler has no way to
598 // predicate MOV under "NoV6", but HINT will always match first because it
599 // requires V6 while MOV does not.
600 if (RequiredFeatures.size() != RHS.RequiredFeatures.size())
601 return RequiredFeatures.size() > RHS.RequiredFeatures.size();
602
Daniel Dunbar3239f022009-08-09 04:00:06 +0000603 return false;
604 }
605
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000606 /// couldMatchAmbiguouslyWith - Check whether this matchable could
Dmitri Gribenko8d302402012-09-15 20:22:05 +0000607 /// ambiguously match the same set of operands as \p RHS (without being a
Daniel Dunbarf573b562009-08-09 06:05:33 +0000608 /// strictly superior match).
Craig Topper42bd8192014-11-28 03:53:00 +0000609 bool couldMatchAmbiguouslyWith(const MatchableInfo &RHS) const {
Chris Lattnere3c48de2010-11-01 23:57:23 +0000610 // The primary comparator is the instruction mnemonic.
Chris Lattner28ea9b12010-11-02 17:30:52 +0000611 if (Mnemonic != RHS.Mnemonic)
Chris Lattnere3c48de2010-11-01 23:57:23 +0000612 return false;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000613
Daniel Dunbarf573b562009-08-09 06:05:33 +0000614 // The number of operands is unambiguous.
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000615 if (AsmOperands.size() != RHS.AsmOperands.size())
Daniel Dunbarf573b562009-08-09 06:05:33 +0000616 return false;
617
Daniel Dunbare1974092010-01-23 00:26:16 +0000618 // Otherwise, make sure the ordering of the two instructions is unambiguous
619 // by checking that either (a) a token or operand kind discriminates them,
620 // or (b) the ordering among equivalent kinds is consistent.
621
Daniel Dunbarf573b562009-08-09 06:05:33 +0000622 // Tokens and operand kinds are unambiguous (assuming a correct target
623 // specific parser).
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000624 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
625 if (AsmOperands[i].Class->Kind != RHS.AsmOperands[i].Class->Kind ||
626 AsmOperands[i].Class->Kind == ClassInfo::Token)
627 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class ||
628 *RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
Daniel Dunbarf573b562009-08-09 06:05:33 +0000629 return false;
Jim Grosbach0eccfc22010-10-29 22:13:48 +0000630
Daniel Dunbarf573b562009-08-09 06:05:33 +0000631 // Otherwise, this operand could commute if all operands are equivalent, or
632 // there is a pair of operands that compare less than and a pair that
633 // compare greater than.
634 bool HasLT = false, HasGT = false;
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000635 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
636 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
Daniel Dunbarf573b562009-08-09 06:05:33 +0000637 HasLT = true;
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000638 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
Daniel Dunbarf573b562009-08-09 06:05:33 +0000639 HasGT = true;
640 }
641
Craig Topper322b67f2016-01-03 07:33:39 +0000642 return HasLT == HasGT;
Daniel Dunbarf573b562009-08-09 06:05:33 +0000643 }
644
Craig Topper42bd8192014-11-28 03:53:00 +0000645 void dump() const;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000646
Chris Lattner28ea9b12010-11-02 17:30:52 +0000647private:
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000648 void tokenizeAsmString(AsmMatcherInfo const &Info,
649 AsmVariantInfo const &Variant);
Craig Topperbc22e262015-12-31 05:01:45 +0000650 void addAsmOperand(StringRef Token, bool IsIsolatedToken = false);
Daniel Dunbare10787e2009-08-07 08:26:05 +0000651};
652
Daniel Dunbareefe8612010-07-19 05:44:09 +0000653/// SubtargetFeatureInfo - Helper class for storing information on a subtarget
654/// feature which participates in instruction matching.
655struct SubtargetFeatureInfo {
656 /// \brief The predicate record for this feature.
657 Record *TheDef;
658
659 /// \brief An unique index assigned to represent this feature.
Tim Northover26bb14e2014-08-18 11:49:42 +0000660 uint64_t Index;
Daniel Dunbareefe8612010-07-19 05:44:09 +0000661
Tim Northover26bb14e2014-08-18 11:49:42 +0000662 SubtargetFeatureInfo(Record *D, uint64_t Idx) : TheDef(D), Index(Idx) {}
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000663
Daniel Dunbareefe8612010-07-19 05:44:09 +0000664 /// \brief The name of the enumerated constant identifying this feature.
Chris Lattnera0e87192010-10-30 20:07:57 +0000665 std::string getEnumName() const {
666 return "Feature_" + TheDef->getName();
667 }
Daniel Sanders3ea92742014-05-21 10:11:24 +0000668
Craig Topper42bd8192014-11-28 03:53:00 +0000669 void dump() const {
Daniel Sanders3ea92742014-05-21 10:11:24 +0000670 errs() << getEnumName() << " " << Index << "\n";
671 TheDef->dump();
672 }
Daniel Dunbareefe8612010-07-19 05:44:09 +0000673};
674
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000675struct OperandMatchEntry {
676 unsigned OperandMask;
Craig Topper42bd8192014-11-28 03:53:00 +0000677 const MatchableInfo* MI;
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000678 ClassInfo *CI;
679
Craig Topper42bd8192014-11-28 03:53:00 +0000680 static OperandMatchEntry create(const MatchableInfo *mi, ClassInfo *ci,
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000681 unsigned opMask) {
682 OperandMatchEntry X;
683 X.OperandMask = opMask;
684 X.CI = ci;
685 X.MI = mi;
686 return X;
687 }
688};
689
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000690class AsmMatcherInfo {
691public:
Chris Lattner77d369c2010-12-13 00:23:57 +0000692 /// Tracked Records
Chris Lattner89dcb682010-12-15 04:48:22 +0000693 RecordKeeper &Records;
Chris Lattner77d369c2010-12-13 00:23:57 +0000694
Daniel Dunbare4318712009-08-11 20:59:47 +0000695 /// The tablegen AsmParser record.
696 Record *AsmParser;
697
Chris Lattnerb80ab362010-11-01 01:37:30 +0000698 /// Target - The target information.
699 CodeGenTarget &Target;
700
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000701 /// The classes which are needed for matching.
David Blaikied749e342014-11-28 20:35:57 +0000702 std::forward_list<ClassInfo> Classes;
Jim Grosbach0eccfc22010-10-29 22:13:48 +0000703
Chris Lattnerad776812010-11-01 05:06:45 +0000704 /// The information on the matchables to match.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +0000705 std::vector<std::unique_ptr<MatchableInfo>> Matchables;
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000706
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000707 /// Info for custom matching operands by user defined methods.
708 std::vector<OperandMatchEntry> OperandMatchInfo;
709
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000710 /// Map of Register records to their class information.
Sean Silvac8f56572012-09-19 01:47:01 +0000711 typedef std::map<Record*, ClassInfo*, LessRecordByID> RegisterClassesTy;
712 RegisterClassesTy RegisterClasses;
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000713
Daniel Dunbareefe8612010-07-19 05:44:09 +0000714 /// Map of Predicate records to their subtarget information.
David Blaikie9a9da992014-11-28 22:15:06 +0000715 std::map<Record *, SubtargetFeatureInfo, LessRecordByID> SubtargetFeatures;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000716
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +0000717 /// Map of AsmOperandClass records to their class information.
718 std::map<Record*, ClassInfo*> AsmOperandClasses;
719
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000720private:
721 /// Map of token to class information which has already been constructed.
722 std::map<std::string, ClassInfo*> TokenClasses;
723
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000724 /// Map of RegisterClass records to their class information.
725 std::map<Record*, ClassInfo*> RegisterClassClasses;
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000726
727private:
728 /// getTokenClass - Lookup or create the class for the given token.
Chris Lattner60db0a62010-02-09 00:34:28 +0000729 ClassInfo *getTokenClass(StringRef Token);
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000730
731 /// getOperandClass - Lookup or create the class for the given operand.
Bob Wilsonb9b24222011-01-26 19:44:55 +0000732 ClassInfo *getOperandClass(const CGIOperandList::OperandInfo &OI,
Jim Grosbachd1f1b792011-10-28 22:32:53 +0000733 int SubOpIdx);
734 ClassInfo *getOperandClass(Record *Rec, int SubOpIdx);
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000735
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000736 /// buildRegisterClasses - Build the ClassInfo* instances for register
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000737 /// classes.
Craig Topper71b7b682014-08-21 05:55:13 +0000738 void buildRegisterClasses(SmallPtrSetImpl<Record*> &SingletonRegisters);
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000739
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000740 /// buildOperandClasses - Build the ClassInfo* instances for user defined
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000741 /// operand classes.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000742 void buildOperandClasses();
Daniel Dunbarbb98db22009-08-11 02:59:53 +0000743
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000744 void buildInstructionOperandReference(MatchableInfo *II, StringRef OpName,
Bob Wilsonb9b24222011-01-26 19:44:55 +0000745 unsigned AsmOpIdx);
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000746 void buildAliasOperandReference(MatchableInfo *II, StringRef OpName,
Chris Lattner4efe13d2010-11-04 02:11:18 +0000747 MatchableInfo::AsmOperand &Op);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000748
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000749public:
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000750 AsmMatcherInfo(Record *AsmParser,
751 CodeGenTarget &Target,
Chris Lattner89dcb682010-12-15 04:48:22 +0000752 RecordKeeper &Records);
Daniel Dunbare4318712009-08-11 20:59:47 +0000753
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000754 /// buildInfo - Construct the various tables used during matching.
755 void buildInfo();
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000756
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000757 /// buildOperandMatchInfo - Build the necessary information to handle user
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000758 /// defined operand parsing methods.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000759 void buildOperandMatchInfo();
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +0000760
Chris Lattner43690072010-10-30 20:15:02 +0000761 /// getSubtargetFeature - Lookup or create the subtarget feature info for the
762 /// given operand.
David Blaikie9a9da992014-11-28 22:15:06 +0000763 const SubtargetFeatureInfo *getSubtargetFeature(Record *Def) const {
Chris Lattner43690072010-10-30 20:15:02 +0000764 assert(Def->isSubClassOf("Predicate") && "Invalid predicate type!");
Craig Topper42bd8192014-11-28 03:53:00 +0000765 const auto &I = SubtargetFeatures.find(Def);
David Blaikie9a9da992014-11-28 22:15:06 +0000766 return I == SubtargetFeatures.end() ? nullptr : &I->second;
Chris Lattner43690072010-10-30 20:15:02 +0000767 }
Chris Lattner77d369c2010-12-13 00:23:57 +0000768
Chris Lattner89dcb682010-12-15 04:48:22 +0000769 RecordKeeper &getRecords() const {
770 return Records;
Chris Lattner77d369c2010-12-13 00:23:57 +0000771 }
Daniel Dunbar541efcc2009-08-08 07:50:56 +0000772};
773
Eugene Zelenkoecefe5a2016-02-02 18:20:45 +0000774} // end anonymous namespace
Daniel Dunbare10787e2009-08-07 08:26:05 +0000775
Craig Topper42bd8192014-11-28 03:53:00 +0000776void MatchableInfo::dump() const {
Chris Lattner9f093812010-11-06 06:43:11 +0000777 errs() << TheDef->getName() << " -- " << "flattened:\"" << AsmString <<"\"\n";
Daniel Dunbare10787e2009-08-07 08:26:05 +0000778
Chris Lattnerd64b7c02010-11-02 01:03:43 +0000779 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
Craig Topper42bd8192014-11-28 03:53:00 +0000780 const AsmOperand &Op = AsmOperands[i];
Daniel Dunbarc32aa062009-08-09 05:18:30 +0000781 errs() << " op[" << i << "] = " << Op.Class->ClassName << " - ";
Chris Lattner4779e3e92010-11-04 00:57:06 +0000782 errs() << '\"' << Op.Token << "\"\n";
Daniel Dunbare10787e2009-08-07 08:26:05 +0000783 }
784}
785
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000786static std::pair<StringRef, StringRef>
Jakob Stoklund Olesend7b66962012-08-22 23:33:58 +0000787parseTwoOperandConstraint(StringRef S, ArrayRef<SMLoc> Loc) {
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000788 // Split via the '='.
789 std::pair<StringRef, StringRef> Ops = S.split('=');
790 if (Ops.second == "")
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000791 PrintFatalError(Loc, "missing '=' in two-operand alias constraint");
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000792 // Trim whitespace and the leading '$' on the operand names.
793 size_t start = Ops.first.find_first_of('$');
794 if (start == std::string::npos)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000795 PrintFatalError(Loc, "expected '$' prefix on asm operand name");
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000796 Ops.first = Ops.first.slice(start + 1, std::string::npos);
797 size_t end = Ops.first.find_last_of(" \t");
798 Ops.first = Ops.first.slice(0, end);
799 // Now the second operand.
800 start = Ops.second.find_first_of('$');
801 if (start == std::string::npos)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000802 PrintFatalError(Loc, "expected '$' prefix on asm operand name");
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000803 Ops.second = Ops.second.slice(start + 1, std::string::npos);
804 end = Ops.second.find_last_of(" \t");
805 Ops.first = Ops.first.slice(0, end);
806 return Ops;
807}
808
809void MatchableInfo::formTwoOperandAlias(StringRef Constraint) {
810 // Figure out which operands are aliased and mark them as tied.
811 std::pair<StringRef, StringRef> Ops =
812 parseTwoOperandConstraint(Constraint, TheDef->getLoc());
813
814 // Find the AsmOperands that refer to the operands we're aliasing.
815 int SrcAsmOperand = findAsmOperandNamed(Ops.first);
816 int DstAsmOperand = findAsmOperandNamed(Ops.second);
817 if (SrcAsmOperand == -1)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000818 PrintFatalError(TheDef->getLoc(),
Benjamin Kramer48e7e852014-03-29 17:17:15 +0000819 "unknown source two-operand alias operand '" + Ops.first +
820 "'.");
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000821 if (DstAsmOperand == -1)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000822 PrintFatalError(TheDef->getLoc(),
Benjamin Kramer48e7e852014-03-29 17:17:15 +0000823 "unknown destination two-operand alias operand '" +
824 Ops.second + "'.");
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000825
826 // Find the ResOperand that refers to the operand we're aliasing away
827 // and update it to refer to the combined operand instead.
Craig Toppere4e74152015-12-29 07:03:23 +0000828 for (ResOperand &Op : ResOperands) {
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000829 if (Op.Kind == ResOperand::RenderAsmOperand &&
830 Op.AsmOperandNum == (unsigned)SrcAsmOperand) {
831 Op.AsmOperandNum = DstAsmOperand;
832 break;
833 }
834 }
835 // Remove the AsmOperand for the alias operand.
836 AsmOperands.erase(AsmOperands.begin() + SrcAsmOperand);
837 // Adjust the ResOperand references to any AsmOperands that followed
838 // the one we just deleted.
Craig Toppere4e74152015-12-29 07:03:23 +0000839 for (ResOperand &Op : ResOperands) {
Jim Grosbach31c2d3f2012-04-19 23:59:23 +0000840 switch(Op.Kind) {
841 default:
842 // Nothing to do for operands that don't reference AsmOperands.
843 break;
844 case ResOperand::RenderAsmOperand:
845 if (Op.AsmOperandNum > (unsigned)SrcAsmOperand)
846 --Op.AsmOperandNum;
847 break;
848 case ResOperand::TiedOperand:
849 if (Op.TiedOperandNum > (unsigned)SrcAsmOperand)
850 --Op.TiedOperandNum;
851 break;
852 }
853 }
854}
855
Craig Topper22fa45f2015-09-13 18:01:25 +0000856/// extractSingletonRegisterForAsmOperand - Extract singleton register,
857/// if present, from specified token.
858static void
859extractSingletonRegisterForAsmOperand(MatchableInfo::AsmOperand &Op,
860 const AsmMatcherInfo &Info,
861 StringRef RegisterPrefix) {
862 StringRef Tok = Op.Token;
863
864 // If this token is not an isolated token, i.e., it isn't separated from
865 // other tokens (e.g. with whitespace), don't interpret it as a register name.
866 if (!Op.IsIsolatedToken)
867 return;
868
869 if (RegisterPrefix.empty()) {
870 std::string LoweredTok = Tok.lower();
871 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(LoweredTok))
872 Op.SingletonReg = Reg->TheDef;
873 return;
874 }
875
876 if (!Tok.startswith(RegisterPrefix))
877 return;
878
879 StringRef RegName = Tok.substr(RegisterPrefix.size());
880 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(RegName))
881 Op.SingletonReg = Reg->TheDef;
882
883 // If there is no register prefix (i.e. "%" in "%eax"), then this may
884 // be some random non-register token, just ignore it.
Craig Topper22fa45f2015-09-13 18:01:25 +0000885}
886
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000887void MatchableInfo::initialize(const AsmMatcherInfo &Info,
Craig Topper71b7b682014-08-21 05:55:13 +0000888 SmallPtrSetImpl<Record*> &SingletonRegisters,
Craig Topperfd2c6a32015-12-31 08:18:23 +0000889 AsmVariantInfo const &Variant,
890 bool HasMnemonicFirst) {
Craig Topperc8b5b252015-12-30 06:00:18 +0000891 AsmVariantID = Variant.AsmVariantNo;
Jim Grosbach0bba00d2012-01-24 21:06:59 +0000892 AsmString =
Craig Topperc8b5b252015-12-30 06:00:18 +0000893 CodeGenInstruction::FlattenAsmStringVariants(AsmString,
894 Variant.AsmVariantNo);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000895
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000896 tokenizeAsmString(Info, Variant);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000897
Craig Topperfd2c6a32015-12-31 08:18:23 +0000898 // The first token of the instruction is the mnemonic, which must be a
899 // simple string, not a $foo variable or a singleton register.
900 if (AsmOperands.empty())
901 PrintFatalError(TheDef->getLoc(),
902 "Instruction '" + TheDef->getName() + "' has no tokens");
903
904 assert(!AsmOperands[0].Token.empty());
905 if (HasMnemonicFirst) {
906 Mnemonic = AsmOperands[0].Token;
907 if (Mnemonic[0] == '$')
908 PrintFatalError(TheDef->getLoc(),
909 "Invalid instruction mnemonic '" + Mnemonic + "'!");
910
911 // Remove the first operand, it is tracked in the mnemonic field.
912 AsmOperands.erase(AsmOperands.begin());
913 } else if (AsmOperands[0].Token[0] != '$')
914 Mnemonic = AsmOperands[0].Token;
915
Chris Lattnerba465f92010-11-01 04:53:48 +0000916 // Compute the require features.
Craig Topper22fa45f2015-09-13 18:01:25 +0000917 for (Record *Predicate : TheDef->getValueAsListOfDefs("Predicates"))
David Blaikie9a9da992014-11-28 22:15:06 +0000918 if (const SubtargetFeatureInfo *Feature =
Craig Topper22fa45f2015-09-13 18:01:25 +0000919 Info.getSubtargetFeature(Predicate))
Chris Lattnerba465f92010-11-01 04:53:48 +0000920 RequiredFeatures.push_back(Feature);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +0000921
Chris Lattnerba465f92010-11-01 04:53:48 +0000922 // Collect singleton registers, if used.
Craig Topper22fa45f2015-09-13 18:01:25 +0000923 for (MatchableInfo::AsmOperand &Op : AsmOperands) {
Craig Topperc8b5b252015-12-30 06:00:18 +0000924 extractSingletonRegisterForAsmOperand(Op, Info, Variant.RegisterPrefix);
Craig Topper22fa45f2015-09-13 18:01:25 +0000925 if (Record *Reg = Op.SingletonReg)
Chris Lattnerba465f92010-11-01 04:53:48 +0000926 SingletonRegisters.insert(Reg);
927 }
Joey Gouly0e76fa72013-09-12 10:28:05 +0000928
929 const RecordVal *DepMask = TheDef->getValue("DeprecatedFeatureMask");
930 if (!DepMask)
931 DepMask = TheDef->getValue("ComplexDeprecationPredicate");
932
933 HasDeprecation =
934 DepMask ? !DepMask->getValue()->getAsUnquotedString().empty() : false;
Chris Lattnerba465f92010-11-01 04:53:48 +0000935}
936
Ahmed Bougachad8dc2ac2015-05-29 00:55:55 +0000937/// Append an AsmOperand for the given substring of AsmString.
Craig Topperbc22e262015-12-31 05:01:45 +0000938void MatchableInfo::addAsmOperand(StringRef Token, bool IsIsolatedToken) {
939 AsmOperands.push_back(AsmOperand(IsIsolatedToken, Token));
Ahmed Bougachad8dc2ac2015-05-29 00:55:55 +0000940}
941
Jim Grosbach8c2beaa2012-04-19 17:52:32 +0000942/// tokenizeAsmString - Tokenize a simplified assembly string.
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000943void MatchableInfo::tokenizeAsmString(const AsmMatcherInfo &Info,
944 AsmVariantInfo const &Variant) {
Chris Lattner28ea9b12010-11-02 17:30:52 +0000945 StringRef String = AsmString;
Craig Topperba614322015-12-30 06:00:15 +0000946 size_t Prev = 0;
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000947 bool InTok = false;
Craig Topperbc22e262015-12-31 05:01:45 +0000948 bool IsIsolatedToken = true;
Craig Topperba614322015-12-30 06:00:15 +0000949 for (size_t i = 0, e = String.size(); i != e; ++i) {
Craig Topperbc22e262015-12-31 05:01:45 +0000950 char Char = String[i];
951 if (Variant.BreakCharacters.find(Char) != std::string::npos) {
952 if (InTok) {
953 addAsmOperand(String.slice(Prev, i), false);
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000954 Prev = i;
Craig Topperbc22e262015-12-31 05:01:45 +0000955 IsIsolatedToken = false;
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000956 }
957 InTok = true;
958 continue;
959 }
Craig Topperbc22e262015-12-31 05:01:45 +0000960 if (Variant.TokenizingCharacters.find(Char) != std::string::npos) {
961 if (InTok) {
962 addAsmOperand(String.slice(Prev, i), IsIsolatedToken);
Chris Lattner28ea9b12010-11-02 17:30:52 +0000963 InTok = false;
Craig Topperbc22e262015-12-31 05:01:45 +0000964 IsIsolatedToken = false;
Chris Lattner28ea9b12010-11-02 17:30:52 +0000965 }
Craig Topperbc22e262015-12-31 05:01:45 +0000966 addAsmOperand(String.slice(i, i + 1), IsIsolatedToken);
Chris Lattner28ea9b12010-11-02 17:30:52 +0000967 Prev = i + 1;
Craig Topperbc22e262015-12-31 05:01:45 +0000968 IsIsolatedToken = true;
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000969 continue;
970 }
Craig Topperbc22e262015-12-31 05:01:45 +0000971 if (Variant.SeparatorCharacters.find(Char) != std::string::npos) {
972 if (InTok) {
973 addAsmOperand(String.slice(Prev, i), IsIsolatedToken);
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000974 InTok = false;
975 }
976 Prev = i + 1;
Craig Topperbc22e262015-12-31 05:01:45 +0000977 IsIsolatedToken = true;
Colin LeMahieu8a0453e2015-11-09 00:31:07 +0000978 continue;
979 }
Craig Topperbc22e262015-12-31 05:01:45 +0000980
981 switch (Char) {
Chris Lattner28ea9b12010-11-02 17:30:52 +0000982 case '\\':
983 if (InTok) {
Craig Topperbc22e262015-12-31 05:01:45 +0000984 addAsmOperand(String.slice(Prev, i), false);
Chris Lattner28ea9b12010-11-02 17:30:52 +0000985 InTok = false;
Craig Topperbc22e262015-12-31 05:01:45 +0000986 IsIsolatedToken = false;
Chris Lattner28ea9b12010-11-02 17:30:52 +0000987 }
988 ++i;
989 assert(i != String.size() && "Invalid quoted character");
Craig Topperbc22e262015-12-31 05:01:45 +0000990 addAsmOperand(String.slice(i, i + 1), IsIsolatedToken);
Chris Lattner28ea9b12010-11-02 17:30:52 +0000991 Prev = i + 1;
Craig Topperbc22e262015-12-31 05:01:45 +0000992 IsIsolatedToken = false;
Chris Lattner28ea9b12010-11-02 17:30:52 +0000993 break;
994
995 case '$': {
Craig Topperbc22e262015-12-31 05:01:45 +0000996 if (InTok) {
997 addAsmOperand(String.slice(Prev, i), false);
Chris Lattner28ea9b12010-11-02 17:30:52 +0000998 InTok = false;
Craig Topperbc22e262015-12-31 05:01:45 +0000999 IsIsolatedToken = false;
Chris Lattner28ea9b12010-11-02 17:30:52 +00001000 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001001
Colin LeMahieu3d905742015-08-10 19:58:06 +00001002 // If this isn't "${", start new identifier looking like "$xxx"
Chris Lattnerd6746d52010-11-06 22:06:03 +00001003 if (i + 1 == String.size() || String[i + 1] != '{') {
1004 Prev = i;
1005 break;
1006 }
Chris Lattner28ea9b12010-11-02 17:30:52 +00001007
Craig Topperba614322015-12-30 06:00:15 +00001008 size_t EndPos = String.find('}', i);
1009 assert(EndPos != StringRef::npos &&
1010 "Missing brace in operand reference!");
Craig Topperbc22e262015-12-31 05:01:45 +00001011 addAsmOperand(String.slice(i, EndPos+1), IsIsolatedToken);
Chris Lattner28ea9b12010-11-02 17:30:52 +00001012 Prev = EndPos + 1;
1013 i = EndPos;
Craig Topperbc22e262015-12-31 05:01:45 +00001014 IsIsolatedToken = false;
Chris Lattner28ea9b12010-11-02 17:30:52 +00001015 break;
1016 }
Craig Topperbc22e262015-12-31 05:01:45 +00001017
Chris Lattner28ea9b12010-11-02 17:30:52 +00001018 default:
1019 InTok = true;
Craig Topperbc22e262015-12-31 05:01:45 +00001020 break;
Chris Lattner28ea9b12010-11-02 17:30:52 +00001021 }
1022 }
1023 if (InTok && Prev != String.size())
Craig Topperbc22e262015-12-31 05:01:45 +00001024 addAsmOperand(String.substr(Prev), IsIsolatedToken);
Chris Lattner28ea9b12010-11-02 17:30:52 +00001025}
1026
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001027bool MatchableInfo::validate(StringRef CommentDelimiter, bool Hack) const {
Chris Lattnerad776812010-11-01 05:06:45 +00001028 // Reject matchables with no .s string.
Chris Lattner39bc53b2010-11-01 04:34:44 +00001029 if (AsmString.empty())
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001030 PrintFatalError(TheDef->getLoc(), "instruction with empty asm string");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001031
Chris Lattnerad776812010-11-01 05:06:45 +00001032 // Reject any matchables with a newline in them, they should be marked
Chris Lattner39bc53b2010-11-01 04:34:44 +00001033 // isCodeGenOnly if they are pseudo instructions.
1034 if (AsmString.find('\n') != std::string::npos)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001035 PrintFatalError(TheDef->getLoc(),
Chris Lattner39bc53b2010-11-01 04:34:44 +00001036 "multiline instruction is not valid for the asmparser, "
1037 "mark it isCodeGenOnly");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001038
Chris Lattner178f4bb2010-11-01 04:44:29 +00001039 // Remove comments from the asm string. We know that the asmstring only
1040 // has one line.
1041 if (!CommentDelimiter.empty() &&
1042 StringRef(AsmString).find(CommentDelimiter) != StringRef::npos)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001043 PrintFatalError(TheDef->getLoc(),
Chris Lattner178f4bb2010-11-01 04:44:29 +00001044 "asmstring for instruction has comment character in it, "
1045 "mark it isCodeGenOnly");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001046
Chris Lattnerad776812010-11-01 05:06:45 +00001047 // Reject matchables with operand modifiers, these aren't something we can
Bob Wilson266d2ba2011-01-20 18:38:07 +00001048 // handle, the target should be refactored to use operands instead of
1049 // modifiers.
Chris Lattner39bc53b2010-11-01 04:34:44 +00001050 //
1051 // Also, check for instructions which reference the operand multiple times;
1052 // this implies a constraint we would not honor.
1053 std::set<std::string> OperandNames;
Craig Topper77bd2b72015-12-30 06:00:20 +00001054 for (const AsmOperand &Op : AsmOperands) {
1055 StringRef Tok = Op.Token;
Chris Lattner28ea9b12010-11-02 17:30:52 +00001056 if (Tok[0] == '$' && Tok.find(':') != StringRef::npos)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001057 PrintFatalError(TheDef->getLoc(),
Benjamin Kramer48e7e852014-03-29 17:17:15 +00001058 "matchable with operand modifier '" + Tok +
1059 "' not supported by asm matcher. Mark isCodeGenOnly!");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001060
Chris Lattnerad776812010-11-01 05:06:45 +00001061 // Verify that any operand is only mentioned once.
Chris Lattner4d23eb22010-11-02 23:18:43 +00001062 // We reject aliases and ignore instructions for now.
Chris Lattner28ea9b12010-11-02 17:30:52 +00001063 if (Tok[0] == '$' && !OperandNames.insert(Tok).second) {
Chris Lattnerad776812010-11-01 05:06:45 +00001064 if (!Hack)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001065 PrintFatalError(TheDef->getLoc(),
Benjamin Kramer48e7e852014-03-29 17:17:15 +00001066 "ERROR: matchable with tied operand '" + Tok +
1067 "' can never be matched!");
Chris Lattnerad776812010-11-01 05:06:45 +00001068 // FIXME: Should reject these. The ARM backend hits this with $lane in a
1069 // bunch of instructions. It is unclear what the right answer is.
Chris Lattner39bc53b2010-11-01 04:34:44 +00001070 DEBUG({
Chris Lattner9f093812010-11-06 06:43:11 +00001071 errs() << "warning: '" << TheDef->getName() << "': "
Chris Lattnerad776812010-11-01 05:06:45 +00001072 << "ignoring instruction with tied operand '"
Benjamin Kramer48e7e852014-03-29 17:17:15 +00001073 << Tok << "'\n";
Chris Lattner39bc53b2010-11-01 04:34:44 +00001074 });
1075 return false;
1076 }
1077 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001078
Chris Lattner39bc53b2010-11-01 04:34:44 +00001079 return true;
1080}
1081
Chris Lattner60db0a62010-02-09 00:34:28 +00001082static std::string getEnumNameForToken(StringRef Str) {
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001083 std::string Res;
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001084
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001085 for (StringRef::iterator it = Str.begin(), ie = Str.end(); it != ie; ++it) {
1086 switch (*it) {
1087 case '*': Res += "_STAR_"; break;
1088 case '%': Res += "_PCT_"; break;
1089 case ':': Res += "_COLON_"; break;
Bill Wendling4a08e562010-11-18 23:36:54 +00001090 case '!': Res += "_EXCLAIM_"; break;
Bill Wendlinga01ea892011-01-22 09:44:32 +00001091 case '.': Res += "_DOT_"; break;
Tim Northoverb3cfb282013-01-10 16:47:31 +00001092 case '<': Res += "_LT_"; break;
1093 case '>': Res += "_GT_"; break;
Hal Finkelf9090722015-01-15 01:33:00 +00001094 case '-': Res += "_MINUS_"; break;
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001095 default:
Tim Northoverb3cfb282013-01-10 16:47:31 +00001096 if ((*it >= 'A' && *it <= 'Z') ||
1097 (*it >= 'a' && *it <= 'z') ||
1098 (*it >= '0' && *it <= '9'))
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001099 Res += *it;
Chris Lattner33fc3e02010-10-31 19:10:56 +00001100 else
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001101 Res += "_" + utostr((unsigned) *it) + "_";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001102 }
1103 }
1104
1105 return Res;
1106}
1107
Chris Lattner60db0a62010-02-09 00:34:28 +00001108ClassInfo *AsmMatcherInfo::getTokenClass(StringRef Token) {
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001109 ClassInfo *&Entry = TokenClasses[Token];
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001110
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001111 if (!Entry) {
David Blaikied749e342014-11-28 20:35:57 +00001112 Classes.emplace_front();
1113 Entry = &Classes.front();
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001114 Entry->Kind = ClassInfo::Token;
Daniel Dunbarc32aa062009-08-09 05:18:30 +00001115 Entry->ClassName = "Token";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001116 Entry->Name = "MCK_" + getEnumNameForToken(Token);
1117 Entry->ValueName = Token;
1118 Entry->PredicateMethod = "<invalid>";
1119 Entry->RenderMethod = "<invalid>";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001120 Entry->ParserMethod = "";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00001121 Entry->DiagnosticType = "";
Tom Stellardb9f235e2016-02-05 19:59:33 +00001122 Entry->IsOptional = false;
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001123 }
1124
1125 return Entry;
1126}
1127
1128ClassInfo *
Bob Wilsonb9b24222011-01-26 19:44:55 +00001129AsmMatcherInfo::getOperandClass(const CGIOperandList::OperandInfo &OI,
1130 int SubOpIdx) {
1131 Record *Rec = OI.Rec;
1132 if (SubOpIdx != -1)
Sean Silva88eb8dd2012-10-10 20:24:47 +00001133 Rec = cast<DefInit>(OI.MIOperandInfo->getArg(SubOpIdx))->getDef();
Jim Grosbachd1f1b792011-10-28 22:32:53 +00001134 return getOperandClass(Rec, SubOpIdx);
1135}
Bob Wilsonb9b24222011-01-26 19:44:55 +00001136
Jim Grosbachd1f1b792011-10-28 22:32:53 +00001137ClassInfo *
1138AsmMatcherInfo::getOperandClass(Record *Rec, int SubOpIdx) {
Owen Andersona84be6c2011-06-27 21:06:21 +00001139 if (Rec->isSubClassOf("RegisterOperand")) {
1140 // RegisterOperand may have an associated ParserMatchClass. If it does,
1141 // use it, else just fall back to the underlying register class.
1142 const RecordVal *R = Rec->getValue("ParserMatchClass");
Craig Topper24064772014-04-15 07:20:03 +00001143 if (!R || !R->getValue())
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001144 PrintFatalError("Record `" + Rec->getName() +
1145 "' does not have a ParserMatchClass!\n");
Owen Andersona84be6c2011-06-27 21:06:21 +00001146
Sean Silvafb509ed2012-10-10 20:24:43 +00001147 if (DefInit *DI= dyn_cast<DefInit>(R->getValue())) {
Owen Andersona84be6c2011-06-27 21:06:21 +00001148 Record *MatchClass = DI->getDef();
1149 if (ClassInfo *CI = AsmOperandClasses[MatchClass])
1150 return CI;
1151 }
1152
1153 // No custom match class. Just use the register class.
1154 Record *ClassRec = Rec->getValueAsDef("RegClass");
1155 if (!ClassRec)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001156 PrintFatalError(Rec->getLoc(), "RegisterOperand `" + Rec->getName() +
Owen Andersona84be6c2011-06-27 21:06:21 +00001157 "' has no associated register class!\n");
1158 if (ClassInfo *CI = RegisterClassClasses[ClassRec])
1159 return CI;
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001160 PrintFatalError(Rec->getLoc(), "register class has no class info!");
Owen Andersona84be6c2011-06-27 21:06:21 +00001161 }
1162
Bob Wilsonb9b24222011-01-26 19:44:55 +00001163 if (Rec->isSubClassOf("RegisterClass")) {
1164 if (ClassInfo *CI = RegisterClassClasses[Rec])
Chris Lattner77d3ead2010-11-02 18:10:06 +00001165 return CI;
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001166 PrintFatalError(Rec->getLoc(), "register class has no class info!");
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001167 }
Daniel Dunbar8e33cb22009-08-09 07:20:21 +00001168
Jim Grosbachf6cb1ee2012-09-12 17:40:25 +00001169 if (!Rec->isSubClassOf("Operand"))
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001170 PrintFatalError(Rec->getLoc(), "Operand `" + Rec->getName() +
Jim Grosbachf6cb1ee2012-09-12 17:40:25 +00001171 "' does not derive from class Operand!\n");
Bob Wilsonb9b24222011-01-26 19:44:55 +00001172 Record *MatchClass = Rec->getValueAsDef("ParserMatchClass");
Chris Lattner77d3ead2010-11-02 18:10:06 +00001173 if (ClassInfo *CI = AsmOperandClasses[MatchClass])
1174 return CI;
Daniel Dunbar17410a42009-08-10 18:41:10 +00001175
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001176 PrintFatalError(Rec->getLoc(), "operand has no match class!");
Daniel Dunbar541efcc2009-08-08 07:50:56 +00001177}
1178
Tim Northoverc74e6912013-09-16 16:43:19 +00001179struct LessRegisterSet {
Tim Northover9c30f7a2013-09-16 17:33:40 +00001180 bool operator() (const RegisterSet &LHS, const RegisterSet & RHS) const {
Tim Northoverc74e6912013-09-16 16:43:19 +00001181 // std::set<T> defines its own compariso "operator<", but it
1182 // performs a lexicographical comparison by T's innate comparison
1183 // for some reason. We don't want non-deterministic pointer
1184 // comparisons so use this instead.
1185 return std::lexicographical_compare(LHS.begin(), LHS.end(),
1186 RHS.begin(), RHS.end(),
1187 LessRecordByID());
1188 }
1189};
1190
Chris Lattnerf7a01e92010-11-01 01:47:07 +00001191void AsmMatcherInfo::
Craig Topper71b7b682014-08-21 05:55:13 +00001192buildRegisterClasses(SmallPtrSetImpl<Record*> &SingletonRegisters) {
David Blaikie9b613db2014-11-29 18:13:39 +00001193 const auto &Registers = Target.getRegBank().getRegisters();
David Blaikiec0bb5ca2014-12-03 19:58:41 +00001194 auto &RegClassList = Target.getRegBank().getRegClasses();
Daniel Dunbar17410a42009-08-10 18:41:10 +00001195
Tim Northoverc74e6912013-09-16 16:43:19 +00001196 typedef std::set<RegisterSet, LessRegisterSet> RegisterSetSet;
1197
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001198 // The register sets used for matching.
Tim Northoverc74e6912013-09-16 16:43:19 +00001199 RegisterSetSet RegisterSets;
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001200
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001201 // Gather the defined sets.
David Blaikiedacea4b2014-12-03 19:58:45 +00001202 for (const CodeGenRegisterClass &RC : RegClassList)
1203 RegisterSets.insert(
1204 RegisterSet(RC.getOrder().begin(), RC.getOrder().end()));
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001205
1206 // Add any required singleton sets.
Craig Topper03ec8012014-11-25 20:11:31 +00001207 for (Record *Rec : SingletonRegisters) {
Tim Northoverc74e6912013-09-16 16:43:19 +00001208 RegisterSets.insert(RegisterSet(&Rec, &Rec + 1));
Chris Lattnerf7a01e92010-11-01 01:47:07 +00001209 }
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001210
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001211 // Introduce derived sets where necessary (when a register does not determine
1212 // a unique register set class), and build the mapping of registers to the set
1213 // they should classify to.
Tim Northoverc74e6912013-09-16 16:43:19 +00001214 std::map<Record*, RegisterSet> RegisterMap;
David Blaikie9b613db2014-11-29 18:13:39 +00001215 for (const CodeGenRegister &CGR : Registers) {
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001216 // Compute the intersection of all sets containing this register.
Tim Northoverc74e6912013-09-16 16:43:19 +00001217 RegisterSet ContainingSet;
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001218
Craig Topper03ec8012014-11-25 20:11:31 +00001219 for (const RegisterSet &RS : RegisterSets) {
David Blaikie9b613db2014-11-29 18:13:39 +00001220 if (!RS.count(CGR.TheDef))
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001221 continue;
1222
1223 if (ContainingSet.empty()) {
Craig Topper03ec8012014-11-25 20:11:31 +00001224 ContainingSet = RS;
Chris Lattner77d3ead2010-11-02 18:10:06 +00001225 continue;
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001226 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001227
Tim Northoverc74e6912013-09-16 16:43:19 +00001228 RegisterSet Tmp;
Chris Lattner77d3ead2010-11-02 18:10:06 +00001229 std::swap(Tmp, ContainingSet);
Tim Northoverc74e6912013-09-16 16:43:19 +00001230 std::insert_iterator<RegisterSet> II(ContainingSet,
1231 ContainingSet.begin());
Craig Topper03ec8012014-11-25 20:11:31 +00001232 std::set_intersection(Tmp.begin(), Tmp.end(), RS.begin(), RS.end(), II,
Tim Northoverc74e6912013-09-16 16:43:19 +00001233 LessRecordByID());
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001234 }
1235
1236 if (!ContainingSet.empty()) {
1237 RegisterSets.insert(ContainingSet);
David Blaikie9b613db2014-11-29 18:13:39 +00001238 RegisterMap.insert(std::make_pair(CGR.TheDef, ContainingSet));
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001239 }
1240 }
1241
1242 // Construct the register classes.
Tim Northoverc74e6912013-09-16 16:43:19 +00001243 std::map<RegisterSet, ClassInfo*, LessRegisterSet> RegisterSetClasses;
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001244 unsigned Index = 0;
Craig Topper03ec8012014-11-25 20:11:31 +00001245 for (const RegisterSet &RS : RegisterSets) {
David Blaikied749e342014-11-28 20:35:57 +00001246 Classes.emplace_front();
1247 ClassInfo *CI = &Classes.front();
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001248 CI->Kind = ClassInfo::RegisterClass0 + Index;
1249 CI->ClassName = "Reg" + utostr(Index);
1250 CI->Name = "MCK_Reg" + utostr(Index);
1251 CI->ValueName = "";
1252 CI->PredicateMethod = ""; // unused
1253 CI->RenderMethod = "addRegOperands";
Craig Topper03ec8012014-11-25 20:11:31 +00001254 CI->Registers = RS;
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00001255 // FIXME: diagnostic type.
1256 CI->DiagnosticType = "";
Tom Stellardb9f235e2016-02-05 19:59:33 +00001257 CI->IsOptional = false;
Craig Topper03ec8012014-11-25 20:11:31 +00001258 RegisterSetClasses.insert(std::make_pair(RS, CI));
1259 ++Index;
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001260 }
1261
1262 // Find the superclasses; we could compute only the subgroup lattice edges,
1263 // but there isn't really a point.
Craig Topper03ec8012014-11-25 20:11:31 +00001264 for (const RegisterSet &RS : RegisterSets) {
1265 ClassInfo *CI = RegisterSetClasses[RS];
1266 for (const RegisterSet &RS2 : RegisterSets)
1267 if (RS != RS2 &&
1268 std::includes(RS2.begin(), RS2.end(), RS.begin(), RS.end(),
Tim Northoverc74e6912013-09-16 16:43:19 +00001269 LessRecordByID()))
Craig Topper03ec8012014-11-25 20:11:31 +00001270 CI->SuperClasses.push_back(RegisterSetClasses[RS2]);
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001271 }
1272
1273 // Name the register classes which correspond to a user defined RegisterClass.
David Blaikiedacea4b2014-12-03 19:58:45 +00001274 for (const CodeGenRegisterClass &RC : RegClassList) {
Jakob Stoklund Olesenbd92dc62011-10-04 15:28:08 +00001275 // Def will be NULL for non-user defined register classes.
David Blaikiedacea4b2014-12-03 19:58:45 +00001276 Record *Def = RC.getDef();
Jakob Stoklund Olesenbd92dc62011-10-04 15:28:08 +00001277 if (!Def)
1278 continue;
David Blaikiedacea4b2014-12-03 19:58:45 +00001279 ClassInfo *CI = RegisterSetClasses[RegisterSet(RC.getOrder().begin(),
1280 RC.getOrder().end())];
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001281 if (CI->ValueName.empty()) {
David Blaikiedacea4b2014-12-03 19:58:45 +00001282 CI->ClassName = RC.getName();
1283 CI->Name = "MCK_" + RC.getName();
1284 CI->ValueName = RC.getName();
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001285 } else
David Blaikiedacea4b2014-12-03 19:58:45 +00001286 CI->ValueName = CI->ValueName + "," + RC.getName();
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001287
Jakob Stoklund Olesenbd92dc62011-10-04 15:28:08 +00001288 RegisterClassClasses.insert(std::make_pair(Def, CI));
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001289 }
1290
1291 // Populate the map for individual registers.
Tim Northoverc74e6912013-09-16 16:43:19 +00001292 for (std::map<Record*, RegisterSet>::iterator it = RegisterMap.begin(),
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001293 ie = RegisterMap.end(); it != ie; ++it)
Chris Lattner77d3ead2010-11-02 18:10:06 +00001294 RegisterClasses[it->first] = RegisterSetClasses[it->second];
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001295
1296 // Name the register classes which correspond to singleton registers.
Craig Topper03ec8012014-11-25 20:11:31 +00001297 for (Record *Rec : SingletonRegisters) {
Chris Lattner77d3ead2010-11-02 18:10:06 +00001298 ClassInfo *CI = RegisterClasses[Rec];
Chris Lattnerf7a01e92010-11-01 01:47:07 +00001299 assert(CI && "Missing singleton register class info!");
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001300
Chris Lattnerf7a01e92010-11-01 01:47:07 +00001301 if (CI->ValueName.empty()) {
1302 CI->ClassName = Rec->getName();
1303 CI->Name = "MCK_" + Rec->getName();
1304 CI->ValueName = Rec->getName();
1305 } else
1306 CI->ValueName = CI->ValueName + "," + Rec->getName();
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001307 }
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001308}
1309
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001310void AsmMatcherInfo::buildOperandClasses() {
Chris Lattnere3c48de2010-11-01 23:57:23 +00001311 std::vector<Record*> AsmOperands =
1312 Records.getAllDerivedDefinitions("AsmOperandClass");
Daniel Dunbarcf181532010-01-30 01:02:37 +00001313
1314 // Pre-populate AsmOperandClasses map.
David Blaikied749e342014-11-28 20:35:57 +00001315 for (Record *Rec : AsmOperands) {
1316 Classes.emplace_front();
1317 AsmOperandClasses[Rec] = &Classes.front();
1318 }
Daniel Dunbarcf181532010-01-30 01:02:37 +00001319
Daniel Dunbar17410a42009-08-10 18:41:10 +00001320 unsigned Index = 0;
Craig Topper03ec8012014-11-25 20:11:31 +00001321 for (Record *Rec : AsmOperands) {
1322 ClassInfo *CI = AsmOperandClasses[Rec];
Daniel Dunbar17410a42009-08-10 18:41:10 +00001323 CI->Kind = ClassInfo::UserClass0 + Index;
1324
Craig Topper03ec8012014-11-25 20:11:31 +00001325 ListInit *Supers = Rec->getValueAsListInit("SuperClasses");
Craig Topperef0578a2015-06-02 04:15:51 +00001326 for (Init *I : Supers->getValues()) {
1327 DefInit *DI = dyn_cast<DefInit>(I);
Daniel Dunbar346782c2010-05-22 21:02:29 +00001328 if (!DI) {
Craig Topper03ec8012014-11-25 20:11:31 +00001329 PrintError(Rec->getLoc(), "Invalid super class reference!");
Daniel Dunbar346782c2010-05-22 21:02:29 +00001330 continue;
1331 }
1332
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001333 ClassInfo *SC = AsmOperandClasses[DI->getDef()];
1334 if (!SC)
Craig Topper03ec8012014-11-25 20:11:31 +00001335 PrintError(Rec->getLoc(), "Invalid super class reference!");
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001336 else
1337 CI->SuperClasses.push_back(SC);
Daniel Dunbar17410a42009-08-10 18:41:10 +00001338 }
Craig Topper03ec8012014-11-25 20:11:31 +00001339 CI->ClassName = Rec->getValueAsString("Name");
Daniel Dunbar17410a42009-08-10 18:41:10 +00001340 CI->Name = "MCK_" + CI->ClassName;
Craig Topper03ec8012014-11-25 20:11:31 +00001341 CI->ValueName = Rec->getName();
Daniel Dunbaraeb1feb2009-08-10 21:00:45 +00001342
1343 // Get or construct the predicate method name.
Craig Topper03ec8012014-11-25 20:11:31 +00001344 Init *PMName = Rec->getValueInit("PredicateMethod");
Sean Silvafb509ed2012-10-10 20:24:43 +00001345 if (StringInit *SI = dyn_cast<StringInit>(PMName)) {
Daniel Dunbaraeb1feb2009-08-10 21:00:45 +00001346 CI->PredicateMethod = SI->getValue();
1347 } else {
Sean Silva88eb8dd2012-10-10 20:24:47 +00001348 assert(isa<UnsetInit>(PMName) && "Unexpected PredicateMethod field!");
Daniel Dunbaraeb1feb2009-08-10 21:00:45 +00001349 CI->PredicateMethod = "is" + CI->ClassName;
1350 }
1351
1352 // Get or construct the render method name.
Craig Topper03ec8012014-11-25 20:11:31 +00001353 Init *RMName = Rec->getValueInit("RenderMethod");
Sean Silvafb509ed2012-10-10 20:24:43 +00001354 if (StringInit *SI = dyn_cast<StringInit>(RMName)) {
Daniel Dunbaraeb1feb2009-08-10 21:00:45 +00001355 CI->RenderMethod = SI->getValue();
1356 } else {
Sean Silva88eb8dd2012-10-10 20:24:47 +00001357 assert(isa<UnsetInit>(RMName) && "Unexpected RenderMethod field!");
Daniel Dunbaraeb1feb2009-08-10 21:00:45 +00001358 CI->RenderMethod = "add" + CI->ClassName + "Operands";
1359 }
1360
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001361 // Get the parse method name or leave it as empty.
Craig Topper03ec8012014-11-25 20:11:31 +00001362 Init *PRMName = Rec->getValueInit("ParserMethod");
Sean Silvafb509ed2012-10-10 20:24:43 +00001363 if (StringInit *SI = dyn_cast<StringInit>(PRMName))
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001364 CI->ParserMethod = SI->getValue();
1365
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00001366 // Get the diagnostic type or leave it as empty.
1367 // Get the parse method name or leave it as empty.
Craig Topper03ec8012014-11-25 20:11:31 +00001368 Init *DiagnosticType = Rec->getValueInit("DiagnosticType");
Sean Silvafb509ed2012-10-10 20:24:43 +00001369 if (StringInit *SI = dyn_cast<StringInit>(DiagnosticType))
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00001370 CI->DiagnosticType = SI->getValue();
1371
Tom Stellardb9f235e2016-02-05 19:59:33 +00001372 Init *IsOptional = Rec->getValueInit("IsOptional");
1373 if (BitInit *BI = dyn_cast<BitInit>(IsOptional))
1374 CI->IsOptional = BI->getValue();
1375
Craig Topper03ec8012014-11-25 20:11:31 +00001376 ++Index;
Daniel Dunbar17410a42009-08-10 18:41:10 +00001377 }
Daniel Dunbarbb98db22009-08-11 02:59:53 +00001378}
1379
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001380AsmMatcherInfo::AsmMatcherInfo(Record *asmParser,
1381 CodeGenTarget &target,
Chris Lattner89dcb682010-12-15 04:48:22 +00001382 RecordKeeper &records)
Devang Patel6d676e42012-01-07 01:33:34 +00001383 : Records(records), AsmParser(asmParser), Target(target) {
Daniel Dunbare4318712009-08-11 20:59:47 +00001384}
1385
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001386/// buildOperandMatchInfo - Build the necessary information to handle user
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001387/// defined operand parsing methods.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001388void AsmMatcherInfo::buildOperandMatchInfo() {
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001389
Jim Grosbach925a6d02012-04-18 23:46:25 +00001390 /// Map containing a mask with all operands indices that can be found for
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001391 /// that class inside a instruction.
Benjamin Kramer3a377bc2014-03-01 11:47:00 +00001392 typedef std::map<ClassInfo *, unsigned, less_ptr<ClassInfo>> OpClassMaskTy;
Sean Silva835139b2012-09-19 01:47:03 +00001393 OpClassMaskTy OpClassMask;
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001394
Craig Topperf34dad92014-11-28 03:53:02 +00001395 for (const auto &MI : Matchables) {
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001396 OpClassMask.clear();
1397
1398 // Keep track of all operands of this instructions which belong to the
1399 // same class.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001400 for (unsigned i = 0, e = MI->AsmOperands.size(); i != e; ++i) {
1401 const MatchableInfo::AsmOperand &Op = MI->AsmOperands[i];
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001402 if (Op.Class->ParserMethod.empty())
1403 continue;
1404 unsigned &OperandMask = OpClassMask[Op.Class];
1405 OperandMask |= (1 << i);
1406 }
1407
1408 // Generate operand match info for each mnemonic/operand class pair.
Craig Topper42bd8192014-11-28 03:53:00 +00001409 for (const auto &OCM : OpClassMask) {
1410 unsigned OpMask = OCM.second;
1411 ClassInfo *CI = OCM.first;
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001412 OperandMatchInfo.push_back(OperandMatchEntry::create(MI.get(), CI,
1413 OpMask));
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00001414 }
1415 }
1416}
1417
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001418void AsmMatcherInfo::buildInfo() {
Chris Lattnera0e87192010-10-30 20:07:57 +00001419 // Build information about all of the AssemblerPredicates.
1420 std::vector<Record*> AllPredicates =
1421 Records.getAllDerivedDefinitions("Predicate");
Craig Topper6e526f12016-01-03 07:33:30 +00001422 for (Record *Pred : AllPredicates) {
Chris Lattnera0e87192010-10-30 20:07:57 +00001423 // Ignore predicates that are not intended for the assembler.
1424 if (!Pred->getValueAsBit("AssemblerMatcherPredicate"))
1425 continue;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001426
Chris Lattner178f4bb2010-11-01 04:44:29 +00001427 if (Pred->getName().empty())
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001428 PrintFatalError(Pred->getLoc(), "Predicate has no name!");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001429
David Blaikie9a9da992014-11-28 22:15:06 +00001430 SubtargetFeatures.insert(std::make_pair(
1431 Pred, SubtargetFeatureInfo(Pred, SubtargetFeatures.size())));
1432 DEBUG(SubtargetFeatures.find(Pred)->second.dump());
1433 assert(SubtargetFeatures.size() <= 64 && "Too many subtarget features!");
Chris Lattnera0e87192010-10-30 20:07:57 +00001434 }
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001435
Craig Topperfd2c6a32015-12-31 08:18:23 +00001436 bool HasMnemonicFirst = AsmParser->getValueAsBit("HasMnemonicFirst");
1437
Chris Lattner33fc3e02010-10-31 19:10:56 +00001438 // Parse the instructions; we need to do this first so that we can gather the
1439 // singleton register classes.
Chris Lattnerf7a01e92010-11-01 01:47:07 +00001440 SmallPtrSet<Record*, 16> SingletonRegisters;
Devang Patel85d684a2012-01-09 19:13:28 +00001441 unsigned VariantCount = Target.getAsmParserVariantCount();
1442 for (unsigned VC = 0; VC != VariantCount; ++VC) {
1443 Record *AsmVariant = Target.getAsmParserVariant(VC);
Jim Grosbach56e63262012-04-17 00:01:04 +00001444 std::string CommentDelimiter =
1445 AsmVariant->getValueAsString("CommentDelimiter");
Colin LeMahieu8a0453e2015-11-09 00:31:07 +00001446 AsmVariantInfo Variant;
Craig Topperc8b5b252015-12-30 06:00:18 +00001447 Variant.RegisterPrefix = AsmVariant->getValueAsString("RegisterPrefix");
Colin LeMahieu8a0453e2015-11-09 00:31:07 +00001448 Variant.TokenizingCharacters =
1449 AsmVariant->getValueAsString("TokenizingCharacters");
1450 Variant.SeparatorCharacters =
1451 AsmVariant->getValueAsString("SeparatorCharacters");
1452 Variant.BreakCharacters =
1453 AsmVariant->getValueAsString("BreakCharacters");
Craig Topperc8b5b252015-12-30 06:00:18 +00001454 Variant.AsmVariantNo = AsmVariant->getValueAsInt("Variant");
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001455
Craig Topper8cc904d2016-01-17 20:38:18 +00001456 for (const CodeGenInstruction *CGI : Target.getInstructionsByEnumValue()) {
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001457
Devang Patel85d684a2012-01-09 19:13:28 +00001458 // If the tblgen -match-prefix option is specified (for tblgen hackers),
1459 // filter the set of instructions we consider.
Craig Topper03ec8012014-11-25 20:11:31 +00001460 if (!StringRef(CGI->TheDef->getName()).startswith(MatchPrefix))
Jim Grosbach3263a072012-04-11 21:02:33 +00001461 continue;
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001462
Devang Patel85d684a2012-01-09 19:13:28 +00001463 // Ignore "codegen only" instructions.
Craig Topper03ec8012014-11-25 20:11:31 +00001464 if (CGI->TheDef->getValueAsBit("isCodeGenOnly"))
Jim Grosbach3263a072012-04-11 21:02:33 +00001465 continue;
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001466
Craig Topper1c8fbd22015-09-06 03:44:50 +00001467 auto II = llvm::make_unique<MatchableInfo>(*CGI);
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001468
Craig Topperfd2c6a32015-12-31 08:18:23 +00001469 II->initialize(*this, SingletonRegisters, Variant, HasMnemonicFirst);
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001470
Devang Patel85d684a2012-01-09 19:13:28 +00001471 // Ignore instructions which shouldn't be matched and diagnose invalid
1472 // instruction definitions with an error.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001473 if (!II->validate(CommentDelimiter, true))
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001474 continue;
1475
1476 Matchables.push_back(std::move(II));
Chris Lattner743081d2010-11-04 00:43:46 +00001477 }
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001478
Devang Patel85d684a2012-01-09 19:13:28 +00001479 // Parse all of the InstAlias definitions and stick them in the list of
1480 // matchables.
1481 std::vector<Record*> AllInstAliases =
1482 Records.getAllDerivedDefinitions("InstAlias");
1483 for (unsigned i = 0, e = AllInstAliases.size(); i != e; ++i) {
David Blaikieba4e00f2014-12-22 21:26:26 +00001484 auto Alias = llvm::make_unique<CodeGenInstAlias>(AllInstAliases[i],
Craig Topperc8b5b252015-12-30 06:00:18 +00001485 Variant.AsmVariantNo,
1486 Target);
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001487
Devang Patel85d684a2012-01-09 19:13:28 +00001488 // If the tblgen -match-prefix option is specified (for tblgen hackers),
1489 // filter the set of instruction aliases we consider, based on the target
1490 // instruction.
Jim Grosbach56e63262012-04-17 00:01:04 +00001491 if (!StringRef(Alias->ResultInst->TheDef->getName())
1492 .startswith( MatchPrefix))
Jim Grosbach3263a072012-04-11 21:02:33 +00001493 continue;
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001494
Craig Topper1c8fbd22015-09-06 03:44:50 +00001495 auto II = llvm::make_unique<MatchableInfo>(std::move(Alias));
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001496
Craig Topperfd2c6a32015-12-31 08:18:23 +00001497 II->initialize(*this, SingletonRegisters, Variant, HasMnemonicFirst);
Jim Grosbach0bba00d2012-01-24 21:06:59 +00001498
Devang Patel85d684a2012-01-09 19:13:28 +00001499 // Validate the alias definitions.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001500 II->validate(CommentDelimiter, false);
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001501
1502 Matchables.push_back(std::move(II));
Devang Patel85d684a2012-01-09 19:13:28 +00001503 }
Chris Lattner488c2012010-11-01 04:05:41 +00001504 }
Chris Lattnerd8adec72010-11-01 04:03:32 +00001505
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001506 // Build info for the register classes.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001507 buildRegisterClasses(SingletonRegisters);
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001508
1509 // Build info for the user defined assembly operand classes.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001510 buildOperandClasses();
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001511
Chris Lattner4779e3e92010-11-04 00:57:06 +00001512 // Build the information about matchables, now that we have fully formed
1513 // classes.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001514 std::vector<std::unique_ptr<MatchableInfo>> NewMatchables;
Craig Topperf34dad92014-11-28 03:53:02 +00001515 for (auto &II : Matchables) {
Chris Lattner82d88ce2010-09-06 21:01:37 +00001516 // Parse the tokens after the mnemonic.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001517 // Note: buildInstructionOperandReference may insert new AsmOperands, so
Bob Wilsonb9b24222011-01-26 19:44:55 +00001518 // don't precompute the loop bound.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001519 for (unsigned i = 0; i != II->AsmOperands.size(); ++i) {
1520 MatchableInfo::AsmOperand &Op = II->AsmOperands[i];
Chris Lattner28ea9b12010-11-02 17:30:52 +00001521 StringRef Token = Op.Token;
Daniel Dunbare10787e2009-08-07 08:26:05 +00001522
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001523 // Check for singleton registers.
Craig Toppere4e74152015-12-29 07:03:23 +00001524 if (Record *RegRecord = Op.SingletonReg) {
Chris Lattner28ea9b12010-11-02 17:30:52 +00001525 Op.Class = RegisterClasses[RegRecord];
Chris Lattnerb80ab362010-11-01 01:37:30 +00001526 assert(Op.Class && Op.Class->Registers.size() == 1 &&
1527 "Unexpected class for singleton register");
Chris Lattnerb80ab362010-11-01 01:37:30 +00001528 continue;
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00001529 }
1530
Daniel Dunbare10787e2009-08-07 08:26:05 +00001531 // Check for simple tokens.
1532 if (Token[0] != '$') {
Chris Lattner28ea9b12010-11-02 17:30:52 +00001533 Op.Class = getTokenClass(Token);
Daniel Dunbare10787e2009-08-07 08:26:05 +00001534 continue;
1535 }
1536
Chris Lattnerd6746d52010-11-06 22:06:03 +00001537 if (Token.size() > 1 && isdigit(Token[1])) {
1538 Op.Class = getTokenClass(Token);
1539 continue;
1540 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001541
Chris Lattner4efe13d2010-11-04 02:11:18 +00001542 // Otherwise this is an operand reference.
Chris Lattnerccde4632010-11-04 01:58:23 +00001543 StringRef OperandName;
1544 if (Token[1] == '{')
1545 OperandName = Token.substr(2, Token.size() - 3);
1546 else
1547 OperandName = Token.substr(1);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001548
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001549 if (II->DefRec.is<const CodeGenInstruction*>())
1550 buildInstructionOperandReference(II.get(), OperandName, i);
Chris Lattner4efe13d2010-11-04 02:11:18 +00001551 else
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001552 buildAliasOperandReference(II.get(), OperandName, Op);
Daniel Dunbare10787e2009-08-07 08:26:05 +00001553 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001554
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001555 if (II->DefRec.is<const CodeGenInstruction*>()) {
1556 II->buildInstructionResultOperands();
Jim Grosbach31c2d3f2012-04-19 23:59:23 +00001557 // If the instruction has a two-operand alias, build up the
1558 // matchable here. We'll add them in bulk at the end to avoid
1559 // confusing this loop.
1560 std::string Constraint =
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001561 II->TheDef->getValueAsString("TwoOperandAliasConstraint");
Jim Grosbach31c2d3f2012-04-19 23:59:23 +00001562 if (Constraint != "") {
1563 // Start by making a copy of the original matchable.
Craig Topper1c8fbd22015-09-06 03:44:50 +00001564 auto AliasII = llvm::make_unique<MatchableInfo>(*II);
Jim Grosbach31c2d3f2012-04-19 23:59:23 +00001565
1566 // Adjust it to be a two-operand alias.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001567 AliasII->formTwoOperandAlias(Constraint);
1568
1569 // Add the alias to the matchables list.
1570 NewMatchables.push_back(std::move(AliasII));
Jim Grosbach31c2d3f2012-04-19 23:59:23 +00001571 }
1572 } else
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001573 II->buildAliasResultOperands();
Daniel Dunbare10787e2009-08-07 08:26:05 +00001574 }
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001575 if (!NewMatchables.empty())
Benjamin Kramer4f6ac162015-02-28 10:11:12 +00001576 Matchables.insert(Matchables.end(),
1577 std::make_move_iterator(NewMatchables.begin()),
1578 std::make_move_iterator(NewMatchables.end()));
Daniel Dunbar8e33cb22009-08-09 07:20:21 +00001579
Jim Grosbachba395922011-12-06 23:43:54 +00001580 // Process token alias definitions and set up the associated superclass
1581 // information.
1582 std::vector<Record*> AllTokenAliases =
1583 Records.getAllDerivedDefinitions("TokenAlias");
Craig Toppere4e74152015-12-29 07:03:23 +00001584 for (Record *Rec : AllTokenAliases) {
Jim Grosbachba395922011-12-06 23:43:54 +00001585 ClassInfo *FromClass = getTokenClass(Rec->getValueAsString("FromToken"));
1586 ClassInfo *ToClass = getTokenClass(Rec->getValueAsString("ToToken"));
Jim Grosbach37f6dcb32012-04-17 21:23:52 +00001587 if (FromClass == ToClass)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001588 PrintFatalError(Rec->getLoc(),
Jim Grosbach37f6dcb32012-04-17 21:23:52 +00001589 "error: Destination value identical to source value.");
Jim Grosbachba395922011-12-06 23:43:54 +00001590 FromClass->SuperClasses.push_back(ToClass);
1591 }
1592
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001593 // Reorder classes so that classes precede super classes.
David Blaikied749e342014-11-28 20:35:57 +00001594 Classes.sort();
Oliver Stannard7772f022016-01-25 10:20:19 +00001595
1596#ifndef NDEBUG
1597 // Verify that the table is now sorted
1598 for (auto I = Classes.begin(), E = Classes.end(); I != E; ++I) {
1599 for (auto J = I; J != E; ++J) {
1600 assert(!(*J < *I));
1601 assert(I == J || !J->isSubsetOf(*I));
1602 }
1603 }
Eugene Zelenkoecefe5a2016-02-02 18:20:45 +00001604#endif // NDEBUG
Daniel Dunbare10787e2009-08-07 08:26:05 +00001605}
1606
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001607/// buildInstructionOperandReference - The specified operand is a reference to a
Chris Lattner4779e3e92010-11-04 00:57:06 +00001608/// named operand such as $src. Resolve the Class and OperandInfo pointers.
1609void AsmMatcherInfo::
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001610buildInstructionOperandReference(MatchableInfo *II,
Chris Lattnerccde4632010-11-04 01:58:23 +00001611 StringRef OperandName,
Bob Wilsonb9b24222011-01-26 19:44:55 +00001612 unsigned AsmOpIdx) {
Chris Lattner4efe13d2010-11-04 02:11:18 +00001613 const CodeGenInstruction &CGI = *II->DefRec.get<const CodeGenInstruction*>();
1614 const CGIOperandList &Operands = CGI.Operands;
Bob Wilsonb9b24222011-01-26 19:44:55 +00001615 MatchableInfo::AsmOperand *Op = &II->AsmOperands[AsmOpIdx];
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001616
Chris Lattnerfecdad62010-11-06 07:14:44 +00001617 // Map this token to an operand.
Chris Lattner4779e3e92010-11-04 00:57:06 +00001618 unsigned Idx;
1619 if (!Operands.hasOperandNamed(OperandName, Idx))
Benjamin Kramer48e7e852014-03-29 17:17:15 +00001620 PrintFatalError(II->TheDef->getLoc(),
1621 "error: unable to find operand: '" + OperandName + "'");
Chris Lattner897a1402010-11-04 01:55:23 +00001622
Bob Wilsonb9b24222011-01-26 19:44:55 +00001623 // If the instruction operand has multiple suboperands, but the parser
1624 // match class for the asm operand is still the default "ImmAsmOperand",
1625 // then handle each suboperand separately.
1626 if (Op->SubOpIdx == -1 && Operands[Idx].MINumOperands > 1) {
1627 Record *Rec = Operands[Idx].Rec;
1628 assert(Rec->isSubClassOf("Operand") && "Unexpected operand!");
1629 Record *MatchClass = Rec->getValueAsDef("ParserMatchClass");
1630 if (MatchClass && MatchClass->getValueAsString("Name") == "Imm") {
1631 // Insert remaining suboperands after AsmOpIdx in II->AsmOperands.
1632 StringRef Token = Op->Token; // save this in case Op gets moved
1633 for (unsigned SI = 1, SE = Operands[Idx].MINumOperands; SI != SE; ++SI) {
Ahmed Bougachaeb4dbd82015-05-29 01:03:37 +00001634 MatchableInfo::AsmOperand NewAsmOp(/*IsIsolatedToken=*/true, Token);
Bob Wilsonb9b24222011-01-26 19:44:55 +00001635 NewAsmOp.SubOpIdx = SI;
1636 II->AsmOperands.insert(II->AsmOperands.begin()+AsmOpIdx+SI, NewAsmOp);
1637 }
1638 // Replace Op with first suboperand.
1639 Op = &II->AsmOperands[AsmOpIdx]; // update the pointer in case it moved
1640 Op->SubOpIdx = 0;
1641 }
1642 }
1643
Chris Lattner897a1402010-11-04 01:55:23 +00001644 // Set up the operand class.
Bob Wilsonb9b24222011-01-26 19:44:55 +00001645 Op->Class = getOperandClass(Operands[Idx], Op->SubOpIdx);
Chris Lattner897a1402010-11-04 01:55:23 +00001646
1647 // If the named operand is tied, canonicalize it to the untied operand.
1648 // For example, something like:
1649 // (outs GPR:$dst), (ins GPR:$src)
1650 // with an asmstring of
1651 // "inc $src"
1652 // we want to canonicalize to:
1653 // "inc $dst"
1654 // so that we know how to provide the $dst operand when filling in the result.
Ulrich Weigande037a492013-04-27 18:48:23 +00001655 int OITied = -1;
1656 if (Operands[Idx].MINumOperands == 1)
1657 OITied = Operands[Idx].getTiedRegister();
Chris Lattner4779e3e92010-11-04 00:57:06 +00001658 if (OITied != -1) {
1659 // The tied operand index is an MIOperand index, find the operand that
1660 // contains it.
Bob Wilsonb9b24222011-01-26 19:44:55 +00001661 std::pair<unsigned, unsigned> Idx = Operands.getSubOperandNumber(OITied);
1662 OperandName = Operands[Idx.first].Name;
1663 Op->SubOpIdx = Idx.second;
Chris Lattner4779e3e92010-11-04 00:57:06 +00001664 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001665
Bob Wilsonb9b24222011-01-26 19:44:55 +00001666 Op->SrcOpName = OperandName;
Chris Lattner4779e3e92010-11-04 00:57:06 +00001667}
1668
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001669/// buildAliasOperandReference - When parsing an operand reference out of the
Chris Lattnerb625dd22010-11-06 07:06:09 +00001670/// matching string (e.g. "movsx $src, $dst"), determine what the class of the
1671/// operand reference is by looking it up in the result pattern definition.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001672void AsmMatcherInfo::buildAliasOperandReference(MatchableInfo *II,
Chris Lattner4efe13d2010-11-04 02:11:18 +00001673 StringRef OperandName,
1674 MatchableInfo::AsmOperand &Op) {
1675 const CodeGenInstAlias &CGA = *II->DefRec.get<const CodeGenInstAlias*>();
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001676
Chris Lattner4efe13d2010-11-04 02:11:18 +00001677 // Set up the operand class.
Chris Lattnerb625dd22010-11-06 07:06:09 +00001678 for (unsigned i = 0, e = CGA.ResultOperands.size(); i != e; ++i)
Chris Lattnerb6f8e822010-11-06 19:25:43 +00001679 if (CGA.ResultOperands[i].isRecord() &&
1680 CGA.ResultOperands[i].getName() == OperandName) {
Chris Lattnerfecdad62010-11-06 07:14:44 +00001681 // It's safe to go with the first one we find, because CodeGenInstAlias
1682 // validates that all operands with the same name have the same record.
Bob Wilsonb9b24222011-01-26 19:44:55 +00001683 Op.SubOpIdx = CGA.ResultInstOperandIndex[i].second;
Jim Grosbachd1f1b792011-10-28 22:32:53 +00001684 // Use the match class from the Alias definition, not the
1685 // destination instruction, as we may have an immediate that's
1686 // being munged by the match class.
1687 Op.Class = getOperandClass(CGA.ResultOperands[i].getRecord(),
Bob Wilsonb9b24222011-01-26 19:44:55 +00001688 Op.SubOpIdx);
Chris Lattnerb625dd22010-11-06 07:06:09 +00001689 Op.SrcOpName = OperandName;
1690 return;
Chris Lattner4efe13d2010-11-04 02:11:18 +00001691 }
Chris Lattnerb625dd22010-11-06 07:06:09 +00001692
Benjamin Kramer48e7e852014-03-29 17:17:15 +00001693 PrintFatalError(II->TheDef->getLoc(),
1694 "error: unable to find operand: '" + OperandName + "'");
Chris Lattner4efe13d2010-11-04 02:11:18 +00001695}
1696
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001697void MatchableInfo::buildInstructionResultOperands() {
Chris Lattnerfecdad62010-11-06 07:14:44 +00001698 const CodeGenInstruction *ResultInst = getResultInst();
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001699
Chris Lattnerfecdad62010-11-06 07:14:44 +00001700 // Loop over all operands of the result instruction, determining how to
1701 // populate them.
Craig Toppere4e74152015-12-29 07:03:23 +00001702 for (const CGIOperandList::OperandInfo &OpInfo : ResultInst->Operands) {
Chris Lattner7108dad2010-11-04 01:42:59 +00001703 // If this is a tied operand, just copy from the previously handled operand.
Ulrich Weigande037a492013-04-27 18:48:23 +00001704 int TiedOp = -1;
1705 if (OpInfo.MINumOperands == 1)
1706 TiedOp = OpInfo.getTiedRegister();
Chris Lattner7108dad2010-11-04 01:42:59 +00001707 if (TiedOp != -1) {
Bob Wilsonb9b24222011-01-26 19:44:55 +00001708 ResOperands.push_back(ResOperand::getTiedOp(TiedOp));
Chris Lattner7108dad2010-11-04 01:42:59 +00001709 continue;
1710 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001711
Bob Wilsonb9b24222011-01-26 19:44:55 +00001712 // Find out what operand from the asmparser this MCInst operand comes from.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001713 int SrcOperand = findAsmOperandNamed(OpInfo.Name);
Ulrich Weigande037a492013-04-27 18:48:23 +00001714 if (OpInfo.Name.empty() || SrcOperand == -1) {
1715 // This may happen for operands that are tied to a suboperand of a
1716 // complex operand. Simply use a dummy value here; nobody should
1717 // use this operand slot.
1718 // FIXME: The long term goal is for the MCOperand list to not contain
1719 // tied operands at all.
1720 ResOperands.push_back(ResOperand::getImmOp(0));
1721 continue;
1722 }
Chris Lattner7108dad2010-11-04 01:42:59 +00001723
Bob Wilsonb9b24222011-01-26 19:44:55 +00001724 // Check if the one AsmOperand populates the entire operand.
1725 unsigned NumOperands = OpInfo.MINumOperands;
1726 if (AsmOperands[SrcOperand].SubOpIdx == -1) {
1727 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, NumOperands));
Chris Lattner743081d2010-11-04 00:43:46 +00001728 continue;
1729 }
Bob Wilsonb9b24222011-01-26 19:44:55 +00001730
1731 // Add a separate ResOperand for each suboperand.
1732 for (unsigned AI = 0; AI < NumOperands; ++AI) {
1733 assert(AsmOperands[SrcOperand+AI].SubOpIdx == (int)AI &&
1734 AsmOperands[SrcOperand+AI].SrcOpName == OpInfo.Name &&
1735 "unexpected AsmOperands for suboperands");
1736 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand + AI, 1));
1737 }
Chris Lattner743081d2010-11-04 00:43:46 +00001738 }
1739}
1740
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001741void MatchableInfo::buildAliasResultOperands() {
Chris Lattner8188fb22010-11-06 07:31:43 +00001742 const CodeGenInstAlias &CGA = *DefRec.get<const CodeGenInstAlias*>();
1743 const CodeGenInstruction *ResultInst = getResultInst();
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001744
Chris Lattner8188fb22010-11-06 07:31:43 +00001745 // Loop over all operands of the result instruction, determining how to
1746 // populate them.
1747 unsigned AliasOpNo = 0;
Bob Wilsonb9b24222011-01-26 19:44:55 +00001748 unsigned LastOpNo = CGA.ResultInstOperandIndex.size();
Chris Lattner8188fb22010-11-06 07:31:43 +00001749 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
Bob Wilsonb9b24222011-01-26 19:44:55 +00001750 const CGIOperandList::OperandInfo *OpInfo = &ResultInst->Operands[i];
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001751
Chris Lattner8188fb22010-11-06 07:31:43 +00001752 // If this is a tied operand, just copy from the previously handled operand.
Ulrich Weigande037a492013-04-27 18:48:23 +00001753 int TiedOp = -1;
1754 if (OpInfo->MINumOperands == 1)
1755 TiedOp = OpInfo->getTiedRegister();
Chris Lattner8188fb22010-11-06 07:31:43 +00001756 if (TiedOp != -1) {
Bob Wilsonb9b24222011-01-26 19:44:55 +00001757 ResOperands.push_back(ResOperand::getTiedOp(TiedOp));
Chris Lattner4869d342010-11-06 19:57:21 +00001758 continue;
1759 }
1760
Bob Wilsonb9b24222011-01-26 19:44:55 +00001761 // Handle all the suboperands for this operand.
1762 const std::string &OpName = OpInfo->Name;
1763 for ( ; AliasOpNo < LastOpNo &&
1764 CGA.ResultInstOperandIndex[AliasOpNo].first == i; ++AliasOpNo) {
1765 int SubIdx = CGA.ResultInstOperandIndex[AliasOpNo].second;
1766
1767 // Find out what operand from the asmparser that this MCInst operand
1768 // comes from.
1769 switch (CGA.ResultOperands[AliasOpNo].Kind) {
Bob Wilsonb9b24222011-01-26 19:44:55 +00001770 case CodeGenInstAlias::ResultOperand::K_Record: {
1771 StringRef Name = CGA.ResultOperands[AliasOpNo].getName();
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00001772 int SrcOperand = findAsmOperand(Name, SubIdx);
Bob Wilsonb9b24222011-01-26 19:44:55 +00001773 if (SrcOperand == -1)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00001774 PrintFatalError(TheDef->getLoc(), "Instruction '" +
Bob Wilsonb9b24222011-01-26 19:44:55 +00001775 TheDef->getName() + "' has operand '" + OpName +
1776 "' that doesn't appear in asm string!");
1777 unsigned NumOperands = (SubIdx == -1 ? OpInfo->MINumOperands : 1);
1778 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand,
1779 NumOperands));
1780 break;
1781 }
1782 case CodeGenInstAlias::ResultOperand::K_Imm: {
1783 int64_t ImmVal = CGA.ResultOperands[AliasOpNo].getImm();
1784 ResOperands.push_back(ResOperand::getImmOp(ImmVal));
1785 break;
1786 }
1787 case CodeGenInstAlias::ResultOperand::K_Reg: {
1788 Record *Reg = CGA.ResultOperands[AliasOpNo].getRegister();
1789 ResOperands.push_back(ResOperand::getRegOp(Reg));
1790 break;
1791 }
1792 }
Chris Lattner4869d342010-11-06 19:57:21 +00001793 }
Chris Lattner8188fb22010-11-06 07:31:43 +00001794 }
1795}
Chris Lattner743081d2010-11-04 00:43:46 +00001796
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001797static unsigned getConverterOperandID(const std::string &Name,
Rafael Espindola55512f92015-11-18 06:52:18 +00001798 SmallSetVector<std::string, 16> &Table,
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001799 bool &IsNew) {
1800 IsNew = Table.insert(Name);
1801
1802 unsigned ID = IsNew ? Table.size() - 1 :
1803 std::find(Table.begin(), Table.end(), Name) - Table.begin();
1804
1805 assert(ID < Table.size());
1806
1807 return ID;
1808}
1809
Chad Rosierf4e35dc2012-10-01 23:45:51 +00001810static void emitConvertFuncs(CodeGenTarget &Target, StringRef ClassName,
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001811 std::vector<std::unique_ptr<MatchableInfo>> &Infos,
Craig Topperfd2c6a32015-12-31 08:18:23 +00001812 bool HasMnemonicFirst, raw_ostream &OS) {
Rafael Espindola55512f92015-11-18 06:52:18 +00001813 SmallSetVector<std::string, 16> OperandConversionKinds;
1814 SmallSetVector<std::string, 16> InstructionConversionKinds;
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001815 std::vector<std::vector<uint8_t> > ConversionTable;
1816 size_t MaxRowLength = 2; // minimum is custom converter plus terminator.
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001817
Chris Lattnerf29c0b62010-01-14 22:21:20 +00001818 // TargetOperandClass - This is the target's operand class, like X86Operand.
1819 std::string TargetOperandClass = Target.getName() + "Operand";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001820
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001821 // Write the convert function to a separate stream, so we can drop it after
1822 // the enum. We'll build up the conversion handlers for the individual
1823 // operand types opportunistically as we encounter them.
1824 std::string ConvertFnBody;
1825 raw_string_ostream CvtOS(ConvertFnBody);
1826 // Start the unified conversion function.
Chad Rosier98cfa102012-08-31 00:03:31 +00001827 CvtOS << "void " << Target.getName() << ClassName << "::\n"
Chad Rosierba284b92012-09-05 01:02:38 +00001828 << "convertToMCInst(unsigned Kind, MCInst &Inst, "
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001829 << "unsigned Opcode,\n"
David Blaikie960ea3f2014-06-08 16:18:35 +00001830 << " const OperandVector"
1831 << " &Operands) {\n"
Chad Rosier98cfa102012-08-31 00:03:31 +00001832 << " assert(Kind < CVT_NUM_SIGNATURES && \"Invalid signature!\");\n"
Craig Topper91506102012-09-18 01:41:49 +00001833 << " const uint8_t *Converter = ConversionTable[Kind];\n"
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001834 << " Inst.setOpcode(Opcode);\n"
Craig Topper91506102012-09-18 01:41:49 +00001835 << " for (const uint8_t *p = Converter; *p; p+= 2) {\n"
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001836 << " switch (*p) {\n"
1837 << " default: llvm_unreachable(\"invalid conversion entry!\");\n"
1838 << " case CVT_Reg:\n"
1839 << " static_cast<" << TargetOperandClass
David Blaikie960ea3f2014-06-08 16:18:35 +00001840 << "&>(*Operands[*(p + 1)]).addRegOperands(Inst, 1);\n"
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001841 << " break;\n"
1842 << " case CVT_Tied:\n"
1843 << " Inst.addOperand(Inst.getOperand(*(p + 1)));\n"
1844 << " break;\n";
1845
Chad Rosier738ea252012-08-30 17:59:25 +00001846 std::string OperandFnBody;
1847 raw_string_ostream OpOS(OperandFnBody);
1848 // Start the operand number lookup function.
Chad Rosierf4e35dc2012-10-01 23:45:51 +00001849 OpOS << "void " << Target.getName() << ClassName << "::\n"
1850 << "convertToMapAndConstraints(unsigned Kind,\n";
Chad Rosier380a74a2012-10-02 00:25:57 +00001851 OpOS.indent(27);
David Blaikie960ea3f2014-06-08 16:18:35 +00001852 OpOS << "const OperandVector &Operands) {\n"
Chad Rosier98cfa102012-08-31 00:03:31 +00001853 << " assert(Kind < CVT_NUM_SIGNATURES && \"Invalid signature!\");\n"
Chad Rosierf4e35dc2012-10-01 23:45:51 +00001854 << " unsigned NumMCOperands = 0;\n"
Craig Topper91506102012-09-18 01:41:49 +00001855 << " const uint8_t *Converter = ConversionTable[Kind];\n"
1856 << " for (const uint8_t *p = Converter; *p; p+= 2) {\n"
Chad Rosier738ea252012-08-30 17:59:25 +00001857 << " switch (*p) {\n"
1858 << " default: llvm_unreachable(\"invalid conversion entry!\");\n"
1859 << " case CVT_Reg:\n"
Chad Rosier2f480a82012-10-12 22:53:36 +00001860 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n"
Chad Rosier72450332013-01-15 23:07:53 +00001861 << " Operands[*(p + 1)]->setConstraint(\"r\");\n"
Chad Rosier2f480a82012-10-12 22:53:36 +00001862 << " ++NumMCOperands;\n"
1863 << " break;\n"
Chad Rosier738ea252012-08-30 17:59:25 +00001864 << " case CVT_Tied:\n"
Chad Rosierf4e35dc2012-10-01 23:45:51 +00001865 << " ++NumMCOperands;\n"
Chad Rosier738ea252012-08-30 17:59:25 +00001866 << " break;\n";
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001867
1868 // Pre-populate the operand conversion kinds with the standard always
1869 // available entries.
1870 OperandConversionKinds.insert("CVT_Done");
1871 OperandConversionKinds.insert("CVT_Reg");
1872 OperandConversionKinds.insert("CVT_Tied");
1873 enum { CVT_Done, CVT_Reg, CVT_Tied };
1874
Craig Topperf34dad92014-11-28 03:53:02 +00001875 for (auto &II : Infos) {
Daniel Dunbar77b7c3f2011-02-04 17:12:15 +00001876 // Check if we have a custom match function.
Daniel Dunbar5f74b392011-04-01 20:23:52 +00001877 std::string AsmMatchConverter =
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001878 II->getResultInst()->TheDef->getValueAsString("AsmMatchConverter");
Tom Stellard74c87c82015-05-26 15:55:50 +00001879 if (!AsmMatchConverter.empty() && II->UseInstAsmMatchConverter) {
Daniel Dunbar5f74b392011-04-01 20:23:52 +00001880 std::string Signature = "ConvertCustom_" + AsmMatchConverter;
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001881 II->ConversionFnKind = Signature;
Daniel Dunbar77b7c3f2011-02-04 17:12:15 +00001882
1883 // Check if we have already generated this signature.
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001884 if (!InstructionConversionKinds.insert(Signature))
Daniel Dunbar77b7c3f2011-02-04 17:12:15 +00001885 continue;
1886
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001887 // Remember this converter for the kind enum.
1888 unsigned KindID = OperandConversionKinds.size();
Tim Northoverb3cfb282013-01-10 16:47:31 +00001889 OperandConversionKinds.insert("CVT_" +
1890 getEnumNameForToken(AsmMatchConverter));
Daniel Dunbar77b7c3f2011-02-04 17:12:15 +00001891
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001892 // Add the converter row for this instruction.
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +00001893 ConversionTable.emplace_back();
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001894 ConversionTable.back().push_back(KindID);
1895 ConversionTable.back().push_back(CVT_Done);
1896
1897 // Add the handler to the conversion driver function.
Tim Northoverb3cfb282013-01-10 16:47:31 +00001898 CvtOS << " case CVT_"
1899 << getEnumNameForToken(AsmMatchConverter) << ":\n"
Chad Rosier451ef132012-08-31 22:12:31 +00001900 << " " << AsmMatchConverter << "(Inst, Operands);\n"
Chad Rosier98cfa102012-08-31 00:03:31 +00001901 << " break;\n";
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001902
Chad Rosier738ea252012-08-30 17:59:25 +00001903 // FIXME: Handle the operand number lookup for custom match functions.
Daniel Dunbar77b7c3f2011-02-04 17:12:15 +00001904 continue;
1905 }
1906
Daniel Dunbare10787e2009-08-07 08:26:05 +00001907 // Build the conversion function signature.
1908 std::string Signature = "Convert";
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001909
1910 std::vector<uint8_t> ConversionRow;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001911
Chris Lattner5cf8a4a2010-11-02 21:49:44 +00001912 // Compute the convert enum and the case body.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001913 MaxRowLength = std::max(MaxRowLength, II->ResOperands.size()*2 + 1 );
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001914
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001915 for (unsigned i = 0, e = II->ResOperands.size(); i != e; ++i) {
1916 const MatchableInfo::ResOperand &OpInfo = II->ResOperands[i];
Jim Grosbach0eccfc22010-10-29 22:13:48 +00001917
Chris Lattner743081d2010-11-04 00:43:46 +00001918 // Generate code to populate each result operand.
1919 switch (OpInfo.Kind) {
Chris Lattner743081d2010-11-04 00:43:46 +00001920 case MatchableInfo::ResOperand::RenderAsmOperand: {
1921 // This comes from something we parsed.
Craig Topper03ec8012014-11-25 20:11:31 +00001922 const MatchableInfo::AsmOperand &Op =
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00001923 II->AsmOperands[OpInfo.AsmOperandNum];
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001924
Chris Lattnere032dbf2010-11-02 22:55:03 +00001925 // Registers are always converted the same, don't duplicate the
1926 // conversion function based on them.
Chris Lattnere032dbf2010-11-02 22:55:03 +00001927 Signature += "__";
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001928 std::string Class;
1929 Class = Op.Class->isRegisterClass() ? "Reg" : Op.Class->ClassName;
1930 Signature += Class;
Bob Wilsonb9b24222011-01-26 19:44:55 +00001931 Signature += utostr(OpInfo.MINumOperands);
Chris Lattner743081d2010-11-04 00:43:46 +00001932 Signature += "_" + itostr(OpInfo.AsmOperandNum);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00001933
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001934 // Add the conversion kind, if necessary, and get the associated ID
1935 // the index of its entry in the vector).
1936 std::string Name = "CVT_" + (Op.Class->isRegisterClass() ? "Reg" :
1937 Op.Class->RenderMethod);
Tim Northoverb3cfb282013-01-10 16:47:31 +00001938 Name = getEnumNameForToken(Name);
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001939
1940 bool IsNewConverter = false;
1941 unsigned ID = getConverterOperandID(Name, OperandConversionKinds,
1942 IsNewConverter);
1943
1944 // Add the operand entry to the instruction kind conversion row.
1945 ConversionRow.push_back(ID);
Craig Topperfd2c6a32015-12-31 08:18:23 +00001946 ConversionRow.push_back(OpInfo.AsmOperandNum + HasMnemonicFirst);
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001947
1948 if (!IsNewConverter)
1949 break;
1950
1951 // This is a new operand kind. Add a handler for it to the
1952 // converter driver.
1953 CvtOS << " case " << Name << ":\n"
1954 << " static_cast<" << TargetOperandClass
David Blaikie960ea3f2014-06-08 16:18:35 +00001955 << "&>(*Operands[*(p + 1)])." << Op.Class->RenderMethod
1956 << "(Inst, " << OpInfo.MINumOperands << ");\n"
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001957 << " break;\n";
Chad Rosier738ea252012-08-30 17:59:25 +00001958
1959 // Add a handler for the operand number lookup.
1960 OpOS << " case " << Name << ":\n"
Chad Rosier72450332013-01-15 23:07:53 +00001961 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n";
1962
1963 if (Op.Class->isRegisterClass())
1964 OpOS << " Operands[*(p + 1)]->setConstraint(\"r\");\n";
1965 else
1966 OpOS << " Operands[*(p + 1)]->setConstraint(\"m\");\n";
1967 OpOS << " NumMCOperands += " << OpInfo.MINumOperands << ";\n"
Chad Rosier738ea252012-08-30 17:59:25 +00001968 << " break;\n";
Chris Lattner743081d2010-11-04 00:43:46 +00001969 break;
Daniel Dunbarf22553a2010-02-10 08:15:48 +00001970 }
Chris Lattner743081d2010-11-04 00:43:46 +00001971 case MatchableInfo::ResOperand::TiedOperand: {
1972 // If this operand is tied to a previous one, just copy the MCInst
1973 // operand from the earlier one.We can only tie single MCOperand values.
Ulrich Weigande037a492013-04-27 18:48:23 +00001974 assert(OpInfo.MINumOperands == 1 && "Not a singular MCOperand");
Chris Lattner743081d2010-11-04 00:43:46 +00001975 unsigned TiedOp = OpInfo.TiedOperandNum;
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001976 assert(i > TiedOp && "Tied operand precedes its target!");
Chris Lattner743081d2010-11-04 00:43:46 +00001977 Signature += "__Tie" + utostr(TiedOp);
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001978 ConversionRow.push_back(CVT_Tied);
1979 ConversionRow.push_back(TiedOp);
Chris Lattner743081d2010-11-04 00:43:46 +00001980 break;
1981 }
Chris Lattnerb6f8e822010-11-06 19:25:43 +00001982 case MatchableInfo::ResOperand::ImmOperand: {
1983 int64_t Val = OpInfo.ImmVal;
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001984 std::string Ty = "imm_" + itostr(Val);
Hal Finkelf9090722015-01-15 01:33:00 +00001985 Ty = getEnumNameForToken(Ty);
Jim Grosbachc93f6c72012-08-22 01:06:23 +00001986 Signature += "__" + Ty;
1987
1988 std::string Name = "CVT_" + Ty;
1989 bool IsNewConverter = false;
1990 unsigned ID = getConverterOperandID(Name, OperandConversionKinds,
1991 IsNewConverter);
1992 // Add the operand entry to the instruction kind conversion row.
1993 ConversionRow.push_back(ID);
1994 ConversionRow.push_back(0);
1995
1996 if (!IsNewConverter)
1997 break;
1998
1999 CvtOS << " case " << Name << ":\n"
Jim Grosbache9119e42015-05-13 18:37:00 +00002000 << " Inst.addOperand(MCOperand::createImm(" << Val << "));\n"
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002001 << " break;\n";
2002
Chad Rosier738ea252012-08-30 17:59:25 +00002003 OpOS << " case " << Name << ":\n"
Chad Rosier2f480a82012-10-12 22:53:36 +00002004 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n"
2005 << " Operands[*(p + 1)]->setConstraint(\"\");\n"
Chad Rosierf4e35dc2012-10-01 23:45:51 +00002006 << " ++NumMCOperands;\n"
Chad Rosier738ea252012-08-30 17:59:25 +00002007 << " break;\n";
Chris Lattnerb6f8e822010-11-06 19:25:43 +00002008 break;
2009 }
Chris Lattner4869d342010-11-06 19:57:21 +00002010 case MatchableInfo::ResOperand::RegOperand: {
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002011 std::string Reg, Name;
Craig Topper24064772014-04-15 07:20:03 +00002012 if (!OpInfo.Register) {
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002013 Name = "reg0";
2014 Reg = "0";
Bob Wilson03912ab2011-01-14 22:58:09 +00002015 } else {
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002016 Reg = getQualifiedName(OpInfo.Register);
2017 Name = "reg" + OpInfo.Register->getName();
Bob Wilson03912ab2011-01-14 22:58:09 +00002018 }
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002019 Signature += "__" + Name;
2020 Name = "CVT_" + Name;
2021 bool IsNewConverter = false;
2022 unsigned ID = getConverterOperandID(Name, OperandConversionKinds,
2023 IsNewConverter);
2024 // Add the operand entry to the instruction kind conversion row.
2025 ConversionRow.push_back(ID);
2026 ConversionRow.push_back(0);
2027
2028 if (!IsNewConverter)
2029 break;
2030 CvtOS << " case " << Name << ":\n"
Jim Grosbache9119e42015-05-13 18:37:00 +00002031 << " Inst.addOperand(MCOperand::createReg(" << Reg << "));\n"
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002032 << " break;\n";
Chad Rosier738ea252012-08-30 17:59:25 +00002033
2034 OpOS << " case " << Name << ":\n"
Chad Rosier2f480a82012-10-12 22:53:36 +00002035 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n"
2036 << " Operands[*(p + 1)]->setConstraint(\"m\");\n"
Chad Rosierf4e35dc2012-10-01 23:45:51 +00002037 << " ++NumMCOperands;\n"
Chad Rosier738ea252012-08-30 17:59:25 +00002038 << " break;\n";
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002039 }
Chris Lattner743081d2010-11-04 00:43:46 +00002040 }
Daniel Dunbare10787e2009-08-07 08:26:05 +00002041 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002042
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002043 // If there were no operands, add to the signature to that effect
2044 if (Signature == "Convert")
2045 Signature += "_NoOperands";
2046
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002047 II->ConversionFnKind = Signature;
Daniel Dunbare10787e2009-08-07 08:26:05 +00002048
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002049 // Save the signature. If we already have it, don't add a new row
2050 // to the table.
2051 if (!InstructionConversionKinds.insert(Signature))
Daniel Dunbare10787e2009-08-07 08:26:05 +00002052 continue;
2053
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002054 // Add the row to the table.
Craig Topperc4de7ee2015-08-16 21:27:08 +00002055 ConversionTable.push_back(std::move(ConversionRow));
Daniel Dunbare10787e2009-08-07 08:26:05 +00002056 }
Daniel Dunbar71330282009-08-08 05:24:34 +00002057
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002058 // Finish up the converter driver function.
Chad Rosierc38826c2012-09-03 17:39:57 +00002059 CvtOS << " }\n }\n}\n\n";
Daniel Dunbar71330282009-08-08 05:24:34 +00002060
Chad Rosier738ea252012-08-30 17:59:25 +00002061 // Finish up the operand number lookup function.
Chad Rosierf4e35dc2012-10-01 23:45:51 +00002062 OpOS << " }\n }\n}\n\n";
Chad Rosier738ea252012-08-30 17:59:25 +00002063
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002064 OS << "namespace {\n";
Daniel Dunbar71330282009-08-08 05:24:34 +00002065
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002066 // Output the operand conversion kind enum.
2067 OS << "enum OperatorConversionKind {\n";
Craig Topper6e526f12016-01-03 07:33:30 +00002068 for (const std::string &Converter : OperandConversionKinds)
2069 OS << " " << Converter << ",\n";
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002070 OS << " CVT_NUM_CONVERTERS\n";
Daniel Dunbar71330282009-08-08 05:24:34 +00002071 OS << "};\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002072
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002073 // Output the instruction conversion kind enum.
2074 OS << "enum InstructionConversionKind {\n";
Craig Topper802d3d32015-08-16 21:27:10 +00002075 for (const std::string &Signature : InstructionConversionKinds)
2076 OS << " " << Signature << ",\n";
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002077 OS << " CVT_NUM_SIGNATURES\n";
2078 OS << "};\n\n";
2079
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002080 OS << "} // end anonymous namespace\n\n";
2081
2082 // Output the conversion table.
Craig Topper91506102012-09-18 01:41:49 +00002083 OS << "static const uint8_t ConversionTable[CVT_NUM_SIGNATURES]["
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002084 << MaxRowLength << "] = {\n";
2085
2086 for (unsigned Row = 0, ERow = ConversionTable.size(); Row != ERow; ++Row) {
2087 assert(ConversionTable[Row].size() % 2 == 0 && "bad conversion row!");
2088 OS << " // " << InstructionConversionKinds[Row] << "\n";
2089 OS << " { ";
2090 for (unsigned i = 0, e = ConversionTable[Row].size(); i != e; i += 2)
2091 OS << OperandConversionKinds[ConversionTable[Row][i]] << ", "
2092 << (unsigned)(ConversionTable[Row][i + 1]) << ", ";
2093 OS << "CVT_Done },\n";
2094 }
2095
2096 OS << "};\n\n";
2097
2098 // Spit out the conversion driver function.
Daniel Dunbar71330282009-08-08 05:24:34 +00002099 OS << CvtOS.str();
Jim Grosbachc93f6c72012-08-22 01:06:23 +00002100
Chad Rosier738ea252012-08-30 17:59:25 +00002101 // Spit out the operand number lookup function.
2102 OS << OpOS.str();
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00002103}
2104
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002105/// emitMatchClassEnumeration - Emit the enumeration for match class kinds.
2106static void emitMatchClassEnumeration(CodeGenTarget &Target,
David Blaikied749e342014-11-28 20:35:57 +00002107 std::forward_list<ClassInfo> &Infos,
2108 raw_ostream &OS) {
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002109 OS << "namespace {\n\n";
2110
2111 OS << "/// MatchClassKind - The kinds of classes which participate in\n"
2112 << "/// instruction matching.\n";
2113 OS << "enum MatchClassKind {\n";
2114 OS << " InvalidMatchClass = 0,\n";
Tom Stellardb9f235e2016-02-05 19:59:33 +00002115 OS << " OptionalMatchClass = 1,\n";
Craig Topperf34dad92014-11-28 03:53:02 +00002116 for (const auto &CI : Infos) {
David Blaikied749e342014-11-28 20:35:57 +00002117 OS << " " << CI.Name << ", // ";
2118 if (CI.Kind == ClassInfo::Token) {
2119 OS << "'" << CI.ValueName << "'\n";
2120 } else if (CI.isRegisterClass()) {
2121 if (!CI.ValueName.empty())
2122 OS << "register class '" << CI.ValueName << "'\n";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002123 else
2124 OS << "derived register class\n";
2125 } else {
David Blaikied749e342014-11-28 20:35:57 +00002126 OS << "user defined class '" << CI.ValueName << "'\n";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002127 }
2128 }
2129 OS << " NumMatchClassKinds\n";
2130 OS << "};\n\n";
2131
2132 OS << "}\n\n";
2133}
2134
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002135/// emitValidateOperandClass - Emit the function to validate an operand class.
2136static void emitValidateOperandClass(AsmMatcherInfo &Info,
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00002137 raw_ostream &OS) {
David Blaikie960ea3f2014-06-08 16:18:35 +00002138 OS << "static unsigned validateOperandClass(MCParsedAsmOperand &GOp, "
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00002139 << "MatchClassKind Kind) {\n";
David Blaikie960ea3f2014-06-08 16:18:35 +00002140 OS << " " << Info.Target.getName() << "Operand &Operand = ("
2141 << Info.Target.getName() << "Operand&)GOp;\n";
Daniel Dunbarbb98db22009-08-11 02:59:53 +00002142
Kevin Enderby1b87c802011-07-15 18:30:43 +00002143 // The InvalidMatchClass is not to match any operand.
2144 OS << " if (Kind == InvalidMatchClass)\n";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002145 OS << " return MCTargetAsmParser::Match_InvalidOperand;\n\n";
Kevin Enderby1b87c802011-07-15 18:30:43 +00002146
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00002147 // Check for Token operands first.
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002148 // FIXME: Use a more specific diagnostic type.
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002149 OS << " if (Operand.isToken())\n";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002150 OS << " return isSubclass(matchTokenString(Operand.getToken()), Kind) ?\n"
2151 << " MCTargetAsmParser::Match_Success :\n"
2152 << " MCTargetAsmParser::Match_InvalidOperand;\n\n";
Daniel Dunbarbb98db22009-08-11 02:59:53 +00002153
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00002154 // Check the user classes. We don't care what order since we're only
2155 // actually matching against one of them.
Valery Pykhtin020c29e2016-04-05 16:18:16 +00002156 OS << " switch (Kind) {\n"
2157 " default: break;\n";
Craig Topperf34dad92014-11-28 03:53:02 +00002158 for (const auto &CI : Info.Classes) {
David Blaikied749e342014-11-28 20:35:57 +00002159 if (!CI.isUserClass())
Daniel Dunbarbb98db22009-08-11 02:59:53 +00002160 continue;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002161
David Blaikied749e342014-11-28 20:35:57 +00002162 OS << " // '" << CI.ClassName << "' class\n";
Valery Pykhtin020c29e2016-04-05 16:18:16 +00002163 OS << " case " << CI.Name << ":\n";
David Blaikied749e342014-11-28 20:35:57 +00002164 OS << " if (Operand." << CI.PredicateMethod << "())\n";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002165 OS << " return MCTargetAsmParser::Match_Success;\n";
David Blaikied749e342014-11-28 20:35:57 +00002166 if (!CI.DiagnosticType.empty())
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002167 OS << " return " << Info.Target.getName() << "AsmParser::Match_"
David Blaikied749e342014-11-28 20:35:57 +00002168 << CI.DiagnosticType << ";\n";
Valery Pykhtin020c29e2016-04-05 16:18:16 +00002169 else
2170 OS << " break;\n";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002171 }
Valery Pykhtin020c29e2016-04-05 16:18:16 +00002172 OS << " } // end switch (Kind)\n\n";
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002173
Owen Anderson8a503f22012-07-16 23:20:09 +00002174 // Check for register operands, including sub-classes.
2175 OS << " if (Operand.isReg()) {\n";
2176 OS << " MatchClassKind OpKind;\n";
2177 OS << " switch (Operand.getReg()) {\n";
2178 OS << " default: OpKind = InvalidMatchClass; break;\n";
Craig Topper03ec8012014-11-25 20:11:31 +00002179 for (const auto &RC : Info.RegisterClasses)
Owen Anderson8a503f22012-07-16 23:20:09 +00002180 OS << " case " << Info.Target.getName() << "::"
Craig Topper03ec8012014-11-25 20:11:31 +00002181 << RC.first->getName() << ": OpKind = " << RC.second->Name
Owen Anderson8a503f22012-07-16 23:20:09 +00002182 << "; break;\n";
2183 OS << " }\n";
2184 OS << " return isSubclass(OpKind, Kind) ? "
2185 << "MCTargetAsmParser::Match_Success :\n "
2186 << " MCTargetAsmParser::Match_InvalidOperand;\n }\n\n";
2187
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002188 // Generic fallthrough match failure case for operands that don't have
2189 // specialized diagnostic types.
2190 OS << " return MCTargetAsmParser::Match_InvalidOperand;\n";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002191 OS << "}\n\n";
2192}
2193
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002194/// emitIsSubclass - Emit the subclass predicate function.
2195static void emitIsSubclass(CodeGenTarget &Target,
David Blaikied749e342014-11-28 20:35:57 +00002196 std::forward_list<ClassInfo> &Infos,
Daniel Dunbar2587b612009-08-10 16:05:47 +00002197 raw_ostream &OS) {
Dmitri Gribenko8d302402012-09-15 20:22:05 +00002198 OS << "/// isSubclass - Compute whether \\p A is a subclass of \\p B.\n";
Jim Grosbach1f5c5aa2011-12-06 22:07:02 +00002199 OS << "static bool isSubclass(MatchClassKind A, MatchClassKind B) {\n";
Daniel Dunbar2587b612009-08-10 16:05:47 +00002200 OS << " if (A == B)\n";
2201 OS << " return true;\n\n";
2202
Craig Topper39311c72015-12-30 06:00:22 +00002203 bool EmittedSwitch = false;
Craig Topperf34dad92014-11-28 03:53:02 +00002204 for (const auto &A : Infos) {
Jim Grosbachba395922011-12-06 23:43:54 +00002205 std::vector<StringRef> SuperClasses;
Tom Stellardb9f235e2016-02-05 19:59:33 +00002206 if (A.IsOptional)
2207 SuperClasses.push_back("OptionalMatchClass");
Craig Topperf34dad92014-11-28 03:53:02 +00002208 for (const auto &B : Infos) {
David Blaikied749e342014-11-28 20:35:57 +00002209 if (&A != &B && A.isSubsetOf(B))
2210 SuperClasses.push_back(B.Name);
Daniel Dunbar2587b612009-08-10 16:05:47 +00002211 }
Jim Grosbachba395922011-12-06 23:43:54 +00002212
2213 if (SuperClasses.empty())
2214 continue;
2215
Craig Topper39311c72015-12-30 06:00:22 +00002216 // If this is the first SuperClass, emit the switch header.
2217 if (!EmittedSwitch) {
Craig Topper13b2a4e2015-12-30 06:00:24 +00002218 OS << " switch (A) {\n";
Craig Topper39311c72015-12-30 06:00:22 +00002219 OS << " default:\n";
2220 OS << " return false;\n";
2221 EmittedSwitch = true;
2222 }
2223
2224 OS << "\n case " << A.Name << ":\n";
Jim Grosbachba395922011-12-06 23:43:54 +00002225
2226 if (SuperClasses.size() == 1) {
Craig Topper13b2a4e2015-12-30 06:00:24 +00002227 OS << " return B == " << SuperClasses.back() << ";\n";
Jim Grosbachba395922011-12-06 23:43:54 +00002228 continue;
2229 }
2230
Aaron Ballmane59e3582013-07-15 16:53:32 +00002231 if (!SuperClasses.empty()) {
Craig Topper39311c72015-12-30 06:00:22 +00002232 OS << " switch (B) {\n";
2233 OS << " default: return false;\n";
Craig Topper77bd2b72015-12-30 06:00:20 +00002234 for (StringRef SC : SuperClasses)
Craig Topper39311c72015-12-30 06:00:22 +00002235 OS << " case " << SC << ": return true;\n";
2236 OS << " }\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +00002237 } else {
2238 // No case statement to emit
Craig Topper39311c72015-12-30 06:00:22 +00002239 OS << " return false;\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +00002240 }
Daniel Dunbar2587b612009-08-10 16:05:47 +00002241 }
Aaron Ballmane59e3582013-07-15 16:53:32 +00002242
Craig Topper39311c72015-12-30 06:00:22 +00002243 // If there were case statements emitted into the string stream write the
2244 // default.
Craig Topperf58323e2016-01-03 07:33:34 +00002245 if (EmittedSwitch)
2246 OS << " }\n";
2247 else
Aaron Ballmane59e3582013-07-15 16:53:32 +00002248 OS << " return false;\n";
2249
Daniel Dunbar2587b612009-08-10 16:05:47 +00002250 OS << "}\n\n";
2251}
2252
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002253/// emitMatchTokenString - Emit the function to match a token string to the
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002254/// appropriate match class value.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002255static void emitMatchTokenString(CodeGenTarget &Target,
David Blaikied749e342014-11-28 20:35:57 +00002256 std::forward_list<ClassInfo> &Infos,
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002257 raw_ostream &OS) {
2258 // Construct the match list.
Chris Lattnerca5a3552010-09-06 02:01:51 +00002259 std::vector<StringMatcher::StringPair> Matches;
Craig Topperf34dad92014-11-28 03:53:02 +00002260 for (const auto &CI : Infos) {
David Blaikied749e342014-11-28 20:35:57 +00002261 if (CI.Kind == ClassInfo::Token)
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +00002262 Matches.emplace_back(CI.ValueName, "return " + CI.Name + ";");
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002263 }
2264
Jim Grosbach1f5c5aa2011-12-06 22:07:02 +00002265 OS << "static MatchClassKind matchTokenString(StringRef Name) {\n";
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002266
Chris Lattnerca5a3552010-09-06 02:01:51 +00002267 StringMatcher("Name", Matches, OS).Emit();
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002268
2269 OS << " return InvalidMatchClass;\n";
2270 OS << "}\n\n";
2271}
Chris Lattner00e2e742009-08-08 20:02:57 +00002272
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002273/// emitMatchRegisterName - Emit the function to match a string to the target
Daniel Dunbard0470d72009-08-07 21:01:44 +00002274/// specific register enum.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002275static void emitMatchRegisterName(CodeGenTarget &Target, Record *AsmParser,
Daniel Dunbard0470d72009-08-07 21:01:44 +00002276 raw_ostream &OS) {
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002277 // Construct the match list.
Chris Lattnerca5a3552010-09-06 02:01:51 +00002278 std::vector<StringMatcher::StringPair> Matches;
David Blaikie9b613db2014-11-29 18:13:39 +00002279 const auto &Regs = Target.getRegBank().getRegisters();
2280 for (const CodeGenRegister &Reg : Regs) {
2281 if (Reg.TheDef->getValueAsString("AsmName").empty())
Daniel Dunbare2eec052009-07-17 18:51:11 +00002282 continue;
2283
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +00002284 Matches.emplace_back(Reg.TheDef->getValueAsString("AsmName"),
2285 "return " + utostr(Reg.EnumValue) + ";");
Daniel Dunbare2eec052009-07-17 18:51:11 +00002286 }
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002287
Chris Lattner60db0a62010-02-09 00:34:28 +00002288 OS << "static unsigned MatchRegisterName(StringRef Name) {\n";
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002289
Chris Lattnerca5a3552010-09-06 02:01:51 +00002290 StringMatcher("Name", Matches, OS).Emit();
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002291
Daniel Dunbar66f4f542009-08-08 21:22:41 +00002292 OS << " return 0;\n";
Daniel Dunbare10787e2009-08-07 08:26:05 +00002293 OS << "}\n\n";
Daniel Dunbard0470d72009-08-07 21:01:44 +00002294}
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00002295
Dylan McKaybff960a2016-02-03 10:30:16 +00002296/// Emit the function to match a string to the target
2297/// specific register enum.
2298static void emitMatchRegisterAltName(CodeGenTarget &Target, Record *AsmParser,
2299 raw_ostream &OS) {
2300 // Construct the match list.
2301 std::vector<StringMatcher::StringPair> Matches;
2302 const auto &Regs = Target.getRegBank().getRegisters();
2303 for (const CodeGenRegister &Reg : Regs) {
2304
2305 auto AltNames = Reg.TheDef->getValueAsListOfStrings("AltNames");
2306
2307 for (auto AltName : AltNames) {
2308 AltName = StringRef(AltName).trim();
2309
2310 // don't handle empty alternative names
2311 if (AltName.empty())
2312 continue;
2313
2314 Matches.emplace_back(AltName,
2315 "return " + utostr(Reg.EnumValue) + ";");
2316 }
2317 }
2318
2319 OS << "static unsigned MatchRegisterAltName(StringRef Name) {\n";
2320
2321 StringMatcher("Name", Matches, OS).Emit();
2322
2323 OS << " return 0;\n";
2324 OS << "}\n\n";
2325}
2326
Daniel Sanders3ea92742014-05-21 10:11:24 +00002327static const char *getMinimalTypeForRange(uint64_t Range) {
Tim Northover26bb14e2014-08-18 11:49:42 +00002328 assert(Range <= 0xFFFFFFFFFFFFFFFFULL && "Enum too large");
2329 if (Range > 0xFFFFFFFFULL)
2330 return "uint64_t";
Daniel Sanders3ea92742014-05-21 10:11:24 +00002331 if (Range > 0xFFFF)
2332 return "uint32_t";
2333 if (Range > 0xFF)
2334 return "uint16_t";
2335 return "uint8_t";
2336}
2337
2338static const char *getMinimalRequiredFeaturesType(const AsmMatcherInfo &Info) {
2339 uint64_t MaxIndex = Info.SubtargetFeatures.size();
2340 if (MaxIndex > 0)
2341 MaxIndex--;
2342 return getMinimalTypeForRange(1ULL << MaxIndex);
2343}
2344
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002345/// emitSubtargetFeatureFlagEnumeration - Emit the subtarget feature flag
Daniel Dunbareefe8612010-07-19 05:44:09 +00002346/// definitions.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002347static void emitSubtargetFeatureFlagEnumeration(AsmMatcherInfo &Info,
Daniel Dunbareefe8612010-07-19 05:44:09 +00002348 raw_ostream &OS) {
2349 OS << "// Flags for subtarget features that participate in "
2350 << "instruction matching.\n";
Daniel Sanders3ea92742014-05-21 10:11:24 +00002351 OS << "enum SubtargetFeatureFlag : " << getMinimalRequiredFeaturesType(Info)
2352 << " {\n";
Craig Topper42bd8192014-11-28 03:53:00 +00002353 for (const auto &SF : Info.SubtargetFeatures) {
David Blaikie9a9da992014-11-28 22:15:06 +00002354 const SubtargetFeatureInfo &SFI = SF.second;
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002355 OS << " " << SFI.getEnumName() << " = (1ULL << " << SFI.Index << "),\n";
Daniel Dunbareefe8612010-07-19 05:44:09 +00002356 }
2357 OS << " Feature_None = 0\n";
2358 OS << "};\n\n";
2359}
2360
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002361/// emitOperandDiagnosticTypes - Emit the operand matching diagnostic types.
2362static void emitOperandDiagnosticTypes(AsmMatcherInfo &Info, raw_ostream &OS) {
2363 // Get the set of diagnostic types from all of the operand classes.
2364 std::set<StringRef> Types;
Craig Topper6e526f12016-01-03 07:33:30 +00002365 for (const auto &OpClassEntry : Info.AsmOperandClasses) {
2366 if (!OpClassEntry.second->DiagnosticType.empty())
2367 Types.insert(OpClassEntry.second->DiagnosticType);
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002368 }
2369
2370 if (Types.empty()) return;
2371
2372 // Now emit the enum entries.
Craig Topper6e526f12016-01-03 07:33:30 +00002373 for (StringRef Type : Types)
2374 OS << " Match_" << Type << ",\n";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002375 OS << " END_OPERAND_DIAGNOSTIC_TYPES\n";
2376}
2377
Jim Grosbach5117ef72012-04-24 22:40:08 +00002378/// emitGetSubtargetFeatureName - Emit the helper function to get the
2379/// user-level name for a subtarget feature.
2380static void emitGetSubtargetFeatureName(AsmMatcherInfo &Info, raw_ostream &OS) {
2381 OS << "// User-level names for subtarget features that participate in\n"
2382 << "// instruction matching.\n"
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002383 << "static const char *getSubtargetFeatureName(uint64_t Val) {\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +00002384 if (!Info.SubtargetFeatures.empty()) {
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002385 OS << " switch(Val) {\n";
Craig Topper42bd8192014-11-28 03:53:00 +00002386 for (const auto &SF : Info.SubtargetFeatures) {
David Blaikie9a9da992014-11-28 22:15:06 +00002387 const SubtargetFeatureInfo &SFI = SF.second;
Aaron Ballmane59e3582013-07-15 16:53:32 +00002388 // FIXME: Totally just a placeholder name to get the algorithm working.
2389 OS << " case " << SFI.getEnumName() << ": return \""
2390 << SFI.TheDef->getValueAsString("PredicateName") << "\";\n";
2391 }
2392 OS << " default: return \"(unknown)\";\n";
2393 OS << " }\n";
2394 } else {
2395 // Nothing to emit, so skip the switch
2396 OS << " return \"(unknown)\";\n";
Jim Grosbach5117ef72012-04-24 22:40:08 +00002397 }
Aaron Ballmane59e3582013-07-15 16:53:32 +00002398 OS << "}\n\n";
Jim Grosbach5117ef72012-04-24 22:40:08 +00002399}
2400
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002401/// emitComputeAvailableFeatures - Emit the function to compute the list of
Daniel Dunbareefe8612010-07-19 05:44:09 +00002402/// available features given a subtarget.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002403static void emitComputeAvailableFeatures(AsmMatcherInfo &Info,
Daniel Dunbareefe8612010-07-19 05:44:09 +00002404 raw_ostream &OS) {
2405 std::string ClassName =
2406 Info.AsmParser->getValueAsString("AsmParserClassName");
2407
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002408 OS << "uint64_t " << Info.Target.getName() << ClassName << "::\n"
Michael Kupersteindb0712f2015-05-26 10:47:10 +00002409 << "ComputeAvailableFeatures(const FeatureBitset& FB) const {\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002410 OS << " uint64_t Features = 0;\n";
Craig Topper42bd8192014-11-28 03:53:00 +00002411 for (const auto &SF : Info.SubtargetFeatures) {
David Blaikie9a9da992014-11-28 22:15:06 +00002412 const SubtargetFeatureInfo &SFI = SF.second;
Evan Cheng4d1ca962011-07-08 01:53:10 +00002413
2414 OS << " if (";
Jim Grosbach56e63262012-04-17 00:01:04 +00002415 std::string CondStorage =
2416 SFI.TheDef->getValueAsString("AssemblerCondString");
Evan Cheng1a6d5512011-07-08 18:04:22 +00002417 StringRef Conds = CondStorage;
Evan Cheng4d1ca962011-07-08 01:53:10 +00002418 std::pair<StringRef,StringRef> Comma = Conds.split(',');
2419 bool First = true;
2420 do {
2421 if (!First)
2422 OS << " && ";
2423
2424 bool Neg = false;
2425 StringRef Cond = Comma.first;
2426 if (Cond[0] == '!') {
2427 Neg = true;
2428 Cond = Cond.substr(1);
2429 }
2430
Michael Kupersteindb0712f2015-05-26 10:47:10 +00002431 OS << "(";
Evan Cheng4d1ca962011-07-08 01:53:10 +00002432 if (Neg)
Michael Kupersteindb0712f2015-05-26 10:47:10 +00002433 OS << "!";
2434 OS << "FB[" << Info.Target.getName() << "::" << Cond << "])";
Evan Cheng4d1ca962011-07-08 01:53:10 +00002435
2436 if (Comma.second.empty())
2437 break;
2438
2439 First = false;
2440 Comma = Comma.second.split(',');
2441 } while (true);
2442
2443 OS << ")\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002444 OS << " Features |= " << SFI.getEnumName() << ";\n";
Daniel Dunbareefe8612010-07-19 05:44:09 +00002445 }
2446 OS << " return Features;\n";
2447 OS << "}\n\n";
2448}
2449
Chris Lattner43690072010-10-30 20:15:02 +00002450static std::string GetAliasRequiredFeatures(Record *R,
2451 const AsmMatcherInfo &Info) {
Chris Lattner2cb092d2010-10-30 19:23:13 +00002452 std::vector<Record*> ReqFeatures = R->getValueAsListOfDefs("Predicates");
Chris Lattner2cb092d2010-10-30 19:23:13 +00002453 std::string Result;
2454 unsigned NumFeatures = 0;
2455 for (unsigned i = 0, e = ReqFeatures.size(); i != e; ++i) {
David Blaikie9a9da992014-11-28 22:15:06 +00002456 const SubtargetFeatureInfo *F = Info.getSubtargetFeature(ReqFeatures[i]);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002457
Craig Topper24064772014-04-15 07:20:03 +00002458 if (!F)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00002459 PrintFatalError(R->getLoc(), "Predicate '" + ReqFeatures[i]->getName() +
Chris Lattner517dc952010-11-01 02:09:21 +00002460 "' is not marked as an AssemblerPredicate!");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002461
Chris Lattner517dc952010-11-01 02:09:21 +00002462 if (NumFeatures)
2463 Result += '|';
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002464
Chris Lattner517dc952010-11-01 02:09:21 +00002465 Result += F->getEnumName();
2466 ++NumFeatures;
Chris Lattner2cb092d2010-10-30 19:23:13 +00002467 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002468
Chris Lattner2cb092d2010-10-30 19:23:13 +00002469 if (NumFeatures > 1)
2470 Result = '(' + Result + ')';
2471 return Result;
2472}
2473
Chad Rosier9f7a2212013-04-18 22:35:36 +00002474static void emitMnemonicAliasVariant(raw_ostream &OS,const AsmMatcherInfo &Info,
2475 std::vector<Record*> &Aliases,
2476 unsigned Indent = 0,
2477 StringRef AsmParserVariantName = StringRef()){
Chris Lattnercf9b6e32010-10-30 18:56:12 +00002478 // Keep track of all the aliases from a mnemonic. Use an std::map so that the
2479 // iteration order of the map is stable.
2480 std::map<std::string, std::vector<Record*> > AliasesFromMnemonic;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002481
Craig Topper6e526f12016-01-03 07:33:30 +00002482 for (Record *R : Aliases) {
Chad Rosier9f7a2212013-04-18 22:35:36 +00002483 // FIXME: Allow AssemblerVariantName to be a comma separated list.
2484 std::string AsmVariantName = R->getValueAsString("AsmVariantName");
2485 if (AsmVariantName != AsmParserVariantName)
2486 continue;
Chris Lattnercf9b6e32010-10-30 18:56:12 +00002487 AliasesFromMnemonic[R->getValueAsString("FromMnemonic")].push_back(R);
Chris Lattnerba7b4fe2010-10-30 17:36:36 +00002488 }
Chad Rosier9f7a2212013-04-18 22:35:36 +00002489 if (AliasesFromMnemonic.empty())
2490 return;
Vladimir Medic75429ad2013-07-16 09:22:38 +00002491
Chris Lattnercf9b6e32010-10-30 18:56:12 +00002492 // Process each alias a "from" mnemonic at a time, building the code executed
2493 // by the string remapper.
2494 std::vector<StringMatcher::StringPair> Cases;
Craig Topper6e526f12016-01-03 07:33:30 +00002495 for (const auto &AliasEntry : AliasesFromMnemonic) {
2496 const std::vector<Record*> &ToVec = AliasEntry.second;
Chris Lattner2cb092d2010-10-30 19:23:13 +00002497
2498 // Loop through each alias and emit code that handles each case. If there
2499 // are two instructions without predicates, emit an error. If there is one,
2500 // emit it last.
2501 std::string MatchCode;
2502 int AliasWithNoPredicate = -1;
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002503
Chris Lattner2cb092d2010-10-30 19:23:13 +00002504 for (unsigned i = 0, e = ToVec.size(); i != e; ++i) {
2505 Record *R = ToVec[i];
Chris Lattner43690072010-10-30 20:15:02 +00002506 std::string FeatureMask = GetAliasRequiredFeatures(R, Info);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002507
Chris Lattner2cb092d2010-10-30 19:23:13 +00002508 // If this unconditionally matches, remember it for later and diagnose
2509 // duplicates.
2510 if (FeatureMask.empty()) {
2511 if (AliasWithNoPredicate != -1) {
2512 // We can't have two aliases from the same mnemonic with no predicate.
2513 PrintError(ToVec[AliasWithNoPredicate]->getLoc(),
2514 "two MnemonicAliases with the same 'from' mnemonic!");
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00002515 PrintFatalError(R->getLoc(), "this is the other MnemonicAlias.");
Chris Lattner2cb092d2010-10-30 19:23:13 +00002516 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002517
Chris Lattner2cb092d2010-10-30 19:23:13 +00002518 AliasWithNoPredicate = i;
2519 continue;
2520 }
Craig Topper6e526f12016-01-03 07:33:30 +00002521 if (R->getValueAsString("ToMnemonic") == AliasEntry.first)
Joerg Sonnenberger635debe2012-10-25 20:33:17 +00002522 PrintFatalError(R->getLoc(), "MnemonicAlias to the same string");
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002523
Chris Lattnerf9ec2fb2010-10-30 19:47:49 +00002524 if (!MatchCode.empty())
2525 MatchCode += "else ";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002526 MatchCode += "if ((Features & " + FeatureMask + ") == "+FeatureMask+")\n";
Chris Lattner2cb092d2010-10-30 19:23:13 +00002527 MatchCode += " Mnemonic = \"" +R->getValueAsString("ToMnemonic")+"\";\n";
Chris Lattnercf9b6e32010-10-30 18:56:12 +00002528 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002529
Chris Lattner2cb092d2010-10-30 19:23:13 +00002530 if (AliasWithNoPredicate != -1) {
2531 Record *R = ToVec[AliasWithNoPredicate];
Chris Lattnerf9ec2fb2010-10-30 19:47:49 +00002532 if (!MatchCode.empty())
2533 MatchCode += "else\n ";
2534 MatchCode += "Mnemonic = \"" + R->getValueAsString("ToMnemonic")+"\";\n";
Chris Lattner2cb092d2010-10-30 19:23:13 +00002535 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002536
Chris Lattner2cb092d2010-10-30 19:23:13 +00002537 MatchCode += "return;";
2538
Craig Topper6e526f12016-01-03 07:33:30 +00002539 Cases.push_back(std::make_pair(AliasEntry.first, MatchCode));
Chris Lattnercf9b6e32010-10-30 18:56:12 +00002540 }
Chad Rosier9f7a2212013-04-18 22:35:36 +00002541 StringMatcher("Mnemonic", Cases, OS).Emit(Indent);
2542}
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002543
Chad Rosier9f7a2212013-04-18 22:35:36 +00002544/// emitMnemonicAliases - If the target has any MnemonicAlias<> definitions,
2545/// emit a function for them and return true, otherwise return false.
2546static bool emitMnemonicAliases(raw_ostream &OS, const AsmMatcherInfo &Info,
2547 CodeGenTarget &Target) {
2548 // Ignore aliases when match-prefix is set.
2549 if (!MatchPrefix.empty())
2550 return false;
2551
2552 std::vector<Record*> Aliases =
2553 Info.getRecords().getAllDerivedDefinitions("MnemonicAlias");
2554 if (Aliases.empty()) return false;
2555
2556 OS << "static void applyMnemonicAliases(StringRef &Mnemonic, "
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002557 "uint64_t Features, unsigned VariantID) {\n";
Chad Rosier9f7a2212013-04-18 22:35:36 +00002558 OS << " switch (VariantID) {\n";
2559 unsigned VariantCount = Target.getAsmParserVariantCount();
2560 for (unsigned VC = 0; VC != VariantCount; ++VC) {
2561 Record *AsmVariant = Target.getAsmParserVariant(VC);
2562 int AsmParserVariantNo = AsmVariant->getValueAsInt("Variant");
2563 std::string AsmParserVariantName = AsmVariant->getValueAsString("Name");
2564 OS << " case " << AsmParserVariantNo << ":\n";
2565 emitMnemonicAliasVariant(OS, Info, Aliases, /*Indent=*/2,
2566 AsmParserVariantName);
2567 OS << " break;\n";
2568 }
2569 OS << " }\n";
2570
2571 // Emit aliases that apply to all variants.
2572 emitMnemonicAliasVariant(OS, Info, Aliases);
2573
Daniel Dunbare46bc4c2011-01-18 01:59:30 +00002574 OS << "}\n\n";
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002575
Chris Lattner477fba4f2010-10-30 18:48:18 +00002576 return true;
Chris Lattnerba7b4fe2010-10-30 17:36:36 +00002577}
2578
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002579static void emitCustomOperandParsing(raw_ostream &OS, CodeGenTarget &Target,
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002580 const AsmMatcherInfo &Info, StringRef ClassName,
2581 StringToOffsetTable &StringTable,
Craig Topperfd2c6a32015-12-31 08:18:23 +00002582 unsigned MaxMnemonicIndex, bool HasMnemonicFirst) {
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002583 unsigned MaxMask = 0;
Craig Topper869cd5f2015-12-31 08:18:20 +00002584 for (const OperandMatchEntry &OMI : Info.OperandMatchInfo) {
2585 MaxMask |= OMI.OperandMask;
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002586 }
2587
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002588 // Emit the static custom operand parsing table;
2589 OS << "namespace {\n";
2590 OS << " struct OperandMatchEntry {\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002591 OS << " " << getMinimalRequiredFeaturesType(Info)
2592 << " RequiredFeatures;\n";
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002593 OS << " " << getMinimalTypeForRange(MaxMnemonicIndex)
2594 << " Mnemonic;\n";
David Blaikied749e342014-11-28 20:35:57 +00002595 OS << " " << getMinimalTypeForRange(std::distance(
2596 Info.Classes.begin(), Info.Classes.end())) << " Class;\n";
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002597 OS << " " << getMinimalTypeForRange(MaxMask)
2598 << " OperandMask;\n\n";
Benjamin Kramer0764a3f2012-03-03 20:44:43 +00002599 OS << " StringRef getMnemonic() const {\n";
2600 OS << " return StringRef(MnemonicTable + Mnemonic + 1,\n";
2601 OS << " MnemonicTable[Mnemonic]);\n";
2602 OS << " }\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002603 OS << " };\n\n";
2604
2605 OS << " // Predicate for searching for an opcode.\n";
2606 OS << " struct LessOpcodeOperand {\n";
2607 OS << " bool operator()(const OperandMatchEntry &LHS, StringRef RHS) {\n";
Benjamin Kramer0764a3f2012-03-03 20:44:43 +00002608 OS << " return LHS.getMnemonic() < RHS;\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002609 OS << " }\n";
2610 OS << " bool operator()(StringRef LHS, const OperandMatchEntry &RHS) {\n";
Benjamin Kramer0764a3f2012-03-03 20:44:43 +00002611 OS << " return LHS < RHS.getMnemonic();\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002612 OS << " }\n";
2613 OS << " bool operator()(const OperandMatchEntry &LHS,";
2614 OS << " const OperandMatchEntry &RHS) {\n";
Benjamin Kramer0764a3f2012-03-03 20:44:43 +00002615 OS << " return LHS.getMnemonic() < RHS.getMnemonic();\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002616 OS << " }\n";
2617 OS << " };\n";
2618
2619 OS << "} // end anonymous namespace.\n\n";
2620
2621 OS << "static const OperandMatchEntry OperandMatchTable["
2622 << Info.OperandMatchInfo.size() << "] = {\n";
2623
Benjamin Kramer0764a3f2012-03-03 20:44:43 +00002624 OS << " /* Operand List Mask, Mnemonic, Operand Class, Features */\n";
Craig Topper869cd5f2015-12-31 08:18:20 +00002625 for (const OperandMatchEntry &OMI : Info.OperandMatchInfo) {
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002626 const MatchableInfo &II = *OMI.MI;
2627
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002628 OS << " { ";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002629
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002630 // Write the required features mask.
2631 if (!II.RequiredFeatures.empty()) {
2632 for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) {
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002633 if (i) OS << "|";
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002634 OS << II.RequiredFeatures[i]->getEnumName();
2635 }
2636 } else
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002637 OS << "0";
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002638
2639 // Store a pascal-style length byte in the mnemonic.
2640 std::string LenMnemonic = char(II.Mnemonic.size()) + II.Mnemonic.str();
2641 OS << ", " << StringTable.GetOrAddStringOffset(LenMnemonic, false)
2642 << " /* " << II.Mnemonic << " */, ";
2643
2644 OS << OMI.CI->Name;
2645
2646 OS << ", " << OMI.OperandMask;
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002647 OS << " /* ";
2648 bool printComma = false;
2649 for (int i = 0, e = 31; i !=e; ++i)
2650 if (OMI.OperandMask & (1 << i)) {
2651 if (printComma)
2652 OS << ", ";
2653 OS << i;
2654 printComma = true;
2655 }
2656 OS << " */";
2657
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002658 OS << " },\n";
2659 }
2660 OS << "};\n\n";
2661
2662 // Emit the operand class switch to call the correct custom parser for
2663 // the found operand class.
Jim Grosbach861e49c2011-02-12 01:34:40 +00002664 OS << Target.getName() << ClassName << "::OperandMatchResultTy "
2665 << Target.getName() << ClassName << "::\n"
David Blaikie960ea3f2014-06-08 16:18:35 +00002666 << "tryCustomParseOperand(OperandVector"
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002667 << " &Operands,\n unsigned MCK) {\n\n"
2668 << " switch(MCK) {\n";
2669
Craig Topperf34dad92014-11-28 03:53:02 +00002670 for (const auto &CI : Info.Classes) {
David Blaikied749e342014-11-28 20:35:57 +00002671 if (CI.ParserMethod.empty())
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002672 continue;
David Blaikied749e342014-11-28 20:35:57 +00002673 OS << " case " << CI.Name << ":\n"
2674 << " return " << CI.ParserMethod << "(Operands);\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002675 }
2676
2677 OS << " default:\n";
Jim Grosbach861e49c2011-02-12 01:34:40 +00002678 OS << " return MatchOperand_NoMatch;\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002679 OS << " }\n";
Jim Grosbach861e49c2011-02-12 01:34:40 +00002680 OS << " return MatchOperand_NoMatch;\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002681 OS << "}\n\n";
2682
2683 // Emit the static custom operand parser. This code is very similar with
2684 // the other matcher. Also use MatchResultTy here just in case we go for
2685 // a better error handling.
Jim Grosbach861e49c2011-02-12 01:34:40 +00002686 OS << Target.getName() << ClassName << "::OperandMatchResultTy "
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002687 << Target.getName() << ClassName << "::\n"
David Blaikie960ea3f2014-06-08 16:18:35 +00002688 << "MatchOperandParserImpl(OperandVector"
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002689 << " &Operands,\n StringRef Mnemonic) {\n";
2690
2691 // Emit code to get the available features.
2692 OS << " // Get the current feature set.\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002693 OS << " uint64_t AvailableFeatures = getAvailableFeatures();\n\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002694
2695 OS << " // Get the next operand index.\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00002696 OS << " unsigned NextOpNum = Operands.size()"
2697 << (HasMnemonicFirst ? " - 1" : "") << ";\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002698
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002699 // Emit code to search the table.
2700 OS << " // Search the table.\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00002701 if (HasMnemonicFirst) {
2702 OS << " auto MnemonicRange =\n";
2703 OS << " std::equal_range(std::begin(OperandMatchTable), "
2704 "std::end(OperandMatchTable),\n";
2705 OS << " Mnemonic, LessOpcodeOperand());\n\n";
2706 } else {
2707 OS << " auto MnemonicRange = std::make_pair(std::begin(OperandMatchTable),"
2708 " std::end(OperandMatchTable));\n";
2709 OS << " if (!Mnemonic.empty())\n";
2710 OS << " MnemonicRange =\n";
2711 OS << " std::equal_range(std::begin(OperandMatchTable), "
2712 "std::end(OperandMatchTable),\n";
2713 OS << " Mnemonic, LessOpcodeOperand());\n\n";
2714 }
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002715
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002716 OS << " if (MnemonicRange.first == MnemonicRange.second)\n";
Jim Grosbach861e49c2011-02-12 01:34:40 +00002717 OS << " return MatchOperand_NoMatch;\n\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002718
2719 OS << " for (const OperandMatchEntry *it = MnemonicRange.first,\n"
2720 << " *ie = MnemonicRange.second; it != ie; ++it) {\n";
2721
2722 OS << " // equal_range guarantees that instruction mnemonic matches.\n";
Benjamin Kramer0764a3f2012-03-03 20:44:43 +00002723 OS << " assert(Mnemonic == it->getMnemonic());\n\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002724
2725 // Emit check that the required features are available.
2726 OS << " // check if the available features match\n";
2727 OS << " if ((AvailableFeatures & it->RequiredFeatures) "
2728 << "!= it->RequiredFeatures) {\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002729 OS << " continue;\n";
2730 OS << " }\n\n";
2731
2732 // Emit check to ensure the operand number matches.
2733 OS << " // check if the operand in question has a custom parser.\n";
2734 OS << " if (!(it->OperandMask & (1 << NextOpNum)))\n";
2735 OS << " continue;\n\n";
2736
2737 // Emit call to the custom parser method
2738 OS << " // call custom parse method to handle the operand\n";
Jim Grosbach861e49c2011-02-12 01:34:40 +00002739 OS << " OperandMatchResultTy Result = ";
Jim Grosbach1f5c5aa2011-12-06 22:07:02 +00002740 OS << "tryCustomParseOperand(Operands, it->Class);\n";
Jim Grosbach861e49c2011-02-12 01:34:40 +00002741 OS << " if (Result != MatchOperand_NoMatch)\n";
2742 OS << " return Result;\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002743 OS << " }\n\n";
2744
Jim Grosbach861e49c2011-02-12 01:34:40 +00002745 OS << " // Okay, we had no match.\n";
2746 OS << " return MatchOperand_NoMatch;\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002747 OS << "}\n\n";
2748}
2749
Daniel Dunbard0470d72009-08-07 21:01:44 +00002750void AsmMatcherEmitter::run(raw_ostream &OS) {
Chris Lattner77d369c2010-12-13 00:23:57 +00002751 CodeGenTarget Target(Records);
Daniel Dunbard0470d72009-08-07 21:01:44 +00002752 Record *AsmParser = Target.getAsmParser();
2753 std::string ClassName = AsmParser->getValueAsString("AsmParserClassName");
2754
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002755 // Compute the information on the instructions to match.
Chris Lattner77d369c2010-12-13 00:23:57 +00002756 AsmMatcherInfo Info(AsmParser, Target, Records);
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002757 Info.buildInfo();
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00002758
Daniel Dunbar3b8a4662010-02-02 23:46:36 +00002759 // Sort the instruction table using the partial order on classes. We use
2760 // stable_sort to ensure that ambiguous instructions are still
2761 // deterministically ordered.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002762 std::stable_sort(Info.Matchables.begin(), Info.Matchables.end(),
2763 [](const std::unique_ptr<MatchableInfo> &a,
2764 const std::unique_ptr<MatchableInfo> &b){
2765 return *a < *b;});
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002766
Oliver Stannard7772f022016-01-25 10:20:19 +00002767#ifndef NDEBUG
2768 // Verify that the table is now sorted
2769 for (auto I = Info.Matchables.begin(), E = Info.Matchables.end(); I != E;
2770 ++I) {
2771 for (auto J = I; J != E; ++J) {
2772 assert(!(**J < **I));
2773 }
2774 }
Eugene Zelenkoecefe5a2016-02-02 18:20:45 +00002775#endif // NDEBUG
Oliver Stannard7772f022016-01-25 10:20:19 +00002776
Daniel Dunbar71330282009-08-08 05:24:34 +00002777 DEBUG_WITH_TYPE("instruction_info", {
Craig Topperf34dad92014-11-28 03:53:02 +00002778 for (const auto &MI : Info.Matchables)
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002779 MI->dump();
Daniel Dunbare10787e2009-08-07 08:26:05 +00002780 });
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00002781
Chris Lattnerad776812010-11-01 05:06:45 +00002782 // Check for ambiguous matchables.
Chris Lattnerc0658cb2010-09-06 21:28:52 +00002783 DEBUG_WITH_TYPE("ambiguous_instrs", {
2784 unsigned NumAmbiguous = 0;
David Blaikie9a6f2832014-12-22 21:26:38 +00002785 for (auto I = Info.Matchables.begin(), E = Info.Matchables.end(); I != E;
2786 ++I) {
2787 for (auto J = std::next(I); J != E; ++J) {
2788 const MatchableInfo &A = **I;
2789 const MatchableInfo &B = **J;
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002790
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002791 if (A.couldMatchAmbiguouslyWith(B)) {
Chris Lattnerad776812010-11-01 05:06:45 +00002792 errs() << "warning: ambiguous matchables:\n";
Chris Lattnerc0658cb2010-09-06 21:28:52 +00002793 A.dump();
2794 errs() << "\nis incomparable with:\n";
2795 B.dump();
2796 errs() << "\n\n";
Chris Lattnerfdb7dec2010-09-06 20:21:47 +00002797 ++NumAmbiguous;
2798 }
Daniel Dunbarf573b562009-08-09 06:05:33 +00002799 }
Daniel Dunbar3239f022009-08-09 04:00:06 +00002800 }
Chris Lattnerfdb7dec2010-09-06 20:21:47 +00002801 if (NumAmbiguous)
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002802 errs() << "warning: " << NumAmbiguous
Chris Lattnerad776812010-11-01 05:06:45 +00002803 << " ambiguous matchables!\n";
Chris Lattnerc0658cb2010-09-06 21:28:52 +00002804 });
Daniel Dunbar3239f022009-08-09 04:00:06 +00002805
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002806 // Compute the information on the custom operand parsing.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002807 Info.buildOperandMatchInfo();
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002808
Craig Topperfd2c6a32015-12-31 08:18:23 +00002809 bool HasMnemonicFirst = AsmParser->getValueAsBit("HasMnemonicFirst");
2810
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00002811 // Write the output.
2812
Chris Lattner3e4582a2010-09-06 19:11:01 +00002813 // Information for the class declaration.
2814 OS << "\n#ifdef GET_ASSEMBLER_HEADER\n";
2815 OS << "#undef GET_ASSEMBLER_HEADER\n";
Jim Grosbach860a84d2011-02-11 21:31:55 +00002816 OS << " // This should be included into the middle of the declaration of\n";
Evan Cheng11424442011-07-26 00:24:13 +00002817 OS << " // your subclasses implementation of MCTargetAsmParser.\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002818 OS << " uint64_t ComputeAvailableFeatures(const FeatureBitset& FB) const;\n";
Chad Rosierba284b92012-09-05 01:02:38 +00002819 OS << " void convertToMCInst(unsigned Kind, MCInst &Inst, "
Daniel Dunbar191524e2011-02-04 23:17:40 +00002820 << "unsigned Opcode,\n"
David Blaikie960ea3f2014-06-08 16:18:35 +00002821 << " const OperandVector "
Daniel Dunbar191524e2011-02-04 23:17:40 +00002822 << "&Operands);\n";
Chad Rosier380a74a2012-10-02 00:25:57 +00002823 OS << " void convertToMapAndConstraints(unsigned Kind,\n ";
David Blaikie960ea3f2014-06-08 16:18:35 +00002824 OS << " const OperandVector &Operands) override;\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00002825 if (HasMnemonicFirst)
2826 OS << " bool mnemonicIsValid(StringRef Mnemonic, unsigned VariantID);\n";
Craig Toppera5754e62015-01-03 08:16:29 +00002827 OS << " unsigned MatchInstructionImpl(const OperandVector &Operands,\n"
Chad Rosier2f480a82012-10-12 22:53:36 +00002828 << " MCInst &Inst,\n"
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002829 << " uint64_t &ErrorInfo,"
2830 << " bool matchingInlineAsm,\n"
Chad Rosier380a74a2012-10-02 00:25:57 +00002831 << " unsigned VariantID = 0);\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002832
Alexander Kornienko8c0809c2015-01-15 11:41:30 +00002833 if (!Info.OperandMatchInfo.empty()) {
Jim Grosbach861e49c2011-02-12 01:34:40 +00002834 OS << "\n enum OperandMatchResultTy {\n";
2835 OS << " MatchOperand_Success, // operand matched successfully\n";
2836 OS << " MatchOperand_NoMatch, // operand did not match\n";
2837 OS << " MatchOperand_ParseFail // operand matched but had errors\n";
2838 OS << " };\n";
2839 OS << " OperandMatchResultTy MatchOperandParserImpl(\n";
David Blaikie960ea3f2014-06-08 16:18:35 +00002840 OS << " OperandVector &Operands,\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002841 OS << " StringRef Mnemonic);\n";
2842
Jim Grosbach1f5c5aa2011-12-06 22:07:02 +00002843 OS << " OperandMatchResultTy tryCustomParseOperand(\n";
David Blaikie960ea3f2014-06-08 16:18:35 +00002844 OS << " OperandVector &Operands,\n";
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002845 OS << " unsigned MCK);\n\n";
2846 }
2847
Chris Lattner3e4582a2010-09-06 19:11:01 +00002848 OS << "#endif // GET_ASSEMBLER_HEADER_INFO\n\n";
2849
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00002850 // Emit the operand match diagnostic enum names.
2851 OS << "\n#ifdef GET_OPERAND_DIAGNOSTIC_TYPES\n";
2852 OS << "#undef GET_OPERAND_DIAGNOSTIC_TYPES\n\n";
2853 emitOperandDiagnosticTypes(Info, OS);
2854 OS << "#endif // GET_OPERAND_DIAGNOSTIC_TYPES\n\n";
2855
Chris Lattner3e4582a2010-09-06 19:11:01 +00002856 OS << "\n#ifdef GET_REGISTER_MATCHER\n";
2857 OS << "#undef GET_REGISTER_MATCHER\n\n";
2858
Daniel Dunbareefe8612010-07-19 05:44:09 +00002859 // Emit the subtarget feature enumeration.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002860 emitSubtargetFeatureFlagEnumeration(Info, OS);
Daniel Dunbareefe8612010-07-19 05:44:09 +00002861
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00002862 // Emit the function to match a register name to number.
Akira Hatanaka7605630c2012-08-17 20:16:42 +00002863 // This should be omitted for Mips target
2864 if (AsmParser->getValueAsBit("ShouldEmitMatchRegisterName"))
2865 emitMatchRegisterName(Target, AsmParser, OS);
Chris Lattner3e4582a2010-09-06 19:11:01 +00002866
Dylan McKaybff960a2016-02-03 10:30:16 +00002867 if (AsmParser->getValueAsBit("ShouldEmitMatchRegisterAltName"))
2868 emitMatchRegisterAltName(Target, AsmParser, OS);
2869
Chris Lattner3e4582a2010-09-06 19:11:01 +00002870 OS << "#endif // GET_REGISTER_MATCHER\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002871
Craig Topper3ec7c2a2012-04-25 06:56:34 +00002872 OS << "\n#ifdef GET_SUBTARGET_FEATURE_NAME\n";
2873 OS << "#undef GET_SUBTARGET_FEATURE_NAME\n\n";
Daniel Dunbar3fb754a2009-08-11 23:23:44 +00002874
Jim Grosbach5117ef72012-04-24 22:40:08 +00002875 // Generate the helper function to get the names for subtarget features.
2876 emitGetSubtargetFeatureName(Info, OS);
2877
Craig Topper3ec7c2a2012-04-25 06:56:34 +00002878 OS << "#endif // GET_SUBTARGET_FEATURE_NAME\n\n";
2879
2880 OS << "\n#ifdef GET_MATCHER_IMPLEMENTATION\n";
2881 OS << "#undef GET_MATCHER_IMPLEMENTATION\n\n";
2882
Chris Lattner477fba4f2010-10-30 18:48:18 +00002883 // Generate the function that remaps for mnemonic aliases.
Chad Rosier9f7a2212013-04-18 22:35:36 +00002884 bool HasMnemonicAliases = emitMnemonicAliases(OS, Info, Target);
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00002885
Chad Rosierf4e35dc2012-10-01 23:45:51 +00002886 // Generate the convertToMCInst function to convert operands into an MCInst.
2887 // Also, generate the convertToMapAndConstraints function for MS-style inline
2888 // assembly. The latter doesn't actually generate a MCInst.
Craig Topperfd2c6a32015-12-31 08:18:23 +00002889 emitConvertFuncs(Target, ClassName, Info.Matchables, HasMnemonicFirst, OS);
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00002890
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002891 // Emit the enumeration for classes which participate in matching.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002892 emitMatchClassEnumeration(Target, Info.Classes, OS);
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00002893
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002894 // Emit the routine to match token strings to their match class.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002895 emitMatchTokenString(Target, Info.Classes, OS);
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002896
Daniel Dunbar2587b612009-08-10 16:05:47 +00002897 // Emit the subclass predicate routine.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002898 emitIsSubclass(Target, Info.Classes, OS);
Daniel Dunbar2587b612009-08-10 16:05:47 +00002899
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00002900 // Emit the routine to validate an operand against a match class.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002901 emitValidateOperandClass(Info, OS);
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00002902
Daniel Dunbareefe8612010-07-19 05:44:09 +00002903 // Emit the available features compute function.
Jim Grosbach8c2beaa2012-04-19 17:52:32 +00002904 emitComputeAvailableFeatures(Info, OS);
Daniel Dunbareefe8612010-07-19 05:44:09 +00002905
Craig Toppere2cfeb32012-09-18 06:10:45 +00002906 StringToOffsetTable StringTable;
2907
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002908 size_t MaxNumOperands = 0;
Craig Toppere2cfeb32012-09-18 06:10:45 +00002909 unsigned MaxMnemonicIndex = 0;
Joey Gouly0e76fa72013-09-12 10:28:05 +00002910 bool HasDeprecation = false;
Craig Topperf34dad92014-11-28 03:53:02 +00002911 for (const auto &MI : Info.Matchables) {
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002912 MaxNumOperands = std::max(MaxNumOperands, MI->AsmOperands.size());
2913 HasDeprecation |= MI->HasDeprecation;
Craig Toppere2cfeb32012-09-18 06:10:45 +00002914
2915 // Store a pascal-style length byte in the mnemonic.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002916 std::string LenMnemonic = char(MI->Mnemonic.size()) + MI->Mnemonic.str();
Craig Toppere2cfeb32012-09-18 06:10:45 +00002917 MaxMnemonicIndex = std::max(MaxMnemonicIndex,
2918 StringTable.GetOrAddStringOffset(LenMnemonic, false));
2919 }
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002920
Craig Topper7ecfa6d2012-09-18 07:02:21 +00002921 OS << "static const char *const MnemonicTable =\n";
2922 StringTable.EmitString(OS);
2923 OS << ";\n\n";
2924
Daniel Dunbar541efcc2009-08-08 07:50:56 +00002925 // Emit the static match table; unused classes get initalized to 0 which is
2926 // guaranteed to be InvalidMatchClass.
2927 //
2928 // FIXME: We can reduce the size of this table very easily. First, we change
2929 // it so that store the kinds in separate bit-fields for each index, which
2930 // only needs to be the max width used for classes at that index (we also need
2931 // to reject based on this during classification). If we then make sure to
2932 // order the match kinds appropriately (putting mnemonics last), then we
2933 // should only end up using a few bits for each class, especially the ones
2934 // following the mnemonic.
Chris Lattner6b6f3dd2010-09-06 21:08:38 +00002935 OS << "namespace {\n";
2936 OS << " struct MatchEntry {\n";
Craig Toppere2cfeb32012-09-18 06:10:45 +00002937 OS << " " << getMinimalTypeForRange(MaxMnemonicIndex)
2938 << " Mnemonic;\n";
Benjamin Kramer5aeee5f2012-03-03 19:13:26 +00002939 OS << " uint16_t Opcode;\n";
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002940 OS << " " << getMinimalTypeForRange(Info.Matchables.size())
2941 << " ConvertFn;\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002942 OS << " " << getMinimalRequiredFeaturesType(Info)
2943 << " RequiredFeatures;\n";
David Blaikied749e342014-11-28 20:35:57 +00002944 OS << " " << getMinimalTypeForRange(
2945 std::distance(Info.Classes.begin(), Info.Classes.end()))
2946 << " Classes[" << MaxNumOperands << "];\n";
Benjamin Kramer5aeee5f2012-03-03 19:13:26 +00002947 OS << " StringRef getMnemonic() const {\n";
2948 OS << " return StringRef(MnemonicTable + Mnemonic + 1,\n";
2949 OS << " MnemonicTable[Mnemonic]);\n";
2950 OS << " }\n";
Chris Lattner81301972010-09-06 21:22:45 +00002951 OS << " };\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002952
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00002953 OS << " // Predicate for searching for an opcode.\n";
Chris Lattner81301972010-09-06 21:22:45 +00002954 OS << " struct LessOpcode {\n";
2955 OS << " bool operator()(const MatchEntry &LHS, StringRef RHS) {\n";
Benjamin Kramer5aeee5f2012-03-03 19:13:26 +00002956 OS << " return LHS.getMnemonic() < RHS;\n";
Chris Lattner81301972010-09-06 21:22:45 +00002957 OS << " }\n";
2958 OS << " bool operator()(StringRef LHS, const MatchEntry &RHS) {\n";
Benjamin Kramer5aeee5f2012-03-03 19:13:26 +00002959 OS << " return LHS < RHS.getMnemonic();\n";
Chris Lattner81301972010-09-06 21:22:45 +00002960 OS << " }\n";
Chris Lattner62823362010-09-07 06:10:48 +00002961 OS << " bool operator()(const MatchEntry &LHS, const MatchEntry &RHS) {\n";
Benjamin Kramer5aeee5f2012-03-03 19:13:26 +00002962 OS << " return LHS.getMnemonic() < RHS.getMnemonic();\n";
Chris Lattner62823362010-09-07 06:10:48 +00002963 OS << " }\n";
Chris Lattner6b6f3dd2010-09-06 21:08:38 +00002964 OS << " };\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002965
Chris Lattner6b6f3dd2010-09-06 21:08:38 +00002966 OS << "} // end anonymous namespace.\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002967
Craig Topper690d8ea2013-07-24 07:33:14 +00002968 unsigned VariantCount = Target.getAsmParserVariantCount();
2969 for (unsigned VC = 0; VC != VariantCount; ++VC) {
2970 Record *AsmVariant = Target.getAsmParserVariant(VC);
Craig Topper690d8ea2013-07-24 07:33:14 +00002971 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002972
Craig Topper690d8ea2013-07-24 07:33:14 +00002973 OS << "static const MatchEntry MatchTable" << VC << "[] = {\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002974
Craig Topperf34dad92014-11-28 03:53:02 +00002975 for (const auto &MI : Info.Matchables) {
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002976 if (MI->AsmVariantID != AsmVariantNo)
Craig Topper690d8ea2013-07-24 07:33:14 +00002977 continue;
Jim Grosbach0eccfc22010-10-29 22:13:48 +00002978
Craig Topper690d8ea2013-07-24 07:33:14 +00002979 // Store a pascal-style length byte in the mnemonic.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002980 std::string LenMnemonic = char(MI->Mnemonic.size()) + MI->Mnemonic.str();
Craig Topper690d8ea2013-07-24 07:33:14 +00002981 OS << " { " << StringTable.GetOrAddStringOffset(LenMnemonic, false)
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002982 << " /* " << MI->Mnemonic << " */, "
2983 << Target.getName() << "::"
2984 << MI->getResultInst()->TheDef->getName() << ", "
2985 << MI->ConversionFnKind << ", ";
Craig Topper690d8ea2013-07-24 07:33:14 +00002986
2987 // Write the required features mask.
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002988 if (!MI->RequiredFeatures.empty()) {
2989 for (unsigned i = 0, e = MI->RequiredFeatures.size(); i != e; ++i) {
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002990 if (i) OS << "|";
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002991 OS << MI->RequiredFeatures[i]->getEnumName();
Craig Topper690d8ea2013-07-24 07:33:14 +00002992 }
2993 } else
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00002994 OS << "0";
Craig Topper690d8ea2013-07-24 07:33:14 +00002995
2996 OS << ", { ";
Duncan P. N. Exon Smith5a48cafb2014-11-28 23:00:22 +00002997 for (unsigned i = 0, e = MI->AsmOperands.size(); i != e; ++i) {
2998 const MatchableInfo::AsmOperand &Op = MI->AsmOperands[i];
Craig Topper690d8ea2013-07-24 07:33:14 +00002999
3000 if (i) OS << ", ";
3001 OS << Op.Class->Name;
Daniel Dunbareefe8612010-07-19 05:44:09 +00003002 }
Craig Topper690d8ea2013-07-24 07:33:14 +00003003 OS << " }, },\n";
Craig Topper4de73732012-04-02 07:48:39 +00003004 }
Jim Grosbach0eccfc22010-10-29 22:13:48 +00003005
Craig Topper690d8ea2013-07-24 07:33:14 +00003006 OS << "};\n\n";
3007 }
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00003008
Bob Wilson770681d72011-01-26 21:43:46 +00003009 // A method to determine if a mnemonic is in the list.
Craig Topperfd2c6a32015-12-31 08:18:23 +00003010 if (HasMnemonicFirst) {
3011 OS << "bool " << Target.getName() << ClassName << "::\n"
3012 << "mnemonicIsValid(StringRef Mnemonic, unsigned VariantID) {\n";
3013 OS << " // Find the appropriate table for this asm variant.\n";
3014 OS << " const MatchEntry *Start, *End;\n";
3015 OS << " switch (VariantID) {\n";
3016 OS << " default: llvm_unreachable(\"invalid variant!\");\n";
3017 for (unsigned VC = 0; VC != VariantCount; ++VC) {
3018 Record *AsmVariant = Target.getAsmParserVariant(VC);
3019 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
3020 OS << " case " << AsmVariantNo << ": Start = std::begin(MatchTable" << VC
3021 << "); End = std::end(MatchTable" << VC << "); break;\n";
3022 }
3023 OS << " }\n";
3024 OS << " // Search the table.\n";
3025 OS << " auto MnemonicRange = ";
3026 OS << "std::equal_range(Start, End, Mnemonic, LessOpcode());\n";
3027 OS << " return MnemonicRange.first != MnemonicRange.second;\n";
3028 OS << "}\n\n";
Craig Topper690d8ea2013-07-24 07:33:14 +00003029 }
Bob Wilson770681d72011-01-26 21:43:46 +00003030
Chris Lattner6b6f3dd2010-09-06 21:08:38 +00003031 // Finally, build the match function.
David Blaikie960ea3f2014-06-08 16:18:35 +00003032 OS << "unsigned " << Target.getName() << ClassName << "::\n"
Craig Toppera5754e62015-01-03 08:16:29 +00003033 << "MatchInstructionImpl(const OperandVector &Operands,\n";
3034 OS << " MCInst &Inst, uint64_t &ErrorInfo,\n"
3035 << " bool matchingInlineAsm, unsigned VariantID) {\n";
Daniel Dunbareefe8612010-07-19 05:44:09 +00003036
Chad Rosiereac13a32012-08-30 21:43:05 +00003037 OS << " // Eliminate obvious mismatches.\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00003038 OS << " if (Operands.size() > "
3039 << (MaxNumOperands + HasMnemonicFirst) << ") {\n";
3040 OS << " ErrorInfo = "
3041 << (MaxNumOperands + HasMnemonicFirst) << ";\n";
Chad Rosiereac13a32012-08-30 21:43:05 +00003042 OS << " return Match_InvalidOperand;\n";
3043 OS << " }\n\n";
3044
Daniel Dunbareefe8612010-07-19 05:44:09 +00003045 // Emit code to get the available features.
3046 OS << " // Get the current feature set.\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00003047 OS << " uint64_t AvailableFeatures = getAvailableFeatures();\n\n";
Daniel Dunbareefe8612010-07-19 05:44:09 +00003048
Chris Lattnerba7b4fe2010-10-30 17:36:36 +00003049 OS << " // Get the instruction mnemonic, which is the first token.\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00003050 if (HasMnemonicFirst) {
3051 OS << " StringRef Mnemonic = ((" << Target.getName()
3052 << "Operand&)*Operands[0]).getToken();\n\n";
3053 } else {
3054 OS << " StringRef Mnemonic;\n";
3055 OS << " if (Operands[0]->isToken())\n";
3056 OS << " Mnemonic = ((" << Target.getName()
3057 << "Operand&)*Operands[0]).getToken();\n\n";
3058 }
Chris Lattnerba7b4fe2010-10-30 17:36:36 +00003059
Chris Lattner477fba4f2010-10-30 18:48:18 +00003060 if (HasMnemonicAliases) {
3061 OS << " // Process all MnemonicAliases to remap the mnemonic.\n";
Chad Rosier9f7a2212013-04-18 22:35:36 +00003062 OS << " applyMnemonicAliases(Mnemonic, AvailableFeatures, VariantID);\n\n";
Chris Lattner477fba4f2010-10-30 18:48:18 +00003063 }
Bob Wilsonf4ee9e52011-01-26 21:26:19 +00003064
Daniel Dunbar541efcc2009-08-08 07:50:56 +00003065 // Emit code to compute the class list for this operand vector.
Chris Lattnerabfe4222010-09-06 23:37:39 +00003066 OS << " // Some state to try to produce better error messages.\n";
Jim Grosbach120a96a2011-08-15 23:03:29 +00003067 OS << " bool HadMatchOtherThanFeatures = false;\n";
Jim Grosbachd152e2c2011-08-16 20:12:35 +00003068 OS << " bool HadMatchOtherThanPredicate = false;\n";
Jim Grosbach120a96a2011-08-15 23:03:29 +00003069 OS << " unsigned RetCode = Match_InvalidOperand;\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00003070 OS << " uint64_t MissingFeatures = ~0ULL;\n";
Jim Grosbach860a84d2011-02-11 21:31:55 +00003071 OS << " // Set ErrorInfo to the operand that mismatches if it is\n";
Chris Lattnerabfe4222010-09-06 23:37:39 +00003072 OS << " // wrong for all instances of the instruction.\n";
Tom Stellard5698d632015-03-05 19:46:55 +00003073 OS << " ErrorInfo = ~0ULL;\n";
Chris Lattner81301972010-09-06 21:22:45 +00003074
Daniel Dunbar541efcc2009-08-08 07:50:56 +00003075 // Emit code to search the table.
Craig Topper690d8ea2013-07-24 07:33:14 +00003076 OS << " // Find the appropriate table for this asm variant.\n";
3077 OS << " const MatchEntry *Start, *End;\n";
3078 OS << " switch (VariantID) {\n";
Craig Topper8c714d12015-01-03 08:16:14 +00003079 OS << " default: llvm_unreachable(\"invalid variant!\");\n";
Craig Topper690d8ea2013-07-24 07:33:14 +00003080 for (unsigned VC = 0; VC != VariantCount; ++VC) {
3081 Record *AsmVariant = Target.getAsmParserVariant(VC);
Craig Topper690d8ea2013-07-24 07:33:14 +00003082 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
Benjamin Kramer502b9e12014-04-12 16:15:53 +00003083 OS << " case " << AsmVariantNo << ": Start = std::begin(MatchTable" << VC
3084 << "); End = std::end(MatchTable" << VC << "); break;\n";
Craig Topper690d8ea2013-07-24 07:33:14 +00003085 }
3086 OS << " }\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00003087
Daniel Dunbar541efcc2009-08-08 07:50:56 +00003088 OS << " // Search the table.\n";
Craig Topperfd2c6a32015-12-31 08:18:23 +00003089 if (HasMnemonicFirst) {
3090 OS << " auto MnemonicRange = "
3091 "std::equal_range(Start, End, Mnemonic, LessOpcode());\n\n";
3092 } else {
3093 OS << " auto MnemonicRange = std::make_pair(Start, End);\n";
3094 OS << " unsigned SIndex = Mnemonic.empty() ? 0 : 1;\n";
3095 OS << " if (!Mnemonic.empty())\n";
3096 OS << " MnemonicRange = "
3097 "std::equal_range(Start, End, Mnemonic.lower(), LessOpcode());\n\n";
3098 }
Jim Grosbach0eccfc22010-10-29 22:13:48 +00003099
Chris Lattner628fbec2010-09-06 21:54:15 +00003100 OS << " // Return a more specific error code if no mnemonics match.\n";
3101 OS << " if (MnemonicRange.first == MnemonicRange.second)\n";
3102 OS << " return Match_MnemonicFail;\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00003103
Chris Lattner81301972010-09-06 21:22:45 +00003104 OS << " for (const MatchEntry *it = MnemonicRange.first, "
Chris Lattner9026ac02010-09-06 21:23:43 +00003105 << "*ie = MnemonicRange.second;\n";
Chris Lattner81301972010-09-06 21:22:45 +00003106 OS << " it != ie; ++it) {\n";
Daniel Dunbareefe8612010-07-19 05:44:09 +00003107
Craig Topperfd2c6a32015-12-31 08:18:23 +00003108 if (HasMnemonicFirst) {
3109 OS << " // equal_range guarantees that instruction mnemonic matches.\n";
3110 OS << " assert(Mnemonic == it->getMnemonic());\n";
3111 }
3112
Daniel Dunbareefe8612010-07-19 05:44:09 +00003113 // Emit check that the subclasses match.
Chris Lattner339cc7b2010-09-06 22:11:18 +00003114 OS << " bool OperandsValid = true;\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003115 OS << " for (unsigned FormalIdx = " << (HasMnemonicFirst ? "0" : "SIndex")
3116 << ", ActualIdx = " << (HasMnemonicFirst ? "1" : "SIndex")
3117 << "; FormalIdx != " << MaxNumOperands << "; ++FormalIdx) {\n";
3118 OS << " auto Formal = "
3119 << "static_cast<MatchClassKind>(it->Classes[FormalIdx]);\n";
3120 OS << " if (ActualIdx >= Operands.size()) {\n";
Tom Stellardb9f235e2016-02-05 19:59:33 +00003121 OS << " OperandsValid = (Formal == " <<"InvalidMatchClass) || "
3122 "isSubclass(Formal, OptionalMatchClass);\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003123 OS << " if (!OperandsValid) ErrorInfo = ActualIdx;\n";
Jim Grosbache6ce2052011-05-03 19:09:56 +00003124 OS << " break;\n";
Jim Grosbach6e2e29b2011-02-10 00:08:28 +00003125 OS << " }\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003126 OS << " MCParsedAsmOperand &Actual = *Operands[ActualIdx];\n";
Colin LeMahieu23403c22015-11-09 00:46:46 +00003127 OS << " unsigned Diag = validateOperandClass(Actual, Formal);\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003128 OS << " if (Diag == Match_Success) {\n";
3129 OS << " ++ActualIdx;\n";
Chris Lattner339cc7b2010-09-06 22:11:18 +00003130 OS << " continue;\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003131 OS << " }\n";
Jim Grosbach86c652a2013-02-06 06:00:06 +00003132 OS << " // If the generic handler indicates an invalid operand\n";
3133 OS << " // failure, check for a special case.\n";
3134 OS << " if (Diag == Match_InvalidOperand) {\n";
Colin LeMahieu23403c22015-11-09 00:46:46 +00003135 OS << " Diag = validateTargetOperandClass(Actual, Formal);\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003136 OS << " if (Diag == Match_Success) {\n";
3137 OS << " ++ActualIdx;\n";
Jim Grosbach86c652a2013-02-06 06:00:06 +00003138 OS << " continue;\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003139 OS << " }\n";
Jim Grosbach86c652a2013-02-06 06:00:06 +00003140 OS << " }\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003141 OS << " // If current formal operand wasn't matched and it is optional\n"
3142 << " // then try to match next formal operand\n";
3143 OS << " if (Diag == Match_InvalidOperand "
3144 << "&& isSubclass(Formal, OptionalMatchClass))\n";
3145 OS << " continue;\n";
Chris Lattnerabfe4222010-09-06 23:37:39 +00003146 OS << " // If this operand is broken for all of the instances of this\n";
3147 OS << " // mnemonic, keep track of it so we can report loc info.\n";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00003148 OS << " // If we already had a match that only failed due to a\n";
3149 OS << " // target predicate, that diagnostic is preferred.\n";
3150 OS << " if (!HadMatchOtherThanPredicate &&\n";
Nikolay Haustovea8febd2016-03-01 08:34:43 +00003151 OS << " (it == MnemonicRange.first || ErrorInfo <= ActualIdx)) {\n";
3152 OS << " ErrorInfo = ActualIdx;\n";
Jim Grosbach8ccdbd12012-06-26 22:58:01 +00003153 OS << " // InvalidOperand is the default. Prefer specificity.\n";
3154 OS << " if (Diag != Match_InvalidOperand)\n";
3155 OS << " RetCode = Diag;\n";
Jim Grosbach3a8a0fa2012-06-22 23:56:44 +00003156 OS << " }\n";
Chris Lattner339cc7b2010-09-06 22:11:18 +00003157 OS << " // Otherwise, just reject this instance of the mnemonic.\n";
3158 OS << " OperandsValid = false;\n";
3159 OS << " break;\n";
3160 OS << " }\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00003161
Chris Lattner339cc7b2010-09-06 22:11:18 +00003162 OS << " if (!OperandsValid) continue;\n";
Chris Lattnerb4be28f2010-09-06 20:08:02 +00003163
3164 // Emit check that the required features are available.
3165 OS << " if ((AvailableFeatures & it->RequiredFeatures) "
3166 << "!= it->RequiredFeatures) {\n";
3167 OS << " HadMatchOtherThanFeatures = true;\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00003168 OS << " uint64_t NewMissingFeatures = it->RequiredFeatures & "
Jim Grosbach9ec06a152012-06-18 19:45:46 +00003169 "~AvailableFeatures;\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00003170 OS << " if (countPopulation(NewMissingFeatures) <=\n"
3171 " countPopulation(MissingFeatures))\n";
Jim Grosbach9ec06a152012-06-18 19:45:46 +00003172 OS << " MissingFeatures = NewMissingFeatures;\n";
Chris Lattnerb4be28f2010-09-06 20:08:02 +00003173 OS << " continue;\n";
3174 OS << " }\n";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00003175 OS << "\n";
Ahmed Bougacha0dc19792014-12-16 18:05:28 +00003176 OS << " Inst.clear();\n\n";
Chad Rosierf4e35dc2012-10-01 23:45:51 +00003177 OS << " if (matchingInlineAsm) {\n";
Chad Rosierf4e35dc2012-10-01 23:45:51 +00003178 OS << " Inst.setOpcode(it->Opcode);\n";
Chad Rosier2f480a82012-10-12 22:53:36 +00003179 OS << " convertToMapAndConstraints(it->ConvertFn, Operands);\n";
Chad Rosierf4e35dc2012-10-01 23:45:51 +00003180 OS << " return Match_Success;\n";
3181 OS << " }\n\n";
Daniel Dunbar66193402011-02-04 17:12:23 +00003182 OS << " // We have selected a definite instruction, convert the parsed\n"
3183 << " // operands into the appropriate MCInst.\n";
Chad Rosierba284b92012-09-05 01:02:38 +00003184 OS << " convertToMCInst(it->ConvertFn, Inst, it->Opcode, Operands);\n";
Daniel Dunbar66193402011-02-04 17:12:23 +00003185 OS << "\n";
Daniel Dunbar451a4352010-03-18 20:05:56 +00003186
Jim Grosbach120a96a2011-08-15 23:03:29 +00003187 // Verify the instruction with the target-specific match predicate function.
3188 OS << " // We have a potential match. Check the target predicate to\n"
3189 << " // handle any context sensitive constraints.\n"
3190 << " unsigned MatchResult;\n"
3191 << " if ((MatchResult = checkTargetMatchPredicate(Inst)) !="
3192 << " Match_Success) {\n"
3193 << " Inst.clear();\n"
3194 << " RetCode = MatchResult;\n"
Jim Grosbachd152e2c2011-08-16 20:12:35 +00003195 << " HadMatchOtherThanPredicate = true;\n"
Jim Grosbach120a96a2011-08-15 23:03:29 +00003196 << " continue;\n"
3197 << " }\n\n";
3198
Daniel Dunbar451a4352010-03-18 20:05:56 +00003199 // Call the post-processing function, if used.
3200 std::string InsnCleanupFn =
3201 AsmParser->getValueAsString("AsmParserInstCleanup");
3202 if (!InsnCleanupFn.empty())
3203 OS << " " << InsnCleanupFn << "(Inst);\n";
3204
Joey Gouly0e76fa72013-09-12 10:28:05 +00003205 if (HasDeprecation) {
3206 OS << " std::string Info;\n";
Akira Hatanakabd9fc282015-11-14 05:20:05 +00003207 OS << " if (MII.get(Inst.getOpcode()).getDeprecatedInfo(Inst, getSTI(), Info)) {\n";
David Blaikie960ea3f2014-06-08 16:18:35 +00003208 OS << " SMLoc Loc = ((" << Target.getName()
3209 << "Operand&)*Operands[0]).getStartLoc();\n";
Rafael Espindola961d4692014-11-11 05:18:41 +00003210 OS << " getParser().Warning(Loc, Info, None);\n";
Joey Gouly0e76fa72013-09-12 10:28:05 +00003211 OS << " }\n";
3212 }
3213
Chris Lattnera22a3682010-09-06 19:22:17 +00003214 OS << " return Match_Success;\n";
Daniel Dunbar541efcc2009-08-08 07:50:56 +00003215 OS << " }\n\n";
3216
Chris Lattnerb4be28f2010-09-06 20:08:02 +00003217 OS << " // Okay, we had no match. Try to return a useful error code.\n";
Chad Rosier4ee03842012-08-21 17:22:47 +00003218 OS << " if (HadMatchOtherThanPredicate || !HadMatchOtherThanFeatures)\n";
3219 OS << " return RetCode;\n\n";
Jim Grosbach9ec06a152012-06-18 19:45:46 +00003220 OS << " // Missing feature matches return which features were missing\n";
Ranjeet Singh86ecbb72015-06-30 12:32:53 +00003221 OS << " ErrorInfo = MissingFeatures;\n";
Jim Grosbachd152e2c2011-08-16 20:12:35 +00003222 OS << " return Match_MissingFeature;\n";
Daniel Dunbarb6d6aa22009-07-31 02:32:59 +00003223 OS << "}\n\n";
Jim Grosbach0eccfc22010-10-29 22:13:48 +00003224
Alexander Kornienko8c0809c2015-01-15 11:41:30 +00003225 if (!Info.OperandMatchInfo.empty())
Craig Topper7ecfa6d2012-09-18 07:02:21 +00003226 emitCustomOperandParsing(OS, Target, Info, ClassName, StringTable,
Craig Topperfd2c6a32015-12-31 08:18:23 +00003227 MaxMnemonicIndex, HasMnemonicFirst);
Bruno Cardoso Lopes2315beb2011-02-07 19:38:32 +00003228
Chris Lattner3e4582a2010-09-06 19:11:01 +00003229 OS << "#endif // GET_MATCHER_IMPLEMENTATION\n\n";
Daniel Dunbar3085b572009-07-11 19:39:44 +00003230}
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +00003231
3232namespace llvm {
3233
3234void EmitAsmMatcher(RecordKeeper &RK, raw_ostream &OS) {
3235 emitSourceFileHeader("Assembly Matcher Source Fragment", OS);
3236 AsmMatcherEmitter(RK).run(OS);
3237}
3238
Eugene Zelenkoecefe5a2016-02-02 18:20:45 +00003239} // end namespace llvm