utils/TableGen/DAGISelMatcherGen.cpp

   1 //===- DAGISelMatcherGen.cpp - Matcher generator --------------------------===//
   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 #include "DAGISelMatcher.h"
  11 #include "CodeGenDAGPatterns.h"
  12 #include "Record.h"
  13 #include "llvm/ADT/SmallVector.h"
  14 #include "llvm/ADT/StringMap.h"
  15 #include <utility>
  16 using namespace llvm;
  17
  18
  19 /// getRegisterValueType - Look up and return the ValueType of the specified
  20 /// register. If the register is a member of multiple register classes which
  21 /// have different associated types, return MVT::Other.
  22 static MVT::SimpleValueType getRegisterValueType(Record *R,
  23                                                  const CodeGenTarget &T) {
  24   bool FoundRC = false;
  25   MVT::SimpleValueType VT = MVT::Other;
  26   const std::vector<CodeGenRegisterClass> &RCs = T.getRegisterClasses();
  27   std::vector<Record*>::const_iterator Element;
  28
  29   for (unsigned rc = 0, e = RCs.size(); rc != e; ++rc) {
  30     const CodeGenRegisterClass &RC = RCs[rc];
  31     if (!std::count(RC.Elements.begin(), RC.Elements.end(), R))
  32       continue;
  33
  34     if (!FoundRC) {
  35       FoundRC = true;
  36       VT = RC.getValueTypeNum(0);
  37       continue;
  38     }
  39
  40     // If this occurs in multiple register classes, they all have to agree.
  41     assert(VT == RC.getValueTypeNum(0));
  42   }
  43   return VT;
  44 }
  45
  46
  47 namespace {
  48   class MatcherGen {
  49     const PatternToMatch &Pattern;
  50     const CodeGenDAGPatterns &CGP;
  51
  52     /// PatWithNoTypes - This is a clone of Pattern.getSrcPattern() that starts
  53     /// out with all of the types removed.  This allows us to insert type checks
  54     /// as we scan the tree.
  55     TreePatternNode *PatWithNoTypes;
  56
  57     /// VariableMap - A map from variable names ('$dst') to the recorded operand
  58     /// number that they were captured as.  These are biased by 1 to make
  59     /// insertion easier.
  60     StringMap<unsigned> VariableMap;
  61
  62     /// NextRecordedOperandNo - As we emit opcodes to record matched values in
  63     /// the RecordedNodes array, this keeps track of which slot will be next to
  64     /// record into.
  65     unsigned NextRecordedOperandNo;
  66
  67     /// MatchedChainNodes - This maintains the position in the recorded nodes
  68     /// array of all of the recorded input nodes that have chains.
  69     SmallVector<unsigned, 2> MatchedChainNodes;
  70
  71     /// MatchedFlagResultNodes - This maintains the position in the recorded
  72     /// nodes array of all of the recorded input nodes that have flag results.
  73     SmallVector<unsigned, 2> MatchedFlagResultNodes;
  74
  75     /// MatchedComplexPatterns - This maintains a list of all of the
  76     /// ComplexPatterns that we need to check.  The patterns are known to have
  77     /// names which were recorded.  The second element of each pair is the first
  78     /// slot number that the OPC_CheckComplexPat opcode drops the matched
  79     /// results into.
  80     SmallVector<std::pair<const TreePatternNode*,
  81                           unsigned>, 2> MatchedComplexPatterns;
  82
  83     /// PhysRegInputs - List list has an entry for each explicitly specified
  84     /// physreg input to the pattern.  The first elt is the Register node, the
  85     /// second is the recorded slot number the input pattern match saved it in.
  86     SmallVector<std::pair<Record*, unsigned>, 2> PhysRegInputs;
  87
  88     /// Matcher - This is the top level of the generated matcher, the result.
  89     Matcher *TheMatcher;
  90
  91     /// CurPredicate - As we emit matcher nodes, this points to the latest check
  92     /// which should have future checks stuck into its Next position.
  93     Matcher *CurPredicate;
  94   public:
  95     MatcherGen(const PatternToMatch &pattern, const CodeGenDAGPatterns &cgp);
  96
  97     ~MatcherGen() {
  98       delete PatWithNoTypes;
  99     }
 100
 101     bool EmitMatcherCode(unsigned Variant);
 102     void EmitResultCode();
 103
 104     Matcher *GetMatcher() const { return TheMatcher; }
 105     Matcher *GetCurPredicate() const { return CurPredicate; }
 106   private:
 107     void AddMatcher(Matcher *NewNode);
 108     void InferPossibleTypes();
 109
 110     // Matcher Generation.
 111     void EmitMatchCode(const TreePatternNode *N, TreePatternNode *NodeNoTypes);
 112     void EmitLeafMatchCode(const TreePatternNode *N);
 113     void EmitOperatorMatchCode(const TreePatternNode *N,
 114                                TreePatternNode *NodeNoTypes);
 115
 116     // Result Code Generation.
 117     unsigned getNamedArgumentSlot(StringRef Name) {
 118       unsigned VarMapEntry = VariableMap[Name];
 119       assert(VarMapEntry != 0 &&
 120              "Variable referenced but not defined and not caught earlier!");
 121       return VarMapEntry-1;
 122     }
 123
 124     /// GetInstPatternNode - Get the pattern for an instruction.
 125     const TreePatternNode *GetInstPatternNode(const DAGInstruction &Ins,
 126                                               const TreePatternNode *N);
 127
 128     void EmitResultOperand(const TreePatternNode *N,
 129                            SmallVectorImpl<unsigned> &ResultOps);
 130     void EmitResultOfNamedOperand(const TreePatternNode *N,
 131                                   SmallVectorImpl<unsigned> &ResultOps);
 132     void EmitResultLeafAsOperand(const TreePatternNode *N,
 133                                  SmallVectorImpl<unsigned> &ResultOps);
 134     void EmitResultInstructionAsOperand(const TreePatternNode *N,
 135                                         SmallVectorImpl<unsigned> &ResultOps);
 136     void EmitResultSDNodeXFormAsOperand(const TreePatternNode *N,
 137                                         SmallVectorImpl<unsigned> &ResultOps);
 138     };
 139
 140 } // end anon namespace.
 141
 142 MatcherGen::MatcherGen(const PatternToMatch &pattern,
 143                        const CodeGenDAGPatterns &cgp)
 144 : Pattern(pattern), CGP(cgp), NextRecordedOperandNo(0),
 145   TheMatcher(0), CurPredicate(0) {
 146   // We need to produce the matcher tree for the patterns source pattern.  To do
 147   // this we need to match the structure as well as the types.  To do the type
 148   // matching, we want to figure out the fewest number of type checks we need to
 149   // emit.  For example, if there is only one integer type supported by a
 150   // target, there should be no type comparisons at all for integer patterns!
 151   //
 152   // To figure out the fewest number of type checks needed, clone the pattern,
 153   // remove the types, then perform type inference on the pattern as a whole.
 154   // If there are unresolved types, emit an explicit check for those types,
 155   // apply the type to the tree, then rerun type inference.  Iterate until all
 156   // types are resolved.
 157   //
 158   PatWithNoTypes = Pattern.getSrcPattern()->clone();
 159   PatWithNoTypes->RemoveAllTypes();
 160
 161   // If there are types that are manifestly known, infer them.
 162   InferPossibleTypes();
 163 }
 164
 165 /// InferPossibleTypes - As we emit the pattern, we end up generating type
 166 /// checks and applying them to the 'PatWithNoTypes' tree.  As we do this, we
 167 /// want to propagate implied types as far throughout the tree as possible so
 168 /// that we avoid doing redundant type checks.  This does the type propagation.
 169 void MatcherGen::InferPossibleTypes() {
 170   // TP - Get *SOME* tree pattern, we don't care which.  It is only used for
 171   // diagnostics, which we know are impossible at this point.
 172   TreePattern &TP = *CGP.pf_begin()->second;
 173
 174   try {
 175     bool MadeChange = true;
 176     while (MadeChange)
 177       MadeChange = PatWithNoTypes->ApplyTypeConstraints(TP,
 178                                                 true/*Ignore reg constraints*/);
 179   } catch (...) {
 180     errs() << "Type constraint application shouldn't fail!";
 181     abort();
 182   }
 183 }
 184
 185
 186 /// AddMatcher - Add a matcher node to the current graph we're building.
 187 void MatcherGen::AddMatcher(Matcher *NewNode) {
 188   if (CurPredicate != 0)
 189     CurPredicate->setNext(NewNode);
 190   else
 191     TheMatcher = NewNode;
 192   CurPredicate = NewNode;
 193 }
 194
 195
 196 //===----------------------------------------------------------------------===//
 197 // Pattern Match Generation
 198 //===----------------------------------------------------------------------===//
 199
 200 /// EmitLeafMatchCode - Generate matching code for leaf nodes.
 201 void MatcherGen::EmitLeafMatchCode(const TreePatternNode *N) {
 202   assert(N->isLeaf() && "Not a leaf?");
 203
 204   // Direct match against an integer constant.
 205   if (IntInit *II = dynamic_cast<IntInit*>(N->getLeafValue())) {
 206     // If this is the root of the dag we're matching, we emit a redundant opcode
 207     // check to ensure that this gets folded into the normal top-level
 208     // OpcodeSwitch.
 209     if (N == Pattern.getSrcPattern()) {
 210       const SDNodeInfo &NI = CGP.getSDNodeInfo(CGP.getSDNodeNamed("imm"));
 211       AddMatcher(new CheckOpcodeMatcher(NI));
 212     }
 213
 214     return AddMatcher(new CheckIntegerMatcher(II->getValue()));
 215   }
 216
 217   DefInit *DI = dynamic_cast<DefInit*>(N->getLeafValue());
 218   if (DI == 0) {
 219     errs() << "Unknown leaf kind: " << *DI << "\n";
 220     abort();
 221   }
 222
 223   Record *LeafRec = DI->getDef();
 224   if (// Handle register references.  Nothing to do here, they always match.
 225       LeafRec->isSubClassOf("RegisterClass") ||
 226       LeafRec->isSubClassOf("PointerLikeRegClass") ||
 227       // Place holder for SRCVALUE nodes. Nothing to do here.
 228       LeafRec->getName() == "srcvalue")
 229     return;
 230
 231   // If we have a physreg reference like (mul gpr:$src, EAX) then we need to
 232   // record the register
 233   if (LeafRec->isSubClassOf("Register")) {
 234     AddMatcher(new RecordMatcher("physreg input "+LeafRec->getName(),
 235                                  NextRecordedOperandNo));
 236     PhysRegInputs.push_back(std::make_pair(LeafRec, NextRecordedOperandNo++));
 237     return;
 238   }
 239
 240   if (LeafRec->isSubClassOf("ValueType"))
 241     return AddMatcher(new CheckValueTypeMatcher(LeafRec->getName()));
 242
 243   if (LeafRec->isSubClassOf("CondCode"))
 244     return AddMatcher(new CheckCondCodeMatcher(LeafRec->getName()));
 245
 246   if (LeafRec->isSubClassOf("ComplexPattern")) {
 247     // We can't model ComplexPattern uses that don't have their name taken yet.
 248     // The OPC_CheckComplexPattern operation implicitly records the results.
 249     if (N->getName().empty()) {
 250       errs() << "We expect complex pattern uses to have names: " << *N << "\n";
 251       exit(1);
 252     }
 253
 254     // Remember this ComplexPattern so that we can emit it after all the other
 255     // structural matches are done.
 256     MatchedComplexPatterns.push_back(std::make_pair(N, 0));
 257     return;
 258   }
 259
 260   errs() << "Unknown leaf kind: " << *N << "\n";
 261   abort();
 262 }
 263
 264 void MatcherGen::EmitOperatorMatchCode(const TreePatternNode *N,
 265                                        TreePatternNode *NodeNoTypes) {
 266   assert(!N->isLeaf() && "Not an operator?");
 267   const SDNodeInfo &CInfo = CGP.getSDNodeInfo(N->getOperator());
 268
 269   // If this is an 'and R, 1234' where the operation is AND/OR and the RHS is
 270   // a constant without a predicate fn that has more that one bit set, handle
 271   // this as a special case.  This is usually for targets that have special
 272   // handling of certain large constants (e.g. alpha with it's 8/16/32-bit
 273   // handling stuff).  Using these instructions is often far more efficient
 274   // than materializing the constant.  Unfortunately, both the instcombiner
 275   // and the dag combiner can often infer that bits are dead, and thus drop
 276   // them from the mask in the dag.  For example, it might turn 'AND X, 255'
 277   // into 'AND X, 254' if it knows the low bit is set.  Emit code that checks
 278   // to handle this.
 279   if ((N->getOperator()->getName() == "and" ||
 280        N->getOperator()->getName() == "or") &&
 281       N->getChild(1)->isLeaf() && N->getChild(1)->getPredicateFns().empty() &&
 282       N->getPredicateFns().empty()) {
 283     if (IntInit *II = dynamic_cast<IntInit*>(N->getChild(1)->getLeafValue())) {
 284       if (!isPowerOf2_32(II->getValue())) {  // Don't bother with single bits.
 285         // If this is at the root of the pattern, we emit a redundant
 286         // CheckOpcode so that the following checks get factored properly under
 287         // a single opcode check.
 288         if (N == Pattern.getSrcPattern())
 289           AddMatcher(new CheckOpcodeMatcher(CInfo));
 290
 291         // Emit the CheckAndImm/CheckOrImm node.
 292         if (N->getOperator()->getName() == "and")
 293           AddMatcher(new CheckAndImmMatcher(II->getValue()));
 294         else
 295           AddMatcher(new CheckOrImmMatcher(II->getValue()));
 296
 297         // Match the LHS of the AND as appropriate.
 298         AddMatcher(new MoveChildMatcher(0));
 299         EmitMatchCode(N->getChild(0), NodeNoTypes->getChild(0));
 300         AddMatcher(new MoveParentMatcher());
 301         return;
 302       }
 303     }
 304   }
 305
 306   // Check that the current opcode lines up.
 307   AddMatcher(new CheckOpcodeMatcher(CInfo));
 308
 309   // If this node has memory references (i.e. is a load or store), tell the
 310   // interpreter to capture them in the memref array.
 311   if (N->NodeHasProperty(SDNPMemOperand, CGP))
 312     AddMatcher(new RecordMemRefMatcher());
 313
 314   // If this node has a chain, then the chain is operand #0 is the SDNode, and
 315   // the child numbers of the node are all offset by one.
 316   unsigned OpNo = 0;
 317   if (N->NodeHasProperty(SDNPHasChain, CGP)) {
 318     // Record the node and remember it in our chained nodes list.
 319     AddMatcher(new RecordMatcher("'" + N->getOperator()->getName() +
 320                                          "' chained node",
 321                                  NextRecordedOperandNo));
 322     // Remember all of the input chains our pattern will match.
 323     MatchedChainNodes.push_back(NextRecordedOperandNo++);
 324
 325     // Don't look at the input chain when matching the tree pattern to the
 326     // SDNode.
 327     OpNo = 1;
 328
 329     // If this node is not the root and the subtree underneath it produces a
 330     // chain, then the result of matching the node is also produce a chain.
 331     // Beyond that, this means that we're also folding (at least) the root node
 332     // into the node that produce the chain (for example, matching
 333     // "(add reg, (load ptr))" as a add_with_memory on X86).  This is
 334     // problematic, if the 'reg' node also uses the load (say, its chain).
 335     // Graphically:
 336     //
 337     //         [LD]
 338     //         ^  ^
 339     //         |  \                              DAG's like cheese.
 340     //        /    |
 341     //       /    [YY]
 342     //       |     ^
 343     //      [XX]--/
 344     //
 345     // It would be invalid to fold XX and LD.  In this case, folding the two
 346     // nodes together would induce a cycle in the DAG, making it a 'cyclic DAG'
 347     // To prevent this, we emit a dynamic check for legality before allowing
 348     // this to be folded.
 349     //
 350     const TreePatternNode *Root = Pattern.getSrcPattern();
 351     if (N != Root) {                             // Not the root of the pattern.
 352       // If there is a node between the root and this node, then we definitely
 353       // need to emit the check.
 354       bool NeedCheck = !Root->hasChild(N);
 355
 356       // If it *is* an immediate child of the root, we can still need a check if
 357       // the root SDNode has multiple inputs.  For us, this means that it is an
 358       // intrinsic, has multiple operands, or has other inputs like chain or
 359       // flag).
 360       if (!NeedCheck) {
 361         const SDNodeInfo &PInfo = CGP.getSDNodeInfo(Root->getOperator());
 362         NeedCheck =
 363           Root->getOperator() == CGP.get_intrinsic_void_sdnode() ||
 364           Root->getOperator() == CGP.get_intrinsic_w_chain_sdnode() ||
 365           Root->getOperator() == CGP.get_intrinsic_wo_chain_sdnode() ||
 366           PInfo.getNumOperands() > 1 ||
 367           PInfo.hasProperty(SDNPHasChain) ||
 368           PInfo.hasProperty(SDNPInFlag) ||
 369           PInfo.hasProperty(SDNPOptInFlag);
 370       }
 371
 372       if (NeedCheck)
 373         AddMatcher(new CheckFoldableChainNodeMatcher());
 374     }
 375   }
 376
 377   // If this node has an output flag and isn't the root, remember it.
 378   if (N->NodeHasProperty(SDNPOutFlag, CGP) &&
 379       N != Pattern.getSrcPattern()) {
 380     // TODO: This redundantly records nodes with both flags and chains.
 381
 382     // Record the node and remember it in our chained nodes list.
 383     AddMatcher(new RecordMatcher("'" + N->getOperator()->getName() +
 384                                          "' flag output node",
 385                                  NextRecordedOperandNo));
 386     // Remember all of the nodes with output flags our pattern will match.
 387     MatchedFlagResultNodes.push_back(NextRecordedOperandNo++);
 388   }
 389
 390   // If this node is known to have an input flag or if it *might* have an input
 391   // flag, capture it as the flag input of the pattern.
 392   if (N->NodeHasProperty(SDNPOptInFlag, CGP) ||
 393       N->NodeHasProperty(SDNPInFlag, CGP))
 394     AddMatcher(new CaptureFlagInputMatcher());
 395
 396   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i, ++OpNo) {
 397     // Get the code suitable for matching this child.  Move to the child, check
 398     // it then move back to the parent.
 399     AddMatcher(new MoveChildMatcher(OpNo));
 400     EmitMatchCode(N->getChild(i), NodeNoTypes->getChild(i));
 401     AddMatcher(new MoveParentMatcher());
 402   }
 403 }
 404
 405
 406 void MatcherGen::EmitMatchCode(const TreePatternNode *N,
 407                                TreePatternNode *NodeNoTypes) {
 408   // If N and NodeNoTypes don't agree on a type, then this is a case where we
 409   // need to do a type check.  Emit the check, apply the tyep to NodeNoTypes and
 410   // reinfer any correlated types.
 411   bool DoTypeCheck = false;
 412   if (NodeNoTypes->getNumTypes() != 0 &&
 413       NodeNoTypes->getExtType(0) != N->getExtType(0)) {
 414     assert(NodeNoTypes->getNumTypes() == 1 && "FIXME: Handle multiple results");
 415     NodeNoTypes->setType(0, N->getExtType(0));
 416     InferPossibleTypes();
 417     DoTypeCheck = true;
 418   }
 419
 420   // If this node has a name associated with it, capture it in VariableMap. If
 421   // we already saw this in the pattern, emit code to verify dagness.
 422   if (!N->getName().empty()) {
 423     unsigned &VarMapEntry = VariableMap[N->getName()];
 424     if (VarMapEntry == 0) {
 425       // If it is a named node, we must emit a 'Record' opcode.
 426       AddMatcher(new RecordMatcher("$" + N->getName(), NextRecordedOperandNo));
 427       VarMapEntry = ++NextRecordedOperandNo;
 428     } else {
 429       // If we get here, this is a second reference to a specific name.  Since
 430       // we already have checked that the first reference is valid, we don't
 431       // have to recursively match it, just check that it's the same as the
 432       // previously named thing.
 433       AddMatcher(new CheckSameMatcher(VarMapEntry-1));
 434       return;
 435     }
 436   }
 437
 438   if (N->isLeaf())
 439     EmitLeafMatchCode(N);
 440   else
 441     EmitOperatorMatchCode(N, NodeNoTypes);
 442
 443   // If there are node predicates for this node, generate their checks.
 444   for (unsigned i = 0, e = N->getPredicateFns().size(); i != e; ++i)
 445     AddMatcher(new CheckPredicateMatcher(N->getPredicateFns()[i]));
 446
 447   if (DoTypeCheck) {
 448     assert(N->getNumTypes() == 1);
 449     AddMatcher(new CheckTypeMatcher(N->getType(0)));
 450   }
 451 }
 452
 453 /// EmitMatcherCode - Generate the code that matches the predicate of this
 454 /// pattern for the specified Variant.  If the variant is invalid this returns
 455 /// true and does not generate code, if it is valid, it returns false.
 456 bool MatcherGen::EmitMatcherCode(unsigned Variant) {
 457   // If the root of the pattern is a ComplexPattern and if it is specified to
 458   // match some number of root opcodes, these are considered to be our variants.
 459   // Depending on which variant we're generating code for, emit the root opcode
 460   // check.
 461   if (const ComplexPattern *CP =
 462                    Pattern.getSrcPattern()->getComplexPatternInfo(CGP)) {
 463     const std::vector<Record*> &OpNodes = CP->getRootNodes();
 464     assert(!OpNodes.empty() &&"Complex Pattern must specify what it can match");
 465     if (Variant >= OpNodes.size()) return true;
 466
 467     AddMatcher(new CheckOpcodeMatcher(CGP.getSDNodeInfo(OpNodes[Variant])));
 468   } else {
 469     if (Variant != 0) return true;
 470   }
 471
 472   // Emit the matcher for the pattern structure and types.
 473   EmitMatchCode(Pattern.getSrcPattern(), PatWithNoTypes);
 474
 475   // If the pattern has a predicate on it (e.g. only enabled when a subtarget
 476   // feature is around, do the check).
 477   if (!Pattern.getPredicateCheck().empty())
 478     AddMatcher(new CheckPatternPredicateMatcher(Pattern.getPredicateCheck()));
 479
 480   // Now that we've completed the structural type match, emit any ComplexPattern
 481   // checks (e.g. addrmode matches).  We emit this after the structural match
 482   // because they are generally more expensive to evaluate and more difficult to
 483   // factor.
 484   for (unsigned i = 0, e = MatchedComplexPatterns.size(); i != e; ++i) {
 485     const TreePatternNode *N = MatchedComplexPatterns[i].first;
 486
 487     // Remember where the results of this match get stuck.
 488     MatchedComplexPatterns[i].second = NextRecordedOperandNo;
 489
 490     // Get the slot we recorded the value in from the name on the node.
 491     unsigned RecNodeEntry = VariableMap[N->getName()];
 492     assert(!N->getName().empty() && RecNodeEntry &&
 493            "Complex pattern should have a name and slot");
 494     --RecNodeEntry;  // Entries in VariableMap are biased.
 495
 496     const ComplexPattern &CP =
 497       CGP.getComplexPattern(((DefInit*)N->getLeafValue())->getDef());
 498
 499     // Emit a CheckComplexPat operation, which does the match (aborting if it
 500     // fails) and pushes the matched operands onto the recorded nodes list.
 501     AddMatcher(new CheckComplexPatMatcher(CP, RecNodeEntry,
 502                                           N->getName(), NextRecordedOperandNo));
 503
 504     // Record the right number of operands.
 505     NextRecordedOperandNo += CP.getNumOperands();
 506     if (CP.hasProperty(SDNPHasChain)) {
 507       // If the complex pattern has a chain, then we need to keep track of the
 508       // fact that we just recorded a chain input.  The chain input will be
 509       // matched as the last operand of the predicate if it was successful.
 510       ++NextRecordedOperandNo; // Chained node operand.
 511
 512       // It is the last operand recorded.
 513       assert(NextRecordedOperandNo > 1 &&
 514              "Should have recorded input/result chains at least!");
 515       MatchedChainNodes.push_back(NextRecordedOperandNo-1);
 516     }
 517
 518     // TODO: Complex patterns can't have output flags, if they did, we'd want
 519     // to record them.
 520   }
 521
 522   return false;
 523 }
 524
 525
 526 //===----------------------------------------------------------------------===//
 527 // Node Result Generation
 528 //===----------------------------------------------------------------------===//
 529
 530 void MatcherGen::EmitResultOfNamedOperand(const TreePatternNode *N,
 531                                           SmallVectorImpl<unsigned> &ResultOps){
 532   assert(!N->getName().empty() && "Operand not named!");
 533
 534   // A reference to a complex pattern gets all of the results of the complex
 535   // pattern's match.
 536   if (const ComplexPattern *CP = N->getComplexPatternInfo(CGP)) {
 537     unsigned SlotNo = 0;
 538     for (unsigned i = 0, e = MatchedComplexPatterns.size(); i != e; ++i)
 539       if (MatchedComplexPatterns[i].first->getName() == N->getName()) {
 540         SlotNo = MatchedComplexPatterns[i].second;
 541         break;
 542       }
 543     assert(SlotNo != 0 && "Didn't get a slot number assigned?");
 544
 545     // The first slot entry is the node itself, the subsequent entries are the
 546     // matched values.
 547     for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
 548       ResultOps.push_back(SlotNo+i);
 549     return;
 550   }
 551
 552   unsigned SlotNo = getNamedArgumentSlot(N->getName());
 553
 554   // If this is an 'imm' or 'fpimm' node, make sure to convert it to the target
 555   // version of the immediate so that it doesn't get selected due to some other
 556   // node use.
 557   if (!N->isLeaf()) {
 558     StringRef OperatorName = N->getOperator()->getName();
 559     if (OperatorName == "imm" || OperatorName == "fpimm") {
 560       AddMatcher(new EmitConvertToTargetMatcher(SlotNo));
 561       ResultOps.push_back(NextRecordedOperandNo++);
 562       return;
 563     }
 564   }
 565
 566   ResultOps.push_back(SlotNo);
 567 }
 568
 569 void MatcherGen::EmitResultLeafAsOperand(const TreePatternNode *N,
 570                                          SmallVectorImpl<unsigned> &ResultOps) {
 571   assert(N->isLeaf() && "Must be a leaf");
 572
 573   if (IntInit *II = dynamic_cast<IntInit*>(N->getLeafValue())) {
 574     AddMatcher(new EmitIntegerMatcher(II->getValue(), N->getType(0)));
 575     ResultOps.push_back(NextRecordedOperandNo++);
 576     return;
 577   }
 578
 579   // If this is an explicit register reference, handle it.
 580   if (DefInit *DI = dynamic_cast<DefInit*>(N->getLeafValue())) {
 581     if (DI->getDef()->isSubClassOf("Register")) {
 582       AddMatcher(new EmitRegisterMatcher(DI->getDef(), N->getType(0)));
 583       ResultOps.push_back(NextRecordedOperandNo++);
 584       return;
 585     }
 586
 587     if (DI->getDef()->getName() == "zero_reg") {
 588       AddMatcher(new EmitRegisterMatcher(0, N->getType(0)));
 589       ResultOps.push_back(NextRecordedOperandNo++);
 590       return;
 591     }
 592
 593     // Handle a reference to a register class. This is used
 594     // in COPY_TO_SUBREG instructions.
 595     if (DI->getDef()->isSubClassOf("RegisterClass")) {
 596       std::string Value = getQualifiedName(DI->getDef()) + "RegClassID";
 597       AddMatcher(new EmitStringIntegerMatcher(Value, MVT::i32));
 598       ResultOps.push_back(NextRecordedOperandNo++);
 599       return;
 600     }
 601   }
 602
 603   errs() << "unhandled leaf node: \n";
 604   N->dump();
 605 }
 606
 607 /// GetInstPatternNode - Get the pattern for an instruction.
 608 ///
 609 const TreePatternNode *MatcherGen::
 610 GetInstPatternNode(const DAGInstruction &Inst, const TreePatternNode *N) {
 611   const TreePattern *InstPat = Inst.getPattern();
 612
 613   // FIXME2?: Assume actual pattern comes before "implicit".
 614   TreePatternNode *InstPatNode;
 615   if (InstPat)
 616     InstPatNode = InstPat->getTree(0);
 617   else if (/*isRoot*/ N == Pattern.getDstPattern())
 618     InstPatNode = Pattern.getSrcPattern();
 619   else
 620     return 0;
 621
 622   if (InstPatNode && !InstPatNode->isLeaf() &&
 623       InstPatNode->getOperator()->getName() == "set")
 624     InstPatNode = InstPatNode->getChild(InstPatNode->getNumChildren()-1);
 625
 626   return InstPatNode;
 627 }
 628
 629 void MatcherGen::
 630 EmitResultInstructionAsOperand(const TreePatternNode *N,
 631                                SmallVectorImpl<unsigned> &OutputOps) {
 632   Record *Op = N->getOperator();
 633   const CodeGenTarget &CGT = CGP.getTargetInfo();
 634   CodeGenInstruction &II = CGT.getInstruction(Op);
 635   const DAGInstruction &Inst = CGP.getInstruction(Op);
 636
 637   // If we can, get the pattern for the instruction we're generating.  We derive
 638   // a variety of information from this pattern, such as whether it has a chain.
 639   //
 640   // FIXME2: This is extremely dubious for several reasons, not the least of
 641   // which it gives special status to instructions with patterns that Pat<>
 642   // nodes can't duplicate.
 643   const TreePatternNode *InstPatNode = GetInstPatternNode(Inst, N);
 644
 645   // NodeHasChain - Whether the instruction node we're creating takes chains.
 646   bool NodeHasChain = InstPatNode &&
 647                       InstPatNode->TreeHasProperty(SDNPHasChain, CGP);
 648
 649   bool isRoot = N == Pattern.getDstPattern();
 650
 651   // TreeHasOutFlag - True if this tree has a flag.
 652   bool TreeHasInFlag = false, TreeHasOutFlag = false;
 653   if (isRoot) {
 654     const TreePatternNode *SrcPat = Pattern.getSrcPattern();
 655     TreeHasInFlag = SrcPat->TreeHasProperty(SDNPOptInFlag, CGP) ||
 656                     SrcPat->TreeHasProperty(SDNPInFlag, CGP);
 657
 658     // FIXME2: this is checking the entire pattern, not just the node in
 659     // question, doing this just for the root seems like a total hack.
 660     TreeHasOutFlag = SrcPat->TreeHasProperty(SDNPOutFlag, CGP);
 661   }
 662
 663   // NumResults - This is the number of results produced by the instruction in
 664   // the "outs" list.
 665   unsigned NumResults = Inst.getNumResults();
 666
 667   // Loop over all of the operands of the instruction pattern, emitting code
 668   // to fill them all in.  The node 'N' usually has number children equal to
 669   // the number of input operands of the instruction.  However, in cases
 670   // where there are predicate operands for an instruction, we need to fill
 671   // in the 'execute always' values.  Match up the node operands to the
 672   // instruction operands to do this.
 673   SmallVector<unsigned, 8> InstOps;
 674   for (unsigned ChildNo = 0, InstOpNo = NumResults, e = II.OperandList.size();
 675        InstOpNo != e; ++InstOpNo) {
 676
 677     // Determine what to emit for this operand.
 678     Record *OperandNode = II.OperandList[InstOpNo].Rec;
 679     if ((OperandNode->isSubClassOf("PredicateOperand") ||
 680          OperandNode->isSubClassOf("OptionalDefOperand")) &&
 681         !CGP.getDefaultOperand(OperandNode).DefaultOps.empty()) {
 682       // This is a predicate or optional def operand; emit the
 683       // 'default ops' operands.
 684       const DAGDefaultOperand &DefaultOp =
 685         CGP.getDefaultOperand(II.OperandList[InstOpNo].Rec);
 686       for (unsigned i = 0, e = DefaultOp.DefaultOps.size(); i != e; ++i)
 687         EmitResultOperand(DefaultOp.DefaultOps[i], InstOps);
 688       continue;
 689     }
 690
 691     // Otherwise this is a normal operand or a predicate operand without
 692     // 'execute always'; emit it.
 693     EmitResultOperand(N->getChild(ChildNo), InstOps);
 694     ++ChildNo;
 695   }
 696
 697   // If this node has an input flag or explicitly specified input physregs, we
 698   // need to add chained and flagged copyfromreg nodes and materialize the flag
 699   // input.
 700   if (isRoot && !PhysRegInputs.empty()) {
 701     // Emit all of the CopyToReg nodes for the input physical registers.  These
 702     // occur in patterns like (mul:i8 AL:i8, GR8:i8:$src).
 703     for (unsigned i = 0, e = PhysRegInputs.size(); i != e; ++i)
 704       AddMatcher(new EmitCopyToRegMatcher(PhysRegInputs[i].second,
 705                                           PhysRegInputs[i].first));
 706     // Even if the node has no other flag inputs, the resultant node must be
 707     // flagged to the CopyFromReg nodes we just generated.
 708     TreeHasInFlag = true;
 709   }
 710
 711   // Result order: node results, chain, flags
 712
 713   // Determine the result types.
 714   SmallVector<MVT::SimpleValueType, 4> ResultVTs;
 715   if (N->getNumTypes()) {
 716     // FIXME2: If the node has multiple results, we should add them.  For now,
 717     // preserve existing behavior?!
 718     assert(N->getNumTypes() == 1);
 719     ResultVTs.push_back(N->getType(0));
 720   }
 721
 722   // If this is the root instruction of a pattern that has physical registers in
 723   // its result pattern, add output VTs for them.  For example, X86 has:
 724   //   (set AL, (mul ...))
 725   // This also handles implicit results like:
 726   //   (implicit EFLAGS)
 727   if (isRoot && Pattern.getDstRegs().size() != 0) {
 728     // If the root came from an implicit def in the instruction handling stuff,
 729     // don't re-add it.
 730     Record *HandledReg = 0;
 731     if (NumResults == 0 && N->getNumTypes() != 0 &&
 732         !II.ImplicitDefs.empty())
 733       HandledReg = II.ImplicitDefs[0];
 734
 735     for (unsigned i = 0; i != Pattern.getDstRegs().size(); ++i) {
 736       Record *Reg = Pattern.getDstRegs()[i];
 737       if (!Reg->isSubClassOf("Register") || Reg == HandledReg) continue;
 738       ResultVTs.push_back(getRegisterValueType(Reg, CGT));
 739     }
 740   }
 741
 742   // If this is the root of the pattern and the pattern we're matching includes
 743   // a node that is variadic, mark the generated node as variadic so that it
 744   // gets the excess operands from the input DAG.
 745   int NumFixedArityOperands = -1;
 746   if (isRoot &&
 747       (Pattern.getSrcPattern()->NodeHasProperty(SDNPVariadic, CGP)))
 748     NumFixedArityOperands = Pattern.getSrcPattern()->getNumChildren();
 749
 750   // If this is the root node and any of the nodes matched nodes in the input
 751   // pattern have MemRefs in them, have the interpreter collect them and plop
 752   // them onto this node.
 753   //
 754   // FIXME3: This is actively incorrect for result patterns where the root of
 755   // the pattern is not the memory reference and is also incorrect when the
 756   // result pattern has multiple memory-referencing instructions.  For example,
 757   // in the X86 backend, this pattern causes the memrefs to get attached to the
 758   // CVTSS2SDrr instead of the MOVSSrm:
 759   //
 760   //  def : Pat<(extloadf32 addr:$src),
 761   //            (CVTSS2SDrr (MOVSSrm addr:$src))>;
 762   //
 763   bool NodeHasMemRefs =
 764     isRoot && Pattern.getSrcPattern()->TreeHasProperty(SDNPMemOperand, CGP);
 765
 766   AddMatcher(new EmitNodeMatcher(II.Namespace+"::"+II.TheDef->getName(),
 767                                  ResultVTs.data(), ResultVTs.size(),
 768                                  InstOps.data(), InstOps.size(),
 769                                  NodeHasChain, TreeHasInFlag, TreeHasOutFlag,
 770                                  NodeHasMemRefs, NumFixedArityOperands,
 771                                  NextRecordedOperandNo));
 772
 773   // The non-chain and non-flag results of the newly emitted node get recorded.
 774   for (unsigned i = 0, e = ResultVTs.size(); i != e; ++i) {
 775     if (ResultVTs[i] == MVT::Other || ResultVTs[i] == MVT::Flag) break;
 776     OutputOps.push_back(NextRecordedOperandNo++);
 777   }
 778 }
 779
 780 void MatcherGen::
 781 EmitResultSDNodeXFormAsOperand(const TreePatternNode *N,
 782                                SmallVectorImpl<unsigned> &ResultOps) {
 783   assert(N->getOperator()->isSubClassOf("SDNodeXForm") && "Not SDNodeXForm?");
 784
 785   // Emit the operand.
 786   SmallVector<unsigned, 8> InputOps;
 787
 788   // FIXME2: Could easily generalize this to support multiple inputs and outputs
 789   // to the SDNodeXForm.  For now we just support one input and one output like
 790   // the old instruction selector.
 791   assert(N->getNumChildren() == 1);
 792   EmitResultOperand(N->getChild(0), InputOps);
 793
 794   // The input currently must have produced exactly one result.
 795   assert(InputOps.size() == 1 && "Unexpected input to SDNodeXForm");
 796
 797   AddMatcher(new EmitNodeXFormMatcher(InputOps[0], N->getOperator()));
 798   ResultOps.push_back(NextRecordedOperandNo++);
 799 }
 800
 801 void MatcherGen::EmitResultOperand(const TreePatternNode *N,
 802                                    SmallVectorImpl<unsigned> &ResultOps) {
 803   // This is something selected from the pattern we matched.
 804   if (!N->getName().empty())
 805     return EmitResultOfNamedOperand(N, ResultOps);
 806
 807   if (N->isLeaf())
 808     return EmitResultLeafAsOperand(N, ResultOps);
 809
 810   Record *OpRec = N->getOperator();
 811   if (OpRec->isSubClassOf("Instruction"))
 812     return EmitResultInstructionAsOperand(N, ResultOps);
 813   if (OpRec->isSubClassOf("SDNodeXForm"))
 814     return EmitResultSDNodeXFormAsOperand(N, ResultOps);
 815   errs() << "Unknown result node to emit code for: " << *N << '\n';
 816   throw std::string("Unknown node in result pattern!");
 817 }
 818
 819 void MatcherGen::EmitResultCode() {
 820   // Patterns that match nodes with (potentially multiple) chain inputs have to
 821   // merge them together into a token factor.  This informs the generated code
 822   // what all the chained nodes are.
 823   if (!MatchedChainNodes.empty())
 824     AddMatcher(new EmitMergeInputChainsMatcher
 825                (MatchedChainNodes.data(), MatchedChainNodes.size()));
 826
 827   // Codegen the root of the result pattern, capturing the resulting values.
 828   SmallVector<unsigned, 8> Ops;
 829   EmitResultOperand(Pattern.getDstPattern(), Ops);
 830
 831   // At this point, we have however many values the result pattern produces.
 832   // However, the input pattern might not need all of these.  If there are
 833   // excess values at the end (such as condition codes etc) just lop them off.
 834   // This doesn't need to worry about flags or chains, just explicit results.
 835   //
 836   // FIXME2: This doesn't work because there is currently no way to get an
 837   // accurate count of the # results the source pattern sets.  This is because
 838   // of the "parallel" construct in X86 land, which looks like this:
 839   //
 840   //def : Pat<(parallel (X86and_flag GR8:$src1, GR8:$src2),
 841   //           (implicit EFLAGS)),
 842   //  (AND8rr GR8:$src1, GR8:$src2)>;
 843   //
 844   // This idiom means to match the two-result node X86and_flag (which is
 845   // declared as returning a single result, because we can't match multi-result
 846   // nodes yet).  In this case, we would have to know that the input has two
 847   // results.  However, mul8r is modelled exactly the same way, but without
 848   // implicit defs included.  The fix is to support multiple results directly
 849   // and eliminate 'parallel'.
 850   //
 851   // FIXME2: When this is fixed, we should revert the terrible hack in the
 852   // OPC_EmitNode code in the interpreter.
 853 #if 0
 854   const TreePatternNode *Src = Pattern.getSrcPattern();
 855   unsigned NumSrcResults = Src->getTypeNum(0) != MVT::isVoid ? 1 : 0;
 856   NumSrcResults += Pattern.getDstRegs().size();
 857   assert(Ops.size() >= NumSrcResults && "Didn't provide enough results");
 858   Ops.resize(NumSrcResults);
 859 #endif
 860
 861   // If the matched pattern covers nodes which define a flag result, emit a node
 862   // that tells the matcher about them so that it can update their results.
 863   if (!MatchedFlagResultNodes.empty())
 864     AddMatcher(new MarkFlagResultsMatcher(MatchedFlagResultNodes.data(),
 865                                           MatchedFlagResultNodes.size()));
 866
 867   AddMatcher(new CompleteMatchMatcher(Ops.data(), Ops.size(), Pattern));
 868 }
 869
 870
 871 /// ConvertPatternToMatcher - Create the matcher for the specified pattern with
 872 /// the specified variant.  If the variant number is invalid, this returns null.
 873 Matcher *llvm::ConvertPatternToMatcher(const PatternToMatch &Pattern,
 874                                        unsigned Variant,
 875                                        const CodeGenDAGPatterns &CGP) {
 876   MatcherGen Gen(Pattern, CGP);
 877
 878   // Generate the code for the matcher.
 879   if (Gen.EmitMatcherCode(Variant))
 880     return 0;
 881
 882   // FIXME2: Kill extra MoveParent commands at the end of the matcher sequence.
 883   // FIXME2: Split result code out to another table, and make the matcher end
 884   // with an "Emit <index>" command.  This allows result generation stuff to be
 885   // shared and factored?
 886
 887   // If the match succeeds, then we generate Pattern.
 888   Gen.EmitResultCode();
 889
 890   // Unconditional match.
 891   return Gen.GetMatcher();
 892 }
 893
 894
 895