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() const {
 569     return Records;
 570   }
 571 };
 572
 573 }
 574
 575 void MatchableInfo::dump() {
 576   errs() << TheDef->getName() << " -- " << "flattened:\"" << AsmString <<"\"\n";
 577
 578   for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 579     AsmOperand &Op = AsmOperands[i];
 580     errs() << "  op[" << i << "] = " << Op.Class->ClassName << " - ";
 581     errs() << '\"' << Op.Token << "\"\n";
 582   }
 583 }
 584
 585 void MatchableInfo::Initialize(const AsmMatcherInfo &Info,
 586                                SmallPtrSet<Record*, 16> &SingletonRegisters) {
 587   // TODO: Eventually support asmparser for Variant != 0.
 588   AsmString = CodeGenInstruction::FlattenAsmStringVariants(AsmString, 0);
 589
 590   TokenizeAsmString(Info);
 591
 592   // Compute the require features.
 593   std::vector<Record*> Predicates =TheDef->getValueAsListOfDefs("Predicates");
 594   for (unsigned i = 0, e = Predicates.size(); i != e; ++i)
 595     if (SubtargetFeatureInfo *Feature =
 596         Info.getSubtargetFeature(Predicates[i]))
 597       RequiredFeatures.push_back(Feature);
 598
 599   // Collect singleton registers, if used.
 600   for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 601     if (Record *Reg = getSingletonRegisterForAsmOperand(i, Info))
 602       SingletonRegisters.insert(Reg);
 603   }
 604 }
 605
 606 /// TokenizeAsmString - Tokenize a simplified assembly string.
 607 void MatchableInfo::TokenizeAsmString(const AsmMatcherInfo &Info) {
 608   StringRef String = AsmString;
 609   unsigned Prev = 0;
 610   bool InTok = true;
 611   for (unsigned i = 0, e = String.size(); i != e; ++i) {
 612     switch (String[i]) {
 613     case '[':
 614     case ']':
 615     case '*':
 616     case '!':
 617     case ' ':
 618     case '\t':
 619     case ',':
 620       if (InTok) {
 621         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 622         InTok = false;
 623       }
 624       if (!isspace(String[i]) && String[i] != ',')
 625         AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
 626       Prev = i + 1;
 627       break;
 628
 629     case '\\':
 630       if (InTok) {
 631         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 632         InTok = false;
 633       }
 634       ++i;
 635       assert(i != String.size() && "Invalid quoted character");
 636       AsmOperands.push_back(AsmOperand(String.substr(i, 1)));
 637       Prev = i + 1;
 638       break;
 639
 640     case '$': {
 641       if (InTok) {
 642         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 643         InTok = false;
 644       }
 645
 646       // If this isn't "${", treat like a normal token.
 647       if (i + 1 == String.size() || String[i + 1] != '{') {
 648         Prev = i;
 649         break;
 650       }
 651
 652       StringRef::iterator End = std::find(String.begin() + i, String.end(),'}');
 653       assert(End != String.end() && "Missing brace in operand reference!");
 654       size_t EndPos = End - String.begin();
 655       AsmOperands.push_back(AsmOperand(String.slice(i, EndPos+1)));
 656       Prev = EndPos + 1;
 657       i = EndPos;
 658       break;
 659     }
 660
 661     case '.':
 662       if (InTok)
 663         AsmOperands.push_back(AsmOperand(String.slice(Prev, i)));
 664       Prev = i;
 665       InTok = true;
 666       break;
 667
 668     default:
 669       InTok = true;
 670     }
 671   }
 672   if (InTok && Prev != String.size())
 673     AsmOperands.push_back(AsmOperand(String.substr(Prev)));
 674
 675   // The first token of the instruction is the mnemonic, which must be a
 676   // simple string, not a $foo variable or a singleton register.
 677   assert(!AsmOperands.empty() && "Instruction has no tokens?");
 678   Mnemonic = AsmOperands[0].Token;
 679   if (Mnemonic[0] == '$' || getSingletonRegisterForAsmOperand(0, Info))
 680     throw TGError(TheDef->getLoc(),
 681                   "Invalid instruction mnemonic '" + Mnemonic.str() + "'!");
 682
 683   // Remove the first operand, it is tracked in the mnemonic field.
 684   AsmOperands.erase(AsmOperands.begin());
 685 }
 686
 687
 688
 689 bool MatchableInfo::Validate(StringRef CommentDelimiter, bool Hack) const {
 690   // Reject matchables with no .s string.
 691   if (AsmString.empty())
 692     throw TGError(TheDef->getLoc(), "instruction with empty asm string");
 693
 694   // Reject any matchables with a newline in them, they should be marked
 695   // isCodeGenOnly if they are pseudo instructions.
 696   if (AsmString.find('\n') != std::string::npos)
 697     throw TGError(TheDef->getLoc(),
 698                   "multiline instruction is not valid for the asmparser, "
 699                   "mark it isCodeGenOnly");
 700
 701   // Remove comments from the asm string.  We know that the asmstring only
 702   // has one line.
 703   if (!CommentDelimiter.empty() &&
 704       StringRef(AsmString).find(CommentDelimiter) != StringRef::npos)
 705     throw TGError(TheDef->getLoc(),
 706                   "asmstring for instruction has comment character in it, "
 707                   "mark it isCodeGenOnly");
 708
 709   // Reject matchables with operand modifiers, these aren't something we can
 710   /// handle, the target should be refactored to use operands instead of
 711   /// modifiers.
 712   //
 713   // Also, check for instructions which reference the operand multiple times;
 714   // this implies a constraint we would not honor.
 715   std::set<std::string> OperandNames;
 716   for (unsigned i = 0, e = AsmOperands.size(); i != e; ++i) {
 717     StringRef Tok = AsmOperands[i].Token;
 718     if (Tok[0] == '$' && Tok.find(':') != StringRef::npos)
 719       throw TGError(TheDef->getLoc(),
 720                     "matchable with operand modifier '" + Tok.str() +
 721                     "' not supported by asm matcher.  Mark isCodeGenOnly!");
 722
 723     // Verify that any operand is only mentioned once.
 724     // We reject aliases and ignore instructions for now.
 725     if (Tok[0] == '$' && !OperandNames.insert(Tok).second) {
 726       if (!Hack)
 727         throw TGError(TheDef->getLoc(),
 728                       "ERROR: matchable with tied operand '" + Tok.str() +
 729                       "' can never be matched!");
 730       // FIXME: Should reject these.  The ARM backend hits this with $lane in a
 731       // bunch of instructions.  It is unclear what the right answer is.
 732       DEBUG({
 733         errs() << "warning: '" << TheDef->getName() << "': "
 734                << "ignoring instruction with tied operand '"
 735                << Tok.str() << "'\n";
 736       });
 737       return false;
 738     }
 739   }
 740
 741   return true;
 742 }
 743
 744
 745 /// getSingletonRegisterForAsmOperand - If the specified token is a singleton
 746 /// register, return the register name, otherwise return a null StringRef.
 747 Record *MatchableInfo::
 748 getSingletonRegisterForAsmOperand(unsigned i, const AsmMatcherInfo &Info) const{
 749   StringRef Tok = AsmOperands[i].Token;
 750   if (!Tok.startswith(Info.RegisterPrefix))
 751     return 0;
 752
 753   StringRef RegName = Tok.substr(Info.RegisterPrefix.size());
 754   if (const CodeGenRegister *Reg = Info.Target.getRegisterByName(RegName))
 755     return Reg->TheDef;
 756
 757   // If there is no register prefix (i.e. "%" in "%eax"), then this may
 758   // be some random non-register token, just ignore it.
 759   if (Info.RegisterPrefix.empty())
 760     return 0;
 761
 762   // Otherwise, we have something invalid prefixed with the register prefix,
 763   // such as %foo.
 764   std::string Err = "unable to find register for '" + RegName.str() +
 765   "' (which matches register prefix)";
 766   throw TGError(TheDef->getLoc(), Err);
 767 }
 768
 769
 770 static std::string getEnumNameForToken(StringRef Str) {
 771   std::string Res;
 772
 773   for (StringRef::iterator it = Str.begin(), ie = Str.end(); it != ie; ++it) {
 774     switch (*it) {
 775     case '*': Res += "_STAR_"; break;
 776     case '%': Res += "_PCT_"; break;
 777     case ':': Res += "_COLON_"; break;
 778     case '!': Res += "_EXCLAIM_"; break;
 779     default:
 780       if (isalnum(*it))
 781         Res += *it;
 782       else
 783         Res += "_" + utostr((unsigned) *it) + "_";
 784     }
 785   }
 786
 787   return Res;
 788 }
 789
 790 ClassInfo *AsmMatcherInfo::getTokenClass(StringRef Token) {
 791   ClassInfo *&Entry = TokenClasses[Token];
 792
 793   if (!Entry) {
 794     Entry = new ClassInfo();
 795     Entry->Kind = ClassInfo::Token;
 796     Entry->ClassName = "Token";
 797     Entry->Name = "MCK_" + getEnumNameForToken(Token);
 798     Entry->ValueName = Token;
 799     Entry->PredicateMethod = "<invalid>";
 800     Entry->RenderMethod = "<invalid>";
 801     Classes.push_back(Entry);
 802   }
 803
 804   return Entry;
 805 }
 806
 807 ClassInfo *
 808 AsmMatcherInfo::getOperandClass(const CGIOperandList::OperandInfo &OI) {
 809   if (OI.Rec->isSubClassOf("RegisterClass")) {
 810     if (ClassInfo *CI = RegisterClassClasses[OI.Rec])
 811       return CI;
 812     throw TGError(OI.Rec->getLoc(), "register class has no class info!");
 813   }
 814
 815   assert(OI.Rec->isSubClassOf("Operand") && "Unexpected operand!");
 816   Record *MatchClass = OI.Rec->getValueAsDef("ParserMatchClass");
 817   if (ClassInfo *CI = AsmOperandClasses[MatchClass])
 818     return CI;
 819
 820   throw TGError(OI.Rec->getLoc(), "operand has no match class!");
 821 }
 822
 823 void AsmMatcherInfo::
 824 BuildRegisterClasses(SmallPtrSet<Record*, 16> &SingletonRegisters) {
 825   const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
 826   const std::vector<CodeGenRegisterClass> &RegClassList =
 827     Target.getRegisterClasses();
 828
 829   // The register sets used for matching.
 830   std::set< std::set<Record*> > RegisterSets;
 831
 832   // Gather the defined sets.
 833   for (std::vector<CodeGenRegisterClass>::const_iterator it =
 834        RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it)
 835     RegisterSets.insert(std::set<Record*>(it->Elements.begin(),
 836                                           it->Elements.end()));
 837
 838   // Add any required singleton sets.
 839   for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(),
 840        ie = SingletonRegisters.end(); it != ie; ++it) {
 841     Record *Rec = *it;
 842     RegisterSets.insert(std::set<Record*>(&Rec, &Rec + 1));
 843   }
 844
 845   // Introduce derived sets where necessary (when a register does not determine
 846   // a unique register set class), and build the mapping of registers to the set
 847   // they should classify to.
 848   std::map<Record*, std::set<Record*> > RegisterMap;
 849   for (std::vector<CodeGenRegister>::const_iterator it = Registers.begin(),
 850          ie = Registers.end(); it != ie; ++it) {
 851     const CodeGenRegister &CGR = *it;
 852     // Compute the intersection of all sets containing this register.
 853     std::set<Record*> ContainingSet;
 854
 855     for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
 856            ie = RegisterSets.end(); it != ie; ++it) {
 857       if (!it->count(CGR.TheDef))
 858         continue;
 859
 860       if (ContainingSet.empty()) {
 861         ContainingSet = *it;
 862         continue;
 863       }
 864
 865       std::set<Record*> Tmp;
 866       std::swap(Tmp, ContainingSet);
 867       std::insert_iterator< std::set<Record*> > II(ContainingSet,
 868                                                    ContainingSet.begin());
 869       std::set_intersection(Tmp.begin(), Tmp.end(), it->begin(), it->end(), II);
 870     }
 871
 872     if (!ContainingSet.empty()) {
 873       RegisterSets.insert(ContainingSet);
 874       RegisterMap.insert(std::make_pair(CGR.TheDef, ContainingSet));
 875     }
 876   }
 877
 878   // Construct the register classes.
 879   std::map<std::set<Record*>, ClassInfo*> RegisterSetClasses;
 880   unsigned Index = 0;
 881   for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
 882          ie = RegisterSets.end(); it != ie; ++it, ++Index) {
 883     ClassInfo *CI = new ClassInfo();
 884     CI->Kind = ClassInfo::RegisterClass0 + Index;
 885     CI->ClassName = "Reg" + utostr(Index);
 886     CI->Name = "MCK_Reg" + utostr(Index);
 887     CI->ValueName = "";
 888     CI->PredicateMethod = ""; // unused
 889     CI->RenderMethod = "addRegOperands";
 890     CI->Registers = *it;
 891     Classes.push_back(CI);
 892     RegisterSetClasses.insert(std::make_pair(*it, CI));
 893   }
 894
 895   // Find the superclasses; we could compute only the subgroup lattice edges,
 896   // but there isn't really a point.
 897   for (std::set< std::set<Record*> >::iterator it = RegisterSets.begin(),
 898          ie = RegisterSets.end(); it != ie; ++it) {
 899     ClassInfo *CI = RegisterSetClasses[*it];
 900     for (std::set< std::set<Record*> >::iterator it2 = RegisterSets.begin(),
 901            ie2 = RegisterSets.end(); it2 != ie2; ++it2)
 902       if (*it != *it2 &&
 903           std::includes(it2->begin(), it2->end(), it->begin(), it->end()))
 904         CI->SuperClasses.push_back(RegisterSetClasses[*it2]);
 905   }
 906
 907   // Name the register classes which correspond to a user defined RegisterClass.
 908   for (std::vector<CodeGenRegisterClass>::const_iterator
 909        it = RegClassList.begin(), ie = RegClassList.end(); it != ie; ++it) {
 910     ClassInfo *CI = RegisterSetClasses[std::set<Record*>(it->Elements.begin(),
 911                                                          it->Elements.end())];
 912     if (CI->ValueName.empty()) {
 913       CI->ClassName = it->getName();
 914       CI->Name = "MCK_" + it->getName();
 915       CI->ValueName = it->getName();
 916     } else
 917       CI->ValueName = CI->ValueName + "," + it->getName();
 918
 919     RegisterClassClasses.insert(std::make_pair(it->TheDef, CI));
 920   }
 921
 922   // Populate the map for individual registers.
 923   for (std::map<Record*, std::set<Record*> >::iterator it = RegisterMap.begin(),
 924          ie = RegisterMap.end(); it != ie; ++it)
 925     RegisterClasses[it->first] = RegisterSetClasses[it->second];
 926
 927   // Name the register classes which correspond to singleton registers.
 928   for (SmallPtrSet<Record*, 16>::iterator it = SingletonRegisters.begin(),
 929          ie = SingletonRegisters.end(); it != ie; ++it) {
 930     Record *Rec = *it;
 931     ClassInfo *CI = RegisterClasses[Rec];
 932     assert(CI && "Missing singleton register class info!");
 933
 934     if (CI->ValueName.empty()) {
 935       CI->ClassName = Rec->getName();
 936       CI->Name = "MCK_" + Rec->getName();
 937       CI->ValueName = Rec->getName();
 938     } else
 939       CI->ValueName = CI->ValueName + "," + Rec->getName();
 940   }
 941 }
 942
 943 void AsmMatcherInfo::BuildOperandClasses() {
 944   std::vector<Record*> AsmOperands =
 945     Records.getAllDerivedDefinitions("AsmOperandClass");
 946
 947   // Pre-populate AsmOperandClasses map.
 948   for (std::vector<Record*>::iterator it = AsmOperands.begin(),
 949          ie = AsmOperands.end(); it != ie; ++it)
 950     AsmOperandClasses[*it] = new ClassInfo();
 951
 952   unsigned Index = 0;
 953   for (std::vector<Record*>::iterator it = AsmOperands.begin(),
 954          ie = AsmOperands.end(); it != ie; ++it, ++Index) {
 955     ClassInfo *CI = AsmOperandClasses[*it];
 956     CI->Kind = ClassInfo::UserClass0 + Index;
 957
 958     ListInit *Supers = (*it)->getValueAsListInit("SuperClasses");
 959     for (unsigned i = 0, e = Supers->getSize(); i != e; ++i) {
 960       DefInit *DI = dynamic_cast<DefInit*>(Supers->getElement(i));
 961       if (!DI) {
 962         PrintError((*it)->getLoc(), "Invalid super class reference!");
 963         continue;
 964       }
 965
 966       ClassInfo *SC = AsmOperandClasses[DI->getDef()];
 967       if (!SC)
 968         PrintError((*it)->getLoc(), "Invalid super class reference!");
 969       else
 970         CI->SuperClasses.push_back(SC);
 971     }
 972     CI->ClassName = (*it)->getValueAsString("Name");
 973     CI->Name = "MCK_" + CI->ClassName;
 974     CI->ValueName = (*it)->getName();
 975
 976     // Get or construct the predicate method name.
 977     Init *PMName = (*it)->getValueInit("PredicateMethod");
 978     if (StringInit *SI = dynamic_cast<StringInit*>(PMName)) {
 979       CI->PredicateMethod = SI->getValue();
 980     } else {
 981       assert(dynamic_cast<UnsetInit*>(PMName) &&
 982              "Unexpected PredicateMethod field!");
 983       CI->PredicateMethod = "is" + CI->ClassName;
 984     }
 985
 986     // Get or construct the render method name.
 987     Init *RMName = (*it)->getValueInit("RenderMethod");
 988     if (StringInit *SI = dynamic_cast<StringInit*>(RMName)) {
 989       CI->RenderMethod = SI->getValue();
 990     } else {
 991       assert(dynamic_cast<UnsetInit*>(RMName) &&
 992              "Unexpected RenderMethod field!");
 993       CI->RenderMethod = "add" + CI->ClassName + "Operands";
 994     }
 995
 996     AsmOperandClasses[*it] = CI;
 997     Classes.push_back(CI);
 998   }
 999 }
