1 //===- AsmMatcherEmitter.cpp - Generate an assembly matcher ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend emits a target specifier matcher for converting parsed
11 // assembly operands in the MCInst structures. It also emits a matcher for
12 // custom operand parsing.
14 // Converting assembly operands into MCInst structures
15 // ---------------------------------------------------
17 // 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
24 // Some example inputs, for X86:
25 // 'addl' (immediate ...) (register ...)
26 // 'add' (immediate ...) (memory ...)
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:
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.
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
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.
52 // The matching is divided into two distinct phases:
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.
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).
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.
67 // In addition, the subset relation amongst classes induces a partial order
68 // on such tuples, which we use to resolve ambiguities.
70 // 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.
75 // Custom Operand Parsing
76 // ----------------------
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
80 // identifiers that need to be mapped to specific values in the final encoded
81 // instructions. The target specific custom operand parsing works in the
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.
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
91 // present in the mask, a successful match occurs. Otherwise, fallback
92 // to the regular operand parsing.
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.
97 //===----------------------------------------------------------------------===//
99 #include "CodeGenTarget.h"
100 #include "llvm/ADT/PointerUnion.h"
101 #include "llvm/ADT/STLExtras.h"
102 #include "llvm/ADT/SmallPtrSet.h"
103 #include "llvm/ADT/SmallVector.h"
104 #include "llvm/ADT/StringExtras.h"
105 #include "llvm/Support/CommandLine.h"
106 #include "llvm/Support/Debug.h"
107 #include "llvm/Support/ErrorHandling.h"
108 #include "llvm/TableGen/Error.h"
109 #include "llvm/TableGen/Record.h"
110 #include "llvm/TableGen/StringMatcher.h"
111 #include "llvm/TableGen/StringToOffsetTable.h"
112 #include "llvm/TableGen/TableGenBackend.h"
118 #include <forward_list>
119 using namespace llvm;
121 #define DEBUG_TYPE "asm-matcher-emitter"
123 static cl::opt<std::string>
124 MatchPrefix("match-prefix", cl::init(""),
125 cl::desc("Only match instructions with the given prefix"));
128 class AsmMatcherInfo;
129 struct SubtargetFeatureInfo;
131 // Register sets are used as keys in some second-order sets TableGen creates
132 // when generating its data structures. This means that the order of two
133 // RegisterSets can be seen in the outputted AsmMatcher tables occasionally, and
134 // can even affect compiler output (at least seen in diagnostics produced when
135 // all matches fail). So we use a type that sorts them consistently.
136 typedef std::set<Record*, LessRecordByID> RegisterSet;
138 class AsmMatcherEmitter {
139 RecordKeeper &Records;
141 AsmMatcherEmitter(RecordKeeper &R) : Records(R) {}
143 void run(raw_ostream &o);
146 /// ClassInfo - Helper class for storing the information about a particular
147 /// class of operands which can be matched.
150 /// Invalid kind, for use as a sentinel value.
153 /// The class for a particular token.
156 /// The (first) register class, subsequent register classes are
157 /// RegisterClass0+1, and so on.
160 /// The (first) user defined class, subsequent user defined classes are
161 /// UserClass0+1, and so on.
165 /// Kind - The class kind, which is either a predefined kind, or (UserClass0 +
166 /// N) for the Nth user defined class.
169 /// SuperClasses - The super classes of this class. Note that for simplicities
170 /// sake user operands only record their immediate super class, while register
171 /// operands include all superclasses.
172 std::vector<ClassInfo*> SuperClasses;
174 /// Name - The full class name, suitable for use in an enum.
177 /// ClassName - The unadorned generic name for this class (e.g., Token).
178 std::string ClassName;
180 /// ValueName - The name of the value this class represents; for a token this
181 /// is the literal token string, for an operand it is the TableGen class (or
182 /// empty if this is a derived class).
183 std::string ValueName;
185 /// PredicateMethod - The name of the operand method to test whether the
186 /// operand matches this class; this is not valid for Token or register kinds.
187 std::string PredicateMethod;
189 /// RenderMethod - The name of the operand method to add this operand to an
190 /// MCInst; this is not valid for Token or register kinds.
191 std::string RenderMethod;
193 /// ParserMethod - The name of the operand method to do a target specific
194 /// parsing on the operand.
195 std::string ParserMethod;
197 /// For register classes: the records for all the registers in this class.
198 RegisterSet Registers;
200 /// For custom match classes: the diagnostic kind for when the predicate fails.
201 std::string DiagnosticType;
203 /// isRegisterClass() - Check if this is a register class.
204 bool isRegisterClass() const {
205 return Kind >= RegisterClass0 && Kind < UserClass0;
208 /// isUserClass() - Check if this is a user defined class.
209 bool isUserClass() const {
210 return Kind >= UserClass0;
213 /// isRelatedTo - Check whether this class is "related" to \p RHS. Classes
214 /// are related if they are in the same class hierarchy.
215 bool isRelatedTo(const ClassInfo &RHS) const {
216 // Tokens are only related to tokens.
217 if (Kind == Token || RHS.Kind == Token)
218 return Kind == Token && RHS.Kind == Token;
220 // Registers classes are only related to registers classes, and only if
221 // their intersection is non-empty.
222 if (isRegisterClass() || RHS.isRegisterClass()) {
223 if (!isRegisterClass() || !RHS.isRegisterClass())
227 std::insert_iterator<RegisterSet> II(Tmp, Tmp.begin());
228 std::set_intersection(Registers.begin(), Registers.end(),
229 RHS.Registers.begin(), RHS.Registers.end(),
230 II, LessRecordByID());
235 // Otherwise we have two users operands; they are related if they are in the
236 // same class hierarchy.
238 // FIXME: This is an oversimplification, they should only be related if they
239 // intersect, however we don't have that information.
240 assert(isUserClass() && RHS.isUserClass() && "Unexpected class!");
241 const ClassInfo *Root = this;
242 while (!Root->SuperClasses.empty())
243 Root = Root->SuperClasses.front();
245 const ClassInfo *RHSRoot = &RHS;
246 while (!RHSRoot->SuperClasses.empty())
247 RHSRoot = RHSRoot->SuperClasses.front();
249 return Root == RHSRoot;
252 /// isSubsetOf - Test whether this class is a subset of \p RHS.
253 bool isSubsetOf(const ClassInfo &RHS) const {
254 // This is a subset of RHS if it is the same class...
258 // ... or if any of its super classes are a subset of RHS.
259 for (const ClassInfo *CI : SuperClasses)
260 if (CI->isSubsetOf(RHS))
266 /// operator< - Compare two classes.
267 bool operator<(const ClassInfo &RHS) const {
271 // Unrelated classes can be ordered by kind.
272 if (!isRelatedTo(RHS))
273 return Kind < RHS.Kind;
277 llvm_unreachable("Invalid kind!");
280 // This class precedes the RHS if it is a proper subset of the RHS.
283 if (RHS.isSubsetOf(*this))
286 // Otherwise, order by name to ensure we have a total ordering.
287 return ValueName < RHS.ValueName;
292 /// MatchableInfo - Helper class for storing the necessary information for an
293 /// instruction or alias which is capable of being matched.
294 struct MatchableInfo {
296 /// Token - This is the token that the operand came from.
299 /// The unique class instance this operand should match.
302 /// The operand name this is, if anything.
305 /// The suboperand index within SrcOpName, or -1 for the entire operand.
308 /// Register record if this token is singleton register.
309 Record *SingletonReg;
311 explicit AsmOperand(StringRef T) : Token(T), Class(nullptr), SubOpIdx(-1),
312 SingletonReg(nullptr) {}
315 /// ResOperand - This represents a single operand in the result instruction
316 /// generated by the match. In cases (like addressing modes) where a single
317 /// assembler operand expands to multiple MCOperands, this represents the
318 /// single assembler operand, not the MCOperand.
321 /// RenderAsmOperand - This represents an operand result that is
322 /// generated by calling the render method on the assembly operand. The
323 /// corresponding AsmOperand is specified by AsmOperandNum.
326 /// TiedOperand - This represents a result operand that is a duplicate of
327 /// a previous result operand.
330 /// ImmOperand - This represents an immediate value that is dumped into
334 /// RegOperand - This represents a fixed register that is dumped in.
339 /// This is the operand # in the AsmOperands list that this should be
341 unsigned AsmOperandNum;
343 /// TiedOperandNum - This is the (earlier) result operand that should be
345 unsigned TiedOperandNum;
347 /// ImmVal - This is the immediate value added to the instruction.
350 /// Register - This is the register record.
354 /// MINumOperands - The number of MCInst operands populated by this
356 unsigned MINumOperands;
358 static ResOperand getRenderedOp(unsigned AsmOpNum, unsigned NumOperands) {
360 X.Kind = RenderAsmOperand;
361 X.AsmOperandNum = AsmOpNum;
362 X.MINumOperands = NumOperands;
366 static ResOperand getTiedOp(unsigned TiedOperandNum) {
368 X.Kind = TiedOperand;
369 X.TiedOperandNum = TiedOperandNum;
374 static ResOperand getImmOp(int64_t Val) {
382 static ResOperand getRegOp(Record *Reg) {
391 /// AsmVariantID - Target's assembly syntax variant no.
394 /// AsmString - The assembly string for this instruction (with variants
395 /// removed), e.g. "movsx $src, $dst".
396 std::string AsmString;
398 /// TheDef - This is the definition of the instruction or InstAlias that this
399 /// matchable came from.
400 Record *const TheDef;
402 /// DefRec - This is the definition that it came from.
403 PointerUnion<const CodeGenInstruction*, const CodeGenInstAlias*> DefRec;
405 const CodeGenInstruction *getResultInst() const {
406 if (DefRec.is<const CodeGenInstruction*>())
407 return DefRec.get<const CodeGenInstruction*>();
408 return DefRec.get<const CodeGenInstAlias*>()->ResultInst;
411 /// ResOperands - This is the operand list that should be built for the result
413 SmallVector<ResOperand, 8> ResOperands;
415 /// Mnemonic - This is the first token of the matched instruction, its
419 /// AsmOperands - The textual operands that this instruction matches,
420 /// annotated with a class and where in the OperandList they were defined.
421 /// This directly corresponds to the tokenized AsmString after the mnemonic is
423 SmallVector<AsmOperand, 8> AsmOperands;
425 /// Predicates - The required subtarget features to match this instruction.
426 SmallVector<const SubtargetFeatureInfo *, 4> RequiredFeatures;
428 /// ConversionFnKind - The enum value which is passed to the generated
429 /// convertToMCInst to convert parsed operands into an MCInst for this
431 std::string ConversionFnKind;
433 /// If this instruction is deprecated in some form.
436 MatchableInfo(const CodeGenInstruction &CGI)
437 : AsmVariantID(0), AsmString(CGI.AsmString), TheDef(CGI.TheDef), DefRec(&CGI) {
440 MatchableInfo(std::unique_ptr<const CodeGenInstAlias> Alias)
441 : AsmVariantID(0), AsmString(Alias->AsmString), TheDef(Alias->TheDef), DefRec(Alias.release()) {
445 delete DefRec.dyn_cast<const CodeGenInstAlias*>();
448 // Two-operand aliases clone from the main matchable, but mark the second
449 // operand as a tied operand of the first for purposes of the assembler.
450 void formTwoOperandAlias(StringRef Constraint);
452 void initialize(const AsmMatcherInfo &Info,
453 SmallPtrSetImpl<Record*> &SingletonRegisters,
454 int AsmVariantNo, std::string &RegisterPrefix);
456 /// validate - Return true if this matchable is a valid thing to match against
457 /// and perform a bunch of validity checking.
458 bool validate(StringRef CommentDelimiter, bool Hack) const;
460 /// extractSingletonRegisterForAsmOperand - Extract singleton register,
461 /// if present, from specified token.
463 extractSingletonRegisterForAsmOperand(unsigned i, const AsmMatcherInfo &Info,
464 std::string &RegisterPrefix);
466 /// findAsmOperand - Find the AsmOperand with the specified name and
467 /// suboperand index.
468 int findAsmOperand(StringRef N, int SubOpIdx) const {
469 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
470 if (N == AsmOperands[i].SrcOpName &&
471 SubOpIdx == AsmOperands[i].SubOpIdx)
476 /// findAsmOperandNamed - Find the first AsmOperand with the specified name.
477 /// This does not check the suboperand index.
478 int findAsmOperandNamed(StringRef N) const {
479 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
480 if (N == AsmOperands[i].SrcOpName)
485 void buildInstructionResultOperands();
486 void buildAliasResultOperands();
488 /// operator< - Compare two matchables.
489 bool operator<(const MatchableInfo &RHS) const {
490 // The primary comparator is the instruction mnemonic.
491 if (Mnemonic != RHS.Mnemonic)
492 return Mnemonic < RHS.Mnemonic;
494 if (AsmOperands.size() != RHS.AsmOperands.size())
495 return AsmOperands.size() < RHS.AsmOperands.size();
497 // Compare lexicographically by operand. The matcher validates that other
498 // orderings wouldn't be ambiguous using \see couldMatchAmbiguouslyWith().
499 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
500 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
502 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
506 // Give matches that require more features higher precedence. This is useful
507 // because we cannot define AssemblerPredicates with the negation of
508 // processor features. For example, ARM v6 "nop" may be either a HINT or
509 // MOV. With v6, we want to match HINT. The assembler has no way to
510 // predicate MOV under "NoV6", but HINT will always match first because it
511 // requires V6 while MOV does not.
512 if (RequiredFeatures.size() != RHS.RequiredFeatures.size())
513 return RequiredFeatures.size() > RHS.RequiredFeatures.size();
518 /// couldMatchAmbiguouslyWith - Check whether this matchable could
519 /// ambiguously match the same set of operands as \p RHS (without being a
520 /// strictly superior match).
521 bool couldMatchAmbiguouslyWith(const MatchableInfo &RHS) const {
522 // The primary comparator is the instruction mnemonic.
523 if (Mnemonic != RHS.Mnemonic)
526 // The number of operands is unambiguous.
527 if (AsmOperands.size() != RHS.AsmOperands.size())
530 // Otherwise, make sure the ordering of the two instructions is unambiguous
531 // by checking that either (a) a token or operand kind discriminates them,
532 // or (b) the ordering among equivalent kinds is consistent.
534 // Tokens and operand kinds are unambiguous (assuming a correct target
536 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
537 if (AsmOperands[i].Class->Kind != RHS.AsmOperands[i].Class->Kind ||
538 AsmOperands[i].Class->Kind == ClassInfo::Token)
539 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class ||
540 *RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
543 // Otherwise, this operand could commute if all operands are equivalent, or
544 // there is a pair of operands that compare less than and a pair that
545 // compare greater than.
546 bool HasLT = false, HasGT = false;
547 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
548 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
550 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
554 return !(HasLT ^ HasGT);
560 void tokenizeAsmString(const AsmMatcherInfo &Info);
563 /// SubtargetFeatureInfo - Helper class for storing information on a subtarget
564 /// feature which participates in instruction matching.
565 struct SubtargetFeatureInfo {
566 /// \brief The predicate record for this feature.
569 /// \brief An unique index assigned to represent this feature.
572 SubtargetFeatureInfo(Record *D, uint64_t Idx) : TheDef(D), Index(Idx) {}
574 /// \brief The name of the enumerated constant identifying this feature.
575 std::string getEnumName() const {
576 return "Feature_" + TheDef->getName();
580 errs() << getEnumName() << " " << Index << "\n";
585 struct OperandMatchEntry {
586 unsigned OperandMask;
587 const MatchableInfo* MI;
590 static OperandMatchEntry create(const MatchableInfo *mi, ClassInfo *ci,
593 X.OperandMask = opMask;
601 class AsmMatcherInfo {
604 RecordKeeper &Records;
606 /// The tablegen AsmParser record.
609 /// Target - The target information.
610 CodeGenTarget &Target;
612 /// The classes which are needed for matching.
613 std::forward_list<ClassInfo> Classes;
615 /// The information on the matchables to match.
616 std::vector<std::unique_ptr<MatchableInfo>> Matchables;
618 /// Info for custom matching operands by user defined methods.
619 std::vector<OperandMatchEntry> OperandMatchInfo;
621 /// Map of Register records to their class information.
622 typedef std::map<Record*, ClassInfo*, LessRecordByID> RegisterClassesTy;
623 RegisterClassesTy RegisterClasses;
625 /// Map of Predicate records to their subtarget information.
626 std::map<Record *, SubtargetFeatureInfo, LessRecordByID> SubtargetFeatures;
628 /// Map of AsmOperandClass records to their class information.
629 std::map<Record*, ClassInfo*> AsmOperandClasses;
632 /// Map of token to class information which has already been constructed.
633 std::map<std::string, ClassInfo*> TokenClasses;
635 /// Map of RegisterClass records to their class information.
636 std::map<Record*, ClassInfo*> RegisterClassClasses;
639 /// getTokenClass - Lookup or create the class for the given token.
640 ClassInfo *getTokenClass(StringRef Token);
642 /// getOperandClass - Lookup or create the class for the given operand.
643 ClassInfo *getOperandClass(const CGIOperandList::OperandInfo &OI,
645 ClassInfo *getOperandClass(Record *Rec, int SubOpIdx);
647 /// buildRegisterClasses - Build the ClassInfo* instances for register
649 void buildRegisterClasses(SmallPtrSetImpl<Record*> &SingletonRegisters);
651 /// buildOperandClasses - Build the ClassInfo* instances for user defined
653 void buildOperandClasses();
655 void buildInstructionOperandReference(MatchableInfo *II, StringRef OpName,
657 void buildAliasOperandReference(MatchableInfo *II, StringRef OpName,
658 MatchableInfo::AsmOperand &Op);
661 AsmMatcherInfo(Record *AsmParser,
662 CodeGenTarget &Target,
663 RecordKeeper &Records);
665 /// buildInfo - Construct the various tables used during matching.
668 /// buildOperandMatchInfo - Build the necessary information to handle user
669 /// defined operand parsing methods.
670 void buildOperandMatchInfo();
672 /// getSubtargetFeature - Lookup or create the subtarget feature info for the
674 const SubtargetFeatureInfo *getSubtargetFeature(Record *Def) const {
675 assert(Def->isSubClassOf("Predicate") && "Invalid predicate type!");
676 const auto &I = SubtargetFeatures.find(Def);
677 return I == SubtargetFeatures.end() ? nullptr : &I->second;
680 RecordKeeper &getRecords() const {
685 } // End anonymous namespace
687 void MatchableInfo::dump() const {
688 errs() << TheDef->getName() << " -- " << "flattened:\"" << AsmString <<"\"\n";
690 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
691 const AsmOperand &Op = AsmOperands[i];
692 errs() << " op[" << i << "] = " << Op.Class->ClassName << " - ";
693 errs() << '\"' << Op.Token << "\"\n";
697 static std::pair<StringRef, StringRef>
698 parseTwoOperandConstraint(StringRef S, ArrayRef<SMLoc> Loc) {
699 // Split via the '='.
700 std::pair<StringRef, StringRef> Ops = S.split('=');
701 if (Ops.second == "")
702 PrintFatalError(Loc, "missing '=' in two-operand alias constraint");
703 // Trim whitespace and the leading '$' on the operand names.
704 size_t start = Ops.first.find_first_of('$');
705 if (start == std::string::npos)
706 PrintFatalError(Loc, "expected '$' prefix on asm operand name");
707 Ops.first = Ops.first.slice(start + 1, std::string::npos);
708 size_t end = Ops.first.find_last_of(" \t");
709 Ops.first = Ops.first.slice(0, end);
710 // Now the second operand.
711 start = Ops.second.find_first_of('$');
712 if (start == std::string::npos)
713 PrintFatalError(Loc, "expected '$' prefix on asm operand name");
714 Ops.second = Ops.second.slice(start + 1, std::string::npos);
715 end = Ops.second.find_last_of(" \t");
716 Ops.first = Ops.first.slice(0, end);
720 void MatchableInfo::formTwoOperandAlias(StringRef Constraint) {
721 // Figure out which operands are aliased and mark them as tied.
722 std::pair<StringRef, StringRef> Ops =
723 parseTwoOperandConstraint(Constraint, TheDef->getLoc());
725 // Find the AsmOperands that refer to the operands we're aliasing.
726 int SrcAsmOperand = findAsmOperandNamed(Ops.first);
727 int DstAsmOperand = findAsmOperandNamed(Ops.second);
728 if (SrcAsmOperand == -1)
729 PrintFatalError(TheDef->getLoc(),
730 "unknown source two-operand alias operand '" + Ops.first +
732 if (DstAsmOperand == -1)
733 PrintFatalError(TheDef->getLoc(),
734 "unknown destination two-operand alias operand '" +
737 // Find the ResOperand that refers to the operand we're aliasing away
738 // and update it to refer to the combined operand instead.
739 for (unsigned i = 0, e = ResOperands.size(); i != e; ++i) {
740 ResOperand &Op = ResOperands[i];
741 if (Op.Kind == ResOperand::RenderAsmOperand &&
742 Op.AsmOperandNum == (unsigned)SrcAsmOperand) {
743 Op.AsmOperandNum = DstAsmOperand;
747 // Remove the AsmOperand for the alias operand.
748 AsmOperands.erase(AsmOperands.begin() + SrcAsmOperand);
749 // Adjust the ResOperand references to any AsmOperands that followed
750 // the one we just deleted.
751 for (unsigned i = 0, e = ResOperands.size(); i != e; ++i) {
752 ResOperand &Op = ResOperands[i];
755 // Nothing to do for operands that don't reference AsmOperands.
757 case ResOperand::RenderAsmOperand:
758 if (Op.AsmOperandNum > (unsigned)SrcAsmOperand)
761 case ResOperand::TiedOperand:
762 if (Op.TiedOperandNum > (unsigned)SrcAsmOperand)
769 void MatchableInfo::initialize(const AsmMatcherInfo &Info,
770 SmallPtrSetImpl<Record*> &SingletonRegisters,
771 int AsmVariantNo, std::string &RegisterPrefix) {
772 AsmVariantID = AsmVariantNo;
774 CodeGenInstruction::FlattenAsmStringVariants(AsmString, AsmVariantNo);
776 tokenizeAsmString(Info);
778 // Compute the require features.
779 std::vector<Record*> Predicates =TheDef->getValueAsListOfDefs("Predicates");
780 for (unsigned i = 0, e = Predicates.size(); i != e; ++i)
781 if (const SubtargetFeatureInfo *Feature =
782 Info.getSubtargetFeature(Predicates[i]))
783 RequiredFeatures.push_back(Feature);
785 // Collect singleton registers, if used.
786 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
787 extractSingletonRegisterForAsmOperand(i, Info, RegisterPrefix);
788 if (Record *Reg = AsmOperands[i].SingletonReg)
789 SingletonRegisters.insert(Reg);
792 const RecordVal *DepMask = TheDef->getValue("DeprecatedFeatureMask");
794 DepMask = TheDef->getValue("ComplexDeprecationPredicate");
797 DepMask ? !DepMask->getValue()->getAsUnquotedString().empty() : false;
800 /// tokenizeAsmString - Tokenize a simplified assembly string.
801 void MatchableInfo::tokenizeAsmString(const AsmMatcherInfo &Info) {
802 StringRef String = AsmString;
805 for (unsigned i = 0, e = String.size(); i != e; ++i) {
815 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
818 if (!isspace(String[i]) && String[i] != ',')
819 AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
825 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
829 assert(i != String.size() && "Invalid quoted character");
830 AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
836 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
840 // If this isn't "${", treat like a normal token.
841 if (i + 1 == String.size() || String[i + 1] != '{') {
846 StringRef::iterator End = std::find(String.begin() + i, String.end(),'}');
847 assert(End != String.end() && "Missing brace in operand reference!");
848 size_t EndPos = End - String.begin();
849 AsmOperands.push_back(AsmOperand(String.slice(i, EndPos+1)));
856 if (!Info.AsmParser->getValueAsBit("MnemonicContainsDot")) {
858 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
868 if (InTok && Prev != String.size())
869 AsmOperands.push_back(AsmOperand(String.substr(Prev)));
871 // The first token of the instruction is the mnemonic, which must be a
872 // simple string, not a $foo variable or a singleton register.
873 if (AsmOperands.empty())
874 PrintFatalError(TheDef->getLoc(),
875 "Instruction '" + TheDef->getName() + "' has no tokens");
876 Mnemonic = AsmOperands[0].Token;
877 if (Mnemonic.empty())
878 PrintFatalError(TheDef->getLoc(),
879 "Missing instruction mnemonic");
880 // FIXME : Check and raise an error if it is a register.
881 if (Mnemonic[0] == '$')
882 PrintFatalError(TheDef->getLoc(),
883 "Invalid instruction mnemonic '" + Mnemonic + "'!");
885 // Remove the first operand, it is tracked in the mnemonic field.
886 AsmOperands.erase(AsmOperands.begin());
889 bool MatchableInfo::validate(StringRef CommentDelimiter, bool Hack) const {
890 // Reject matchables with no .s string.
891 if (AsmString.empty())
892 PrintFatalError(TheDef->getLoc(), "instruction with empty asm string");
894 // Reject any matchables with a newline in them, they should be marked
895 // isCodeGenOnly if they are pseudo instructions.
896 if (AsmString.find('\n') != std::string::npos)
897 PrintFatalError(TheDef->getLoc(),
898 "multiline instruction is not valid for the asmparser, "
899 "mark it isCodeGenOnly");
901 // Remove comments from the asm string. We know that the asmstring only
903 if (!CommentDelimiter.empty() &&
904 StringRef(AsmString).find(CommentDelimiter) != StringRef::npos)
905 PrintFatalError(TheDef->getLoc(),
906 "asmstring for instruction has comment character in it, "
907 "mark it isCodeGenOnly");
909 // Reject matchables with operand modifiers, these aren't something we can
910 // handle, the target should be refactored to use operands instead of
913 // Also, check for instructions which reference the operand multiple times;
914 // this implies a constraint we would not honor.
915 std::set<std::string> OperandNames;
916 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
917 StringRef Tok = AsmOperands[i].Token;
918 if (Tok[0] == '$' && Tok.find(':') != StringRef::npos)
919 PrintFatalError(TheDef->getLoc(),
920 "matchable with operand modifier '" + Tok +
921 "' not supported by asm matcher. Mark isCodeGenOnly!");
923 // Verify that any operand is only mentioned once.
924 // We reject aliases and ignore instructions for now.
925 if (Tok[0] == '$' && !OperandNames.insert(Tok).second) {
927 PrintFatalError(TheDef->getLoc(),
928 "ERROR: matchable with tied operand '" + Tok +
929 "' can never be matched!");
930 // FIXME: Should reject these. The ARM backend hits this with $lane in a
931 // bunch of instructions. It is unclear what the right answer is.
933 errs() << "warning: '" << TheDef->getName() << "': "
934 << "ignoring instruction with tied operand '"
944 /// extractSingletonRegisterForAsmOperand - Extract singleton register,
945 /// if present, from specified token.
947 extractSingletonRegisterForAsmOperand(unsigned OperandNo,
948 const AsmMatcherInfo &Info,
949 std::string &RegisterPrefix) {
950 StringRef Tok = AsmOperands[OperandNo].Token;
951 if (RegisterPrefix.empty()) {
952 std::string LoweredTok = Tok.lower();
953 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(LoweredTok))
954 AsmOperands[OperandNo].SingletonReg = Reg->TheDef;
958 if (!Tok.startswith(RegisterPrefix))
961 StringRef RegName = Tok.substr(RegisterPrefix.size());
962 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(RegName))
963 AsmOperands[OperandNo].SingletonReg = Reg->TheDef;
965 // If there is no register prefix (i.e. "%" in "%eax"), then this may
966 // be some random non-register token, just ignore it.
970 static std::string getEnumNameForToken(StringRef Str) {
973 for (StringRef::iterator it = Str.begin(), ie = Str.end(); it != ie; ++it) {
975 case '*': Res += "_STAR_"; break;
976 case '%': Res += "_PCT_"; break;
977 case ':': Res += "_COLON_"; break;
978 case '!': Res += "_EXCLAIM_"; break;
979 case '.': Res += "_DOT_"; break;
980 case '<': Res += "_LT_"; break;
981 case '>': Res += "_GT_"; break;
982 case '-': Res += "_MINUS_"; break;
984 if ((*it >= 'A' && *it <= 'Z') ||
985 (*it >= 'a' && *it <= 'z') ||
986 (*it >= '0' && *it <= '9'))
989 Res += "_" + utostr((unsigned) *it) + "_";
996 ClassInfo *AsmMatcherInfo::getTokenClass(StringRef Token) {
997 ClassInfo *&Entry = TokenClasses[Token];
1000 Classes.emplace_front();
1001 Entry = &Classes.front();
1002 Entry->Kind = ClassInfo::Token;
1003 Entry->ClassName = "Token";
1004 Entry->Name = "MCK_" + getEnumNameForToken(Token);
1005 Entry->ValueName = Token;
1006 Entry->PredicateMethod = "<invalid>";
1007 Entry->RenderMethod = "<invalid>";
1008 Entry->ParserMethod = "";
1009 Entry->DiagnosticType = "";
1016 AsmMatcherInfo::getOperandClass(const CGIOperandList::OperandInfo &OI,
1018 Record *Rec = OI.Rec;
1020 Rec = cast<DefInit>(OI.MIOperandInfo->getArg(SubOpIdx))->getDef();
1021 return getOperandClass(Rec, SubOpIdx);
1025 AsmMatcherInfo::getOperandClass(Record *Rec, int SubOpIdx) {
1026 if (Rec->isSubClassOf("RegisterOperand")) {
1027 // RegisterOperand may have an associated ParserMatchClass. If it does,
1028 // use it, else just fall back to the underlying register class.
1029 const RecordVal *R = Rec->getValue("ParserMatchClass");
1030 if (!R || !R->getValue())
1031 PrintFatalError("Record `" + Rec->getName() +
1032 "' does not have a ParserMatchClass!\n");
1034 if (DefInit *DI= dyn_cast<DefInit>(R->getValue())) {
1035 Record *MatchClass = DI->getDef();
1036 if (ClassInfo *CI = AsmOperandClasses[MatchClass])
1040 // No custom match class. Just use the register class.
1041 Record *ClassRec = Rec->getValueAsDef("RegClass");
1043 PrintFatalError(Rec->getLoc(), "RegisterOperand `" + Rec->getName() +
1044 "' has no associated register class!\n");
1045 if (ClassInfo *CI = RegisterClassClasses[ClassRec])
1047 PrintFatalError(Rec->getLoc(), "register class has no class info!");
1051 if (Rec->isSubClassOf("RegisterClass")) {
1052 if (ClassInfo *CI = RegisterClassClasses[Rec])
1054 PrintFatalError(Rec->getLoc(), "register class has no class info!");
1057 if (!Rec->isSubClassOf("Operand"))
1058 PrintFatalError(Rec->getLoc(), "Operand `" + Rec->getName() +
1059 "' does not derive from class Operand!\n");
1060 Record *MatchClass = Rec->getValueAsDef("ParserMatchClass");
1061 if (ClassInfo *CI = AsmOperandClasses[MatchClass])
1064 PrintFatalError(Rec->getLoc(), "operand has no match class!");
1067 struct LessRegisterSet {
1068 bool operator() (const RegisterSet &LHS, const RegisterSet & RHS) const {
1069 // std::set<T> defines its own compariso "operator<", but it
1070 // performs a lexicographical comparison by T's innate comparison
1071 // for some reason. We don't want non-deterministic pointer
1072 // comparisons so use this instead.
1073 return std::lexicographical_compare(LHS.begin(), LHS.end(),
1074 RHS.begin(), RHS.end(),
1079 void AsmMatcherInfo::
1080 buildRegisterClasses(SmallPtrSetImpl<Record*> &SingletonRegisters) {
1081 const auto &Registers = Target.getRegBank().getRegisters();
1082 auto &RegClassList = Target.getRegBank().getRegClasses();
1084 typedef std::set<RegisterSet, LessRegisterSet> RegisterSetSet;
1086 // The register sets used for matching.
1087 RegisterSetSet RegisterSets;
1089 // Gather the defined sets.
1090 for (const CodeGenRegisterClass &RC : RegClassList)
1091 RegisterSets.insert(
1092 RegisterSet(RC.getOrder().begin(), RC.getOrder().end()));
1094 // Add any required singleton sets.
1095 for (Record *Rec : SingletonRegisters) {
1096 RegisterSets.insert(RegisterSet(&Rec, &Rec + 1));
1099 // Introduce derived sets where necessary (when a register does not determine
1100 // a unique register set class), and build the mapping of registers to the set
1101 // they should classify to.
1102 std::map<Record*, RegisterSet> RegisterMap;
1103 for (const CodeGenRegister &CGR : Registers) {
1104 // Compute the intersection of all sets containing this register.
1105 RegisterSet ContainingSet;
1107 for (const RegisterSet &RS : RegisterSets) {
1108 if (!RS.count(CGR.TheDef))
1111 if (ContainingSet.empty()) {
1117 std::swap(Tmp, ContainingSet);
1118 std::insert_iterator<RegisterSet> II(ContainingSet,
1119 ContainingSet.begin());
1120 std::set_intersection(Tmp.begin(), Tmp.end(), RS.begin(), RS.end(), II,
1124 if (!ContainingSet.empty()) {
1125 RegisterSets.insert(ContainingSet);
1126 RegisterMap.insert(std::make_pair(CGR.TheDef, ContainingSet));
1130 // Construct the register classes.
1131 std::map<RegisterSet, ClassInfo*, LessRegisterSet> RegisterSetClasses;
1133 for (const RegisterSet &RS : RegisterSets) {
1134 Classes.emplace_front();
1135 ClassInfo *CI = &Classes.front();
1136 CI->Kind = ClassInfo::RegisterClass0 + Index;
1137 CI->ClassName = "Reg" + utostr(Index);
1138 CI->Name = "MCK_Reg" + utostr(Index);
1140 CI->PredicateMethod = ""; // unused
1141 CI->RenderMethod = "addRegOperands";
1143 // FIXME: diagnostic type.
1144 CI->DiagnosticType = "";
1145 RegisterSetClasses.insert(std::make_pair(RS, CI));
1149 // Find the superclasses; we could compute only the subgroup lattice edges,
1150 // but there isn't really a point.
1151 for (const RegisterSet &RS : RegisterSets) {
1152 ClassInfo *CI = RegisterSetClasses[RS];
1153 for (const RegisterSet &RS2 : RegisterSets)
1155 std::includes(RS2.begin(), RS2.end(), RS.begin(), RS.end(),
1157 CI->SuperClasses.push_back(RegisterSetClasses[RS2]);
1160 // Name the register classes which correspond to a user defined RegisterClass.
1161 for (const CodeGenRegisterClass &RC : RegClassList) {
1162 // Def will be NULL for non-user defined register classes.
1163 Record *Def = RC.getDef();
1166 ClassInfo *CI = RegisterSetClasses[RegisterSet(RC.getOrder().begin(),
1167 RC.getOrder().end())];
1168 if (CI->ValueName.empty()) {
1169 CI->ClassName = RC.getName();
1170 CI->Name = "MCK_" + RC.getName();
1171 CI->ValueName = RC.getName();
1173 CI->ValueName = CI->ValueName + "," + RC.getName();
1175 RegisterClassClasses.insert(std::make_pair(Def, CI));
1178 // Populate the map for individual registers.
1179 for (std::map<Record*, RegisterSet>::iterator it = RegisterMap.begin(),
1180 ie = RegisterMap.end(); it != ie; ++it)
1181 RegisterClasses[it->first] = RegisterSetClasses[it->second];
1183 // Name the register classes which correspond to singleton registers.
1184 for (Record *Rec : SingletonRegisters) {
1185 ClassInfo *CI = RegisterClasses[Rec];
1186 assert(CI && "Missing singleton register class info!");
1188 if (CI->ValueName.empty()) {
1189 CI->ClassName = Rec->getName();
1190 CI->Name = "MCK_" + Rec->getName();
1191 CI->ValueName = Rec->getName();
1193 CI->ValueName = CI->ValueName + "," + Rec->getName();
1197 void AsmMatcherInfo::buildOperandClasses() {
1198 std::vector<Record*> AsmOperands =
1199 Records.getAllDerivedDefinitions("AsmOperandClass");
1201 // Pre-populate AsmOperandClasses map.
1202 for (Record *Rec : AsmOperands) {
1203 Classes.emplace_front();
1204 AsmOperandClasses[Rec] = &Classes.front();
1208 for (Record *Rec : AsmOperands) {
1209 ClassInfo *CI = AsmOperandClasses[Rec];
1210 CI->Kind = ClassInfo::UserClass0 + Index;
1212 ListInit *Supers = Rec->getValueAsListInit("SuperClasses");
1213 for (unsigned i = 0, e = Supers->getSize(); i != e; ++i) {
1214 DefInit *DI = dyn_cast<DefInit>(Supers->getElement(i));
1216 PrintError(Rec->getLoc(), "Invalid super class reference!");
1220 ClassInfo *SC = AsmOperandClasses[DI->getDef()];
1222 PrintError(Rec->getLoc(), "Invalid super class reference!");
1224 CI->SuperClasses.push_back(SC);
1226 CI->ClassName = Rec->getValueAsString("Name");
1227 CI->Name = "MCK_" + CI->ClassName;
1228 CI->ValueName = Rec->getName();
1230 // Get or construct the predicate method name.
1231 Init *PMName = Rec->getValueInit("PredicateMethod");
1232 if (StringInit *SI = dyn_cast<StringInit>(PMName)) {
1233 CI->PredicateMethod = SI->getValue();
1235 assert(isa<UnsetInit>(PMName) && "Unexpected PredicateMethod field!");
1236 CI->PredicateMethod = "is" + CI->ClassName;
1239 // Get or construct the render method name.
1240 Init *RMName = Rec->getValueInit("RenderMethod");
1241 if (StringInit *SI = dyn_cast<StringInit>(RMName)) {
1242 CI->RenderMethod = SI->getValue();
1244 assert(isa<UnsetInit>(RMName) && "Unexpected RenderMethod field!");
1245 CI->RenderMethod = "add" + CI->ClassName + "Operands";
1248 // Get the parse method name or leave it as empty.
1249 Init *PRMName = Rec->getValueInit("ParserMethod");
1250 if (StringInit *SI = dyn_cast<StringInit>(PRMName))
1251 CI->ParserMethod = SI->getValue();
1253 // Get the diagnostic type or leave it as empty.
1254 // Get the parse method name or leave it as empty.
1255 Init *DiagnosticType = Rec->getValueInit("DiagnosticType");
1256 if (StringInit *SI = dyn_cast<StringInit>(DiagnosticType))
1257 CI->DiagnosticType = SI->getValue();
1263 AsmMatcherInfo::AsmMatcherInfo(Record *asmParser,
1264 CodeGenTarget &target,
1265 RecordKeeper &records)
1266 : Records(records), AsmParser(asmParser), Target(target) {
1269 /// buildOperandMatchInfo - Build the necessary information to handle user
1270 /// defined operand parsing methods.
1271 void AsmMatcherInfo::buildOperandMatchInfo() {
1273 /// Map containing a mask with all operands indices that can be found for
1274 /// that class inside a instruction.
1275 typedef std::map<ClassInfo *, unsigned, less_ptr<ClassInfo>> OpClassMaskTy;
1276 OpClassMaskTy OpClassMask;
1278 for (const auto &MI : Matchables) {
1279 OpClassMask.clear();
1281 // Keep track of all operands of this instructions which belong to the
1283 for (unsigned i = 0, e = MI->AsmOperands.size(); i != e; ++i) {
1284 const MatchableInfo::AsmOperand &Op = MI->AsmOperands[i];
1285 if (Op.Class->ParserMethod.empty())
1287 unsigned &OperandMask = OpClassMask[Op.Class];
1288 OperandMask |= (1 << i);
1291 // Generate operand match info for each mnemonic/operand class pair.
1292 for (const auto &OCM : OpClassMask) {
1293 unsigned OpMask = OCM.second;
1294 ClassInfo *CI = OCM.first;
1295 OperandMatchInfo.push_back(OperandMatchEntry::create(MI.get(), CI,
1301 void AsmMatcherInfo::buildInfo() {
1302 // Build information about all of the AssemblerPredicates.
1303 std::vector<Record*> AllPredicates =
1304 Records.getAllDerivedDefinitions("Predicate");
1305 for (unsigned i = 0, e = AllPredicates.size(); i != e; ++i) {
1306 Record *Pred = AllPredicates[i];
1307 // Ignore predicates that are not intended for the assembler.
1308 if (!Pred->getValueAsBit("AssemblerMatcherPredicate"))
1311 if (Pred->getName().empty())
1312 PrintFatalError(Pred->getLoc(), "Predicate has no name!");
1314 SubtargetFeatures.insert(std::make_pair(
1315 Pred, SubtargetFeatureInfo(Pred, SubtargetFeatures.size())));
1316 DEBUG(SubtargetFeatures.find(Pred)->second.dump());
1317 assert(SubtargetFeatures.size() <= 64 && "Too many subtarget features!");
1320 // Parse the instructions; we need to do this first so that we can gather the
1321 // singleton register classes.
1322 SmallPtrSet<Record*, 16> SingletonRegisters;
1323 unsigned VariantCount = Target.getAsmParserVariantCount();
1324 for (unsigned VC = 0; VC != VariantCount; ++VC) {
1325 Record *AsmVariant = Target.getAsmParserVariant(VC);
1326 std::string CommentDelimiter =
1327 AsmVariant->getValueAsString("CommentDelimiter");
1328 std::string RegisterPrefix = AsmVariant->getValueAsString("RegisterPrefix");
1329 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
1331 for (const CodeGenInstruction *CGI : Target.instructions()) {
1333 // If the tblgen -match-prefix option is specified (for tblgen hackers),
1334 // filter the set of instructions we consider.
1335 if (!StringRef(CGI->TheDef->getName()).startswith(MatchPrefix))
1338 // Ignore "codegen only" instructions.
1339 if (CGI->TheDef->getValueAsBit("isCodeGenOnly"))
1342 std::unique_ptr<MatchableInfo> II(new MatchableInfo(*CGI));
1344 II->initialize(*this, SingletonRegisters, AsmVariantNo, RegisterPrefix);
1346 // Ignore instructions which shouldn't be matched and diagnose invalid
1347 // instruction definitions with an error.
1348 if (!II->validate(CommentDelimiter, true))
1351 Matchables.push_back(std::move(II));
1354 // Parse all of the InstAlias definitions and stick them in the list of
1356 std::vector<Record*> AllInstAliases =
1357 Records.getAllDerivedDefinitions("InstAlias");
1358 for (unsigned i = 0, e = AllInstAliases.size(); i != e; ++i) {
1359 auto Alias = llvm::make_unique<CodeGenInstAlias>(AllInstAliases[i],
1360 AsmVariantNo, Target);
1362 // If the tblgen -match-prefix option is specified (for tblgen hackers),
1363 // filter the set of instruction aliases we consider, based on the target
1365 if (!StringRef(Alias->ResultInst->TheDef->getName())
1366 .startswith( MatchPrefix))
1369 std::unique_ptr<MatchableInfo> II(new MatchableInfo(std::move(Alias)));
1371 II->initialize(*this, SingletonRegisters, AsmVariantNo, RegisterPrefix);
1373 // Validate the alias definitions.
1374 II->validate(CommentDelimiter, false);
1376 Matchables.push_back(std::move(II));
1380 // Build info for the register classes.
1381 buildRegisterClasses(SingletonRegisters);
1383 // Build info for the user defined assembly operand classes.
1384 buildOperandClasses();
1386 // Build the information about matchables, now that we have fully formed
1388 std::vector<std::unique_ptr<MatchableInfo>> NewMatchables;
1389 for (auto &II : Matchables) {
1390 // Parse the tokens after the mnemonic.
1391 // Note: buildInstructionOperandReference may insert new AsmOperands, so
1392 // don't precompute the loop bound.
1393 for (unsigned i = 0; i != II->AsmOperands.size(); ++i) {
1394 MatchableInfo::AsmOperand &Op = II->AsmOperands[i];
1395 StringRef Token = Op.Token;
1397 // Check for singleton registers.
1398 if (Record *RegRecord = II->AsmOperands[i].SingletonReg) {
1399 Op.Class = RegisterClasses[RegRecord];
1400 assert(Op.Class && Op.Class->Registers.size() == 1 &&
1401 "Unexpected class for singleton register");
1405 // Check for simple tokens.
1406 if (Token[0] != '$') {
1407 Op.Class = getTokenClass(Token);
1411 if (Token.size() > 1 && isdigit(Token[1])) {
1412 Op.Class = getTokenClass(Token);
1416 // Otherwise this is an operand reference.
1417 StringRef OperandName;
1418 if (Token[1] == '{')
1419 OperandName = Token.substr(2, Token.size() - 3);
1421 OperandName = Token.substr(1);
1423 if (II->DefRec.is<const CodeGenInstruction*>())
1424 buildInstructionOperandReference(II.get(), OperandName, i);
1426 buildAliasOperandReference(II.get(), OperandName, Op);
1429 if (II->DefRec.is<const CodeGenInstruction*>()) {
1430 II->buildInstructionResultOperands();
1431 // If the instruction has a two-operand alias, build up the
1432 // matchable here. We'll add them in bulk at the end to avoid
1433 // confusing this loop.
1434 std::string Constraint =
1435 II->TheDef->getValueAsString("TwoOperandAliasConstraint");
1436 if (Constraint != "") {
1437 // Start by making a copy of the original matchable.
1438 std::unique_ptr<MatchableInfo> AliasII(new MatchableInfo(*II));
1440 // Adjust it to be a two-operand alias.
1441 AliasII->formTwoOperandAlias(Constraint);
1443 // Add the alias to the matchables list.
1444 NewMatchables.push_back(std::move(AliasII));
1447 II->buildAliasResultOperands();
1449 if (!NewMatchables.empty())
1450 Matchables.insert(Matchables.end(),
1451 std::make_move_iterator(NewMatchables.begin()),
1452 std::make_move_iterator(NewMatchables.end()));
1454 // Process token alias definitions and set up the associated superclass
1456 std::vector<Record*> AllTokenAliases =
1457 Records.getAllDerivedDefinitions("TokenAlias");
1458 for (unsigned i = 0, e = AllTokenAliases.size(); i != e; ++i) {
1459 Record *Rec = AllTokenAliases[i];
1460 ClassInfo *FromClass = getTokenClass(Rec->getValueAsString("FromToken"));
1461 ClassInfo *ToClass = getTokenClass(Rec->getValueAsString("ToToken"));
1462 if (FromClass == ToClass)
1463 PrintFatalError(Rec->getLoc(),
1464 "error: Destination value identical to source value.");
1465 FromClass->SuperClasses.push_back(ToClass);
1468 // Reorder classes so that classes precede super classes.
1472 /// buildInstructionOperandReference - The specified operand is a reference to a
1473 /// named operand such as $src. Resolve the Class and OperandInfo pointers.
1474 void AsmMatcherInfo::
1475 buildInstructionOperandReference(MatchableInfo *II,
1476 StringRef OperandName,
1477 unsigned AsmOpIdx) {
1478 const CodeGenInstruction &CGI = *II->DefRec.get<const CodeGenInstruction*>();
1479 const CGIOperandList &Operands = CGI.Operands;
1480 MatchableInfo::AsmOperand *Op = &II->AsmOperands[AsmOpIdx];
1482 // Map this token to an operand.
1484 if (!Operands.hasOperandNamed(OperandName, Idx))
1485 PrintFatalError(II->TheDef->getLoc(),
1486 "error: unable to find operand: '" + OperandName + "'");
1488 // If the instruction operand has multiple suboperands, but the parser
1489 // match class for the asm operand is still the default "ImmAsmOperand",
1490 // then handle each suboperand separately.
1491 if (Op->SubOpIdx == -1 && Operands[Idx].MINumOperands > 1) {
1492 Record *Rec = Operands[Idx].Rec;
1493 assert(Rec->isSubClassOf("Operand") && "Unexpected operand!");
1494 Record *MatchClass = Rec->getValueAsDef("ParserMatchClass");
1495 if (MatchClass && MatchClass->getValueAsString("Name") == "Imm") {
1496 // Insert remaining suboperands after AsmOpIdx in II->AsmOperands.
1497 StringRef Token = Op->Token; // save this in case Op gets moved
1498 for (unsigned SI = 1, SE = Operands[Idx].MINumOperands; SI != SE; ++SI) {
1499 MatchableInfo::AsmOperand NewAsmOp(Token);
1500 NewAsmOp.SubOpIdx = SI;
1501 II->AsmOperands.insert(II->AsmOperands.begin()+AsmOpIdx+SI, NewAsmOp);
1503 // Replace Op with first suboperand.
1504 Op = &II->AsmOperands[AsmOpIdx]; // update the pointer in case it moved
1509 // Set up the operand class.
1510 Op->Class = getOperandClass(Operands[Idx], Op->SubOpIdx);
1512 // If the named operand is tied, canonicalize it to the untied operand.
1513 // For example, something like:
1514 // (outs GPR:$dst), (ins GPR:$src)
1515 // with an asmstring of
1517 // we want to canonicalize to:
1519 // so that we know how to provide the $dst operand when filling in the result.
1521 if (Operands[Idx].MINumOperands == 1)
1522 OITied = Operands[Idx].getTiedRegister();
1524 // The tied operand index is an MIOperand index, find the operand that
1526 std::pair<unsigned, unsigned> Idx = Operands.getSubOperandNumber(OITied);
1527 OperandName = Operands[Idx.first].Name;
1528 Op->SubOpIdx = Idx.second;
1531 Op->SrcOpName = OperandName;
1534 /// buildAliasOperandReference - When parsing an operand reference out of the
1535 /// matching string (e.g. "movsx $src, $dst"), determine what the class of the
1536 /// operand reference is by looking it up in the result pattern definition.
1537 void AsmMatcherInfo::buildAliasOperandReference(MatchableInfo *II,
1538 StringRef OperandName,
1539 MatchableInfo::AsmOperand &Op) {
1540 const CodeGenInstAlias &CGA = *II->DefRec.get<const CodeGenInstAlias*>();
1542 // Set up the operand class.
1543 for (unsigned i = 0, e = CGA.ResultOperands.size(); i != e; ++i)
1544 if (CGA.ResultOperands[i].isRecord() &&
1545 CGA.ResultOperands[i].getName() == OperandName) {
1546 // It's safe to go with the first one we find, because CodeGenInstAlias
1547 // validates that all operands with the same name have the same record.
1548 Op.SubOpIdx = CGA.ResultInstOperandIndex[i].second;
1549 // Use the match class from the Alias definition, not the
1550 // destination instruction, as we may have an immediate that's
1551 // being munged by the match class.
1552 Op.Class = getOperandClass(CGA.ResultOperands[i].getRecord(),
1554 Op.SrcOpName = OperandName;
1558 PrintFatalError(II->TheDef->getLoc(),
1559 "error: unable to find operand: '" + OperandName + "'");
1562 void MatchableInfo::buildInstructionResultOperands() {
1563 const CodeGenInstruction *ResultInst = getResultInst();
1565 // Loop over all operands of the result instruction, determining how to
1567 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
1568 const CGIOperandList::OperandInfo &OpInfo = ResultInst->Operands[i];
1570 // If this is a tied operand, just copy from the previously handled operand.
1572 if (OpInfo.MINumOperands == 1)
1573 TiedOp = OpInfo.getTiedRegister();
1575 ResOperands.push_back(ResOperand::getTiedOp(TiedOp));
1579 // Find out what operand from the asmparser this MCInst operand comes from.
1580 int SrcOperand = findAsmOperandNamed(OpInfo.Name);
1581 if (OpInfo.Name.empty() || SrcOperand == -1) {
1582 // This may happen for operands that are tied to a suboperand of a
1583 // complex operand. Simply use a dummy value here; nobody should
1584 // use this operand slot.
1585 // FIXME: The long term goal is for the MCOperand list to not contain
1586 // tied operands at all.
1587 ResOperands.push_back(ResOperand::getImmOp(0));
1591 // Check if the one AsmOperand populates the entire operand.
1592 unsigned NumOperands = OpInfo.MINumOperands;
1593 if (AsmOperands[SrcOperand].SubOpIdx == -1) {
1594 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, NumOperands));
1598 // Add a separate ResOperand for each suboperand.
1599 for (unsigned AI = 0; AI < NumOperands; ++AI) {
1600 assert(AsmOperands[SrcOperand+AI].SubOpIdx == (int)AI &&
1601 AsmOperands[SrcOperand+AI].SrcOpName == OpInfo.Name &&
1602 "unexpected AsmOperands for suboperands");
1603 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand + AI, 1));
1608 void MatchableInfo::buildAliasResultOperands() {
1609 const CodeGenInstAlias &CGA = *DefRec.get<const CodeGenInstAlias*>();
1610 const CodeGenInstruction *ResultInst = getResultInst();
1612 // Loop over all operands of the result instruction, determining how to
1614 unsigned AliasOpNo = 0;
1615 unsigned LastOpNo = CGA.ResultInstOperandIndex.size();
1616 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
1617 const CGIOperandList::OperandInfo *OpInfo = &ResultInst->Operands[i];
1619 // If this is a tied operand, just copy from the previously handled operand.
1621 if (OpInfo->MINumOperands == 1)
1622 TiedOp = OpInfo->getTiedRegister();
1624 ResOperands.push_back(ResOperand::getTiedOp(TiedOp));
1628 // Handle all the suboperands for this operand.
1629 const std::string &OpName = OpInfo->Name;
1630 for ( ; AliasOpNo < LastOpNo &&
1631 CGA.ResultInstOperandIndex[AliasOpNo].first == i; ++AliasOpNo) {
1632 int SubIdx = CGA.ResultInstOperandIndex[AliasOpNo].second;
1634 // Find out what operand from the asmparser that this MCInst operand
1636 switch (CGA.ResultOperands[AliasOpNo].Kind) {
1637 case CodeGenInstAlias::ResultOperand::K_Record: {
1638 StringRef Name = CGA.ResultOperands[AliasOpNo].getName();
1639 int SrcOperand = findAsmOperand(Name, SubIdx);
1640 if (SrcOperand == -1)
1641 PrintFatalError(TheDef->getLoc(), "Instruction '" +
1642 TheDef->getName() + "' has operand '" + OpName +
1643 "' that doesn't appear in asm string!");
1644 unsigned NumOperands = (SubIdx == -1 ? OpInfo->MINumOperands : 1);
1645 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand,
1649 case CodeGenInstAlias::ResultOperand::K_Imm: {
1650 int64_t ImmVal = CGA.ResultOperands[AliasOpNo].getImm();
1651 ResOperands.push_back(ResOperand::getImmOp(ImmVal));
1654 case CodeGenInstAlias::ResultOperand::K_Reg: {
1655 Record *Reg = CGA.ResultOperands[AliasOpNo].getRegister();
1656 ResOperands.push_back(ResOperand::getRegOp(Reg));
1664 static unsigned getConverterOperandID(const std::string &Name,
1665 SetVector<std::string> &Table,
1667 IsNew = Table.insert(Name);
1669 unsigned ID = IsNew ? Table.size() - 1 :
1670 std::find(Table.begin(), Table.end(), Name) - Table.begin();
1672 assert(ID < Table.size());
1678 static void emitConvertFuncs(CodeGenTarget &Target, StringRef ClassName,
1679 std::vector<std::unique_ptr<MatchableInfo>> &Infos,
1681 SetVector<std::string> OperandConversionKinds;
1682 SetVector<std::string> InstructionConversionKinds;
1683 std::vector<std::vector<uint8_t> > ConversionTable;
1684 size_t MaxRowLength = 2; // minimum is custom converter plus terminator.
1686 // TargetOperandClass - This is the target's operand class, like X86Operand.
1687 std::string TargetOperandClass = Target.getName() + "Operand";
1689 // Write the convert function to a separate stream, so we can drop it after
1690 // the enum. We'll build up the conversion handlers for the individual
1691 // operand types opportunistically as we encounter them.
1692 std::string ConvertFnBody;
1693 raw_string_ostream CvtOS(ConvertFnBody);
1694 // Start the unified conversion function.
1695 CvtOS << "void " << Target.getName() << ClassName << "::\n"
1696 << "convertToMCInst(unsigned Kind, MCInst &Inst, "
1697 << "unsigned Opcode,\n"
1698 << " const OperandVector"
1699 << " &Operands) {\n"
1700 << " assert(Kind < CVT_NUM_SIGNATURES && \"Invalid signature!\");\n"
1701 << " const uint8_t *Converter = ConversionTable[Kind];\n"
1702 << " Inst.setOpcode(Opcode);\n"
1703 << " for (const uint8_t *p = Converter; *p; p+= 2) {\n"
1704 << " switch (*p) {\n"
1705 << " default: llvm_unreachable(\"invalid conversion entry!\");\n"
1706 << " case CVT_Reg:\n"
1707 << " static_cast<" << TargetOperandClass
1708 << "&>(*Operands[*(p + 1)]).addRegOperands(Inst, 1);\n"
1710 << " case CVT_Tied:\n"
1711 << " Inst.addOperand(Inst.getOperand(*(p + 1)));\n"
1714 std::string OperandFnBody;
1715 raw_string_ostream OpOS(OperandFnBody);
1716 // Start the operand number lookup function.
1717 OpOS << "void " << Target.getName() << ClassName << "::\n"
1718 << "convertToMapAndConstraints(unsigned Kind,\n";
1720 OpOS << "const OperandVector &Operands) {\n"
1721 << " assert(Kind < CVT_NUM_SIGNATURES && \"Invalid signature!\");\n"
1722 << " unsigned NumMCOperands = 0;\n"
1723 << " const uint8_t *Converter = ConversionTable[Kind];\n"
1724 << " for (const uint8_t *p = Converter; *p; p+= 2) {\n"
1725 << " switch (*p) {\n"
1726 << " default: llvm_unreachable(\"invalid conversion entry!\");\n"
1727 << " case CVT_Reg:\n"
1728 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n"
1729 << " Operands[*(p + 1)]->setConstraint(\"r\");\n"
1730 << " ++NumMCOperands;\n"
1732 << " case CVT_Tied:\n"
1733 << " ++NumMCOperands;\n"
1736 // Pre-populate the operand conversion kinds with the standard always
1737 // available entries.
1738 OperandConversionKinds.insert("CVT_Done");
1739 OperandConversionKinds.insert("CVT_Reg");
1740 OperandConversionKinds.insert("CVT_Tied");
1741 enum { CVT_Done, CVT_Reg, CVT_Tied };
1743 for (auto &II : Infos) {
1744 // Check if we have a custom match function.
1745 std::string AsmMatchConverter =
1746 II->getResultInst()->TheDef->getValueAsString("AsmMatchConverter");
1747 if (!AsmMatchConverter.empty()) {
1748 std::string Signature = "ConvertCustom_" + AsmMatchConverter;
1749 II->ConversionFnKind = Signature;
1751 // Check if we have already generated this signature.
1752 if (!InstructionConversionKinds.insert(Signature))
1755 // Remember this converter for the kind enum.
1756 unsigned KindID = OperandConversionKinds.size();
1757 OperandConversionKinds.insert("CVT_" +
1758 getEnumNameForToken(AsmMatchConverter));
1760 // Add the converter row for this instruction.
1761 ConversionTable.push_back(std::vector<uint8_t>());
1762 ConversionTable.back().push_back(KindID);
1763 ConversionTable.back().push_back(CVT_Done);
1765 // Add the handler to the conversion driver function.
1766 CvtOS << " case CVT_"
1767 << getEnumNameForToken(AsmMatchConverter) << ":\n"
1768 << " " << AsmMatchConverter << "(Inst, Operands);\n"
1771 // FIXME: Handle the operand number lookup for custom match functions.
1775 // Build the conversion function signature.
1776 std::string Signature = "Convert";
1778 std::vector<uint8_t> ConversionRow;
1780 // Compute the convert enum and the case body.
1781 MaxRowLength = std::max(MaxRowLength, II->ResOperands.size()*2 + 1 );
1783 for (unsigned i = 0, e = II->ResOperands.size(); i != e; ++i) {
1784 const MatchableInfo::ResOperand &OpInfo = II->ResOperands[i];
1786 // Generate code to populate each result operand.
1787 switch (OpInfo.Kind) {
1788 case MatchableInfo::ResOperand::RenderAsmOperand: {
1789 // This comes from something we parsed.
1790 const MatchableInfo::AsmOperand &Op =
1791 II->AsmOperands[OpInfo.AsmOperandNum];
1793 // Registers are always converted the same, don't duplicate the
1794 // conversion function based on them.
1797 Class = Op.Class->isRegisterClass() ? "Reg" : Op.Class->ClassName;
1799 Signature += utostr(OpInfo.MINumOperands);
1800 Signature += "_" + itostr(OpInfo.AsmOperandNum);
1802 // Add the conversion kind, if necessary, and get the associated ID
1803 // the index of its entry in the vector).
1804 std::string Name = "CVT_" + (Op.Class->isRegisterClass() ? "Reg" :
1805 Op.Class->RenderMethod);
1806 Name = getEnumNameForToken(Name);
1808 bool IsNewConverter = false;
1809 unsigned ID = getConverterOperandID(Name, OperandConversionKinds,
1812 // Add the operand entry to the instruction kind conversion row.
1813 ConversionRow.push_back(ID);
1814 ConversionRow.push_back(OpInfo.AsmOperandNum + 1);
1816 if (!IsNewConverter)
1819 // This is a new operand kind. Add a handler for it to the
1820 // converter driver.
1821 CvtOS << " case " << Name << ":\n"
1822 << " static_cast<" << TargetOperandClass
1823 << "&>(*Operands[*(p + 1)])." << Op.Class->RenderMethod
1824 << "(Inst, " << OpInfo.MINumOperands << ");\n"
1827 // Add a handler for the operand number lookup.
1828 OpOS << " case " << Name << ":\n"
1829 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n";
1831 if (Op.Class->isRegisterClass())
1832 OpOS << " Operands[*(p + 1)]->setConstraint(\"r\");\n";
1834 OpOS << " Operands[*(p + 1)]->setConstraint(\"m\");\n";
1835 OpOS << " NumMCOperands += " << OpInfo.MINumOperands << ";\n"
1839 case MatchableInfo::ResOperand::TiedOperand: {
1840 // If this operand is tied to a previous one, just copy the MCInst
1841 // operand from the earlier one.We can only tie single MCOperand values.
1842 assert(OpInfo.MINumOperands == 1 && "Not a singular MCOperand");
1843 unsigned TiedOp = OpInfo.TiedOperandNum;
1844 assert(i > TiedOp && "Tied operand precedes its target!");
1845 Signature += "__Tie" + utostr(TiedOp);
1846 ConversionRow.push_back(CVT_Tied);
1847 ConversionRow.push_back(TiedOp);
1850 case MatchableInfo::ResOperand::ImmOperand: {
1851 int64_t Val = OpInfo.ImmVal;
1852 std::string Ty = "imm_" + itostr(Val);
1853 Ty = getEnumNameForToken(Ty);
1854 Signature += "__" + Ty;
1856 std::string Name = "CVT_" + Ty;
1857 bool IsNewConverter = false;
1858 unsigned ID = getConverterOperandID(Name, OperandConversionKinds,
1860 // Add the operand entry to the instruction kind conversion row.
1861 ConversionRow.push_back(ID);
1862 ConversionRow.push_back(0);
1864 if (!IsNewConverter)
1867 CvtOS << " case " << Name << ":\n"
1868 << " Inst.addOperand(MCOperand::CreateImm(" << Val << "));\n"
1871 OpOS << " case " << Name << ":\n"
1872 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n"
1873 << " Operands[*(p + 1)]->setConstraint(\"\");\n"
1874 << " ++NumMCOperands;\n"
1878 case MatchableInfo::ResOperand::RegOperand: {
1879 std::string Reg, Name;
1880 if (!OpInfo.Register) {
1884 Reg = getQualifiedName(OpInfo.Register);
1885 Name = "reg" + OpInfo.Register->getName();
1887 Signature += "__" + Name;
1888 Name = "CVT_" + Name;
1889 bool IsNewConverter = false;
1890 unsigned ID = getConverterOperandID(Name, OperandConversionKinds,
1892 // Add the operand entry to the instruction kind conversion row.
1893 ConversionRow.push_back(ID);
1894 ConversionRow.push_back(0);
1896 if (!IsNewConverter)
1898 CvtOS << " case " << Name << ":\n"
1899 << " Inst.addOperand(MCOperand::CreateReg(" << Reg << "));\n"
1902 OpOS << " case " << Name << ":\n"
1903 << " Operands[*(p + 1)]->setMCOperandNum(NumMCOperands);\n"
1904 << " Operands[*(p + 1)]->setConstraint(\"m\");\n"
1905 << " ++NumMCOperands;\n"
1911 // If there were no operands, add to the signature to that effect
1912 if (Signature == "Convert")
1913 Signature += "_NoOperands";
1915 II->ConversionFnKind = Signature;
1917 // Save the signature. If we already have it, don't add a new row
1919 if (!InstructionConversionKinds.insert(Signature))
1922 // Add the row to the table.
1923 ConversionTable.push_back(ConversionRow);
1926 // Finish up the converter driver function.
1927 CvtOS << " }\n }\n}\n\n";
1929 // Finish up the operand number lookup function.
1930 OpOS << " }\n }\n}\n\n";
1932 OS << "namespace {\n";
1934 // Output the operand conversion kind enum.
1935 OS << "enum OperatorConversionKind {\n";
1936 for (unsigned i = 0, e = OperandConversionKinds.size(); i != e; ++i)
1937 OS << " " << OperandConversionKinds[i] << ",\n";
1938 OS << " CVT_NUM_CONVERTERS\n";
1941 // Output the instruction conversion kind enum.
1942 OS << "enum InstructionConversionKind {\n";
1943 for (SetVector<std::string>::const_iterator
1944 i = InstructionConversionKinds.begin(),
1945 e = InstructionConversionKinds.end(); i != e; ++i)
1946 OS << " " << *i << ",\n";
1947 OS << " CVT_NUM_SIGNATURES\n";
1951 OS << "} // end anonymous namespace\n\n";
1953 // Output the conversion table.
1954 OS << "static const uint8_t ConversionTable[CVT_NUM_SIGNATURES]["
1955 << MaxRowLength << "] = {\n";
1957 for (unsigned Row = 0, ERow = ConversionTable.size(); Row != ERow; ++Row) {
1958 assert(ConversionTable[Row].size() % 2 == 0 && "bad conversion row!");
1959 OS << " // " << InstructionConversionKinds[Row] << "\n";
1961 for (unsigned i = 0, e = ConversionTable[Row].size(); i != e; i += 2)
1962 OS << OperandConversionKinds[ConversionTable[Row][i]] << ", "
1963 << (unsigned)(ConversionTable[Row][i + 1]) << ", ";
1964 OS << "CVT_Done },\n";
1969 // Spit out the conversion driver function.
1972 // Spit out the operand number lookup function.
1976 /// emitMatchClassEnumeration - Emit the enumeration for match class kinds.
1977 static void emitMatchClassEnumeration(CodeGenTarget &Target,
1978 std::forward_list<ClassInfo> &Infos,
1980 OS << "namespace {\n\n";
1982 OS << "/// MatchClassKind - The kinds of classes which participate in\n"
1983 << "/// instruction matching.\n";
1984 OS << "enum MatchClassKind {\n";
1985 OS << " InvalidMatchClass = 0,\n";
1986 for (const auto &CI : Infos) {
1987 OS << " " << CI.Name << ", // ";
1988 if (CI.Kind == ClassInfo::Token) {
1989 OS << "'" << CI.ValueName << "'\n";
1990 } else if (CI.isRegisterClass()) {
1991 if (!CI.ValueName.empty())
1992 OS << "register class '" << CI.ValueName << "'\n";
1994 OS << "derived register class\n";
1996 OS << "user defined class '" << CI.ValueName << "'\n";
1999 OS << " NumMatchClassKinds\n";
2005 /// emitValidateOperandClass - Emit the function to validate an operand class.
2006 static void emitValidateOperandClass(AsmMatcherInfo &Info,
2008 OS << "static unsigned validateOperandClass(MCParsedAsmOperand &GOp, "
2009 << "MatchClassKind Kind) {\n";
2010 OS << " " << Info.Target.getName() << "Operand &Operand = ("
2011 << Info.Target.getName() << "Operand&)GOp;\n";
2013 // The InvalidMatchClass is not to match any operand.
2014 OS << " if (Kind == InvalidMatchClass)\n";
2015 OS << " return MCTargetAsmParser::Match_InvalidOperand;\n\n";
2017 // Check for Token operands first.
2018 // FIXME: Use a more specific diagnostic type.
2019 OS << " if (Operand.isToken())\n";
2020 OS << " return isSubclass(matchTokenString(Operand.getToken()), Kind) ?\n"
2021 << " MCTargetAsmParser::Match_Success :\n"
2022 << " MCTargetAsmParser::Match_InvalidOperand;\n\n";
2024 // Check the user classes. We don't care what order since we're only
2025 // actually matching against one of them.
2026 for (const auto &CI : Info.Classes) {
2027 if (!CI.isUserClass())
2030 OS << " // '" << CI.ClassName << "' class\n";
2031 OS << " if (Kind == " << CI.Name << ") {\n";
2032 OS << " if (Operand." << CI.PredicateMethod << "())\n";
2033 OS << " return MCTargetAsmParser::Match_Success;\n";
2034 if (!CI.DiagnosticType.empty())
2035 OS << " return " << Info.Target.getName() << "AsmParser::Match_"
2036 << CI.DiagnosticType << ";\n";
2040 // Check for register operands, including sub-classes.
2041 OS << " if (Operand.isReg()) {\n";
2042 OS << " MatchClassKind OpKind;\n";
2043 OS << " switch (Operand.getReg()) {\n";
2044 OS << " default: OpKind = InvalidMatchClass; break;\n";
2045 for (const auto &RC : Info.RegisterClasses)
2046 OS << " case " << Info.Target.getName() << "::"
2047 << RC.first->getName() << ": OpKind = " << RC.second->Name
2050 OS << " return isSubclass(OpKind, Kind) ? "
2051 << "MCTargetAsmParser::Match_Success :\n "
2052 << " MCTargetAsmParser::Match_InvalidOperand;\n }\n\n";
2054 // Generic fallthrough match failure case for operands that don't have
2055 // specialized diagnostic types.
2056 OS << " return MCTargetAsmParser::Match_InvalidOperand;\n";
2060 /// emitIsSubclass - Emit the subclass predicate function.
2061 static void emitIsSubclass(CodeGenTarget &Target,
2062 std::forward_list<ClassInfo> &Infos,
2064 OS << "/// isSubclass - Compute whether \\p A is a subclass of \\p B.\n";
2065 OS << "static bool isSubclass(MatchClassKind A, MatchClassKind B) {\n";
2066 OS << " if (A == B)\n";
2067 OS << " return true;\n\n";
2070 raw_string_ostream SS(OStr);
2072 SS << " switch (A) {\n";
2073 SS << " default:\n";
2074 SS << " return false;\n";
2075 for (const auto &A : Infos) {
2076 std::vector<StringRef> SuperClasses;
2077 for (const auto &B : Infos) {
2078 if (&A != &B && A.isSubsetOf(B))
2079 SuperClasses.push_back(B.Name);
2082 if (SuperClasses.empty())
2086 SS << "\n case " << A.Name << ":\n";
2088 if (SuperClasses.size() == 1) {
2089 SS << " return B == " << SuperClasses.back().str() << ";\n";
2093 if (!SuperClasses.empty()) {
2094 SS << " switch (B) {\n";
2095 SS << " default: return false;\n";
2096 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
2097 SS << " case " << SuperClasses[i].str() << ": return true;\n";
2100 // No case statement to emit
2101 SS << " return false;\n";
2106 // If there were case statements emitted into the string stream, write them
2107 // to the output stream, otherwise write the default.
2111 OS << " return false;\n";
2116 /// emitMatchTokenString - Emit the function to match a token string to the
2117 /// appropriate match class value.
2118 static void emitMatchTokenString(CodeGenTarget &Target,
2119 std::forward_list<ClassInfo> &Infos,
2121 // Construct the match list.
2122 std::vector<StringMatcher::StringPair> Matches;
2123 for (const auto &CI : Infos) {
2124 if (CI.Kind == ClassInfo::Token)
2126 StringMatcher::StringPair(CI.ValueName, "return " + CI.Name + ";"));
2129 OS << "static MatchClassKind matchTokenString(StringRef Name) {\n";
2131 StringMatcher("Name", Matches, OS).Emit();
2133 OS << " return InvalidMatchClass;\n";
2137 /// emitMatchRegisterName - Emit the function to match a string to the target
2138 /// specific register enum.
2139 static void emitMatchRegisterName(CodeGenTarget &Target, Record *AsmParser,
2141 // Construct the match list.
2142 std::vector<StringMatcher::StringPair> Matches;
2143 const auto &Regs = Target.getRegBank().getRegisters();
2144 for (const CodeGenRegister &Reg : Regs) {
2145 if (Reg.TheDef->getValueAsString("AsmName").empty())
2149 StringMatcher::StringPair(Reg.TheDef->getValueAsString("AsmName"),
2150 "return " + utostr(Reg.EnumValue) + ";"));
2153 OS << "static unsigned MatchRegisterName(StringRef Name) {\n";
2155 StringMatcher("Name", Matches, OS).Emit();
2157 OS << " return 0;\n";
2161 static const char *getMinimalTypeForRange(uint64_t Range) {
2162 assert(Range <= 0xFFFFFFFFFFFFFFFFULL && "Enum too large");
2163 if (Range > 0xFFFFFFFFULL)
2172 static const char *getMinimalRequiredFeaturesType(const AsmMatcherInfo &Info) {
2173 uint64_t MaxIndex = Info.SubtargetFeatures.size();
2176 return getMinimalTypeForRange(1ULL << MaxIndex);
2179 /// emitSubtargetFeatureFlagEnumeration - Emit the subtarget feature flag
2181 static void emitSubtargetFeatureFlagEnumeration(AsmMatcherInfo &Info,
2183 OS << "// Flags for subtarget features that participate in "
2184 << "instruction matching.\n";
2185 OS << "enum SubtargetFeatureFlag : " << getMinimalRequiredFeaturesType(Info)
2187 for (const auto &SF : Info.SubtargetFeatures) {
2188 const SubtargetFeatureInfo &SFI = SF.second;
2189 OS << " " << SFI.getEnumName() << " = (1ULL << " << SFI.Index << "),\n";
2191 OS << " Feature_None = 0\n";
2195 /// emitOperandDiagnosticTypes - Emit the operand matching diagnostic types.
2196 static void emitOperandDiagnosticTypes(AsmMatcherInfo &Info, raw_ostream &OS) {
2197 // Get the set of diagnostic types from all of the operand classes.
2198 std::set<StringRef> Types;
2199 for (std::map<Record*, ClassInfo*>::const_iterator
2200 I = Info.AsmOperandClasses.begin(),
2201 E = Info.AsmOperandClasses.end(); I != E; ++I) {
2202 if (!I->second->DiagnosticType.empty())
2203 Types.insert(I->second->DiagnosticType);
2206 if (Types.empty()) return;
2208 // Now emit the enum entries.
2209 for (std::set<StringRef>::const_iterator I = Types.begin(), E = Types.end();
2211 OS << " Match_" << *I << ",\n";
2212 OS << " END_OPERAND_DIAGNOSTIC_TYPES\n";
2215 /// emitGetSubtargetFeatureName - Emit the helper function to get the
2216 /// user-level name for a subtarget feature.
2217 static void emitGetSubtargetFeatureName(AsmMatcherInfo &Info, raw_ostream &OS) {
2218 OS << "// User-level names for subtarget features that participate in\n"
2219 << "// instruction matching.\n"
2220 << "static const char *getSubtargetFeatureName(uint64_t Val) {\n";
2221 if (!Info.SubtargetFeatures.empty()) {
2222 OS << " switch(Val) {\n";
2223 for (const auto &SF : Info.SubtargetFeatures) {
2224 const SubtargetFeatureInfo &SFI = SF.second;
2225 // FIXME: Totally just a placeholder name to get the algorithm working.
2226 OS << " case " << SFI.getEnumName() << ": return \""
2227 << SFI.TheDef->getValueAsString("PredicateName") << "\";\n";
2229 OS << " default: return \"(unknown)\";\n";
2232 // Nothing to emit, so skip the switch
2233 OS << " return \"(unknown)\";\n";
2238 /// emitComputeAvailableFeatures - Emit the function to compute the list of
2239 /// available features given a subtarget.
2240 static void emitComputeAvailableFeatures(AsmMatcherInfo &Info,
2242 std::string ClassName =
2243 Info.AsmParser->getValueAsString("AsmParserClassName");
2245 OS << "uint64_t " << Info.Target.getName() << ClassName << "::\n"
2246 << "ComputeAvailableFeatures(uint64_t FB) const {\n";
2247 OS << " uint64_t Features = 0;\n";
2248 for (const auto &SF : Info.SubtargetFeatures) {
2249 const SubtargetFeatureInfo &SFI = SF.second;
2252 std::string CondStorage =
2253 SFI.TheDef->getValueAsString("AssemblerCondString");
2254 StringRef Conds = CondStorage;
2255 std::pair<StringRef,StringRef> Comma = Conds.split(',');
2262 StringRef Cond = Comma.first;
2263 if (Cond[0] == '!') {
2265 Cond = Cond.substr(1);
2268 OS << "((FB & " << Info.Target.getName() << "::" << Cond << ")";
2275 if (Comma.second.empty())
2279 Comma = Comma.second.split(',');
2283 OS << " Features |= " << SFI.getEnumName() << ";\n";
2285 OS << " return Features;\n";
2289 static std::string GetAliasRequiredFeatures(Record *R,
2290 const AsmMatcherInfo &Info) {
2291 std::vector<Record*> ReqFeatures = R->getValueAsListOfDefs("Predicates");
2293 unsigned NumFeatures = 0;
2294 for (unsigned i = 0, e = ReqFeatures.size(); i != e; ++i) {
2295 const SubtargetFeatureInfo *F = Info.getSubtargetFeature(ReqFeatures[i]);
2298 PrintFatalError(R->getLoc(), "Predicate '" + ReqFeatures[i]->getName() +
2299 "' is not marked as an AssemblerPredicate!");
2304 Result += F->getEnumName();
2308 if (NumFeatures > 1)
2309 Result = '(' + Result + ')';
2313 static void emitMnemonicAliasVariant(raw_ostream &OS,const AsmMatcherInfo &Info,
2314 std::vector<Record*> &Aliases,
2315 unsigned Indent = 0,
2316 StringRef AsmParserVariantName = StringRef()){
2317 // Keep track of all the aliases from a mnemonic. Use an std::map so that the
2318 // iteration order of the map is stable.
2319 std::map<std::string, std::vector<Record*> > AliasesFromMnemonic;
2321 for (unsigned i = 0, e = Aliases.size(); i != e; ++i) {
2322 Record *R = Aliases[i];
2323 // FIXME: Allow AssemblerVariantName to be a comma separated list.
2324 std::string AsmVariantName = R->getValueAsString("AsmVariantName");
2325 if (AsmVariantName != AsmParserVariantName)
2327 AliasesFromMnemonic[R->getValueAsString("FromMnemonic")].push_back(R);
2329 if (AliasesFromMnemonic.empty())
2332 // Process each alias a "from" mnemonic at a time, building the code executed
2333 // by the string remapper.
2334 std::vector<StringMatcher::StringPair> Cases;
2335 for (std::map<std::string, std::vector<Record*> >::iterator
2336 I = AliasesFromMnemonic.begin(), E = AliasesFromMnemonic.end();
2338 const std::vector<Record*> &ToVec = I->second;
2340 // Loop through each alias and emit code that handles each case. If there
2341 // are two instructions without predicates, emit an error. If there is one,
2343 std::string MatchCode;
2344 int AliasWithNoPredicate = -1;
2346 for (unsigned i = 0, e = ToVec.size(); i != e; ++i) {
2347 Record *R = ToVec[i];
2348 std::string FeatureMask = GetAliasRequiredFeatures(R, Info);
2350 // If this unconditionally matches, remember it for later and diagnose
2352 if (FeatureMask.empty()) {
2353 if (AliasWithNoPredicate != -1) {
2354 // We can't have two aliases from the same mnemonic with no predicate.
2355 PrintError(ToVec[AliasWithNoPredicate]->getLoc(),
2356 "two MnemonicAliases with the same 'from' mnemonic!");
2357 PrintFatalError(R->getLoc(), "this is the other MnemonicAlias.");
2360 AliasWithNoPredicate = i;
2363 if (R->getValueAsString("ToMnemonic") == I->first)
2364 PrintFatalError(R->getLoc(), "MnemonicAlias to the same string");
2366 if (!MatchCode.empty())
2367 MatchCode += "else ";
2368 MatchCode += "if ((Features & " + FeatureMask + ") == "+FeatureMask+")\n";
2369 MatchCode += " Mnemonic = \"" +R->getValueAsString("ToMnemonic")+"\";\n";
2372 if (AliasWithNoPredicate != -1) {
2373 Record *R = ToVec[AliasWithNoPredicate];
2374 if (!MatchCode.empty())
2375 MatchCode += "else\n ";
2376 MatchCode += "Mnemonic = \"" + R->getValueAsString("ToMnemonic")+"\";\n";
2379 MatchCode += "return;";
2381 Cases.push_back(std::make_pair(I->first, MatchCode));
2383 StringMatcher("Mnemonic", Cases, OS).Emit(Indent);
2386 /// emitMnemonicAliases - If the target has any MnemonicAlias<> definitions,
2387 /// emit a function for them and return true, otherwise return false.
2388 static bool emitMnemonicAliases(raw_ostream &OS, const AsmMatcherInfo &Info,
2389 CodeGenTarget &Target) {
2390 // Ignore aliases when match-prefix is set.
2391 if (!MatchPrefix.empty())
2394 std::vector<Record*> Aliases =
2395 Info.getRecords().getAllDerivedDefinitions("MnemonicAlias");
2396 if (Aliases.empty()) return false;
2398 OS << "static void applyMnemonicAliases(StringRef &Mnemonic, "
2399 "uint64_t Features, unsigned VariantID) {\n";
2400 OS << " switch (VariantID) {\n";
2401 unsigned VariantCount = Target.getAsmParserVariantCount();
2402 for (unsigned VC = 0; VC != VariantCount; ++VC) {
2403 Record *AsmVariant = Target.getAsmParserVariant(VC);
2404 int AsmParserVariantNo = AsmVariant->getValueAsInt("Variant");
2405 std::string AsmParserVariantName = AsmVariant->getValueAsString("Name");
2406 OS << " case " << AsmParserVariantNo << ":\n";
2407 emitMnemonicAliasVariant(OS, Info, Aliases, /*Indent=*/2,
2408 AsmParserVariantName);
2413 // Emit aliases that apply to all variants.
2414 emitMnemonicAliasVariant(OS, Info, Aliases);
2421 static void emitCustomOperandParsing(raw_ostream &OS, CodeGenTarget &Target,
2422 const AsmMatcherInfo &Info, StringRef ClassName,
2423 StringToOffsetTable &StringTable,
2424 unsigned MaxMnemonicIndex) {
2425 unsigned MaxMask = 0;
2426 for (std::vector<OperandMatchEntry>::const_iterator it =
2427 Info.OperandMatchInfo.begin(), ie = Info.OperandMatchInfo.end();
2429 MaxMask |= it->OperandMask;
2432 // Emit the static custom operand parsing table;
2433 OS << "namespace {\n";
2434 OS << " struct OperandMatchEntry {\n";
2435 OS << " " << getMinimalRequiredFeaturesType(Info)
2436 << " RequiredFeatures;\n";
2437 OS << " " << getMinimalTypeForRange(MaxMnemonicIndex)
2439 OS << " " << getMinimalTypeForRange(std::distance(
2440 Info.Classes.begin(), Info.Classes.end())) << " Class;\n";
2441 OS << " " << getMinimalTypeForRange(MaxMask)
2442 << " OperandMask;\n\n";
2443 OS << " StringRef getMnemonic() const {\n";
2444 OS << " return StringRef(MnemonicTable + Mnemonic + 1,\n";
2445 OS << " MnemonicTable[Mnemonic]);\n";
2449 OS << " // Predicate for searching for an opcode.\n";
2450 OS << " struct LessOpcodeOperand {\n";
2451 OS << " bool operator()(const OperandMatchEntry &LHS, StringRef RHS) {\n";
2452 OS << " return LHS.getMnemonic() < RHS;\n";
2454 OS << " bool operator()(StringRef LHS, const OperandMatchEntry &RHS) {\n";
2455 OS << " return LHS < RHS.getMnemonic();\n";
2457 OS << " bool operator()(const OperandMatchEntry &LHS,";
2458 OS << " const OperandMatchEntry &RHS) {\n";
2459 OS << " return LHS.getMnemonic() < RHS.getMnemonic();\n";
2463 OS << "} // end anonymous namespace.\n\n";
2465 OS << "static const OperandMatchEntry OperandMatchTable["
2466 << Info.OperandMatchInfo.size() << "] = {\n";
2468 OS << " /* Operand List Mask, Mnemonic, Operand Class, Features */\n";
2469 for (std::vector<OperandMatchEntry>::const_iterator it =
2470 Info.OperandMatchInfo.begin(), ie = Info.OperandMatchInfo.end();
2472 const OperandMatchEntry &OMI = *it;
2473 const MatchableInfo &II = *OMI.MI;
2477 // Write the required features mask.
2478 if (!II.RequiredFeatures.empty()) {
2479 for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) {
2481 OS << II.RequiredFeatures[i]->getEnumName();
2486 // Store a pascal-style length byte in the mnemonic.
2487 std::string LenMnemonic = char(II.Mnemonic.size()) + II.Mnemonic.str();
2488 OS << ", " << StringTable.GetOrAddStringOffset(LenMnemonic, false)
2489 << " /* " << II.Mnemonic << " */, ";
2493 OS << ", " << OMI.OperandMask;
2495 bool printComma = false;
2496 for (int i = 0, e = 31; i !=e; ++i)
2497 if (OMI.OperandMask & (1 << i)) {
2509 // Emit the operand class switch to call the correct custom parser for
2510 // the found operand class.
2511 OS << Target.getName() << ClassName << "::OperandMatchResultTy "
2512 << Target.getName() << ClassName << "::\n"
2513 << "tryCustomParseOperand(OperandVector"
2514 << " &Operands,\n unsigned MCK) {\n\n"
2515 << " switch(MCK) {\n";
2517 for (const auto &CI : Info.Classes) {
2518 if (CI.ParserMethod.empty())
2520 OS << " case " << CI.Name << ":\n"
2521 << " return " << CI.ParserMethod << "(Operands);\n";
2524 OS << " default:\n";
2525 OS << " return MatchOperand_NoMatch;\n";
2527 OS << " return MatchOperand_NoMatch;\n";
2530 // Emit the static custom operand parser. This code is very similar with
2531 // the other matcher. Also use MatchResultTy here just in case we go for
2532 // a better error handling.
2533 OS << Target.getName() << ClassName << "::OperandMatchResultTy "
2534 << Target.getName() << ClassName << "::\n"
2535 << "MatchOperandParserImpl(OperandVector"
2536 << " &Operands,\n StringRef Mnemonic) {\n";
2538 // Emit code to get the available features.
2539 OS << " // Get the current feature set.\n";
2540 OS << " uint64_t AvailableFeatures = getAvailableFeatures();\n\n";
2542 OS << " // Get the next operand index.\n";
2543 OS << " unsigned NextOpNum = Operands.size()-1;\n";
2545 // Emit code to search the table.
2546 OS << " // Search the table.\n";
2547 OS << " std::pair<const OperandMatchEntry*, const OperandMatchEntry*>";
2548 OS << " MnemonicRange =\n";
2549 OS << " std::equal_range(OperandMatchTable, OperandMatchTable+"
2550 << Info.OperandMatchInfo.size() << ", Mnemonic,\n"
2551 << " LessOpcodeOperand());\n\n";
2553 OS << " if (MnemonicRange.first == MnemonicRange.second)\n";
2554 OS << " return MatchOperand_NoMatch;\n\n";
2556 OS << " for (const OperandMatchEntry *it = MnemonicRange.first,\n"
2557 << " *ie = MnemonicRange.second; it != ie; ++it) {\n";
2559 OS << " // equal_range guarantees that instruction mnemonic matches.\n";
2560 OS << " assert(Mnemonic == it->getMnemonic());\n\n";
2562 // Emit check that the required features are available.
2563 OS << " // check if the available features match\n";
2564 OS << " if ((AvailableFeatures & it->RequiredFeatures) "
2565 << "!= it->RequiredFeatures) {\n";
2566 OS << " continue;\n";
2569 // Emit check to ensure the operand number matches.
2570 OS << " // check if the operand in question has a custom parser.\n";
2571 OS << " if (!(it->OperandMask & (1 << NextOpNum)))\n";
2572 OS << " continue;\n\n";
2574 // Emit call to the custom parser method
2575 OS << " // call custom parse method to handle the operand\n";
2576 OS << " OperandMatchResultTy Result = ";
2577 OS << "tryCustomParseOperand(Operands, it->Class);\n";
2578 OS << " if (Result != MatchOperand_NoMatch)\n";
2579 OS << " return Result;\n";
2582 OS << " // Okay, we had no match.\n";
2583 OS << " return MatchOperand_NoMatch;\n";
2587 void AsmMatcherEmitter::run(raw_ostream &OS) {
2588 CodeGenTarget Target(Records);
2589 Record *AsmParser = Target.getAsmParser();
2590 std::string ClassName = AsmParser->getValueAsString("AsmParserClassName");
2592 // Compute the information on the instructions to match.
2593 AsmMatcherInfo Info(AsmParser, Target, Records);
2596 // Sort the instruction table using the partial order on classes. We use
2597 // stable_sort to ensure that ambiguous instructions are still
2598 // deterministically ordered.
2599 std::stable_sort(Info.Matchables.begin(), Info.Matchables.end(),
2600 [](const std::unique_ptr<MatchableInfo> &a,
2601 const std::unique_ptr<MatchableInfo> &b){
2604 DEBUG_WITH_TYPE("instruction_info", {
2605 for (const auto &MI : Info.Matchables)
2609 // Check for ambiguous matchables.
2610 DEBUG_WITH_TYPE("ambiguous_instrs", {
2611 unsigned NumAmbiguous = 0;
2612 for (auto I = Info.Matchables.begin(), E = Info.Matchables.end(); I != E;
2614 for (auto J = std::next(I); J != E; ++J) {
2615 const MatchableInfo &A = **I;
2616 const MatchableInfo &B = **J;
2618 if (A.couldMatchAmbiguouslyWith(B)) {
2619 errs() << "warning: ambiguous matchables:\n";
2621 errs() << "\nis incomparable with:\n";
2629 errs() << "warning: " << NumAmbiguous
2630 << " ambiguous matchables!\n";
2633 // Compute the information on the custom operand parsing.
2634 Info.buildOperandMatchInfo();
2636 // Write the output.
2638 // Information for the class declaration.
2639 OS << "\n#ifdef GET_ASSEMBLER_HEADER\n";
2640 OS << "#undef GET_ASSEMBLER_HEADER\n";
2641 OS << " // This should be included into the middle of the declaration of\n";
2642 OS << " // your subclasses implementation of MCTargetAsmParser.\n";
2643 OS << " uint64_t ComputeAvailableFeatures(uint64_t FeatureBits) const;\n";
2644 OS << " void convertToMCInst(unsigned Kind, MCInst &Inst, "
2645 << "unsigned Opcode,\n"
2646 << " const OperandVector "
2648 OS << " void convertToMapAndConstraints(unsigned Kind,\n ";
2649 OS << " const OperandVector &Operands) override;\n";
2650 OS << " bool mnemonicIsValid(StringRef Mnemonic, unsigned VariantID) override;\n";
2651 OS << " unsigned MatchInstructionImpl(const OperandVector &Operands,\n"
2652 << " MCInst &Inst,\n"
2653 << " uint64_t &ErrorInfo,"
2654 << " bool matchingInlineAsm,\n"
2655 << " unsigned VariantID = 0);\n";
2657 if (!Info.OperandMatchInfo.empty()) {
2658 OS << "\n enum OperandMatchResultTy {\n";
2659 OS << " MatchOperand_Success, // operand matched successfully\n";
2660 OS << " MatchOperand_NoMatch, // operand did not match\n";
2661 OS << " MatchOperand_ParseFail // operand matched but had errors\n";
2663 OS << " OperandMatchResultTy MatchOperandParserImpl(\n";
2664 OS << " OperandVector &Operands,\n";
2665 OS << " StringRef Mnemonic);\n";
2667 OS << " OperandMatchResultTy tryCustomParseOperand(\n";
2668 OS << " OperandVector &Operands,\n";
2669 OS << " unsigned MCK);\n\n";
2672 OS << "#endif // GET_ASSEMBLER_HEADER_INFO\n\n";
2674 // Emit the operand match diagnostic enum names.
2675 OS << "\n#ifdef GET_OPERAND_DIAGNOSTIC_TYPES\n";
2676 OS << "#undef GET_OPERAND_DIAGNOSTIC_TYPES\n\n";
2677 emitOperandDiagnosticTypes(Info, OS);
2678 OS << "#endif // GET_OPERAND_DIAGNOSTIC_TYPES\n\n";
2681 OS << "\n#ifdef GET_REGISTER_MATCHER\n";
2682 OS << "#undef GET_REGISTER_MATCHER\n\n";
2684 // Emit the subtarget feature enumeration.
2685 emitSubtargetFeatureFlagEnumeration(Info, OS);
2687 // Emit the function to match a register name to number.
2688 // This should be omitted for Mips target
2689 if (AsmParser->getValueAsBit("ShouldEmitMatchRegisterName"))
2690 emitMatchRegisterName(Target, AsmParser, OS);
2692 OS << "#endif // GET_REGISTER_MATCHER\n\n";
2694 OS << "\n#ifdef GET_SUBTARGET_FEATURE_NAME\n";
2695 OS << "#undef GET_SUBTARGET_FEATURE_NAME\n\n";
2697 // Generate the helper function to get the names for subtarget features.
2698 emitGetSubtargetFeatureName(Info, OS);
2700 OS << "#endif // GET_SUBTARGET_FEATURE_NAME\n\n";
2702 OS << "\n#ifdef GET_MATCHER_IMPLEMENTATION\n";
2703 OS << "#undef GET_MATCHER_IMPLEMENTATION\n\n";
2705 // Generate the function that remaps for mnemonic aliases.
2706 bool HasMnemonicAliases = emitMnemonicAliases(OS, Info, Target);
2708 // Generate the convertToMCInst function to convert operands into an MCInst.
2709 // Also, generate the convertToMapAndConstraints function for MS-style inline
2710 // assembly. The latter doesn't actually generate a MCInst.
2711 emitConvertFuncs(Target, ClassName, Info.Matchables, OS);
2713 // Emit the enumeration for classes which participate in matching.
2714 emitMatchClassEnumeration(Target, Info.Classes, OS);
2716 // Emit the routine to match token strings to their match class.
2717 emitMatchTokenString(Target, Info.Classes, OS);
2719 // Emit the subclass predicate routine.
2720 emitIsSubclass(Target, Info.Classes, OS);
2722 // Emit the routine to validate an operand against a match class.
2723 emitValidateOperandClass(Info, OS);
2725 // Emit the available features compute function.
2726 emitComputeAvailableFeatures(Info, OS);
2729 StringToOffsetTable StringTable;
2731 size_t MaxNumOperands = 0;
2732 unsigned MaxMnemonicIndex = 0;
2733 bool HasDeprecation = false;
2734 for (const auto &MI : Info.Matchables) {
2735 MaxNumOperands = std::max(MaxNumOperands, MI->AsmOperands.size());
2736 HasDeprecation |= MI->HasDeprecation;
2738 // Store a pascal-style length byte in the mnemonic.
2739 std::string LenMnemonic = char(MI->Mnemonic.size()) + MI->Mnemonic.str();
2740 MaxMnemonicIndex = std::max(MaxMnemonicIndex,
2741 StringTable.GetOrAddStringOffset(LenMnemonic, false));
2744 OS << "static const char *const MnemonicTable =\n";
2745 StringTable.EmitString(OS);
2748 // Emit the static match table; unused classes get initalized to 0 which is
2749 // guaranteed to be InvalidMatchClass.
2751 // FIXME: We can reduce the size of this table very easily. First, we change
2752 // it so that store the kinds in separate bit-fields for each index, which
2753 // only needs to be the max width used for classes at that index (we also need
2754 // to reject based on this during classification). If we then make sure to
2755 // order the match kinds appropriately (putting mnemonics last), then we
2756 // should only end up using a few bits for each class, especially the ones
2757 // following the mnemonic.
2758 OS << "namespace {\n";
2759 OS << " struct MatchEntry {\n";
2760 OS << " " << getMinimalTypeForRange(MaxMnemonicIndex)
2762 OS << " uint16_t Opcode;\n";
2763 OS << " " << getMinimalTypeForRange(Info.Matchables.size())
2765 OS << " " << getMinimalRequiredFeaturesType(Info)
2766 << " RequiredFeatures;\n";
2767 OS << " " << getMinimalTypeForRange(
2768 std::distance(Info.Classes.begin(), Info.Classes.end()))
2769 << " Classes[" << MaxNumOperands << "];\n";
2770 OS << " StringRef getMnemonic() const {\n";
2771 OS << " return StringRef(MnemonicTable + Mnemonic + 1,\n";
2772 OS << " MnemonicTable[Mnemonic]);\n";
2776 OS << " // Predicate for searching for an opcode.\n";
2777 OS << " struct LessOpcode {\n";
2778 OS << " bool operator()(const MatchEntry &LHS, StringRef RHS) {\n";
2779 OS << " return LHS.getMnemonic() < RHS;\n";
2781 OS << " bool operator()(StringRef LHS, const MatchEntry &RHS) {\n";
2782 OS << " return LHS < RHS.getMnemonic();\n";
2784 OS << " bool operator()(const MatchEntry &LHS, const MatchEntry &RHS) {\n";
2785 OS << " return LHS.getMnemonic() < RHS.getMnemonic();\n";
2789 OS << "} // end anonymous namespace.\n\n";
2791 unsigned VariantCount = Target.getAsmParserVariantCount();
2792 for (unsigned VC = 0; VC != VariantCount; ++VC) {
2793 Record *AsmVariant = Target.getAsmParserVariant(VC);
2794 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
2796 OS << "static const MatchEntry MatchTable" << VC << "[] = {\n";
2798 for (const auto &MI : Info.Matchables) {
2799 if (MI->AsmVariantID != AsmVariantNo)
2802 // Store a pascal-style length byte in the mnemonic.
2803 std::string LenMnemonic = char(MI->Mnemonic.size()) + MI->Mnemonic.str();
2804 OS << " { " << StringTable.GetOrAddStringOffset(LenMnemonic, false)
2805 << " /* " << MI->Mnemonic << " */, "
2806 << Target.getName() << "::"
2807 << MI->getResultInst()->TheDef->getName() << ", "
2808 << MI->ConversionFnKind << ", ";
2810 // Write the required features mask.
2811 if (!MI->RequiredFeatures.empty()) {
2812 for (unsigned i = 0, e = MI->RequiredFeatures.size(); i != e; ++i) {
2814 OS << MI->RequiredFeatures[i]->getEnumName();
2820 for (unsigned i = 0, e = MI->AsmOperands.size(); i != e; ++i) {
2821 const MatchableInfo::AsmOperand &Op = MI->AsmOperands[i];
2824 OS << Op.Class->Name;
2832 // A method to determine if a mnemonic is in the list.
2833 OS << "bool " << Target.getName() << ClassName << "::\n"
2834 << "mnemonicIsValid(StringRef Mnemonic, unsigned VariantID) {\n";
2835 OS << " // Find the appropriate table for this asm variant.\n";
2836 OS << " const MatchEntry *Start, *End;\n";
2837 OS << " switch (VariantID) {\n";
2838 OS << " default: llvm_unreachable(\"invalid variant!\");\n";
2839 for (unsigned VC = 0; VC != VariantCount; ++VC) {
2840 Record *AsmVariant = Target.getAsmParserVariant(VC);
2841 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
2842 OS << " case " << AsmVariantNo << ": Start = std::begin(MatchTable" << VC
2843 << "); End = std::end(MatchTable" << VC << "); break;\n";
2846 OS << " // Search the table.\n";
2847 OS << " std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n";
2848 OS << " std::equal_range(Start, End, Mnemonic, LessOpcode());\n";
2849 OS << " return MnemonicRange.first != MnemonicRange.second;\n";
2852 // Finally, build the match function.
2853 OS << "unsigned " << Target.getName() << ClassName << "::\n"
2854 << "MatchInstructionImpl(const OperandVector &Operands,\n";
2855 OS << " MCInst &Inst, uint64_t &ErrorInfo,\n"
2856 << " bool matchingInlineAsm, unsigned VariantID) {\n";
2858 OS << " // Eliminate obvious mismatches.\n";
2859 OS << " if (Operands.size() > " << (MaxNumOperands+1) << ") {\n";
2860 OS << " ErrorInfo = " << (MaxNumOperands+1) << ";\n";
2861 OS << " return Match_InvalidOperand;\n";
2864 // Emit code to get the available features.
2865 OS << " // Get the current feature set.\n";
2866 OS << " uint64_t AvailableFeatures = getAvailableFeatures();\n\n";
2868 OS << " // Get the instruction mnemonic, which is the first token.\n";
2869 OS << " StringRef Mnemonic = ((" << Target.getName()
2870 << "Operand&)*Operands[0]).getToken();\n\n";
2872 if (HasMnemonicAliases) {
2873 OS << " // Process all MnemonicAliases to remap the mnemonic.\n";
2874 OS << " applyMnemonicAliases(Mnemonic, AvailableFeatures, VariantID);\n\n";
2877 // Emit code to compute the class list for this operand vector.
2878 OS << " // Some state to try to produce better error messages.\n";
2879 OS << " bool HadMatchOtherThanFeatures = false;\n";
2880 OS << " bool HadMatchOtherThanPredicate = false;\n";
2881 OS << " unsigned RetCode = Match_InvalidOperand;\n";
2882 OS << " uint64_t MissingFeatures = ~0ULL;\n";
2883 OS << " // Set ErrorInfo to the operand that mismatches if it is\n";
2884 OS << " // wrong for all instances of the instruction.\n";
2885 OS << " ErrorInfo = ~0U;\n";
2887 // Emit code to search the table.
2888 OS << " // Find the appropriate table for this asm variant.\n";
2889 OS << " const MatchEntry *Start, *End;\n";
2890 OS << " switch (VariantID) {\n";
2891 OS << " default: llvm_unreachable(\"invalid variant!\");\n";
2892 for (unsigned VC = 0; VC != VariantCount; ++VC) {
2893 Record *AsmVariant = Target.getAsmParserVariant(VC);
2894 int AsmVariantNo = AsmVariant->getValueAsInt("Variant");
2895 OS << " case " << AsmVariantNo << ": Start = std::begin(MatchTable" << VC
2896 << "); End = std::end(MatchTable" << VC << "); break;\n";
2899 OS << " // Search the table.\n";
2900 OS << " std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n";
2901 OS << " std::equal_range(Start, End, Mnemonic, LessOpcode());\n\n";
2903 OS << " // Return a more specific error code if no mnemonics match.\n";
2904 OS << " if (MnemonicRange.first == MnemonicRange.second)\n";
2905 OS << " return Match_MnemonicFail;\n\n";
2907 OS << " for (const MatchEntry *it = MnemonicRange.first, "
2908 << "*ie = MnemonicRange.second;\n";
2909 OS << " it != ie; ++it) {\n";
2911 OS << " // equal_range guarantees that instruction mnemonic matches.\n";
2912 OS << " assert(Mnemonic == it->getMnemonic());\n";
2914 // Emit check that the subclasses match.
2915 OS << " bool OperandsValid = true;\n";
2916 OS << " for (unsigned i = 0; i != " << MaxNumOperands << "; ++i) {\n";
2917 OS << " if (i + 1 >= Operands.size()) {\n";
2918 OS << " OperandsValid = (it->Classes[i] == " <<"InvalidMatchClass);\n";
2919 OS << " if (!OperandsValid) ErrorInfo = i + 1;\n";
2922 OS << " unsigned Diag = validateOperandClass(*Operands[i+1],\n";
2924 OS << "(MatchClassKind)it->Classes[i]);\n";
2925 OS << " if (Diag == Match_Success)\n";
2926 OS << " continue;\n";
2927 OS << " // If the generic handler indicates an invalid operand\n";
2928 OS << " // failure, check for a special case.\n";
2929 OS << " if (Diag == Match_InvalidOperand) {\n";
2930 OS << " Diag = validateTargetOperandClass(*Operands[i+1],\n";
2932 OS << "(MatchClassKind)it->Classes[i]);\n";
2933 OS << " if (Diag == Match_Success)\n";
2934 OS << " continue;\n";
2936 OS << " // If this operand is broken for all of the instances of this\n";
2937 OS << " // mnemonic, keep track of it so we can report loc info.\n";
2938 OS << " // If we already had a match that only failed due to a\n";
2939 OS << " // target predicate, that diagnostic is preferred.\n";
2940 OS << " if (!HadMatchOtherThanPredicate &&\n";
2941 OS << " (it == MnemonicRange.first || ErrorInfo <= i+1)) {\n";
2942 OS << " ErrorInfo = i+1;\n";
2943 OS << " // InvalidOperand is the default. Prefer specificity.\n";
2944 OS << " if (Diag != Match_InvalidOperand)\n";
2945 OS << " RetCode = Diag;\n";
2947 OS << " // Otherwise, just reject this instance of the mnemonic.\n";
2948 OS << " OperandsValid = false;\n";
2952 OS << " if (!OperandsValid) continue;\n";
2954 // Emit check that the required features are available.
2955 OS << " if ((AvailableFeatures & it->RequiredFeatures) "
2956 << "!= it->RequiredFeatures) {\n";
2957 OS << " HadMatchOtherThanFeatures = true;\n";
2958 OS << " uint64_t NewMissingFeatures = it->RequiredFeatures & "
2959 "~AvailableFeatures;\n";
2960 OS << " if (countPopulation(NewMissingFeatures) <=\n"
2961 " countPopulation(MissingFeatures))\n";
2962 OS << " MissingFeatures = NewMissingFeatures;\n";
2963 OS << " continue;\n";
2966 OS << " Inst.clear();\n\n";
2967 OS << " if (matchingInlineAsm) {\n";
2968 OS << " Inst.setOpcode(it->Opcode);\n";
2969 OS << " convertToMapAndConstraints(it->ConvertFn, Operands);\n";
2970 OS << " return Match_Success;\n";
2972 OS << " // We have selected a definite instruction, convert the parsed\n"
2973 << " // operands into the appropriate MCInst.\n";
2974 OS << " convertToMCInst(it->ConvertFn, Inst, it->Opcode, Operands);\n";
2977 // Verify the instruction with the target-specific match predicate function.
2978 OS << " // We have a potential match. Check the target predicate to\n"
2979 << " // handle any context sensitive constraints.\n"
2980 << " unsigned MatchResult;\n"
2981 << " if ((MatchResult = checkTargetMatchPredicate(Inst)) !="
2982 << " Match_Success) {\n"
2983 << " Inst.clear();\n"
2984 << " RetCode = MatchResult;\n"
2985 << " HadMatchOtherThanPredicate = true;\n"
2989 // Call the post-processing function, if used.
2990 std::string InsnCleanupFn =
2991 AsmParser->getValueAsString("AsmParserInstCleanup");
2992 if (!InsnCleanupFn.empty())
2993 OS << " " << InsnCleanupFn << "(Inst);\n";
2995 if (HasDeprecation) {
2996 OS << " std::string Info;\n";
2997 OS << " if (MII.get(Inst.getOpcode()).getDeprecatedInfo(Inst, STI, Info)) {\n";
2998 OS << " SMLoc Loc = ((" << Target.getName()
2999 << "Operand&)*Operands[0]).getStartLoc();\n";
3000 OS << " getParser().Warning(Loc, Info, None);\n";
3004 OS << " return Match_Success;\n";
3007 OS << " // Okay, we had no match. Try to return a useful error code.\n";
3008 OS << " if (HadMatchOtherThanPredicate || !HadMatchOtherThanFeatures)\n";
3009 OS << " return RetCode;\n\n";
3010 OS << " // Missing feature matches return which features were missing\n";
3011 OS << " ErrorInfo = MissingFeatures;\n";
3012 OS << " return Match_MissingFeature;\n";
3015 if (!Info.OperandMatchInfo.empty())
3016 emitCustomOperandParsing(OS, Target, Info, ClassName, StringTable,
3019 OS << "#endif // GET_MATCHER_IMPLEMENTATION\n\n";
3024 void EmitAsmMatcher(RecordKeeper &RK, raw_ostream &OS) {
3025 emitSourceFileHeader("Assembly Matcher Source Fragment", OS);
3026 AsmMatcherEmitter(RK).run(OS);
3029 } // End llvm namespace