utils/TableGen/AsmMatcherEmitter.cpp

   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.
  12 //
  13 // The input to the target specific matcher is a list of literal tokens and
  14 // operands. The target specific parser should generally eliminate any syntax
  15 // which is not relevant for matching; for example, comma tokens should have
  16 // already been consumed and eliminated by the parser. Most instructions will
  17 // end up with a single literal token (the instruction name) and some number of
  18 // operands.
  19 //
  20 // Some example inputs, for X86:
  21 //   'addl' (immediate ...) (register ...)
  22 //   'add' (immediate ...) (memory ...)
  23 //   'call' '*' %epc
  24 //
  25 // The assembly matcher is responsible for converting this input into a precise
  26 // machine instruction (i.e., an instruction with a well defined encoding). This
  27 // mapping has several properties which complicate matching:
  28 //
  29 //  - It may be ambiguous; many architectures can legally encode particular
  30 //    variants of an instruction in different ways (for example, using a smaller
  31 //    encoding for small immediates). Such ambiguities should never be
  32 //    arbitrarily resolved by the assembler, the assembler is always responsible
  33 //    for choosing the "best" available instruction.
  34 //
  35 //  - It may depend on the subtarget or the assembler context. Instructions
  36 //    which are invalid for the current mode, but otherwise unambiguous (e.g.,
  37 //    an SSE instruction in a file being assembled for i486) should be accepted
  38 //    and rejected by the assembler front end. However, if the proper encoding
  39 //    for an instruction is dependent on the assembler context then the matcher
  40 //    is responsible for selecting the correct machine instruction for the
  41 //    current mode.
  42 //
  43 // The core matching algorithm attempts to exploit the regularity in most
  44 // instruction sets to quickly determine the set of possibly matching
  45 // instructions, and the simplify the generated code. Additionally, this helps
  46 // to ensure that the ambiguities are intentionally resolved by the user.
  47 //
  48 // The matching is divided into two distinct phases:
  49 //
  50 //   1. Classification: Each operand is mapped to the unique set which (a)
  51 //      contains it, and (b) is the largest such subset for which a single
  52 //      instruction could match all members.
  53 //
  54 //      For register classes, we can generate these subgroups automatically. For
  55 //      arbitrary operands, we expect the user to define the classes and their
  56 //      relations to one another (for example, 8-bit signed immediates as a
  57 //      subset of 32-bit immediates).
  58 //
  59 //      By partitioning the operands in this way, we guarantee that for any
  60 //      tuple of classes, any single instruction must match either all or none
  61 //      of the sets of operands which could classify to that tuple.
  62 //
  63 //      In addition, the subset relation amongst classes induces a partial order
  64 //      on such tuples, which we use to resolve ambiguities.
  65 //
  66 //   2. The input can now be treated as a tuple of classes (static tokens are
  67 //      simple singleton sets). Each such tuple should generally map to a single
  68 //      instruction (we currently ignore cases where this isn't true, whee!!!),
  69 //      which we can emit a simple matcher for.
  70 //
  71 //===----------------------------------------------------------------------===//
  72
  73 #include "AsmMatcherEmitter.h"
  74 #include "CodeGenTarget.h"
  75 #include "Record.h"
  76 #include "StringMatcher.h"
  77 #include "llvm/ADT/OwningPtr.h"
  78 #include "llvm/ADT/PointerUnion.h"
  79 #include "llvm/ADT/SmallPtrSet.h"
  80 #include "llvm/ADT/SmallVector.h"
  81 #include "llvm/ADT/STLExtras.h"
  82 #include "llvm/ADT/StringExtras.h"
  83 #include "llvm/Support/CommandLine.h"
  84 #include "llvm/Support/Debug.h"
  85 #include <map>
  86 #include <set>
  87 using namespace llvm;
  88
  89 static cl::opt<std::string>
  90 MatchPrefix("match-prefix", cl::init(""),
  91             cl::desc("Only match instructions with the given prefix"));
  92
  93
  94 namespace {
  95   class AsmMatcherInfo;
  96 struct SubtargetFeatureInfo;
  97
  98 /// ClassInfo - Helper class for storing the information about a particular
  99 /// class of operands which can be matched.
 100 struct ClassInfo {
 101   enum ClassInfoKind {
 102     /// Invalid kind, for use as a sentinel value.
 103     Invalid = 0,
 104
 105     /// The class for a particular token.
 106     Token,
 107
 108     /// The (first) register class, subsequent register classes are
 109     /// RegisterClass0+1, and so on.
 110     RegisterClass0,
 111
 112     /// The (first) user defined class, subsequent user defined classes are
 113     /// UserClass0+1, and so on.
 114     UserClass0 = 1<<16
 115   };
 116
 117   /// Kind - The class kind, which is either a predefined kind, or (UserClass0 +
 118   /// N) for the Nth user defined class.
 119   unsigned Kind;
 120
 121   /// SuperClasses - The super classes of this class. Note that for simplicities
 122   /// sake user operands only record their immediate super class, while register
 123   /// operands include all superclasses.
 124   std::vector<ClassInfo*> SuperClasses;
 125
 126   /// Name - The full class name, suitable for use in an enum.
 127   std::string Name;
 128
 129   /// ClassName - The unadorned generic name for this class (e.g., Token).
 130   std::string ClassName;
 131
 132   /// ValueName - The name of the value this class represents; for a token this
 133   /// is the literal token string, for an operand it is the TableGen class (or
 134   /// empty if this is a derived class).
 135   std::string ValueName;
 136
 137   /// PredicateMethod - The name of the operand method to test whether the
 138   /// operand matches this class; this is not valid for Token or register kinds.
 139   std::string PredicateMethod;
 140
 141   /// RenderMethod - The name of the operand method to add this operand to an
 142   /// MCInst; this is not valid for Token or register kinds.
 143   std::string RenderMethod;
 144
 145   /// For register classes, the records for all the registers in this class.
 146   std::set<Record*> Registers;
 147
 148 public:
 149   /// isRegisterClass() - Check if this is a register class.
 150   bool isRegisterClass() const {
 151     return Kind >= RegisterClass0 && Kind < UserClass0;
 152   }
 153
 154   /// isUserClass() - Check if this is a user defined class.
 155   bool isUserClass() const {
 156     return Kind >= UserClass0;
 157   }
 158
 159   /// isRelatedTo - Check whether this class is "related" to \arg RHS. Classes
 160   /// are related if they are in the same class hierarchy.
 161   bool isRelatedTo(const ClassInfo &RHS) const {
 162     // Tokens are only related to tokens.
 163     if (Kind == Token || RHS.Kind == Token)
 164       return Kind == Token && RHS.Kind == Token;
 165
 166     // Registers classes are only related to registers classes, and only if
 167     // their intersection is non-empty.
 168     if (isRegisterClass() || RHS.isRegisterClass()) {
 169       if (!isRegisterClass() || !RHS.isRegisterClass())
 170         return false;
 171
 172       std::set<Record*> Tmp;
 173       std::insert_iterator< std::set<Record*> > II(Tmp, Tmp.begin());
 174       std::set_intersection(Registers.begin(), Registers.end(),
 175                             RHS.Registers.begin(), RHS.Registers.end(),
 176                             II);
 177
 178       return !Tmp.empty();
 179     }
 180
 181     // Otherwise we have two users operands; they are related if they are in the
 182     // same class hierarchy.
 183     //
 184     // FIXME: This is an oversimplification, they should only be related if they
 185     // intersect, however we don't have that information.
 186     assert(isUserClass() && RHS.isUserClass() && "Unexpected class!");
 187     const ClassInfo *Root = this;
 188     while (!Root->SuperClasses.empty())
 189       Root = Root->SuperClasses.front();
 190
 191     const ClassInfo *RHSRoot = &RHS;
 192     while (!RHSRoot->SuperClasses.empty())
 193       RHSRoot = RHSRoot->SuperClasses.front();
 194
 195     return Root == RHSRoot;
 196   }
 197
 198   /// isSubsetOf - Test whether this class is a subset of \arg RHS;
 199   bool isSubsetOf(const ClassInfo &RHS) const {
 200     // This is a subset of RHS if it is the same class...
 201     if (this == &RHS)
 202       return true;
 203
 204     // ... or if any of its super classes are a subset of RHS.
 205     for (std::vector<ClassInfo*>::const_iterator it = SuperClasses.begin(),
 206            ie = SuperClasses.end(); it != ie; ++it)
 207       if ((*it)->isSubsetOf(RHS))
 208         return true;
 209
 210     return false;
 211   }
 212
 213   /// operator< - Compare two classes.
 214   bool operator<(const ClassInfo &RHS) const {
 215     if (this == &RHS)
 216       return false;
 217
 218     // Unrelated classes can be ordered by kind.
 219     if (!isRelatedTo(RHS))
 220       return Kind < RHS.Kind;
 221
 222     switch (Kind) {
 223     case Invalid:
 224       assert(0 && "Invalid kind!");
 225     case Token:
 226       // Tokens are comparable by value.
 227       //
 228       // FIXME: Compare by enum value.
 229       return ValueName < RHS.ValueName;
 230
 231     default:
 232       // This class preceeds the RHS if it is a proper subset of the RHS.
 233       if (isSubsetOf(RHS))
 234         return true;
 235       if (RHS.isSubsetOf(*this))
 236         return false;
 237
 238       // Otherwise, order by name to ensure we have a total ordering.
 239       return ValueName < RHS.ValueName;
 240     }
 241   }
 242 };
 243
 244 /// MatchableInfo - Helper class for storing the necessary information for an
 245 /// instruction or alias which is capable of being matched.
 246 struct MatchableInfo {
 247   struct AsmOperand {
 248     /// Token - This is the token that the operand came from.
 249     StringRef Token;
 250
 251     /// The unique class instance this operand should match.
 252     ClassInfo *Class;
 253
 254     /// The operand name this is, if anything.
 255     StringRef SrcOpName;
 256
 257     explicit AsmOperand(StringRef T) : Token(T), Class(0) {}
 258   };
 259
 260   /// ResOperand - This represents a single operand in the result instruction
 261   /// generated by the match.  In cases (like addressing modes) where a single
 262   /// assembler operand expands to multiple MCOperands, this represents the
 263   /// single assembler operand, not the MCOperand.
 264   struct ResOperand {
 265     enum {
 266       /// RenderAsmOperand - This represents an operand result that is
 267       /// generated by calling the render method on the assembly operand.  The
 268       /// corresponding AsmOperand is specified by AsmOperandNum.
 269       RenderAsmOperand,
 270
 271       /// TiedOperand - This represents a result operand that is a duplicate of
 272       /// a previous result operand.
 273       TiedOperand,
 274
 275       /// ImmOperand - This represents an immediate value that is dumped into
 276       /// the operand.
 277       ImmOperand,
 278
 279       /// RegOperand - This represents a fixed register that is dumped in.
 280       RegOperand
 281     } Kind;
 282
 283     union {
 284       /// This is the operand # in the AsmOperands list that this should be
 285       /// copied from.
 286       unsigned AsmOperandNum;
 287
 288       /// TiedOperandNum - This is the (earlier) result operand that should be
 289       /// copied from.
 290       unsigned TiedOperandNum;
 291
 292       /// ImmVal - This is the immediate value added to the instruction.
 293       int64_t ImmVal;
 294
 295       /// Register - This is the register record.
 296       Record *Register;
 297     };
 298
 299     /// OpInfo - This is the information about the instruction operand that is
 300     /// being populated.
 301     const CGIOperandList::OperandInfo *OpInfo;
 302
 303     static ResOperand getRenderedOp(unsigned AsmOpNum,
 304                                     const CGIOperandList::OperandInfo *Op) {
 305       ResOperand X;
 306       X.Kind = RenderAsmOperand;
 307       X.AsmOperandNum = AsmOpNum;
 308       X.OpInfo = Op;
 309       return X;
 310     }
 311
 312     static ResOperand getTiedOp(unsigned TiedOperandNum,
 313                                 const CGIOperandList::OperandInfo *Op) {
 314       ResOperand X;
 315       X.Kind = TiedOperand;
 316       X.TiedOperandNum = TiedOperandNum;
 317       X.OpInfo = Op;
 318       return X;
 319     }
 320
 321     static ResOperand getImmOp(int64_t Val,
 322                                const CGIOperandList::OperandInfo *Op) {
 323       ResOperand X;
 324       X.Kind = ImmOperand;
 325       X.ImmVal = Val;
 326       X.OpInfo = Op;
 327       return X;
 328     }
 329
 330     static ResOperand getRegOp(Record *Reg,
 331                                const CGIOperandList::OperandInfo *Op) {
 332       ResOperand X;
 333       X.Kind = RegOperand;
 334       X.Register = Reg;
 335       X.OpInfo = Op;
 336       return X;
 337     }
 338
 339   };
 340
 341   /// TheDef - This is the definition of the instruction or InstAlias that this
 342   /// matchable came from.
 343   Record *const TheDef;
 344
 345   /// DefRec - This is the definition that it came from.
 346   PointerUnion<const CodeGenInstruction*, const CodeGenInstAlias*> DefRec;
 347
 348   const CodeGenInstruction *getResultInst() const {
 349     if (DefRec.is<const CodeGenInstruction*>())
 350       return DefRec.get<const CodeGenInstruction*>();
 351     return DefRec.get<const CodeGenInstAlias*>()->ResultInst;
 352   }
 353
 354   /// ResOperands - This is the operand list that should be built for the result
 355   /// MCInst.
 356   std::vector<ResOperand> ResOperands;
 357
 358   /// AsmString - The assembly string for this instruction (with variants
 359   /// removed), e.g. "movsx $src, $dst".
 360   std::string AsmString;
 361
 362   /// Mnemonic - This is the first token of the matched instruction, its
 363   /// mnemonic.
 364   StringRef Mnemonic;
 365
 366   /// AsmOperands - The textual operands that this instruction matches,
 367   /// annotated with a class and where in the OperandList they were defined.
 368   /// This directly corresponds to the tokenized AsmString after the mnemonic is
 369   /// removed.
 370   SmallVector<AsmOperand, 4> AsmOperands;
 371
 372   /// Predicates - The required subtarget features to match this instruction.
 373   SmallVector<SubtargetFeatureInfo*, 4> RequiredFeatures;
 374
 375   /// ConversionFnKind - The enum value which is passed to the generated
 376   /// ConvertToMCInst to convert parsed operands into an MCInst for this
 377   /// function.
 378   std::string ConversionFnKind;
 379
 380   MatchableInfo(const CodeGenInstruction &CGI)
 381     : TheDef(CGI.TheDef), DefRec(&CGI), AsmString(CGI.AsmString) {
 382   }
 383
 384   MatchableInfo(const CodeGenInstAlias *Alias)
 385     : TheDef(Alias->TheDef), DefRec(Alias), AsmString(Alias->AsmString) {
 386   }
 387
 388   void Initialize(const AsmMatcherInfo &Info,
 389                   SmallPtrSet<Record*, 16> &SingletonRegisters);
 390
 391   /// Validate - Return true if this matchable is a valid thing to match against
 392   /// and perform a bunch of validity checking.
 393   bool Validate(StringRef CommentDelimiter, bool Hack) const;
 394
 395   /// getSingletonRegisterForAsmOperand - If the specified token is a singleton
 396   /// register, return the Record for it, otherwise return null.
 397   Record *getSingletonRegisterForAsmOperand(unsigned i,
 398                                             const AsmMatcherInfo &Info) const;
 399
 400   int FindAsmOperandNamed(StringRef N) const {
 401     for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
 402       if (N == AsmOperands[i].SrcOpName)
 403         return i;
 404     return -1;
 405   }
 406
 407   void BuildInstructionResultOperands();
 408   void BuildAliasResultOperands();
 409
 410   /// operator< - Compare two matchables.
 411   bool operator<(const MatchableInfo &RHS) const {
 412     // The primary comparator is the instruction mnemonic.
 413     if (Mnemonic != RHS.Mnemonic)
 414       return Mnemonic < RHS.Mnemonic;
 415
 416     if (AsmOperands.size() != RHS.AsmOperands.size())
 417       return AsmOperands.size() < RHS.AsmOperands.size();
 418
 419     // Compare lexicographically by operand. The matcher validates that other
 420     // orderings wouldn't be ambiguous using \see CouldMatchAmiguouslyWith().
 421     for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 422       if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
 423         return true;
 424       if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
 425         return false;
 426     }
 427
 428     return false;
 429   }
 430
 431   /// CouldMatchAmiguouslyWith - Check whether this matchable could
 432   /// ambiguously match the same set of operands as \arg RHS (without being a
 433   /// strictly superior match).
 434   bool CouldMatchAmiguouslyWith(const MatchableInfo &RHS) {
 435     // The primary comparator is the instruction mnemonic.
 436     if (Mnemonic != RHS.Mnemonic)
 437       return false;
 438
 439     // The number of operands is unambiguous.
 440     if (AsmOperands.size() != RHS.AsmOperands.size())
 441       return false;
 442
 443     // Otherwise, make sure the ordering of the two instructions is unambiguous
 444     // by checking that either (a) a token or operand kind discriminates them,
 445     // or (b) the ordering among equivalent kinds is consistent.
 446
 447     // Tokens and operand kinds are unambiguous (assuming a correct target
 448     // specific parser).
 449     for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i)
 450       if (AsmOperands[i].Class->Kind != RHS.AsmOperands[i].Class->Kind ||
 451           AsmOperands[i].Class->Kind == ClassInfo::Token)
 452         if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class ||
 453             *RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
 454           return false;
 455
 456     // Otherwise, this operand could commute if all operands are equivalent, or
 457     // there is a pair of operands that compare less than and a pair that
 458     // compare greater than.
 459     bool HasLT = false, HasGT = false;
 460     for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 461       if (*AsmOperands[i].Class < *RHS.AsmOperands[i].Class)
 462         HasLT = true;
 463       if (*RHS.AsmOperands[i].Class < *AsmOperands[i].Class)
 464         HasGT = true;
 465     }
 466
 467     return !(HasLT ^ HasGT);
 468   }
 469
 470   void dump();
 471
 472 private:
 473   void TokenizeAsmString(const AsmMatcherInfo &Info);
 474 };
 475
 476 /// SubtargetFeatureInfo - Helper class for storing information on a subtarget
 477 /// feature which participates in instruction matching.
 478 struct SubtargetFeatureInfo {
 479   /// \brief The predicate record for this feature.
 480   Record *TheDef;
 481
 482   /// \brief An unique index assigned to represent this feature.
 483   unsigned Index;
 484
 485   SubtargetFeatureInfo(Record *D, unsigned Idx) : TheDef(D), Index(Idx) {}
 486
 487   /// \brief The name of the enumerated constant identifying this feature.
 488   std::string getEnumName() const {
 489     return "Feature_" + TheDef->getName();
 490   }
 491 };
 492
 493 class AsmMatcherInfo {
 494 public:
 495   /// Tracked Records
 496   RecordKeeper& Records;
 497
 498   /// The tablegen AsmParser record.
 499   Record *AsmParser;
 500
 501   /// Target - The target information.
 502   CodeGenTarget &Target;
 503
 504   /// The AsmParser "RegisterPrefix" value.
 505   std::string RegisterPrefix;
 506
 507   /// The classes which are needed for matching.
 508   std::vector<ClassInfo*> Classes;
 509
 510   /// The information on the matchables to match.
 511   std::vector<MatchableInfo*> Matchables;
 512
 513   /// Map of Register records to their class information.
 514   std::map<Record*, ClassInfo*> RegisterClasses;
 515
 516   /// Map of Predicate records to their subtarget information.
 517   std::map<Record*, SubtargetFeatureInfo*> SubtargetFeatures;
 518
 519 private:
 520   /// Map of token to class information which has already been constructed.
 521   std::map<std::string, ClassInfo*> TokenClasses;
 522
 523   /// Map of RegisterClass records to their class information.
 524   std::map<Record*, ClassInfo*> RegisterClassClasses;
 525
 526   /// Map of AsmOperandClass records to their class information.
 527   std::map<Record*, ClassInfo*> AsmOperandClasses;
 528
 529 private:
 530   /// getTokenClass - Lookup or create the class for the given token.
 531   ClassInfo *getTokenClass(StringRef Token);
 532
 533   /// getOperandClass - Lookup or create the class for the given operand.
 534   ClassInfo *getOperandClass(const CGIOperandList::OperandInfo &OI);
 535
 536   /// BuildRegisterClasses - Build the ClassInfo* instances for register
 537   /// classes.
 538   void BuildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters);
 539
 540   /// BuildOperandClasses - Build the ClassInfo* instances for user defined
 541   /// operand classes.
 542   void BuildOperandClasses();
 543
 544   void BuildInstructionOperandReference(MatchableInfo *II,
 545                                         StringRef OpName,
 546                                         MatchableInfo::AsmOperand &Op);
 547   void BuildAliasOperandReference(MatchableInfo *II,
 548                                   StringRef OpName,
 549                                   MatchableInfo::AsmOperand &Op);
 550
 551 public:
 552   AsmMatcherInfo(Record *AsmParser,
 553                  CodeGenTarget &Target,
 554                  RecordKeeper& Records);
 555
 556   /// BuildInfo - Construct the various tables used during matching.
 557   void BuildInfo();
 558
 559   /// getSubtargetFeature - Lookup or create the subtarget feature info for the
 560   /// given operand.
 561   SubtargetFeatureInfo *getSubtargetFeature(Record *Def) const {
 562     assert(Def->isSubClassOf("Predicate") && "Invalid predicate type!");
 563     std::map<Record*, SubtargetFeatureInfo*>::const_iterator I =
 564       SubtargetFeatures.find(Def);
 565     return I == SubtargetFeatures.end() ? 0 : I->second;
 566   }
 567
 568   RecordKeeper& getRecords() {
 569     return(Records);
 570   }
 571
 572   RecordKeeper& getRecords() const {
 573     return(Records);
 574   }
 575 };
 576
 577 }
 578
 579 void MatchableInfo::dump() {
 580   errs() << TheDef->getName() << " -- " << "flattened:\"" << AsmString <<"\"\n";
 581
 582   for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 583     AsmOperand &Op = AsmOperands[i];
 584     errs() << "  op[" << i << "] = " << Op.Class->ClassName << " - ";
 585     errs() << '\"' << Op.Token << "\"\n";
 586   }
 587 }
 588
 589 void MatchableInfo::Initialize(const AsmMatcherInfo &Info,
 590                                SmallPtrSet<Record*, 16> &SingletonRegisters) {
 591   // TODO: Eventually support asmparser for Variant != 0.
 592   AsmString = CodeGenInstruction::FlattenAsmStringVariants(AsmString, 0);
 593
 594   TokenizeAsmString(Info);
 595
 596   // Compute the require features.
 597   std::vector<Record*> Predicates =TheDef->getValueAsListOfDefs("Predicates");
 598   for (unsigned i = 0, e = Predicates.size(); i != e; ++i)
 599     if (SubtargetFeatureInfo *Feature =
 600         Info.getSubtargetFeature(Predicates[i]))
 601       RequiredFeatures.push_back(Feature);
 602
 603   // Collect singleton registers, if used.
 604   for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 605     if (Record *Reg = getSingletonRegisterForAsmOperand(i, Info))
 606       SingletonRegisters.insert(Reg);
 607   }
 608 }
 609
 610 /// TokenizeAsmString - Tokenize a simplified assembly string.
 611 void MatchableInfo::TokenizeAsmString(const AsmMatcherInfo &Info) {
 612   StringRef String = AsmString;
 613   unsigned Prev = 0;
 614   bool InTok = true;
 615   for (unsigned i = 0, e = String.size(); i != e; ++i) {
 616     switch (String[i]) {
 617     case '[':
 618     case ']':
 619     case '*':
 620     case '!':
 621     case ' ':
 622     case '\t':
 623     case ',':
 624       if (InTok) {
 625         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 626         InTok = false;
 627       }
 628       if (!isspace(String[i]) && String[i] != ',')
 629         AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
 630       Prev = i + 1;
 631       break;
 632
 633     case '\\':
 634       if (InTok) {
 635         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 636         InTok = false;
 637       }
 638       ++i;
 639       assert(i != String.size() && "Invalid quoted character");
 640       AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
 641       Prev = i + 1;
 642       break;
 643
 644     case '$': {
 645       if (InTok) {
 646         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 647         InTok = false;
 648       }
 649
 650       // If this isn't "${", treat like a normal token.
 651       if (i + 1 == String.size() || String[i + 1] != '{') {
 652         Prev = i;
 653         break;
 654       }
 655
 656       StringRef::iterator End = std::find(String.begin() + i, String.end(),'}');
 657       assert(End != String.end() && "Missing brace in operand reference!");
 658       size_t EndPos = End - String.begin();
 659       AsmOperands.push_back(AsmOperand(String.slice(i, EndPos+1)));
 660       Prev = EndPos + 1;
 661       i = EndPos;
 662       break;
 663     }
 664
 665     case '.':
 666       if (InTok)
 667         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 668       Prev = i;
 669       InTok = true;
 670       break;
 671
 672     default:
 673       InTok = true;
 674     }
 675   }
 676   if (InTok && Prev != String.size())
 677     AsmOperands.push_back(AsmOperand(String.substr(Prev)));
 678
 679   // The first token of the instruction is the mnemonic, which must be a
 680   // simple string, not a $foo variable or a singleton register.
 681   assert(!AsmOperands.empty() && "Instruction has no tokens?");
 682   Mnemonic = AsmOperands[0].Token;
 683   if (Mnemonic[0] == '$' || getSingletonRegisterForAsmOperand(0, Info))
 684     throw TGError(TheDef->getLoc(),
 685                   "Invalid instruction mnemonic '" + Mnemonic.str() + "'!");
 686
 687   // Remove the first operand, it is tracked in the mnemonic field.
 688   AsmOperands.erase(AsmOperands.begin());
 689 }
 690
 691
 692
 693 bool MatchableInfo::Validate(StringRef CommentDelimiter, bool Hack) const {
 694   // Reject matchables with no .s string.
 695   if (AsmString.empty())
 696     throw TGError(TheDef->getLoc(), "instruction with empty asm string");
 697
 698   // Reject any matchables with a newline in them, they should be marked
 699   // isCodeGenOnly if they are pseudo instructions.
 700   if (AsmString.find('\n') != std::string::npos)
 701     throw TGError(TheDef->getLoc(),
 702                   "multiline instruction is not valid for the asmparser, "
 703                   "mark it isCodeGenOnly");
 704
 705   // Remove comments from the asm string.  We know that the asmstring only
 706   // has one line.
 707   if (!CommentDelimiter.empty() &&
 708       StringRef(AsmString).find(CommentDelimiter) != StringRef::npos)
 709     throw TGError(TheDef->getLoc(),
 710                   "asmstring for instruction has comment character in it, "
 711                   "mark it isCodeGenOnly");
 712
 713   // Reject matchables with operand modifiers, these aren't something we can
 714   /// handle, the target should be refactored to use operands instead of
 715   /// modifiers.
 716   //
 717   // Also, check for instructions which reference the operand multiple times;
 718   // this implies a constraint we would not honor.
 719   std::set<std::string> OperandNames;
 720   for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 721     StringRef Tok = AsmOperands[i].Token;
 722     if (Tok[0] == '$' && Tok.find(':') != StringRef::npos)
 723       throw TGError(TheDef->getLoc(),
 724                     "matchable with operand modifier '" + Tok.str() +
 725                     "' not supported by asm matcher.  Mark isCodeGenOnly!");
 726
 727     // Verify that any operand is only mentioned once.
 728     // We reject aliases and ignore instructions for now.
 729     if (Tok[0] == '$' && !OperandNames.insert(Tok).second) {
 730       if (!Hack)
 731         throw TGError(TheDef->getLoc(),
 732                       "ERROR: matchable with tied operand '" + Tok.str() +
 733                       "' can never be matched!");
 734       // FIXME: Should reject these.  The ARM backend hits this with $lane in a
 735       // bunch of instructions.  It is unclear what the right answer is.
 736       DEBUG({
 737         errs() << "warning: '" << TheDef->getName() << "': "
 738                << "ignoring instruction with tied operand '"
 739                << Tok.str() << "'\n";
 740       });
 741       return false;
 742     }
 743   }
 744
 745   return true;
 746 }
 747
 748
 749 /// getSingletonRegisterForAsmOperand - If the specified token is a singleton
 750 /// register, return the register name, otherwise return a null StringRef.
 751 Record *MatchableInfo::
 752 getSingletonRegisterForAsmOperand(unsigned i, const AsmMatcherInfo &Info) const{
 753   StringRef Tok = AsmOperands[i].Token;
 754   if (!Tok.startswith(Info.RegisterPrefix))
 755     return 0;
 756
 757   StringRef RegName = Tok.substr(Info.RegisterPrefix.size());
 758   if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(RegName))
 759     return Reg->TheDef;
 760
 761   // If there is no register prefix (i.e. "%" in "%eax"), then this may
 762   // be some random non-register token, just ignore it.
 763   if (Info.RegisterPrefix.empty())
 764     return 0;
 765
 766   // Otherwise, we have something invalid prefixed with the register prefix,
 767   // such as %foo.
 768   std::string Err = "unable to find register for '" + RegName.str() +
 769   "' (which matches register prefix)";
 770   throw TGError(TheDef->getLoc(), Err);
 771 }
 772
 773
 774 static std::string getEnumNameForToken(StringRef Str) {
 775   std::string Res;
 776
 777   for (StringRef::iterator it = Str.begin(), ie = Str.end(); it != ie; ++it) {
 778     switch (*it) {
 779     case '*': Res += "_STAR_"; break;
 780     case '%': Res += "_PCT_"; break;
 781     case ':': Res += "_COLON_"; break;
 782     case '!': Res += "_EXCLAIM_"; break;
 783     default:
 784       if (isalnum(*it))
 785         Res += *it;
 786       else
 787         Res += "_" + utostr((unsigned) *it) + "_";
 788     }
 789   }
 790
 791   return Res;
 792 }
 793
 794 ClassInfo *AsmMatcherInfo::getTokenClass(StringRef Token) {
 795   ClassInfo *&Entry = TokenClasses[Token];
 796
 797   if (!Entry) {
 798     Entry = new ClassInfo();
 799     Entry->Kind = ClassInfo::Token;
 800     Entry->ClassName = "Token";
 801     Entry->Name = "MCK_" + getEnumNameForToken(Token);
 802     Entry->ValueName = Token;
 803     Entry->PredicateMethod = "<invalid>";
 804     Entry->RenderMethod = "<invalid>";
 805     Classes.push_back(Entry);
 806   }
 807
 808   return Entry;
 809 }
 810
 811 ClassInfo *
 812 AsmMatcherInfo::getOperandClass(const CGIOperandList::OperandInfo &OI) {
 813   if (OI.Rec->isSubClassOf("RegisterClass")) {
 814     if (ClassInfo *CI = RegisterClassClasses[OI.Rec])
 815       return CI;
 816     throw TGError(OI.Rec->getLoc(), "register class has no class info!");
 817   }
 818
 819   assert(OI.Rec->isSubClassOf("Operand") && "Unexpected operand!");
 820   Record *MatchClass = OI.Rec->getValueAsDef("ParserMatchClass");
 821   if (ClassInfo *CI = AsmOperandClasses[MatchClass])
 822     return CI;
 823
 824   throw TGError(OI.Rec->getLoc(), "operand has no match class!");
 825 }
 826
 827 void AsmMatcherInfo::
 828 BuildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters) {
 829   const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
 830   const std::vector<CodeGenRegisterClass> &RegClassList =
 831     Target.getRegisterClasses();
 832
 833   // The register sets used for matching.
 834   std::set< std::set<Record*> > RegisterSets;
 835
 836   // Gather the defined sets.
 837   for (std::vector<CodeGenRegisterClass>::const_iterator it =
 838        RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it)
 839     RegisterSets.insert(std::set<Record*>(it->Elements.begin(),
 840                                           it->Elements.end()));
 841
 842   // Add any required singleton sets.
 843   for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(),
 844        ie = SingletonRegisters.end(); it != ie; ++it) {
 845     Record *Rec = *it;
 846     RegisterSets.insert(std::set<Record*>(&Rec, &Rec + 1));
 847   }
 848
 849   // Introduce derived sets where necessary (when a register does not determine
 850   // a unique register set class), and build the mapping of registers to the set
 851   // they should classify to.
 852   std::map<Record*, std::set<Record*> > RegisterMap;
 853   for (std::vector<CodeGenRegister>::const_iterator it = Registers.begin(),
 854          ie = Registers.end(); it != ie; ++it) {
 855     const CodeGenRegister &CGR = *it;
 856     // Compute the intersection of all sets containing this register.
 857     std::set<Record*> ContainingSet;
 858
 859     for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
 860            ie = RegisterSets.end(); it != ie; ++it) {
 861       if (!it->count(CGR.TheDef))
 862         continue;
 863
 864       if (ContainingSet.empty()) {
 865         ContainingSet = *it;
 866         continue;
 867       }
 868
 869       std::set<Record*> Tmp;
 870       std::swap(Tmp, ContainingSet);
 871       std::insert_iterator< std::set<Record*> > II(ContainingSet,
 872                                                    ContainingSet.begin());
 873       std::set_intersection(Tmp.begin(), Tmp.end(), it->begin(), it->end(), II);
 874     }
 875
 876     if (!ContainingSet.empty()) {
 877       RegisterSets.insert(ContainingSet);
 878       RegisterMap.insert(std::make_pair(CGR.TheDef, ContainingSet));
 879     }
 880   }
 881
 882   // Construct the register classes.
 883   std::map<std::set<Record*>, ClassInfo*> RegisterSetClasses;
 884   unsigned Index = 0;
 885   for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
 886          ie = RegisterSets.end(); it != ie; ++it, ++Index) {
 887     ClassInfo *CI = new ClassInfo();
 888     CI->Kind = ClassInfo::RegisterClass0 + Index;
 889     CI->ClassName = "Reg" + utostr(Index);
 890     CI->Name = "MCK_Reg" + utostr(Index);
 891     CI->ValueName = "";
 892     CI->PredicateMethod = ""; // unused
 893     CI->RenderMethod = "addRegOperands";
 894     CI->Registers = *it;
 895     Classes.push_back(CI);
 896     RegisterSetClasses.insert(std::make_pair(*it, CI));
 897   }
 898
 899   // Find the superclasses; we could compute only the subgroup lattice edges,
 900   // but there isn't really a point.
 901   for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
 902          ie = RegisterSets.end(); it != ie; ++it) {
 903     ClassInfo *CI = RegisterSetClasses[*it];
 904     for (std::set< std::set<Record*> >::iterator it2 = RegisterSets.begin(),
 905            ie2 = RegisterSets.end(); it2 != ie2; ++it2)
 906       if (*it != *it2 &&
 907           std::includes(it2->begin(), it2->end(), it->begin(), it->end()))
 908         CI->SuperClasses.push_back(RegisterSetClasses[*it2]);
 909   }
 910
 911   // Name the register classes which correspond to a user defined RegisterClass.
 912   for (std::vector<CodeGenRegisterClass>::const_iterator
 913        it = RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it) {
 914     ClassInfo *CI = RegisterSetClasses[std::set<Record*>(it->Elements.begin(),
 915                                                          it->Elements.end())];
 916     if (CI->ValueName.empty()) {
 917       CI->ClassName = it->getName();
 918       CI->Name = "MCK_" + it->getName();
 919       CI->ValueName = it->getName();
 920     } else
 921       CI->ValueName = CI->ValueName + "," + it->getName();
 922
 923     RegisterClassClasses.insert(std::make_pair(it->TheDef, CI));
 924   }
 925
 926   // Populate the map for individual registers.
 927   for (std::map<Record*, std::set<Record*> >::iterator it = RegisterMap.begin(),
 928          ie = RegisterMap.end(); it != ie; ++it)
 929     RegisterClasses[it->first] = RegisterSetClasses[it->second];
 930
 931   // Name the register classes which correspond to singleton registers.
 932   for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(),
 933          ie = SingletonRegisters.end(); it != ie; ++it) {
 934     Record *Rec = *it;
 935     ClassInfo *CI = RegisterClasses[Rec];
 936     assert(CI && "Missing singleton register class info!");
 937
 938     if (CI->ValueName.empty()) {
 939       CI->ClassName = Rec->getName();
 940       CI->Name = "MCK_" + Rec->getName();
 941       CI->ValueName = Rec->getName();
 942     } else
 943       CI->ValueName = CI->ValueName + "," + Rec->getName();
 944   }
 945 }
 946
 947 void AsmMatcherInfo::BuildOperandClasses() {
 948   std::vector<Record*> AsmOperands =
 949     Records.getAllDerivedDefinitions("AsmOperandClass");
 950
 951   // Pre-populate AsmOperandClasses map.
 952   for (std::vector<Record*>::iterator it = AsmOperands.begin(),
 953          ie = AsmOperands.end(); it != ie; ++it)
 954     AsmOperandClasses[*it] = new ClassInfo();
 955
 956   unsigned Index = 0;
 957   for (std::vector<Record*>::iterator it = AsmOperands.begin(),
 958          ie = AsmOperands.end(); it != ie; ++it, ++Index) {
 959     ClassInfo *CI = AsmOperandClasses[*it];
 960     CI->Kind = ClassInfo::UserClass0 + Index;
 961
 962     ListInit *Supers = (*it)->getValueAsListInit("SuperClasses");
 963     for (unsigned i = 0, e = Supers->getSize(); i != e; ++i) {
 964       DefInit *DI = dynamic_cast<DefInit*>(Supers->getElement(i));
 965       if (!DI) {
 966         PrintError((*it)->getLoc(), "Invalid super class reference!");
 967         continue;
 968       }
 969
 970       ClassInfo *SC = AsmOperandClasses[DI->getDef()];
 971       if (!SC)
 972         PrintError((*it)->getLoc(), "Invalid super class reference!");
 973       else
 974         CI->SuperClasses.push_back(SC);
 975     }
 976     CI->ClassName = (*it)->getValueAsString("Name");
 977     CI->Name = "MCK_" + CI->ClassName;
 978     CI->ValueName = (*it)->getName();
 979
 980     // Get or construct the predicate method name.
 981     Init *PMName = (*it)->getValueInit("PredicateMethod");
 982     if (StringInit *SI = dynamic_cast<StringInit*>(PMName)) {
 983       CI->PredicateMethod = SI->getValue();
 984     } else {
 985       assert(dynamic_cast<UnsetInit*>(PMName) &&
 986              "Unexpected PredicateMethod field!");
 987       CI->PredicateMethod = "is" + CI->ClassName;
 988     }
 989
 990     // Get or construct the render method name.
 991     Init *RMName = (*it)->getValueInit("RenderMethod");
 992     if (StringInit *SI = dynamic_cast<StringInit*>(RMName)) {
 993       CI->RenderMethod = SI->getValue();
 994     } else {
 995       assert(dynamic_cast<UnsetInit*>(RMName) &&
 996              "Unexpected RenderMethod field!");
 997       CI->RenderMethod = "add" + CI->ClassName + "Operands";
 998     }
 999
1000     AsmOperandClasses[*it] = CI;
1001     Classes.push_back(CI);
1002   }
1003 }
1004
1005 AsmMatcherInfo::AsmMatcherInfo(Record *asmParser,
1006                                CodeGenTarget &target,
1007                                RecordKeeper& records)
1008   : Records(records), AsmParser(asmParser), Target(target),
1009     RegisterPrefix(AsmParser->getValueAsString("RegisterPrefix")) {
1010 }
1011
1012
1013 void AsmMatcherInfo::BuildInfo() {
1014   // Build information about all of the AssemblerPredicates.
1015   std::vector<Record*> AllPredicates =
1016     Records.getAllDerivedDefinitions("Predicate");
1017   for (unsigned i = 0, e = AllPredicates.size(); i != e; ++i) {
1018     Record *Pred = AllPredicates[i];
1019     // Ignore predicates that are not intended for the assembler.
1020     if (!Pred->getValueAsBit("AssemblerMatcherPredicate"))
1021       continue;
1022
1023     if (Pred->getName().empty())
1024       throw TGError(Pred->getLoc(), "Predicate has no name!");
1025
1026     unsigned FeatureNo = SubtargetFeatures.size();
1027     SubtargetFeatures[Pred] = new SubtargetFeatureInfo(Pred, FeatureNo);
1028     assert(FeatureNo < 32 && "Too many subtarget features!");
1029   }
1030
1031   StringRef CommentDelimiter = AsmParser->getValueAsString("CommentDelimiter");
1032
1033   // Parse the instructions; we need to do this first so that we can gather the
1034   // singleton register classes.
1035   SmallPtrSet<Record*, 16> SingletonRegisters;
1036   for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
1037        E = Target.inst_end(); I != E; ++I) {
1038     const CodeGenInstruction &CGI = **I;
1039
1040     // If the tblgen -match-prefix option is specified (for tblgen hackers),
1041     // filter the set of instructions we consider.
1042     if (!StringRef(CGI.TheDef->getName()).startswith(MatchPrefix))
1043       continue;
1044
1045     // Ignore "codegen only" instructions.
1046     if (CGI.TheDef->getValueAsBit("isCodeGenOnly"))
1047       continue;
1048
1049     // Validate the operand list to ensure we can handle this instruction.
1050     for (unsigned i = 0, e = CGI.Operands.size(); i != e; ++i) {
1051       const CGIOperandList::OperandInfo &OI = CGI.Operands[i];
1052
1053       // Validate tied operands.
1054       if (OI.getTiedRegister() != -1) {
1055         // If we have a tied operand that consists of multiple MCOperands, reject
1056         // it.  We reject aliases and ignore instructions for now.
1057         if (OI.MINumOperands != 1) {
1058           // FIXME: Should reject these.  The ARM backend hits this with $lane
1059           // in a bunch of instructions. It is unclear what the right answer is.
1060           DEBUG({
1061             errs() << "warning: '" << CGI.TheDef->getName() << "': "
1062             << "ignoring instruction with multi-operand tied operand '"
1063             << OI.Name << "'\n";
1064           });
1065           continue;
1066         }
1067       }
1068     }
1069
1070     OwningPtr<MatchableInfo> II(new MatchableInfo(CGI));
1071
1072     II->Initialize(*this, SingletonRegisters);
1073
1074     // Ignore instructions which shouldn't be matched and diagnose invalid
1075     // instruction definitions with an error.
1076     if (!II->Validate(CommentDelimiter, true))
1077       continue;
1078
1079     // Ignore "Int_*" and "*_Int" instructions, which are internal aliases.
1080     //
1081     // FIXME: This is a total hack.
1082     if (StringRef(II->TheDef->getName()).startswith("Int_") ||
1083         StringRef(II->TheDef->getName()).endswith("_Int"))
1084       continue;
1085
1086      Matchables.push_back(II.take());
1087   }
1088
1089   // Parse all of the InstAlias definitions and stick them in the list of
1090   // matchables.
1091   std::vector<Record*> AllInstAliases =
1092     Records.getAllDerivedDefinitions("InstAlias");
1093   for (unsigned i = 0, e = AllInstAliases.size(); i != e; ++i) {
1094     CodeGenInstAlias *Alias = new CodeGenInstAlias(AllInstAliases[i], Target);
1095
1096     OwningPtr<MatchableInfo> II(new MatchableInfo(Alias));
1097
1098     II->Initialize(*this, SingletonRegisters);
1099
1100     // Validate the alias definitions.
1101     II->Validate(CommentDelimiter, false);
1102
1103     Matchables.push_back(II.take());
1104   }
1105
1106   // Build info for the register classes.
1107   BuildRegisterClasses(SingletonRegisters);
1108
1109   // Build info for the user defined assembly operand classes.
1110   BuildOperandClasses();
1111
1112   // Build the information about matchables, now that we have fully formed
1113   // classes.
1114   for (std::vector<MatchableInfo*>::iterator it = Matchables.begin(),
1115          ie = Matchables.end(); it != ie; ++it) {
1116     MatchableInfo *II = *it;
1117
1118     // Parse the tokens after the mnemonic.
1119     for (unsigned i = 0, e = II->AsmOperands.size(); i != e; ++i) {
1120       MatchableInfo::AsmOperand &Op = II->AsmOperands[i];
1121       StringRef Token = Op.Token;
1122
1123       // Check for singleton registers.
1124       if (Record *RegRecord = II->getSingletonRegisterForAsmOperand(i, *this)) {
1125         Op.Class = RegisterClasses[RegRecord];
1126         assert(Op.Class && Op.Class->Registers.size() == 1 &&
1127                "Unexpected class for singleton register");
1128         continue;
1129       }
1130
1131       // Check for simple tokens.
1132       if (Token[0] != '$') {
1133         Op.Class = getTokenClass(Token);
1134         continue;
1135       }
1136
1137       if (Token.size() > 1 && isdigit(Token[1])) {
1138         Op.Class = getTokenClass(Token);
1139         continue;
1140       }
1141
1142       // Otherwise this is an operand reference.
1143       StringRef OperandName;
1144       if (Token[1] == '{')
1145         OperandName = Token.substr(2, Token.size() - 3);
1146       else
1147         OperandName = Token.substr(1);
1148
1149       if (II->DefRec.is<const CodeGenInstruction*>())
1150         BuildInstructionOperandReference(II, OperandName, Op);
1151       else
1152         BuildAliasOperandReference(II, OperandName, Op);
1153     }
1154
1155     if (II->DefRec.is<const CodeGenInstruction*>())
1156       II->BuildInstructionResultOperands();
1157     else
1158       II->BuildAliasResultOperands();
1159   }
1160
1161   // Reorder classes so that classes preceed super classes.
1162   std::sort(Classes.begin(), Classes.end(), less_ptr<ClassInfo>());
1163 }
1164
1165 /// BuildInstructionOperandReference - The specified operand is a reference to a
1166 /// named operand such as $src.  Resolve the Class and OperandInfo pointers.
1167 void AsmMatcherInfo::
1168 BuildInstructionOperandReference(MatchableInfo *II,
1169                                  StringRef OperandName,
1170                                  MatchableInfo::AsmOperand &Op) {
1171   const CodeGenInstruction &CGI = *II->DefRec.get<const CodeGenInstruction*>();
1172   const CGIOperandList &Operands = CGI.Operands;
1173
1174   // Map this token to an operand.
1175   unsigned Idx;
1176   if (!Operands.hasOperandNamed(OperandName, Idx))
1177     throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" +
1178                   OperandName.str() + "'");
1179
1180   // Set up the operand class.
1181   Op.Class = getOperandClass(Operands[Idx]);
1182
1183   // If the named operand is tied, canonicalize it to the untied operand.
1184   // For example, something like:
1185   //   (outs GPR:$dst), (ins GPR:$src)
1186   // with an asmstring of
1187   //   "inc $src"
1188   // we want to canonicalize to:
1189   //   "inc $dst"
1190   // so that we know how to provide the $dst operand when filling in the result.
1191   int OITied = Operands[Idx].getTiedRegister();
1192   if (OITied != -1) {
1193     // The tied operand index is an MIOperand index, find the operand that
1194     // contains it.
1195     for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
1196       if (Operands[i].MIOperandNo == unsigned(OITied)) {
1197         OperandName = Operands[i].Name;
1198         break;
1199       }
1200     }
1201   }
1202
1203   Op.SrcOpName = OperandName;
1204 }
1205
1206 /// BuildAliasOperandReference - When parsing an operand reference out of the
1207 /// matching string (e.g. "movsx $src, $dst"), determine what the class of the
1208 /// operand reference is by looking it up in the result pattern definition.
1209 void AsmMatcherInfo::BuildAliasOperandReference(MatchableInfo *II,
1210                                                 StringRef OperandName,
1211                                                 MatchableInfo::AsmOperand &Op) {
1212   const CodeGenInstAlias &CGA = *II->DefRec.get<const CodeGenInstAlias*>();
1213
1214   // Set up the operand class.
1215   for (unsigned i = 0, e = CGA.ResultOperands.size(); i != e; ++i)
1216     if (CGA.ResultOperands[i].isRecord() &&
1217         CGA.ResultOperands[i].getName() == OperandName) {
1218       // It's safe to go with the first one we find, because CodeGenInstAlias
1219       // validates that all operands with the same name have the same record.
1220       unsigned ResultIdx =CGA.getResultInstOperandIndexForResultOperandIndex(i);
1221       Op.Class = getOperandClass(CGA.ResultInst->Operands[ResultIdx]);
1222       Op.SrcOpName = OperandName;
1223       return;
1224     }
1225
1226   throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" +
1227                 OperandName.str() + "'");
1228 }
1229
1230 void MatchableInfo::BuildInstructionResultOperands() {
1231   const CodeGenInstruction *ResultInst = getResultInst();
1232
1233   // Loop over all operands of the result instruction, determining how to
1234   // populate them.
1235   for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
1236     const CGIOperandList::OperandInfo &OpInfo = ResultInst->Operands[i];
1237
1238     // If this is a tied operand, just copy from the previously handled operand.
1239     int TiedOp = OpInfo.getTiedRegister();
1240     if (TiedOp != -1) {
1241       ResOperands.push_back(ResOperand::getTiedOp(TiedOp, &OpInfo));
1242       continue;
1243     }
1244
1245     // Find out what operand from the asmparser that this MCInst operand comes
1246     // from.
1247     int SrcOperand = FindAsmOperandNamed(OpInfo.Name);
1248
1249     if (!OpInfo.Name.empty() && SrcOperand != -1) {
1250       ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, &OpInfo));
1251       continue;
1252     }
1253
1254     throw TGError(TheDef->getLoc(), "Instruction '" +
1255                   TheDef->getName() + "' has operand '" + OpInfo.Name +
1256                   "' that doesn't appear in asm string!");
1257   }
1258 }
1259
1260 void MatchableInfo::BuildAliasResultOperands() {
1261   const CodeGenInstAlias &CGA = *DefRec.get<const CodeGenInstAlias*>();
1262   const CodeGenInstruction *ResultInst = getResultInst();
1263
1264   // Loop over all operands of the result instruction, determining how to
1265   // populate them.
1266   unsigned AliasOpNo = 0;
1267   for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
1268     const CGIOperandList::OperandInfo &OpInfo = ResultInst->Operands[i];
1269
1270     // If this is a tied operand, just copy from the previously handled operand.
1271     int TiedOp = OpInfo.getTiedRegister();
1272     if (TiedOp != -1) {
1273       ResOperands.push_back(ResOperand::getTiedOp(TiedOp, &OpInfo));
1274       continue;
1275     }
1276
1277     // Find out what operand from the asmparser that this MCInst operand comes
1278     // from.
1279     switch (CGA.ResultOperands[AliasOpNo].Kind) {
1280     case CodeGenInstAlias::ResultOperand::K_Record: {
1281       StringRef Name = CGA.ResultOperands[AliasOpNo++].getName();
1282       int SrcOperand = FindAsmOperandNamed(Name);
1283       if (SrcOperand != -1) {
1284         ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, &OpInfo));
1285         continue;
1286       }
1287
1288       throw TGError(TheDef->getLoc(), "Instruction '" +
1289                     TheDef->getName() + "' has operand '" + OpInfo.Name +
1290                     "' that doesn't appear in asm string!");
1291     }
1292     case CodeGenInstAlias::ResultOperand::K_Imm: {
1293       int64_t ImmVal = CGA.ResultOperands[AliasOpNo++].getImm();
1294       ResOperands.push_back(ResOperand::getImmOp(ImmVal, &OpInfo));
1295       continue;
1296     }
1297
1298     case CodeGenInstAlias::ResultOperand::K_Reg: {
1299       Record *Reg = CGA.ResultOperands[AliasOpNo++].getRegister();
1300       ResOperands.push_back(ResOperand::getRegOp(Reg, &OpInfo));
1301       continue;
1302     }
1303     }
1304   }
1305 }
1306
1307 static void EmitConvertToMCInst(CodeGenTarget &Target,
1308                                 std::vector<MatchableInfo*> &Infos,
1309                                 raw_ostream &OS) {
1310   // Write the convert function to a separate stream, so we can drop it after
1311   // the enum.
1312   std::string ConvertFnBody;
1313   raw_string_ostream CvtOS(ConvertFnBody);
1314
1315   // Function we have already generated.
1316   std::set<std::string> GeneratedFns;
1317
1318   // Start the unified conversion function.
1319   CvtOS << "static void ConvertToMCInst(ConversionKind Kind, MCInst &Inst, "
1320         << "unsigned Opcode,\n"
1321         << "                      const SmallVectorImpl<MCParsedAsmOperand*"
1322         << "> &Operands) {\n";
1323   CvtOS << "  Inst.setOpcode(Opcode);\n";
1324   CvtOS << "  switch (Kind) {\n";
1325   CvtOS << "  default:\n";
1326
1327   // Start the enum, which we will generate inline.
1328
1329   OS << "// Unified function for converting operands to MCInst instances.\n\n";
1330   OS << "enum ConversionKind {\n";
1331
1332   // TargetOperandClass - This is the target's operand class, like X86Operand.
1333   std::string TargetOperandClass = Target.getName() + "Operand";
1334
1335   for (std::vector<MatchableInfo*>::const_iterator it = Infos.begin(),
1336          ie = Infos.end(); it != ie; ++it) {
1337     MatchableInfo &II = **it;
1338
1339     // Build the conversion function signature.
1340     std::string Signature = "Convert";
1341     std::string CaseBody;
1342     raw_string_ostream CaseOS(CaseBody);
1343
1344     // Compute the convert enum and the case body.
1345     for (unsigned i = 0, e = II.ResOperands.size(); i != e; ++i) {
1346       const MatchableInfo::ResOperand &OpInfo = II.ResOperands[i];
1347
1348       // Generate code to populate each result operand.
1349       switch (OpInfo.Kind) {
1350       case MatchableInfo::ResOperand::RenderAsmOperand: {
1351         // This comes from something we parsed.
1352         MatchableInfo::AsmOperand &Op = II.AsmOperands[OpInfo.AsmOperandNum];
1353
1354         // Registers are always converted the same, don't duplicate the
1355         // conversion function based on them.
1356         Signature += "__";
1357         if (Op.Class->isRegisterClass())
1358           Signature += "Reg";
1359         else
1360           Signature += Op.Class->ClassName;
1361         Signature += utostr(OpInfo.OpInfo->MINumOperands);
1362         Signature += "_" + itostr(OpInfo.AsmOperandNum);
1363
1364         CaseOS << "    ((" << TargetOperandClass << "*)Operands["
1365                << (OpInfo.AsmOperandNum+1) << "])->" << Op.Class->RenderMethod
1366                << "(Inst, " << OpInfo.OpInfo->MINumOperands << ");\n";
1367         break;
1368       }
1369
1370       case MatchableInfo::ResOperand::TiedOperand: {
1371         // If this operand is tied to a previous one, just copy the MCInst
1372         // operand from the earlier one.We can only tie single MCOperand values.
1373       //assert(OpInfo.OpInfo->MINumOperands == 1 && "Not a singular MCOperand");
1374         unsigned TiedOp = OpInfo.TiedOperandNum;
1375         assert(i > TiedOp && "Tied operand preceeds its target!");
1376         CaseOS << "    Inst.addOperand(Inst.getOperand(" << TiedOp << "));\n";
1377         Signature += "__Tie" + utostr(TiedOp);
1378         break;
1379       }
1380       case MatchableInfo::ResOperand::ImmOperand: {
1381         int64_t Val = OpInfo.ImmVal;
1382         CaseOS << "    Inst.addOperand(MCOperand::CreateImm(" << Val << "));\n";
1383         Signature += "__imm" + itostr(Val);
1384         break;
1385       }
1386       case MatchableInfo::ResOperand::RegOperand: {
1387         std::string N = getQualifiedName(OpInfo.Register);
1388         CaseOS << "    Inst.addOperand(MCOperand::CreateReg(" << N << "));\n";
1389         Signature += "__reg" + OpInfo.Register->getName();
1390       }
1391       }
1392     }
1393
1394     II.ConversionFnKind = Signature;
1395
1396     // Check if we have already generated this signature.
1397     if (!GeneratedFns.insert(Signature).second)
1398       continue;
1399
1400     // If not, emit it now.  Add to the enum list.
1401     OS << "  " << Signature << ",\n";
1402
1403     CvtOS << "  case " << Signature << ":\n";
1404     CvtOS << CaseOS.str();
1405     CvtOS << "    return;\n";
1406   }
1407
1408   // Finish the convert function.
1409
1410   CvtOS << "  }\n";
1411   CvtOS << "}\n\n";
1412
1413   // Finish the enum, and drop the convert function after it.
1414
1415   OS << "  NumConversionVariants\n";
1416   OS << "};\n\n";
1417
1418   OS << CvtOS.str();
1419 }
1420
1421 /// EmitMatchClassEnumeration - Emit the enumeration for match class kinds.
1422 static void EmitMatchClassEnumeration(CodeGenTarget &Target,
1423                                       std::vector<ClassInfo*> &Infos,
1424                                       raw_ostream &OS) {
1425   OS << "namespace {\n\n";
1426
1427   OS << "/// MatchClassKind - The kinds of classes which participate in\n"
1428      << "/// instruction matching.\n";
1429   OS << "enum MatchClassKind {\n";
1430   OS << "  InvalidMatchClass = 0,\n";
1431   for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1432          ie = Infos.end(); it != ie; ++it) {
1433     ClassInfo &CI = **it;
1434     OS << "  " << CI.Name << ", // ";
1435     if (CI.Kind == ClassInfo::Token) {
1436       OS << "'" << CI.ValueName << "'\n";
1437     } else if (CI.isRegisterClass()) {
1438       if (!CI.ValueName.empty())
1439         OS << "register class '" << CI.ValueName << "'\n";
1440       else
1441         OS << "derived register class\n";
1442     } else {
1443       OS << "user defined class '" << CI.ValueName << "'\n";
1444     }
1445   }
1446   OS << "  NumMatchClassKinds\n";
1447   OS << "};\n\n";
1448
1449   OS << "}\n\n";
1450 }
1451
1452 /// EmitClassifyOperand - Emit the function to classify an operand.
1453 static void EmitClassifyOperand(AsmMatcherInfo &Info,
1454                                 raw_ostream &OS) {
1455   OS << "static MatchClassKind ClassifyOperand(MCParsedAsmOperand *GOp) {\n"
1456      << "  " << Info.Target.getName() << "Operand &Operand = *("
1457      << Info.Target.getName() << "Operand*)GOp;\n";
1458
1459   // Classify tokens.
1460   OS << "  if (Operand.isToken())\n";
1461   OS << "    return MatchTokenString(Operand.getToken());\n\n";
1462
1463   // Classify registers.
1464   //
1465   // FIXME: Don't hardcode isReg, getReg.
1466   OS << "  if (Operand.isReg()) {\n";
1467   OS << "    switch (Operand.getReg()) {\n";
1468   OS << "    default: return InvalidMatchClass;\n";
1469   for (std::map<Record*, ClassInfo*>::iterator
1470          it = Info.RegisterClasses.begin(), ie = Info.RegisterClasses.end();
1471        it != ie; ++it)
1472     OS << "    case " << Info.Target.getName() << "::"
1473        << it->first->getName() << ": return " << it->second->Name << ";\n";
1474   OS << "    }\n";
1475   OS << "  }\n\n";
1476
1477   // Classify user defined operands.
1478   for (std::vector<ClassInfo*>::iterator it = Info.Classes.begin(),
1479          ie = Info.Classes.end(); it != ie; ++it) {
1480     ClassInfo &CI = **it;
1481
1482     if (!CI.isUserClass())
1483       continue;
1484
1485     OS << "  // '" << CI.ClassName << "' class";
1486     if (!CI.SuperClasses.empty()) {
1487       OS << ", subclass of ";
1488       for (unsigned i = 0, e = CI.SuperClasses.size(); i != e; ++i) {
1489         if (i) OS << ", ";
1490         OS << "'" << CI.SuperClasses[i]->ClassName << "'";
1491         assert(CI < *CI.SuperClasses[i] && "Invalid class relation!");
1492       }
1493     }
1494     OS << "\n";
1495
1496     OS << "  if (Operand." << CI.PredicateMethod << "()) {\n";
1497
1498     // Validate subclass relationships.
1499     if (!CI.SuperClasses.empty()) {
1500       for (unsigned i = 0, e = CI.SuperClasses.size(); i != e; ++i)
1501         OS << "    assert(Operand." << CI.SuperClasses[i]->PredicateMethod
1502            << "() && \"Invalid class relationship!\");\n";
1503     }
1504
1505     OS << "    return " << CI.Name << ";\n";
1506     OS << "  }\n\n";
1507   }
1508   OS << "  return InvalidMatchClass;\n";
1509   OS << "}\n\n";
1510 }
1511
1512 /// EmitIsSubclass - Emit the subclass predicate function.
1513 static void EmitIsSubclass(CodeGenTarget &Target,
1514                            std::vector<ClassInfo*> &Infos,
1515                            raw_ostream &OS) {
1516   OS << "/// IsSubclass - Compute whether \\arg A is a subclass of \\arg B.\n";
1517   OS << "static bool IsSubclass(MatchClassKind A, MatchClassKind B) {\n";
1518   OS << "  if (A == B)\n";
1519   OS << "    return true;\n\n";
1520
1521   OS << "  switch (A) {\n";
1522   OS << "  default:\n";
1523   OS << "    return false;\n";
1524   for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1525          ie = Infos.end(); it != ie; ++it) {
1526     ClassInfo &A = **it;
1527
1528     if (A.Kind != ClassInfo::Token) {
1529       std::vector<StringRef> SuperClasses;
1530       for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1531              ie = Infos.end(); it != ie; ++it) {
1532         ClassInfo &B = **it;
1533
1534         if (&A != &B && A.isSubsetOf(B))
1535           SuperClasses.push_back(B.Name);
1536       }
1537
1538       if (SuperClasses.empty())
1539         continue;
1540
1541       OS << "\n  case " << A.Name << ":\n";
1542
1543       if (SuperClasses.size() == 1) {
1544         OS << "    return B == " << SuperClasses.back() << ";\n";
1545         continue;
1546       }
1547
1548       OS << "    switch (B) {\n";
1549       OS << "    default: return false;\n";
1550       for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1551         OS << "    case " << SuperClasses[i] << ": return true;\n";
1552       OS << "    }\n";
1553     }
1554   }
1555   OS << "  }\n";
1556   OS << "}\n\n";
1557 }
1558
1559
1560
1561 /// EmitMatchTokenString - Emit the function to match a token string to the
1562 /// appropriate match class value.
1563 static void EmitMatchTokenString(CodeGenTarget &Target,
1564                                  std::vector<ClassInfo*> &Infos,
1565                                  raw_ostream &OS) {
1566   // Construct the match list.
1567   std::vector<StringMatcher::StringPair> Matches;
1568   for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1569          ie = Infos.end(); it != ie; ++it) {
1570     ClassInfo &CI = **it;
1571
1572     if (CI.Kind == ClassInfo::Token)
1573       Matches.push_back(StringMatcher::StringPair(CI.ValueName,
1574                                                   "return " + CI.Name + ";"));
1575   }
1576
1577   OS << "static MatchClassKind MatchTokenString(StringRef Name) {\n";
1578
1579   StringMatcher("Name", Matches, OS).Emit();
1580
1581   OS << "  return InvalidMatchClass;\n";
1582   OS << "}\n\n";
1583 }
1584
1585 /// EmitMatchRegisterName - Emit the function to match a string to the target
1586 /// specific register enum.
1587 static void EmitMatchRegisterName(CodeGenTarget &Target, Record *AsmParser,
1588                                   raw_ostream &OS) {
1589   // Construct the match list.
1590   std::vector<StringMatcher::StringPair> Matches;
1591   for (unsigned i = 0, e = Target.getRegisters().size(); i != e; ++i) {
1592     const CodeGenRegister &Reg = Target.getRegisters()[i];
1593     if (Reg.TheDef->getValueAsString("AsmName").empty())
1594       continue;
1595
1596     Matches.push_back(StringMatcher::StringPair(
1597                                         Reg.TheDef->getValueAsString("AsmName"),
1598                                         "return " + utostr(i + 1) + ";"));
1599   }
1600
1601   OS << "static unsigned MatchRegisterName(StringRef Name) {\n";
1602
1603   StringMatcher("Name", Matches, OS).Emit();
1604
1605   OS << "  return 0;\n";
1606   OS << "}\n\n";
1607 }
1608
1609 /// EmitSubtargetFeatureFlagEnumeration - Emit the subtarget feature flag
1610 /// definitions.
1611 static void EmitSubtargetFeatureFlagEnumeration(AsmMatcherInfo &Info,
1612                                                 raw_ostream &OS) {
1613   OS << "// Flags for subtarget features that participate in "
1614      << "instruction matching.\n";
1615   OS << "enum SubtargetFeatureFlag {\n";
1616   for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator
1617          it = Info.SubtargetFeatures.begin(),
1618          ie = Info.SubtargetFeatures.end(); it != ie; ++it) {
1619     SubtargetFeatureInfo &SFI = *it->second;
1620     OS << "  " << SFI.getEnumName() << " = (1 << " << SFI.Index << "),\n";
1621   }
1622   OS << "  Feature_None = 0\n";
1623   OS << "};\n\n";
1624 }
1625
1626 /// EmitComputeAvailableFeatures - Emit the function to compute the list of
1627 /// available features given a subtarget.
1628 static void EmitComputeAvailableFeatures(AsmMatcherInfo &Info,
1629                                          raw_ostream &OS) {
1630   std::string ClassName =
1631     Info.AsmParser->getValueAsString("AsmParserClassName");
1632
1633   OS << "unsigned " << Info.Target.getName() << ClassName << "::\n"
1634      << "ComputeAvailableFeatures(const " << Info.Target.getName()
1635      << "Subtarget *Subtarget) const {\n";
1636   OS << "  unsigned Features = 0;\n";
1637   for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator
1638          it = Info.SubtargetFeatures.begin(),
1639          ie = Info.SubtargetFeatures.end(); it != ie; ++it) {
1640     SubtargetFeatureInfo &SFI = *it->second;
1641     OS << "  if (" << SFI.TheDef->getValueAsString("CondString")
1642        << ")\n";
1643     OS << "    Features |= " << SFI.getEnumName() << ";\n";
1644   }
1645   OS << "  return Features;\n";
1646   OS << "}\n\n";
1647 }
1648
1649 static std::string GetAliasRequiredFeatures(Record *R,
1650                                             const AsmMatcherInfo &Info) {
1651   std::vector<Record*> ReqFeatures = R->getValueAsListOfDefs("Predicates");
1652   std::string Result;
1653   unsigned NumFeatures = 0;
1654   for (unsigned i = 0, e = ReqFeatures.size(); i != e; ++i) {
1655     SubtargetFeatureInfo *F = Info.getSubtargetFeature(ReqFeatures[i]);
1656
1657     if (F == 0)
1658       throw TGError(R->getLoc(), "Predicate '" + ReqFeatures[i]->getName() +
1659                     "' is not marked as an AssemblerPredicate!");
1660
1661     if (NumFeatures)
1662       Result += '|';
1663
1664     Result += F->getEnumName();
1665     ++NumFeatures;
1666   }
1667
1668   if (NumFeatures > 1)
1669     Result = '(' + Result + ')';
1670   return Result;
1671 }
1672
1673 /// EmitMnemonicAliases - If the target has any MnemonicAlias<> definitions,
1674 /// emit a function for them and return true, otherwise return false.
1675 static bool EmitMnemonicAliases(raw_ostream &OS, const AsmMatcherInfo &Info) {
1676   std::vector<Record*> Aliases =
1677     Info.getRecords().getAllDerivedDefinitions("MnemonicAlias");
1678   if (Aliases.empty()) return false;
1679
1680   OS << "static void ApplyMnemonicAliases(StringRef &Mnemonic, "
1681         "unsigned Features) {\n";
1682
1683   // Keep track of all the aliases from a mnemonic.  Use an std::map so that the
1684   // iteration order of the map is stable.
1685   std::map<std::string, std::vector<Record*> > AliasesFromMnemonic;
1686
1687   for (unsigned i = 0, e = Aliases.size(); i != e; ++i) {
1688     Record *R = Aliases[i];
1689     AliasesFromMnemonic[R->getValueAsString("FromMnemonic")].push_back(R);
1690   }
1691
1692   // Process each alias a "from" mnemonic at a time, building the code executed
1693   // by the string remapper.
1694   std::vector<StringMatcher::StringPair> Cases;
1695   for (std::map<std::string, std::vector<Record*> >::iterator
1696        I = AliasesFromMnemonic.begin(), E = AliasesFromMnemonic.end();
1697        I != E; ++I) {
1698     const std::vector<Record*> &ToVec = I->second;
1699
1700     // Loop through each alias and emit code that handles each case.  If there
1701     // are two instructions without predicates, emit an error.  If there is one,
1702     // emit it last.
1703     std::string MatchCode;
1704     int AliasWithNoPredicate = -1;
1705
1706     for (unsigned i = 0, e = ToVec.size(); i != e; ++i) {
1707       Record *R = ToVec[i];
1708       std::string FeatureMask = GetAliasRequiredFeatures(R, Info);
1709
1710       // If this unconditionally matches, remember it for later and diagnose
1711       // duplicates.
1712       if (FeatureMask.empty()) {
1713         if (AliasWithNoPredicate != -1) {
1714           // We can't have two aliases from the same mnemonic with no predicate.
1715           PrintError(ToVec[AliasWithNoPredicate]->getLoc(),
1716                      "two MnemonicAliases with the same 'from' mnemonic!");
1717           throw TGError(R->getLoc(), "this is the other MnemonicAlias.");
1718         }
1719
1720         AliasWithNoPredicate = i;
1721         continue;
1722       }
1723
1724       if (!MatchCode.empty())
1725         MatchCode += "else ";
1726       MatchCode += "if ((Features & " + FeatureMask + ") == "+FeatureMask+")\n";
1727       MatchCode += "  Mnemonic = \"" +R->getValueAsString("ToMnemonic")+"\";\n";
1728     }
1729
1730     if (AliasWithNoPredicate != -1) {
1731       Record *R = ToVec[AliasWithNoPredicate];
1732       if (!MatchCode.empty())
1733         MatchCode += "else\n  ";
1734       MatchCode += "Mnemonic = \"" + R->getValueAsString("ToMnemonic")+"\";\n";
1735     }
1736
1737     MatchCode += "return;";
1738
1739     Cases.push_back(std::make_pair(I->first, MatchCode));
1740   }
1741
1742
1743   StringMatcher("Mnemonic", Cases, OS).Emit();
1744   OS << "}\n";
1745
1746   return true;
1747 }
1748
1749 void AsmMatcherEmitter::run(raw_ostream &OS) {
1750   CodeGenTarget Target(Records);
1751   Record *AsmParser = Target.getAsmParser();
1752   std::string ClassName = AsmParser->getValueAsString("AsmParserClassName");
1753
1754   // Compute the information on the instructions to match.
1755   AsmMatcherInfo Info(AsmParser, Target, Records);
1756   Info.BuildInfo();
1757
1758   // Sort the instruction table using the partial order on classes. We use
1759   // stable_sort to ensure that ambiguous instructions are still
1760   // deterministically ordered.
1761   std::stable_sort(Info.Matchables.begin(), Info.Matchables.end(),
1762                    less_ptr<MatchableInfo>());
1763
1764   DEBUG_WITH_TYPE("instruction_info", {
1765       for (std::vector<MatchableInfo*>::iterator
1766              it = Info.Matchables.begin(), ie = Info.Matchables.end();
1767            it != ie; ++it)
1768         (*it)->dump();
1769     });
1770
1771   // Check for ambiguous matchables.
1772   DEBUG_WITH_TYPE("ambiguous_instrs", {
1773     unsigned NumAmbiguous = 0;
1774     for (unsigned i = 0, e = Info.Matchables.size(); i != e; ++i) {
1775       for (unsigned j = i + 1; j != e; ++j) {
1776         MatchableInfo &A = *Info.Matchables[i];
1777         MatchableInfo &B = *Info.Matchables[j];
1778
1779         if (A.CouldMatchAmiguouslyWith(B)) {
1780           errs() << "warning: ambiguous matchables:\n";
1781           A.dump();
1782           errs() << "\nis incomparable with:\n";
1783           B.dump();
1784           errs() << "\n\n";
1785           ++NumAmbiguous;
1786         }
1787       }
1788     }
1789     if (NumAmbiguous)
1790       errs() << "warning: " << NumAmbiguous
1791              << " ambiguous matchables!\n";
1792   });
1793
1794   // Write the output.
1795
1796   EmitSourceFileHeader("Assembly Matcher Source Fragment", OS);
1797
1798   // Information for the class declaration.
1799   OS << "\n#ifdef GET_ASSEMBLER_HEADER\n";
1800   OS << "#undef GET_ASSEMBLER_HEADER\n";
1801   OS << "  // This should be included into the middle of the declaration of \n";
1802   OS << "  // your subclasses implementation of TargetAsmParser.\n";
1803   OS << "  unsigned ComputeAvailableFeatures(const " <<
1804            Target.getName() << "Subtarget *Subtarget) const;\n";
1805   OS << "  enum MatchResultTy {\n";
1806   OS << "    Match_Success, Match_MnemonicFail, Match_InvalidOperand,\n";
1807   OS << "    Match_MissingFeature\n";
1808   OS << "  };\n";
1809   OS << "  MatchResultTy MatchInstructionImpl(const "
1810      << "SmallVectorImpl<MCParsedAsmOperand*>"
1811      << " &Operands, MCInst &Inst, unsigned &ErrorInfo);\n\n";
1812   OS << "#endif // GET_ASSEMBLER_HEADER_INFO\n\n";
1813
1814
1815
1816
1817   OS << "\n#ifdef GET_REGISTER_MATCHER\n";
1818   OS << "#undef GET_REGISTER_MATCHER\n\n";
1819
1820   // Emit the subtarget feature enumeration.
1821   EmitSubtargetFeatureFlagEnumeration(Info, OS);
1822
1823   // Emit the function to match a register name to number.
1824   EmitMatchRegisterName(Target, AsmParser, OS);
1825
1826   OS << "#endif // GET_REGISTER_MATCHER\n\n";
1827
1828
1829   OS << "\n#ifdef GET_MATCHER_IMPLEMENTATION\n";
1830   OS << "#undef GET_MATCHER_IMPLEMENTATION\n\n";
1831
1832   // Generate the function that remaps for mnemonic aliases.
1833   bool HasMnemonicAliases = EmitMnemonicAliases(OS, Info);
1834
1835   // Generate the unified function to convert operands into an MCInst.
1836   EmitConvertToMCInst(Target, Info.Matchables, OS);
1837
1838   // Emit the enumeration for classes which participate in matching.
1839   EmitMatchClassEnumeration(Target, Info.Classes, OS);
1840
1841   // Emit the routine to match token strings to their match class.
1842   EmitMatchTokenString(Target, Info.Classes, OS);
1843
1844   // Emit the routine to classify an operand.
1845   EmitClassifyOperand(Info, OS);
1846
1847   // Emit the subclass predicate routine.
1848   EmitIsSubclass(Target, Info.Classes, OS);
1849
1850   // Emit the available features compute function.
1851   EmitComputeAvailableFeatures(Info, OS);
1852
1853
1854   size_t MaxNumOperands = 0;
1855   for (std::vector<MatchableInfo*>::const_iterator it =
1856          Info.Matchables.begin(), ie = Info.Matchables.end();
1857        it != ie; ++it)
1858     MaxNumOperands = std::max(MaxNumOperands, (*it)->AsmOperands.size());
1859
1860
1861   // Emit the static match table; unused classes get initalized to 0 which is
1862   // guaranteed to be InvalidMatchClass.
1863   //
1864   // FIXME: We can reduce the size of this table very easily. First, we change
1865   // it so that store the kinds in separate bit-fields for each index, which
1866   // only needs to be the max width used for classes at that index (we also need
1867   // to reject based on this during classification). If we then make sure to
1868   // order the match kinds appropriately (putting mnemonics last), then we
1869   // should only end up using a few bits for each class, especially the ones
1870   // following the mnemonic.
1871   OS << "namespace {\n";
1872   OS << "  struct MatchEntry {\n";
1873   OS << "    unsigned Opcode;\n";
1874   OS << "    const char *Mnemonic;\n";
1875   OS << "    ConversionKind ConvertFn;\n";
1876   OS << "    MatchClassKind Classes[" << MaxNumOperands << "];\n";
1877   OS << "    unsigned RequiredFeatures;\n";
1878   OS << "  };\n\n";
1879
1880   OS << "// Predicate for searching for an opcode.\n";
1881   OS << "  struct LessOpcode {\n";
1882   OS << "    bool operator()(const MatchEntry &LHS, StringRef RHS) {\n";
1883   OS << "      return StringRef(LHS.Mnemonic) < RHS;\n";
1884   OS << "    }\n";
1885   OS << "    bool operator()(StringRef LHS, const MatchEntry &RHS) {\n";
1886   OS << "      return LHS < StringRef(RHS.Mnemonic);\n";
1887   OS << "    }\n";
1888   OS << "    bool operator()(const MatchEntry &LHS, const MatchEntry &RHS) {\n";
1889   OS << "      return StringRef(LHS.Mnemonic) < StringRef(RHS.Mnemonic);\n";
1890   OS << "    }\n";
1891   OS << "  };\n";
1892
1893   OS << "} // end anonymous namespace.\n\n";
1894
1895   OS << "static const MatchEntry MatchTable["
1896      << Info.Matchables.size() << "] = {\n";
1897
1898   for (std::vector<MatchableInfo*>::const_iterator it =
1899        Info.Matchables.begin(), ie = Info.Matchables.end();
1900        it != ie; ++it) {
1901     MatchableInfo &II = **it;
1902
1903
1904     OS << "  { " << Target.getName() << "::"
1905        << II.getResultInst()->TheDef->getName() << ", \"" << II.Mnemonic << "\""
1906        << ", " << II.ConversionFnKind << ", { ";
1907     for (unsigned i = 0, e = II.AsmOperands.size(); i != e; ++i) {
1908       MatchableInfo::AsmOperand &Op = II.AsmOperands[i];
1909
1910       if (i) OS << ", ";
1911       OS << Op.Class->Name;
1912     }
1913     OS << " }, ";
1914
1915     // Write the required features mask.
1916     if (!II.RequiredFeatures.empty()) {
1917       for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) {
1918         if (i) OS << "|";
1919         OS << II.RequiredFeatures[i]->getEnumName();
1920       }
1921     } else
1922       OS << "0";
1923
1924     OS << "},\n";
1925   }
1926
1927   OS << "};\n\n";
1928
1929   // Finally, build the match function.
1930   OS << Target.getName() << ClassName << "::MatchResultTy "
1931      << Target.getName() << ClassName << "::\n"
1932      << "MatchInstructionImpl(const SmallVectorImpl<MCParsedAsmOperand*>"
1933      << " &Operands,\n";
1934   OS << "                     MCInst &Inst, unsigned &ErrorInfo) {\n";
1935
1936   // Emit code to get the available features.
1937   OS << "  // Get the current feature set.\n";
1938   OS << "  unsigned AvailableFeatures = getAvailableFeatures();\n\n";
1939
1940   OS << "  // Get the instruction mnemonic, which is the first token.\n";
1941   OS << "  StringRef Mnemonic = ((" << Target.getName()
1942      << "Operand*)Operands[0])->getToken();\n\n";
1943
1944   if (HasMnemonicAliases) {
1945     OS << "  // Process all MnemonicAliases to remap the mnemonic.\n";
1946     OS << "  ApplyMnemonicAliases(Mnemonic, AvailableFeatures);\n\n";
1947   }
1948
1949   // Emit code to compute the class list for this operand vector.
1950   OS << "  // Eliminate obvious mismatches.\n";
1951   OS << "  if (Operands.size() > " << (MaxNumOperands+1) << ") {\n";
1952   OS << "    ErrorInfo = " << (MaxNumOperands+1) << ";\n";
1953   OS << "    return Match_InvalidOperand;\n";
1954   OS << "  }\n\n";
1955
1956   OS << "  // Compute the class list for this operand vector.\n";
1957   OS << "  MatchClassKind Classes[" << MaxNumOperands << "];\n";
1958   OS << "  for (unsigned i = 1, e = Operands.size(); i != e; ++i) {\n";
1959   OS << "    Classes[i-1] = ClassifyOperand(Operands[i]);\n\n";
1960
1961   OS << "    // Check for invalid operands before matching.\n";
1962   OS << "    if (Classes[i-1] == InvalidMatchClass) {\n";
1963   OS << "      ErrorInfo = i;\n";
1964   OS << "      return Match_InvalidOperand;\n";
1965   OS << "    }\n";
1966   OS << "  }\n\n";
1967
1968   OS << "  // Mark unused classes.\n";
1969   OS << "  for (unsigned i = Operands.size()-1, e = " << MaxNumOperands << "; "
1970      << "i != e; ++i)\n";
1971   OS << "    Classes[i] = InvalidMatchClass;\n\n";
1972
1973   OS << "  // Some state to try to produce better error messages.\n";
1974   OS << "  bool HadMatchOtherThanFeatures = false;\n\n";
1975   OS << "  // Set ErrorInfo to the operand that mismatches if it is \n";
1976   OS << "  // wrong for all instances of the instruction.\n";
1977   OS << "  ErrorInfo = ~0U;\n";
1978
1979   // Emit code to search the table.
1980   OS << "  // Search the table.\n";
1981   OS << "  std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n";
1982   OS << "    std::equal_range(MatchTable, MatchTable+"
1983      << Info.Matchables.size() << ", Mnemonic, LessOpcode());\n\n";
1984
1985   OS << "  // Return a more specific error code if no mnemonics match.\n";
1986   OS << "  if (MnemonicRange.first == MnemonicRange.second)\n";
1987   OS << "    return Match_MnemonicFail;\n\n";
1988
1989   OS << "  for (const MatchEntry *it = MnemonicRange.first, "
1990      << "*ie = MnemonicRange.second;\n";
1991   OS << "       it != ie; ++it) {\n";
1992
1993   OS << "    // equal_range guarantees that instruction mnemonic matches.\n";
1994   OS << "    assert(Mnemonic == it->Mnemonic);\n";
1995
1996   // Emit check that the subclasses match.
1997   OS << "    bool OperandsValid = true;\n";
1998   OS << "    for (unsigned i = 0; i != " << MaxNumOperands << "; ++i) {\n";
1999   OS << "      if (IsSubclass(Classes[i], it->Classes[i]))\n";
2000   OS << "        continue;\n";
2001   OS << "      // If this operand is broken for all of the instances of this\n";
2002   OS << "      // mnemonic, keep track of it so we can report loc info.\n";
2003   OS << "      if (it == MnemonicRange.first || ErrorInfo == i+1)\n";
2004   OS << "        ErrorInfo = i+1;\n";
2005   OS << "      else\n";
2006   OS << "        ErrorInfo = ~0U;";
2007   OS << "      // Otherwise, just reject this instance of the mnemonic.\n";
2008   OS << "      OperandsValid = false;\n";
2009   OS << "      break;\n";
2010   OS << "    }\n\n";
2011
2012   OS << "    if (!OperandsValid) continue;\n";
2013
2014   // Emit check that the required features are available.
2015   OS << "    if ((AvailableFeatures & it->RequiredFeatures) "
2016      << "!= it->RequiredFeatures) {\n";
2017   OS << "      HadMatchOtherThanFeatures = true;\n";
2018   OS << "      continue;\n";
2019   OS << "    }\n";
2020
2021   OS << "\n";
2022   OS << "    ConvertToMCInst(it->ConvertFn, Inst, it->Opcode, Operands);\n";
2023
2024   // Call the post-processing function, if used.
2025   std::string InsnCleanupFn =
2026     AsmParser->getValueAsString("AsmParserInstCleanup");
2027   if (!InsnCleanupFn.empty())
2028     OS << "    " << InsnCleanupFn << "(Inst);\n";
2029
2030   OS << "    return Match_Success;\n";
2031   OS << "  }\n\n";
2032
2033   OS << "  // Okay, we had no match.  Try to return a useful error code.\n";
2034   OS << "  if (HadMatchOtherThanFeatures) return Match_MissingFeature;\n";
2035   OS << "  return Match_InvalidOperand;\n";
2036   OS << "}\n\n";
2037
2038   OS << "#endif // GET_MATCHER_IMPLEMENTATION\n\n";
2039 }