1//===- AsmMatcherEmitter.cpp - Generate an assembly matcher ---------------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This tablegen backend emits a target specifier matcher for converting parsed 11// assembly operands in the MCInst structures. It also emits a matcher for 12// custom operand parsing. 13// 14// Converting assembly operands into MCInst structures 15// --------------------------------------------------- 16// 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 22// operands. 23// 24// Some example inputs, for X86: 25// 'addl' (immediate ...) (register ...) 26// 'add' (immediate ...) (memory ...) 27// 'call' '*' %epc 28// 29// The assembly matcher is responsible for converting this input into a precise 30// machine instruction (i.e., an instruction with a well defined encoding). This 31// mapping has several properties which complicate matching: 32// 33// - It may be ambiguous; many architectures can legally encode particular 34// variants of an instruction in different ways (for example, using a smaller 35// encoding for small immediates). Such ambiguities should never be 36// arbitrarily resolved by the assembler, the assembler is always responsible 37// for choosing the "best" available instruction. 38// 39// - It may depend on the subtarget or the assembler context. Instructions 40// which are invalid for the current mode, but otherwise unambiguous (e.g., 41// an SSE instruction in a file being assembled for i486) should be accepted 42// and rejected by the assembler front end. However, if the proper encoding 43// for an instruction is dependent on the assembler context then the matcher 44// is responsible for selecting the correct machine instruction for the 45// current mode. 46// 47// The core matching algorithm attempts to exploit the regularity in most 48// instruction sets to quickly determine the set of possibly matching 49// instructions, and the simplify the generated code. Additionally, this helps 50// to ensure that the ambiguities are intentionally resolved by the user. 51// 52// The matching is divided into two distinct phases: 53// 54// 1. Classification: Each operand is mapped to the unique set which (a) 55// contains it, and (b) is the largest such subset for which a single 56// instruction could match all members. 57// 58// For register classes, we can generate these subgroups automatically. For 59// arbitrary operands, we expect the user to define the classes and their 60// relations to one another (for example, 8-bit signed immediates as a 61// subset of 32-bit immediates). 62// 63// By partitioning the operands in this way, we guarantee that for any 64// tuple of classes, any single instruction must match either all or none 65// of the sets of operands which could classify to that tuple. 66// 67// In addition, the subset relation amongst classes induces a partial order 68// on such tuples, which we use to resolve ambiguities. 69// 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. 74// 75// Custom Operand Parsing 76// ---------------------- 77// 78// Some targets need a custom way to parse operands, some specific instructions 79// can contain arguments that can represent processor flags and other kinds of 80// identifiers that need to be mapped to specific valeus in the final encoded 81// instructions. The target specific custom operand parsing works in the 82// following way: 83// 84// 1. A operand match table is built, each entry contains a mnemonic, an 85// operand class, a mask for all operand positions for that same 86// class/mnemonic and target features to be checked while trying to match. 87// 88// 2. The operand matcher will try every possible entry with the same 89// mnemonic and will check if the target feature for this mnemonic also 90// matches. After that, if the operand to be matched has its index 91// present in the mask, a successful match occurs. Otherwise, fallback 92// to the regular operand parsing. 93// 94// 3. For a match success, each operand class that has a 'ParserMethod' 95// becomes part of a switch from where the custom method is called. 96// 97//===----------------------------------------------------------------------===// 98 99#include "CodeGenTarget.h" 100#include "StringToOffsetTable.h" 101#include "llvm/ADT/OwningPtr.h" 102#include "llvm/ADT/PointerUnion.h" 103#include "llvm/ADT/SmallPtrSet.h" 104#include "llvm/ADT/SmallVector.h" 105#include "llvm/ADT/STLExtras.h" 106#include "llvm/ADT/StringExtras.h" 107#include "llvm/Support/CommandLine.h" 108#include "llvm/Support/Debug.h" 109#include "llvm/Support/ErrorHandling.h" 110#include "llvm/TableGen/Error.h" 111#include "llvm/TableGen/Record.h" 112#include "llvm/TableGen/StringMatcher.h" 113#include "llvm/TableGen/TableGenBackend.h" 114#include <cassert> 115#include <map> 116#include <set> 117using namespace llvm; 118 119static cl::opt<std::string> 120MatchPrefix("match-prefix", cl::init(""), 121 cl::desc("Only match instructions with the given prefix")); 122 123namespace { 124class AsmMatcherInfo; 125struct SubtargetFeatureInfo; 126 127class AsmMatcherEmitter { 128 RecordKeeper &Records; 129public: 130 AsmMatcherEmitter(RecordKeeper &R) : Records(R) {} 131 132 void run(raw_ostream &o); 133}; 134 135/// ClassInfo - Helper class for storing the information about a particular 136/// class of operands which can be matched. 137struct ClassInfo { 138 enum ClassInfoKind { 139 /// Invalid kind, for use as a sentinel value. 140 Invalid = 0, 141 142 /// The class for a particular token. 143 Token, 144 145 /// The (first) register class, subsequent register classes are 146 /// RegisterClass0+1, and so on. 147 RegisterClass0, 148 149 /// The (first) user defined class, subsequent user defined classes are 150 /// UserClass0+1, and so on. 151 UserClass0 = 1<<16 152 }; 153 154 /// Kind - The class kind, which is either a predefined kind, or (UserClass0 + 155 /// N) for the Nth user defined class. 156 unsigned Kind; 157 158 /// SuperClasses - The super classes of this class. Note that for simplicities 159 /// sake user operands only record their immediate super class, while register 160 /// operands include all superclasses. 161 std::vector<ClassInfo*> SuperClasses; 162 163 /// Name - The full class name, suitable for use in an enum. 164 std::string Name; 165 166 /// ClassName - The unadorned generic name for this class (e.g., Token). 167 std::string ClassName; 168 169 /// ValueName - The name of the value this class represents; for a token this 170 /// is the literal token string, for an operand it is the TableGen class (or 171 /// empty if this is a derived class). 172 std::string ValueName; 173 174 /// PredicateMethod - The name of the operand method to test whether the 175 /// operand matches this class; this is not valid for Token or register kinds. 176 std::string PredicateMethod; 177 178 /// RenderMethod - The name of the operand method to add this operand to an 179 /// MCInst; this is not valid for Token or register kinds. 180 std::string RenderMethod; 181 182 /// ParserMethod - The name of the operand method to do a target specific 183 /// parsing on the operand. 184 std::string ParserMethod; 185 186 /// For register classes, the records for all the registers in this class. 187 std::set<Record*> Registers; 188 189 /// For custom match classes, he diagnostic kind for when the predicate fails. 190 std::string DiagnosticType; 191public: 192 /// isRegisterClass() - Check if this is a register class. 193 bool isRegisterClass() const { 194 return Kind >= RegisterClass0 && Kind < UserClass0; 195 } 196 197 /// isUserClass() - Check if this is a user defined class. 198 bool isUserClass() const { 199 return Kind >= UserClass0; 200 } 201 202 /// isRelatedTo - Check whether this class is "related" to \arg RHS. Classes 203 /// are related if they are in the same class hierarchy. 204 bool isRelatedTo(const ClassInfo &RHS) const { 205 // Tokens are only related to tokens. 206 if (Kind == Token || RHS.Kind == Token) 207 return Kind == Token && RHS.Kind == Token; 208 209 // Registers classes are only related to registers classes, and only if 210 // their intersection is non-empty. 211 if (isRegisterClass() || RHS.isRegisterClass()) { 212 if (!isRegisterClass() || !RHS.isRegisterClass()) 213 return false; 214 215 std::set<Record*> Tmp; 216 std::insert_iterator< std::set<Record*> > II(Tmp, Tmp.begin()); 217 std::set_intersection(Registers.begin(), Registers.end(), 218 RHS.Registers.begin(), RHS.Registers.end(), 219 II); 220 221 return !Tmp.empty(); 222 } 223 224 // Otherwise we have two users operands; they are related if they are in the 225 // same class hierarchy. 226 // 227 // FIXME: This is an oversimplification, they should only be related if they 228 // intersect, however we don't have that information. 229 assert(isUserClass() && RHS.isUserClass() && "Unexpected class!"); 230 const ClassInfo *Root = this; 231 while (!Root->SuperClasses.empty()) 232 Root = Root->SuperClasses.front(); 233 234 const ClassInfo *RHSRoot = &RHS; 235 while (!RHSRoot->SuperClasses.empty()) 236 RHSRoot = RHSRoot->SuperClasses.front(); 237 238 return Root == RHSRoot; 239 } 240 241 /// isSubsetOf - Test whether this class is a subset of \arg RHS; 242 bool isSubsetOf(const ClassInfo &RHS) const { 243 // This is a subset of RHS if it is the same class... 244 if (this == &RHS) 245 return true; 246 247 // ... or if any of its super classes are a subset of RHS. 248 for (std::vector<ClassInfo*>::const_iterator it = SuperClasses.begin(), 249 ie = SuperClasses.end(); it != ie; ++it) 250 if ((*it)->isSubsetOf(RHS)) 251 return true; 252 253 return false; 254 } 255 256 /// operator< - Compare two classes. 257 bool operator<(const ClassInfo &RHS) const { 258 if (this == &RHS) 259 return false; 260 261 // Unrelated classes can be ordered by kind. 262 if (!isRelatedTo(RHS)) 263 return Kind < RHS.Kind; 264 265 switch (Kind) { 266 case Invalid: 267 llvm_unreachable("Invalid kind!"); 268 269 default: 270 // This class precedes the RHS if it is a proper subset of the RHS. 271 if (isSubsetOf(RHS)) 272 return true; 273 if (RHS.isSubsetOf(*this)) 274 return false; 275 276 // Otherwise, order by name to ensure we have a total ordering. 277 return ValueName < RHS.ValueName; 278 } 279 } 280}; 281 282/// MatchableInfo - Helper class for storing the necessary information for an 283/// instruction or alias which is capable of being matched. 284struct MatchableInfo { 285 struct AsmOperand { 286 /// Token - This is the token that the operand came from. 287 StringRef Token; 288 289 /// The unique class instance this operand should match. 290 ClassInfo *Class; 291 292 /// The operand name this is, if anything. 293 StringRef SrcOpName; 294 295 /// The suboperand index within SrcOpName, or -1 for the entire operand. 296 int SubOpIdx; 297 298 /// Register record if this token is singleton register. 299 Record *SingletonReg; 300 301 explicit AsmOperand(StringRef T) : Token(T), Class(0), SubOpIdx(-1), 302 SingletonReg(0) {} 303 }; 304 305 /// ResOperand - This represents a single operand in the result instruction 306 /// generated by the match. In cases (like addressing modes) where a single 307 /// assembler operand expands to multiple MCOperands, this represents the 308 /// single assembler operand, not the MCOperand. 309 struct ResOperand { 310 enum { 311 /// RenderAsmOperand - This represents an operand result that is 312 /// generated by calling the render method on the assembly operand. The 313 /// corresponding AsmOperand is specified by AsmOperandNum. 314 RenderAsmOperand, 315 316 /// TiedOperand - This represents a result operand that is a duplicate of 317 /// a previous result operand. 318 TiedOperand, 319 320 /// ImmOperand - This represents an immediate value that is dumped into 321 /// the operand. 322 ImmOperand, 323 324 /// RegOperand - This represents a fixed register that is dumped in. 325 RegOperand 326 } Kind; 327 328 union { 329 /// This is the operand # in the AsmOperands list that this should be 330 /// copied from. 331 unsigned AsmOperandNum; 332 333 /// TiedOperandNum - This is the (earlier) result operand that should be 334 /// copied from. 335 unsigned TiedOperandNum; 336 337 /// ImmVal - This is the immediate value added to the instruction. 338 int64_t ImmVal; 339 340 /// Register - This is the register record. 341 Record *Register; 342 }; 343 344 /// MINumOperands - The number of MCInst operands populated by this 345 /// operand. 346 unsigned MINumOperands; 347 348 static ResOperand getRenderedOp(unsigned AsmOpNum, unsigned NumOperands) { 349 ResOperand X; 350 X.Kind = RenderAsmOperand; 351 X.AsmOperandNum = AsmOpNum; 352 X.MINumOperands = NumOperands; 353 return X; 354 } 355 356 static ResOperand getTiedOp(unsigned TiedOperandNum) { 357 ResOperand X; 358 X.Kind = TiedOperand; 359 X.TiedOperandNum = TiedOperandNum; 360 X.MINumOperands = 1; 361 return X; 362 } 363 364 static ResOperand getImmOp(int64_t Val) { 365 ResOperand X; 366 X.Kind = ImmOperand; 367 X.ImmVal = Val; 368 X.MINumOperands = 1; 369 return X; 370 } 371 372 static ResOperand getRegOp(Record *Reg) { 373 ResOperand X; 374 X.Kind = RegOperand; 375 X.Register = Reg; 376 X.MINumOperands = 1; 377 return X; 378 } 379 }; 380 381 /// AsmVariantID - Target's assembly syntax variant no. 382 int AsmVariantID; 383 384 /// TheDef - This is the definition of the instruction or InstAlias that this 385 /// matchable came from. 386 Record *const TheDef; 387 388 /// DefRec - This is the definition that it came from. 389 PointerUnion<const CodeGenInstruction*, const CodeGenInstAlias*> DefRec; 390 391 const CodeGenInstruction *getResultInst() const { 392 if (DefRec.is<const CodeGenInstruction*>()) 393 return DefRec.get<const CodeGenInstruction*>(); 394 return DefRec.get<const CodeGenInstAlias*>()->ResultInst; 395 } 396 397 /// ResOperands - This is the operand list that should be built for the result 398 /// MCInst. 399 SmallVector<ResOperand, 8> ResOperands; 400 401 /// AsmString - The assembly string for this instruction (with variants 402 /// removed), e.g. "movsx $src, $dst". 403 std::string AsmString; 404 405 /// Mnemonic - This is the first token of the matched instruction, its 406 /// mnemonic. 407 StringRef Mnemonic; 408 409 /// AsmOperands - The textual operands that this instruction matches, 410 /// annotated with a class and where in the OperandList they were defined. 411 /// This directly corresponds to the tokenized AsmString after the mnemonic is 412 /// removed. 413 SmallVector<AsmOperand, 8> AsmOperands; 414 415 /// Predicates - The required subtarget features to match this instruction. 416 SmallVector<SubtargetFeatureInfo*, 4> RequiredFeatures; 417 418 /// ConversionFnKind - The enum value which is passed to the generated 419 /// convertToMCInst to convert parsed operands into an MCInst for this 420 /// function. 421 std::string ConversionFnKind; 422 423 MatchableInfo(const CodeGenInstruction &CGI) 424 : AsmVariantID(0), TheDef(CGI.TheDef), DefRec(&CGI), 425 AsmString(CGI.AsmString) { 426 } 427 428 MatchableInfo(const CodeGenInstAlias *Alias) 429 : AsmVariantID(0), TheDef(Alias->TheDef), DefRec(Alias), 430 AsmString(Alias->AsmString) { 431 } 432 433 // Two-operand aliases clone from the main matchable, but mark the second 434 // operand as a tied operand of the first for purposes of the assembler. 435 void formTwoOperandAlias(StringRef Constraint); 436 437 void initialize(const AsmMatcherInfo &Info, 438 SmallPtrSet<Record*, 16> &SingletonRegisters, 439 int AsmVariantNo, std::string &RegisterPrefix); 440 441 /// validate - Return true if this matchable is a valid thing to match against 442 /// and perform a bunch of validity checking. 443 bool validate(StringRef CommentDelimiter, bool Hack) const; 444 445 /// extractSingletonRegisterForAsmOperand - Extract singleton register, 446 /// if present, from specified token. 447 void 448 extractSingletonRegisterForAsmOperand(unsigned i, const AsmMatcherInfo &Info, 449 std::string &RegisterPrefix); 450 451 /// findAsmOperand - Find the AsmOperand with the specified name and 452 /// suboperand index. 453 int findAsmOperand(StringRef N, int SubOpIdx) const { 454 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) 455 if (N == AsmOperands[i].SrcOpName && 456 SubOpIdx == AsmOperands[i].SubOpIdx) 457 return i; 458 return -1; 459 } 460 461 /// findAsmOperandNamed - Find the first AsmOperand with the specified name. 462 /// This does not check the suboperand index. 463 int findAsmOperandNamed(StringRef N) const { 464 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) 465 if (N == AsmOperands[i].SrcOpName) 466 return i; 467 return -1; 468 } 469 470 void buildInstructionResultOperands(); 471 void buildAliasResultOperands(); 472 473 /// operator< - Compare two matchables. 474 bool operator<(const MatchableInfo &RHS) const { 475 // The primary comparator is the instruction mnemonic. 476 if (Mnemonic != RHS.Mnemonic) 477 return Mnemonic < RHS.Mnemonic; 478 479 if (AsmOperands.size() != RHS.AsmOperands.size()) 480 return AsmOperands.size() < RHS.AsmOperands.size(); 481 482 // Compare lexicographically by operand. The matcher validates that other 483 // orderings wouldn't be ambiguous using \see couldMatchAmbiguouslyWith(). 484 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) { 485 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class) 486 return true; 487 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class) 488 return false; 489 } 490 491 // Give matches that require more features higher precedence. This is useful 492 // because we cannot define AssemblerPredicates with the negation of 493 // processor features. For example, ARM v6 "nop" may be either a HINT or 494 // MOV. With v6, we want to match HINT. The assembler has no way to 495 // predicate MOV under "NoV6", but HINT will always match first because it 496 // requires V6 while MOV does not. 497 if (RequiredFeatures.size() != RHS.RequiredFeatures.size()) 498 return RequiredFeatures.size() > RHS.RequiredFeatures.size(); 499 500 return false; 501 } 502 503 /// couldMatchAmbiguouslyWith - Check whether this matchable could 504 /// ambiguously match the same set of operands as \arg RHS (without being a 505 /// strictly superior match). 506 bool couldMatchAmbiguouslyWith(const MatchableInfo &RHS) { 507 // The primary comparator is the instruction mnemonic. 508 if (Mnemonic != RHS.Mnemonic) 509 return false; 510 511 // The number of operands is unambiguous. 512 if (AsmOperands.size() != RHS.AsmOperands.size()) 513 return false; 514 515 // Otherwise, make sure the ordering of the two instructions is unambiguous 516 // by checking that either (a) a token or operand kind discriminates them, 517 // or (b) the ordering among equivalent kinds is consistent. 518 519 // Tokens and operand kinds are unambiguous (assuming a correct target 520 // specific parser). 521 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) 522 if (AsmOperands[i].Class->Kind != RHS.AsmOperands[i].Class->Kind || 523 AsmOperands[i].Class->Kind == ClassInfo::Token) 524 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class || 525 *RHS.AsmOperands[i].Class < *AsmOperands[i].Class) 526 return false; 527 528 // Otherwise, this operand could commute if all operands are equivalent, or 529 // there is a pair of operands that compare less than and a pair that 530 // compare greater than. 531 bool HasLT = false, HasGT = false; 532 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) { 533 if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class) 534 HasLT = true; 535 if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class) 536 HasGT = true; 537 } 538 539 return !(HasLT ^ HasGT); 540 } 541 542 void dump(); 543 544private: 545 void tokenizeAsmString(const AsmMatcherInfo &Info); 546}; 547 548/// SubtargetFeatureInfo - Helper class for storing information on a subtarget 549/// feature which participates in instruction matching. 550struct SubtargetFeatureInfo { 551 /// \brief The predicate record for this feature. 552 Record *TheDef; 553 554 /// \brief An unique index assigned to represent this feature. 555 unsigned Index; 556 557 SubtargetFeatureInfo(Record *D, unsigned Idx) : TheDef(D), Index(Idx) {} 558 559 /// \brief The name of the enumerated constant identifying this feature. 560 std::string getEnumName() const { 561 return "Feature_" + TheDef->getName(); 562 } 563}; 564 565struct OperandMatchEntry { 566 unsigned OperandMask; 567 MatchableInfo* MI; 568 ClassInfo *CI; 569 570 static OperandMatchEntry create(MatchableInfo* mi, ClassInfo *ci, 571 unsigned opMask) { 572 OperandMatchEntry X; 573 X.OperandMask = opMask; 574 X.CI = ci; 575 X.MI = mi; 576 return X; 577 } 578}; 579 580 581class AsmMatcherInfo { 582public: 583 /// Tracked Records 584 RecordKeeper &Records; 585 586 /// The tablegen AsmParser record. 587 Record *AsmParser; 588 589 /// Target - The target information. 590 CodeGenTarget &Target; 591 592 /// The classes which are needed for matching. 593 std::vector<ClassInfo*> Classes; 594 595 /// The information on the matchables to match. 596 std::vector<MatchableInfo*> Matchables; 597 598 /// Info for custom matching operands by user defined methods. 599 std::vector<OperandMatchEntry> OperandMatchInfo; 600 601 /// Map of Register records to their class information. 602 std::map<Record*, ClassInfo*> RegisterClasses; 603 604 /// Map of Predicate records to their subtarget information. 605 std::map<Record*, SubtargetFeatureInfo*> SubtargetFeatures; 606 607 /// Map of AsmOperandClass records to their class information. 608 std::map<Record*, ClassInfo*> AsmOperandClasses; 609 610private: 611 /// Map of token to class information which has already been constructed. 612 std::map<std::string, ClassInfo*> TokenClasses; 613 614 /// Map of RegisterClass records to their class information. 615 std::map<Record*, ClassInfo*> RegisterClassClasses; 616 617private: 618 /// getTokenClass - Lookup or create the class for the given token. 619 ClassInfo *getTokenClass(StringRef Token); 620 621 /// getOperandClass - Lookup or create the class for the given operand. 622 ClassInfo *getOperandClass(const CGIOperandList::OperandInfo &OI, 623 int SubOpIdx); 624 ClassInfo *getOperandClass(Record *Rec, int SubOpIdx); 625 626 /// buildRegisterClasses - Build the ClassInfo* instances for register 627 /// classes. 628 void buildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters); 629 630 /// buildOperandClasses - Build the ClassInfo* instances for user defined 631 /// operand classes. 632 void buildOperandClasses(); 633 634 void buildInstructionOperandReference(MatchableInfo *II, StringRef OpName, 635 unsigned AsmOpIdx); 636 void buildAliasOperandReference(MatchableInfo *II, StringRef OpName, 637 MatchableInfo::AsmOperand &Op); 638 639public: 640 AsmMatcherInfo(Record *AsmParser, 641 CodeGenTarget &Target, 642 RecordKeeper &Records); 643 644 /// buildInfo - Construct the various tables used during matching. 645 void buildInfo(); 646 647 /// buildOperandMatchInfo - Build the necessary information to handle user 648 /// defined operand parsing methods. 649 void buildOperandMatchInfo(); 650 651 /// getSubtargetFeature - Lookup or create the subtarget feature info for the 652 /// given operand. 653 SubtargetFeatureInfo *getSubtargetFeature(Record *Def) const { 654 assert(Def->isSubClassOf("Predicate") && "Invalid predicate type!"); 655 std::map<Record*, SubtargetFeatureInfo*>::const_iterator I = 656 SubtargetFeatures.find(Def); 657 return I == SubtargetFeatures.end() ? 0 : I->second; 658 } 659 660 RecordKeeper &getRecords() const { 661 return Records; 662 } 663}; 664 665} // End anonymous namespace 666 667void MatchableInfo::dump() { 668 errs() << TheDef->getName() << " -- " << "flattened:\"" << AsmString <<"\"\n"; 669 670 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) { 671 AsmOperand &Op = AsmOperands[i]; 672 errs() << " op[" << i << "] = " << Op.Class->ClassName << " - "; 673 errs() << '\"' << Op.Token << "\"\n"; 674 } 675} 676 677static std::pair<StringRef, StringRef> 678parseTwoOperandConstraint(StringRef S, ArrayRef<SMLoc> Loc) { 679 // Split via the '='. 680 std::pair<StringRef, StringRef> Ops = S.split('='); 681 if (Ops.second == "") 682 throw TGError(Loc, "missing '=' in two-operand alias constraint"); 683 // Trim whitespace and the leading '$' on the operand names. 684 size_t start = Ops.first.find_first_of('$'); 685 if (start == std::string::npos) 686 throw TGError(Loc, "expected '$' prefix on asm operand name"); 687 Ops.first = Ops.first.slice(start + 1, std::string::npos); 688 size_t end = Ops.first.find_last_of(" \t"); 689 Ops.first = Ops.first.slice(0, end); 690 // Now the second operand. 691 start = Ops.second.find_first_of('$'); 692 if (start == std::string::npos) 693 throw TGError(Loc, "expected '$' prefix on asm operand name"); 694 Ops.second = Ops.second.slice(start + 1, std::string::npos); 695 end = Ops.second.find_last_of(" \t"); 696 Ops.first = Ops.first.slice(0, end); 697 return Ops; 698} 699 700void MatchableInfo::formTwoOperandAlias(StringRef Constraint) { 701 // Figure out which operands are aliased and mark them as tied. 702 std::pair<StringRef, StringRef> Ops = 703 parseTwoOperandConstraint(Constraint, TheDef->getLoc()); 704 705 // Find the AsmOperands that refer to the operands we're aliasing. 706 int SrcAsmOperand = findAsmOperandNamed(Ops.first); 707 int DstAsmOperand = findAsmOperandNamed(Ops.second); 708 if (SrcAsmOperand == -1) 709 throw TGError(TheDef->getLoc(), 710 "unknown source two-operand alias operand '" + 711 Ops.first.str() + "'."); 712 if (DstAsmOperand == -1) 713 throw TGError(TheDef->getLoc(), 714 "unknown destination two-operand alias operand '" + 715 Ops.second.str() + "'."); 716 717 // Find the ResOperand that refers to the operand we're aliasing away 718 // and update it to refer to the combined operand instead. 719 for (unsigned i = 0, e = ResOperands.size(); i != e; ++i) { 720 ResOperand &Op = ResOperands[i]; 721 if (Op.Kind == ResOperand::RenderAsmOperand && 722 Op.AsmOperandNum == (unsigned)SrcAsmOperand) { 723 Op.AsmOperandNum = DstAsmOperand; 724 break; 725 } 726 } 727 // Remove the AsmOperand for the alias operand. 728 AsmOperands.erase(AsmOperands.begin() + SrcAsmOperand); 729 // Adjust the ResOperand references to any AsmOperands that followed 730 // the one we just deleted. 731 for (unsigned i = 0, e = ResOperands.size(); i != e; ++i) { 732 ResOperand &Op = ResOperands[i]; 733 switch(Op.Kind) { 734 default: 735 // Nothing to do for operands that don't reference AsmOperands. 736 break; 737 case ResOperand::RenderAsmOperand: 738 if (Op.AsmOperandNum > (unsigned)SrcAsmOperand) 739 --Op.AsmOperandNum; 740 break; 741 case ResOperand::TiedOperand: 742 if (Op.TiedOperandNum > (unsigned)SrcAsmOperand) 743 --Op.TiedOperandNum; 744 break; 745 } 746 } 747} 748 749void MatchableInfo::initialize(const AsmMatcherInfo &Info, 750 SmallPtrSet<Record*, 16> &SingletonRegisters, 751 int AsmVariantNo, std::string &RegisterPrefix) { 752 AsmVariantID = AsmVariantNo; 753 AsmString = 754 CodeGenInstruction::FlattenAsmStringVariants(AsmString, AsmVariantNo); 755 756 tokenizeAsmString(Info); 757 758 // Compute the require features. 759 std::vector<Record*> Predicates =TheDef->getValueAsListOfDefs("Predicates"); 760 for (unsigned i = 0, e = Predicates.size(); i != e; ++i) 761 if (SubtargetFeatureInfo *Feature = 762 Info.getSubtargetFeature(Predicates[i])) 763 RequiredFeatures.push_back(Feature); 764 765 // Collect singleton registers, if used. 766 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) { 767 extractSingletonRegisterForAsmOperand(i, Info, RegisterPrefix); 768 if (Record *Reg = AsmOperands[i].SingletonReg) 769 SingletonRegisters.insert(Reg); 770 } 771} 772 773/// tokenizeAsmString - Tokenize a simplified assembly string. 774void MatchableInfo::tokenizeAsmString(const AsmMatcherInfo &Info) { 775 StringRef String = AsmString; 776 unsigned Prev = 0; 777 bool InTok = true; 778 for (unsigned i = 0, e = String.size(); i != e; ++i) { 779 switch (String[i]) { 780 case '[': 781 case ']': 782 case '*': 783 case '!': 784 case ' ': 785 case '\t': 786 case ',': 787 if (InTok) { 788 AsmOperands.push_back(AsmOperand(String.slice(Prev, i))); 789 InTok = false; 790 } 791 if (!isspace(String[i]) && String[i] != ',') 792 AsmOperands.push_back(AsmOperand(String.substr(i, 1))); 793 Prev = i + 1; 794 break; 795 796 case '\\': 797 if (InTok) { 798 AsmOperands.push_back(AsmOperand(String.slice(Prev, i))); 799 InTok = false; 800 } 801 ++i; 802 assert(i != String.size() && "Invalid quoted character"); 803 AsmOperands.push_back(AsmOperand(String.substr(i, 1))); 804 Prev = i + 1; 805 break; 806 807 case '$': { 808 if (InTok) { 809 AsmOperands.push_back(AsmOperand(String.slice(Prev, i))); 810 InTok = false; 811 } 812 813 // If this isn't "${", treat like a normal token. 814 if (i + 1 == String.size() || String[i + 1] != '{') { 815 Prev = i; 816 break; 817 } 818 819 StringRef::iterator End = std::find(String.begin() + i, String.end(),'}'); 820 assert(End != String.end() && "Missing brace in operand reference!"); 821 size_t EndPos = End - String.begin(); 822 AsmOperands.push_back(AsmOperand(String.slice(i, EndPos+1))); 823 Prev = EndPos + 1; 824 i = EndPos; 825 break; 826 } 827 828 case '.': 829 if (InTok) 830 AsmOperands.push_back(AsmOperand(String.slice(Prev, i))); 831 Prev = i; 832 InTok = true; 833 break; 834 835 default: 836 InTok = true; 837 } 838 } 839 if (InTok && Prev != String.size()) 840 AsmOperands.push_back(AsmOperand(String.substr(Prev))); 841 842 // The first token of the instruction is the mnemonic, which must be a 843 // simple string, not a $foo variable or a singleton register. 844 if (AsmOperands.empty()) 845 throw TGError(TheDef->getLoc(), 846 "Instruction '" + TheDef->getName() + "' has no tokens"); 847 Mnemonic = AsmOperands[0].Token; 848 if (Mnemonic.empty()) 849 throw TGError(TheDef->getLoc(), 850 "Missing instruction mnemonic"); 851 // FIXME : Check and raise an error if it is a register. 852 if (Mnemonic[0] == '$') 853 throw TGError(TheDef->getLoc(), 854 "Invalid instruction mnemonic '" + Mnemonic.str() + "'!"); 855 856 // Remove the first operand, it is tracked in the mnemonic field. 857 AsmOperands.erase(AsmOperands.begin()); 858} 859 860bool MatchableInfo::validate(StringRef CommentDelimiter, bool Hack) const { 861 // Reject matchables with no .s string. 862 if (AsmString.empty()) 863 throw TGError(TheDef->getLoc(), "instruction with empty asm string"); 864 865 // Reject any matchables with a newline in them, they should be marked 866 // isCodeGenOnly if they are pseudo instructions. 867 if (AsmString.find('\n') != std::string::npos) 868 throw TGError(TheDef->getLoc(), 869 "multiline instruction is not valid for the asmparser, " 870 "mark it isCodeGenOnly"); 871 872 // Remove comments from the asm string. We know that the asmstring only 873 // has one line. 874 if (!CommentDelimiter.empty() && 875 StringRef(AsmString).find(CommentDelimiter) != StringRef::npos) 876 throw TGError(TheDef->getLoc(), 877 "asmstring for instruction has comment character in it, " 878 "mark it isCodeGenOnly"); 879 880 // Reject matchables with operand modifiers, these aren't something we can 881 // handle, the target should be refactored to use operands instead of 882 // modifiers. 883 // 884 // Also, check for instructions which reference the operand multiple times; 885 // this implies a constraint we would not honor. 886 std::set<std::string> OperandNames; 887 for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) { 888 StringRef Tok = AsmOperands[i].Token; 889 if (Tok[0] == '$' && Tok.find(':') != StringRef::npos) 890 throw TGError(TheDef->getLoc(), 891 "matchable with operand modifier '" + Tok.str() + 892 "' not supported by asm matcher. Mark isCodeGenOnly!"); 893 894 // Verify that any operand is only mentioned once. 895 // We reject aliases and ignore instructions for now. 896 if (Tok[0] == '$' && !OperandNames.insert(Tok).second) { 897 if (!Hack) 898 throw TGError(TheDef->getLoc(), 899 "ERROR: matchable with tied operand '" + Tok.str() + 900 "' can never be matched!"); 901 // FIXME: Should reject these. The ARM backend hits this with $lane in a 902 // bunch of instructions. It is unclear what the right answer is. 903 DEBUG({ 904 errs() << "warning: '" << TheDef->getName() << "': " 905 << "ignoring instruction with tied operand '" 906 << Tok.str() << "'\n"; 907 }); 908 return false; 909 } 910 } 911 912 return true; 913} 914 915/// extractSingletonRegisterForAsmOperand - Extract singleton register, 916/// if present, from specified token. 917void MatchableInfo:: 918extractSingletonRegisterForAsmOperand(unsigned OperandNo, 919 const AsmMatcherInfo &Info, 920 std::string &RegisterPrefix) { 921 StringRef Tok = AsmOperands[OperandNo].Token; 922 if (RegisterPrefix.empty()) { 923 std::string LoweredTok = Tok.lower(); 924 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(LoweredTok)) 925 AsmOperands[OperandNo].SingletonReg = Reg->TheDef; 926 return; 927 } 928 929 if (!Tok.startswith(RegisterPrefix)) 930 return; 931 932 StringRef RegName = Tok.substr(RegisterPrefix.size()); 933 if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(RegName)) 934 AsmOperands[OperandNo].SingletonReg = Reg->TheDef; 935 936 // If there is no register prefix (i.e. "%" in "%eax"), then this may 937 // be some random non-register token, just ignore it. 938 return; 939} 940 941static std::string getEnumNameForToken(StringRef Str) { 942 std::string Res; 943 944 for (StringRef::iterator it = Str.begin(), ie = Str.end(); it != ie; ++it) { 945 switch (*it) { 946 case '*': Res += "_STAR_"; break; 947 case '%': Res += "_PCT_"; break; 948 case ':': Res += "_COLON_"; break; 949 case '!': Res += "_EXCLAIM_"; break; 950 case '.': Res += "_DOT_"; break; 951 default: 952 if (isalnum(*it)) 953 Res += *it; 954 else 955 Res += "_" + utostr((unsigned) *it) + "_"; 956 } 957 } 958 959 return Res; 960} 961 962ClassInfo *AsmMatcherInfo::getTokenClass(StringRef Token) { 963 ClassInfo *&Entry = TokenClasses[Token]; 964 965 if (!Entry) { 966 Entry = new ClassInfo(); 967 Entry->Kind = ClassInfo::Token; 968 Entry->ClassName = "Token"; 969 Entry->Name = "MCK_" + getEnumNameForToken(Token); 970 Entry->ValueName = Token; 971 Entry->PredicateMethod = "<invalid>"; 972 Entry->RenderMethod = "<invalid>"; 973 Entry->ParserMethod = ""; 974 Entry->DiagnosticType = ""; 975 Classes.push_back(Entry); 976 } 977 978 return Entry; 979} 980 981ClassInfo * 982AsmMatcherInfo::getOperandClass(const CGIOperandList::OperandInfo &OI, 983 int SubOpIdx) { 984 Record *Rec = OI.Rec; 985 if (SubOpIdx != -1) 986 Rec = dynamic_cast<DefInit*>(OI.MIOperandInfo->getArg(SubOpIdx))->getDef(); 987 return getOperandClass(Rec, SubOpIdx); 988} 989 990ClassInfo * 991AsmMatcherInfo::getOperandClass(Record *Rec, int SubOpIdx) { 992 if (Rec->isSubClassOf("RegisterOperand")) { 993 // RegisterOperand may have an associated ParserMatchClass. If it does, 994 // use it, else just fall back to the underlying register class. 995 const RecordVal *R = Rec->getValue("ParserMatchClass"); 996 if (R == 0 || R->getValue() == 0) 997 throw "Record `" + Rec->getName() + 998 "' does not have a ParserMatchClass!\n"; 999 1000 if (DefInit *DI= dynamic_cast<DefInit*>(R->getValue())) { 1001 Record *MatchClass = DI->getDef(); 1002 if (ClassInfo *CI = AsmOperandClasses[MatchClass]) 1003 return CI; 1004 } 1005 1006 // No custom match class. Just use the register class. 1007 Record *ClassRec = Rec->getValueAsDef("RegClass"); 1008 if (!ClassRec) 1009 throw TGError(Rec->getLoc(), "RegisterOperand `" + Rec->getName() + 1010 "' has no associated register class!\n"); 1011 if (ClassInfo *CI = RegisterClassClasses[ClassRec]) 1012 return CI; 1013 throw TGError(Rec->getLoc(), "register class has no class info!"); 1014 } 1015 1016 1017 if (Rec->isSubClassOf("RegisterClass")) { 1018 if (ClassInfo *CI = RegisterClassClasses[Rec]) 1019 return CI; 1020 throw TGError(Rec->getLoc(), "register class has no class info!"); 1021 } 1022 1023 assert(Rec->isSubClassOf("Operand") && "Unexpected operand!"); 1024 Record *MatchClass = Rec->getValueAsDef("ParserMatchClass"); 1025 if (ClassInfo *CI = AsmOperandClasses[MatchClass]) 1026 return CI; 1027 1028 throw TGError(Rec->getLoc(), "operand has no match class!"); 1029} 1030 1031void AsmMatcherInfo:: 1032buildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters) { 1033 const std::vector<CodeGenRegister*> &Registers = 1034 Target.getRegBank().getRegisters(); 1035 ArrayRef<CodeGenRegisterClass*> RegClassList = 1036 Target.getRegBank().getRegClasses(); 1037 1038 // The register sets used for matching. 1039 std::set< std::set<Record*> > RegisterSets; 1040 1041 // Gather the defined sets. 1042 for (ArrayRef<CodeGenRegisterClass*>::const_iterator it = 1043 RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it) 1044 RegisterSets.insert(std::set<Record*>( 1045 (*it)->getOrder().begin(), (*it)->getOrder().end())); 1046 1047 // Add any required singleton sets. 1048 for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(), 1049 ie = SingletonRegisters.end(); it != ie; ++it) { 1050 Record *Rec = *it; 1051 RegisterSets.insert(std::set<Record*>(&Rec, &Rec + 1)); 1052 } 1053 1054 // Introduce derived sets where necessary (when a register does not determine 1055 // a unique register set class), and build the mapping of registers to the set 1056 // they should classify to. 1057 std::map<Record*, std::set<Record*> > RegisterMap; 1058 for (std::vector<CodeGenRegister*>::const_iterator it = Registers.begin(), 1059 ie = Registers.end(); it != ie; ++it) { 1060 const CodeGenRegister &CGR = **it; 1061 // Compute the intersection of all sets containing this register. 1062 std::set<Record*> ContainingSet; 1063 1064 for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(), 1065 ie = RegisterSets.end(); it != ie; ++it) { 1066 if (!it->count(CGR.TheDef)) 1067 continue; 1068 1069 if (ContainingSet.empty()) { 1070 ContainingSet = *it; 1071 continue; 1072 } 1073 1074 std::set<Record*> Tmp; 1075 std::swap(Tmp, ContainingSet); 1076 std::insert_iterator< std::set<Record*> > II(ContainingSet, 1077 ContainingSet.begin()); 1078 std::set_intersection(Tmp.begin(), Tmp.end(), it->begin(), it->end(), II); 1079 } 1080 1081 if (!ContainingSet.empty()) { 1082 RegisterSets.insert(ContainingSet); 1083 RegisterMap.insert(std::make_pair(CGR.TheDef, ContainingSet)); 1084 } 1085 } 1086 1087 // Construct the register classes. 1088 std::map<std::set<Record*>, ClassInfo*> RegisterSetClasses; 1089 unsigned Index = 0; 1090 for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(), 1091 ie = RegisterSets.end(); it != ie; ++it, ++Index) { 1092 ClassInfo *CI = new ClassInfo(); 1093 CI->Kind = ClassInfo::RegisterClass0 + Index; 1094 CI->ClassName = "Reg" + utostr(Index); 1095 CI->Name = "MCK_Reg" + utostr(Index); 1096 CI->ValueName = ""; 1097 CI->PredicateMethod = ""; // unused 1098 CI->RenderMethod = "addRegOperands"; 1099 CI->Registers = *it; 1100 // FIXME: diagnostic type. 1101 CI->DiagnosticType = ""; 1102 Classes.push_back(CI); 1103 RegisterSetClasses.insert(std::make_pair(*it, CI)); 1104 } 1105 1106 // Find the superclasses; we could compute only the subgroup lattice edges, 1107 // but there isn't really a point. 1108 for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(), 1109 ie = RegisterSets.end(); it != ie; ++it) { 1110 ClassInfo *CI = RegisterSetClasses[*it]; 1111 for (std::set< std::set<Record*> >::iterator it2 = RegisterSets.begin(), 1112 ie2 = RegisterSets.end(); it2 != ie2; ++it2) 1113 if (*it != *it2 && 1114 std::includes(it2->begin(), it2->end(), it->begin(), it->end())) 1115 CI->SuperClasses.push_back(RegisterSetClasses[*it2]); 1116 } 1117 1118 // Name the register classes which correspond to a user defined RegisterClass. 1119 for (ArrayRef<CodeGenRegisterClass*>::const_iterator 1120 it = RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it) { 1121 const CodeGenRegisterClass &RC = **it; 1122 // Def will be NULL for non-user defined register classes. 1123 Record *Def = RC.getDef(); 1124 if (!Def) 1125 continue; 1126 ClassInfo *CI = RegisterSetClasses[std::set<Record*>(RC.getOrder().begin(), 1127 RC.getOrder().end())]; 1128 if (CI->ValueName.empty()) { 1129 CI->ClassName = RC.getName(); 1130 CI->Name = "MCK_" + RC.getName(); 1131 CI->ValueName = RC.getName(); 1132 } else 1133 CI->ValueName = CI->ValueName + "," + RC.getName(); 1134 1135 RegisterClassClasses.insert(std::make_pair(Def, CI)); 1136 } 1137 1138 // Populate the map for individual registers. 1139 for (std::map<Record*, std::set<Record*> >::iterator it = RegisterMap.begin(), 1140 ie = RegisterMap.end(); it != ie; ++it) 1141 RegisterClasses[it->first] = RegisterSetClasses[it->second]; 1142 1143 // Name the register classes which correspond to singleton registers. 1144 for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(), 1145 ie = SingletonRegisters.end(); it != ie; ++it) { 1146 Record *Rec = *it; 1147 ClassInfo *CI = RegisterClasses[Rec]; 1148 assert(CI && "Missing singleton register class info!"); 1149 1150 if (CI->ValueName.empty()) { 1151 CI->ClassName = Rec->getName(); 1152 CI->Name = "MCK_" + Rec->getName(); 1153 CI->ValueName = Rec->getName(); 1154 } else 1155 CI->ValueName = CI->ValueName + "," + Rec->getName(); 1156 } 1157} 1158 1159void AsmMatcherInfo::buildOperandClasses() { 1160 std::vector<Record*> AsmOperands = 1161 Records.getAllDerivedDefinitions("AsmOperandClass"); 1162 1163 // Pre-populate AsmOperandClasses map. 1164 for (std::vector<Record*>::iterator it = AsmOperands.begin(), 1165 ie = AsmOperands.end(); it != ie; ++it) 1166 AsmOperandClasses[*it] = new ClassInfo(); 1167 1168 unsigned Index = 0; 1169 for (std::vector<Record*>::iterator it = AsmOperands.begin(), 1170 ie = AsmOperands.end(); it != ie; ++it, ++Index) { 1171 ClassInfo *CI = AsmOperandClasses[*it]; 1172 CI->Kind = ClassInfo::UserClass0 + Index; 1173 1174 ListInit *Supers = (*it)->getValueAsListInit("SuperClasses"); 1175 for (unsigned i = 0, e = Supers->getSize(); i != e; ++i) { 1176 DefInit *DI = dynamic_cast<DefInit*>(Supers->getElement(i)); 1177 if (!DI) { 1178 PrintError((*it)->getLoc(), "Invalid super class reference!"); 1179 continue; 1180 } 1181 1182 ClassInfo *SC = AsmOperandClasses[DI->getDef()]; 1183 if (!SC) 1184 PrintError((*it)->getLoc(), "Invalid super class reference!"); 1185 else 1186 CI->SuperClasses.push_back(SC); 1187 } 1188 CI->ClassName = (*it)->getValueAsString("Name"); 1189 CI->Name = "MCK_" + CI->ClassName; 1190 CI->ValueName = (*it)->getName(); 1191 1192 // Get or construct the predicate method name. 1193 Init *PMName = (*it)->getValueInit("PredicateMethod"); 1194 if (StringInit *SI = dynamic_cast<StringInit*>(PMName)) { 1195 CI->PredicateMethod = SI->getValue(); 1196 } else { 1197 assert(dynamic_cast<UnsetInit*>(PMName) && 1198 "Unexpected PredicateMethod field!"); 1199 CI->PredicateMethod = "is" + CI->ClassName; 1200 } 1201 1202 // Get or construct the render method name. 1203 Init *RMName = (*it)->getValueInit("RenderMethod"); 1204 if (StringInit *SI = dynamic_cast<StringInit*>(RMName)) { 1205 CI->RenderMethod = SI->getValue(); 1206 } else { 1207 assert(dynamic_cast<UnsetInit*>(RMName) && 1208 "Unexpected RenderMethod field!"); 1209 CI->RenderMethod = "add" + CI->ClassName + "Operands"; 1210 } 1211 1212 // Get the parse method name or leave it as empty. 1213 Init *PRMName = (*it)->getValueInit("ParserMethod"); 1214 if (StringInit *SI = dynamic_cast<StringInit*>(PRMName)) 1215 CI->ParserMethod = SI->getValue(); 1216 1217 // Get the diagnostic type or leave it as empty. 1218 // Get the parse method name or leave it as empty. 1219 Init *DiagnosticType = (*it)->getValueInit("DiagnosticType"); 1220 if (StringInit *SI = dynamic_cast<StringInit*>(DiagnosticType)) 1221 CI->DiagnosticType = SI->getValue(); 1222 1223 AsmOperandClasses[*it] = CI; 1224 Classes.push_back(CI); 1225 } 1226} 1227 1228AsmMatcherInfo::AsmMatcherInfo(Record *asmParser, 1229 CodeGenTarget &target, 1230 RecordKeeper &records) 1231 : Records(records), AsmParser(asmParser), Target(target) { 1232} 1233 1234/// buildOperandMatchInfo - Build the necessary information to handle user 1235/// defined operand parsing methods. 1236void AsmMatcherInfo::buildOperandMatchInfo() { 1237 1238 /// Map containing a mask with all operands indices that can be found for 1239 /// that class inside a instruction. 1240 std::map<ClassInfo*, unsigned> OpClassMask; 1241 1242 for (std::vector<MatchableInfo*>::const_iterator it = 1243 Matchables.begin(), ie = Matchables.end(); 1244 it != ie; ++it) { 1245 MatchableInfo &II = **it; 1246 OpClassMask.clear(); 1247 1248 // Keep track of all operands of this instructions which belong to the 1249 // same class. 1250 for (unsigned i = 0, e = II.AsmOperands.size(); i != e; ++i) { 1251 MatchableInfo::AsmOperand &Op = II.AsmOperands[i]; 1252 if (Op.Class->ParserMethod.empty()) 1253 continue; 1254 unsigned &OperandMask = OpClassMask[Op.Class]; 1255 OperandMask |= (1 << i); 1256 } 1257 1258 // Generate operand match info for each mnemonic/operand class pair. 1259 for (std::map<ClassInfo*, unsigned>::iterator iit = OpClassMask.begin(), 1260 iie = OpClassMask.end(); iit != iie; ++iit) { 1261 unsigned OpMask = iit->second; 1262 ClassInfo *CI = iit->first; 1263 OperandMatchInfo.push_back(OperandMatchEntry::create(&II, CI, OpMask)); 1264 } 1265 } 1266} 1267 1268void AsmMatcherInfo::buildInfo() { 1269 // Build information about all of the AssemblerPredicates. 1270 std::vector<Record*> AllPredicates = 1271 Records.getAllDerivedDefinitions("Predicate"); 1272 for (unsigned i = 0, e = AllPredicates.size(); i != e; ++i) { 1273 Record *Pred = AllPredicates[i]; 1274 // Ignore predicates that are not intended for the assembler. 1275 if (!Pred->getValueAsBit("AssemblerMatcherPredicate")) 1276 continue; 1277 1278 if (Pred->getName().empty()) 1279 throw TGError(Pred->getLoc(), "Predicate has no name!"); 1280 1281 unsigned FeatureNo = SubtargetFeatures.size(); 1282 SubtargetFeatures[Pred] = new SubtargetFeatureInfo(Pred, FeatureNo); 1283 assert(FeatureNo < 32 && "Too many subtarget features!"); 1284 } 1285 1286 // Parse the instructions; we need to do this first so that we can gather the 1287 // singleton register classes. 1288 SmallPtrSet<Record*, 16> SingletonRegisters; 1289 unsigned VariantCount = Target.getAsmParserVariantCount(); 1290 for (unsigned VC = 0; VC != VariantCount; ++VC) { 1291 Record *AsmVariant = Target.getAsmParserVariant(VC); 1292 std::string CommentDelimiter = 1293 AsmVariant->getValueAsString("CommentDelimiter"); 1294 std::string RegisterPrefix = AsmVariant->getValueAsString("RegisterPrefix"); 1295 int AsmVariantNo = AsmVariant->getValueAsInt("Variant"); 1296 1297 for (CodeGenTarget::inst_iterator I = Target.inst_begin(), 1298 E = Target.inst_end(); I != E; ++I) { 1299 const CodeGenInstruction &CGI = **I; 1300 1301 // If the tblgen -match-prefix option is specified (for tblgen hackers), 1302 // filter the set of instructions we consider. 1303 if (!StringRef(CGI.TheDef->getName()).startswith(MatchPrefix)) 1304 continue; 1305 1306 // Ignore "codegen only" instructions. 1307 if (CGI.TheDef->getValueAsBit("isCodeGenOnly")) 1308 continue; 1309 1310 // Validate the operand list to ensure we can handle this instruction. 1311 for (unsigned i = 0, e = CGI.Operands.size(); i != e; ++i) { 1312 const CGIOperandList::OperandInfo &OI = CGI.Operands[i]; 1313 1314 // Validate tied operands. 1315 if (OI.getTiedRegister() != -1) { 1316 // If we have a tied operand that consists of multiple MCOperands, 1317 // reject it. We reject aliases and ignore instructions for now. 1318 if (OI.MINumOperands != 1) { 1319 // FIXME: Should reject these. The ARM backend hits this with $lane 1320 // in a bunch of instructions. The right answer is unclear. 1321 DEBUG({ 1322 errs() << "warning: '" << CGI.TheDef->getName() << "': " 1323 << "ignoring instruction with multi-operand tied operand '" 1324 << OI.Name << "'\n"; 1325 }); 1326 continue; 1327 } 1328 } 1329 } 1330 1331 OwningPtr<MatchableInfo> II(new MatchableInfo(CGI)); 1332 1333 II->initialize(*this, SingletonRegisters, AsmVariantNo, RegisterPrefix); 1334 1335 // Ignore instructions which shouldn't be matched and diagnose invalid 1336 // instruction definitions with an error. 1337 if (!II->validate(CommentDelimiter, true)) 1338 continue; 1339 1340 // Ignore "Int_*" and "*_Int" instructions, which are internal aliases. 1341 // 1342 // FIXME: This is a total hack. 1343 if (StringRef(II->TheDef->getName()).startswith("Int_") || 1344 StringRef(II->TheDef->getName()).endswith("_Int")) 1345 continue; 1346 1347 Matchables.push_back(II.take()); 1348 } 1349 1350 // Parse all of the InstAlias definitions and stick them in the list of 1351 // matchables. 1352 std::vector<Record*> AllInstAliases = 1353 Records.getAllDerivedDefinitions("InstAlias"); 1354 for (unsigned i = 0, e = AllInstAliases.size(); i != e; ++i) { 1355 CodeGenInstAlias *Alias = new CodeGenInstAlias(AllInstAliases[i], Target); 1356 1357 // If the tblgen -match-prefix option is specified (for tblgen hackers), 1358 // filter the set of instruction aliases we consider, based on the target 1359 // instruction. 1360 if (!StringRef(Alias->ResultInst->TheDef->getName()) 1361 .startswith( MatchPrefix)) 1362 continue; 1363 1364 OwningPtr<MatchableInfo> II(new MatchableInfo(Alias)); 1365 1366 II->initialize(*this, SingletonRegisters, AsmVariantNo, RegisterPrefix); 1367 1368 // Validate the alias definitions. 1369 II->validate(CommentDelimiter, false); 1370 1371 Matchables.push_back(II.take()); 1372 } 1373 } 1374 1375 // Build info for the register classes. 1376 buildRegisterClasses(SingletonRegisters); 1377 1378 // Build info for the user defined assembly operand classes. 1379 buildOperandClasses(); 1380 1381 // Build the information about matchables, now that we have fully formed 1382 // classes. 1383 std::vector<MatchableInfo*> NewMatchables; 1384 for (std::vector<MatchableInfo*>::iterator it = Matchables.begin(), 1385 ie = Matchables.end(); it != ie; ++it) { 1386 MatchableInfo *II = *it; 1387 1388 // Parse the tokens after the mnemonic. 1389 // Note: buildInstructionOperandReference may insert new AsmOperands, so 1390 // don't precompute the loop bound. 1391 for (unsigned i = 0; i != II->AsmOperands.size(); ++i) { 1392 MatchableInfo::AsmOperand &Op = II->AsmOperands[i]; 1393 StringRef Token = Op.Token; 1394 1395 // Check for singleton registers. 1396 if (Record *RegRecord = II->AsmOperands[i].SingletonReg) { 1397 Op.Class = RegisterClasses[RegRecord]; 1398 assert(Op.Class && Op.Class->Registers.size() == 1 && 1399 "Unexpected class for singleton register"); 1400 continue; 1401 } 1402 1403 // Check for simple tokens. 1404 if (Token[0] != '$') { 1405 Op.Class = getTokenClass(Token); 1406 continue; 1407 } 1408 1409 if (Token.size() > 1 && isdigit(Token[1])) { 1410 Op.Class = getTokenClass(Token); 1411 continue; 1412 } 1413 1414 // Otherwise this is an operand reference. 1415 StringRef OperandName; 1416 if (Token[1] == '{') 1417 OperandName = Token.substr(2, Token.size() - 3); 1418 else 1419 OperandName = Token.substr(1); 1420 1421 if (II->DefRec.is<const CodeGenInstruction*>()) 1422 buildInstructionOperandReference(II, OperandName, i); 1423 else 1424 buildAliasOperandReference(II, OperandName, Op); 1425 } 1426 1427 if (II->DefRec.is<const CodeGenInstruction*>()) { 1428 II->buildInstructionResultOperands(); 1429 // If the instruction has a two-operand alias, build up the 1430 // matchable here. We'll add them in bulk at the end to avoid 1431 // confusing this loop. 1432 std::string Constraint = 1433 II->TheDef->getValueAsString("TwoOperandAliasConstraint"); 1434 if (Constraint != "") { 1435 // Start by making a copy of the original matchable. 1436 OwningPtr<MatchableInfo> AliasII(new MatchableInfo(*II)); 1437 1438 // Adjust it to be a two-operand alias. 1439 AliasII->formTwoOperandAlias(Constraint); 1440 1441 // Add the alias to the matchables list. 1442 NewMatchables.push_back(AliasII.take()); 1443 } 1444 } else 1445 II->buildAliasResultOperands(); 1446 } 1447 if (!NewMatchables.empty()) 1448 Matchables.insert(Matchables.end(), NewMatchables.begin(), 1449 NewMatchables.end()); 1450 1451 // Process token alias definitions and set up the associated superclass 1452 // information. 1453 std::vector<Record*> AllTokenAliases = 1454 Records.getAllDerivedDefinitions("TokenAlias"); 1455 for (unsigned i = 0, e = AllTokenAliases.size(); i != e; ++i) { 1456 Record *Rec = AllTokenAliases[i]; 1457 ClassInfo *FromClass = getTokenClass(Rec->getValueAsString("FromToken")); 1458 ClassInfo *ToClass = getTokenClass(Rec->getValueAsString("ToToken")); 1459 if (FromClass == ToClass) 1460 throw TGError(Rec->getLoc(), 1461 "error: Destination value identical to source value."); 1462 FromClass->SuperClasses.push_back(ToClass); 1463 } 1464 1465 // Reorder classes so that classes precede super classes. 1466 std::sort(Classes.begin(), Classes.end(), less_ptr<ClassInfo>()); 1467} 1468 1469/// buildInstructionOperandReference - The specified operand is a reference to a 1470/// named operand such as $src. Resolve the Class and OperandInfo pointers. 1471void AsmMatcherInfo:: 1472buildInstructionOperandReference(MatchableInfo *II, 1473 StringRef OperandName, 1474 unsigned AsmOpIdx) { 1475 const CodeGenInstruction &CGI = *II->DefRec.get<const CodeGenInstruction*>(); 1476 const CGIOperandList &Operands = CGI.Operands; 1477 MatchableInfo::AsmOperand *Op = &II->AsmOperands[AsmOpIdx]; 1478 1479 // Map this token to an operand. 1480 unsigned Idx; 1481 if (!Operands.hasOperandNamed(OperandName, Idx)) 1482 throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" + 1483 OperandName.str() + "'"); 1484 1485 // If the instruction operand has multiple suboperands, but the parser 1486 // match class for the asm operand is still the default "ImmAsmOperand", 1487 // then handle each suboperand separately. 1488 if (Op->SubOpIdx == -1 && Operands[Idx].MINumOperands > 1) { 1489 Record *Rec = Operands[Idx].Rec; 1490 assert(Rec->isSubClassOf("Operand") && "Unexpected operand!"); 1491 Record *MatchClass = Rec->getValueAsDef("ParserMatchClass"); 1492 if (MatchClass && MatchClass->getValueAsString("Name") == "Imm") { 1493 // Insert remaining suboperands after AsmOpIdx in II->AsmOperands. 1494 StringRef Token = Op->Token; // save this in case Op gets moved 1495 for (unsigned SI = 1, SE = Operands[Idx].MINumOperands; SI != SE; ++SI) { 1496 MatchableInfo::AsmOperand NewAsmOp(Token); 1497 NewAsmOp.SubOpIdx = SI; 1498 II->AsmOperands.insert(II->AsmOperands.begin()+AsmOpIdx+SI, NewAsmOp); 1499 } 1500 // Replace Op with first suboperand. 1501 Op = &II->AsmOperands[AsmOpIdx]; // update the pointer in case it moved 1502 Op->SubOpIdx = 0; 1503 } 1504 } 1505 1506 // Set up the operand class. 1507 Op->Class = getOperandClass(Operands[Idx], Op->SubOpIdx); 1508 1509 // If the named operand is tied, canonicalize it to the untied operand. 1510 // For example, something like: 1511 // (outs GPR:$dst), (ins GPR:$src) 1512 // with an asmstring of 1513 // "inc $src" 1514 // we want to canonicalize to: 1515 // "inc $dst" 1516 // so that we know how to provide the $dst operand when filling in the result. 1517 int OITied = Operands[Idx].getTiedRegister(); 1518 if (OITied != -1) { 1519 // The tied operand index is an MIOperand index, find the operand that 1520 // contains it. 1521 std::pair<unsigned, unsigned> Idx = Operands.getSubOperandNumber(OITied); 1522 OperandName = Operands[Idx.first].Name; 1523 Op->SubOpIdx = Idx.second; 1524 } 1525 1526 Op->SrcOpName = OperandName; 1527} 1528 1529/// buildAliasOperandReference - When parsing an operand reference out of the 1530/// matching string (e.g. "movsx $src, $dst"), determine what the class of the 1531/// operand reference is by looking it up in the result pattern definition. 1532void AsmMatcherInfo::buildAliasOperandReference(MatchableInfo *II, 1533 StringRef OperandName, 1534 MatchableInfo::AsmOperand &Op) { 1535 const CodeGenInstAlias &CGA = *II->DefRec.get<const CodeGenInstAlias*>(); 1536 1537 // Set up the operand class. 1538 for (unsigned i = 0, e = CGA.ResultOperands.size(); i != e; ++i) 1539 if (CGA.ResultOperands[i].isRecord() && 1540 CGA.ResultOperands[i].getName() == OperandName) { 1541 // It's safe to go with the first one we find, because CodeGenInstAlias 1542 // validates that all operands with the same name have the same record. 1543 Op.SubOpIdx = CGA.ResultInstOperandIndex[i].second; 1544 // Use the match class from the Alias definition, not the 1545 // destination instruction, as we may have an immediate that's 1546 // being munged by the match class. 1547 Op.Class = getOperandClass(CGA.ResultOperands[i].getRecord(), 1548 Op.SubOpIdx); 1549 Op.SrcOpName = OperandName; 1550 return; 1551 } 1552 1553 throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" + 1554 OperandName.str() + "'"); 1555} 1556 1557void MatchableInfo::buildInstructionResultOperands() { 1558 const CodeGenInstruction *ResultInst = getResultInst(); 1559 1560 // Loop over all operands of the result instruction, determining how to 1561 // populate them. 1562 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) { 1563 const CGIOperandList::OperandInfo &OpInfo = ResultInst->Operands[i]; 1564 1565 // If this is a tied operand, just copy from the previously handled operand. 1566 int TiedOp = OpInfo.getTiedRegister(); 1567 if (TiedOp != -1) { 1568 ResOperands.push_back(ResOperand::getTiedOp(TiedOp)); 1569 continue; 1570 } 1571 1572 // Find out what operand from the asmparser this MCInst operand comes from. 1573 int SrcOperand = findAsmOperandNamed(OpInfo.Name); 1574 if (OpInfo.Name.empty() || SrcOperand == -1) 1575 throw TGError(TheDef->getLoc(), "Instruction '" + 1576 TheDef->getName() + "' has operand '" + OpInfo.Name + 1577 "' that doesn't appear in asm string!"); 1578 1579 // Check if the one AsmOperand populates the entire operand. 1580 unsigned NumOperands = OpInfo.MINumOperands; 1581 if (AsmOperands[SrcOperand].SubOpIdx == -1) { 1582 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, NumOperands)); 1583 continue; 1584 } 1585 1586 // Add a separate ResOperand for each suboperand. 1587 for (unsigned AI = 0; AI < NumOperands; ++AI) { 1588 assert(AsmOperands[SrcOperand+AI].SubOpIdx == (int)AI && 1589 AsmOperands[SrcOperand+AI].SrcOpName == OpInfo.Name && 1590 "unexpected AsmOperands for suboperands"); 1591 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand + AI, 1)); 1592 } 1593 } 1594} 1595 1596void MatchableInfo::buildAliasResultOperands() { 1597 const CodeGenInstAlias &CGA = *DefRec.get<const CodeGenInstAlias*>(); 1598 const CodeGenInstruction *ResultInst = getResultInst(); 1599 1600 // Loop over all operands of the result instruction, determining how to 1601 // populate them. 1602 unsigned AliasOpNo = 0; 1603 unsigned LastOpNo = CGA.ResultInstOperandIndex.size(); 1604 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) { 1605 const CGIOperandList::OperandInfo *OpInfo = &ResultInst->Operands[i]; 1606 1607 // If this is a tied operand, just copy from the previously handled operand. 1608 int TiedOp = OpInfo->getTiedRegister(); 1609 if (TiedOp != -1) { 1610 ResOperands.push_back(ResOperand::getTiedOp(TiedOp)); 1611 continue; 1612 } 1613 1614 // Handle all the suboperands for this operand. 1615 const std::string &OpName = OpInfo->Name; 1616 for ( ; AliasOpNo < LastOpNo && 1617 CGA.ResultInstOperandIndex[AliasOpNo].first == i; ++AliasOpNo) { 1618 int SubIdx = CGA.ResultInstOperandIndex[AliasOpNo].second; 1619 1620 // Find out what operand from the asmparser that this MCInst operand 1621 // comes from. 1622 switch (CGA.ResultOperands[AliasOpNo].Kind) { 1623 case CodeGenInstAlias::ResultOperand::K_Record: { 1624 StringRef Name = CGA.ResultOperands[AliasOpNo].getName(); 1625 int SrcOperand = findAsmOperand(Name, SubIdx); 1626 if (SrcOperand == -1) 1627 throw TGError(TheDef->getLoc(), "Instruction '" + 1628 TheDef->getName() + "' has operand '" + OpName + 1629 "' that doesn't appear in asm string!"); 1630 unsigned NumOperands = (SubIdx == -1 ? OpInfo->MINumOperands : 1); 1631 ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, 1632 NumOperands)); 1633 break; 1634 } 1635 case CodeGenInstAlias::ResultOperand::K_Imm: { 1636 int64_t ImmVal = CGA.ResultOperands[AliasOpNo].getImm(); 1637 ResOperands.push_back(ResOperand::getImmOp(ImmVal)); 1638 break; 1639 } 1640 case CodeGenInstAlias::ResultOperand::K_Reg: { 1641 Record *Reg = CGA.ResultOperands[AliasOpNo].getRegister(); 1642 ResOperands.push_back(ResOperand::getRegOp(Reg)); 1643 break; 1644 } 1645 } 1646 } 1647 } 1648} 1649 1650static unsigned getConverterOperandID(const std::string &Name, 1651 SetVector<std::string> &Table, 1652 bool &IsNew) { 1653 IsNew = Table.insert(Name); 1654 1655 unsigned ID = IsNew ? Table.size() - 1 : 1656 std::find(Table.begin(), Table.end(), Name) - Table.begin(); 1657 1658 assert(ID < Table.size()); 1659 1660 return ID; 1661} 1662 1663 1664static void emitConvertToMCInst(CodeGenTarget &Target, StringRef ClassName, 1665 std::vector<MatchableInfo*> &Infos, 1666 raw_ostream &OS) { 1667 SetVector<std::string> OperandConversionKinds; 1668 SetVector<std::string> InstructionConversionKinds; 1669 std::vector<std::vector<uint8_t> > ConversionTable; 1670 size_t MaxRowLength = 2; // minimum is custom converter plus terminator. 1671 1672 // TargetOperandClass - This is the target's operand class, like X86Operand. 1673 std::string TargetOperandClass = Target.getName() + "Operand"; 1674 1675 // Write the convert function to a separate stream, so we can drop it after 1676 // the enum. We'll build up the conversion handlers for the individual 1677 // operand types opportunistically as we encounter them. 1678 std::string ConvertFnBody; 1679 raw_string_ostream CvtOS(ConvertFnBody); 1680 // Start the unified conversion function. 1681 CvtOS << "void " << Target.getName() << ClassName << "::\n" 1682 << "convertToMCInst(unsigned Kind, MCInst &Inst, " 1683 << "unsigned Opcode,\n" 1684 << " const SmallVectorImpl<MCParsedAsmOperand*" 1685 << "> &Operands) {\n" 1686 << " assert(Kind < CVT_NUM_SIGNATURES && \"Invalid signature!\");\n" 1687 << " uint8_t *Converter = ConversionTable[Kind];\n" 1688 << " Inst.setOpcode(Opcode);\n" 1689 << " for (uint8_t *p = Converter; *p; p+= 2) {\n" 1690 << " switch (*p) {\n" 1691 << " default: llvm_unreachable(\"invalid conversion entry!\");\n" 1692 << " case CVT_Reg:\n" 1693 << " static_cast<" << TargetOperandClass 1694 << "*>(Operands[*(p + 1)])->addRegOperands(Inst, 1);\n" 1695 << " break;\n" 1696 << " case CVT_Tied:\n" 1697 << " Inst.addOperand(Inst.getOperand(*(p + 1)));\n" 1698 << " break;\n"; 1699 1700 std::string OperandFnBody; 1701 raw_string_ostream OpOS(OperandFnBody); 1702 // Start the operand number lookup function. 1703 OpOS << "unsigned " << Target.getName() << ClassName << "::\n" 1704 << "getMCInstOperandNumImpl(unsigned Kind, MCInst &Inst,\n" 1705 << " const SmallVectorImpl<MCParsedAsmOperand*> " 1706 << "&Operands,\n unsigned OperandNum, unsigned " 1707 << "&NumMCOperands) {\n" 1708 << " assert(Kind < CVT_NUM_SIGNATURES && \"Invalid signature!\");\n" 1709 << " NumMCOperands = 0;\n" 1710 << " unsigned MCOperandNum = 0;\n" 1711 << " uint8_t *Converter = ConversionTable[Kind];\n" 1712 << " for (uint8_t *p = Converter; *p; p+= 2) {\n" 1713 << " if (*(p + 1) > OperandNum) continue;\n" 1714 << " switch (*p) {\n" 1715 << " default: llvm_unreachable(\"invalid conversion entry!\");\n" 1716 << " case CVT_Reg:\n" 1717 << " if (*(p + 1) == OperandNum) {\n" 1718 << " NumMCOperands = 1;\n" 1719 << " break;\n" 1720 << " }\n" 1721 << " ++MCOperandNum;\n" 1722 << " break;\n" 1723 << " case CVT_Tied:\n" 1724 << " // FIXME: Tied operand calculation not supported.\n" 1725 << " assert (0 && \"getMCInstOperandNumImpl() doesn't support tied operands, yet!\");\n" 1726 << " break;\n"; 1727 1728 // Pre-populate the operand conversion kinds with the standard always 1729 // available entries. 1730 OperandConversionKinds.insert("CVT_Done"); 1731 OperandConversionKinds.insert("CVT_Reg"); 1732 OperandConversionKinds.insert("CVT_Tied"); 1733 enum { CVT_Done, CVT_Reg, CVT_Tied }; 1734 1735 for (std::vector<MatchableInfo*>::const_iterator it = Infos.begin(), 1736 ie = Infos.end(); it != ie; ++it) { 1737 MatchableInfo &II = **it; 1738 1739 // Check if we have a custom match function. 1740 std::string AsmMatchConverter = 1741 II.getResultInst()->TheDef->getValueAsString("AsmMatchConverter"); 1742 if (!AsmMatchConverter.empty()) { 1743 std::string Signature = "ConvertCustom_" + AsmMatchConverter; 1744 II.ConversionFnKind = Signature; 1745 1746 // Check if we have already generated this signature. 1747 if (!InstructionConversionKinds.insert(Signature)) 1748 continue; 1749 1750 // Remember this converter for the kind enum. 1751 unsigned KindID = OperandConversionKinds.size(); 1752 OperandConversionKinds.insert("CVT_" + AsmMatchConverter); 1753 1754 // Add the converter row for this instruction. 1755 ConversionTable.push_back(std::vector<uint8_t>()); 1756 ConversionTable.back().push_back(KindID); 1757 ConversionTable.back().push_back(CVT_Done); 1758 1759 // Add the handler to the conversion driver function. 1760 CvtOS << " case CVT_" << AsmMatchConverter << ":\n" 1761 << " " << AsmMatchConverter << "(Inst, Operands);\n" 1762 << " break;\n"; 1763 1764 // FIXME: Handle the operand number lookup for custom match functions. 1765 continue; 1766 } 1767 1768 // Build the conversion function signature. 1769 std::string Signature = "Convert"; 1770 1771 std::vector<uint8_t> ConversionRow; 1772 1773 // Compute the convert enum and the case body. 1774 MaxRowLength = std::max(MaxRowLength, II.ResOperands.size()*2 + 1 ); 1775 1776 for (unsigned i = 0, e = II.ResOperands.size(); i != e; ++i) { 1777 const MatchableInfo::ResOperand &OpInfo = II.ResOperands[i]; 1778 1779 // Generate code to populate each result operand. 1780 switch (OpInfo.Kind) { 1781 case MatchableInfo::ResOperand::RenderAsmOperand: { 1782 // This comes from something we parsed. 1783 MatchableInfo::AsmOperand &Op = II.AsmOperands[OpInfo.AsmOperandNum]; 1784 1785 // Registers are always converted the same, don't duplicate the 1786 // conversion function based on them. 1787 Signature += "__"; 1788 std::string Class; 1789 Class = Op.Class->isRegisterClass() ? "Reg" : Op.Class->ClassName; 1790 Signature += Class; 1791 Signature += utostr(OpInfo.MINumOperands); 1792 Signature += "_" + itostr(OpInfo.AsmOperandNum); 1793 1794 // Add the conversion kind, if necessary, and get the associated ID 1795 // the index of its entry in the vector). 1796 std::string Name = "CVT_" + (Op.Class->isRegisterClass() ? "Reg" : 1797 Op.Class->RenderMethod); 1798 1799 bool IsNewConverter = false; 1800 unsigned ID = getConverterOperandID(Name, OperandConversionKinds, 1801 IsNewConverter); 1802 1803 // Add the operand entry to the instruction kind conversion row. 1804 ConversionRow.push_back(ID); 1805 ConversionRow.push_back(OpInfo.AsmOperandNum + 1); 1806 1807 if (!IsNewConverter) 1808 break; 1809 1810 // This is a new operand kind. Add a handler for it to the 1811 // converter driver. 1812 CvtOS << " case " << Name << ":\n" 1813 << " static_cast<" << TargetOperandClass 1814 << "*>(Operands[*(p + 1)])->" 1815 << Op.Class->RenderMethod << "(Inst, " << OpInfo.MINumOperands 1816 << ");\n" 1817 << " break;\n"; 1818 1819 // Add a handler for the operand number lookup. 1820 OpOS << " case " << Name << ":\n" 1821 << " if (*(p + 1) == OperandNum) {\n" 1822 << " NumMCOperands = " << OpInfo.MINumOperands << ";\n" 1823 << " break;\n" 1824 << " }\n" 1825 << " MCOperandNum += " << OpInfo.MINumOperands << ";\n" 1826 << " break;\n"; 1827 break; 1828 } 1829 case MatchableInfo::ResOperand::TiedOperand: { 1830 // If this operand is tied to a previous one, just copy the MCInst 1831 // operand from the earlier one.We can only tie single MCOperand values. 1832 //assert(OpInfo.MINumOperands == 1 && "Not a singular MCOperand"); 1833 unsigned TiedOp = OpInfo.TiedOperandNum; 1834 assert(i > TiedOp && "Tied operand precedes its target!"); 1835 Signature += "__Tie" + utostr(TiedOp); 1836 ConversionRow.push_back(CVT_Tied); 1837 ConversionRow.push_back(TiedOp); 1838 // FIXME: Handle the operand number lookup for tied operands. 1839 break; 1840 } 1841 case MatchableInfo::ResOperand::ImmOperand: { 1842 int64_t Val = OpInfo.ImmVal; 1843 std::string Ty = "imm_" + itostr(Val); 1844 Signature += "__" + Ty; 1845 1846 std::string Name = "CVT_" + Ty; 1847 bool IsNewConverter = false; 1848 unsigned ID = getConverterOperandID(Name, OperandConversionKinds, 1849 IsNewConverter); 1850 // Add the operand entry to the instruction kind conversion row. 1851 ConversionRow.push_back(ID); 1852 ConversionRow.push_back(0); 1853 1854 if (!IsNewConverter) 1855 break; 1856 1857 CvtOS << " case " << Name << ":\n" 1858 << " Inst.addOperand(MCOperand::CreateImm(" << Val << "));\n" 1859 << " break;\n"; 1860 1861 OpOS << " case " << Name << ":\n" 1862 << " if (*(p + 1) == OperandNum) {\n" 1863 << " NumMCOperands = 1;\n" 1864 << " break;\n" 1865 << " }\n" 1866 << " ++MCOperandNum;\n" 1867 << " break;\n"; 1868 break; 1869 } 1870 case MatchableInfo::ResOperand::RegOperand: { 1871 std::string Reg, Name; 1872 if (OpInfo.Register == 0) { 1873 Name = "reg0"; 1874 Reg = "0"; 1875 } else { 1876 Reg = getQualifiedName(OpInfo.Register); 1877 Name = "reg" + OpInfo.Register->getName(); 1878 } 1879 Signature += "__" + Name; 1880 Name = "CVT_" + Name; 1881 bool IsNewConverter = false; 1882 unsigned ID = getConverterOperandID(Name, OperandConversionKinds, 1883 IsNewConverter); 1884 // Add the operand entry to the instruction kind conversion row. 1885 ConversionRow.push_back(ID); 1886 ConversionRow.push_back(0); 1887 1888 if (!IsNewConverter) 1889 break; 1890 CvtOS << " case " << Name << ":\n" 1891 << " Inst.addOperand(MCOperand::CreateReg(" << Reg << "));\n" 1892 << " break;\n"; 1893 1894 OpOS << " case " << Name << ":\n" 1895 << " if (*(p + 1) == OperandNum) {\n" 1896 << " NumMCOperands = 1;\n" 1897 << " break;\n" 1898 << " }\n" 1899 << " ++MCOperandNum;\n" 1900 << " break;\n"; 1901 } 1902 } 1903 } 1904 1905 // If there were no operands, add to the signature to that effect 1906 if (Signature == "Convert") 1907 Signature += "_NoOperands"; 1908 1909 II.ConversionFnKind = Signature; 1910 1911 // Save the signature. If we already have it, don't add a new row 1912 // to the table. 1913 if (!InstructionConversionKinds.insert(Signature)) 1914 continue; 1915 1916 // Add the row to the table. 1917 ConversionTable.push_back(ConversionRow); 1918 } 1919 1920 // Finish up the converter driver function. 1921 CvtOS << " }\n }\n}\n\n"; 1922 1923 // Finish up the operand number lookup function. 1924 OpOS << " }\n }\n return MCOperandNum;\n}\n\n"; 1925 1926 OS << "namespace {\n"; 1927 1928 // Output the operand conversion kind enum. 1929 OS << "enum OperatorConversionKind {\n"; 1930 for (unsigned i = 0, e = OperandConversionKinds.size(); i != e; ++i) 1931 OS << " " << OperandConversionKinds[i] << ",\n"; 1932 OS << " CVT_NUM_CONVERTERS\n"; 1933 OS << "};\n\n"; 1934 1935 // Output the instruction conversion kind enum. 1936 OS << "enum InstructionConversionKind {\n"; 1937 for (SetVector<std::string>::const_iterator 1938 i = InstructionConversionKinds.begin(), 1939 e = InstructionConversionKinds.end(); i != e; ++i) 1940 OS << " " << *i << ",\n"; 1941 OS << " CVT_NUM_SIGNATURES\n"; 1942 OS << "};\n\n"; 1943 1944 1945 OS << "} // end anonymous namespace\n\n"; 1946 1947 // Output the conversion table. 1948 OS << "static uint8_t ConversionTable[CVT_NUM_SIGNATURES][" 1949 << MaxRowLength << "] = {\n"; 1950 1951 for (unsigned Row = 0, ERow = ConversionTable.size(); Row != ERow; ++Row) { 1952 assert(ConversionTable[Row].size() % 2 == 0 && "bad conversion row!"); 1953 OS << " // " << InstructionConversionKinds[Row] << "\n"; 1954 OS << " { "; 1955 for (unsigned i = 0, e = ConversionTable[Row].size(); i != e; i += 2) 1956 OS << OperandConversionKinds[ConversionTable[Row][i]] << ", " 1957 << (unsigned)(ConversionTable[Row][i + 1]) << ", "; 1958 OS << "CVT_Done },\n"; 1959 } 1960 1961 OS << "};\n\n"; 1962 1963 // Spit out the conversion driver function. 1964 OS << CvtOS.str(); 1965 1966 // Spit out the operand number lookup function. 1967 OS << OpOS.str(); 1968} 1969 1970/// emitMatchClassEnumeration - Emit the enumeration for match class kinds. 1971static void emitMatchClassEnumeration(CodeGenTarget &Target, 1972 std::vector<ClassInfo*> &Infos, 1973 raw_ostream &OS) { 1974 OS << "namespace {\n\n"; 1975 1976 OS << "/// MatchClassKind - The kinds of classes which participate in\n" 1977 << "/// instruction matching.\n"; 1978 OS << "enum MatchClassKind {\n"; 1979 OS << " InvalidMatchClass = 0,\n"; 1980 for (std::vector<ClassInfo*>::iterator it = Infos.begin(), 1981 ie = Infos.end(); it != ie; ++it) { 1982 ClassInfo &CI = **it; 1983 OS << " " << CI.Name << ", // "; 1984 if (CI.Kind == ClassInfo::Token) { 1985 OS << "'" << CI.ValueName << "'\n"; 1986 } else if (CI.isRegisterClass()) { 1987 if (!CI.ValueName.empty()) 1988 OS << "register class '" << CI.ValueName << "'\n"; 1989 else 1990 OS << "derived register class\n"; 1991 } else { 1992 OS << "user defined class '" << CI.ValueName << "'\n"; 1993 } 1994 } 1995 OS << " NumMatchClassKinds\n"; 1996 OS << "};\n\n"; 1997 1998 OS << "}\n\n"; 1999} 2000 2001/// emitValidateOperandClass - Emit the function to validate an operand class. 2002static void emitValidateOperandClass(AsmMatcherInfo &Info, 2003 raw_ostream &OS) { 2004 OS << "static unsigned validateOperandClass(MCParsedAsmOperand *GOp, " 2005 << "MatchClassKind Kind) {\n"; 2006 OS << " " << Info.Target.getName() << "Operand &Operand = *(" 2007 << Info.Target.getName() << "Operand*)GOp;\n"; 2008 2009 // The InvalidMatchClass is not to match any operand. 2010 OS << " if (Kind == InvalidMatchClass)\n"; 2011 OS << " return MCTargetAsmParser::Match_InvalidOperand;\n\n"; 2012 2013 // Check for Token operands first. 2014 // FIXME: Use a more specific diagnostic type. 2015 OS << " if (Operand.isToken())\n"; 2016 OS << " return isSubclass(matchTokenString(Operand.getToken()), Kind) ?\n" 2017 << " MCTargetAsmParser::Match_Success :\n" 2018 << " MCTargetAsmParser::Match_InvalidOperand;\n\n"; 2019 2020 // Check the user classes. We don't care what order since we're only 2021 // actually matching against one of them. 2022 for (std::vector<ClassInfo*>::iterator it = Info.Classes.begin(), 2023 ie = Info.Classes.end(); it != ie; ++it) { 2024 ClassInfo &CI = **it; 2025 2026 if (!CI.isUserClass()) 2027 continue; 2028 2029 OS << " // '" << CI.ClassName << "' class\n"; 2030 OS << " if (Kind == " << CI.Name << ") {\n"; 2031 OS << " if (Operand." << CI.PredicateMethod << "())\n"; 2032 OS << " return MCTargetAsmParser::Match_Success;\n"; 2033 if (!CI.DiagnosticType.empty()) 2034 OS << " return " << Info.Target.getName() << "AsmParser::Match_" 2035 << CI.DiagnosticType << ";\n"; 2036 OS << " }\n\n"; 2037 } 2038 2039 // Check for register operands, including sub-classes. 2040 OS << " if (Operand.isReg()) {\n"; 2041 OS << " MatchClassKind OpKind;\n"; 2042 OS << " switch (Operand.getReg()) {\n"; 2043 OS << " default: OpKind = InvalidMatchClass; break;\n"; 2044 for (std::map<Record*, ClassInfo*>::iterator 2045 it = Info.RegisterClasses.begin(), ie = Info.RegisterClasses.end(); 2046 it != ie; ++it) 2047 OS << " case " << Info.Target.getName() << "::" 2048 << it->first->getName() << ": OpKind = " << it->second->Name 2049 << "; break;\n"; 2050 OS << " }\n"; 2051 OS << " return isSubclass(OpKind, Kind) ? " 2052 << "MCTargetAsmParser::Match_Success :\n " 2053 << " MCTargetAsmParser::Match_InvalidOperand;\n }\n\n"; 2054 2055 // Generic fallthrough match failure case for operands that don't have 2056 // specialized diagnostic types. 2057 OS << " return MCTargetAsmParser::Match_InvalidOperand;\n"; 2058 OS << "}\n\n"; 2059} 2060 2061/// emitIsSubclass - Emit the subclass predicate function. 2062static void emitIsSubclass(CodeGenTarget &Target, 2063 std::vector<ClassInfo*> &Infos, 2064 raw_ostream &OS) { 2065 OS << "/// isSubclass - Compute whether \\arg A is a subclass of \\arg B.\n"; 2066 OS << "static bool isSubclass(MatchClassKind A, MatchClassKind B) {\n"; 2067 OS << " if (A == B)\n"; 2068 OS << " return true;\n\n"; 2069 2070 OS << " switch (A) {\n"; 2071 OS << " default:\n"; 2072 OS << " return false;\n"; 2073 for (std::vector<ClassInfo*>::iterator it = Infos.begin(), 2074 ie = Infos.end(); it != ie; ++it) { 2075 ClassInfo &A = **it; 2076 2077 std::vector<StringRef> SuperClasses; 2078 for (std::vector<ClassInfo*>::iterator it = Infos.begin(), 2079 ie = Infos.end(); it != ie; ++it) { 2080 ClassInfo &B = **it; 2081 2082 if (&A != &B && A.isSubsetOf(B)) 2083 SuperClasses.push_back(B.Name); 2084 } 2085 2086 if (SuperClasses.empty()) 2087 continue; 2088 2089 OS << "\n case " << A.Name << ":\n"; 2090 2091 if (SuperClasses.size() == 1) { 2092 OS << " return B == " << SuperClasses.back() << ";\n"; 2093 continue; 2094 } 2095 2096 OS << " switch (B) {\n"; 2097 OS << " default: return false;\n"; 2098 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i) 2099 OS << " case " << SuperClasses[i] << ": return true;\n"; 2100 OS << " }\n"; 2101 } 2102 OS << " }\n"; 2103 OS << "}\n\n"; 2104} 2105 2106/// emitMatchTokenString - Emit the function to match a token string to the 2107/// appropriate match class value. 2108static void emitMatchTokenString(CodeGenTarget &Target, 2109 std::vector<ClassInfo*> &Infos, 2110 raw_ostream &OS) { 2111 // Construct the match list. 2112 std::vector<StringMatcher::StringPair> Matches; 2113 for (std::vector<ClassInfo*>::iterator it = Infos.begin(), 2114 ie = Infos.end(); it != ie; ++it) { 2115 ClassInfo &CI = **it; 2116 2117 if (CI.Kind == ClassInfo::Token) 2118 Matches.push_back(StringMatcher::StringPair(CI.ValueName, 2119 "return " + CI.Name + ";")); 2120 } 2121 2122 OS << "static MatchClassKind matchTokenString(StringRef Name) {\n"; 2123 2124 StringMatcher("Name", Matches, OS).Emit(); 2125 2126 OS << " return InvalidMatchClass;\n"; 2127 OS << "}\n\n"; 2128} 2129 2130/// emitMatchRegisterName - Emit the function to match a string to the target 2131/// specific register enum. 2132static void emitMatchRegisterName(CodeGenTarget &Target, Record *AsmParser, 2133 raw_ostream &OS) { 2134 // Construct the match list. 2135 std::vector<StringMatcher::StringPair> Matches; 2136 const std::vector<CodeGenRegister*> &Regs = 2137 Target.getRegBank().getRegisters(); 2138 for (unsigned i = 0, e = Regs.size(); i != e; ++i) { 2139 const CodeGenRegister *Reg = Regs[i]; 2140 if (Reg->TheDef->getValueAsString("AsmName").empty()) 2141 continue; 2142 2143 Matches.push_back(StringMatcher::StringPair( 2144 Reg->TheDef->getValueAsString("AsmName"), 2145 "return " + utostr(Reg->EnumValue) + ";")); 2146 } 2147 2148 OS << "static unsigned MatchRegisterName(StringRef Name) {\n"; 2149 2150 StringMatcher("Name", Matches, OS).Emit(); 2151 2152 OS << " return 0;\n"; 2153 OS << "}\n\n"; 2154} 2155 2156/// emitSubtargetFeatureFlagEnumeration - Emit the subtarget feature flag 2157/// definitions. 2158static void emitSubtargetFeatureFlagEnumeration(AsmMatcherInfo &Info, 2159 raw_ostream &OS) { 2160 OS << "// Flags for subtarget features that participate in " 2161 << "instruction matching.\n"; 2162 OS << "enum SubtargetFeatureFlag {\n"; 2163 for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator 2164 it = Info.SubtargetFeatures.begin(), 2165 ie = Info.SubtargetFeatures.end(); it != ie; ++it) { 2166 SubtargetFeatureInfo &SFI = *it->second; 2167 OS << " " << SFI.getEnumName() << " = (1 << " << SFI.Index << "),\n"; 2168 } 2169 OS << " Feature_None = 0\n"; 2170 OS << "};\n\n"; 2171} 2172 2173/// emitOperandDiagnosticTypes - Emit the operand matching diagnostic types. 2174static void emitOperandDiagnosticTypes(AsmMatcherInfo &Info, raw_ostream &OS) { 2175 // Get the set of diagnostic types from all of the operand classes. 2176 std::set<StringRef> Types; 2177 for (std::map<Record*, ClassInfo*>::const_iterator 2178 I = Info.AsmOperandClasses.begin(), 2179 E = Info.AsmOperandClasses.end(); I != E; ++I) { 2180 if (!I->second->DiagnosticType.empty()) 2181 Types.insert(I->second->DiagnosticType); 2182 } 2183 2184 if (Types.empty()) return; 2185 2186 // Now emit the enum entries. 2187 for (std::set<StringRef>::const_iterator I = Types.begin(), E = Types.end(); 2188 I != E; ++I) 2189 OS << " Match_" << *I << ",\n"; 2190 OS << " END_OPERAND_DIAGNOSTIC_TYPES\n"; 2191} 2192 2193/// emitGetSubtargetFeatureName - Emit the helper function to get the 2194/// user-level name for a subtarget feature. 2195static void emitGetSubtargetFeatureName(AsmMatcherInfo &Info, raw_ostream &OS) { 2196 OS << "// User-level names for subtarget features that participate in\n" 2197 << "// instruction matching.\n" 2198 << "static const char *getSubtargetFeatureName(unsigned Val) {\n" 2199 << " switch(Val) {\n"; 2200 for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator 2201 it = Info.SubtargetFeatures.begin(), 2202 ie = Info.SubtargetFeatures.end(); it != ie; ++it) { 2203 SubtargetFeatureInfo &SFI = *it->second; 2204 // FIXME: Totally just a placeholder name to get the algorithm working. 2205 OS << " case " << SFI.getEnumName() << ": return \"" 2206 << SFI.TheDef->getValueAsString("PredicateName") << "\";\n"; 2207 } 2208 OS << " default: return \"(unknown)\";\n"; 2209 OS << " }\n}\n\n"; 2210} 2211 2212/// emitComputeAvailableFeatures - Emit the function to compute the list of 2213/// available features given a subtarget. 2214static void emitComputeAvailableFeatures(AsmMatcherInfo &Info, 2215 raw_ostream &OS) { 2216 std::string ClassName = 2217 Info.AsmParser->getValueAsString("AsmParserClassName"); 2218 2219 OS << "unsigned " << Info.Target.getName() << ClassName << "::\n" 2220 << "ComputeAvailableFeatures(uint64_t FB) const {\n"; 2221 OS << " unsigned Features = 0;\n"; 2222 for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator 2223 it = Info.SubtargetFeatures.begin(), 2224 ie = Info.SubtargetFeatures.end(); it != ie; ++it) { 2225 SubtargetFeatureInfo &SFI = *it->second; 2226 2227 OS << " if ("; 2228 std::string CondStorage = 2229 SFI.TheDef->getValueAsString("AssemblerCondString"); 2230 StringRef Conds = CondStorage; 2231 std::pair<StringRef,StringRef> Comma = Conds.split(','); 2232 bool First = true; 2233 do { 2234 if (!First) 2235 OS << " && "; 2236 2237 bool Neg = false; 2238 StringRef Cond = Comma.first; 2239 if (Cond[0] == '!') { 2240 Neg = true; 2241 Cond = Cond.substr(1); 2242 } 2243 2244 OS << "((FB & " << Info.Target.getName() << "::" << Cond << ")"; 2245 if (Neg) 2246 OS << " == 0"; 2247 else 2248 OS << " != 0"; 2249 OS << ")"; 2250 2251 if (Comma.second.empty()) 2252 break; 2253 2254 First = false; 2255 Comma = Comma.second.split(','); 2256 } while (true); 2257 2258 OS << ")\n"; 2259 OS << " Features |= " << SFI.getEnumName() << ";\n"; 2260 } 2261 OS << " return Features;\n"; 2262 OS << "}\n\n"; 2263} 2264 2265static std::string GetAliasRequiredFeatures(Record *R, 2266 const AsmMatcherInfo &Info) { 2267 std::vector<Record*> ReqFeatures = R->getValueAsListOfDefs("Predicates"); 2268 std::string Result; 2269 unsigned NumFeatures = 0; 2270 for (unsigned i = 0, e = ReqFeatures.size(); i != e; ++i) { 2271 SubtargetFeatureInfo *F = Info.getSubtargetFeature(ReqFeatures[i]); 2272 2273 if (F == 0) 2274 throw TGError(R->getLoc(), "Predicate '" + ReqFeatures[i]->getName() + 2275 "' is not marked as an AssemblerPredicate!"); 2276 2277 if (NumFeatures) 2278 Result += '|'; 2279 2280 Result += F->getEnumName(); 2281 ++NumFeatures; 2282 } 2283 2284 if (NumFeatures > 1) 2285 Result = '(' + Result + ')'; 2286 return Result; 2287} 2288 2289/// emitMnemonicAliases - If the target has any MnemonicAlias<> definitions, 2290/// emit a function for them and return true, otherwise return false. 2291static bool emitMnemonicAliases(raw_ostream &OS, const AsmMatcherInfo &Info) { 2292 // Ignore aliases when match-prefix is set. 2293 if (!MatchPrefix.empty()) 2294 return false; 2295 2296 std::vector<Record*> Aliases = 2297 Info.getRecords().getAllDerivedDefinitions("MnemonicAlias"); 2298 if (Aliases.empty()) return false; 2299 2300 OS << "static void applyMnemonicAliases(StringRef &Mnemonic, " 2301 "unsigned Features) {\n"; 2302 2303 // Keep track of all the aliases from a mnemonic. Use an std::map so that the 2304 // iteration order of the map is stable. 2305 std::map<std::string, std::vector<Record*> > AliasesFromMnemonic; 2306 2307 for (unsigned i = 0, e = Aliases.size(); i != e; ++i) { 2308 Record *R = Aliases[i]; 2309 AliasesFromMnemonic[R->getValueAsString("FromMnemonic")].push_back(R); 2310 } 2311 2312 // Process each alias a "from" mnemonic at a time, building the code executed 2313 // by the string remapper. 2314 std::vector<StringMatcher::StringPair> Cases; 2315 for (std::map<std::string, std::vector<Record*> >::iterator 2316 I = AliasesFromMnemonic.begin(), E = AliasesFromMnemonic.end(); 2317 I != E; ++I) { 2318 const std::vector<Record*> &ToVec = I->second; 2319 2320 // Loop through each alias and emit code that handles each case. If there 2321 // are two instructions without predicates, emit an error. If there is one, 2322 // emit it last. 2323 std::string MatchCode; 2324 int AliasWithNoPredicate = -1; 2325 2326 for (unsigned i = 0, e = ToVec.size(); i != e; ++i) { 2327 Record *R = ToVec[i]; 2328 std::string FeatureMask = GetAliasRequiredFeatures(R, Info); 2329 2330 // If this unconditionally matches, remember it for later and diagnose 2331 // duplicates. 2332 if (FeatureMask.empty()) { 2333 if (AliasWithNoPredicate != -1) { 2334 // We can't have two aliases from the same mnemonic with no predicate. 2335 PrintError(ToVec[AliasWithNoPredicate]->getLoc(), 2336 "two MnemonicAliases with the same 'from' mnemonic!"); 2337 throw TGError(R->getLoc(), "this is the other MnemonicAlias."); 2338 } 2339 2340 AliasWithNoPredicate = i; 2341 continue; 2342 } 2343 if (R->getValueAsString("ToMnemonic") == I->first) 2344 throw TGError(R->getLoc(), "MnemonicAlias to the same string"); 2345 2346 if (!MatchCode.empty()) 2347 MatchCode += "else "; 2348 MatchCode += "if ((Features & " + FeatureMask + ") == "+FeatureMask+")\n"; 2349 MatchCode += " Mnemonic = \"" +R->getValueAsString("ToMnemonic")+"\";\n"; 2350 } 2351 2352 if (AliasWithNoPredicate != -1) { 2353 Record *R = ToVec[AliasWithNoPredicate]; 2354 if (!MatchCode.empty()) 2355 MatchCode += "else\n "; 2356 MatchCode += "Mnemonic = \"" + R->getValueAsString("ToMnemonic")+"\";\n"; 2357 } 2358 2359 MatchCode += "return;"; 2360 2361 Cases.push_back(std::make_pair(I->first, MatchCode)); 2362 } 2363 2364 StringMatcher("Mnemonic", Cases, OS).Emit(); 2365 OS << "}\n\n"; 2366 2367 return true; 2368} 2369 2370static const char *getMinimalTypeForRange(uint64_t Range) { 2371 assert(Range < 0xFFFFFFFFULL && "Enum too large"); 2372 if (Range > 0xFFFF) 2373 return "uint32_t"; 2374 if (Range > 0xFF) 2375 return "uint16_t"; 2376 return "uint8_t"; 2377} 2378 2379static void emitCustomOperandParsing(raw_ostream &OS, CodeGenTarget &Target, 2380 const AsmMatcherInfo &Info, StringRef ClassName) { 2381 // Emit the static custom operand parsing table; 2382 OS << "namespace {\n"; 2383 OS << " struct OperandMatchEntry {\n"; 2384 OS << " static const char *const MnemonicTable;\n"; 2385 OS << " uint32_t OperandMask;\n"; 2386 OS << " uint32_t Mnemonic;\n"; 2387 OS << " " << getMinimalTypeForRange(1ULL << Info.SubtargetFeatures.size()) 2388 << " RequiredFeatures;\n"; 2389 OS << " " << getMinimalTypeForRange(Info.Classes.size()) 2390 << " Class;\n\n"; 2391 OS << " StringRef getMnemonic() const {\n"; 2392 OS << " return StringRef(MnemonicTable + Mnemonic + 1,\n"; 2393 OS << " MnemonicTable[Mnemonic]);\n"; 2394 OS << " }\n"; 2395 OS << " };\n\n"; 2396 2397 OS << " // Predicate for searching for an opcode.\n"; 2398 OS << " struct LessOpcodeOperand {\n"; 2399 OS << " bool operator()(const OperandMatchEntry &LHS, StringRef RHS) {\n"; 2400 OS << " return LHS.getMnemonic() < RHS;\n"; 2401 OS << " }\n"; 2402 OS << " bool operator()(StringRef LHS, const OperandMatchEntry &RHS) {\n"; 2403 OS << " return LHS < RHS.getMnemonic();\n"; 2404 OS << " }\n"; 2405 OS << " bool operator()(const OperandMatchEntry &LHS,"; 2406 OS << " const OperandMatchEntry &RHS) {\n"; 2407 OS << " return LHS.getMnemonic() < RHS.getMnemonic();\n"; 2408 OS << " }\n"; 2409 OS << " };\n"; 2410 2411 OS << "} // end anonymous namespace.\n\n"; 2412 2413 StringToOffsetTable StringTable; 2414 2415 OS << "static const OperandMatchEntry OperandMatchTable[" 2416 << Info.OperandMatchInfo.size() << "] = {\n"; 2417 2418 OS << " /* Operand List Mask, Mnemonic, Operand Class, Features */\n"; 2419 for (std::vector<OperandMatchEntry>::const_iterator it = 2420 Info.OperandMatchInfo.begin(), ie = Info.OperandMatchInfo.end(); 2421 it != ie; ++it) { 2422 const OperandMatchEntry &OMI = *it; 2423 const MatchableInfo &II = *OMI.MI; 2424 2425 OS << " { " << OMI.OperandMask; 2426 2427 OS << " /* "; 2428 bool printComma = false; 2429 for (int i = 0, e = 31; i !=e; ++i) 2430 if (OMI.OperandMask & (1 << i)) { 2431 if (printComma) 2432 OS << ", "; 2433 OS << i; 2434 printComma = true; 2435 } 2436 OS << " */"; 2437 2438 // Store a pascal-style length byte in the mnemonic. 2439 std::string LenMnemonic = char(II.Mnemonic.size()) + II.Mnemonic.str(); 2440 OS << ", " << StringTable.GetOrAddStringOffset(LenMnemonic, false) 2441 << " /* " << II.Mnemonic << " */, "; 2442 2443 // Write the required features mask. 2444 if (!II.RequiredFeatures.empty()) { 2445 for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) { 2446 if (i) OS << "|"; 2447 OS << II.RequiredFeatures[i]->getEnumName(); 2448 } 2449 } else 2450 OS << "0"; 2451 2452 OS << ", " << OMI.CI->Name; 2453 2454 OS << " },\n"; 2455 } 2456 OS << "};\n\n"; 2457 2458 OS << "const char *const OperandMatchEntry::MnemonicTable =\n"; 2459 StringTable.EmitString(OS); 2460 OS << ";\n\n"; 2461 2462 // Emit the operand class switch to call the correct custom parser for 2463 // the found operand class. 2464 OS << Target.getName() << ClassName << "::OperandMatchResultTy " 2465 << Target.getName() << ClassName << "::\n" 2466 << "tryCustomParseOperand(SmallVectorImpl<MCParsedAsmOperand*>" 2467 << " &Operands,\n unsigned MCK) {\n\n" 2468 << " switch(MCK) {\n"; 2469 2470 for (std::vector<ClassInfo*>::const_iterator it = Info.Classes.begin(), 2471 ie = Info.Classes.end(); it != ie; ++it) { 2472 ClassInfo *CI = *it; 2473 if (CI->ParserMethod.empty()) 2474 continue; 2475 OS << " case " << CI->Name << ":\n" 2476 << " return " << CI->ParserMethod << "(Operands);\n"; 2477 } 2478 2479 OS << " default:\n"; 2480 OS << " return MatchOperand_NoMatch;\n"; 2481 OS << " }\n"; 2482 OS << " return MatchOperand_NoMatch;\n"; 2483 OS << "}\n\n"; 2484 2485 // Emit the static custom operand parser. This code is very similar with 2486 // the other matcher. Also use MatchResultTy here just in case we go for 2487 // a better error handling. 2488 OS << Target.getName() << ClassName << "::OperandMatchResultTy " 2489 << Target.getName() << ClassName << "::\n" 2490 << "MatchOperandParserImpl(SmallVectorImpl<MCParsedAsmOperand*>" 2491 << " &Operands,\n StringRef Mnemonic) {\n"; 2492 2493 // Emit code to get the available features. 2494 OS << " // Get the current feature set.\n"; 2495 OS << " unsigned AvailableFeatures = getAvailableFeatures();\n\n"; 2496 2497 OS << " // Get the next operand index.\n"; 2498 OS << " unsigned NextOpNum = Operands.size()-1;\n"; 2499 2500 // Emit code to search the table. 2501 OS << " // Search the table.\n"; 2502 OS << " std::pair<const OperandMatchEntry*, const OperandMatchEntry*>"; 2503 OS << " MnemonicRange =\n"; 2504 OS << " std::equal_range(OperandMatchTable, OperandMatchTable+" 2505 << Info.OperandMatchInfo.size() << ", Mnemonic,\n" 2506 << " LessOpcodeOperand());\n\n"; 2507 2508 OS << " if (MnemonicRange.first == MnemonicRange.second)\n"; 2509 OS << " return MatchOperand_NoMatch;\n\n"; 2510 2511 OS << " for (const OperandMatchEntry *it = MnemonicRange.first,\n" 2512 << " *ie = MnemonicRange.second; it != ie; ++it) {\n"; 2513 2514 OS << " // equal_range guarantees that instruction mnemonic matches.\n"; 2515 OS << " assert(Mnemonic == it->getMnemonic());\n\n"; 2516 2517 // Emit check that the required features are available. 2518 OS << " // check if the available features match\n"; 2519 OS << " if ((AvailableFeatures & it->RequiredFeatures) " 2520 << "!= it->RequiredFeatures) {\n"; 2521 OS << " continue;\n"; 2522 OS << " }\n\n"; 2523 2524 // Emit check to ensure the operand number matches. 2525 OS << " // check if the operand in question has a custom parser.\n"; 2526 OS << " if (!(it->OperandMask & (1 << NextOpNum)))\n"; 2527 OS << " continue;\n\n"; 2528 2529 // Emit call to the custom parser method 2530 OS << " // call custom parse method to handle the operand\n"; 2531 OS << " OperandMatchResultTy Result = "; 2532 OS << "tryCustomParseOperand(Operands, it->Class);\n"; 2533 OS << " if (Result != MatchOperand_NoMatch)\n"; 2534 OS << " return Result;\n"; 2535 OS << " }\n\n"; 2536 2537 OS << " // Okay, we had no match.\n"; 2538 OS << " return MatchOperand_NoMatch;\n"; 2539 OS << "}\n\n"; 2540} 2541 2542void AsmMatcherEmitter::run(raw_ostream &OS) { 2543 CodeGenTarget Target(Records); 2544 Record *AsmParser = Target.getAsmParser(); 2545 std::string ClassName = AsmParser->getValueAsString("AsmParserClassName"); 2546 2547 // Compute the information on the instructions to match. 2548 AsmMatcherInfo Info(AsmParser, Target, Records); 2549 Info.buildInfo(); 2550 2551 // Sort the instruction table using the partial order on classes. We use 2552 // stable_sort to ensure that ambiguous instructions are still 2553 // deterministically ordered. 2554 std::stable_sort(Info.Matchables.begin(), Info.Matchables.end(), 2555 less_ptr<MatchableInfo>()); 2556 2557 DEBUG_WITH_TYPE("instruction_info", { 2558 for (std::vector<MatchableInfo*>::iterator 2559 it = Info.Matchables.begin(), ie = Info.Matchables.end(); 2560 it != ie; ++it) 2561 (*it)->dump(); 2562 }); 2563 2564 // Check for ambiguous matchables. 2565 DEBUG_WITH_TYPE("ambiguous_instrs", { 2566 unsigned NumAmbiguous = 0; 2567 for (unsigned i = 0, e = Info.Matchables.size(); i != e; ++i) { 2568 for (unsigned j = i + 1; j != e; ++j) { 2569 MatchableInfo &A = *Info.Matchables[i]; 2570 MatchableInfo &B = *Info.Matchables[j]; 2571 2572 if (A.couldMatchAmbiguouslyWith(B)) { 2573 errs() << "warning: ambiguous matchables:\n"; 2574 A.dump(); 2575 errs() << "\nis incomparable with:\n"; 2576 B.dump(); 2577 errs() << "\n\n"; 2578 ++NumAmbiguous; 2579 } 2580 } 2581 } 2582 if (NumAmbiguous) 2583 errs() << "warning: " << NumAmbiguous 2584 << " ambiguous matchables!\n"; 2585 }); 2586 2587 // Compute the information on the custom operand parsing. 2588 Info.buildOperandMatchInfo(); 2589 2590 // Write the output. 2591 2592 // Information for the class declaration. 2593 OS << "\n#ifdef GET_ASSEMBLER_HEADER\n"; 2594 OS << "#undef GET_ASSEMBLER_HEADER\n"; 2595 OS << " // This should be included into the middle of the declaration of\n"; 2596 OS << " // your subclasses implementation of MCTargetAsmParser.\n"; 2597 OS << " unsigned ComputeAvailableFeatures(uint64_t FeatureBits) const;\n"; 2598 OS << " void convertToMCInst(unsigned Kind, MCInst &Inst, " 2599 << "unsigned Opcode,\n" 2600 << " const SmallVectorImpl<MCParsedAsmOperand*> " 2601 << "&Operands);\n"; 2602 OS << " unsigned getMCInstOperandNumImpl(unsigned Kind, MCInst &Inst,\n " 2603 << " const " 2604 << "SmallVectorImpl<MCParsedAsmOperand*> &Operands,\n " 2605 << " unsigned OperandNum, unsigned &NumMCOperands);\n"; 2606 OS << " bool MnemonicIsValid(StringRef Mnemonic);\n"; 2607 OS << " unsigned MatchInstructionImpl(\n" 2608 << " const SmallVectorImpl<MCParsedAsmOperand*> &Operands,\n" 2609 << " unsigned &Kind, MCInst &Inst, " 2610 << "unsigned &ErrorInfo,\n unsigned VariantID = 0);\n"; 2611 2612 if (Info.OperandMatchInfo.size()) { 2613 OS << "\n enum OperandMatchResultTy {\n"; 2614 OS << " MatchOperand_Success, // operand matched successfully\n"; 2615 OS << " MatchOperand_NoMatch, // operand did not match\n"; 2616 OS << " MatchOperand_ParseFail // operand matched but had errors\n"; 2617 OS << " };\n"; 2618 OS << " OperandMatchResultTy MatchOperandParserImpl(\n"; 2619 OS << " SmallVectorImpl<MCParsedAsmOperand*> &Operands,\n"; 2620 OS << " StringRef Mnemonic);\n"; 2621 2622 OS << " OperandMatchResultTy tryCustomParseOperand(\n"; 2623 OS << " SmallVectorImpl<MCParsedAsmOperand*> &Operands,\n"; 2624 OS << " unsigned MCK);\n\n"; 2625 } 2626 2627 OS << "#endif // GET_ASSEMBLER_HEADER_INFO\n\n"; 2628 2629 // Emit the operand match diagnostic enum names. 2630 OS << "\n#ifdef GET_OPERAND_DIAGNOSTIC_TYPES\n"; 2631 OS << "#undef GET_OPERAND_DIAGNOSTIC_TYPES\n\n"; 2632 emitOperandDiagnosticTypes(Info, OS); 2633 OS << "#endif // GET_OPERAND_DIAGNOSTIC_TYPES\n\n"; 2634 2635 2636 OS << "\n#ifdef GET_REGISTER_MATCHER\n"; 2637 OS << "#undef GET_REGISTER_MATCHER\n\n"; 2638 2639 // Emit the subtarget feature enumeration. 2640 emitSubtargetFeatureFlagEnumeration(Info, OS); 2641 2642 // Emit the function to match a register name to number. 2643 // This should be omitted for Mips target 2644 if (AsmParser->getValueAsBit("ShouldEmitMatchRegisterName")) 2645 emitMatchRegisterName(Target, AsmParser, OS); 2646 2647 OS << "#endif // GET_REGISTER_MATCHER\n\n"; 2648 2649 OS << "\n#ifdef GET_SUBTARGET_FEATURE_NAME\n"; 2650 OS << "#undef GET_SUBTARGET_FEATURE_NAME\n\n"; 2651 2652 // Generate the helper function to get the names for subtarget features. 2653 emitGetSubtargetFeatureName(Info, OS); 2654 2655 OS << "#endif // GET_SUBTARGET_FEATURE_NAME\n\n"; 2656 2657 OS << "\n#ifdef GET_MATCHER_IMPLEMENTATION\n"; 2658 OS << "#undef GET_MATCHER_IMPLEMENTATION\n\n"; 2659 2660 // Generate the function that remaps for mnemonic aliases. 2661 bool HasMnemonicAliases = emitMnemonicAliases(OS, Info); 2662 2663 // Generate the unified function to convert operands into an MCInst. 2664 emitConvertToMCInst(Target, ClassName, Info.Matchables, OS); 2665 2666 // Emit the enumeration for classes which participate in matching. 2667 emitMatchClassEnumeration(Target, Info.Classes, OS); 2668 2669 // Emit the routine to match token strings to their match class. 2670 emitMatchTokenString(Target, Info.Classes, OS); 2671 2672 // Emit the subclass predicate routine. 2673 emitIsSubclass(Target, Info.Classes, OS); 2674 2675 // Emit the routine to validate an operand against a match class. 2676 emitValidateOperandClass(Info, OS); 2677 2678 // Emit the available features compute function. 2679 emitComputeAvailableFeatures(Info, OS); 2680 2681 2682 size_t MaxNumOperands = 0; 2683 for (std::vector<MatchableInfo*>::const_iterator it = 2684 Info.Matchables.begin(), ie = Info.Matchables.end(); 2685 it != ie; ++it) 2686 MaxNumOperands = std::max(MaxNumOperands, (*it)->AsmOperands.size()); 2687 2688 // Emit the static match table; unused classes get initalized to 0 which is 2689 // guaranteed to be InvalidMatchClass. 2690 // 2691 // FIXME: We can reduce the size of this table very easily. First, we change 2692 // it so that store the kinds in separate bit-fields for each index, which 2693 // only needs to be the max width used for classes at that index (we also need 2694 // to reject based on this during classification). If we then make sure to 2695 // order the match kinds appropriately (putting mnemonics last), then we 2696 // should only end up using a few bits for each class, especially the ones 2697 // following the mnemonic. 2698 OS << "namespace {\n"; 2699 OS << " struct MatchEntry {\n"; 2700 OS << " static const char *const MnemonicTable;\n"; 2701 OS << " uint32_t Mnemonic;\n"; 2702 OS << " uint16_t Opcode;\n"; 2703 OS << " " << getMinimalTypeForRange(Info.Matchables.size()) 2704 << " ConvertFn;\n"; 2705 OS << " " << getMinimalTypeForRange(1ULL << Info.SubtargetFeatures.size()) 2706 << " RequiredFeatures;\n"; 2707 OS << " " << getMinimalTypeForRange(Info.Classes.size()) 2708 << " Classes[" << MaxNumOperands << "];\n"; 2709 OS << " uint8_t AsmVariantID;\n\n"; 2710 OS << " StringRef getMnemonic() const {\n"; 2711 OS << " return StringRef(MnemonicTable + Mnemonic + 1,\n"; 2712 OS << " MnemonicTable[Mnemonic]);\n"; 2713 OS << " }\n"; 2714 OS << " };\n\n"; 2715 2716 OS << " // Predicate for searching for an opcode.\n"; 2717 OS << " struct LessOpcode {\n"; 2718 OS << " bool operator()(const MatchEntry &LHS, StringRef RHS) {\n"; 2719 OS << " return LHS.getMnemonic() < RHS;\n"; 2720 OS << " }\n"; 2721 OS << " bool operator()(StringRef LHS, const MatchEntry &RHS) {\n"; 2722 OS << " return LHS < RHS.getMnemonic();\n"; 2723 OS << " }\n"; 2724 OS << " bool operator()(const MatchEntry &LHS, const MatchEntry &RHS) {\n"; 2725 OS << " return LHS.getMnemonic() < RHS.getMnemonic();\n"; 2726 OS << " }\n"; 2727 OS << " };\n"; 2728 2729 OS << "} // end anonymous namespace.\n\n"; 2730 2731 StringToOffsetTable StringTable; 2732 2733 OS << "static const MatchEntry MatchTable[" 2734 << Info.Matchables.size() << "] = {\n"; 2735 2736 for (std::vector<MatchableInfo*>::const_iterator it = 2737 Info.Matchables.begin(), ie = Info.Matchables.end(); 2738 it != ie; ++it) { 2739 MatchableInfo &II = **it; 2740 2741 // Store a pascal-style length byte in the mnemonic. 2742 std::string LenMnemonic = char(II.Mnemonic.size()) + II.Mnemonic.str(); 2743 OS << " { " << StringTable.GetOrAddStringOffset(LenMnemonic, false) 2744 << " /* " << II.Mnemonic << " */, " 2745 << Target.getName() << "::" 2746 << II.getResultInst()->TheDef->getName() << ", " 2747 << II.ConversionFnKind << ", "; 2748 2749 // Write the required features mask. 2750 if (!II.RequiredFeatures.empty()) { 2751 for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) { 2752 if (i) OS << "|"; 2753 OS << II.RequiredFeatures[i]->getEnumName(); 2754 } 2755 } else 2756 OS << "0"; 2757 2758 OS << ", { "; 2759 for (unsigned i = 0, e = II.AsmOperands.size(); i != e; ++i) { 2760 MatchableInfo::AsmOperand &Op = II.AsmOperands[i]; 2761 2762 if (i) OS << ", "; 2763 OS << Op.Class->Name; 2764 } 2765 OS << " }, " << II.AsmVariantID; 2766 OS << "},\n"; 2767 } 2768 2769 OS << "};\n\n"; 2770 2771 OS << "const char *const MatchEntry::MnemonicTable =\n"; 2772 StringTable.EmitString(OS); 2773 OS << ";\n\n"; 2774 2775 // A method to determine if a mnemonic is in the list. 2776 OS << "bool " << Target.getName() << ClassName << "::\n" 2777 << "MnemonicIsValid(StringRef Mnemonic) {\n"; 2778 OS << " // Search the table.\n"; 2779 OS << " std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n"; 2780 OS << " std::equal_range(MatchTable, MatchTable+" 2781 << Info.Matchables.size() << ", Mnemonic, LessOpcode());\n"; 2782 OS << " return MnemonicRange.first != MnemonicRange.second;\n"; 2783 OS << "}\n\n"; 2784 2785 // Finally, build the match function. 2786 OS << "unsigned " 2787 << Target.getName() << ClassName << "::\n" 2788 << "MatchInstructionImpl(const SmallVectorImpl<MCParsedAsmOperand*>" 2789 << " &Operands,\n"; 2790 OS << " unsigned &Kind, MCInst &Inst, unsigned "; 2791 OS << "&ErrorInfo,\n unsigned VariantID) {\n"; 2792 2793 OS << " // Eliminate obvious mismatches.\n"; 2794 OS << " if (Operands.size() > " << (MaxNumOperands+1) << ") {\n"; 2795 OS << " ErrorInfo = " << (MaxNumOperands+1) << ";\n"; 2796 OS << " return Match_InvalidOperand;\n"; 2797 OS << " }\n\n"; 2798 2799 // Emit code to get the available features. 2800 OS << " // Get the current feature set.\n"; 2801 OS << " unsigned AvailableFeatures = getAvailableFeatures();\n\n"; 2802 2803 OS << " // Get the instruction mnemonic, which is the first token.\n"; 2804 OS << " StringRef Mnemonic = ((" << Target.getName() 2805 << "Operand*)Operands[0])->getToken();\n\n"; 2806 2807 if (HasMnemonicAliases) { 2808 OS << " // Process all MnemonicAliases to remap the mnemonic.\n"; 2809 OS << " // FIXME : Add an entry in AsmParserVariant to check this.\n"; 2810 OS << " if (!VariantID)\n"; 2811 OS << " applyMnemonicAliases(Mnemonic, AvailableFeatures);\n\n"; 2812 } 2813 2814 // Emit code to compute the class list for this operand vector. 2815 OS << " // Some state to try to produce better error messages.\n"; 2816 OS << " bool HadMatchOtherThanFeatures = false;\n"; 2817 OS << " bool HadMatchOtherThanPredicate = false;\n"; 2818 OS << " unsigned RetCode = Match_InvalidOperand;\n"; 2819 OS << " unsigned MissingFeatures = ~0U;\n"; 2820 OS << " // Set ErrorInfo to the operand that mismatches if it is\n"; 2821 OS << " // wrong for all instances of the instruction.\n"; 2822 OS << " ErrorInfo = ~0U;\n"; 2823 2824 // Emit code to search the table. 2825 OS << " // Search the table.\n"; 2826 OS << " std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n"; 2827 OS << " std::equal_range(MatchTable, MatchTable+" 2828 << Info.Matchables.size() << ", Mnemonic, LessOpcode());\n\n"; 2829 2830 OS << " // Return a more specific error code if no mnemonics match.\n"; 2831 OS << " if (MnemonicRange.first == MnemonicRange.second)\n"; 2832 OS << " return Match_MnemonicFail;\n\n"; 2833 2834 OS << " for (const MatchEntry *it = MnemonicRange.first, " 2835 << "*ie = MnemonicRange.second;\n"; 2836 OS << " it != ie; ++it) {\n"; 2837 2838 OS << " // equal_range guarantees that instruction mnemonic matches.\n"; 2839 OS << " assert(Mnemonic == it->getMnemonic());\n"; 2840 2841 // Emit check that the subclasses match. 2842 OS << " if (VariantID != it->AsmVariantID) continue;\n"; 2843 OS << " bool OperandsValid = true;\n"; 2844 OS << " for (unsigned i = 0; i != " << MaxNumOperands << "; ++i) {\n"; 2845 OS << " if (i + 1 >= Operands.size()) {\n"; 2846 OS << " OperandsValid = (it->Classes[i] == " <<"InvalidMatchClass);\n"; 2847 OS << " if (!OperandsValid) ErrorInfo = i + 1;\n"; 2848 OS << " break;\n"; 2849 OS << " }\n"; 2850 OS << " unsigned Diag = validateOperandClass(Operands[i+1],\n"; 2851 OS.indent(43); 2852 OS << "(MatchClassKind)it->Classes[i]);\n"; 2853 OS << " if (Diag == Match_Success)\n"; 2854 OS << " continue;\n"; 2855 OS << " // If this operand is broken for all of the instances of this\n"; 2856 OS << " // mnemonic, keep track of it so we can report loc info.\n"; 2857 OS << " // If we already had a match that only failed due to a\n"; 2858 OS << " // target predicate, that diagnostic is preferred.\n"; 2859 OS << " if (!HadMatchOtherThanPredicate &&\n"; 2860 OS << " (it == MnemonicRange.first || ErrorInfo <= i+1)) {\n"; 2861 OS << " ErrorInfo = i+1;\n"; 2862 OS << " // InvalidOperand is the default. Prefer specificity.\n"; 2863 OS << " if (Diag != Match_InvalidOperand)\n"; 2864 OS << " RetCode = Diag;\n"; 2865 OS << " }\n"; 2866 OS << " // Otherwise, just reject this instance of the mnemonic.\n"; 2867 OS << " OperandsValid = false;\n"; 2868 OS << " break;\n"; 2869 OS << " }\n\n"; 2870 2871 OS << " if (!OperandsValid) continue;\n"; 2872 2873 // Emit check that the required features are available. 2874 OS << " if ((AvailableFeatures & it->RequiredFeatures) " 2875 << "!= it->RequiredFeatures) {\n"; 2876 OS << " HadMatchOtherThanFeatures = true;\n"; 2877 OS << " unsigned NewMissingFeatures = it->RequiredFeatures & " 2878 "~AvailableFeatures;\n"; 2879 OS << " if (CountPopulation_32(NewMissingFeatures) <=\n" 2880 " CountPopulation_32(MissingFeatures))\n"; 2881 OS << " MissingFeatures = NewMissingFeatures;\n"; 2882 OS << " continue;\n"; 2883 OS << " }\n"; 2884 OS << "\n"; 2885 OS << " // We have selected a definite instruction, convert the parsed\n" 2886 << " // operands into the appropriate MCInst.\n"; 2887 OS << " convertToMCInst(it->ConvertFn, Inst, it->Opcode, Operands);\n"; 2888 OS << "\n"; 2889 2890 // Verify the instruction with the target-specific match predicate function. 2891 OS << " // We have a potential match. Check the target predicate to\n" 2892 << " // handle any context sensitive constraints.\n" 2893 << " unsigned MatchResult;\n" 2894 << " if ((MatchResult = checkTargetMatchPredicate(Inst)) !=" 2895 << " Match_Success) {\n" 2896 << " Inst.clear();\n" 2897 << " RetCode = MatchResult;\n" 2898 << " HadMatchOtherThanPredicate = true;\n" 2899 << " continue;\n" 2900 << " }\n\n"; 2901 2902 // Call the post-processing function, if used. 2903 std::string InsnCleanupFn = 2904 AsmParser->getValueAsString("AsmParserInstCleanup"); 2905 if (!InsnCleanupFn.empty()) 2906 OS << " " << InsnCleanupFn << "(Inst);\n"; 2907 2908 OS << " Kind = it->ConvertFn;\n"; 2909 OS << " return Match_Success;\n"; 2910 OS << " }\n\n"; 2911 2912 OS << " // Okay, we had no match. Try to return a useful error code.\n"; 2913 OS << " if (HadMatchOtherThanPredicate || !HadMatchOtherThanFeatures)\n"; 2914 OS << " return RetCode;\n\n"; 2915 OS << " // Missing feature matches return which features were missing\n"; 2916 OS << " ErrorInfo = MissingFeatures;\n"; 2917 OS << " return Match_MissingFeature;\n"; 2918 OS << "}\n\n"; 2919 2920 if (Info.OperandMatchInfo.size()) 2921 emitCustomOperandParsing(OS, Target, Info, ClassName); 2922 2923 OS << "#endif // GET_MATCHER_IMPLEMENTATION\n\n"; 2924} 2925 2926namespace llvm { 2927 2928void EmitAsmMatcher(RecordKeeper &RK, raw_ostream &OS) { 2929 emitSourceFileHeader("Assembly Matcher Source Fragment", OS); 2930 AsmMatcherEmitter(RK).run(OS); 2931} 2932 2933} // End llvm namespace 2934