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     // In multiple RC's.  If the Types of the RC's do not agree, return
  41     // MVT::Other. The target is responsible for handling this.
  42     if (VT != RC.getValueTypeNum(0))
  43       // FIXME2: when does this happen?  Abort?
  44       return MVT::Other;
  45   }
  46   return VT;
  47 }
  48
  49
  50 namespace {
  51   class MatcherGen {
  52     const PatternToMatch &Pattern;
  53     const CodeGenDAGPatterns &CGP;
  54
  55     /// PatWithNoTypes - This is a clone of Pattern.getSrcPattern() that starts
  56     /// out with all of the types removed.  This allows us to insert type checks
  57     /// as we scan the tree.
  58     TreePatternNode *PatWithNoTypes;
  59
  60     /// VariableMap - A map from variable names ('$dst') to the recorded operand
  61     /// number that they were captured as.  These are biased by 1 to make
  62     /// insertion easier.
  63     StringMap<unsigned> VariableMap;
  64
  65     /// NextRecordedOperandNo - As we emit opcodes to record matched values in
  66     /// the RecordedNodes array, this keeps track of which slot will be next to
  67     /// record into.
  68     unsigned NextRecordedOperandNo;
  69
  70     /// MatchedChainNodes - This maintains the position in the recorded nodes
  71     /// array of all of the recorded input nodes that have chains.
  72     SmallVector<unsigned, 2> MatchedChainNodes;
  73
  74     /// PhysRegInputs - List list has an entry for each explicitly specified
  75     /// physreg input to the pattern.  The first elt is the Register node, the
  76     /// second is the recorded slot number the input pattern match saved it in.
  77     SmallVector<std::pair<Record*, unsigned>, 2> PhysRegInputs;
  78
  79     /// EmittedMergeInputChains - For nodes that match patterns involving
  80     /// chains, is set to true if we emitted the "MergeInputChains" operation.
  81     bool EmittedMergeInputChains;
  82
  83     /// Matcher - This is the top level of the generated matcher, the result.
  84     MatcherNode *Matcher;
  85
  86     /// CurPredicate - As we emit matcher nodes, this points to the latest check
  87     /// which should have future checks stuck into its Next position.
  88     MatcherNode *CurPredicate;
  89   public:
  90     MatcherGen(const PatternToMatch &pattern, const CodeGenDAGPatterns &cgp);
  91
  92     ~MatcherGen() {
  93       delete PatWithNoTypes;
  94     }
  95
  96     void EmitMatcherCode();
  97     void EmitResultCode();
  98
  99     MatcherNode *GetMatcher() const { return Matcher; }
 100     MatcherNode *GetCurPredicate() const { return CurPredicate; }
 101   private:
 102     void AddMatcherNode(MatcherNode *NewNode);
 103     void InferPossibleTypes();
 104
 105     // Matcher Generation.
 106     void EmitMatchCode(const TreePatternNode *N, TreePatternNode *NodeNoTypes);
 107     void EmitLeafMatchCode(const TreePatternNode *N);
 108     void EmitOperatorMatchCode(const TreePatternNode *N,
 109                                TreePatternNode *NodeNoTypes);
 110
 111     // Result Code Generation.
 112     unsigned getNamedArgumentSlot(StringRef Name) {
 113       unsigned VarMapEntry = VariableMap[Name];
 114       assert(VarMapEntry != 0 &&
 115              "Variable referenced but not defined and not caught earlier!");
 116       return VarMapEntry-1;
 117     }
 118
 119     /// GetInstPatternNode - Get the pattern for an instruction.
 120     const TreePatternNode *GetInstPatternNode(const DAGInstruction &Ins,
 121                                               const TreePatternNode *N);
 122
 123     void EmitResultOperand(const TreePatternNode *N,
 124                            SmallVectorImpl<unsigned> &ResultOps);
 125     void EmitResultOfNamedOperand(const TreePatternNode *N,
 126                                   SmallVectorImpl<unsigned> &ResultOps);
 127     void EmitResultLeafAsOperand(const TreePatternNode *N,
 128                                  SmallVectorImpl<unsigned> &ResultOps);
 129     void EmitResultInstructionAsOperand(const TreePatternNode *N,
 130                                         SmallVectorImpl<unsigned> &ResultOps);
 131     void EmitResultSDNodeXFormAsOperand(const TreePatternNode *N,
 132                                         SmallVectorImpl<unsigned> &ResultOps);
 133     };
 134
 135 } // end anon namespace.
 136
 137 MatcherGen::MatcherGen(const PatternToMatch &pattern,
 138                        const CodeGenDAGPatterns &cgp)
 139 : Pattern(pattern), CGP(cgp), NextRecordedOperandNo(0),
 140   EmittedMergeInputChains(false), Matcher(0), CurPredicate(0) {
 141   // We need to produce the matcher tree for the patterns source pattern.  To do
 142   // this we need to match the structure as well as the types.  To do the type
 143   // matching, we want to figure out the fewest number of type checks we need to
 144   // emit.  For example, if there is only one integer type supported by a
 145   // target, there should be no type comparisons at all for integer patterns!
 146   //
 147   // To figure out the fewest number of type checks needed, clone the pattern,
 148   // remove the types, then perform type inference on the pattern as a whole.
 149   // If there are unresolved types, emit an explicit check for those types,
 150   // apply the type to the tree, then rerun type inference.  Iterate until all
 151   // types are resolved.
 152   //
 153   PatWithNoTypes = Pattern.getSrcPattern()->clone();
 154   PatWithNoTypes->RemoveAllTypes();
 155
 156   // If there are types that are manifestly known, infer them.
 157   InferPossibleTypes();
 158 }
 159
 160 /// InferPossibleTypes - As we emit the pattern, we end up generating type
 161 /// checks and applying them to the 'PatWithNoTypes' tree.  As we do this, we
 162 /// want to propagate implied types as far throughout the tree as possible so
 163 /// that we avoid doing redundant type checks.  This does the type propagation.
 164 void MatcherGen::InferPossibleTypes() {
 165   // TP - Get *SOME* tree pattern, we don't care which.  It is only used for
 166   // diagnostics, which we know are impossible at this point.
 167   TreePattern &TP = *CGP.pf_begin()->second;
 168
 169   try {
 170     bool MadeChange = true;
 171     while (MadeChange)
 172       MadeChange = PatWithNoTypes->ApplyTypeConstraints(TP,
 173                                                 true/*Ignore reg constraints*/);
 174   } catch (...) {
 175     errs() << "Type constraint application shouldn't fail!";
 176     abort();
 177   }
 178 }
 179
 180
 181 /// AddMatcherNode - Add a matcher node to the current graph we're building.
 182 void MatcherGen::AddMatcherNode(MatcherNode *NewNode) {
 183   if (CurPredicate != 0)
 184     CurPredicate->setNext(NewNode);
 185   else
 186     Matcher = NewNode;
 187   CurPredicate = NewNode;
 188 }
 189
 190
 191 //===----------------------------------------------------------------------===//
 192 // Pattern Match Generation
 193 //===----------------------------------------------------------------------===//
 194
 195 /// EmitLeafMatchCode - Generate matching code for leaf nodes.
 196 void MatcherGen::EmitLeafMatchCode(const TreePatternNode *N) {
 197   assert(N->isLeaf() && "Not a leaf?");
 198
 199   // If there are node predicates for this node, generate their checks.
 200   for (unsigned i = 0, e = N->getPredicateFns().size(); i != e; ++i)
 201     AddMatcherNode(new CheckPredicateMatcherNode(N->getPredicateFns()[i]));
 202
 203   // Direct match against an integer constant.
 204   if (IntInit *II = dynamic_cast<IntInit*>(N->getLeafValue()))
 205     return AddMatcherNode(new CheckIntegerMatcherNode(II->getValue()));
 206
 207   DefInit *DI = dynamic_cast<DefInit*>(N->getLeafValue());
 208   if (DI == 0) {
 209     errs() << "Unknown leaf kind: " << *DI << "\n";
 210     abort();
 211   }
 212
 213   Record *LeafRec = DI->getDef();
 214   if (// Handle register references.  Nothing to do here, they always match.
 215       LeafRec->isSubClassOf("RegisterClass") ||
 216       LeafRec->isSubClassOf("PointerLikeRegClass") ||
 217       // Place holder for SRCVALUE nodes. Nothing to do here.
 218       LeafRec->getName() == "srcvalue")
 219     return;
 220
 221   // If we have a physreg reference like (mul gpr:$src, EAX) then we need to
 222   // record the register
 223   if (LeafRec->isSubClassOf("Register")) {
 224     AddMatcherNode(new RecordMatcherNode("physreg input "+LeafRec->getName()));
 225     PhysRegInputs.push_back(std::make_pair(LeafRec, NextRecordedOperandNo++));
 226     return;
 227   }
 228
 229   if (LeafRec->isSubClassOf("ValueType"))
 230     return AddMatcherNode(new CheckValueTypeMatcherNode(LeafRec->getName()));
 231
 232   if (LeafRec->isSubClassOf("CondCode"))
 233     return AddMatcherNode(new CheckCondCodeMatcherNode(LeafRec->getName()));
 234
 235   if (LeafRec->isSubClassOf("ComplexPattern")) {
 236     // We can't model ComplexPattern uses that don't have their name taken yet.
 237     // The OPC_CheckComplexPattern operation implicitly records the results.
 238     if (N->getName().empty()) {
 239       errs() << "We expect complex pattern uses to have names: " << *N << "\n";
 240       exit(1);
 241     }
 242
 243     // Handle complex pattern.
 244     const ComplexPattern &CP = CGP.getComplexPattern(LeafRec);
 245     AddMatcherNode(new CheckComplexPatMatcherNode(CP));
 246
 247     // If the complex pattern has a chain, then we need to keep track of the
 248     // fact that we just recorded a chain input.  The chain input will be
 249     // matched as the last operand of the predicate if it was successful.
 250     if (CP.hasProperty(SDNPHasChain)) {
 251       // It is the last operand recorded.
 252       assert(NextRecordedOperandNo > 1 &&
 253              "Should have recorded input/result chains at least!");
 254       MatchedChainNodes.push_back(NextRecordedOperandNo-1);
 255
 256       // If we need to check chains, do so, see comment for
 257       // "NodeHasProperty(SDNPHasChain" below.
 258       if (MatchedChainNodes.size() > 1) {
 259         // FIXME2: This is broken, we should eliminate this nonsense completely,
 260         // but we want to produce the same selections that the old matcher does
 261         // for now.
 262         unsigned PrevOp = MatchedChainNodes[MatchedChainNodes.size()-2];
 263         AddMatcherNode(new CheckChainCompatibleMatcherNode(PrevOp));
 264       }
 265     }
 266     return;
 267   }
 268
 269   errs() << "Unknown leaf kind: " << *N << "\n";
 270   abort();
 271 }
 272
 273 void MatcherGen::EmitOperatorMatchCode(const TreePatternNode *N,
 274                                        TreePatternNode *NodeNoTypes) {
 275   assert(!N->isLeaf() && "Not an operator?");
 276   const SDNodeInfo &CInfo = CGP.getSDNodeInfo(N->getOperator());
 277
 278   // If this is an 'and R, 1234' where the operation is AND/OR and the RHS is
 279   // a constant without a predicate fn that has more that one bit set, handle
 280   // this as a special case.  This is usually for targets that have special
 281   // handling of certain large constants (e.g. alpha with it's 8/16/32-bit
 282   // handling stuff).  Using these instructions is often far more efficient
 283   // than materializing the constant.  Unfortunately, both the instcombiner
 284   // and the dag combiner can often infer that bits are dead, and thus drop
 285   // them from the mask in the dag.  For example, it might turn 'AND X, 255'
 286   // into 'AND X, 254' if it knows the low bit is set.  Emit code that checks
 287   // to handle this.
 288   if ((N->getOperator()->getName() == "and" ||
 289        N->getOperator()->getName() == "or") &&
 290       N->getChild(1)->isLeaf() && N->getChild(1)->getPredicateFns().empty() &&
 291       N->getPredicateFns().empty()) {
 292     if (IntInit *II = dynamic_cast<IntInit*>(N->getChild(1)->getLeafValue())) {
 293       if (!isPowerOf2_32(II->getValue())) {  // Don't bother with single bits.
 294         if (N->getOperator()->getName() == "and")
 295           AddMatcherNode(new CheckAndImmMatcherNode(II->getValue()));
 296         else
 297           AddMatcherNode(new CheckOrImmMatcherNode(II->getValue()));
 298
 299         // Match the LHS of the AND as appropriate.
 300         AddMatcherNode(new MoveChildMatcherNode(0));
 301         EmitMatchCode(N->getChild(0), NodeNoTypes->getChild(0));
 302         AddMatcherNode(new MoveParentMatcherNode());
 303         return;
 304       }
 305     }
 306   }
 307
 308   // Check that the current opcode lines up.
 309   AddMatcherNode(new CheckOpcodeMatcherNode(CInfo.getEnumName()));
 310
 311   // If there are node predicates for this node, generate their checks.
 312   for (unsigned i = 0, e = N->getPredicateFns().size(); i != e; ++i)
 313     AddMatcherNode(new CheckPredicateMatcherNode(N->getPredicateFns()[i]));
 314
 315
 316   // If this node has memory references (i.e. is a load or store), tell the
 317   // interpreter to capture them in the memref array.
 318   if (N->NodeHasProperty(SDNPMemOperand, CGP))
 319     AddMatcherNode(new RecordMemRefMatcherNode());
 320
 321   // If this node has a chain, then the chain is operand #0 is the SDNode, and
 322   // the child numbers of the node are all offset by one.
 323   unsigned OpNo = 0;
 324   if (N->NodeHasProperty(SDNPHasChain, CGP)) {
 325     // Record the node and remember it in our chained nodes list.
 326     AddMatcherNode(new RecordMatcherNode("'" + N->getOperator()->getName() +
 327                                          "' chained node"));
 328     // Remember all of the input chains our pattern will match.
 329     MatchedChainNodes.push_back(NextRecordedOperandNo++);
 330
 331     // If this is the second (e.g. indbr(load) or store(add(load))) or third
 332     // input chain (e.g. (store (add (load, load))) from msp430) we need to make
 333     // sure that folding the chain won't induce cycles in the DAG.  This could
 334     // happen if there were an intermediate node between the indbr and load, for
 335     // example.
 336     if (MatchedChainNodes.size() > 1) {
 337       // FIXME2: This is broken, we should eliminate this nonsense completely,
 338       // but we want to produce the same selections that the old matcher does
 339       // for now.
 340       unsigned PrevOp = MatchedChainNodes[MatchedChainNodes.size()-2];
 341       AddMatcherNode(new CheckChainCompatibleMatcherNode(PrevOp));
 342     }
 343
 344     // Don't look at the input chain when matching the tree pattern to the
 345     // SDNode.
 346     OpNo = 1;
 347
 348     // If this node is not the root and the subtree underneath it produces a
 349     // chain, then the result of matching the node is also produce a chain.
 350     // Beyond that, this means that we're also folding (at least) the root node
 351     // into the node that produce the chain (for example, matching
 352     // "(add reg, (load ptr))" as a add_with_memory on X86).  This is
 353     // problematic, if the 'reg' node also uses the load (say, its chain).
 354     // Graphically:
 355     //
 356     //         [LD]
 357     //         ^  ^
 358     //         |  \                              DAG's like cheese.
 359     //        /    |
 360     //       /    [YY]
 361     //       |     ^
 362     //      [XX]--/
 363     //
 364     // It would be invalid to fold XX and LD.  In this case, folding the two
 365     // nodes together would induce a cycle in the DAG, making it a 'cyclic DAG'
 366     // To prevent this, we emit a dynamic check for legality before allowing
 367     // this to be folded.
 368     //
 369     const TreePatternNode *Root = Pattern.getSrcPattern();
 370     if (N != Root) {                             // Not the root of the pattern.
 371       // If there is a node between the root and this node, then we definitely
 372       // need to emit the check.
 373       bool NeedCheck = !Root->hasChild(N);
 374
 375       // If it *is* an immediate child of the root, we can still need a check if
 376       // the root SDNode has multiple inputs.  For us, this means that it is an
 377       // intrinsic, has multiple operands, or has other inputs like chain or
 378       // flag).
 379       if (!NeedCheck) {
 380         const SDNodeInfo &PInfo = CGP.getSDNodeInfo(Root->getOperator());
 381         NeedCheck =
 382           Root->getOperator() == CGP.get_intrinsic_void_sdnode() ||
 383           Root->getOperator() == CGP.get_intrinsic_w_chain_sdnode() ||
 384           Root->getOperator() == CGP.get_intrinsic_wo_chain_sdnode() ||
 385           PInfo.getNumOperands() > 1 ||
 386           PInfo.hasProperty(SDNPHasChain) ||
 387           PInfo.hasProperty(SDNPInFlag) ||
 388           PInfo.hasProperty(SDNPOptInFlag);
 389       }
 390
 391       if (NeedCheck)
 392         AddMatcherNode(new CheckFoldableChainNodeMatcherNode());
 393     }
 394   }
 395
 396   // If this node is known to have an input flag or if it *might* have an input
 397   // flag, capture it as the flag input of the pattern.
 398   if (N->NodeHasProperty(SDNPOptInFlag, CGP) ||
 399       N->NodeHasProperty(SDNPInFlag, CGP))
 400     AddMatcherNode(new CaptureFlagInputMatcherNode());
 401
 402   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i, ++OpNo) {
 403     // Get the code suitable for matching this child.  Move to the child, check
 404     // it then move back to the parent.
 405     AddMatcherNode(new MoveChildMatcherNode(OpNo));
 406     EmitMatchCode(N->getChild(i), NodeNoTypes->getChild(i));
 407     AddMatcherNode(new MoveParentMatcherNode());
 408   }
 409 }
 410
 411
 412 void MatcherGen::EmitMatchCode(const TreePatternNode *N,
 413                                TreePatternNode *NodeNoTypes) {
 414   // If N and NodeNoTypes don't agree on a type, then this is a case where we
 415   // need to do a type check.  Emit the check, apply the tyep to NodeNoTypes and
 416   // reinfer any correlated types.
 417   if (NodeNoTypes->getExtTypes() != N->getExtTypes()) {
 418     AddMatcherNode(new CheckTypeMatcherNode(N->getTypeNum(0)));
 419     NodeNoTypes->setTypes(N->getExtTypes());
 420     InferPossibleTypes();
 421   }
 422
 423   // If this node has a name associated with it, capture it in VariableMap. If
 424   // we already saw this in the pattern, emit code to verify dagness.
 425   if (!N->getName().empty()) {
 426     unsigned &VarMapEntry = VariableMap[N->getName()];
 427     if (VarMapEntry == 0) {
 428       VarMapEntry = NextRecordedOperandNo+1;
 429
 430       unsigned NumRecorded;
 431
 432       // If this is a complex pattern, the match operation for it will
 433       // implicitly record all of the outputs of it (which may be more than
 434       // one).
 435       if (const ComplexPattern *CP = N->getComplexPatternInfo(CGP)) {
 436         // Record the right number of operands.
 437         NumRecorded = CP->getNumOperands();
 438
 439         if (CP->hasProperty(SDNPHasChain))
 440           ++NumRecorded; // Chained node operand.
 441       } else {
 442         // If it is a normal named node, we must emit a 'Record' opcode.
 443         AddMatcherNode(new RecordMatcherNode("$" + N->getName()));
 444         NumRecorded = 1;
 445       }
 446       NextRecordedOperandNo += NumRecorded;
 447
 448     } else {
 449       // If we get here, this is a second reference to a specific name.  Since
 450       // we already have checked that the first reference is valid, we don't
 451       // have to recursively match it, just check that it's the same as the
 452       // previously named thing.
 453       AddMatcherNode(new CheckSameMatcherNode(VarMapEntry-1));
 454       return;
 455     }
 456   }
 457
 458   if (N->isLeaf())
 459     EmitLeafMatchCode(N);
 460   else
 461     EmitOperatorMatchCode(N, NodeNoTypes);
 462 }
 463
 464 void MatcherGen::EmitMatcherCode() {
 465   // If the pattern has a predicate on it (e.g. only enabled when a subtarget
 466   // feature is around, do the check).
 467   if (!Pattern.getPredicateCheck().empty())
 468     AddMatcherNode(new
 469                  CheckPatternPredicateMatcherNode(Pattern.getPredicateCheck()));
 470
 471   // Emit the matcher for the pattern structure and types.
 472   EmitMatchCode(Pattern.getSrcPattern(), PatWithNoTypes);
 473 }
 474
 475
 476 //===----------------------------------------------------------------------===//
 477 // Node Result Generation
 478 //===----------------------------------------------------------------------===//
 479
 480 void MatcherGen::EmitResultOfNamedOperand(const TreePatternNode *N,
 481                                           SmallVectorImpl<unsigned> &ResultOps){
 482   assert(!N->getName().empty() && "Operand not named!");
 483
 484   unsigned SlotNo = getNamedArgumentSlot(N->getName());
 485
 486   // A reference to a complex pattern gets all of the results of the complex
 487   // pattern's match.
 488   if (const ComplexPattern *CP = N->getComplexPatternInfo(CGP)) {
 489     for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
 490       ResultOps.push_back(SlotNo+i);
 491     return;
 492   }
 493
 494   // If this is an 'imm' or 'fpimm' node, make sure to convert it to the target
 495   // version of the immediate so that it doesn't get selected due to some other
 496   // node use.
 497   if (!N->isLeaf()) {
 498     StringRef OperatorName = N->getOperator()->getName();
 499     if (OperatorName == "imm" || OperatorName == "fpimm") {
 500       AddMatcherNode(new EmitConvertToTargetMatcherNode(SlotNo));
 501       ResultOps.push_back(NextRecordedOperandNo++);
 502       return;
 503     }
 504   }
 505
 506   ResultOps.push_back(SlotNo);
 507 }
 508
 509 void MatcherGen::EmitResultLeafAsOperand(const TreePatternNode *N,
 510                                          SmallVectorImpl<unsigned> &ResultOps) {
 511   assert(N->isLeaf() && "Must be a leaf");
 512
 513   if (IntInit *II = dynamic_cast<IntInit*>(N->getLeafValue())) {
 514     AddMatcherNode(new EmitIntegerMatcherNode(II->getValue(),N->getTypeNum(0)));
 515     ResultOps.push_back(NextRecordedOperandNo++);
 516     return;
 517   }
 518
 519   // If this is an explicit register reference, handle it.
 520   if (DefInit *DI = dynamic_cast<DefInit*>(N->getLeafValue())) {
 521     if (DI->getDef()->isSubClassOf("Register")) {
 522       AddMatcherNode(new EmitRegisterMatcherNode(DI->getDef(),
 523                                                  N->getTypeNum(0)));
 524       ResultOps.push_back(NextRecordedOperandNo++);
 525       return;
 526     }
 527
 528     if (DI->getDef()->getName() == "zero_reg") {
 529       AddMatcherNode(new EmitRegisterMatcherNode(0, N->getTypeNum(0)));
 530       ResultOps.push_back(NextRecordedOperandNo++);
 531       return;
 532     }
 533
 534     // Handle a reference to a register class. This is used
 535     // in COPY_TO_SUBREG instructions.
 536     if (DI->getDef()->isSubClassOf("RegisterClass")) {
 537       std::string Value = getQualifiedName(DI->getDef()) + "RegClassID";
 538       AddMatcherNode(new EmitStringIntegerMatcherNode(Value, N->getTypeNum(0)));
 539       ResultOps.push_back(NextRecordedOperandNo++);
 540       return;
 541     }
 542   }
 543
 544   errs() << "unhandled leaf node: \n";
 545   N->dump();
 546 }
 547
 548 /// GetInstPatternNode - Get the pattern for an instruction.
 549 ///
 550 const TreePatternNode *MatcherGen::
 551 GetInstPatternNode(const DAGInstruction &Inst, const TreePatternNode *N) {
 552   const TreePattern *InstPat = Inst.getPattern();
 553
 554   // FIXME2?: Assume actual pattern comes before "implicit".
 555   TreePatternNode *InstPatNode;
 556   if (InstPat)
 557     InstPatNode = InstPat->getTree(0);
 558   else if (/*isRoot*/ N == Pattern.getDstPattern())
 559     InstPatNode = Pattern.getSrcPattern();
 560   else
 561     return 0;
 562
 563   if (InstPatNode && !InstPatNode->isLeaf() &&
 564       InstPatNode->getOperator()->getName() == "set")
 565     InstPatNode = InstPatNode->getChild(InstPatNode->getNumChildren()-1);
 566
 567   return InstPatNode;
 568 }
 569
 570 void MatcherGen::
 571 EmitResultInstructionAsOperand(const TreePatternNode *N,
 572                                SmallVectorImpl<unsigned> &OutputOps) {
 573   Record *Op = N->getOperator();
 574   const CodeGenTarget &CGT = CGP.getTargetInfo();
 575   CodeGenInstruction &II = CGT.getInstruction(Op->getName());
 576   const DAGInstruction &Inst = CGP.getInstruction(Op);
 577
 578   // If we can, get the pattern for the instruction we're generating.  We derive
 579   // a variety of information from this pattern, such as whether it has a chain.
 580   //
 581   // FIXME2: This is extremely dubious for several reasons, not the least of
 582   // which it gives special status to instructions with patterns that Pat<>
 583   // nodes can't duplicate.
 584   const TreePatternNode *InstPatNode = GetInstPatternNode(Inst, N);
 585
 586   // NodeHasChain - Whether the instruction node we're creating takes chains.
 587   bool NodeHasChain = InstPatNode &&
 588                       InstPatNode->TreeHasProperty(SDNPHasChain, CGP);
 589
 590   bool isRoot = N == Pattern.getDstPattern();
 591
 592   // NodeHasOutFlag - True if this node has a flag.
 593   bool NodeHasInFlag = false, NodeHasOutFlag = false;
 594   if (isRoot) {
 595     const TreePatternNode *SrcPat = Pattern.getSrcPattern();
 596     NodeHasInFlag = SrcPat->TreeHasProperty(SDNPOptInFlag, CGP) ||
 597                     SrcPat->TreeHasProperty(SDNPInFlag, CGP);
 598
 599     // FIXME2: this is checking the entire pattern, not just the node in
 600     // question, doing this just for the root seems like a total hack.
 601     NodeHasOutFlag = SrcPat->TreeHasProperty(SDNPOutFlag, CGP);
 602   }
 603
 604   // NumResults - This is the number of results produced by the instruction in
 605   // the "outs" list.
 606   unsigned NumResults = Inst.getNumResults();
 607
 608   // Loop over all of the operands of the instruction pattern, emitting code
 609   // to fill them all in.  The node 'N' usually has number children equal to
 610   // the number of input operands of the instruction.  However, in cases
 611   // where there are predicate operands for an instruction, we need to fill
 612   // in the 'execute always' values.  Match up the node operands to the
 613   // instruction operands to do this.
 614   SmallVector<unsigned, 8> InstOps;
 615   for (unsigned ChildNo = 0, InstOpNo = NumResults, e = II.OperandList.size();
 616        InstOpNo != e; ++InstOpNo) {
 617
 618     // Determine what to emit for this operand.
 619     Record *OperandNode = II.OperandList[InstOpNo].Rec;
 620     if ((OperandNode->isSubClassOf("PredicateOperand") ||
 621          OperandNode->isSubClassOf("OptionalDefOperand")) &&
 622         !CGP.getDefaultOperand(OperandNode).DefaultOps.empty()) {
 623       // This is a predicate or optional def operand; emit the
 624       // 'default ops' operands.
 625       const DAGDefaultOperand &DefaultOp =
 626         CGP.getDefaultOperand(II.OperandList[InstOpNo].Rec);
 627       for (unsigned i = 0, e = DefaultOp.DefaultOps.size(); i != e; ++i)
 628         EmitResultOperand(DefaultOp.DefaultOps[i], InstOps);
 629       continue;
 630     }
 631
 632     // Otherwise this is a normal operand or a predicate operand without
 633     // 'execute always'; emit it.
 634     EmitResultOperand(N->getChild(ChildNo), InstOps);
 635     ++ChildNo;
 636   }
 637
 638   // Nodes that match patterns with (potentially multiple) chain inputs have to
 639   // merge them together into a token factor.
 640   if (NodeHasChain && !EmittedMergeInputChains) {
 641     // FIXME2: Move this out of emitresult to a top level place.
 642     assert(!MatchedChainNodes.empty() &&
 643            "How can this node have chain if no inputs do?");
 644     // Otherwise, we have to emit an operation to merge the input chains and
 645     // set this as the current input chain.
 646     AddMatcherNode(new EmitMergeInputChainsMatcherNode
 647                         (MatchedChainNodes.data(), MatchedChainNodes.size()));
 648     EmittedMergeInputChains = true;
 649   }
 650
 651   // If this node has an input flag or explicitly specified input physregs, we
 652   // need to add chained and flagged copyfromreg nodes and materialize the flag
 653   // input.
 654   if (isRoot && !PhysRegInputs.empty()) {
 655     // Emit all of the CopyToReg nodes for the input physical registers.  These
 656     // occur in patterns like (mul:i8 AL:i8, GR8:i8:$src).
 657     for (unsigned i = 0, e = PhysRegInputs.size(); i != e; ++i)
 658       AddMatcherNode(new EmitCopyToRegMatcherNode(PhysRegInputs[i].second,
 659                                                   PhysRegInputs[i].first));
 660     // Even if the node has no other flag inputs, the resultant node must be
 661     // flagged to the CopyFromReg nodes we just generated.
 662     NodeHasInFlag = true;
 663   }
 664
 665   // Result order: node results, chain, flags
 666
 667   // Determine the result types.
 668   SmallVector<MVT::SimpleValueType, 4> ResultVTs;
 669   if (NumResults > 0 && N->getTypeNum(0) != MVT::isVoid) {
 670     // FIXME2: If the node has multiple results, we should add them.  For now,
 671     // preserve existing behavior?!
 672     ResultVTs.push_back(N->getTypeNum(0));
 673   }
 674
 675
 676   // If this is the root instruction of a pattern that has physical registers in
 677   // its result pattern, add output VTs for them.  For example, X86 has:
 678   //   (set AL, (mul ...))
 679   // This also handles implicit results like:
 680   //   (implicit EFLAGS)
 681   if (isRoot && Pattern.getDstRegs().size() != 0) {
 682     for (unsigned i = 0; i != Pattern.getDstRegs().size(); ++i)
 683       if (Pattern.getDstRegs()[i]->isSubClassOf("Register"))
 684         ResultVTs.push_back(getRegisterValueType(Pattern.getDstRegs()[i], CGT));
 685   }
 686   if (NodeHasChain)
 687     ResultVTs.push_back(MVT::Other);
 688   if (NodeHasOutFlag)
 689     ResultVTs.push_back(MVT::Flag);
 690
 691   // FIXME2: Instead of using the isVariadic flag on the instruction, we should
 692   // have an SDNP that indicates variadicism.  The TargetInstrInfo isVariadic
 693   // property should be inferred from this when an instruction has a pattern.
 694   int NumFixedArityOperands = -1;
 695   if (isRoot && II.isVariadic)
 696     NumFixedArityOperands = Pattern.getSrcPattern()->getNumChildren();
 697
 698   // If this is the root node and any of the nodes matched nodes in the input
 699   // pattern have MemRefs in them, have the interpreter collect them and plop
 700   // them onto this node.
 701   //
 702   // FIXME3: This is actively incorrect for result patterns where the root of
 703   // the pattern is not the memory reference and is also incorrect when the
 704   // result pattern has multiple memory-referencing instructions.  For example,
 705   // in the X86 backend, this pattern causes the memrefs to get attached to the
 706   // CVTSS2SDrr instead of the MOVSSrm:
 707   //
 708   //  def : Pat<(extloadf32 addr:$src),
 709   //            (CVTSS2SDrr (MOVSSrm addr:$src))>;
 710   //
 711   bool NodeHasMemRefs =
 712     isRoot && Pattern.getSrcPattern()->TreeHasProperty(SDNPMemOperand, CGP);
 713
 714   // FIXME: Eventually add a SelectNodeTo form.  It works if the new node has a
 715   // superset of the results of the old node, in the same places.  E.g. turning
 716   // (add (load)) -> add32rm is ok because result #0 is the result and result #1
 717   // is new.
 718   AddMatcherNode(new EmitNodeMatcherNode(II.Namespace+"::"+II.TheDef->getName(),
 719                                          ResultVTs.data(), ResultVTs.size(),
 720                                          InstOps.data(), InstOps.size(),
 721                                          NodeHasChain, NodeHasInFlag,
 722                                          NodeHasMemRefs,NumFixedArityOperands));
 723
 724   // The newly emitted node gets recorded.
 725   // FIXME2: This should record all of the results except the (implicit) one.
 726   OutputOps.push_back(NextRecordedOperandNo++);
 727
 728
 729   // FIXME2: Kill off all the SelectionDAG::SelectNodeTo and getMachineNode
 730   // variants.  Call MorphNodeTo instead of SelectNodeTo.
 731 }
 732
 733 void MatcherGen::
 734 EmitResultSDNodeXFormAsOperand(const TreePatternNode *N,
 735                                SmallVectorImpl<unsigned> &ResultOps) {
 736   assert(N->getOperator()->isSubClassOf("SDNodeXForm") && "Not SDNodeXForm?");
 737
 738   // Emit the operand.
 739   SmallVector<unsigned, 8> InputOps;
 740
 741   // FIXME2: Could easily generalize this to support multiple inputs and outputs
 742   // to the SDNodeXForm.  For now we just support one input and one output like
 743   // the old instruction selector.
 744   assert(N->getNumChildren() == 1);
 745   EmitResultOperand(N->getChild(0), InputOps);
 746
 747   // The input currently must have produced exactly one result.
 748   assert(InputOps.size() == 1 && "Unexpected input to SDNodeXForm");
 749
 750   AddMatcherNode(new EmitNodeXFormMatcherNode(InputOps[0], N->getOperator()));
 751   ResultOps.push_back(NextRecordedOperandNo++);
 752 }
 753
 754 void MatcherGen::EmitResultOperand(const TreePatternNode *N,
 755                                    SmallVectorImpl<unsigned> &ResultOps) {
 756   // This is something selected from the pattern we matched.
 757   if (!N->getName().empty())
 758     return EmitResultOfNamedOperand(N, ResultOps);
 759
 760   if (N->isLeaf())
 761     return EmitResultLeafAsOperand(N, ResultOps);
 762
 763   Record *OpRec = N->getOperator();
 764   if (OpRec->isSubClassOf("Instruction"))
 765     return EmitResultInstructionAsOperand(N, ResultOps);
 766   if (OpRec->isSubClassOf("SDNodeXForm"))
 767     return EmitResultSDNodeXFormAsOperand(N, ResultOps);
 768   errs() << "Unknown result node to emit code for: " << *N << '\n';
 769   throw std::string("Unknown node in result pattern!");
 770 }
 771
 772 void MatcherGen::EmitResultCode() {
 773   SmallVector<unsigned, 8> Ops;
 774   EmitResultOperand(Pattern.getDstPattern(), Ops);
 775
 776   // We know that the resulting pattern has exactly one result/
 777   // FIXME2: why?  what about something like (set a,b,c, (complexpat))
 778   // FIXME2: Implicit results should be pushed here I guess?
 779   assert(Ops.size() == 1);
 780   // FIXME: Handle Ops.
 781   // FIXME: Handle (set EAX, (foo)) but not (implicit EFLAGS)
 782
 783   AddMatcherNode(new PatternMarkerMatcherNode(Pattern));
 784 }
 785
 786
 787 MatcherNode *llvm::ConvertPatternToMatcher(const PatternToMatch &Pattern,
 788                                            const CodeGenDAGPatterns &CGP) {
 789   MatcherGen Gen(Pattern, CGP);
 790
 791   // Generate the code for the matcher.
 792   Gen.EmitMatcherCode();
 793
 794
 795   // FIXME2: Kill extra MoveParent commands at the end of the matcher sequence.
 796   // FIXME2: Split result code out to another table, and make the matcher end
 797   // with an "Emit <index>" command.  This allows result generation stuff to be
 798   // shared and factored?
 799
 800   // If the match succeeds, then we generate Pattern.
 801   Gen.EmitResultCode();
 802
 803   // Unconditional match.
 804   return Gen.GetMatcher();
 805 }
 806
 807
 808