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.
13 // The input to the target specific matcher is a list of literal tokens and
14 // operands. The target specific parser should generally eliminate any syntax
15 // which is not relevant for matching; for example, comma tokens should have
16 // already been consumed and eliminated by the parser. Most instructions will
17 // end up with a single literal token (the instruction name) and some number of
20 // Some example inputs, for X86:
21 // 'addl' (immediate ...) (register ...)
22 // 'add' (immediate ...) (memory ...)
25 // The assembly matcher is responsible for converting this input into a precise
26 // machine instruction (i.e., an instruction with a well defined encoding). This
27 // mapping has several properties which complicate matching:
29 // - It may be ambiguous; many architectures can legally encode particular
30 // variants of an instruction in different ways (for example, using a smaller
31 // encoding for small immediates). Such ambiguities should never be
32 // arbitrarily resolved by the assembler, the assembler is always responsible
33 // for choosing the "best" available instruction.
35 // - It may depend on the subtarget or the assembler context. Instructions
36 // which are invalid for the current mode, but otherwise unambiguous (e.g.,
37 // an SSE instruction in a file being assembled for i486) should be accepted
38 // and rejected by the assembler front end. However, if the proper encoding
39 // for an instruction is dependent on the assembler context then the matcher
40 // is responsible for selecting the correct machine instruction for the
43 // The core matching algorithm attempts to exploit the regularity in most
44 // instruction sets to quickly determine the set of possibly matching
45 // instructions, and the simplify the generated code. Additionally, this helps
46 // to ensure that the ambiguities are intentionally resolved by the user.
48 // The matching is divided into two distinct phases:
50 // 1. Classification: Each operand is mapped to the unique set which (a)
51 // contains it, and (b) is the largest such subset for which a single
52 // instruction could match all members.
54 // For register classes, we can generate these subgroups automatically. For
55 // arbitrary operands, we expect the user to define the classes and their
56 // relations to one another (for example, 8-bit signed immediates as a
57 // subset of 32-bit immediates).
59 // By partitioning the operands in this way, we guarantee that for any
60 // tuple of classes, any single instruction must match either all or none
61 // of the sets of operands which could classify to that tuple.
63 // In addition, the subset relation amongst classes induces a partial order
64 // on such tuples, which we use to resolve ambiguities.
66 // 2. The input can now be treated as a tuple of classes (static tokens are
67 // simple singleton sets). Each such tuple should generally map to a single
68 // instruction (we currently ignore cases where this isn't true, whee!!!),
69 // which we can emit a simple matcher for.
71 //===----------------------------------------------------------------------===//
73 #include "AsmMatcherEmitter.h"
74 #include "CodeGenTarget.h"
76 #include "StringMatcher.h"
77 #include "llvm/ADT/OwningPtr.h"
78 #include "llvm/ADT/SmallPtrSet.h"
79 #include "llvm/ADT/SmallVector.h"
80 #include "llvm/ADT/STLExtras.h"
81 #include "llvm/ADT/StringExtras.h"
82 #include "llvm/Support/CommandLine.h"
83 #include "llvm/Support/Debug.h"
88 static cl::opt<std::string>
89 MatchPrefix("match-prefix", cl::init(""),
90 cl::desc("Only match instructions with the given prefix"));
95 struct SubtargetFeatureInfo;
97 /// ClassInfo - Helper class for storing the information about a particular
98 /// class of operands which can be matched.
101 /// Invalid kind, for use as a sentinel value.
104 /// The class for a particular token.
107 /// The (first) register class, subsequent register classes are
108 /// RegisterClass0+1, and so on.
111 /// The (first) user defined class, subsequent user defined classes are
112 /// UserClass0+1, and so on.
116 /// Kind - The class kind, which is either a predefined kind, or (UserClass0 +
117 /// N) for the Nth user defined class.
120 /// SuperClasses - The super classes of this class. Note that for simplicities
121 /// sake user operands only record their immediate super class, while register
122 /// operands include all superclasses.
123 std::vector<ClassInfo*> SuperClasses;
125 /// Name - The full class name, suitable for use in an enum.
128 /// ClassName - The unadorned generic name for this class (e.g., Token).
129 std::string ClassName;
131 /// ValueName - The name of the value this class represents; for a token this
132 /// is the literal token string, for an operand it is the TableGen class (or
133 /// empty if this is a derived class).
134 std::string ValueName;
136 /// PredicateMethod - The name of the operand method to test whether the
137 /// operand matches this class; this is not valid for Token or register kinds.
138 std::string PredicateMethod;
140 /// RenderMethod - The name of the operand method to add this operand to an
141 /// MCInst; this is not valid for Token or register kinds.
142 std::string RenderMethod;
144 /// For register classes, the records for all the registers in this class.
145 std::set<Record*> Registers;
148 /// isRegisterClass() - Check if this is a register class.
149 bool isRegisterClass() const {
150 return Kind >= RegisterClass0 && Kind < UserClass0;
153 /// isUserClass() - Check if this is a user defined class.
154 bool isUserClass() const {
155 return Kind >= UserClass0;
158 /// isRelatedTo - Check whether this class is "related" to \arg RHS. Classes
159 /// are related if they are in the same class hierarchy.
160 bool isRelatedTo(const ClassInfo &RHS) const {
161 // Tokens are only related to tokens.
162 if (Kind == Token || RHS.Kind == Token)
163 return Kind == Token && RHS.Kind == Token;
165 // Registers classes are only related to registers classes, and only if
166 // their intersection is non-empty.
167 if (isRegisterClass() || RHS.isRegisterClass()) {
168 if (!isRegisterClass() || !RHS.isRegisterClass())
171 std::set<Record*> Tmp;
172 std::insert_iterator< std::set<Record*> > II(Tmp, Tmp.begin());
173 std::set_intersection(Registers.begin(), Registers.end(),
174 RHS.Registers.begin(), RHS.Registers.end(),
180 // Otherwise we have two users operands; they are related if they are in the
181 // same class hierarchy.
183 // FIXME: This is an oversimplification, they should only be related if they
184 // intersect, however we don't have that information.
185 assert(isUserClass() && RHS.isUserClass() && "Unexpected class!");
186 const ClassInfo *Root = this;
187 while (!Root->SuperClasses.empty())
188 Root = Root->SuperClasses.front();
190 const ClassInfo *RHSRoot = &RHS;
191 while (!RHSRoot->SuperClasses.empty())
192 RHSRoot = RHSRoot->SuperClasses.front();
194 return Root == RHSRoot;
197 /// isSubsetOf - Test whether this class is a subset of \arg RHS;
198 bool isSubsetOf(const ClassInfo &RHS) const {
199 // This is a subset of RHS if it is the same class...
203 // ... or if any of its super classes are a subset of RHS.
204 for (std::vector<ClassInfo*>::const_iterator it = SuperClasses.begin(),
205 ie = SuperClasses.end(); it != ie; ++it)
206 if ((*it)->isSubsetOf(RHS))
212 /// operator< - Compare two classes.
213 bool operator<(const ClassInfo &RHS) const {
217 // Unrelated classes can be ordered by kind.
218 if (!isRelatedTo(RHS))
219 return Kind < RHS.Kind;
223 assert(0 && "Invalid kind!");
225 // Tokens are comparable by value.
227 // FIXME: Compare by enum value.
228 return ValueName < RHS.ValueName;
231 // This class preceeds the RHS if it is a proper subset of the RHS.
234 if (RHS.isSubsetOf(*this))
237 // Otherwise, order by name to ensure we have a total ordering.
238 return ValueName < RHS.ValueName;
243 /// MatchableInfo - Helper class for storing the necessary information for an
244 /// instruction or alias which is capable of being matched.
245 struct MatchableInfo {
247 /// Token - This is the token that the operand came from.
250 /// The unique class instance this operand should match.
253 /// The operand name this is, if anything.
256 explicit AsmOperand(StringRef T) : Token(T), Class(0) {}
259 /// ResOperand - This represents a single operand in the result instruction
260 /// generated by the match. In cases (like addressing modes) where a single
261 /// assembler operand expands to multiple MCOperands, this represents the
262 /// single assembler operand, not the MCOperand.
265 /// RenderAsmOperand - This represents an operand result that is
266 /// generated by calling the render method on the assembly operand. The
267 /// corresponding AsmOperand is specified by AsmOperandNum.
270 /// TiedOperand - This represents a result operand that is a duplicate of
271 /// a previous result operand.
276 /// This is the operand # in the AsmOperands list that this should be
278 unsigned AsmOperandNum;
280 /// TiedOperandNum - This is the (earlier) result operand that should be
282 unsigned TiedOperandNum;
285 /// OpInfo - This is the information about the instruction operand that is
287 const CGIOperandList::OperandInfo *OpInfo;
289 static ResOperand getRenderedOp(unsigned AsmOpNum,
290 const CGIOperandList::OperandInfo *Op) {
292 X.Kind = RenderAsmOperand;
293 X.AsmOperandNum = AsmOpNum;
298 static ResOperand getTiedOp(unsigned TiedOperandNum,
299 const CGIOperandList::OperandInfo *Op) {
301 X.Kind = TiedOperand;
302 X.TiedOperandNum = TiedOperandNum;
308 /// InstrName - The target name for this instruction.
309 std::string InstrName;
311 /// TheDef - This is the definition of the instruction or InstAlias that this
312 /// matchable came from.
313 Record *const TheDef;
316 const CGIOperandList &TheOperandList;
319 /// ResOperands - This is the operand list that should be built for the result
321 std::vector<ResOperand> ResOperands;
323 /// AsmString - The assembly string for this instruction (with variants
324 /// removed), e.g. "movsx $src, $dst".
325 std::string AsmString;
327 /// Mnemonic - This is the first token of the matched instruction, its
331 /// AsmOperands - The textual operands that this instruction matches,
332 /// annotated with a class and where in the OperandList they were defined.
333 /// This directly corresponds to the tokenized AsmString after the mnemonic is
335 SmallVector<AsmOperand, 4> AsmOperands;
337 /// Predicates - The required subtarget features to match this instruction.
338 SmallVector<SubtargetFeatureInfo*, 4> RequiredFeatures;
340 /// ConversionFnKind - The enum value which is passed to the generated
341 /// ConvertToMCInst to convert parsed operands into an MCInst for this
343 std::string ConversionFnKind;
345 MatchableInfo(const CodeGenInstruction &CGI)
346 : TheDef(CGI.TheDef), TheOperandList(CGI.Operands), AsmString(CGI.AsmString) {
347 InstrName = TheDef->getName();
350 MatchableInfo(const CodeGenInstAlias *Alias)
351 : TheDef(Alias->TheDef), TheOperandList(Alias->Operands),
352 AsmString(Alias->AsmString) {
355 DefInit *DI = dynamic_cast<DefInit*>(Alias->Result->getOperator());
358 InstrName = DI->getDef()->getName();
361 void Initialize(const AsmMatcherInfo &Info,
362 SmallPtrSet<Record*, 16> &SingletonRegisters);
364 /// Validate - Return true if this matchable is a valid thing to match against
365 /// and perform a bunch of validity checking.
366 bool Validate(StringRef CommentDelimiter, bool Hack) const;
368 /// getSingletonRegisterForAsmOperand - If the specified token is a singleton
369 /// register, return the Record for it, otherwise return null.
370 Record *getSingletonRegisterForAsmOperand(unsigned i,
371 const AsmMatcherInfo &Info) const;
373 int FindAsmOperandNamed(StringRef N) const {
374 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
375 if (N == AsmOperands[i].SrcOpName)
380 void BuildResultOperands();
382 /// operator< - Compare two matchables.
383 bool operator<(const MatchableInfo &RHS) const {
384 // The primary comparator is the instruction mnemonic.
385 if (Mnemonic != RHS.Mnemonic)
386 return Mnemonic < RHS.Mnemonic;
388 if (AsmOperands.size() != RHS.AsmOperands.size())
389 return AsmOperands.size() < RHS.AsmOperands.size();
391 // Compare lexicographically by operand. The matcher validates that other
392 // orderings wouldn't be ambiguous using \see CouldMatchAmiguouslyWith().
393 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
394 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
396 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
403 /// CouldMatchAmiguouslyWith - Check whether this matchable could
404 /// ambiguously match the same set of operands as \arg RHS (without being a
405 /// strictly superior match).
406 bool CouldMatchAmiguouslyWith(const MatchableInfo &RHS) {
407 // The primary comparator is the instruction mnemonic.
408 if (Mnemonic != RHS.Mnemonic)
411 // The number of operands is unambiguous.
412 if (AsmOperands.size() != RHS.AsmOperands.size())
415 // Otherwise, make sure the ordering of the two instructions is unambiguous
416 // by checking that either (a) a token or operand kind discriminates them,
417 // or (b) the ordering among equivalent kinds is consistent.
419 // Tokens and operand kinds are unambiguous (assuming a correct target
421 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
422 if (AsmOperands[i].Class->Kind != RHS.AsmOperands[i].Class->Kind ||
423 AsmOperands[i].Class->Kind == ClassInfo::Token)
424 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class ||
425 *RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
428 // Otherwise, this operand could commute if all operands are equivalent, or
429 // there is a pair of operands that compare less than and a pair that
430 // compare greater than.
431 bool HasLT = false, HasGT = false;
432 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
433 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
435 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
439 return !(HasLT ^ HasGT);
445 void TokenizeAsmString(const AsmMatcherInfo &Info);
448 /// SubtargetFeatureInfo - Helper class for storing information on a subtarget
449 /// feature which participates in instruction matching.
450 struct SubtargetFeatureInfo {
451 /// \brief The predicate record for this feature.
454 /// \brief An unique index assigned to represent this feature.
457 SubtargetFeatureInfo(Record *D, unsigned Idx) : TheDef(D), Index(Idx) {}
459 /// \brief The name of the enumerated constant identifying this feature.
460 std::string getEnumName() const {
461 return "Feature_" + TheDef->getName();
465 class AsmMatcherInfo {
467 /// The tablegen AsmParser record.
470 /// Target - The target information.
471 CodeGenTarget &Target;
473 /// The AsmParser "RegisterPrefix" value.
474 std::string RegisterPrefix;
476 /// The classes which are needed for matching.
477 std::vector<ClassInfo*> Classes;
479 /// The information on the matchables to match.
480 std::vector<MatchableInfo*> Matchables;
482 /// Map of Register records to their class information.
483 std::map<Record*, ClassInfo*> RegisterClasses;
485 /// Map of Predicate records to their subtarget information.
486 std::map<Record*, SubtargetFeatureInfo*> SubtargetFeatures;
489 /// Map of token to class information which has already been constructed.
490 std::map<std::string, ClassInfo*> TokenClasses;
492 /// Map of RegisterClass records to their class information.
493 std::map<Record*, ClassInfo*> RegisterClassClasses;
495 /// Map of AsmOperandClass records to their class information.
496 std::map<Record*, ClassInfo*> AsmOperandClasses;
499 /// getTokenClass - Lookup or create the class for the given token.
500 ClassInfo *getTokenClass(StringRef Token);
502 /// getOperandClass - Lookup or create the class for the given operand.
503 ClassInfo *getOperandClass(StringRef Token,
504 const CGIOperandList::OperandInfo &OI);
506 /// BuildRegisterClasses - Build the ClassInfo* instances for register
508 void BuildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters);
510 /// BuildOperandClasses - Build the ClassInfo* instances for user defined
512 void BuildOperandClasses();
514 void BuildInstructionOperandReference(MatchableInfo *II,
515 MatchableInfo::AsmOperand &Op);
518 AsmMatcherInfo(Record *AsmParser, CodeGenTarget &Target);
520 /// BuildInfo - Construct the various tables used during matching.
523 /// getSubtargetFeature - Lookup or create the subtarget feature info for the
525 SubtargetFeatureInfo *getSubtargetFeature(Record *Def) const {
526 assert(Def->isSubClassOf("Predicate") && "Invalid predicate type!");
527 std::map<Record*, SubtargetFeatureInfo*>::const_iterator I =
528 SubtargetFeatures.find(Def);
529 return I == SubtargetFeatures.end() ? 0 : I->second;
535 void MatchableInfo::dump() {
536 errs() << InstrName << " -- " << "flattened:\"" << AsmString << "\"\n";
538 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
539 AsmOperand &Op = AsmOperands[i];
540 errs() << " op[" << i << "] = " << Op.Class->ClassName << " - ";
541 errs() << '\"' << Op.Token << "\"\n";
543 if (!Op.OperandInfo) {
544 errs() << "(singleton register)\n";
548 const CGIOperandList::OperandInfo &OI = *Op.OperandInfo;
549 errs() << OI.Name << " " << OI.Rec->getName()
550 << " (" << OI.MIOperandNo << ", " << OI.MINumOperands << ")\n";
555 void MatchableInfo::Initialize(const AsmMatcherInfo &Info,
556 SmallPtrSet<Record*, 16> &SingletonRegisters) {
557 // TODO: Eventually support asmparser for Variant != 0.
558 AsmString = CodeGenInstruction::FlattenAsmStringVariants(AsmString, 0);
560 TokenizeAsmString(Info);
562 // Compute the require features.
563 std::vector<Record*> Predicates =TheDef->getValueAsListOfDefs("Predicates");
564 for (unsigned i = 0, e = Predicates.size(); i != e; ++i)
565 if (SubtargetFeatureInfo *Feature =
566 Info.getSubtargetFeature(Predicates[i]))
567 RequiredFeatures.push_back(Feature);
569 // Collect singleton registers, if used.
570 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
571 if (Record *Reg = getSingletonRegisterForAsmOperand(i, Info))
572 SingletonRegisters.insert(Reg);
576 /// TokenizeAsmString - Tokenize a simplified assembly string.
577 void MatchableInfo::TokenizeAsmString(const AsmMatcherInfo &Info) {
578 StringRef String = AsmString;
581 for (unsigned i = 0, e = String.size(); i != e; ++i) {
591 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
594 if (!isspace(String[i]) && String[i] != ',')
595 AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
601 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
605 assert(i != String.size() && "Invalid quoted character");
606 AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
611 // If this isn't "${", treat like a normal token.
612 if (i + 1 == String.size() || String[i + 1] != '{') {
614 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
622 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
626 StringRef::iterator End = std::find(String.begin() + i, String.end(),'}');
627 assert(End != String.end() && "Missing brace in operand reference!");
628 size_t EndPos = End - String.begin();
629 AsmOperands.push_back(AsmOperand(String.slice(i, EndPos+1)));
637 AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
646 if (InTok && Prev != String.size())
647 AsmOperands.push_back(AsmOperand(String.substr(Prev)));
649 // The first token of the instruction is the mnemonic, which must be a
650 // simple string, not a $foo variable or a singleton register.
651 assert(!AsmOperands.empty() && "Instruction has no tokens?");
652 Mnemonic = AsmOperands[0].Token;
653 if (Mnemonic[0] == '$' || getSingletonRegisterForAsmOperand(0, Info))
654 throw TGError(TheDef->getLoc(),
655 "Invalid instruction mnemonic '" + Mnemonic.str() + "'!");
657 // Remove the first operand, it is tracked in the mnemonic field.
658 AsmOperands.erase(AsmOperands.begin());
663 bool MatchableInfo::Validate(StringRef CommentDelimiter, bool Hack) const {
664 // Reject matchables with no .s string.
665 if (AsmString.empty())
666 throw TGError(TheDef->getLoc(), "instruction with empty asm string");
668 // Reject any matchables with a newline in them, they should be marked
669 // isCodeGenOnly if they are pseudo instructions.
670 if (AsmString.find('\n') != std::string::npos)
671 throw TGError(TheDef->getLoc(),
672 "multiline instruction is not valid for the asmparser, "
673 "mark it isCodeGenOnly");
675 // Remove comments from the asm string. We know that the asmstring only
677 if (!CommentDelimiter.empty() &&
678 StringRef(AsmString).find(CommentDelimiter) != StringRef::npos)
679 throw TGError(TheDef->getLoc(),
680 "asmstring for instruction has comment character in it, "
681 "mark it isCodeGenOnly");
683 // Reject matchables with operand modifiers, these aren't something we can
684 /// handle, the target should be refactored to use operands instead of
687 // Also, check for instructions which reference the operand multiple times;
688 // this implies a constraint we would not honor.
689 std::set<std::string> OperandNames;
690 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
691 StringRef Tok = AsmOperands[i].Token;
692 if (Tok[0] == '$' && Tok.find(':') != StringRef::npos)
693 throw TGError(TheDef->getLoc(),
694 "matchable with operand modifier '" + Tok.str() +
695 "' not supported by asm matcher. Mark isCodeGenOnly!");
697 // Verify that any operand is only mentioned once.
698 // We reject aliases and ignore instructions for now.
699 if (Tok[0] == '$' && !OperandNames.insert(Tok).second) {
701 throw TGError(TheDef->getLoc(),
702 "ERROR: matchable with tied operand '" + Tok.str() +
703 "' can never be matched!");
704 // FIXME: Should reject these. The ARM backend hits this with $lane in a
705 // bunch of instructions. It is unclear what the right answer is.
707 errs() << "warning: '" << InstrName << "': "
708 << "ignoring instruction with tied operand '"
709 << Tok.str() << "'\n";
719 /// getSingletonRegisterForAsmOperand - If the specified token is a singleton
720 /// register, return the register name, otherwise return a null StringRef.
721 Record *MatchableInfo::
722 getSingletonRegisterForAsmOperand(unsigned i, const AsmMatcherInfo &Info) const{
723 StringRef Tok = AsmOperands[i].Token;
724 if (!Tok.startswith(Info.RegisterPrefix))
727 StringRef RegName = Tok.substr(Info.RegisterPrefix.size());
728 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(RegName))
731 // If there is no register prefix (i.e. "%" in "%eax"), then this may
732 // be some random non-register token, just ignore it.
733 if (Info.RegisterPrefix.empty())
736 // Otherwise, we have something invalid prefixed with the register prefix,
738 std::string Err = "unable to find register for '" + RegName.str() +
739 "' (which matches register prefix)";
740 throw TGError(TheDef->getLoc(), Err);
744 static std::string getEnumNameForToken(StringRef Str) {
747 for (StringRef::iterator it = Str.begin(), ie = Str.end(); it != ie; ++it) {
749 case '*': Res += "_STAR_"; break;
750 case '%': Res += "_PCT_"; break;
751 case ':': Res += "_COLON_"; break;
756 Res += "_" + utostr((unsigned) *it) + "_";
763 ClassInfo *AsmMatcherInfo::getTokenClass(StringRef Token) {
764 ClassInfo *&Entry = TokenClasses[Token];
767 Entry = new ClassInfo();
768 Entry->Kind = ClassInfo::Token;
769 Entry->ClassName = "Token";
770 Entry->Name = "MCK_" + getEnumNameForToken(Token);
771 Entry->ValueName = Token;
772 Entry->PredicateMethod = "<invalid>";
773 Entry->RenderMethod = "<invalid>";
774 Classes.push_back(Entry);
781 AsmMatcherInfo::getOperandClass(StringRef Token,
782 const CGIOperandList::OperandInfo &OI) {
783 if (OI.Rec->isSubClassOf("RegisterClass")) {
784 if (ClassInfo *CI = RegisterClassClasses[OI.Rec])
786 throw TGError(OI.Rec->getLoc(), "register class has no class info!");
789 assert(OI.Rec->isSubClassOf("Operand") && "Unexpected operand!");
790 Record *MatchClass = OI.Rec->getValueAsDef("ParserMatchClass");
791 if (ClassInfo *CI = AsmOperandClasses[MatchClass])
794 throw TGError(OI.Rec->getLoc(), "operand has no match class!");
797 void AsmMatcherInfo::
798 BuildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters) {
799 const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
800 const std::vector<CodeGenRegisterClass> &RegClassList =
801 Target.getRegisterClasses();
803 // The register sets used for matching.
804 std::set< std::set<Record*> > RegisterSets;
806 // Gather the defined sets.
807 for (std::vector<CodeGenRegisterClass>::const_iterator it =
808 RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it)
809 RegisterSets.insert(std::set<Record*>(it->Elements.begin(),
810 it->Elements.end()));
812 // Add any required singleton sets.
813 for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(),
814 ie = SingletonRegisters.end(); it != ie; ++it) {
816 RegisterSets.insert(std::set<Record*>(&Rec, &Rec + 1));
819 // Introduce derived sets where necessary (when a register does not determine
820 // a unique register set class), and build the mapping of registers to the set
821 // they should classify to.
822 std::map<Record*, std::set<Record*> > RegisterMap;
823 for (std::vector<CodeGenRegister>::const_iterator it = Registers.begin(),
824 ie = Registers.end(); it != ie; ++it) {
825 const CodeGenRegister &CGR = *it;
826 // Compute the intersection of all sets containing this register.
827 std::set<Record*> ContainingSet;
829 for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
830 ie = RegisterSets.end(); it != ie; ++it) {
831 if (!it->count(CGR.TheDef))
834 if (ContainingSet.empty()) {
839 std::set<Record*> Tmp;
840 std::swap(Tmp, ContainingSet);
841 std::insert_iterator< std::set<Record*> > II(ContainingSet,
842 ContainingSet.begin());
843 std::set_intersection(Tmp.begin(), Tmp.end(), it->begin(), it->end(), II);
846 if (!ContainingSet.empty()) {
847 RegisterSets.insert(ContainingSet);
848 RegisterMap.insert(std::make_pair(CGR.TheDef, ContainingSet));
852 // Construct the register classes.
853 std::map<std::set<Record*>, ClassInfo*> RegisterSetClasses;
855 for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
856 ie = RegisterSets.end(); it != ie; ++it, ++Index) {
857 ClassInfo *CI = new ClassInfo();
858 CI->Kind = ClassInfo::RegisterClass0 + Index;
859 CI->ClassName = "Reg" + utostr(Index);
860 CI->Name = "MCK_Reg" + utostr(Index);
862 CI->PredicateMethod = ""; // unused
863 CI->RenderMethod = "addRegOperands";
865 Classes.push_back(CI);
866 RegisterSetClasses.insert(std::make_pair(*it, CI));
869 // Find the superclasses; we could compute only the subgroup lattice edges,
870 // but there isn't really a point.
871 for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
872 ie = RegisterSets.end(); it != ie; ++it) {
873 ClassInfo *CI = RegisterSetClasses[*it];
874 for (std::set< std::set<Record*> >::iterator it2 = RegisterSets.begin(),
875 ie2 = RegisterSets.end(); it2 != ie2; ++it2)
877 std::includes(it2->begin(), it2->end(), it->begin(), it->end()))
878 CI->SuperClasses.push_back(RegisterSetClasses[*it2]);
881 // Name the register classes which correspond to a user defined RegisterClass.
882 for (std::vector<CodeGenRegisterClass>::const_iterator
883 it = RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it) {
884 ClassInfo *CI = RegisterSetClasses[std::set<Record*>(it->Elements.begin(),
885 it->Elements.end())];
886 if (CI->ValueName.empty()) {
887 CI->ClassName = it->getName();
888 CI->Name = "MCK_" + it->getName();
889 CI->ValueName = it->getName();
891 CI->ValueName = CI->ValueName + "," + it->getName();
893 RegisterClassClasses.insert(std::make_pair(it->TheDef, CI));
896 // Populate the map for individual registers.
897 for (std::map<Record*, std::set<Record*> >::iterator it = RegisterMap.begin(),
898 ie = RegisterMap.end(); it != ie; ++it)
899 RegisterClasses[it->first] = RegisterSetClasses[it->second];
901 // Name the register classes which correspond to singleton registers.
902 for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(),
903 ie = SingletonRegisters.end(); it != ie; ++it) {
905 ClassInfo *CI = RegisterClasses[Rec];
906 assert(CI && "Missing singleton register class info!");
908 if (CI->ValueName.empty()) {
909 CI->ClassName = Rec->getName();
910 CI->Name = "MCK_" + Rec->getName();
911 CI->ValueName = Rec->getName();
913 CI->ValueName = CI->ValueName + "," + Rec->getName();
917 void AsmMatcherInfo::BuildOperandClasses() {
918 std::vector<Record*> AsmOperands =
919 Records.getAllDerivedDefinitions("AsmOperandClass");
921 // Pre-populate AsmOperandClasses map.
922 for (std::vector<Record*>::iterator it = AsmOperands.begin(),
923 ie = AsmOperands.end(); it != ie; ++it)
924 AsmOperandClasses[*it] = new ClassInfo();
927 for (std::vector<Record*>::iterator it = AsmOperands.begin(),
928 ie = AsmOperands.end(); it != ie; ++it, ++Index) {
929 ClassInfo *CI = AsmOperandClasses[*it];
930 CI->Kind = ClassInfo::UserClass0 + Index;
932 ListInit *Supers = (*it)->getValueAsListInit("SuperClasses");
933 for (unsigned i = 0, e = Supers->getSize(); i != e; ++i) {
934 DefInit *DI = dynamic_cast<DefInit*>(Supers->getElement(i));
936 PrintError((*it)->getLoc(), "Invalid super class reference!");
940 ClassInfo *SC = AsmOperandClasses[DI->getDef()];
942 PrintError((*it)->getLoc(), "Invalid super class reference!");
944 CI->SuperClasses.push_back(SC);
946 CI->ClassName = (*it)->getValueAsString("Name");
947 CI->Name = "MCK_" + CI->ClassName;
948 CI->ValueName = (*it)->getName();
950 // Get or construct the predicate method name.
951 Init *PMName = (*it)->getValueInit("PredicateMethod");
952 if (StringInit *SI = dynamic_cast<StringInit*>(PMName)) {
953 CI->PredicateMethod = SI->getValue();
955 assert(dynamic_cast<UnsetInit*>(PMName) &&
956 "Unexpected PredicateMethod field!");
957 CI->PredicateMethod = "is" + CI->ClassName;
960 // Get or construct the render method name.
961 Init *RMName = (*it)->getValueInit("RenderMethod");
962 if (StringInit *SI = dynamic_cast<StringInit*>(RMName)) {
963 CI->RenderMethod = SI->getValue();
965 assert(dynamic_cast<UnsetInit*>(RMName) &&
966 "Unexpected RenderMethod field!");
967 CI->RenderMethod = "add" + CI->ClassName + "Operands";
970 AsmOperandClasses[*it] = CI;
971 Classes.push_back(CI);
975 AsmMatcherInfo::AsmMatcherInfo(Record *asmParser, CodeGenTarget &target)
976 : AsmParser(asmParser), Target(target),
977 RegisterPrefix(AsmParser->getValueAsString("RegisterPrefix")) {
981 void AsmMatcherInfo::BuildInfo() {
982 // Build information about all of the AssemblerPredicates.
983 std::vector<Record*> AllPredicates =
984 Records.getAllDerivedDefinitions("Predicate");
985 for (unsigned i = 0, e = AllPredicates.size(); i != e; ++i) {
986 Record *Pred = AllPredicates[i];
987 // Ignore predicates that are not intended for the assembler.
988 if (!Pred->getValueAsBit("AssemblerMatcherPredicate"))
991 if (Pred->getName().empty())
992 throw TGError(Pred->getLoc(), "Predicate has no name!");
994 unsigned FeatureNo = SubtargetFeatures.size();
995 SubtargetFeatures[Pred] = new SubtargetFeatureInfo(Pred, FeatureNo);
996 assert(FeatureNo < 32 && "Too many subtarget features!");
999 StringRef CommentDelimiter = AsmParser->getValueAsString("CommentDelimiter");
1001 // Parse the instructions; we need to do this first so that we can gather the
1002 // singleton register classes.
1003 SmallPtrSet<Record*, 16> SingletonRegisters;
1004 for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
1005 E = Target.inst_end(); I != E; ++I) {
1006 const CodeGenInstruction &CGI = **I;
1008 // If the tblgen -match-prefix option is specified (for tblgen hackers),
1009 // filter the set of instructions we consider.
1010 if (!StringRef(CGI.TheDef->getName()).startswith(MatchPrefix))
1013 // Ignore "codegen only" instructions.
1014 if (CGI.TheDef->getValueAsBit("isCodeGenOnly"))
1017 // Validate the operand list to ensure we can handle this instruction.
1018 for (unsigned i = 0, e = CGI.Operands.size(); i != e; ++i) {
1019 const CGIOperandList::OperandInfo &OI = CGI.Operands[i];
1021 // Validate tied operands.
1022 if (OI.getTiedRegister() != -1) {
1023 // If we have a tied operand that consists of multiple MCOperands, reject
1024 // it. We reject aliases and ignore instructions for now.
1025 if (OI.MINumOperands != 1) {
1026 // FIXME: Should reject these. The ARM backend hits this with $lane
1027 // in a bunch of instructions. It is unclear what the right answer is.
1029 errs() << "warning: '" << CGI.TheDef->getName() << "': "
1030 << "ignoring instruction with multi-operand tied operand '"
1031 << OI.Name << "'\n";
1038 OwningPtr<MatchableInfo> II(new MatchableInfo(CGI));
1040 II->Initialize(*this, SingletonRegisters);
1042 // Ignore instructions which shouldn't be matched and diagnose invalid
1043 // instruction definitions with an error.
1044 if (!II->Validate(CommentDelimiter, true))
1047 // Ignore "Int_*" and "*_Int" instructions, which are internal aliases.
1049 // FIXME: This is a total hack.
1050 if (StringRef(II->InstrName).startswith("Int_") ||
1051 StringRef(II->InstrName).endswith("_Int"))
1054 Matchables.push_back(II.take());
1057 // Parse all of the InstAlias definitions and stick them in the list of
1059 std::vector<Record*> AllInstAliases =
1060 Records.getAllDerivedDefinitions("InstAlias");
1061 for (unsigned i = 0, e = AllInstAliases.size(); i != e; ++i) {
1062 CodeGenInstAlias *Alias = new CodeGenInstAlias(AllInstAliases[i]);
1064 OwningPtr<MatchableInfo> II(new MatchableInfo(Alias));
1066 II->Initialize(*this, SingletonRegisters);
1068 // Validate the alias definitions.
1069 II->Validate(CommentDelimiter, false);
1071 Matchables.push_back(II.take());
1074 // Build info for the register classes.
1075 BuildRegisterClasses(SingletonRegisters);
1077 // Build info for the user defined assembly operand classes.
1078 BuildOperandClasses();
1080 // Build the information about matchables, now that we have fully formed
1082 for (std::vector<MatchableInfo*>::iterator it = Matchables.begin(),
1083 ie = Matchables.end(); it != ie; ++it) {
1084 MatchableInfo *II = *it;
1086 // Parse the tokens after the mnemonic.
1087 for (unsigned i = 0, e = II->AsmOperands.size(); i != e; ++i) {
1088 MatchableInfo::AsmOperand &Op = II->AsmOperands[i];
1089 StringRef Token = Op.Token;
1091 // Check for singleton registers.
1092 if (Record *RegRecord = II->getSingletonRegisterForAsmOperand(i, *this)) {
1093 Op.Class = RegisterClasses[RegRecord];
1094 assert(Op.Class && Op.Class->Registers.size() == 1 &&
1095 "Unexpected class for singleton register");
1099 // Check for simple tokens.
1100 if (Token[0] != '$') {
1101 Op.Class = getTokenClass(Token);
1105 // Otherwise this is an operand reference.
1106 BuildInstructionOperandReference(II, Op);
1109 II->BuildResultOperands();
1112 // Reorder classes so that classes preceed super classes.
1113 std::sort(Classes.begin(), Classes.end(), less_ptr<ClassInfo>());
1116 /// BuildInstructionOperandReference - The specified operand is a reference to a
1117 /// named operand such as $src. Resolve the Class and OperandInfo pointers.
1118 void AsmMatcherInfo::
1119 BuildInstructionOperandReference(MatchableInfo *II,
1120 MatchableInfo::AsmOperand &Op) {
1121 StringRef Token = Op.Token;
1122 assert(Token[0] == '$' && "Not an operand name ref");
1124 StringRef OperandName;
1125 if (Token[1] == '{')
1126 OperandName = Token.substr(2, Token.size() - 3);
1128 OperandName = Token.substr(1);
1130 const CGIOperandList &Operands = II->TheOperandList;
1133 // Map this token to an operand. FIXME: Move elsewhere.
1135 if (!Operands.hasOperandNamed(OperandName, Idx))
1136 throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" +
1137 OperandName.str() + "'");
1139 // Set up the operand class.
1140 Op.Class = getOperandClass(Token, Operands[Idx]);
1142 // If the named operand is tied, canonicalize it to the untied operand.
1143 // For example, something like:
1144 // (outs GPR:$dst), (ins GPR:$src)
1145 // with an asmstring of
1147 // we want to canonicalize to:
1149 // so that we know how to provide the $dst operand when filling in the result.
1150 int OITied = Operands[Idx].getTiedRegister();
1152 // The tied operand index is an MIOperand index, find the operand that
1154 for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
1155 if (Operands[i].MIOperandNo == unsigned(OITied)) {
1156 OperandName = Operands[i].Name;
1162 Op.SrcOpName = OperandName;
1165 void MatchableInfo::BuildResultOperands() {
1166 for (unsigned i = 0, e = TheOperandList.size(); i != e; ++i) {
1167 const CGIOperandList::OperandInfo &OpInfo = TheOperandList[i];
1169 // If this is a tied operand, just copy from the previously handled operand.
1170 int TiedOp = OpInfo.getTiedRegister();
1172 ResOperands.push_back(ResOperand::getTiedOp(TiedOp, &OpInfo));
1176 // Find out what operand from the asmparser that this MCInst operand comes
1178 int SrcOperand = FindAsmOperandNamed(OpInfo.Name);
1180 if (!OpInfo.Name.empty() && SrcOperand != -1) {
1181 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, &OpInfo));
1185 throw TGError(TheDef->getLoc(), "Instruction '" +
1186 TheDef->getName() + "' has operand '" + OpInfo.Name +
1187 "' that doesn't appear in asm string!");
1192 static void EmitConvertToMCInst(CodeGenTarget &Target,
1193 std::vector<MatchableInfo*> &Infos,
1195 // Write the convert function to a separate stream, so we can drop it after
1197 std::string ConvertFnBody;
1198 raw_string_ostream CvtOS(ConvertFnBody);
1200 // Function we have already generated.
1201 std::set<std::string> GeneratedFns;
1203 // Start the unified conversion function.
1204 CvtOS << "static void ConvertToMCInst(ConversionKind Kind, MCInst &Inst, "
1205 << "unsigned Opcode,\n"
1206 << " const SmallVectorImpl<MCParsedAsmOperand*"
1207 << "> &Operands) {\n";
1208 CvtOS << " Inst.setOpcode(Opcode);\n";
1209 CvtOS << " switch (Kind) {\n";
1210 CvtOS << " default:\n";
1212 // Start the enum, which we will generate inline.
1214 OS << "// Unified function for converting operands to MCInst instances.\n\n";
1215 OS << "enum ConversionKind {\n";
1217 // TargetOperandClass - This is the target's operand class, like X86Operand.
1218 std::string TargetOperandClass = Target.getName() + "Operand";
1220 for (std::vector<MatchableInfo*>::const_iterator it = Infos.begin(),
1221 ie = Infos.end(); it != ie; ++it) {
1222 MatchableInfo &II = **it;
1224 // Build the conversion function signature.
1225 std::string Signature = "Convert";
1226 std::string CaseBody;
1227 raw_string_ostream CaseOS(CaseBody);
1229 // Compute the convert enum and the case body.
1230 for (unsigned i = 0, e = II.ResOperands.size(); i != e; ++i) {
1231 const MatchableInfo::ResOperand &OpInfo = II.ResOperands[i];
1233 // Generate code to populate each result operand.
1234 switch (OpInfo.Kind) {
1235 default: assert(0 && "Unknown result operand kind");
1236 case MatchableInfo::ResOperand::RenderAsmOperand: {
1237 // This comes from something we parsed.
1238 MatchableInfo::AsmOperand &Op = II.AsmOperands[OpInfo.AsmOperandNum];
1240 // Registers are always converted the same, don't duplicate the
1241 // conversion function based on them.
1243 if (Op.Class->isRegisterClass())
1246 Signature += Op.Class->ClassName;
1247 Signature += utostr(OpInfo.OpInfo->MINumOperands);
1248 Signature += "_" + itostr(OpInfo.AsmOperandNum);
1250 CaseOS << " ((" << TargetOperandClass << "*)Operands["
1251 << (OpInfo.AsmOperandNum+1) << "])->" << Op.Class->RenderMethod
1252 << "(Inst, " << OpInfo.OpInfo->MINumOperands << ");\n";
1256 case MatchableInfo::ResOperand::TiedOperand: {
1257 // If this operand is tied to a previous one, just copy the MCInst
1258 // operand from the earlier one.We can only tie single MCOperand values.
1259 //assert(OpInfo.OpInfo->MINumOperands == 1 && "Not a singular MCOperand");
1260 unsigned TiedOp = OpInfo.TiedOperandNum;
1261 assert(i > TiedOp && "Tied operand preceeds its target!");
1262 CaseOS << " Inst.addOperand(Inst.getOperand(" << TiedOp << "));\n";
1263 Signature += "__Tie" + utostr(TiedOp);
1269 II.ConversionFnKind = Signature;
1271 // Check if we have already generated this signature.
1272 if (!GeneratedFns.insert(Signature).second)
1275 // If not, emit it now. Add to the enum list.
1276 OS << " " << Signature << ",\n";
1278 CvtOS << " case " << Signature << ":\n";
1279 CvtOS << CaseOS.str();
1280 CvtOS << " return;\n";
1283 // Finish the convert function.
1288 // Finish the enum, and drop the convert function after it.
1290 OS << " NumConversionVariants\n";
1296 /// EmitMatchClassEnumeration - Emit the enumeration for match class kinds.
1297 static void EmitMatchClassEnumeration(CodeGenTarget &Target,
1298 std::vector<ClassInfo*> &Infos,
1300 OS << "namespace {\n\n";
1302 OS << "/// MatchClassKind - The kinds of classes which participate in\n"
1303 << "/// instruction matching.\n";
1304 OS << "enum MatchClassKind {\n";
1305 OS << " InvalidMatchClass = 0,\n";
1306 for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1307 ie = Infos.end(); it != ie; ++it) {
1308 ClassInfo &CI = **it;
1309 OS << " " << CI.Name << ", // ";
1310 if (CI.Kind == ClassInfo::Token) {
1311 OS << "'" << CI.ValueName << "'\n";
1312 } else if (CI.isRegisterClass()) {
1313 if (!CI.ValueName.empty())
1314 OS << "register class '" << CI.ValueName << "'\n";
1316 OS << "derived register class\n";
1318 OS << "user defined class '" << CI.ValueName << "'\n";
1321 OS << " NumMatchClassKinds\n";
1327 /// EmitClassifyOperand - Emit the function to classify an operand.
1328 static void EmitClassifyOperand(AsmMatcherInfo &Info,
1330 OS << "static MatchClassKind ClassifyOperand(MCParsedAsmOperand *GOp) {\n"
1331 << " " << Info.Target.getName() << "Operand &Operand = *("
1332 << Info.Target.getName() << "Operand*)GOp;\n";
1335 OS << " if (Operand.isToken())\n";
1336 OS << " return MatchTokenString(Operand.getToken());\n\n";
1338 // Classify registers.
1340 // FIXME: Don't hardcode isReg, getReg.
1341 OS << " if (Operand.isReg()) {\n";
1342 OS << " switch (Operand.getReg()) {\n";
1343 OS << " default: return InvalidMatchClass;\n";
1344 for (std::map<Record*, ClassInfo*>::iterator
1345 it = Info.RegisterClasses.begin(), ie = Info.RegisterClasses.end();
1347 OS << " case " << Info.Target.getName() << "::"
1348 << it->first->getName() << ": return " << it->second->Name << ";\n";
1352 // Classify user defined operands.
1353 for (std::vector<ClassInfo*>::iterator it = Info.Classes.begin(),
1354 ie = Info.Classes.end(); it != ie; ++it) {
1355 ClassInfo &CI = **it;
1357 if (!CI.isUserClass())
1360 OS << " // '" << CI.ClassName << "' class";
1361 if (!CI.SuperClasses.empty()) {
1362 OS << ", subclass of ";
1363 for (unsigned i = 0, e = CI.SuperClasses.size(); i != e; ++i) {
1365 OS << "'" << CI.SuperClasses[i]->ClassName << "'";
1366 assert(CI < *CI.SuperClasses[i] && "Invalid class relation!");
1371 OS << " if (Operand." << CI.PredicateMethod << "()) {\n";
1373 // Validate subclass relationships.
1374 if (!CI.SuperClasses.empty()) {
1375 for (unsigned i = 0, e = CI.SuperClasses.size(); i != e; ++i)
1376 OS << " assert(Operand." << CI.SuperClasses[i]->PredicateMethod
1377 << "() && \"Invalid class relationship!\");\n";
1380 OS << " return " << CI.Name << ";\n";
1383 OS << " return InvalidMatchClass;\n";
1387 /// EmitIsSubclass - Emit the subclass predicate function.
1388 static void EmitIsSubclass(CodeGenTarget &Target,
1389 std::vector<ClassInfo*> &Infos,
1391 OS << "/// IsSubclass - Compute whether \\arg A is a subclass of \\arg B.\n";
1392 OS << "static bool IsSubclass(MatchClassKind A, MatchClassKind B) {\n";
1393 OS << " if (A == B)\n";
1394 OS << " return true;\n\n";
1396 OS << " switch (A) {\n";
1397 OS << " default:\n";
1398 OS << " return false;\n";
1399 for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1400 ie = Infos.end(); it != ie; ++it) {
1401 ClassInfo &A = **it;
1403 if (A.Kind != ClassInfo::Token) {
1404 std::vector<StringRef> SuperClasses;
1405 for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1406 ie = Infos.end(); it != ie; ++it) {
1407 ClassInfo &B = **it;
1409 if (&A != &B && A.isSubsetOf(B))
1410 SuperClasses.push_back(B.Name);
1413 if (SuperClasses.empty())
1416 OS << "\n case " << A.Name << ":\n";
1418 if (SuperClasses.size() == 1) {
1419 OS << " return B == " << SuperClasses.back() << ";\n";
1423 OS << " switch (B) {\n";
1424 OS << " default: return false;\n";
1425 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1426 OS << " case " << SuperClasses[i] << ": return true;\n";
1436 /// EmitMatchTokenString - Emit the function to match a token string to the
1437 /// appropriate match class value.
1438 static void EmitMatchTokenString(CodeGenTarget &Target,
1439 std::vector<ClassInfo*> &Infos,
1441 // Construct the match list.
1442 std::vector<StringMatcher::StringPair> Matches;
1443 for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1444 ie = Infos.end(); it != ie; ++it) {
1445 ClassInfo &CI = **it;
1447 if (CI.Kind == ClassInfo::Token)
1448 Matches.push_back(StringMatcher::StringPair(CI.ValueName,
1449 "return " + CI.Name + ";"));
1452 OS << "static MatchClassKind MatchTokenString(StringRef Name) {\n";
1454 StringMatcher("Name", Matches, OS).Emit();
1456 OS << " return InvalidMatchClass;\n";
1460 /// EmitMatchRegisterName - Emit the function to match a string to the target
1461 /// specific register enum.
1462 static void EmitMatchRegisterName(CodeGenTarget &Target, Record *AsmParser,
1464 // Construct the match list.
1465 std::vector<StringMatcher::StringPair> Matches;
1466 for (unsigned i = 0, e = Target.getRegisters().size(); i != e; ++i) {
1467 const CodeGenRegister &Reg = Target.getRegisters()[i];
1468 if (Reg.TheDef->getValueAsString("AsmName").empty())
1471 Matches.push_back(StringMatcher::StringPair(
1472 Reg.TheDef->getValueAsString("AsmName"),
1473 "return " + utostr(i + 1) + ";"));
1476 OS << "static unsigned MatchRegisterName(StringRef Name) {\n";
1478 StringMatcher("Name", Matches, OS).Emit();
1480 OS << " return 0;\n";
1484 /// EmitSubtargetFeatureFlagEnumeration - Emit the subtarget feature flag
1486 static void EmitSubtargetFeatureFlagEnumeration(AsmMatcherInfo &Info,
1488 OS << "// Flags for subtarget features that participate in "
1489 << "instruction matching.\n";
1490 OS << "enum SubtargetFeatureFlag {\n";
1491 for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator
1492 it = Info.SubtargetFeatures.begin(),
1493 ie = Info.SubtargetFeatures.end(); it != ie; ++it) {
1494 SubtargetFeatureInfo &SFI = *it->second;
1495 OS << " " << SFI.getEnumName() << " = (1 << " << SFI.Index << "),\n";
1497 OS << " Feature_None = 0\n";
1501 /// EmitComputeAvailableFeatures - Emit the function to compute the list of
1502 /// available features given a subtarget.
1503 static void EmitComputeAvailableFeatures(AsmMatcherInfo &Info,
1505 std::string ClassName =
1506 Info.AsmParser->getValueAsString("AsmParserClassName");
1508 OS << "unsigned " << Info.Target.getName() << ClassName << "::\n"
1509 << "ComputeAvailableFeatures(const " << Info.Target.getName()
1510 << "Subtarget *Subtarget) const {\n";
1511 OS << " unsigned Features = 0;\n";
1512 for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator
1513 it = Info.SubtargetFeatures.begin(),
1514 ie = Info.SubtargetFeatures.end(); it != ie; ++it) {
1515 SubtargetFeatureInfo &SFI = *it->second;
1516 OS << " if (" << SFI.TheDef->getValueAsString("CondString")
1518 OS << " Features |= " << SFI.getEnumName() << ";\n";
1520 OS << " return Features;\n";
1524 static std::string GetAliasRequiredFeatures(Record *R,
1525 const AsmMatcherInfo &Info) {
1526 std::vector<Record*> ReqFeatures = R->getValueAsListOfDefs("Predicates");
1528 unsigned NumFeatures = 0;
1529 for (unsigned i = 0, e = ReqFeatures.size(); i != e; ++i) {
1530 SubtargetFeatureInfo *F = Info.getSubtargetFeature(ReqFeatures[i]);
1533 throw TGError(R->getLoc(), "Predicate '" + ReqFeatures[i]->getName() +
1534 "' is not marked as an AssemblerPredicate!");
1539 Result += F->getEnumName();
1543 if (NumFeatures > 1)
1544 Result = '(' + Result + ')';
1548 /// EmitMnemonicAliases - If the target has any MnemonicAlias<> definitions,
1549 /// emit a function for them and return true, otherwise return false.
1550 static bool EmitMnemonicAliases(raw_ostream &OS, const AsmMatcherInfo &Info) {
1551 std::vector<Record*> Aliases =
1552 Records.getAllDerivedDefinitions("MnemonicAlias");
1553 if (Aliases.empty()) return false;
1555 OS << "static void ApplyMnemonicAliases(StringRef &Mnemonic, "
1556 "unsigned Features) {\n";
1558 // Keep track of all the aliases from a mnemonic. Use an std::map so that the
1559 // iteration order of the map is stable.
1560 std::map<std::string, std::vector<Record*> > AliasesFromMnemonic;
1562 for (unsigned i = 0, e = Aliases.size(); i != e; ++i) {
1563 Record *R = Aliases[i];
1564 AliasesFromMnemonic[R->getValueAsString("FromMnemonic")].push_back(R);
1567 // Process each alias a "from" mnemonic at a time, building the code executed
1568 // by the string remapper.
1569 std::vector<StringMatcher::StringPair> Cases;
1570 for (std::map<std::string, std::vector<Record*> >::iterator
1571 I = AliasesFromMnemonic.begin(), E = AliasesFromMnemonic.end();
1573 const std::vector<Record*> &ToVec = I->second;
1575 // Loop through each alias and emit code that handles each case. If there
1576 // are two instructions without predicates, emit an error. If there is one,
1578 std::string MatchCode;
1579 int AliasWithNoPredicate = -1;
1581 for (unsigned i = 0, e = ToVec.size(); i != e; ++i) {
1582 Record *R = ToVec[i];
1583 std::string FeatureMask = GetAliasRequiredFeatures(R, Info);
1585 // If this unconditionally matches, remember it for later and diagnose
1587 if (FeatureMask.empty()) {
1588 if (AliasWithNoPredicate != -1) {
1589 // We can't have two aliases from the same mnemonic with no predicate.
1590 PrintError(ToVec[AliasWithNoPredicate]->getLoc(),
1591 "two MnemonicAliases with the same 'from' mnemonic!");
1592 throw TGError(R->getLoc(), "this is the other MnemonicAlias.");
1595 AliasWithNoPredicate = i;
1599 if (!MatchCode.empty())
1600 MatchCode += "else ";
1601 MatchCode += "if ((Features & " + FeatureMask + ") == "+FeatureMask+")\n";
1602 MatchCode += " Mnemonic = \"" +R->getValueAsString("ToMnemonic")+"\";\n";
1605 if (AliasWithNoPredicate != -1) {
1606 Record *R = ToVec[AliasWithNoPredicate];
1607 if (!MatchCode.empty())
1608 MatchCode += "else\n ";
1609 MatchCode += "Mnemonic = \"" + R->getValueAsString("ToMnemonic")+"\";\n";
1612 MatchCode += "return;";
1614 Cases.push_back(std::make_pair(I->first, MatchCode));
1618 StringMatcher("Mnemonic", Cases, OS).Emit();
1624 void AsmMatcherEmitter::run(raw_ostream &OS) {
1625 CodeGenTarget Target;
1626 Record *AsmParser = Target.getAsmParser();
1627 std::string ClassName = AsmParser->getValueAsString("AsmParserClassName");
1629 // Compute the information on the instructions to match.
1630 AsmMatcherInfo Info(AsmParser, Target);
1633 // Sort the instruction table using the partial order on classes. We use
1634 // stable_sort to ensure that ambiguous instructions are still
1635 // deterministically ordered.
1636 std::stable_sort(Info.Matchables.begin(), Info.Matchables.end(),
1637 less_ptr<MatchableInfo>());
1639 DEBUG_WITH_TYPE("instruction_info", {
1640 for (std::vector<MatchableInfo*>::iterator
1641 it = Info.Matchables.begin(), ie = Info.Matchables.end();
1646 // Check for ambiguous matchables.
1647 DEBUG_WITH_TYPE("ambiguous_instrs", {
1648 unsigned NumAmbiguous = 0;
1649 for (unsigned i = 0, e = Info.Matchables.size(); i != e; ++i) {
1650 for (unsigned j = i + 1; j != e; ++j) {
1651 MatchableInfo &A = *Info.Matchables[i];
1652 MatchableInfo &B = *Info.Matchables[j];
1654 if (A.CouldMatchAmiguouslyWith(B)) {
1655 errs() << "warning: ambiguous matchables:\n";
1657 errs() << "\nis incomparable with:\n";
1665 errs() << "warning: " << NumAmbiguous
1666 << " ambiguous matchables!\n";
1669 // Write the output.
1671 EmitSourceFileHeader("Assembly Matcher Source Fragment", OS);
1673 // Information for the class declaration.
1674 OS << "\n#ifdef GET_ASSEMBLER_HEADER\n";
1675 OS << "#undef GET_ASSEMBLER_HEADER\n";
1676 OS << " // This should be included into the middle of the declaration of \n";
1677 OS << " // your subclasses implementation of TargetAsmParser.\n";
1678 OS << " unsigned ComputeAvailableFeatures(const " <<
1679 Target.getName() << "Subtarget *Subtarget) const;\n";
1680 OS << " enum MatchResultTy {\n";
1681 OS << " Match_Success, Match_MnemonicFail, Match_InvalidOperand,\n";
1682 OS << " Match_MissingFeature\n";
1684 OS << " MatchResultTy MatchInstructionImpl(const "
1685 << "SmallVectorImpl<MCParsedAsmOperand*>"
1686 << " &Operands, MCInst &Inst, unsigned &ErrorInfo);\n\n";
1687 OS << "#endif // GET_ASSEMBLER_HEADER_INFO\n\n";
1692 OS << "\n#ifdef GET_REGISTER_MATCHER\n";
1693 OS << "#undef GET_REGISTER_MATCHER\n\n";
1695 // Emit the subtarget feature enumeration.
1696 EmitSubtargetFeatureFlagEnumeration(Info, OS);
1698 // Emit the function to match a register name to number.
1699 EmitMatchRegisterName(Target, AsmParser, OS);
1701 OS << "#endif // GET_REGISTER_MATCHER\n\n";
1704 OS << "\n#ifdef GET_MATCHER_IMPLEMENTATION\n";
1705 OS << "#undef GET_MATCHER_IMPLEMENTATION\n\n";
1707 // Generate the function that remaps for mnemonic aliases.
1708 bool HasMnemonicAliases = EmitMnemonicAliases(OS, Info);
1710 // Generate the unified function to convert operands into an MCInst.
1711 EmitConvertToMCInst(Target, Info.Matchables, OS);
1713 // Emit the enumeration for classes which participate in matching.
1714 EmitMatchClassEnumeration(Target, Info.Classes, OS);
1716 // Emit the routine to match token strings to their match class.
1717 EmitMatchTokenString(Target, Info.Classes, OS);
1719 // Emit the routine to classify an operand.
1720 EmitClassifyOperand(Info, OS);
1722 // Emit the subclass predicate routine.
1723 EmitIsSubclass(Target, Info.Classes, OS);
1725 // Emit the available features compute function.
1726 EmitComputeAvailableFeatures(Info, OS);
1729 size_t MaxNumOperands = 0;
1730 for (std::vector<MatchableInfo*>::const_iterator it =
1731 Info.Matchables.begin(), ie = Info.Matchables.end();
1733 MaxNumOperands = std::max(MaxNumOperands, (*it)->AsmOperands.size());
1736 // Emit the static match table; unused classes get initalized to 0 which is
1737 // guaranteed to be InvalidMatchClass.
1739 // FIXME: We can reduce the size of this table very easily. First, we change
1740 // it so that store the kinds in separate bit-fields for each index, which
1741 // only needs to be the max width used for classes at that index (we also need
1742 // to reject based on this during classification). If we then make sure to
1743 // order the match kinds appropriately (putting mnemonics last), then we
1744 // should only end up using a few bits for each class, especially the ones
1745 // following the mnemonic.
1746 OS << "namespace {\n";
1747 OS << " struct MatchEntry {\n";
1748 OS << " unsigned Opcode;\n";
1749 OS << " const char *Mnemonic;\n";
1750 OS << " ConversionKind ConvertFn;\n";
1751 OS << " MatchClassKind Classes[" << MaxNumOperands << "];\n";
1752 OS << " unsigned RequiredFeatures;\n";
1755 OS << "// Predicate for searching for an opcode.\n";
1756 OS << " struct LessOpcode {\n";
1757 OS << " bool operator()(const MatchEntry &LHS, StringRef RHS) {\n";
1758 OS << " return StringRef(LHS.Mnemonic) < RHS;\n";
1760 OS << " bool operator()(StringRef LHS, const MatchEntry &RHS) {\n";
1761 OS << " return LHS < StringRef(RHS.Mnemonic);\n";
1763 OS << " bool operator()(const MatchEntry &LHS, const MatchEntry &RHS) {\n";
1764 OS << " return StringRef(LHS.Mnemonic) < StringRef(RHS.Mnemonic);\n";
1768 OS << "} // end anonymous namespace.\n\n";
1770 OS << "static const MatchEntry MatchTable["
1771 << Info.Matchables.size() << "] = {\n";
1773 for (std::vector<MatchableInfo*>::const_iterator it =
1774 Info.Matchables.begin(), ie = Info.Matchables.end();
1776 MatchableInfo &II = **it;
1778 OS << " { " << Target.getName() << "::" << II.InstrName
1779 << ", \"" << II.Mnemonic << "\""
1780 << ", " << II.ConversionFnKind << ", { ";
1781 for (unsigned i = 0, e = II.AsmOperands.size(); i != e; ++i) {
1782 MatchableInfo::AsmOperand &Op = II.AsmOperands[i];
1785 OS << Op.Class->Name;
1789 // Write the required features mask.
1790 if (!II.RequiredFeatures.empty()) {
1791 for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) {
1793 OS << II.RequiredFeatures[i]->getEnumName();
1803 // Finally, build the match function.
1804 OS << Target.getName() << ClassName << "::MatchResultTy "
1805 << Target.getName() << ClassName << "::\n"
1806 << "MatchInstructionImpl(const SmallVectorImpl<MCParsedAsmOperand*>"
1808 OS << " MCInst &Inst, unsigned &ErrorInfo) {\n";
1810 // Emit code to get the available features.
1811 OS << " // Get the current feature set.\n";
1812 OS << " unsigned AvailableFeatures = getAvailableFeatures();\n\n";
1814 OS << " // Get the instruction mnemonic, which is the first token.\n";
1815 OS << " StringRef Mnemonic = ((" << Target.getName()
1816 << "Operand*)Operands[0])->getToken();\n\n";
1818 if (HasMnemonicAliases) {
1819 OS << " // Process all MnemonicAliases to remap the mnemonic.\n";
1820 OS << " ApplyMnemonicAliases(Mnemonic, AvailableFeatures);\n\n";
1823 // Emit code to compute the class list for this operand vector.
1824 OS << " // Eliminate obvious mismatches.\n";
1825 OS << " if (Operands.size() > " << (MaxNumOperands+1) << ") {\n";
1826 OS << " ErrorInfo = " << (MaxNumOperands+1) << ";\n";
1827 OS << " return Match_InvalidOperand;\n";
1830 OS << " // Compute the class list for this operand vector.\n";
1831 OS << " MatchClassKind Classes[" << MaxNumOperands << "];\n";
1832 OS << " for (unsigned i = 1, e = Operands.size(); i != e; ++i) {\n";
1833 OS << " Classes[i-1] = ClassifyOperand(Operands[i]);\n\n";
1835 OS << " // Check for invalid operands before matching.\n";
1836 OS << " if (Classes[i-1] == InvalidMatchClass) {\n";
1837 OS << " ErrorInfo = i;\n";
1838 OS << " return Match_InvalidOperand;\n";
1842 OS << " // Mark unused classes.\n";
1843 OS << " for (unsigned i = Operands.size()-1, e = " << MaxNumOperands << "; "
1844 << "i != e; ++i)\n";
1845 OS << " Classes[i] = InvalidMatchClass;\n\n";
1847 OS << " // Some state to try to produce better error messages.\n";
1848 OS << " bool HadMatchOtherThanFeatures = false;\n\n";
1849 OS << " // Set ErrorInfo to the operand that mismatches if it is \n";
1850 OS << " // wrong for all instances of the instruction.\n";
1851 OS << " ErrorInfo = ~0U;\n";
1853 // Emit code to search the table.
1854 OS << " // Search the table.\n";
1855 OS << " std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n";
1856 OS << " std::equal_range(MatchTable, MatchTable+"
1857 << Info.Matchables.size() << ", Mnemonic, LessOpcode());\n\n";
1859 OS << " // Return a more specific error code if no mnemonics match.\n";
1860 OS << " if (MnemonicRange.first == MnemonicRange.second)\n";
1861 OS << " return Match_MnemonicFail;\n\n";
1863 OS << " for (const MatchEntry *it = MnemonicRange.first, "
1864 << "*ie = MnemonicRange.second;\n";
1865 OS << " it != ie; ++it) {\n";
1867 OS << " // equal_range guarantees that instruction mnemonic matches.\n";
1868 OS << " assert(Mnemonic == it->Mnemonic);\n";
1870 // Emit check that the subclasses match.
1871 OS << " bool OperandsValid = true;\n";
1872 OS << " for (unsigned i = 0; i != " << MaxNumOperands << "; ++i) {\n";
1873 OS << " if (IsSubclass(Classes[i], it->Classes[i]))\n";
1874 OS << " continue;\n";
1875 OS << " // If this operand is broken for all of the instances of this\n";
1876 OS << " // mnemonic, keep track of it so we can report loc info.\n";
1877 OS << " if (it == MnemonicRange.first || ErrorInfo == i+1)\n";
1878 OS << " ErrorInfo = i+1;\n";
1880 OS << " ErrorInfo = ~0U;";
1881 OS << " // Otherwise, just reject this instance of the mnemonic.\n";
1882 OS << " OperandsValid = false;\n";
1886 OS << " if (!OperandsValid) continue;\n";
1888 // Emit check that the required features are available.
1889 OS << " if ((AvailableFeatures & it->RequiredFeatures) "
1890 << "!= it->RequiredFeatures) {\n";
1891 OS << " HadMatchOtherThanFeatures = true;\n";
1892 OS << " continue;\n";
1896 OS << " ConvertToMCInst(it->ConvertFn, Inst, it->Opcode, Operands);\n";
1898 // Call the post-processing function, if used.
1899 std::string InsnCleanupFn =
1900 AsmParser->getValueAsString("AsmParserInstCleanup");
1901 if (!InsnCleanupFn.empty())
1902 OS << " " << InsnCleanupFn << "(Inst);\n";
1904 OS << " return Match_Success;\n";
1907 OS << " // Okay, we had no match. Try to return a useful error code.\n";
1908 OS << " if (HadMatchOtherThanFeatures) return Match_MissingFeature;\n";
1909 OS << " return Match_InvalidOperand;\n";
1912 OS << "#endif // GET_MATCHER_IMPLEMENTATION\n\n";