1000
1001 AsmMatcherInfo::AsmMatcherInfo(Record *asmParser,
1002                                CodeGenTarget &target,
1003                                RecordKeeper &records)
1004   : Records(records), AsmParser(asmParser), Target(target),
1005     RegisterPrefix(AsmParser->getValueAsString("RegisterPrefix")) {
1006 }
1007
1008
1009 void AsmMatcherInfo::BuildInfo() {
1010   // Build information about all of the AssemblerPredicates.
1011   std::vector<Record*> AllPredicates =
1012     Records.getAllDerivedDefinitions("Predicate");
1013   for (unsigned i = 0, e = AllPredicates.size(); i != e; ++i) {
1014     Record *Pred = AllPredicates[i];
1015     // Ignore predicates that are not intended for the assembler.
1016     if (!Pred->getValueAsBit("AssemblerMatcherPredicate"))
1017       continue;
1018
1019     if (Pred->getName().empty())
1020       throw TGError(Pred->getLoc(), "Predicate has no name!");
1021
1022     unsigned FeatureNo = SubtargetFeatures.size();
1023     SubtargetFeatures[Pred] = new SubtargetFeatureInfo(Pred, FeatureNo);
1024     assert(FeatureNo < 32 && "Too many subtarget features!");
1025   }
1026
1027   StringRef CommentDelimiter = AsmParser->getValueAsString("CommentDelimiter");
1028
1029   // Parse the instructions; we need to do this first so that we can gather the
1030   // singleton register classes.
1031   SmallPtrSet<Record*, 16> SingletonRegisters;
1032   for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
1033        E = Target.inst_end(); I != E; ++I) {
1034     const CodeGenInstruction &CGI = **I;
1035
1036     // If the tblgen -match-prefix option is specified (for tblgen hackers),
1037     // filter the set of instructions we consider.
1038     if (!StringRef(CGI.TheDef->getName()).startswith(MatchPrefix))
1039       continue;
1040
1041     // Ignore "codegen only" instructions.
1042     if (CGI.TheDef->getValueAsBit("isCodeGenOnly"))
1043       continue;
1044
1045     // Validate the operand list to ensure we can handle this instruction.
1046     for (unsigned i = 0, e = CGI.Operands.size(); i != e; ++i) {
1047       const CGIOperandList::OperandInfo &OI = CGI.Operands[i];
1048
1049       // Validate tied operands.
1050       if (OI.getTiedRegister() != -1) {
1051         // If we have a tied operand that consists of multiple MCOperands, reject
1052         // it.  We reject aliases and ignore instructions for now.
1053         if (OI.MINumOperands != 1) {
1054           // FIXME: Should reject these.  The ARM backend hits this with $lane
1055           // in a bunch of instructions. It is unclear what the right answer is.
1056           DEBUG({
1057             errs() << "warning: '" << CGI.TheDef->getName() << "': "
1058             << "ignoring instruction with multi-operand tied operand '"
1059             << OI.Name << "'\n";
1060           });
1061           continue;
1062         }
1063       }
1064     }
1065
1066     OwningPtr<MatchableInfo> II(new MatchableInfo(CGI));
1067
1068     II->Initialize(*this, SingletonRegisters);
1069
1070     // Ignore instructions which shouldn't be matched and diagnose invalid
1071     // instruction definitions with an error.
1072     if (!II->Validate(CommentDelimiter, true))
1073       continue;
1074
1075     // Ignore "Int_*" and "*_Int" instructions, which are internal aliases.
1076     //
1077     // FIXME: This is a total hack.
1078     if (StringRef(II->TheDef->getName()).startswith("Int_") ||
1079         StringRef(II->TheDef->getName()).endswith("_Int"))
1080       continue;
1081
1082      Matchables.push_back(II.take());
1083   }
1084
1085   // Parse all of the InstAlias definitions and stick them in the list of
1086   // matchables.
1087   std::vector<Record*> AllInstAliases =
1088     Records.getAllDerivedDefinitions("InstAlias");
1089   for (unsigned i = 0, e = AllInstAliases.size(); i != e; ++i) {
1090     CodeGenInstAlias *Alias = new CodeGenInstAlias(AllInstAliases[i], Target);
1091
1092     OwningPtr<MatchableInfo> II(new MatchableInfo(Alias));
1093
1094     II->Initialize(*this, SingletonRegisters);
1095
1096     // Validate the alias definitions.
1097     II->Validate(CommentDelimiter, false);
1098
1099     Matchables.push_back(II.take());
1100   }
1101
1102   // Build info for the register classes.
1103   BuildRegisterClasses(SingletonRegisters);
1104
1105   // Build info for the user defined assembly operand classes.
1106   BuildOperandClasses();
1107
1108   // Build the information about matchables, now that we have fully formed
1109   // classes.
1110   for (std::vector<MatchableInfo*>::iterator it = Matchables.begin(),
1111          ie = Matchables.end(); it != ie; ++it) {
1112     MatchableInfo *II = *it;
1113
1114     // Parse the tokens after the mnemonic.
1115     for (unsigned i = 0, e = II->AsmOperands.size(); i != e; ++i) {
1116       MatchableInfo::AsmOperand &Op = II->AsmOperands[i];
1117       StringRef Token = Op.Token;
1118
1119       // Check for singleton registers.
1120       if (Record *RegRecord = II->getSingletonRegisterForAsmOperand(i, *this)) {
1121         Op.Class = RegisterClasses[RegRecord];
1122         assert(Op.Class && Op.Class->Registers.size() == 1 &&
1123                "Unexpected class for singleton register");
1124         continue;
1125       }
1126
1127       // Check for simple tokens.
1128       if (Token[0] != '$') {
1129         Op.Class = getTokenClass(Token);
1130         continue;
1131       }
1132
1133       if (Token.size() > 1 && isdigit(Token[1])) {
1134         Op.Class = getTokenClass(Token);
1135         continue;
1136       }
1137
1138       // Otherwise this is an operand reference.
1139       StringRef OperandName;
1140       if (Token[1] == '{')
1141         OperandName = Token.substr(2, Token.size() - 3);
1142       else
1143         OperandName = Token.substr(1);
1144
1145       if (II->DefRec.is<const CodeGenInstruction*>())
1146         BuildInstructionOperandReference(II, OperandName, Op);
1147       else
1148         BuildAliasOperandReference(II, OperandName, Op);
1149     }
1150
1151     if (II->DefRec.is<const CodeGenInstruction*>())
1152       II->BuildInstructionResultOperands();
1153     else
1154       II->BuildAliasResultOperands();
1155   }
1156
1157   // Reorder classes so that classes preceed super classes.
1158   std::sort(Classes.begin(), Classes.end(), less_ptr<ClassInfo>());
1159 }
1160
1161 /// BuildInstructionOperandReference - The specified operand is a reference to a
1162 /// named operand such as $src.  Resolve the Class and OperandInfo pointers.
1163 void AsmMatcherInfo::
1164 BuildInstructionOperandReference(MatchableInfo *II,
1165                                  StringRef OperandName,
1166                                  MatchableInfo::AsmOperand &Op) {
1167   const CodeGenInstruction &CGI = *II->DefRec.get<const CodeGenInstruction*>();
1168   const CGIOperandList &Operands = CGI.Operands;
1169
1170   // Map this token to an operand.
1171   unsigned Idx;
1172   if (!Operands.hasOperandNamed(OperandName, Idx))
1173     throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" +
1174                   OperandName.str() + "'");
1175
1176   // Set up the operand class.
1177   Op.Class = getOperandClass(Operands[Idx]);
1178
1179   // If the named operand is tied, canonicalize it to the untied operand.
1180   // For example, something like:
1181   //   (outs GPR:$dst), (ins GPR:$src)
1182   // with an asmstring of
1183   //   "inc $src"
1184   // we want to canonicalize to:
1185   //   "inc $dst"
1186   // so that we know how to provide the $dst operand when filling in the result.
1187   int OITied = Operands[Idx].getTiedRegister();
1188   if (OITied != -1) {
1189     // The tied operand index is an MIOperand index, find the operand that
1190     // contains it.
1191     for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
1192       if (Operands[i].MIOperandNo == unsigned(OITied)) {
1193         OperandName = Operands[i].Name;
1194         break;
1195       }
1196     }
1197   }
1198
1199   Op.SrcOpName = OperandName;
1200 }
1201
1202 /// BuildAliasOperandReference - When parsing an operand reference out of the
1203 /// matching string (e.g. "movsx $src, $dst"), determine what the class of the
1204 /// operand reference is by looking it up in the result pattern definition.
1205 void AsmMatcherInfo::BuildAliasOperandReference(MatchableInfo *II,
1206                                                 StringRef OperandName,
1207                                                 MatchableInfo::AsmOperand &Op) {
1208   const CodeGenInstAlias &CGA = *II->DefRec.get<const CodeGenInstAlias*>();
1209
1210   // Set up the operand class.
1211   for (unsigned i = 0, e = CGA.ResultOperands.size(); i != e; ++i)
1212     if (CGA.ResultOperands[i].isRecord() &&
1213         CGA.ResultOperands[i].getName() == OperandName) {
1214       // It's safe to go with the first one we find, because CodeGenInstAlias
1215       // validates that all operands with the same name have the same record.
1216       unsigned ResultIdx =CGA.getResultInstOperandIndexForResultOperandIndex(i);
1217       Op.Class = getOperandClass(CGA.ResultInst->Operands[ResultIdx]);
1218       Op.SrcOpName = OperandName;
1219       return;
1220     }
1221
1222   throw TGError(II->TheDef->getLoc(), "error: unable to find operand: '" +
1223                 OperandName.str() + "'");
1224 }
1225
1226 void MatchableInfo::BuildInstructionResultOperands() {
1227   const CodeGenInstruction *ResultInst = getResultInst();
1228
1229   // Loop over all operands of the result instruction, determining how to
1230   // populate them.
1231   for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
1232     const CGIOperandList::OperandInfo &OpInfo = ResultInst->Operands[i];
1233
1234     // If this is a tied operand, just copy from the previously handled operand.
1235     int TiedOp = OpInfo.getTiedRegister();
1236     if (TiedOp != -1) {
1237       ResOperands.push_back(ResOperand::getTiedOp(TiedOp, &OpInfo));
1238       continue;
1239     }
1240
1241     // Find out what operand from the asmparser that this MCInst operand comes
1242     // from.
1243     int SrcOperand = FindAsmOperandNamed(OpInfo.Name);
1244
1245     if (!OpInfo.Name.empty() && SrcOperand != -1) {
1246       ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, &OpInfo));
1247       continue;
1248     }
1249
1250     throw TGError(TheDef->getLoc(), "Instruction '" +
1251                   TheDef->getName() + "' has operand '" + OpInfo.Name +
1252                   "' that doesn't appear in asm string!");
1253   }
1254 }
1255
1256 void MatchableInfo::BuildAliasResultOperands() {
1257   const CodeGenInstAlias &CGA = *DefRec.get<const CodeGenInstAlias*>();
1258   const CodeGenInstruction *ResultInst = getResultInst();
1259
1260   // Loop over all operands of the result instruction, determining how to
1261   // populate them.
1262   unsigned AliasOpNo = 0;
1263   for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
1264     const CGIOperandList::OperandInfo &OpInfo = ResultInst->Operands[i];
1265
1266     // If this is a tied operand, just copy from the previously handled operand.
1267     int TiedOp = OpInfo.getTiedRegister();
1268     if (TiedOp != -1) {
1269       ResOperands.push_back(ResOperand::getTiedOp(TiedOp, &OpInfo));
1270       continue;
1271     }
1272
1273     // Find out what operand from the asmparser that this MCInst operand comes
1274     // from.
1275     switch (CGA.ResultOperands[AliasOpNo].Kind) {
1276     case CodeGenInstAlias::ResultOperand::K_Record: {
1277       StringRef Name = CGA.ResultOperands[AliasOpNo++].getName();
1278       int SrcOperand = FindAsmOperandNamed(Name);
1279       if (SrcOperand != -1) {
1280         ResOperands.push_back(ResOperand::getRenderedOp(SrcOperand, &OpInfo));
1281         continue;
1282       }
1283
1284       throw TGError(TheDef->getLoc(), "Instruction '" +
1285                     TheDef->getName() + "' has operand '" + OpInfo.Name +
1286                     "' that doesn't appear in asm string!");
1287     }
1288     case CodeGenInstAlias::ResultOperand::K_Imm: {
1289       int64_t ImmVal = CGA.ResultOperands[AliasOpNo++].getImm();
1290       ResOperands.push_back(ResOperand::getImmOp(ImmVal, &OpInfo));
1291       continue;
1292     }
1293
1294     case CodeGenInstAlias::ResultOperand::K_Reg: {
1295       Record *Reg = CGA.ResultOperands[AliasOpNo++].getRegister();
1296       ResOperands.push_back(ResOperand::getRegOp(Reg, &OpInfo));
1297       continue;
1298     }
1299     }
1300   }
1301 }
1302
1303 static void EmitConvertToMCInst(CodeGenTarget &Target,
1304                                 std::vector<MatchableInfo*> &Infos,
1305                                 raw_ostream &OS) {
1306   // Write the convert function to a separate stream, so we can drop it after
1307   // the enum.
1308   std::string ConvertFnBody;
1309   raw_string_ostream CvtOS(ConvertFnBody);
1310
1311   // Function we have already generated.
1312   std::set<std::string> GeneratedFns;
1313
1314   // Start the unified conversion function.
1315   CvtOS << "static void ConvertToMCInst(ConversionKind Kind, MCInst &Inst, "
1316         << "unsigned Opcode,\n"
1317         << "                      const SmallVectorImpl<MCParsedAsmOperand*"
1318         << "> &Operands) {\n";
1319   CvtOS << "  Inst.setOpcode(Opcode);\n";
1320   CvtOS << "  switch (Kind) {\n";
1321   CvtOS << "  default:\n";
1322
1323   // Start the enum, which we will generate inline.
1324
1325   OS << "// Unified function for converting operands to MCInst instances.\n\n";
1326   OS << "enum ConversionKind {\n";
1327
1328   // TargetOperandClass - This is the target's operand class, like X86Operand.
1329   std::string TargetOperandClass = Target.getName() + "Operand";
1330
1331   for (std::vector<MatchableInfo*>::const_iterator it = Infos.begin(),
1332          ie = Infos.end(); it != ie; ++it) {
1333     MatchableInfo &II = **it;
1334
1335     // Build the conversion function signature.
1336     std::string Signature = "Convert";
1337     std::string CaseBody;
1338     raw_string_ostream CaseOS(CaseBody);
1339
1340     // Compute the convert enum and the case body.
1341     for (unsigned i = 0, e = II.ResOperands.size(); i != e; ++i) {
1342       const MatchableInfo::ResOperand &OpInfo = II.ResOperands[i];
1343
1344       // Generate code to populate each result operand.
1345       switch (OpInfo.Kind) {
1346       case MatchableInfo::ResOperand::RenderAsmOperand: {
1347         // This comes from something we parsed.
1348         MatchableInfo::AsmOperand &Op = II.AsmOperands[OpInfo.AsmOperandNum];
1349
1350         // Registers are always converted the same, don't duplicate the
1351         // conversion function based on them.
1352         Signature += "__";
1353         if (Op.Class->isRegisterClass())
1354           Signature += "Reg";
1355         else
1356           Signature += Op.Class->ClassName;
1357         Signature += utostr(OpInfo.OpInfo->MINumOperands);
1358         Signature += "_" + itostr(OpInfo.AsmOperandNum);
1359
1360         CaseOS << "    ((" << TargetOperandClass << "*)Operands["
1361                << (OpInfo.AsmOperandNum+1) << "])->" << Op.Class->RenderMethod
1362                << "(Inst, " << OpInfo.OpInfo->MINumOperands << ");\n";
1363         break;
1364       }
1365
1366       case MatchableInfo::ResOperand::TiedOperand: {
1367         // If this operand is tied to a previous one, just copy the MCInst
1368         // operand from the earlier one.We can only tie single MCOperand values.
1369       //assert(OpInfo.OpInfo->MINumOperands == 1 && "Not a singular MCOperand");
1370         unsigned TiedOp = OpInfo.TiedOperandNum;
1371         assert(i > TiedOp && "Tied operand preceeds its target!");
1372         CaseOS << "    Inst.addOperand(Inst.getOperand(" << TiedOp << "));\n";
1373         Signature += "__Tie" + utostr(TiedOp);
1374         break;
1375       }
1376       case MatchableInfo::ResOperand::ImmOperand: {
1377         int64_t Val = OpInfo.ImmVal;
1378         CaseOS << "    Inst.addOperand(MCOperand::CreateImm(" << Val << "));\n";
1379         Signature += "__imm" + itostr(Val);
1380         break;
1381       }
1382       case MatchableInfo::ResOperand::RegOperand: {
1383         std::string N = getQualifiedName(OpInfo.Register);
1384         CaseOS << "    Inst.addOperand(MCOperand::CreateReg(" << N << "));\n";
1385         Signature += "__reg" + OpInfo.Register->getName();
1386       }
1387       }
1388     }
1389
1390     II.ConversionFnKind = Signature;
1391
1392     // Check if we have already generated this signature.
1393     if (!GeneratedFns.insert(Signature).second)
1394       continue;
1395
1396     // If not, emit it now.  Add to the enum list.
1397     OS << "  " << Signature << ",\n";
1398
1399     CvtOS << "  case " << Signature << ":\n";
1400     CvtOS << CaseOS.str();
1401     CvtOS << "    return;\n";
1402   }
1403
1404   // Finish the convert function.
1405
1406   CvtOS << "  }\n";
1407   CvtOS << "}\n\n";
1408
1409   // Finish the enum, and drop the convert function after it.
1410
1411   OS << "  NumConversionVariants\n";
1412   OS << "};\n\n";
1413
1414   OS << CvtOS.str();
1415 }
1416
1417 /// EmitMatchClassEnumeration - Emit the enumeration for match class kinds.
1418 static void EmitMatchClassEnumeration(CodeGenTarget &Target,
1419                                       std::vector<ClassInfo*> &Infos,
1420                                       raw_ostream &OS) {
1421   OS << "namespace {\n\n";
1422
1423   OS << "/// MatchClassKind - The kinds of classes which participate in\n"
1424      << "/// instruction matching.\n";
1425   OS << "enum MatchClassKind {\n";
1426   OS << "  InvalidMatchClass = 0,\n";
1427   for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1428          ie = Infos.end(); it != ie; ++it) {
1429     ClassInfo &CI = **it;
1430     OS << "  " << CI.Name << ", // ";
1431     if (CI.Kind == ClassInfo::Token) {
1432       OS << "'" << CI.ValueName << "'\n";
1433     } else if (CI.isRegisterClass()) {
1434       if (!CI.ValueName.empty())
1435         OS << "register class '" << CI.ValueName << "'\n";
1436       else
1437         OS << "derived register class\n";
1438     } else {
1439       OS << "user defined class '" << CI.ValueName << "'\n";
1440     }
1441   }
1442   OS << "  NumMatchClassKinds\n";
1443   OS << "};\n\n";
1444
1445   OS << "}\n\n";
1446 }
1447
1448 /// EmitClassifyOperand - Emit the function to classify an operand.
1449 static void EmitClassifyOperand(AsmMatcherInfo &Info,
1450                                 raw_ostream &OS) {
1451   OS << "static MatchClassKind ClassifyOperand(MCParsedAsmOperand *GOp) {\n"
1452      << "  " << Info.Target.getName() << "Operand &Operand = *("
1453      << Info.Target.getName() << "Operand*)GOp;\n";
1454
1455   // Classify tokens.
1456   OS << "  if (Operand.isToken())\n";
1457   OS << "    return MatchTokenString(Operand.getToken());\n\n";
1458
1459   // Classify registers.
1460   //
1461   // FIXME: Don't hardcode isReg, getReg.
1462   OS << "  if (Operand.isReg()) {\n";
1463   OS << "    switch (Operand.getReg()) {\n";
1464   OS << "    default: return InvalidMatchClass;\n";
1465   for (std::map<Record*, ClassInfo*>::iterator
1466          it = Info.RegisterClasses.begin(), ie = Info.RegisterClasses.end();
1467        it != ie; ++it)
1468     OS << "    case " << Info.Target.getName() << "::"
1469        << it->first->getName() << ": return " << it->second->Name << ";\n";
1470   OS << "    }\n";
1471   OS << "  }\n\n";
1472
1473   // Classify user defined operands.
1474   for (std::vector<ClassInfo*>::iterator it = Info.Classes.begin(),
1475          ie = Info.Classes.end(); it != ie; ++it) {
1476     ClassInfo &CI = **it;
1477
1478     if (!CI.isUserClass())
1479       continue;
1480
1481     OS << "  // '" << CI.ClassName << "' class";
1482     if (!CI.SuperClasses.empty()) {
1483       OS << ", subclass of ";
1484       for (unsigned i = 0, e = CI.SuperClasses.size(); i != e; ++i) {
1485         if (i) OS << ", ";
1486         OS << "'" << CI.SuperClasses[i]->ClassName << "'";
1487         assert(CI < *CI.SuperClasses[i] && "Invalid class relation!");
1488       }
1489     }
1490     OS << "\n";
1491
1492     OS << "  if (Operand." << CI.PredicateMethod << "()) {\n";
1493
1494     // Validate subclass relationships.
1495     if (!CI.SuperClasses.empty()) {
1496       for (unsigned i = 0, e = CI.SuperClasses.size(); i != e; ++i)
1497         OS << "    assert(Operand." << CI.SuperClasses[i]->PredicateMethod
1498            << "() && \"Invalid class relationship!\");\n";
1499     }
1500
1501     OS << "    return " << CI.Name << ";\n";
1502     OS << "  }\n\n";
1503   }
1504   OS << "  return InvalidMatchClass;\n";
1505   OS << "}\n\n";
1506 }
1507
1508 /// EmitIsSubclass - Emit the subclass predicate function.
1509 static void EmitIsSubclass(CodeGenTarget &Target,
1510                            std::vector<ClassInfo*> &Infos,
1511                            raw_ostream &OS) {
1512   OS << "/// IsSubclass - Compute whether \\arg A is a subclass of \\arg B.\n";
1513   OS << "static bool IsSubclass(MatchClassKind A, MatchClassKind B) {\n";
1514   OS << "  if (A == B)\n";
1515   OS << "    return true;\n\n";
1516
1517   OS << "  switch (A) {\n";
1518   OS << "  default:\n";
1519   OS << "    return false;\n";
1520   for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1521          ie = Infos.end(); it != ie; ++it) {
1522     ClassInfo &A = **it;
1523
1524     if (A.Kind != ClassInfo::Token) {
1525       std::vector<StringRef> SuperClasses;
1526       for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1527              ie = Infos.end(); it != ie; ++it) {
1528         ClassInfo &B = **it;
1529
1530         if (&A != &B && A.isSubsetOf(B))
1531           SuperClasses.push_back(B.Name);
1532       }
1533
1534       if (SuperClasses.empty())
1535         continue;
1536
1537       OS << "\n  case " << A.Name << ":\n";
1538
1539       if (SuperClasses.size() == 1) {
1540         OS << "    return B == " << SuperClasses.back() << ";\n";
1541         continue;
1542       }
1543
1544       OS << "    switch (B) {\n";
1545       OS << "    default: return false;\n";
1546       for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1547         OS << "    case " << SuperClasses[i] << ": return true;\n";
1548       OS << "    }\n";
1549     }
1550   }
1551   OS << "  }\n";
1552   OS << "}\n\n";
1553 }
1554
1555
1556
1557 /// EmitMatchTokenString - Emit the function to match a token string to the
1558 /// appropriate match class value.
1559 static void EmitMatchTokenString(CodeGenTarget &Target,
1560                                  std::vector<ClassInfo*> &Infos,
1561                                  raw_ostream &OS) {
1562   // Construct the match list.
1563   std::vector<StringMatcher::StringPair> Matches;
1564   for (std::vector<ClassInfo*>::iterator it = Infos.begin(),
1565          ie = Infos.end(); it != ie; ++it) {
1566     ClassInfo &CI = **it;
1567
1568     if (CI.Kind == ClassInfo::Token)
1569       Matches.push_back(StringMatcher::StringPair(CI.ValueName,
1570                                                   "return " + CI.Name + ";"));
1571   }
1572
1573   OS << "static MatchClassKind MatchTokenString(StringRef Name) {\n";
1574
1575   StringMatcher("Name", Matches, OS).Emit();
1576
1577   OS << "  return InvalidMatchClass;\n";
1578   OS << "}\n\n";
1579 }
1580
1581 /// EmitMatchRegisterName - Emit the function to match a string to the target
1582 /// specific register enum.
1583 static void EmitMatchRegisterName(CodeGenTarget &Target, Record *AsmParser,
1584                                   raw_ostream &OS) {
1585   // Construct the match list.
1586   std::vector<StringMatcher::StringPair> Matches;
1587   for (unsigned i = 0, e = Target.getRegisters().size(); i != e; ++i) {
1588     const CodeGenRegister &Reg = Target.getRegisters()[i];
1589     if (Reg.TheDef->getValueAsString("AsmName").empty())
1590       continue;
1591
1592     Matches.push_back(StringMatcher::StringPair(
1593                                         Reg.TheDef->getValueAsString("AsmName"),
1594                                         "return " + utostr(i + 1) + ";"));
1595   }
1596
1597   OS << "static unsigned MatchRegisterName(StringRef Name) {\n";
1598
1599   StringMatcher("Name", Matches, OS).Emit();
1600
1601   OS << "  return 0;\n";
1602   OS << "}\n\n";
1603 }
1604
1605 /// EmitSubtargetFeatureFlagEnumeration - Emit the subtarget feature flag
1606 /// definitions.
1607 static void EmitSubtargetFeatureFlagEnumeration(AsmMatcherInfo &Info,
1608                                                 raw_ostream &OS) {
1609   OS << "// Flags for subtarget features that participate in "
1610      << "instruction matching.\n";
1611   OS << "enum SubtargetFeatureFlag {\n";
1612   for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator
1613          it = Info.SubtargetFeatures.begin(),
1614          ie = Info.SubtargetFeatures.end(); it != ie; ++it) {
1615     SubtargetFeatureInfo &SFI = *it->second;
1616     OS << "  " << SFI.getEnumName() << " = (1 << " << SFI.Index << "),\n";
1617   }
1618   OS << "  Feature_None = 0\n";
1619   OS << "};\n\n";
1620 }
1621
1622 /// EmitComputeAvailableFeatures - Emit the function to compute the list of
1623 /// available features given a subtarget.
1624 static void EmitComputeAvailableFeatures(AsmMatcherInfo &Info,
1625                                          raw_ostream &OS) {
1626   std::string ClassName =
1627     Info.AsmParser->getValueAsString("AsmParserClassName");
1628
1629   OS << "unsigned " << Info.Target.getName() << ClassName << "::\n"
1630      << "ComputeAvailableFeatures(const " << Info.Target.getName()
1631      << "Subtarget *Subtarget) const {\n";
1632   OS << "  unsigned Features = 0;\n";
1633   for (std::map<Record*, SubtargetFeatureInfo*>::const_iterator
1634          it = Info.SubtargetFeatures.begin(),
1635          ie = Info.SubtargetFeatures.end(); it != ie; ++it) {
1636     SubtargetFeatureInfo &SFI = *it->second;
1637     OS << "  if (" << SFI.TheDef->getValueAsString("CondString")
1638        << ")\n";
1639     OS << "    Features |= " << SFI.getEnumName() << ";\n";
1640   }
1641   OS << "  return Features;\n";
1642   OS << "}\n\n";
1643 }
1644
1645 static std::string GetAliasRequiredFeatures(Record *R,
1646                                             const AsmMatcherInfo &Info) {
1647   std::vector<Record*> ReqFeatures = R->getValueAsListOfDefs("Predicates");
1648   std::string Result;
1649   unsigned NumFeatures = 0;
1650   for (unsigned i = 0, e = ReqFeatures.size(); i != e; ++i) {
1651     SubtargetFeatureInfo *F = Info.getSubtargetFeature(ReqFeatures[i]);
1652
1653     if (F == 0)
1654       throw TGError(R->getLoc(), "Predicate '" + ReqFeatures[i]->getName() +
1655                     "' is not marked as an AssemblerPredicate!");
1656
1657     if (NumFeatures)
1658       Result += '|';
1659
1660     Result += F->getEnumName();
1661     ++NumFeatures;
1662   }
1663
1664   if (NumFeatures > 1)
1665     Result = '(' + Result + ')';
1666   return Result;
1667 }
1668
1669 /// EmitMnemonicAliases - If the target has any MnemonicAlias<> definitions,
1670 /// emit a function for them and return true, otherwise return false.
1671 static bool EmitMnemonicAliases(raw_ostream &OS, const AsmMatcherInfo &Info) {
1672   std::vector<Record*> Aliases =
1673     Info.getRecords().getAllDerivedDefinitions("MnemonicAlias");
1674   if (Aliases.empty()) return false;
1675
1676   OS << "static void ApplyMnemonicAliases(StringRef &Mnemonic, "
1677         "unsigned Features) {\n";
1678
1679   // Keep track of all the aliases from a mnemonic.  Use an std::map so that the
1680   // iteration order of the map is stable.
1681   std::map<std::string, std::vector<Record*> > AliasesFromMnemonic;
1682
1683   for (unsigned i = 0, e = Aliases.size(); i != e; ++i) {
1684     Record *R = Aliases[i];
1685     AliasesFromMnemonic[R->getValueAsString("FromMnemonic")].push_back(R);
1686   }
1687
1688   // Process each alias a "from" mnemonic at a time, building the code executed
1689   // by the string remapper.
1690   std::vector<StringMatcher::StringPair> Cases;
1691   for (std::map<std::string, std::vector<Record*> >::iterator
1692        I = AliasesFromMnemonic.begin(), E = AliasesFromMnemonic.end();
1693        I != E; ++I) {
1694     const std::vector<Record*> &ToVec = I->second;
1695
1696     // Loop through each alias and emit code that handles each case.  If there
1697     // are two instructions without predicates, emit an error.  If there is one,
1698     // emit it last.
1699     std::string MatchCode;
1700     int AliasWithNoPredicate = -1;
1701
1702     for (unsigned i = 0, e = ToVec.size(); i != e; ++i) {
1703       Record *R = ToVec[i];
1704       std::string FeatureMask = GetAliasRequiredFeatures(R, Info);
1705
1706       // If this unconditionally matches, remember it for later and diagnose
1707       // duplicates.
1708       if (FeatureMask.empty()) {
1709         if (AliasWithNoPredicate != -1) {
1710           // We can't have two aliases from the same mnemonic with no predicate.
1711           PrintError(ToVec[AliasWithNoPredicate]->getLoc(),
1712                      "two MnemonicAliases with the same 'from' mnemonic!");
1713           throw TGError(R->getLoc(), "this is the other MnemonicAlias.");
1714         }
1715
1716         AliasWithNoPredicate = i;
1717         continue;
1718       }
1719
1720       if (!MatchCode.empty())
1721         MatchCode += "else ";
1722       MatchCode += "if ((Features & " + FeatureMask + ") == "+FeatureMask+")\n";
1723       MatchCode += "  Mnemonic = \"" +R->getValueAsString("ToMnemonic")+"\";\n";
1724     }
1725
1726     if (AliasWithNoPredicate != -1) {
1727       Record *R = ToVec[AliasWithNoPredicate];
1728       if (!MatchCode.empty())
1729         MatchCode += "else\n  ";
1730       MatchCode += "Mnemonic = \"" + R->getValueAsString("ToMnemonic")+"\";\n";
1731     }
1732
1733     MatchCode += "return;";
1734
1735     Cases.push_back(std::make_pair(I->first, MatchCode));
1736   }
1737
1738
1739   StringMatcher("Mnemonic", Cases, OS).Emit();
1740   OS << "}\n";
1741
1742   return true;
1743 }
1744
1745 void AsmMatcherEmitter::run(raw_ostream &OS) {
1746   CodeGenTarget Target(Records);
1747   Record *AsmParser = Target.getAsmParser();
1748   std::string ClassName = AsmParser->getValueAsString("AsmParserClassName");
1749
1750   // Compute the information on the instructions to match.
1751   AsmMatcherInfo Info(AsmParser, Target, Records);
1752   Info.BuildInfo();
1753
1754   // Sort the instruction table using the partial order on classes. We use
1755   // stable_sort to ensure that ambiguous instructions are still
1756   // deterministically ordered.
1757   std::stable_sort(Info.Matchables.begin(), Info.Matchables.end(),
1758                    less_ptr<MatchableInfo>());
1759
1760   DEBUG_WITH_TYPE("instruction_info", {
1761       for (std::vector<MatchableInfo*>::iterator
1762              it = Info.Matchables.begin(), ie = Info.Matchables.end();
1763            it != ie; ++it)
1764         (*it)->dump();
1765     });
1766
1767   // Check for ambiguous matchables.
1768   DEBUG_WITH_TYPE("ambiguous_instrs", {
1769     unsigned NumAmbiguous = 0;
1770     for (unsigned i = 0, e = Info.Matchables.size(); i != e; ++i) {
1771       for (unsigned j = i + 1; j != e; ++j) {
1772         MatchableInfo &A = *Info.Matchables[i];
1773         MatchableInfo &B = *Info.Matchables[j];
1774
1775         if (A.CouldMatchAmiguouslyWith(B)) {
1776           errs() << "warning: ambiguous matchables:\n";
1777           A.dump();
1778           errs() << "\nis incomparable with:\n";
1779           B.dump();
1780           errs() << "\n\n";
1781           ++NumAmbiguous;
1782         }
1783       }
1784     }
1785     if (NumAmbiguous)
1786       errs() << "warning: " << NumAmbiguous
1787              << " ambiguous matchables!\n";
1788   });
1789
1790   // Write the output.
1791
1792   EmitSourceFileHeader("Assembly Matcher Source Fragment", OS);
1793
1794   // Information for the class declaration.
1795   OS << "\n#ifdef GET_ASSEMBLER_HEADER\n";
1796   OS << "#undef GET_ASSEMBLER_HEADER\n";
1797   OS << "  // This should be included into the middle of the declaration of \n";
1798   OS << "  // your subclasses implementation of TargetAsmParser.\n";
1799   OS << "  unsigned ComputeAvailableFeatures(const " <<
1800            Target.getName() << "Subtarget *Subtarget) const;\n";
1801   OS << "  enum MatchResultTy {\n";
1802   OS << "    Match_Success, Match_MnemonicFail, Match_InvalidOperand,\n";
1803   OS << "    Match_MissingFeature\n";
1804   OS << "  };\n";
1805   OS << "  MatchResultTy MatchInstructionImpl(\n";
1806   OS << "    const SmallVectorImpl<MCParsedAsmOperand*> &Operands,\n";
1807   OS << "    MCInst &Inst, unsigned &ErrorInfo);\n\n";
1808   OS << "#endif // GET_ASSEMBLER_HEADER_INFO\n\n";
1809
1810   OS << "\n#ifdef GET_REGISTER_MATCHER\n";
1811   OS << "#undef GET_REGISTER_MATCHER\n\n";
1812
1813   // Emit the subtarget feature enumeration.
1814   EmitSubtargetFeatureFlagEnumeration(Info, OS);
1815
1816   // Emit the function to match a register name to number.
1817   EmitMatchRegisterName(Target, AsmParser, OS);
1818
1819   OS << "#endif // GET_REGISTER_MATCHER\n\n";
1820
1821
1822   OS << "\n#ifdef GET_MATCHER_IMPLEMENTATION\n";
1823   OS << "#undef GET_MATCHER_IMPLEMENTATION\n\n";
1824
1825   // Generate the function that remaps for mnemonic aliases.
1826   bool HasMnemonicAliases = EmitMnemonicAliases(OS, Info);
1827
1828   // Generate the unified function to convert operands into an MCInst.
1829   EmitConvertToMCInst(Target, Info.Matchables, OS);
1830
1831   // Emit the enumeration for classes which participate in matching.
1832   EmitMatchClassEnumeration(Target, Info.Classes, OS);
1833
1834   // Emit the routine to match token strings to their match class.
1835   EmitMatchTokenString(Target, Info.Classes, OS);
1836
1837   // Emit the routine to classify an operand.
1838   EmitClassifyOperand(Info, OS);
1839
1840   // Emit the subclass predicate routine.
1841   EmitIsSubclass(Target, Info.Classes, OS);
1842
1843   // Emit the available features compute function.
1844   EmitComputeAvailableFeatures(Info, OS);
1845
1846
1847   size_t MaxNumOperands = 0;
1848   for (std::vector<MatchableInfo*>::const_iterator it =
1849          Info.Matchables.begin(), ie = Info.Matchables.end();
1850        it != ie; ++it)
1851     MaxNumOperands = std::max(MaxNumOperands, (*it)->AsmOperands.size());
1852
1853
1854   // Emit the static match table; unused classes get initalized to 0 which is
1855   // guaranteed to be InvalidMatchClass.
1856   //
1857   // FIXME: We can reduce the size of this table very easily. First, we change
1858   // it so that store the kinds in separate bit-fields for each index, which
1859   // only needs to be the max width used for classes at that index (we also need
1860   // to reject based on this during classification). If we then make sure to
1861   // order the match kinds appropriately (putting mnemonics last), then we
1862   // should only end up using a few bits for each class, especially the ones
1863   // following the mnemonic.
1864   OS << "namespace {\n";
1865   OS << "  struct MatchEntry {\n";
1866   OS << "    unsigned Opcode;\n";
1867   OS << "    const char *Mnemonic;\n";
1868   OS << "    ConversionKind ConvertFn;\n";
1869   OS << "    MatchClassKind Classes[" << MaxNumOperands << "];\n";
1870   OS << "    unsigned RequiredFeatures;\n";
1871   OS << "  };\n\n";
1872
1873   OS << "// Predicate for searching for an opcode.\n";
1874   OS << "  struct LessOpcode {\n";
1875   OS << "    bool operator()(const MatchEntry &LHS, StringRef RHS) {\n";
1876   OS << "      return StringRef(LHS.Mnemonic) < RHS;\n";
1877   OS << "    }\n";
1878   OS << "    bool operator()(StringRef LHS, const MatchEntry &RHS) {\n";
1879   OS << "      return LHS < StringRef(RHS.Mnemonic);\n";
1880   OS << "    }\n";
1881   OS << "    bool operator()(const MatchEntry &LHS, const MatchEntry &RHS) {\n";
1882   OS << "      return StringRef(LHS.Mnemonic) < StringRef(RHS.Mnemonic);\n";
1883   OS << "    }\n";
1884   OS << "  };\n";
1885
1886   OS << "} // end anonymous namespace.\n\n";
1887
1888   OS << "static const MatchEntry MatchTable["
1889      << Info.Matchables.size() << "] = {\n";
1890
1891   for (std::vector<MatchableInfo*>::const_iterator it =
1892        Info.Matchables.begin(), ie = Info.Matchables.end();
1893        it != ie; ++it) {
1894     MatchableInfo &II = **it;
1895
1896
1897     OS << "  { " << Target.getName() << "::"
1898        << II.getResultInst()->TheDef->getName() << ", \"" << II.Mnemonic << "\""
1899        << ", " << II.ConversionFnKind << ", { ";
1900     for (unsigned i = 0, e = II.AsmOperands.size(); i != e; ++i) {
1901       MatchableInfo::AsmOperand &Op = II.AsmOperands[i];
1902
1903       if (i) OS << ", ";
1904       OS << Op.Class->Name;
1905     }
1906     OS << " }, ";
1907
1908     // Write the required features mask.
1909     if (!II.RequiredFeatures.empty()) {
1910       for (unsigned i = 0, e = II.RequiredFeatures.size(); i != e; ++i) {
1911         if (i) OS << "|";
1912         OS << II.RequiredFeatures[i]->getEnumName();
1913       }
1914     } else
1915       OS << "0";
1916
1917     OS << "},\n";
1918   }
1919
1920   OS << "};\n\n";
1921
1922   // Finally, build the match function.
1923   OS << Target.getName() << ClassName << "::MatchResultTy "
1924      << Target.getName() << ClassName << "::\n"
1925      << "MatchInstructionImpl(const SmallVectorImpl<MCParsedAsmOperand*>"
1926      << " &Operands,\n";
1927   OS << "                     MCInst &Inst, unsigned &ErrorInfo) {\n";
1928
1929   // Emit code to get the available features.
1930   OS << "  // Get the current feature set.\n";
1931   OS << "  unsigned AvailableFeatures = getAvailableFeatures();\n\n";
1932
1933   OS << "  // Get the instruction mnemonic, which is the first token.\n";
1934   OS << "  StringRef Mnemonic = ((" << Target.getName()
1935      << "Operand*)Operands[0])->getToken();\n\n";
1936
1937   if (HasMnemonicAliases) {
1938     OS << "  // Process all MnemonicAliases to remap the mnemonic.\n";
1939     OS << "  ApplyMnemonicAliases(Mnemonic, AvailableFeatures);\n\n";
1940   }
1941
1942   // Emit code to compute the class list for this operand vector.
1943   OS << "  // Eliminate obvious mismatches.\n";
1944   OS << "  if (Operands.size() > " << (MaxNumOperands+1) << ") {\n";
1945   OS << "    ErrorInfo = " << (MaxNumOperands+1) << ";\n";
1946   OS << "    return Match_InvalidOperand;\n";
1947   OS << "  }\n\n";
1948
1949   OS << "  // Compute the class list for this operand vector.\n";
1950   OS << "  MatchClassKind Classes[" << MaxNumOperands << "];\n";
1951   OS << "  for (unsigned i = 1, e = Operands.size(); i != e; ++i) {\n";
1952   OS << "    Classes[i-1] = ClassifyOperand(Operands[i]);\n\n";
1953
1954   OS << "    // Check for invalid operands before matching.\n";
1955   OS << "    if (Classes[i-1] == InvalidMatchClass) {\n";
1956   OS << "      ErrorInfo = i;\n";
1957   OS << "      return Match_InvalidOperand;\n";
1958   OS << "    }\n";
1959   OS << "  }\n\n";
1960
1961   OS << "  // Mark unused classes.\n";
1962   OS << "  for (unsigned i = Operands.size()-1, e = " << MaxNumOperands << "; "
1963      << "i != e; ++i)\n";
1964   OS << "    Classes[i] = InvalidMatchClass;\n\n";
1965
1966   OS << "  // Some state to try to produce better error messages.\n";
1967   OS << "  bool HadMatchOtherThanFeatures = false;\n\n";
1968   OS << "  // Set ErrorInfo to the operand that mismatches if it is \n";
1969   OS << "  // wrong for all instances of the instruction.\n";
1970   OS << "  ErrorInfo = ~0U;\n";
1971
1972   // Emit code to search the table.
1973   OS << "  // Search the table.\n";
1974   OS << "  std::pair<const MatchEntry*, const MatchEntry*> MnemonicRange =\n";
1975   OS << "    std::equal_range(MatchTable, MatchTable+"
1976      << Info.Matchables.size() << ", Mnemonic, LessOpcode());\n\n";
1977
1978   OS << "  // Return a more specific error code if no mnemonics match.\n";
1979   OS << "  if (MnemonicRange.first == MnemonicRange.second)\n";
1980   OS << "    return Match_MnemonicFail;\n\n";
1981
1982   OS << "  for (const MatchEntry *it = MnemonicRange.first, "
1983      << "*ie = MnemonicRange.second;\n";
1984   OS << "       it != ie; ++it) {\n";
1985
1986   OS << "    // equal_range guarantees that instruction mnemonic matches.\n";
1987   OS << "    assert(Mnemonic == it->Mnemonic);\n";
1988
1989   // Emit check that the subclasses match.
1990   OS << "    bool OperandsValid = true;\n";
1991   OS << "    for (unsigned i = 0; i != " << MaxNumOperands << "; ++i) {\n";
1992   OS << "      if (IsSubclass(Classes[i], it->Classes[i]))\n";
1993   OS << "        continue;\n";
1994   OS << "      // If this operand is broken for all of the instances of this\n";
1995   OS << "      // mnemonic, keep track of it so we can report loc info.\n";
1996   OS << "      if (it == MnemonicRange.first || ErrorInfo == i+1)\n";
1997   OS << "        ErrorInfo = i+1;\n";
1998   OS << "      else\n";
1999   OS << "        ErrorInfo = ~0U;";
2000   OS << "      // Otherwise, just reject this instance of the mnemonic.\n";
2001   OS << "      OperandsValid = false;\n";
2002   OS << "      break;\n";
2003   OS << "    }\n\n";
2004
2005   OS << "    if (!OperandsValid) continue;\n";
2006
2007   // Emit check that the required features are available.
2008   OS << "    if ((AvailableFeatures & it->RequiredFeatures) "
2009      << "!= it->RequiredFeatures) {\n";
2010   OS << "      HadMatchOtherThanFeatures = true;\n";
2011   OS << "      continue;\n";
2012   OS << "    }\n";
2013
2014   OS << "\n";
2015   OS << "    ConvertToMCInst(it->ConvertFn, Inst, it->Opcode, Operands);\n";
2016
2017   // Call the post-processing function, if used.
2018   std::string InsnCleanupFn =
2019     AsmParser->getValueAsString("AsmParserInstCleanup");
2020   if (!InsnCleanupFn.empty())
2021     OS << "    " << InsnCleanupFn << "(Inst);\n";
2022
2023   OS << "    return Match_Success;\n";
2024   OS << "  }\n\n";
2025
2026   OS << "  // Okay, we had no match.  Try to return a useful error code.\n";
2027   OS << "  if (HadMatchOtherThanFeatures) return Match_MissingFeature;\n";
2028   OS << "  return Match_InvalidOperand;\n";
2029   OS << "}\n\n";
2030
2031   OS << "#endif // GET_MATCHER_IMPLEMENTATION\n\n";
2032 }