utils/TableGen/CodeGenDAGPatterns.cpp

   1 //===- CodeGenDAGPatterns.cpp - Read DAG patterns from .td file -----------===//
   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 file implements the CodeGenDAGPatterns class, which is used to read and
  11 // represent the patterns present in a .td file for instructions.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "CodeGenDAGPatterns.h"
  16 #include "Record.h"
  17 #include "llvm/ADT/StringExtras.h"
  18 #include "llvm/Support/Debug.h"
  19 #include <set>
  20 #include <algorithm>
  21 #include <iostream>
  22 using namespace llvm;
  23
  24 //===----------------------------------------------------------------------===//
  25 // Helpers for working with extended types.
  26
  27 /// FilterVTs - Filter a list of VT's according to a predicate.
  28 ///
  29 template<typename T>
  30 static std::vector<MVT::SimpleValueType>
  31 FilterVTs(const std::vector<MVT::SimpleValueType> &InVTs, T Filter) {
  32   std::vector<MVT::SimpleValueType> Result;
  33   for (unsigned i = 0, e = InVTs.size(); i != e; ++i)
  34     if (Filter(InVTs[i]))
  35       Result.push_back(InVTs[i]);
  36   return Result;
  37 }
  38
  39 template<typename T>
  40 static std::vector<unsigned char>
  41 FilterEVTs(const std::vector<unsigned char> &InVTs, T Filter) {
  42   std::vector<unsigned char> Result;
  43   for (unsigned i = 0, e = InVTs.size(); i != e; ++i)
  44     if (Filter((MVT::SimpleValueType)InVTs[i]))
  45       Result.push_back(InVTs[i]);
  46   return Result;
  47 }
  48
  49 static std::vector<unsigned char>
  50 ConvertVTs(const std::vector<MVT::SimpleValueType> &InVTs) {
  51   std::vector<unsigned char> Result;
  52   for (unsigned i = 0, e = InVTs.size(); i != e; ++i)
  53     Result.push_back(InVTs[i]);
  54   return Result;
  55 }
  56
  57 static inline bool isInteger(MVT::SimpleValueType VT) {
  58   return EVT(VT).isInteger();
  59 }
  60
  61 static inline bool isFloatingPoint(MVT::SimpleValueType VT) {
  62   return EVT(VT).isFloatingPoint();
  63 }
  64
  65 static inline bool isVector(MVT::SimpleValueType VT) {
  66   return EVT(VT).isVector();
  67 }
  68
  69 static bool LHSIsSubsetOfRHS(const std::vector<unsigned char> &LHS,
  70                              const std::vector<unsigned char> &RHS) {
  71   if (LHS.size() > RHS.size()) return false;
  72   for (unsigned i = 0, e = LHS.size(); i != e; ++i)
  73     if (std::find(RHS.begin(), RHS.end(), LHS[i]) == RHS.end())
  74       return false;
  75   return true;
  76 }
  77
  78 namespace llvm {
  79 namespace EEVT {
  80 /// isExtIntegerInVTs - Return true if the specified extended value type vector
  81 /// contains iAny or an integer value type.
  82 bool isExtIntegerInVTs(const std::vector<unsigned char> &EVTs) {
  83   assert(!EVTs.empty() && "Cannot check for integer in empty ExtVT list!");
  84   return EVTs[0] == MVT::iAny || !(FilterEVTs(EVTs, isInteger).empty());
  85 }
  86
  87 /// isExtFloatingPointInVTs - Return true if the specified extended value type
  88 /// vector contains fAny or a FP value type.
  89 bool isExtFloatingPointInVTs(const std::vector<unsigned char> &EVTs) {
  90   assert(!EVTs.empty() && "Cannot check for FP in empty ExtVT list!");
  91   return EVTs[0] == MVT::fAny || !(FilterEVTs(EVTs, isFloatingPoint).empty());
  92 }
  93
  94 /// isExtVectorInVTs - Return true if the specified extended value type
  95 /// vector contains vAny or a vector value type.
  96 bool isExtVectorInVTs(const std::vector<unsigned char> &EVTs) {
  97   assert(!EVTs.empty() && "Cannot check for vector in empty ExtVT list!");
  98   return EVTs[0] == MVT::vAny || !(FilterEVTs(EVTs, isVector).empty());
  99 }
 100 } // end namespace EEVT.
 101 } // end namespace llvm.
 102
 103 bool RecordPtrCmp::operator()(const Record *LHS, const Record *RHS) const {
 104   return LHS->getID() < RHS->getID();
 105 }
 106
 107 /// Dependent variable map for CodeGenDAGPattern variant generation
 108 typedef std::map<std::string, int> DepVarMap;
 109
 110 /// Const iterator shorthand for DepVarMap
 111 typedef DepVarMap::const_iterator DepVarMap_citer;
 112
 113 namespace {
 114 void FindDepVarsOf(TreePatternNode *N, DepVarMap &DepMap) {
 115   if (N->isLeaf()) {
 116     if (dynamic_cast<DefInit*>(N->getLeafValue()) != NULL) {
 117       DepMap[N->getName()]++;
 118     }
 119   } else {
 120     for (size_t i = 0, e = N->getNumChildren(); i != e; ++i)
 121       FindDepVarsOf(N->getChild(i), DepMap);
 122   }
 123 }
 124
 125 //! Find dependent variables within child patterns
 126 /*!
 127  */
 128 void FindDepVars(TreePatternNode *N, MultipleUseVarSet &DepVars) {
 129   DepVarMap depcounts;
 130   FindDepVarsOf(N, depcounts);
 131   for (DepVarMap_citer i = depcounts.begin(); i != depcounts.end(); ++i) {
 132     if (i->second > 1) {            // std::pair<std::string, int>
 133       DepVars.insert(i->first);
 134     }
 135   }
 136 }
 137
 138 //! Dump the dependent variable set:
 139 void DumpDepVars(MultipleUseVarSet &DepVars) {
 140   if (DepVars.empty()) {
 141     DEBUG(errs() << "<empty set>");
 142   } else {
 143     DEBUG(errs() << "[ ");
 144     for (MultipleUseVarSet::const_iterator i = DepVars.begin(), e = DepVars.end();
 145          i != e; ++i) {
 146       DEBUG(errs() << (*i) << " ");
 147     }
 148     DEBUG(errs() << "]");
 149   }
 150 }
 151 }
 152
 153 //===----------------------------------------------------------------------===//
 154 // PatternToMatch implementation
 155 //
 156
 157 /// getPredicateCheck - Return a single string containing all of this
 158 /// pattern's predicates concatenated with "&&" operators.
 159 ///
 160 std::string PatternToMatch::getPredicateCheck() const {
 161   std::string PredicateCheck;
 162   for (unsigned i = 0, e = Predicates->getSize(); i != e; ++i) {
 163     if (DefInit *Pred = dynamic_cast<DefInit*>(Predicates->getElement(i))) {
 164       Record *Def = Pred->getDef();
 165       if (!Def->isSubClassOf("Predicate")) {
 166 #ifndef NDEBUG
 167         Def->dump();
 168 #endif
 169         assert(0 && "Unknown predicate type!");
 170       }
 171       if (!PredicateCheck.empty())
 172         PredicateCheck += " && ";
 173       PredicateCheck += "(" + Def->getValueAsString("CondString") + ")";
 174     }
 175   }
 176
 177   return PredicateCheck;
 178 }
 179
 180 //===----------------------------------------------------------------------===//
 181 // SDTypeConstraint implementation
 182 //
 183
 184 SDTypeConstraint::SDTypeConstraint(Record *R) {
 185   OperandNo = R->getValueAsInt("OperandNum");
 186
 187   if (R->isSubClassOf("SDTCisVT")) {
 188     ConstraintType = SDTCisVT;
 189     x.SDTCisVT_Info.VT = getValueType(R->getValueAsDef("VT"));
 190   } else if (R->isSubClassOf("SDTCisPtrTy")) {
 191     ConstraintType = SDTCisPtrTy;
 192   } else if (R->isSubClassOf("SDTCisInt")) {
 193     ConstraintType = SDTCisInt;
 194   } else if (R->isSubClassOf("SDTCisFP")) {
 195     ConstraintType = SDTCisFP;
 196   } else if (R->isSubClassOf("SDTCisVec")) {
 197     ConstraintType = SDTCisVec;
 198   } else if (R->isSubClassOf("SDTCisSameAs")) {
 199     ConstraintType = SDTCisSameAs;
 200     x.SDTCisSameAs_Info.OtherOperandNum = R->getValueAsInt("OtherOperandNum");
 201   } else if (R->isSubClassOf("SDTCisVTSmallerThanOp")) {
 202     ConstraintType = SDTCisVTSmallerThanOp;
 203     x.SDTCisVTSmallerThanOp_Info.OtherOperandNum =
 204       R->getValueAsInt("OtherOperandNum");
 205   } else if (R->isSubClassOf("SDTCisOpSmallerThanOp")) {
 206     ConstraintType = SDTCisOpSmallerThanOp;
 207     x.SDTCisOpSmallerThanOp_Info.BigOperandNum =
 208       R->getValueAsInt("BigOperandNum");
 209   } else if (R->isSubClassOf("SDTCisEltOfVec")) {
 210     ConstraintType = SDTCisEltOfVec;
 211     x.SDTCisEltOfVec_Info.OtherOperandNum =
 212       R->getValueAsInt("OtherOpNum");
 213   } else {
 214     errs() << "Unrecognized SDTypeConstraint '" << R->getName() << "'!\n";
 215     exit(1);
 216   }
 217 }
 218
 219 /// getOperandNum - Return the node corresponding to operand #OpNo in tree
 220 /// N, which has NumResults results.
 221 TreePatternNode *SDTypeConstraint::getOperandNum(unsigned OpNo,
 222                                                  TreePatternNode *N,
 223                                                  unsigned NumResults) const {
 224   assert(NumResults <= 1 &&
 225          "We only work with nodes with zero or one result so far!");
 226
 227   if (OpNo >= (NumResults + N->getNumChildren())) {
 228     errs() << "Invalid operand number " << OpNo << " ";
 229     N->dump();
 230     errs() << '\n';
 231     exit(1);
 232   }
 233
 234   if (OpNo < NumResults)
 235     return N;  // FIXME: need value #
 236   else
 237     return N->getChild(OpNo-NumResults);
 238 }
 239
 240 /// ApplyTypeConstraint - Given a node in a pattern, apply this type
 241 /// constraint to the nodes operands.  This returns true if it makes a
 242 /// change, false otherwise.  If a type contradiction is found, throw an
 243 /// exception.
 244 bool SDTypeConstraint::ApplyTypeConstraint(TreePatternNode *N,
 245                                            const SDNodeInfo &NodeInfo,
 246                                            TreePattern &TP) const {
 247   unsigned NumResults = NodeInfo.getNumResults();
 248   assert(NumResults <= 1 &&
 249          "We only work with nodes with zero or one result so far!");
 250
 251   // Check that the number of operands is sane.  Negative operands -> varargs.
 252   if (NodeInfo.getNumOperands() >= 0) {
 253     if (N->getNumChildren() != (unsigned)NodeInfo.getNumOperands())
 254       TP.error(N->getOperator()->getName() + " node requires exactly " +
 255                itostr(NodeInfo.getNumOperands()) + " operands!");
 256   }
 257
 258   const CodeGenTarget &CGT = TP.getDAGPatterns().getTargetInfo();
 259
 260   TreePatternNode *NodeToApply = getOperandNum(OperandNo, N, NumResults);
 261
 262   switch (ConstraintType) {
 263   default: assert(0 && "Unknown constraint type!");
 264   case SDTCisVT:
 265     // Operand must be a particular type.
 266     return NodeToApply->UpdateNodeType(x.SDTCisVT_Info.VT, TP);
 267   case SDTCisPtrTy: {
 268     // Operand must be same as target pointer type.
 269     return NodeToApply->UpdateNodeType(MVT::iPTR, TP);
 270   }
 271   case SDTCisInt: {
 272     // If there is only one integer type supported, this must be it.
 273     std::vector<MVT::SimpleValueType> IntVTs =
 274       FilterVTs(CGT.getLegalValueTypes(), isInteger);
 275
 276     // If we found exactly one supported integer type, apply it.
 277     if (IntVTs.size() == 1)
 278       return NodeToApply->UpdateNodeType(IntVTs[0], TP);
 279     return NodeToApply->UpdateNodeType(MVT::iAny, TP);
 280   }
 281   case SDTCisFP: {
 282     // If there is only one FP type supported, this must be it.
 283     std::vector<MVT::SimpleValueType> FPVTs =
 284       FilterVTs(CGT.getLegalValueTypes(), isFloatingPoint);
 285
 286     // If we found exactly one supported FP type, apply it.
 287     if (FPVTs.size() == 1)
 288       return NodeToApply->UpdateNodeType(FPVTs[0], TP);
 289     return NodeToApply->UpdateNodeType(MVT::fAny, TP);
 290   }
 291   case SDTCisVec: {
 292     // If there is only one vector type supported, this must be it.
 293     std::vector<MVT::SimpleValueType> VecVTs =
 294       FilterVTs(CGT.getLegalValueTypes(), isVector);
 295
 296     // If we found exactly one supported vector type, apply it.
 297     if (VecVTs.size() == 1)
 298       return NodeToApply->UpdateNodeType(VecVTs[0], TP);
 299     return NodeToApply->UpdateNodeType(MVT::vAny, TP);
 300   }
 301   case SDTCisSameAs: {
 302     TreePatternNode *OtherNode =
 303       getOperandNum(x.SDTCisSameAs_Info.OtherOperandNum, N, NumResults);
 304     return NodeToApply->UpdateNodeType(OtherNode->getExtTypes(), TP) |
 305            OtherNode->UpdateNodeType(NodeToApply->getExtTypes(), TP);
 306   }
 307   case SDTCisVTSmallerThanOp: {
 308     // The NodeToApply must be a leaf node that is a VT.  OtherOperandNum must
 309     // have an integer type that is smaller than the VT.
 310     if (!NodeToApply->isLeaf() ||
 311         !dynamic_cast<DefInit*>(NodeToApply->getLeafValue()) ||
 312         !static_cast<DefInit*>(NodeToApply->getLeafValue())->getDef()
 313                ->isSubClassOf("ValueType"))
 314       TP.error(N->getOperator()->getName() + " expects a VT operand!");
 315     MVT::SimpleValueType VT =
 316      getValueType(static_cast<DefInit*>(NodeToApply->getLeafValue())->getDef());
 317     if (!isInteger(VT))
 318       TP.error(N->getOperator()->getName() + " VT operand must be integer!");
 319
 320     TreePatternNode *OtherNode =
 321       getOperandNum(x.SDTCisVTSmallerThanOp_Info.OtherOperandNum, N,NumResults);
 322
 323     // It must be integer.
 324     bool MadeChange = OtherNode->UpdateNodeType(MVT::iAny, TP);
 325
 326     // This code only handles nodes that have one type set.  Assert here so
 327     // that we can change this if we ever need to deal with multiple value
 328     // types at this point.
 329     assert(OtherNode->getExtTypes().size() == 1 && "Node has too many types!");
 330     if (OtherNode->hasTypeSet() && OtherNode->getTypeNum(0) <= VT)
 331       OtherNode->UpdateNodeType(MVT::Other, TP);  // Throw an error.
 332     return MadeChange;
 333   }
 334   case SDTCisOpSmallerThanOp: {
 335     TreePatternNode *BigOperand =
 336       getOperandNum(x.SDTCisOpSmallerThanOp_Info.BigOperandNum, N, NumResults);
 337
 338     // Both operands must be integer or FP, but we don't care which.
 339     bool MadeChange = false;
 340
 341     // This code does not currently handle nodes which have multiple types,
 342     // where some types are integer, and some are fp.  Assert that this is not
 343     // the case.
 344     assert(!(EEVT::isExtIntegerInVTs(NodeToApply->getExtTypes()) &&
 345              EEVT::isExtFloatingPointInVTs(NodeToApply->getExtTypes())) &&
 346            !(EEVT::isExtIntegerInVTs(BigOperand->getExtTypes()) &&
 347              EEVT::isExtFloatingPointInVTs(BigOperand->getExtTypes())) &&
 348            "SDTCisOpSmallerThanOp does not handle mixed int/fp types!");
 349     if (EEVT::isExtIntegerInVTs(NodeToApply->getExtTypes()))
 350       MadeChange |= BigOperand->UpdateNodeType(MVT::iAny, TP);
 351     else if (EEVT::isExtFloatingPointInVTs(NodeToApply->getExtTypes()))
 352       MadeChange |= BigOperand->UpdateNodeType(MVT::fAny, TP);
 353     if (EEVT::isExtIntegerInVTs(BigOperand->getExtTypes()))
 354       MadeChange |= NodeToApply->UpdateNodeType(MVT::iAny, TP);
 355     else if (EEVT::isExtFloatingPointInVTs(BigOperand->getExtTypes()))
 356       MadeChange |= NodeToApply->UpdateNodeType(MVT::fAny, TP);
 357
 358     std::vector<MVT::SimpleValueType> VTs = CGT.getLegalValueTypes();
 359
 360     if (EEVT::isExtIntegerInVTs(NodeToApply->getExtTypes())) {
 361       VTs = FilterVTs(VTs, isInteger);
 362     } else if (EEVT::isExtFloatingPointInVTs(NodeToApply->getExtTypes())) {
 363       VTs = FilterVTs(VTs, isFloatingPoint);
 364     } else {
 365       VTs.clear();
 366     }
 367
 368     switch (VTs.size()) {
 369     default:         // Too many VT's to pick from.
 370     case 0: break;   // No info yet.
 371     case 1:
 372       // Only one VT of this flavor.  Cannot ever satisfy the constraints.
 373       return NodeToApply->UpdateNodeType(MVT::Other, TP);  // throw
 374     case 2:
 375       // If we have exactly two possible types, the little operand must be the
 376       // small one, the big operand should be the big one.  Common with
 377       // float/double for example.
 378       assert(VTs[0] < VTs[1] && "Should be sorted!");
 379       MadeChange |= NodeToApply->UpdateNodeType(VTs[0], TP);
 380       MadeChange |= BigOperand->UpdateNodeType(VTs[1], TP);
 381       break;
 382     }
 383     return MadeChange;
 384   }
 385   case SDTCisEltOfVec: {
 386     TreePatternNode *OtherOperand =
 387       getOperandNum(x.SDTCisEltOfVec_Info.OtherOperandNum,
 388                     N, NumResults);
 389     if (OtherOperand->hasTypeSet()) {
 390       if (!isVector(OtherOperand->getTypeNum(0)))
 391         TP.error(N->getOperator()->getName() + " VT operand must be a vector!");
 392       EVT IVT = OtherOperand->getTypeNum(0);
 393       IVT = IVT.getVectorElementType();
 394       return NodeToApply->UpdateNodeType(IVT.getSimpleVT().SimpleTy, TP);
 395     }
 396     return false;
 397   }
 398   }
 399   return false;
 400 }
 401
 402 //===----------------------------------------------------------------------===//
 403 // SDNodeInfo implementation
 404 //
 405 SDNodeInfo::SDNodeInfo(Record *R) : Def(R) {
 406   EnumName    = R->getValueAsString("Opcode");
 407   SDClassName = R->getValueAsString("SDClass");
 408   Record *TypeProfile = R->getValueAsDef("TypeProfile");
 409   NumResults = TypeProfile->getValueAsInt("NumResults");
 410   NumOperands = TypeProfile->getValueAsInt("NumOperands");
 411
 412   // Parse the properties.
 413   Properties = 0;
 414   std::vector<Record*> PropList = R->getValueAsListOfDefs("Properties");
 415   for (unsigned i = 0, e = PropList.size(); i != e; ++i) {
 416     if (PropList[i]->getName() == "SDNPCommutative") {
 417       Properties |= 1 << SDNPCommutative;
 418     } else if (PropList[i]->getName() == "SDNPAssociative") {
 419       Properties |= 1 << SDNPAssociative;
 420     } else if (PropList[i]->getName() == "SDNPHasChain") {
 421       Properties |= 1 << SDNPHasChain;
 422     } else if (PropList[i]->getName() == "SDNPOutFlag") {
 423       Properties |= 1 << SDNPOutFlag;
 424     } else if (PropList[i]->getName() == "SDNPInFlag") {
 425       Properties |= 1 << SDNPInFlag;
 426     } else if (PropList[i]->getName() == "SDNPOptInFlag") {
 427       Properties |= 1 << SDNPOptInFlag;
 428     } else if (PropList[i]->getName() == "SDNPMayStore") {
 429       Properties |= 1 << SDNPMayStore;
 430     } else if (PropList[i]->getName() == "SDNPMayLoad") {
 431       Properties |= 1 << SDNPMayLoad;
 432     } else if (PropList[i]->getName() == "SDNPSideEffect") {
 433       Properties |= 1 << SDNPSideEffect;
 434     } else if (PropList[i]->getName() == "SDNPMemOperand") {
 435       Properties |= 1 << SDNPMemOperand;
 436     } else {
 437       errs() << "Unknown SD Node property '" << PropList[i]->getName()
 438              << "' on node '" << R->getName() << "'!\n";
 439       exit(1);
 440     }
 441   }
 442
 443
 444   // Parse the type constraints.
 445   std::vector<Record*> ConstraintList =
 446     TypeProfile->getValueAsListOfDefs("Constraints");
 447   TypeConstraints.assign(ConstraintList.begin(), ConstraintList.end());
 448 }
 449
 450 //===----------------------------------------------------------------------===//
 451 // TreePatternNode implementation
 452 //
 453
 454 TreePatternNode::~TreePatternNode() {
 455 #if 0 // FIXME: implement refcounted tree nodes!
 456   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
 457     delete getChild(i);
 458 #endif
 459 }
 460
 461 /// UpdateNodeType - Set the node type of N to VT if VT contains
 462 /// information.  If N already contains a conflicting type, then throw an
 463 /// exception.  This returns true if any information was updated.
 464 ///
 465 bool TreePatternNode::UpdateNodeType(const std::vector<unsigned char> &ExtVTs,
 466                                      TreePattern &TP) {
 467   assert(!ExtVTs.empty() && "Cannot update node type with empty type vector!");
 468
 469   if (ExtVTs[0] == EEVT::isUnknown || LHSIsSubsetOfRHS(getExtTypes(), ExtVTs))
 470     return false;
 471   if (isTypeCompletelyUnknown() || LHSIsSubsetOfRHS(ExtVTs, getExtTypes())) {
 472     setTypes(ExtVTs);
 473     return true;
 474   }
 475
 476   if (getExtTypeNum(0) == MVT::iPTR || getExtTypeNum(0) == MVT::iPTRAny) {
 477     if (ExtVTs[0] == MVT::iPTR || ExtVTs[0] == MVT::iPTRAny ||
 478         ExtVTs[0] == MVT::iAny)
 479       return false;
 480     if (EEVT::isExtIntegerInVTs(ExtVTs)) {
 481       std::vector<unsigned char> FVTs = FilterEVTs(ExtVTs, isInteger);
 482       if (FVTs.size()) {
 483         setTypes(ExtVTs);
 484         return true;
 485       }
 486     }
 487   }
 488
 489   // Merge vAny with iAny/fAny.  The latter include vector types so keep them
 490   // as the more specific information.
 491   if (ExtVTs[0] == MVT::vAny &&
 492       (getExtTypeNum(0) == MVT::iAny || getExtTypeNum(0) == MVT::fAny))
 493     return false;
 494   if (getExtTypeNum(0) == MVT::vAny &&
 495       (ExtVTs[0] == MVT::iAny || ExtVTs[0] == MVT::fAny)) {
 496     setTypes(ExtVTs);
 497     return true;
 498   }
 499
 500   if (ExtVTs[0] == MVT::iAny &&
 501       EEVT::isExtIntegerInVTs(getExtTypes())) {
 502     assert(hasTypeSet() && "should be handled above!");
 503     std::vector<unsigned char> FVTs = FilterEVTs(getExtTypes(), isInteger);
 504     if (getExtTypes() == FVTs)
 505       return false;
 506     setTypes(FVTs);
 507     return true;
 508   }
 509   if ((ExtVTs[0] == MVT::iPTR || ExtVTs[0] == MVT::iPTRAny) &&
 510       EEVT::isExtIntegerInVTs(getExtTypes())) {
 511     //assert(hasTypeSet() && "should be handled above!");
 512     std::vector<unsigned char> FVTs = FilterEVTs(getExtTypes(), isInteger);
 513     if (getExtTypes() == FVTs)
 514       return false;
 515     if (FVTs.size()) {
 516       setTypes(FVTs);
 517       return true;
 518     }
 519   }
 520   if (ExtVTs[0] == MVT::fAny &&
 521       EEVT::isExtFloatingPointInVTs(getExtTypes())) {
 522     assert(hasTypeSet() && "should be handled above!");
 523     std::vector<unsigned char> FVTs =
 524       FilterEVTs(getExtTypes(), isFloatingPoint);
 525     if (getExtTypes() == FVTs)
 526       return false;
 527     setTypes(FVTs);
 528     return true;
 529   }
 530   if (ExtVTs[0] == MVT::vAny &&
 531       EEVT::isExtVectorInVTs(getExtTypes())) {
 532     assert(hasTypeSet() && "should be handled above!");
 533     std::vector<unsigned char> FVTs = FilterEVTs(getExtTypes(), isVector);
 534     if (getExtTypes() == FVTs)
 535       return false;
 536     setTypes(FVTs);
 537     return true;
 538   }
 539
 540   // If we know this is an int, FP, or vector type, and we are told it is a
 541   // specific one, take the advice.
 542   //
 543   // Similarly, we should probably set the type here to the intersection of
 544   // {iAny|fAny|vAny} and ExtVTs
 545   if ((getExtTypeNum(0) == MVT::iAny &&
 546        EEVT::isExtIntegerInVTs(ExtVTs)) ||
 547       (getExtTypeNum(0) == MVT::fAny &&
 548        EEVT::isExtFloatingPointInVTs(ExtVTs)) ||
 549       (getExtTypeNum(0) == MVT::vAny &&
 550        EEVT::isExtVectorInVTs(ExtVTs))) {
 551     setTypes(ExtVTs);
 552     return true;
 553   }
 554   if (getExtTypeNum(0) == MVT::iAny &&
 555       (ExtVTs[0] == MVT::iPTR || ExtVTs[0] == MVT::iPTRAny)) {
 556     setTypes(ExtVTs);
 557     return true;
 558   }
 559
 560   if (isLeaf()) {
 561     dump();
 562     errs() << " ";
 563     TP.error("Type inference contradiction found in node!");
 564   } else {
 565     TP.error("Type inference contradiction found in node " +
 566              getOperator()->getName() + "!");
 567   }
 568   return true; // unreachable
 569 }
 570
 571
 572 void TreePatternNode::print(raw_ostream &OS) const {
 573   if (isLeaf()) {
 574     OS << *getLeafValue();
 575   } else {
 576     OS << "(" << getOperator()->getName();
 577   }
 578
 579   // FIXME: At some point we should handle printing all the value types for
 580   // nodes that are multiply typed.
 581   switch (getExtTypeNum(0)) {
 582   case MVT::Other: OS << ":Other"; break;
 583   case MVT::iAny: OS << ":iAny"; break;
 584   case MVT::fAny : OS << ":fAny"; break;
 585   case MVT::vAny: OS << ":vAny"; break;
 586   case EEVT::isUnknown: ; /*OS << ":?";*/ break;
 587   case MVT::iPTR:  OS << ":iPTR"; break;
 588   case MVT::iPTRAny:  OS << ":iPTRAny"; break;
 589   default: {
 590     std::string VTName = llvm::getName(getTypeNum(0));
 591     // Strip off EVT:: prefix if present.
 592     if (VTName.substr(0,5) == "MVT::")
 593       VTName = VTName.substr(5);
 594     OS << ":" << VTName;
 595     break;
 596   }
 597   }
 598
 599   if (!isLeaf()) {
 600     if (getNumChildren() != 0) {
 601       OS << " ";
 602       getChild(0)->print(OS);
 603       for (unsigned i = 1, e = getNumChildren(); i != e; ++i) {
 604         OS << ", ";
 605         getChild(i)->print(OS);
 606       }
 607     }
 608     OS << ")";
 609   }
 610
 611   for (unsigned i = 0, e = PredicateFns.size(); i != e; ++i)
 612     OS << "<<P:" << PredicateFns[i] << ">>";
 613   if (TransformFn)
 614     OS << "<<X:" << TransformFn->getName() << ">>";
 615   if (!getName().empty())
 616     OS << ":$" << getName();
 617
 618 }
 619 void TreePatternNode::dump() const {
 620   print(errs());
 621 }
 622
 623 /// isIsomorphicTo - Return true if this node is recursively
 624 /// isomorphic to the specified node.  For this comparison, the node's
 625 /// entire state is considered. The assigned name is ignored, since
 626 /// nodes with differing names are considered isomorphic. However, if
 627 /// the assigned name is present in the dependent variable set, then
 628 /// the assigned name is considered significant and the node is
 629 /// isomorphic if the names match.
 630 bool TreePatternNode::isIsomorphicTo(const TreePatternNode *N,
 631                                      const MultipleUseVarSet &DepVars) const {
 632   if (N == this) return true;
 633   if (N->isLeaf() != isLeaf() || getExtTypes() != N->getExtTypes() ||
 634       getPredicateFns() != N->getPredicateFns() ||
 635       getTransformFn() != N->getTransformFn())
 636     return false;
 637
 638   if (isLeaf()) {
 639     if (DefInit *DI = dynamic_cast<DefInit*>(getLeafValue())) {
 640       if (DefInit *NDI = dynamic_cast<DefInit*>(N->getLeafValue())) {
 641         return ((DI->getDef() == NDI->getDef())
 642                 && (DepVars.find(getName()) == DepVars.end()
 643                     || getName() == N->getName()));
 644       }
 645     }
 646     return getLeafValue() == N->getLeafValue();
 647   }
 648
 649   if (N->getOperator() != getOperator() ||
 650       N->getNumChildren() != getNumChildren()) return false;
 651   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
 652     if (!getChild(i)->isIsomorphicTo(N->getChild(i), DepVars))
 653       return false;
 654   return true;
 655 }
 656
 657 /// clone - Make a copy of this tree and all of its children.
 658 ///
 659 TreePatternNode *TreePatternNode::clone() const {
 660   TreePatternNode *New;
 661   if (isLeaf()) {
 662     New = new TreePatternNode(getLeafValue());
 663   } else {
 664     std::vector<TreePatternNode*> CChildren;
 665     CChildren.reserve(Children.size());
 666     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
 667       CChildren.push_back(getChild(i)->clone());
 668     New = new TreePatternNode(getOperator(), CChildren);
 669   }
 670   New->setName(getName());
 671   New->setTypes(getExtTypes());
 672   New->setPredicateFns(getPredicateFns());
 673   New->setTransformFn(getTransformFn());
 674   return New;
 675 }
 676
 677 /// SubstituteFormalArguments - Replace the formal arguments in this tree
 678 /// with actual values specified by ArgMap.
 679 void TreePatternNode::
 680 SubstituteFormalArguments(std::map<std::string, TreePatternNode*> &ArgMap) {
 681   if (isLeaf()) return;
 682
 683   for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
 684     TreePatternNode *Child = getChild(i);
 685     if (Child->isLeaf()) {
 686       Init *Val = Child->getLeafValue();
 687       if (dynamic_cast<DefInit*>(Val) &&
 688           static_cast<DefInit*>(Val)->getDef()->getName() == "node") {
 689         // We found a use of a formal argument, replace it with its value.
 690         TreePatternNode *NewChild = ArgMap[Child->getName()];
 691         assert(NewChild && "Couldn't find formal argument!");
 692         assert((Child->getPredicateFns().empty() ||
 693                 NewChild->getPredicateFns() == Child->getPredicateFns()) &&
 694                "Non-empty child predicate clobbered!");
 695         setChild(i, NewChild);
 696       }
 697     } else {
 698       getChild(i)->SubstituteFormalArguments(ArgMap);
 699     }
 700   }
 701 }
 702
 703
 704 /// InlinePatternFragments - If this pattern refers to any pattern
 705 /// fragments, inline them into place, giving us a pattern without any
 706 /// PatFrag references.
 707 TreePatternNode *TreePatternNode::InlinePatternFragments(TreePattern &TP) {
 708   if (isLeaf()) return this;  // nothing to do.
 709   Record *Op = getOperator();
 710
 711   if (!Op->isSubClassOf("PatFrag")) {
 712     // Just recursively inline children nodes.
 713     for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
 714       TreePatternNode *Child = getChild(i);
 715       TreePatternNode *NewChild = Child->InlinePatternFragments(TP);
 716
 717       assert((Child->getPredicateFns().empty() ||
 718               NewChild->getPredicateFns() == Child->getPredicateFns()) &&
 719              "Non-empty child predicate clobbered!");
 720
 721       setChild(i, NewChild);
 722     }
 723     return this;
 724   }
 725
 726   // Otherwise, we found a reference to a fragment.  First, look up its
 727   // TreePattern record.
 728   TreePattern *Frag = TP.getDAGPatterns().getPatternFragment(Op);
 729
 730   // Verify that we are passing the right number of operands.
 731   if (Frag->getNumArgs() != Children.size())
 732     TP.error("'" + Op->getName() + "' fragment requires " +
 733              utostr(Frag->getNumArgs()) + " operands!");
 734
 735   TreePatternNode *FragTree = Frag->getOnlyTree()->clone();
 736
 737   std::string Code = Op->getValueAsCode("Predicate");
 738   if (!Code.empty())
 739     FragTree->addPredicateFn("Predicate_"+Op->getName());
 740
 741   // Resolve formal arguments to their actual value.
 742   if (Frag->getNumArgs()) {
 743     // Compute the map of formal to actual arguments.
 744     std::map<std::string, TreePatternNode*> ArgMap;
 745     for (unsigned i = 0, e = Frag->getNumArgs(); i != e; ++i)
 746       ArgMap[Frag->getArgName(i)] = getChild(i)->InlinePatternFragments(TP);
 747
 748     FragTree->SubstituteFormalArguments(ArgMap);
 749   }
 750
 751   FragTree->setName(getName());
 752   FragTree->UpdateNodeType(getExtTypes(), TP);
 753
 754   // Transfer in the old predicates.
 755   for (unsigned i = 0, e = getPredicateFns().size(); i != e; ++i)
 756     FragTree->addPredicateFn(getPredicateFns()[i]);
 757
 758   // Get a new copy of this fragment to stitch into here.
 759   //delete this;    // FIXME: implement refcounting!
 760
 761   // The fragment we inlined could have recursive inlining that is needed.  See
 762   // if there are any pattern fragments in it and inline them as needed.
 763   return FragTree->InlinePatternFragments(TP);
 764 }
 765
 766 /// getImplicitType - Check to see if the specified record has an implicit
 767 /// type which should be applied to it.  This will infer the type of register
 768 /// references from the register file information, for example.
 769 ///
 770 static std::vector<unsigned char> getImplicitType(Record *R, bool NotRegisters,
 771                                                   TreePattern &TP) {
 772   // Some common return values
 773   std::vector<unsigned char> Unknown(1, EEVT::isUnknown);
 774   std::vector<unsigned char> Other(1, MVT::Other);
 775
 776   // Check to see if this is a register or a register class...
 777   if (R->isSubClassOf("RegisterClass")) {
 778     if (NotRegisters)
 779       return Unknown;
 780     const CodeGenRegisterClass &RC =
 781       TP.getDAGPatterns().getTargetInfo().getRegisterClass(R);
 782     return ConvertVTs(RC.getValueTypes());
 783   } else if (R->isSubClassOf("PatFrag")) {
 784     // Pattern fragment types will be resolved when they are inlined.
 785     return Unknown;
 786   } else if (R->isSubClassOf("Register")) {
 787     if (NotRegisters)
 788       return Unknown;
 789     const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
 790     return T.getRegisterVTs(R);
 791   } else if (R->isSubClassOf("ValueType") || R->isSubClassOf("CondCode")) {
 792     // Using a VTSDNode or CondCodeSDNode.
 793     return Other;
 794   } else if (R->isSubClassOf("ComplexPattern")) {
 795     if (NotRegisters)
 796       return Unknown;
 797     std::vector<unsigned char>
 798     ComplexPat(1, TP.getDAGPatterns().getComplexPattern(R).getValueType());
 799     return ComplexPat;
 800   } else if (R->isSubClassOf("PointerLikeRegClass")) {
 801     Other[0] = MVT::iPTR;
 802     return Other;
 803   } else if (R->getName() == "node" || R->getName() == "srcvalue" ||
 804              R->getName() == "zero_reg") {
 805     // Placeholder.
 806     return Unknown;
 807   }
 808
 809   TP.error("Unknown node flavor used in pattern: " + R->getName());
 810   return Other;
 811 }
 812
 813
 814 /// getIntrinsicInfo - If this node corresponds to an intrinsic, return the
 815 /// CodeGenIntrinsic information for it, otherwise return a null pointer.
 816 const CodeGenIntrinsic *TreePatternNode::
 817 getIntrinsicInfo(const CodeGenDAGPatterns &CDP) const {
 818   if (getOperator() != CDP.get_intrinsic_void_sdnode() &&
 819       getOperator() != CDP.get_intrinsic_w_chain_sdnode() &&
 820       getOperator() != CDP.get_intrinsic_wo_chain_sdnode())
 821     return 0;
 822
 823   unsigned IID =
 824     dynamic_cast<IntInit*>(getChild(0)->getLeafValue())->getValue();
 825   return &CDP.getIntrinsicInfo(IID);
 826 }
 827
 828 /// isCommutativeIntrinsic - Return true if the node corresponds to a
 829 /// commutative intrinsic.
 830 bool
 831 TreePatternNode::isCommutativeIntrinsic(const CodeGenDAGPatterns &CDP) const {
 832   if (const CodeGenIntrinsic *Int = getIntrinsicInfo(CDP))
 833     return Int->isCommutative;
 834   return false;
 835 }
 836
 837
 838 /// ApplyTypeConstraints - Apply all of the type constraints relevant to
 839 /// this node and its children in the tree.  This returns true if it makes a
 840 /// change, false otherwise.  If a type contradiction is found, throw an
 841 /// exception.
 842 bool TreePatternNode::ApplyTypeConstraints(TreePattern &TP, bool NotRegisters) {
 843   CodeGenDAGPatterns &CDP = TP.getDAGPatterns();
 844   if (isLeaf()) {
 845     if (DefInit *DI = dynamic_cast<DefInit*>(getLeafValue())) {
 846       // If it's a regclass or something else known, include the type.
 847       return UpdateNodeType(getImplicitType(DI->getDef(), NotRegisters, TP),TP);
 848     }
 849
 850     if (IntInit *II = dynamic_cast<IntInit*>(getLeafValue())) {
 851       // Int inits are always integers. :)
 852       bool MadeChange = UpdateNodeType(MVT::iAny, TP);
 853
 854       if (hasTypeSet()) {
 855         // At some point, it may make sense for this tree pattern to have
 856         // multiple types.  Assert here that it does not, so we revisit this
 857         // code when appropriate.
 858         assert(getExtTypes().size() >= 1 && "TreePattern doesn't have a type!");
 859         MVT::SimpleValueType VT = getTypeNum(0);
 860         for (unsigned i = 1, e = getExtTypes().size(); i != e; ++i)
 861           assert(getTypeNum(i) == VT && "TreePattern has too many types!");
 862
 863         VT = getTypeNum(0);
 864         if (VT != MVT::iPTR && VT != MVT::iPTRAny) {
 865           unsigned Size = EVT(VT).getSizeInBits();
 866           // Make sure that the value is representable for this type.
 867           if (Size < 32) {
 868             int Val = (II->getValue() << (32-Size)) >> (32-Size);
 869             if (Val != II->getValue()) {
 870               // If sign-extended doesn't fit, does it fit as unsigned?
 871               unsigned ValueMask;
 872               unsigned UnsignedVal;
 873               ValueMask = unsigned(~uint32_t(0UL) >> (32-Size));
 874               UnsignedVal = unsigned(II->getValue());
 875
 876               if ((ValueMask & UnsignedVal) != UnsignedVal) {
 877                 TP.error("Integer value '" + itostr(II->getValue())+
 878                          "' is out of range for type '" +
 879                          getEnumName(getTypeNum(0)) + "'!");
 880               }
 881             }
 882           }
 883         }
 884       }
 885
 886       return MadeChange;
 887     }
 888     return false;
 889   }
 890
 891   // special handling for set, which isn't really an SDNode.
 892   if (getOperator()->getName() == "set") {
 893     assert (getNumChildren() >= 2 && "Missing RHS of a set?");
 894     unsigned NC = getNumChildren();
 895     bool MadeChange = false;
 896     for (unsigned i = 0; i < NC-1; ++i) {
 897       MadeChange = getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
 898       MadeChange |= getChild(NC-1)->ApplyTypeConstraints(TP, NotRegisters);
 899
 900       // Types of operands must match.
 901       MadeChange |= getChild(i)->UpdateNodeType(getChild(NC-1)->getExtTypes(),
 902                                                 TP);
 903       MadeChange |= getChild(NC-1)->UpdateNodeType(getChild(i)->getExtTypes(),
 904                                                    TP);
 905       MadeChange |= UpdateNodeType(MVT::isVoid, TP);
 906     }
 907     return MadeChange;
 908   } else if (getOperator()->getName() == "implicit" ||
 909              getOperator()->getName() == "parallel") {
 910     bool MadeChange = false;
 911     for (unsigned i = 0; i < getNumChildren(); ++i)
 912       MadeChange = getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
 913     MadeChange |= UpdateNodeType(MVT::isVoid, TP);
 914     return MadeChange;
 915   } else if (getOperator()->getName() == "COPY_TO_REGCLASS") {
 916     bool MadeChange = false;
 917     MadeChange |= getChild(0)->ApplyTypeConstraints(TP, NotRegisters);
 918     MadeChange |= getChild(1)->ApplyTypeConstraints(TP, NotRegisters);
 919     return MadeChange;
 920   } else if (const CodeGenIntrinsic *Int = getIntrinsicInfo(CDP)) {
 921     bool MadeChange = false;
 922
 923     // Apply the result type to the node.
 924     unsigned NumRetVTs = Int->IS.RetVTs.size();
 925     unsigned NumParamVTs = Int->IS.ParamVTs.size();
 926
 927     for (unsigned i = 0, e = NumRetVTs; i != e; ++i)
 928       MadeChange |= UpdateNodeType(Int->IS.RetVTs[i], TP);
 929
 930     if (getNumChildren() != NumParamVTs + NumRetVTs)
 931       TP.error("Intrinsic '" + Int->Name + "' expects " +
 932                utostr(NumParamVTs + NumRetVTs - 1) + " operands, not " +
 933                utostr(getNumChildren() - 1) + " operands!");
 934
 935     // Apply type info to the intrinsic ID.
 936     MadeChange |= getChild(0)->UpdateNodeType(MVT::iPTR, TP);
 937
 938     for (unsigned i = NumRetVTs, e = getNumChildren(); i != e; ++i) {
 939       MVT::SimpleValueType OpVT = Int->IS.ParamVTs[i - NumRetVTs];
 940       MadeChange |= getChild(i)->UpdateNodeType(OpVT, TP);
 941       MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
 942     }
 943     return MadeChange;
 944   } else if (getOperator()->isSubClassOf("SDNode")) {
 945     const SDNodeInfo &NI = CDP.getSDNodeInfo(getOperator());
 946
 947     bool MadeChange = NI.ApplyTypeConstraints(this, TP);
 948     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
 949       MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
 950     // Branch, etc. do not produce results and top-level forms in instr pattern
 951     // must have void types.
 952     if (NI.getNumResults() == 0)
 953       MadeChange |= UpdateNodeType(MVT::isVoid, TP);
 954
 955     return MadeChange;
 956   } else if (getOperator()->isSubClassOf("Instruction")) {
 957     const DAGInstruction &Inst = CDP.getInstruction(getOperator());
 958     bool MadeChange = false;
 959     unsigned NumResults = Inst.getNumResults();
 960
 961     assert(NumResults <= 1 &&
 962            "Only supports zero or one result instrs!");
 963
 964     CodeGenInstruction &InstInfo =
 965       CDP.getTargetInfo().getInstruction(getOperator()->getName());
 966     // Apply the result type to the node
 967     if (NumResults == 0 || InstInfo.NumDefs == 0) {
 968       MadeChange = UpdateNodeType(MVT::isVoid, TP);
 969     } else {
 970       Record *ResultNode = Inst.getResult(0);
 971
 972       if (ResultNode->isSubClassOf("PointerLikeRegClass")) {
 973         std::vector<unsigned char> VT;
 974         VT.push_back(MVT::iPTR);
 975         MadeChange = UpdateNodeType(VT, TP);
 976       } else if (ResultNode->getName() == "unknown") {
 977         std::vector<unsigned char> VT;
 978         VT.push_back(EEVT::isUnknown);
 979         MadeChange = UpdateNodeType(VT, TP);
 980       } else {
 981         assert(ResultNode->isSubClassOf("RegisterClass") &&
 982                "Operands should be register classes!");
 983
 984         const CodeGenRegisterClass &RC =
 985           CDP.getTargetInfo().getRegisterClass(ResultNode);
 986         MadeChange = UpdateNodeType(ConvertVTs(RC.getValueTypes()), TP);
 987       }
 988     }
 989
 990     unsigned ChildNo = 0;
 991     for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i) {
 992       Record *OperandNode = Inst.getOperand(i);
 993
 994       // If the instruction expects a predicate or optional def operand, we
 995       // codegen this by setting the operand to it's default value if it has a
 996       // non-empty DefaultOps field.
 997       if ((OperandNode->isSubClassOf("PredicateOperand") ||
 998            OperandNode->isSubClassOf("OptionalDefOperand")) &&
 999           !CDP.getDefaultOperand(OperandNode).DefaultOps.empty())
1000         continue;
1001
1002       // Verify that we didn't run out of provided operands.
1003       if (ChildNo >= getNumChildren())
1004         TP.error("Instruction '" + getOperator()->getName() +
1005                  "' expects more operands than were provided.");
1006
1007       MVT::SimpleValueType VT;
1008       TreePatternNode *Child = getChild(ChildNo++);
1009       if (OperandNode->isSubClassOf("RegisterClass")) {
1010         const CodeGenRegisterClass &RC =
1011           CDP.getTargetInfo().getRegisterClass(OperandNode);
1012         MadeChange |= Child->UpdateNodeType(ConvertVTs(RC.getValueTypes()), TP);
1013       } else if (OperandNode->isSubClassOf("Operand")) {
1014         VT = getValueType(OperandNode->getValueAsDef("Type"));
1015         MadeChange |= Child->UpdateNodeType(VT, TP);
1016       } else if (OperandNode->isSubClassOf("PointerLikeRegClass")) {
1017         MadeChange |= Child->UpdateNodeType(MVT::iPTR, TP);
1018       } else if (OperandNode->getName() == "unknown") {
1019         MadeChange |= Child->UpdateNodeType(EEVT::isUnknown, TP);
1020       } else {
1021         assert(0 && "Unknown operand type!");
1022         abort();
1023       }
1024       MadeChange |= Child->ApplyTypeConstraints(TP, NotRegisters);
1025     }
1026
1027     if (ChildNo != getNumChildren())
1028       TP.error("Instruction '" + getOperator()->getName() +
1029                "' was provided too many operands!");
1030
1031     return MadeChange;
1032   } else {
1033     assert(getOperator()->isSubClassOf("SDNodeXForm") && "Unknown node type!");
1034
1035     // Node transforms always take one operand.
1036     if (getNumChildren() != 1)
1037       TP.error("Node transform '" + getOperator()->getName() +
1038                "' requires one operand!");
1039
1040     // If either the output or input of the xform does not have exact
1041     // type info. We assume they must be the same. Otherwise, it is perfectly
1042     // legal to transform from one type to a completely different type.
1043     if (!hasTypeSet() || !getChild(0)->hasTypeSet()) {
1044       bool MadeChange = UpdateNodeType(getChild(0)->getExtTypes(), TP);
1045       MadeChange |= getChild(0)->UpdateNodeType(getExtTypes(), TP);
1046       return MadeChange;
1047     }
1048     return false;
1049   }
1050 }
1051
1052 /// OnlyOnRHSOfCommutative - Return true if this value is only allowed on the
1053 /// RHS of a commutative operation, not the on LHS.
1054 static bool OnlyOnRHSOfCommutative(TreePatternNode *N) {
1055   if (!N->isLeaf() && N->getOperator()->getName() == "imm")
1056     return true;
1057   if (N->isLeaf() && dynamic_cast<IntInit*>(N->getLeafValue()))
1058     return true;
1059   return false;
1060 }
1061
1062
1063 /// canPatternMatch - If it is impossible for this pattern to match on this
1064 /// target, fill in Reason and return false.  Otherwise, return true.  This is
1065 /// used as a sanity check for .td files (to prevent people from writing stuff
1066 /// that can never possibly work), and to prevent the pattern permuter from
1067 /// generating stuff that is useless.
1068 bool TreePatternNode::canPatternMatch(std::string &Reason,
1069                                       const CodeGenDAGPatterns &CDP) {
1070   if (isLeaf()) return true;
1071
1072   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1073     if (!getChild(i)->canPatternMatch(Reason, CDP))
1074       return false;
1075
1076   // If this is an intrinsic, handle cases that would make it not match.  For
1077   // example, if an operand is required to be an immediate.
1078   if (getOperator()->isSubClassOf("Intrinsic")) {
1079     // TODO:
1080     return true;
1081   }
1082
1083   // If this node is a commutative operator, check that the LHS isn't an
1084   // immediate.
1085   const SDNodeInfo &NodeInfo = CDP.getSDNodeInfo(getOperator());
1086   bool isCommIntrinsic = isCommutativeIntrinsic(CDP);
1087   if (NodeInfo.hasProperty(SDNPCommutative) || isCommIntrinsic) {
1088     // Scan all of the operands of the node and make sure that only the last one
1089     // is a constant node, unless the RHS also is.
1090     if (!OnlyOnRHSOfCommutative(getChild(getNumChildren()-1))) {
1091       bool Skip = isCommIntrinsic ? 1 : 0; // First operand is intrinsic id.
1092       for (unsigned i = Skip, e = getNumChildren()-1; i != e; ++i)
1093         if (OnlyOnRHSOfCommutative(getChild(i))) {
1094           Reason="Immediate value must be on the RHS of commutative operators!";
1095           return false;
1096         }
1097     }
1098   }
1099
1100   return true;
1101 }
1102
1103 //===----------------------------------------------------------------------===//
1104 // TreePattern implementation
1105 //
1106
1107 TreePattern::TreePattern(Record *TheRec, ListInit *RawPat, bool isInput,
1108                          CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp){
1109    isInputPattern = isInput;
1110    for (unsigned i = 0, e = RawPat->getSize(); i != e; ++i)
1111      Trees.push_back(ParseTreePattern((DagInit*)RawPat->getElement(i)));
1112 }
1113
1114 TreePattern::TreePattern(Record *TheRec, DagInit *Pat, bool isInput,
1115                          CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp){
1116   isInputPattern = isInput;
1117   Trees.push_back(ParseTreePattern(Pat));
1118 }
1119
1120 TreePattern::TreePattern(Record *TheRec, TreePatternNode *Pat, bool isInput,
1121                          CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp){
1122   isInputPattern = isInput;
1123   Trees.push_back(Pat);
1124 }
1125
1126
1127
1128 void TreePattern::error(const std::string &Msg) const {
1129   dump();
1130   throw TGError(TheRecord->getLoc(), "In " + TheRecord->getName() + ": " + Msg);
1131 }
1132
1133 TreePatternNode *TreePattern::ParseTreePattern(DagInit *Dag) {
1134   DefInit *OpDef = dynamic_cast<DefInit*>(Dag->getOperator());
1135   if (!OpDef) error("Pattern has unexpected operator type!");
1136   Record *Operator = OpDef->getDef();
1137
1138   if (Operator->isSubClassOf("ValueType")) {
1139     // If the operator is a ValueType, then this must be "type cast" of a leaf
1140     // node.
1141     if (Dag->getNumArgs() != 1)
1142       error("Type cast only takes one operand!");
1143
1144     Init *Arg = Dag->getArg(0);
1145     TreePatternNode *New;
1146     if (DefInit *DI = dynamic_cast<DefInit*>(Arg)) {
1147       Record *R = DI->getDef();
1148       if (R->isSubClassOf("SDNode") || R->isSubClassOf("PatFrag")) {
1149         Dag->setArg(0, new DagInit(DI, "",
1150                                 std::vector<std::pair<Init*, std::string> >()));
1151         return ParseTreePattern(Dag);
1152       }
1153       New = new TreePatternNode(DI);
1154     } else if (DagInit *DI = dynamic_cast<DagInit*>(Arg)) {
1155       New = ParseTreePattern(DI);
1156     } else if (IntInit *II = dynamic_cast<IntInit*>(Arg)) {
1157       New = new TreePatternNode(II);
1158       if (!Dag->getArgName(0).empty())
1159         error("Constant int argument should not have a name!");
1160     } else if (BitsInit *BI = dynamic_cast<BitsInit*>(Arg)) {
1161       // Turn this into an IntInit.
1162       Init *II = BI->convertInitializerTo(new IntRecTy());
1163       if (II == 0 || !dynamic_cast<IntInit*>(II))
1164         error("Bits value must be constants!");
1165
1166       New = new TreePatternNode(dynamic_cast<IntInit*>(II));
1167       if (!Dag->getArgName(0).empty())
1168         error("Constant int argument should not have a name!");
1169     } else {
1170       Arg->dump();
1171       error("Unknown leaf value for tree pattern!");
1172       return 0;
1173     }
1174
1175     // Apply the type cast.
1176     New->UpdateNodeType(getValueType(Operator), *this);
1177     if (New->getNumChildren() == 0)
1178       New->setName(Dag->getArgName(0));
1179     return New;
1180   }
1181
1182   // Verify that this is something that makes sense for an operator.
1183   if (!Operator->isSubClassOf("PatFrag") &&
1184       !Operator->isSubClassOf("SDNode") &&
1185       !Operator->isSubClassOf("Instruction") &&
1186       !Operator->isSubClassOf("SDNodeXForm") &&
1187       !Operator->isSubClassOf("Intrinsic") &&
1188       Operator->getName() != "set" &&
1189       Operator->getName() != "implicit" &&
1190       Operator->getName() != "parallel")
1191     error("Unrecognized node '" + Operator->getName() + "'!");
1192
1193   //  Check to see if this is something that is illegal in an input pattern.
1194   if (isInputPattern && (Operator->isSubClassOf("Instruction") ||
1195                          Operator->isSubClassOf("SDNodeXForm")))
1196     error("Cannot use '" + Operator->getName() + "' in an input pattern!");
1197
1198   std::vector<TreePatternNode*> Children;
1199
1200   for (unsigned i = 0, e = Dag->getNumArgs(); i != e; ++i) {
1201     Init *Arg = Dag->getArg(i);
1202     if (DagInit *DI = dynamic_cast<DagInit*>(Arg)) {
1203       Children.push_back(ParseTreePattern(DI));
1204       if (Children.back()->getName().empty())
1205         Children.back()->setName(Dag->getArgName(i));
1206     } else if (DefInit *DefI = dynamic_cast<DefInit*>(Arg)) {
1207       Record *R = DefI->getDef();
1208       // Direct reference to a leaf DagNode or PatFrag?  Turn it into a
1209       // TreePatternNode if its own.
1210       if (R->isSubClassOf("SDNode") || R->isSubClassOf("PatFrag")) {
1211         Dag->setArg(i, new DagInit(DefI, "",
1212                               std::vector<std::pair<Init*, std::string> >()));
1213         --i;  // Revisit this node...
1214       } else {
1215         TreePatternNode *Node = new TreePatternNode(DefI);
1216         Node->setName(Dag->getArgName(i));
1217         Children.push_back(Node);
1218
1219         // Input argument?
1220         if (R->getName() == "node") {
1221           if (Dag->getArgName(i).empty())
1222             error("'node' argument requires a name to match with operand list");
1223           Args.push_back(Dag->getArgName(i));
1224         }
1225       }
1226     } else if (IntInit *II = dynamic_cast<IntInit*>(Arg)) {
1227       TreePatternNode *Node = new TreePatternNode(II);
1228       if (!Dag->getArgName(i).empty())
1229         error("Constant int argument should not have a name!");
1230       Children.push_back(Node);
1231     } else if (BitsInit *BI = dynamic_cast<BitsInit*>(Arg)) {
1232       // Turn this into an IntInit.
1233       Init *II = BI->convertInitializerTo(new IntRecTy());
1234       if (II == 0 || !dynamic_cast<IntInit*>(II))
1235         error("Bits value must be constants!");
1236
1237       TreePatternNode *Node = new TreePatternNode(dynamic_cast<IntInit*>(II));
1238       if (!Dag->getArgName(i).empty())
1239         error("Constant int argument should not have a name!");
1240       Children.push_back(Node);
1241     } else {
1242       errs() << '"';
1243       Arg->dump();
1244       errs() << "\": ";
1245       error("Unknown leaf value for tree pattern!");
1246     }
1247   }
1248
1249   // If the operator is an intrinsic, then this is just syntactic sugar for for
1250   // (intrinsic_* <number>, ..children..).  Pick the right intrinsic node, and
1251   // convert the intrinsic name to a number.
1252   if (Operator->isSubClassOf("Intrinsic")) {
1253     const CodeGenIntrinsic &Int = getDAGPatterns().getIntrinsic(Operator);
1254     unsigned IID = getDAGPatterns().getIntrinsicID(Operator)+1;
1255
1256     // If this intrinsic returns void, it must have side-effects and thus a
1257     // chain.
1258     if (Int.IS.RetVTs[0] == MVT::isVoid) {
1259       Operator = getDAGPatterns().get_intrinsic_void_sdnode();
1260     } else if (Int.ModRef != CodeGenIntrinsic::NoMem) {
1261       // Has side-effects, requires chain.
1262       Operator = getDAGPatterns().get_intrinsic_w_chain_sdnode();
1263     } else {
1264       // Otherwise, no chain.
1265       Operator = getDAGPatterns().get_intrinsic_wo_chain_sdnode();
1266     }
1267
1268     TreePatternNode *IIDNode = new TreePatternNode(new IntInit(IID));
1269     Children.insert(Children.begin(), IIDNode);
1270   }
1271
1272   TreePatternNode *Result = new TreePatternNode(Operator, Children);
1273   Result->setName(Dag->getName());
1274   return Result;
1275 }
1276
1277 /// InferAllTypes - Infer/propagate as many types throughout the expression
1278 /// patterns as possible.  Return true if all types are inferred, false
1279 /// otherwise.  Throw an exception if a type contradiction is found.
1280 bool TreePattern::InferAllTypes() {
1281   bool MadeChange = true;
1282   while (MadeChange) {
1283     MadeChange = false;
1284     for (unsigned i = 0, e = Trees.size(); i != e; ++i)
1285       MadeChange |= Trees[i]->ApplyTypeConstraints(*this, false);
1286   }
1287
1288   bool HasUnresolvedTypes = false;
1289   for (unsigned i = 0, e = Trees.size(); i != e; ++i)
1290     HasUnresolvedTypes |= Trees[i]->ContainsUnresolvedType();
1291   return !HasUnresolvedTypes;
1292 }
1293
1294 void TreePattern::print(raw_ostream &OS) const {
1295   OS << getRecord()->getName();
1296   if (!Args.empty()) {
1297     OS << "(" << Args[0];
1298     for (unsigned i = 1, e = Args.size(); i != e; ++i)
1299       OS << ", " << Args[i];
1300     OS << ")";
1301   }
1302   OS << ": ";
1303
1304   if (Trees.size() > 1)
1305     OS << "[\n";
1306   for (unsigned i = 0, e = Trees.size(); i != e; ++i) {
1307     OS << "\t";
1308     Trees[i]->print(OS);
1309     OS << "\n";
1310   }
1311
1312   if (Trees.size() > 1)
1313     OS << "]\n";
1314 }
1315
1316 void TreePattern::dump() const { print(errs()); }
1317
1318 //===----------------------------------------------------------------------===//
1319 // CodeGenDAGPatterns implementation
1320 //
1321
1322 // FIXME: REMOVE OSTREAM ARGUMENT
1323 CodeGenDAGPatterns::CodeGenDAGPatterns(RecordKeeper &R) : Records(R) {
1324   Intrinsics = LoadIntrinsics(Records, false);
1325   TgtIntrinsics = LoadIntrinsics(Records, true);
1326   ParseNodeInfo();
1327   ParseNodeTransforms();
1328   ParseComplexPatterns();
1329   ParsePatternFragments();
1330   ParseDefaultOperands();
1331   ParseInstructions();
1332   ParsePatterns();
1333
1334   // Generate variants.  For example, commutative patterns can match
1335   // multiple ways.  Add them to PatternsToMatch as well.
1336   GenerateVariants();
1337
1338   // Infer instruction flags.  For example, we can detect loads,
1339   // stores, and side effects in many cases by examining an
1340   // instruction's pattern.
1341   InferInstructionFlags();
1342 }
1343
1344 CodeGenDAGPatterns::~CodeGenDAGPatterns() {
1345   for (pf_iterator I = PatternFragments.begin(),
1346        E = PatternFragments.end(); I != E; ++I)
1347     delete I->second;
1348 }
1349
1350
1351 Record *CodeGenDAGPatterns::getSDNodeNamed(const std::string &Name) const {
1352   Record *N = Records.getDef(Name);
1353   if (!N || !N->isSubClassOf("SDNode")) {
1354     errs() << "Error getting SDNode '" << Name << "'!\n";
1355     exit(1);
1356   }
1357   return N;
1358 }
1359
1360 // Parse all of the SDNode definitions for the target, populating SDNodes.
1361 void CodeGenDAGPatterns::ParseNodeInfo() {
1362   std::vector<Record*> Nodes = Records.getAllDerivedDefinitions("SDNode");
1363   while (!Nodes.empty()) {
1364     SDNodes.insert(std::make_pair(Nodes.back(), Nodes.back()));
1365     Nodes.pop_back();
1366   }
1367
1368   // Get the builtin intrinsic nodes.
1369   intrinsic_void_sdnode     = getSDNodeNamed("intrinsic_void");
1370   intrinsic_w_chain_sdnode  = getSDNodeNamed("intrinsic_w_chain");
1371   intrinsic_wo_chain_sdnode = getSDNodeNamed("intrinsic_wo_chain");
1372 }
1373
1374 /// ParseNodeTransforms - Parse all SDNodeXForm instances into the SDNodeXForms
1375 /// map, and emit them to the file as functions.
1376 void CodeGenDAGPatterns::ParseNodeTransforms() {
1377   std::vector<Record*> Xforms = Records.getAllDerivedDefinitions("SDNodeXForm");
1378   while (!Xforms.empty()) {
1379     Record *XFormNode = Xforms.back();
1380     Record *SDNode = XFormNode->getValueAsDef("Opcode");
1381     std::string Code = XFormNode->getValueAsCode("XFormFunction");
1382     SDNodeXForms.insert(std::make_pair(XFormNode, NodeXForm(SDNode, Code)));
1383
1384     Xforms.pop_back();
1385   }
1386 }
1387
1388 void CodeGenDAGPatterns::ParseComplexPatterns() {
1389   std::vector<Record*> AMs = Records.getAllDerivedDefinitions("ComplexPattern");
1390   while (!AMs.empty()) {
1391     ComplexPatterns.insert(std::make_pair(AMs.back(), AMs.back()));
1392     AMs.pop_back();
1393   }
1394 }
1395
1396
1397 /// ParsePatternFragments - Parse all of the PatFrag definitions in the .td
1398 /// file, building up the PatternFragments map.  After we've collected them all,
1399 /// inline fragments together as necessary, so that there are no references left
1400 /// inside a pattern fragment to a pattern fragment.
1401 ///
1402 void CodeGenDAGPatterns::ParsePatternFragments() {
1403   std::vector<Record*> Fragments = Records.getAllDerivedDefinitions("PatFrag");
1404
1405   // First step, parse all of the fragments.
1406   for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
1407     DagInit *Tree = Fragments[i]->getValueAsDag("Fragment");
1408     TreePattern *P = new TreePattern(Fragments[i], Tree, true, *this);
1409     PatternFragments[Fragments[i]] = P;
1410
1411     // Validate the argument list, converting it to set, to discard duplicates.
1412     std::vector<std::string> &Args = P->getArgList();
1413     std::set<std::string> OperandsSet(Args.begin(), Args.end());
1414
1415     if (OperandsSet.count(""))
1416       P->error("Cannot have unnamed 'node' values in pattern fragment!");
1417
1418     // Parse the operands list.
1419     DagInit *OpsList = Fragments[i]->getValueAsDag("Operands");
1420     DefInit *OpsOp = dynamic_cast<DefInit*>(OpsList->getOperator());
1421     // Special cases: ops == outs == ins. Different names are used to
1422     // improve readability.
1423     if (!OpsOp ||
1424         (OpsOp->getDef()->getName() != "ops" &&
1425          OpsOp->getDef()->getName() != "outs" &&
1426          OpsOp->getDef()->getName() != "ins"))
1427       P->error("Operands list should start with '(ops ... '!");
1428
1429     // Copy over the arguments.
1430     Args.clear();
1431     for (unsigned j = 0, e = OpsList->getNumArgs(); j != e; ++j) {
1432       if (!dynamic_cast<DefInit*>(OpsList->getArg(j)) ||
1433           static_cast<DefInit*>(OpsList->getArg(j))->
1434           getDef()->getName() != "node")
1435         P->error("Operands list should all be 'node' values.");
1436       if (OpsList->getArgName(j).empty())
1437         P->error("Operands list should have names for each operand!");
1438       if (!OperandsSet.count(OpsList->getArgName(j)))
1439         P->error("'" + OpsList->getArgName(j) +
1440                  "' does not occur in pattern or was multiply specified!");
1441       OperandsSet.erase(OpsList->getArgName(j));
1442       Args.push_back(OpsList->getArgName(j));
1443     }
1444
1445     if (!OperandsSet.empty())
1446       P->error("Operands list does not contain an entry for operand '" +
1447                *OperandsSet.begin() + "'!");
1448
1449     // If there is a code init for this fragment, keep track of the fact that
1450     // this fragment uses it.
1451     std::string Code = Fragments[i]->getValueAsCode("Predicate");
1452     if (!Code.empty())
1453       P->getOnlyTree()->addPredicateFn("Predicate_"+Fragments[i]->getName());
1454
1455     // If there is a node transformation corresponding to this, keep track of
1456     // it.
1457     Record *Transform = Fragments[i]->getValueAsDef("OperandTransform");
1458     if (!getSDNodeTransform(Transform).second.empty())    // not noop xform?
1459       P->getOnlyTree()->setTransformFn(Transform);
1460   }
1461
1462   // Now that we've parsed all of the tree fragments, do a closure on them so
1463   // that there are not references to PatFrags left inside of them.
1464   for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
1465     TreePattern *ThePat = PatternFragments[Fragments[i]];
1466     ThePat->InlinePatternFragments();
1467
1468     // Infer as many types as possible.  Don't worry about it if we don't infer
1469     // all of them, some may depend on the inputs of the pattern.
1470     try {
1471       ThePat->InferAllTypes();
1472     } catch (...) {
1473       // If this pattern fragment is not supported by this target (no types can
1474       // satisfy its constraints), just ignore it.  If the bogus pattern is
1475       // actually used by instructions, the type consistency error will be
1476       // reported there.
1477     }
1478
1479     // If debugging, print out the pattern fragment result.
1480     DEBUG(ThePat->dump());
1481   }
1482 }
1483
1484 void CodeGenDAGPatterns::ParseDefaultOperands() {
1485   std::vector<Record*> DefaultOps[2];
1486   DefaultOps[0] = Records.getAllDerivedDefinitions("PredicateOperand");
1487   DefaultOps[1] = Records.getAllDerivedDefinitions("OptionalDefOperand");
1488
1489   // Find some SDNode.
1490   assert(!SDNodes.empty() && "No SDNodes parsed?");
1491   Init *SomeSDNode = new DefInit(SDNodes.begin()->first);
1492
1493   for (unsigned iter = 0; iter != 2; ++iter) {
1494     for (unsigned i = 0, e = DefaultOps[iter].size(); i != e; ++i) {
1495       DagInit *DefaultInfo = DefaultOps[iter][i]->getValueAsDag("DefaultOps");
1496
1497       // Clone the DefaultInfo dag node, changing the operator from 'ops' to
1498       // SomeSDnode so that we can parse this.
1499       std::vector<std::pair<Init*, std::string> > Ops;
1500       for (unsigned op = 0, e = DefaultInfo->getNumArgs(); op != e; ++op)
1501         Ops.push_back(std::make_pair(DefaultInfo->getArg(op),
1502                                      DefaultInfo->getArgName(op)));
1503       DagInit *DI = new DagInit(SomeSDNode, "", Ops);
1504
1505       // Create a TreePattern to parse this.
1506       TreePattern P(DefaultOps[iter][i], DI, false, *this);
1507       assert(P.getNumTrees() == 1 && "This ctor can only produce one tree!");
1508
1509       // Copy the operands over into a DAGDefaultOperand.
1510       DAGDefaultOperand DefaultOpInfo;
1511
1512       TreePatternNode *T = P.getTree(0);
1513       for (unsigned op = 0, e = T->getNumChildren(); op != e; ++op) {
1514         TreePatternNode *TPN = T->getChild(op);
1515         while (TPN->ApplyTypeConstraints(P, false))
1516           /* Resolve all types */;
1517
1518         if (TPN->ContainsUnresolvedType()) {
1519           if (iter == 0)
1520             throw "Value #" + utostr(i) + " of PredicateOperand '" +
1521               DefaultOps[iter][i]->getName() + "' doesn't have a concrete type!";
1522           else
1523             throw "Value #" + utostr(i) + " of OptionalDefOperand '" +
1524               DefaultOps[iter][i]->getName() + "' doesn't have a concrete type!";
1525         }
1526         DefaultOpInfo.DefaultOps.push_back(TPN);
1527       }
1528
1529       // Insert it into the DefaultOperands map so we can find it later.
1530       DefaultOperands[DefaultOps[iter][i]] = DefaultOpInfo;
1531     }
1532   }
1533 }
1534
1535 /// HandleUse - Given "Pat" a leaf in the pattern, check to see if it is an
1536 /// instruction input.  Return true if this is a real use.
1537 static bool HandleUse(TreePattern *I, TreePatternNode *Pat,
1538                       std::map<std::string, TreePatternNode*> &InstInputs,
1539                       std::vector<Record*> &InstImpInputs) {
1540   // No name -> not interesting.
1541   if (Pat->getName().empty()) {
1542     if (Pat->isLeaf()) {
1543       DefInit *DI = dynamic_cast<DefInit*>(Pat->getLeafValue());
1544       if (DI && DI->getDef()->isSubClassOf("RegisterClass"))
1545         I->error("Input " + DI->getDef()->getName() + " must be named!");
1546       else if (DI && DI->getDef()->isSubClassOf("Register"))
1547         InstImpInputs.push_back(DI->getDef());
1548     }
1549     return false;
1550   }
1551
1552   Record *Rec;
1553   if (Pat->isLeaf()) {
1554     DefInit *DI = dynamic_cast<DefInit*>(Pat->getLeafValue());
1555     if (!DI) I->error("Input $" + Pat->getName() + " must be an identifier!");
1556     Rec = DI->getDef();
1557   } else {
1558     Rec = Pat->getOperator();
1559   }
1560
1561   // SRCVALUE nodes are ignored.
1562   if (Rec->getName() == "srcvalue")
1563     return false;
1564
1565   TreePatternNode *&Slot = InstInputs[Pat->getName()];
1566   if (!Slot) {
1567     Slot = Pat;
1568   } else {
1569     Record *SlotRec;
1570     if (Slot->isLeaf()) {
1571       SlotRec = dynamic_cast<DefInit*>(Slot->getLeafValue())->getDef();
1572     } else {
1573       assert(Slot->getNumChildren() == 0 && "can't be a use with children!");
1574       SlotRec = Slot->getOperator();
1575     }
1576
1577     // Ensure that the inputs agree if we've already seen this input.
1578     if (Rec != SlotRec)
1579       I->error("All $" + Pat->getName() + " inputs must agree with each other");
1580     if (Slot->getExtTypes() != Pat->getExtTypes())
1581       I->error("All $" + Pat->getName() + " inputs must agree with each other");
1582   }
1583   return true;
1584 }
1585
1586 /// FindPatternInputsAndOutputs - Scan the specified TreePatternNode (which is
1587 /// part of "I", the instruction), computing the set of inputs and outputs of
1588 /// the pattern.  Report errors if we see anything naughty.
1589 void CodeGenDAGPatterns::
1590 FindPatternInputsAndOutputs(TreePattern *I, TreePatternNode *Pat,
1591                             std::map<std::string, TreePatternNode*> &InstInputs,
1592                             std::map<std::string, TreePatternNode*>&InstResults,
1593                             std::vector<Record*> &InstImpInputs,
1594                             std::vector<Record*> &InstImpResults) {
1595   if (Pat->isLeaf()) {
1596     bool isUse = HandleUse(I, Pat, InstInputs, InstImpInputs);
1597     if (!isUse && Pat->getTransformFn())
1598       I->error("Cannot specify a transform function for a non-input value!");
1599     return;
1600   } else if (Pat->getOperator()->getName() == "implicit") {
1601     for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
1602       TreePatternNode *Dest = Pat->getChild(i);
1603       if (!Dest->isLeaf())
1604         I->error("implicitly defined value should be a register!");
1605
1606       DefInit *Val = dynamic_cast<DefInit*>(Dest->getLeafValue());
1607       if (!Val || !Val->getDef()->isSubClassOf("Register"))
1608         I->error("implicitly defined value should be a register!");
1609       InstImpResults.push_back(Val->getDef());
1610     }
1611     return;
1612   } else if (Pat->getOperator()->getName() != "set") {
1613     // If this is not a set, verify that the children nodes are not void typed,
1614     // and recurse.
1615     for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
1616       if (Pat->getChild(i)->getExtTypeNum(0) == MVT::isVoid)
1617         I->error("Cannot have void nodes inside of patterns!");
1618       FindPatternInputsAndOutputs(I, Pat->getChild(i), InstInputs, InstResults,
1619                                   InstImpInputs, InstImpResults);
1620     }
1621
1622     // If this is a non-leaf node with no children, treat it basically as if
1623     // it were a leaf.  This handles nodes like (imm).
1624     bool isUse = HandleUse(I, Pat, InstInputs, InstImpInputs);
1625
1626     if (!isUse && Pat->getTransformFn())
1627       I->error("Cannot specify a transform function for a non-input value!");
1628     return;
1629   }
1630
1631   // Otherwise, this is a set, validate and collect instruction results.
1632   if (Pat->getNumChildren() == 0)
1633     I->error("set requires operands!");
1634
1635   if (Pat->getTransformFn())
1636     I->error("Cannot specify a transform function on a set node!");
1637
1638   // Check the set destinations.
1639   unsigned NumDests = Pat->getNumChildren()-1;
1640   for (unsigned i = 0; i != NumDests; ++i) {
1641     TreePatternNode *Dest = Pat->getChild(i);
1642     if (!Dest->isLeaf())
1643       I->error("set destination should be a register!");
1644
1645     DefInit *Val = dynamic_cast<DefInit*>(Dest->getLeafValue());
1646     if (!Val)
1647       I->error("set destination should be a register!");
1648
1649     if (Val->getDef()->isSubClassOf("RegisterClass") ||
1650         Val->getDef()->isSubClassOf("PointerLikeRegClass")) {
1651       if (Dest->getName().empty())
1652         I->error("set destination must have a name!");
1653       if (InstResults.count(Dest->getName()))
1654         I->error("cannot set '" + Dest->getName() +"' multiple times");
1655       InstResults[Dest->getName()] = Dest;
1656     } else if (Val->getDef()->isSubClassOf("Register")) {
1657       InstImpResults.push_back(Val->getDef());
1658     } else {
1659       I->error("set destination should be a register!");
1660     }
1661   }
1662
1663   // Verify and collect info from the computation.
1664   FindPatternInputsAndOutputs(I, Pat->getChild(NumDests),
1665                               InstInputs, InstResults,
1666                               InstImpInputs, InstImpResults);
1667 }
1668
1669 //===----------------------------------------------------------------------===//
1670 // Instruction Analysis
1671 //===----------------------------------------------------------------------===//
1672
1673 class InstAnalyzer {
1674   const CodeGenDAGPatterns &CDP;
1675   bool &mayStore;
1676   bool &mayLoad;
1677   bool &HasSideEffects;
1678 public:
1679   InstAnalyzer(const CodeGenDAGPatterns &cdp,
1680                bool &maystore, bool &mayload, bool &hse)
1681     : CDP(cdp), mayStore(maystore), mayLoad(mayload), HasSideEffects(hse){
1682   }
1683
1684   /// Analyze - Analyze the specified instruction, returning true if the
1685   /// instruction had a pattern.
1686   bool Analyze(Record *InstRecord) {
1687     const TreePattern *Pattern = CDP.getInstruction(InstRecord).getPattern();
1688     if (Pattern == 0) {
1689       HasSideEffects = 1;
1690       return false;  // No pattern.
1691     }
1692
1693     // FIXME: Assume only the first tree is the pattern. The others are clobber
1694     // nodes.
1695     AnalyzeNode(Pattern->getTree(0));
1696     return true;
1697   }
1698
1699 private:
1700   void AnalyzeNode(const TreePatternNode *N) {
1701     if (N->isLeaf()) {
1702       if (DefInit *DI = dynamic_cast<DefInit*>(N->getLeafValue())) {
1703         Record *LeafRec = DI->getDef();
1704         // Handle ComplexPattern leaves.
1705         if (LeafRec->isSubClassOf("ComplexPattern")) {
1706           const ComplexPattern &CP = CDP.getComplexPattern(LeafRec);
1707           if (CP.hasProperty(SDNPMayStore)) mayStore = true;
1708           if (CP.hasProperty(SDNPMayLoad)) mayLoad = true;
1709           if (CP.hasProperty(SDNPSideEffect)) HasSideEffects = true;
1710         }
1711       }
1712       return;
1713     }
1714
1715     // Analyze children.
1716     for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
1717       AnalyzeNode(N->getChild(i));
1718
1719     // Ignore set nodes, which are not SDNodes.
1720     if (N->getOperator()->getName() == "set")
1721       return;
1722
1723     // Get information about the SDNode for the operator.
1724     const SDNodeInfo &OpInfo = CDP.getSDNodeInfo(N->getOperator());
1725
1726     // Notice properties of the node.
1727     if (OpInfo.hasProperty(SDNPMayStore)) mayStore = true;
1728     if (OpInfo.hasProperty(SDNPMayLoad)) mayLoad = true;
1729     if (OpInfo.hasProperty(SDNPSideEffect)) HasSideEffects = true;
1730
1731     if (const CodeGenIntrinsic *IntInfo = N->getIntrinsicInfo(CDP)) {
1732       // If this is an intrinsic, analyze it.
1733       if (IntInfo->ModRef >= CodeGenIntrinsic::ReadArgMem)
1734         mayLoad = true;// These may load memory.
1735
1736       if (IntInfo->ModRef >= CodeGenIntrinsic::WriteArgMem)
1737         mayStore = true;// Intrinsics that can write to memory are 'mayStore'.
1738
1739       if (IntInfo->ModRef >= CodeGenIntrinsic::WriteMem)
1740         // WriteMem intrinsics can have other strange effects.
1741         HasSideEffects = true;
1742     }
1743   }
1744
1745 };
1746
1747 static void InferFromPattern(const CodeGenInstruction &Inst,
1748                              bool &MayStore, bool &MayLoad,
1749                              bool &HasSideEffects,
1750                              const CodeGenDAGPatterns &CDP) {
1751   MayStore = MayLoad = HasSideEffects = false;
1752
1753   bool HadPattern =
1754     InstAnalyzer(CDP, MayStore, MayLoad, HasSideEffects).Analyze(Inst.TheDef);
1755
1756   // InstAnalyzer only correctly analyzes mayStore/mayLoad so far.
1757   if (Inst.mayStore) {  // If the .td file explicitly sets mayStore, use it.
1758     // If we decided that this is a store from the pattern, then the .td file
1759     // entry is redundant.
1760     if (MayStore)
1761       fprintf(stderr,
1762               "Warning: mayStore flag explicitly set on instruction '%s'"
1763               " but flag already inferred from pattern.\n",
1764               Inst.TheDef->getName().c_str());
1765     MayStore = true;
1766   }
1767
1768   if (Inst.mayLoad) {  // If the .td file explicitly sets mayLoad, use it.
1769     // If we decided that this is a load from the pattern, then the .td file
1770     // entry is redundant.
1771     if (MayLoad)
1772       fprintf(stderr,
1773               "Warning: mayLoad flag explicitly set on instruction '%s'"
1774               " but flag already inferred from pattern.\n",
1775               Inst.TheDef->getName().c_str());
1776     MayLoad = true;
1777   }
1778
1779   if (Inst.neverHasSideEffects) {
1780     if (HadPattern)
1781       fprintf(stderr, "Warning: neverHasSideEffects set on instruction '%s' "
1782               "which already has a pattern\n", Inst.TheDef->getName().c_str());
1783     HasSideEffects = false;
1784   }
1785
1786   if (Inst.hasSideEffects) {
1787     if (HasSideEffects)
1788       fprintf(stderr, "Warning: hasSideEffects set on instruction '%s' "
1789               "which already inferred this.\n", Inst.TheDef->getName().c_str());
1790     HasSideEffects = true;
1791   }
1792 }
1793
1794 /// ParseInstructions - Parse all of the instructions, inlining and resolving
1795 /// any fragments involved.  This populates the Instructions list with fully
1796 /// resolved instructions.
1797 void CodeGenDAGPatterns::ParseInstructions() {
1798   std::vector<Record*> Instrs = Records.getAllDerivedDefinitions("Instruction");
1799
1800   for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
1801     ListInit *LI = 0;
1802
1803     if (dynamic_cast<ListInit*>(Instrs[i]->getValueInit("Pattern")))
1804       LI = Instrs[i]->getValueAsListInit("Pattern");
1805
1806     // If there is no pattern, only collect minimal information about the
1807     // instruction for its operand list.  We have to assume that there is one
1808     // result, as we have no detailed info.
1809     if (!LI || LI->getSize() == 0) {
1810       std::vector<Record*> Results;
1811       std::vector<Record*> Operands;
1812
1813       CodeGenInstruction &InstInfo =Target.getInstruction(Instrs[i]->getName());
1814
1815       if (InstInfo.OperandList.size() != 0) {
1816         if (InstInfo.NumDefs == 0) {
1817           // These produce no results
1818           for (unsigned j = 0, e = InstInfo.OperandList.size(); j < e; ++j)
1819             Operands.push_back(InstInfo.OperandList[j].Rec);
1820         } else {
1821           // Assume the first operand is the result.
1822           Results.push_back(InstInfo.OperandList[0].Rec);
1823
1824           // The rest are inputs.
1825           for (unsigned j = 1, e = InstInfo.OperandList.size(); j < e; ++j)
1826             Operands.push_back(InstInfo.OperandList[j].Rec);
1827         }
1828       }
1829
1830       // Create and insert the instruction.
1831       std::vector<Record*> ImpResults;
1832       std::vector<Record*> ImpOperands;
1833       Instructions.insert(std::make_pair(Instrs[i],
1834                           DAGInstruction(0, Results, Operands, ImpResults,
1835                                          ImpOperands)));
1836       continue;  // no pattern.
1837     }
1838
1839     // Parse the instruction.
1840     TreePattern *I = new TreePattern(Instrs[i], LI, true, *this);
1841     // Inline pattern fragments into it.
1842     I->InlinePatternFragments();
1843
1844     // Infer as many types as possible.  If we cannot infer all of them, we can
1845     // never do anything with this instruction pattern: report it to the user.
1846     if (!I->InferAllTypes())
1847       I->error("Could not infer all types in pattern!");
1848
1849     // InstInputs - Keep track of all of the inputs of the instruction, along
1850     // with the record they are declared as.
1851     std::map<std::string, TreePatternNode*> InstInputs;
1852
1853     // InstResults - Keep track of all the virtual registers that are 'set'
1854     // in the instruction, including what reg class they are.
1855     std::map<std::string, TreePatternNode*> InstResults;
1856
1857     std::vector<Record*> InstImpInputs;
1858     std::vector<Record*> InstImpResults;
1859
1860     // Verify that the top-level forms in the instruction are of void type, and
1861     // fill in the InstResults map.
1862     for (unsigned j = 0, e = I->getNumTrees(); j != e; ++j) {
1863       TreePatternNode *Pat = I->getTree(j);
1864       if (Pat->getExtTypeNum(0) != MVT::isVoid)
1865         I->error("Top-level forms in instruction pattern should have"
1866                  " void types");
1867
1868       // Find inputs and outputs, and verify the structure of the uses/defs.
1869       FindPatternInputsAndOutputs(I, Pat, InstInputs, InstResults,
1870                                   InstImpInputs, InstImpResults);
1871     }
1872
1873     // Now that we have inputs and outputs of the pattern, inspect the operands
1874     // list for the instruction.  This determines the order that operands are
1875     // added to the machine instruction the node corresponds to.
1876     unsigned NumResults = InstResults.size();
1877
1878     // Parse the operands list from the (ops) list, validating it.
1879     assert(I->getArgList().empty() && "Args list should still be empty here!");
1880     CodeGenInstruction &CGI = Target.getInstruction(Instrs[i]->getName());
1881
1882     // Check that all of the results occur first in the list.
1883     std::vector<Record*> Results;
1884     TreePatternNode *Res0Node = NULL;
1885     for (unsigned i = 0; i != NumResults; ++i) {
1886       if (i == CGI.OperandList.size())
1887         I->error("'" + InstResults.begin()->first +
1888                  "' set but does not appear in operand list!");
1889       const std::string &OpName = CGI.OperandList[i].Name;
1890
1891       // Check that it exists in InstResults.
1892       TreePatternNode *RNode = InstResults[OpName];
1893       if (RNode == 0)
1894         I->error("Operand $" + OpName + " does not exist in operand list!");
1895
1896       if (i == 0)
1897         Res0Node = RNode;
1898       Record *R = dynamic_cast<DefInit*>(RNode->getLeafValue())->getDef();
1899       if (R == 0)
1900         I->error("Operand $" + OpName + " should be a set destination: all "
1901                  "outputs must occur before inputs in operand list!");
1902
1903       if (CGI.OperandList[i].Rec != R)
1904         I->error("Operand $" + OpName + " class mismatch!");
1905
1906       // Remember the return type.
1907       Results.push_back(CGI.OperandList[i].Rec);
1908
1909       // Okay, this one checks out.
1910       InstResults.erase(OpName);
1911     }
1912
1913     // Loop over the inputs next.  Make a copy of InstInputs so we can destroy
1914     // the copy while we're checking the inputs.
1915     std::map<std::string, TreePatternNode*> InstInputsCheck(InstInputs);
1916
1917     std::vector<TreePatternNode*> ResultNodeOperands;
1918     std::vector<Record*> Operands;
1919     for (unsigned i = NumResults, e = CGI.OperandList.size(); i != e; ++i) {
1920       CodeGenInstruction::OperandInfo &Op = CGI.OperandList[i];
1921       const std::string &OpName = Op.Name;
1922       if (OpName.empty())
1923         I->error("Operand #" + utostr(i) + " in operands list has no name!");
1924
1925       if (!InstInputsCheck.count(OpName)) {
1926         // If this is an predicate operand or optional def operand with an
1927         // DefaultOps set filled in, we can ignore this.  When we codegen it,
1928         // we will do so as always executed.
1929         if (Op.Rec->isSubClassOf("PredicateOperand") ||
1930             Op.Rec->isSubClassOf("OptionalDefOperand")) {
1931           // Does it have a non-empty DefaultOps field?  If so, ignore this
1932           // operand.
1933           if (!getDefaultOperand(Op.Rec).DefaultOps.empty())
1934             continue;
1935         }
1936         I->error("Operand $" + OpName +
1937                  " does not appear in the instruction pattern");
1938       }
1939       TreePatternNode *InVal = InstInputsCheck[OpName];
1940       InstInputsCheck.erase(OpName);   // It occurred, remove from map.
1941
1942       if (InVal->isLeaf() &&
1943           dynamic_cast<DefInit*>(InVal->getLeafValue())) {
1944         Record *InRec = static_cast<DefInit*>(InVal->getLeafValue())->getDef();
1945         if (Op.Rec != InRec && !InRec->isSubClassOf("ComplexPattern"))
1946           I->error("Operand $" + OpName + "'s register class disagrees"
1947                    " between the operand and pattern");
1948       }
1949       Operands.push_back(Op.Rec);
1950
1951       // Construct the result for the dest-pattern operand list.
1952       TreePatternNode *OpNode = InVal->clone();
1953
1954       // No predicate is useful on the result.
1955       OpNode->clearPredicateFns();
1956
1957       // Promote the xform function to be an explicit node if set.
1958       if (Record *Xform = OpNode->getTransformFn()) {
1959         OpNode->setTransformFn(0);
1960         std::vector<TreePatternNode*> Children;
1961         Children.push_back(OpNode);
1962         OpNode = new TreePatternNode(Xform, Children);
1963       }
1964
1965       ResultNodeOperands.push_back(OpNode);
1966     }
1967
1968     if (!InstInputsCheck.empty())
1969       I->error("Input operand $" + InstInputsCheck.begin()->first +
1970                " occurs in pattern but not in operands list!");
1971
1972     TreePatternNode *ResultPattern =
1973       new TreePatternNode(I->getRecord(), ResultNodeOperands);
1974     // Copy fully inferred output node type to instruction result pattern.
1975     if (NumResults > 0)
1976       ResultPattern->setTypes(Res0Node->getExtTypes());
1977
1978     // Create and insert the instruction.
1979     // FIXME: InstImpResults and InstImpInputs should not be part of
1980     // DAGInstruction.
1981     DAGInstruction TheInst(I, Results, Operands, InstImpResults, InstImpInputs);
1982     Instructions.insert(std::make_pair(I->getRecord(), TheInst));
1983
1984     // Use a temporary tree pattern to infer all types and make sure that the
1985     // constructed result is correct.  This depends on the instruction already
1986     // being inserted into the Instructions map.
1987     TreePattern Temp(I->getRecord(), ResultPattern, false, *this);
1988     Temp.InferAllTypes();
1989
1990     DAGInstruction &TheInsertedInst = Instructions.find(I->getRecord())->second;
1991     TheInsertedInst.setResultPattern(Temp.getOnlyTree());
1992
1993     DEBUG(I->dump());
1994   }
1995
1996   // If we can, convert the instructions to be patterns that are matched!
1997   for (std::map<Record*, DAGInstruction, RecordPtrCmp>::iterator II =
1998         Instructions.begin(),
1999        E = Instructions.end(); II != E; ++II) {
2000     DAGInstruction &TheInst = II->second;
2001     const TreePattern *I = TheInst.getPattern();
2002     if (I == 0) continue;  // No pattern.
2003
2004     // FIXME: Assume only the first tree is the pattern. The others are clobber
2005     // nodes.
2006     TreePatternNode *Pattern = I->getTree(0);
2007     TreePatternNode *SrcPattern;
2008     if (Pattern->getOperator()->getName() == "set") {
2009       SrcPattern = Pattern->getChild(Pattern->getNumChildren()-1)->clone();
2010     } else{
2011       // Not a set (store or something?)
2012       SrcPattern = Pattern;
2013     }
2014
2015     std::string Reason;
2016     if (!SrcPattern->canPatternMatch(Reason, *this))
2017       I->error("Instruction can never match: " + Reason);
2018
2019     Record *Instr = II->first;
2020     TreePatternNode *DstPattern = TheInst.getResultPattern();
2021     PatternsToMatch.
2022       push_back(PatternToMatch(Instr->getValueAsListInit("Predicates"),
2023                                SrcPattern, DstPattern, TheInst.getImpResults(),
2024                                Instr->getValueAsInt("AddedComplexity")));
2025   }
2026 }
2027
2028
2029 void CodeGenDAGPatterns::InferInstructionFlags() {
2030   std::map<std::string, CodeGenInstruction> &InstrDescs =
2031     Target.getInstructions();
2032   for (std::map<std::string, CodeGenInstruction>::iterator
2033          II = InstrDescs.begin(), E = InstrDescs.end(); II != E; ++II) {
2034     CodeGenInstruction &InstInfo = II->second;
2035     // Determine properties of the instruction from its pattern.
2036     bool MayStore, MayLoad, HasSideEffects;
2037     InferFromPattern(InstInfo, MayStore, MayLoad, HasSideEffects, *this);
2038     InstInfo.mayStore = MayStore;
2039     InstInfo.mayLoad = MayLoad;
2040     InstInfo.hasSideEffects = HasSideEffects;
2041   }
2042 }
2043
2044 void CodeGenDAGPatterns::ParsePatterns() {
2045   std::vector<Record*> Patterns = Records.getAllDerivedDefinitions("Pattern");
2046
2047   for (unsigned i = 0, e = Patterns.size(); i != e; ++i) {
2048     DagInit *Tree = Patterns[i]->getValueAsDag("PatternToMatch");
2049     DefInit *OpDef = dynamic_cast<DefInit*>(Tree->getOperator());
2050     Record *Operator = OpDef->getDef();
2051     TreePattern *Pattern;
2052     if (Operator->getName() != "parallel")
2053       Pattern = new TreePattern(Patterns[i], Tree, true, *this);
2054     else {
2055       std::vector<Init*> Values;
2056       RecTy *ListTy = 0;
2057       for (unsigned j = 0, ee = Tree->getNumArgs(); j != ee; ++j) {
2058         Values.push_back(Tree->getArg(j));
2059         TypedInit *TArg = dynamic_cast<TypedInit*>(Tree->getArg(j));
2060         if (TArg == 0) {
2061           errs() << "In dag: " << Tree->getAsString();
2062           errs() << " --  Untyped argument in pattern\n";
2063           assert(0 && "Untyped argument in pattern");
2064         }
2065         if (ListTy != 0) {
2066           ListTy = resolveTypes(ListTy, TArg->getType());
2067           if (ListTy == 0) {
2068             errs() << "In dag: " << Tree->getAsString();
2069             errs() << " --  Incompatible types in pattern arguments\n";
2070             assert(0 && "Incompatible types in pattern arguments");
2071           }
2072         }
2073         else {
2074           ListTy = TArg->getType();
2075         }
2076       }
2077       ListInit *LI = new ListInit(Values, new ListRecTy(ListTy));
2078       Pattern = new TreePattern(Patterns[i], LI, true, *this);
2079     }
2080
2081     // Inline pattern fragments into it.
2082     Pattern->InlinePatternFragments();
2083
2084     ListInit *LI = Patterns[i]->getValueAsListInit("ResultInstrs");
2085     if (LI->getSize() == 0) continue;  // no pattern.
2086
2087     // Parse the instruction.
2088     TreePattern *Result = new TreePattern(Patterns[i], LI, false, *this);
2089
2090     // Inline pattern fragments into it.
2091     Result->InlinePatternFragments();
2092
2093     if (Result->getNumTrees() != 1)
2094       Result->error("Cannot handle instructions producing instructions "
2095                     "with temporaries yet!");
2096
2097     bool IterateInference;
2098     bool InferredAllPatternTypes, InferredAllResultTypes;
2099     do {
2100       // Infer as many types as possible.  If we cannot infer all of them, we
2101       // can never do anything with this pattern: report it to the user.
2102       InferredAllPatternTypes = Pattern->InferAllTypes();
2103
2104       // Infer as many types as possible.  If we cannot infer all of them, we
2105       // can never do anything with this pattern: report it to the user.
2106       InferredAllResultTypes = Result->InferAllTypes();
2107
2108       // Apply the type of the result to the source pattern.  This helps us
2109       // resolve cases where the input type is known to be a pointer type (which
2110       // is considered resolved), but the result knows it needs to be 32- or
2111       // 64-bits.  Infer the other way for good measure.
2112       IterateInference = Pattern->getTree(0)->
2113         UpdateNodeType(Result->getTree(0)->getExtTypes(), *Result);
2114       IterateInference |= Result->getTree(0)->
2115         UpdateNodeType(Pattern->getTree(0)->getExtTypes(), *Result);
2116     } while (IterateInference);
2117
2118     // Verify that we inferred enough types that we can do something with the
2119     // pattern and result.  If these fire the user has to add type casts.
2120     if (!InferredAllPatternTypes)
2121       Pattern->error("Could not infer all types in pattern!");
2122     if (!InferredAllResultTypes)
2123       Result->error("Could not infer all types in pattern result!");
2124
2125     // Validate that the input pattern is correct.
2126     std::map<std::string, TreePatternNode*> InstInputs;
2127     std::map<std::string, TreePatternNode*> InstResults;
2128     std::vector<Record*> InstImpInputs;
2129     std::vector<Record*> InstImpResults;
2130     for (unsigned j = 0, ee = Pattern->getNumTrees(); j != ee; ++j)
2131       FindPatternInputsAndOutputs(Pattern, Pattern->getTree(j),
2132                                   InstInputs, InstResults,
2133                                   InstImpInputs, InstImpResults);
2134
2135     // Promote the xform function to be an explicit node if set.
2136     TreePatternNode *DstPattern = Result->getOnlyTree();
2137     std::vector<TreePatternNode*> ResultNodeOperands;
2138     for (unsigned ii = 0, ee = DstPattern->getNumChildren(); ii != ee; ++ii) {
2139       TreePatternNode *OpNode = DstPattern->getChild(ii);
2140       if (Record *Xform = OpNode->getTransformFn()) {
2141         OpNode->setTransformFn(0);
2142         std::vector<TreePatternNode*> Children;
2143         Children.push_back(OpNode);
2144         OpNode = new TreePatternNode(Xform, Children);
2145       }
2146       ResultNodeOperands.push_back(OpNode);
2147     }
2148     DstPattern = Result->getOnlyTree();
2149     if (!DstPattern->isLeaf())
2150       DstPattern = new TreePatternNode(DstPattern->getOperator(),
2151                                        ResultNodeOperands);
2152     DstPattern->setTypes(Result->getOnlyTree()->getExtTypes());
2153     TreePattern Temp(Result->getRecord(), DstPattern, false, *this);
2154     Temp.InferAllTypes();
2155
2156     std::string Reason;
2157     if (!Pattern->getTree(0)->canPatternMatch(Reason, *this))
2158       Pattern->error("Pattern can never match: " + Reason);
2159
2160     PatternsToMatch.
2161       push_back(PatternToMatch(Patterns[i]->getValueAsListInit("Predicates"),
2162                                Pattern->getTree(0),
2163                                Temp.getOnlyTree(), InstImpResults,
2164                                Patterns[i]->getValueAsInt("AddedComplexity")));
2165   }
2166 }
2167
2168 /// CombineChildVariants - Given a bunch of permutations of each child of the
2169 /// 'operator' node, put them together in all possible ways.
2170 static void CombineChildVariants(TreePatternNode *Orig,
2171                const std::vector<std::vector<TreePatternNode*> > &ChildVariants,
2172                                  std::vector<TreePatternNode*> &OutVariants,
2173                                  CodeGenDAGPatterns &CDP,
2174                                  const MultipleUseVarSet &DepVars) {
2175   // Make sure that each operand has at least one variant to choose from.
2176   for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
2177     if (ChildVariants[i].empty())
2178       return;
2179
2180   // The end result is an all-pairs construction of the resultant pattern.
2181   std::vector<unsigned> Idxs;
2182   Idxs.resize(ChildVariants.size());
2183   bool NotDone;
2184   do {
2185 #ifndef NDEBUG
2186     if (DebugFlag && !Idxs.empty()) {
2187       errs() << Orig->getOperator()->getName() << ": Idxs = [ ";
2188         for (unsigned i = 0; i < Idxs.size(); ++i) {
2189           errs() << Idxs[i] << " ";
2190       }
2191       errs() << "]\n";
2192     }
2193 #endif
2194     // Create the variant and add it to the output list.
2195     std::vector<TreePatternNode*> NewChildren;
2196     for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
2197       NewChildren.push_back(ChildVariants[i][Idxs[i]]);
2198     TreePatternNode *R = new TreePatternNode(Orig->getOperator(), NewChildren);
2199
2200     // Copy over properties.
2201     R->setName(Orig->getName());
2202     R->setPredicateFns(Orig->getPredicateFns());
2203     R->setTransformFn(Orig->getTransformFn());
2204     R->setTypes(Orig->getExtTypes());
2205
2206     // If this pattern cannot match, do not include it as a variant.
2207     std::string ErrString;
2208     if (!R->canPatternMatch(ErrString, CDP)) {
2209       delete R;
2210     } else {
2211       bool AlreadyExists = false;
2212
2213       // Scan to see if this pattern has already been emitted.  We can get
2214       // duplication due to things like commuting:
2215       //   (and GPRC:$a, GPRC:$b) -> (and GPRC:$b, GPRC:$a)
2216       // which are the same pattern.  Ignore the dups.
2217       for (unsigned i = 0, e = OutVariants.size(); i != e; ++i)
2218         if (R->isIsomorphicTo(OutVariants[i], DepVars)) {
2219           AlreadyExists = true;
2220           break;
2221         }
2222
2223       if (AlreadyExists)
2224         delete R;
2225       else
2226         OutVariants.push_back(R);
2227     }
2228
2229     // Increment indices to the next permutation by incrementing the
2230     // indicies from last index backward, e.g., generate the sequence
2231     // [0, 0], [0, 1], [1, 0], [1, 1].
2232     int IdxsIdx;
2233     for (IdxsIdx = Idxs.size() - 1; IdxsIdx >= 0; --IdxsIdx) {
2234       if (++Idxs[IdxsIdx] == ChildVariants[IdxsIdx].size())
2235         Idxs[IdxsIdx] = 0;
2236       else
2237         break;
2238     }
2239     NotDone = (IdxsIdx >= 0);
2240   } while (NotDone);
2241 }
2242
2243 /// CombineChildVariants - A helper function for binary operators.
2244 ///
2245 static void CombineChildVariants(TreePatternNode *Orig,
2246                                  const std::vector<TreePatternNode*> &LHS,
2247                                  const std::vector<TreePatternNode*> &RHS,
2248                                  std::vector<TreePatternNode*> &OutVariants,
2249                                  CodeGenDAGPatterns &CDP,
2250                                  const MultipleUseVarSet &DepVars) {
2251   std::vector<std::vector<TreePatternNode*> > ChildVariants;
2252   ChildVariants.push_back(LHS);
2253   ChildVariants.push_back(RHS);
2254   CombineChildVariants(Orig, ChildVariants, OutVariants, CDP, DepVars);
2255 }
2256
2257
2258 static void GatherChildrenOfAssociativeOpcode(TreePatternNode *N,
2259                                      std::vector<TreePatternNode *> &Children) {
2260   assert(N->getNumChildren()==2 &&"Associative but doesn't have 2 children!");
2261   Record *Operator = N->getOperator();
2262
2263   // Only permit raw nodes.
2264   if (!N->getName().empty() || !N->getPredicateFns().empty() ||
2265       N->getTransformFn()) {
2266     Children.push_back(N);
2267     return;
2268   }
2269
2270   if (N->getChild(0)->isLeaf() || N->getChild(0)->getOperator() != Operator)
2271     Children.push_back(N->getChild(0));
2272   else
2273     GatherChildrenOfAssociativeOpcode(N->getChild(0), Children);
2274
2275   if (N->getChild(1)->isLeaf() || N->getChild(1)->getOperator() != Operator)
2276     Children.push_back(N->getChild(1));
2277   else
2278     GatherChildrenOfAssociativeOpcode(N->getChild(1), Children);
2279 }
2280
2281 /// GenerateVariantsOf - Given a pattern N, generate all permutations we can of
2282 /// the (potentially recursive) pattern by using algebraic laws.
2283 ///
2284 static void GenerateVariantsOf(TreePatternNode *N,
2285                                std::vector<TreePatternNode*> &OutVariants,
2286                                CodeGenDAGPatterns &CDP,
2287                                const MultipleUseVarSet &DepVars) {
2288   // We cannot permute leaves.
2289   if (N->isLeaf()) {
2290     OutVariants.push_back(N);
2291     return;
2292   }
2293
2294   // Look up interesting info about the node.
2295   const SDNodeInfo &NodeInfo = CDP.getSDNodeInfo(N->getOperator());
2296
2297   // If this node is associative, re-associate.
2298   if (NodeInfo.hasProperty(SDNPAssociative)) {
2299     // Re-associate by pulling together all of the linked operators
2300     std::vector<TreePatternNode*> MaximalChildren;
2301     GatherChildrenOfAssociativeOpcode(N, MaximalChildren);
2302
2303     // Only handle child sizes of 3.  Otherwise we'll end up trying too many
2304     // permutations.
2305     if (MaximalChildren.size() == 3) {
2306       // Find the variants of all of our maximal children.
2307       std::vector<TreePatternNode*> AVariants, BVariants, CVariants;
2308       GenerateVariantsOf(MaximalChildren[0], AVariants, CDP, DepVars);
2309       GenerateVariantsOf(MaximalChildren[1], BVariants, CDP, DepVars);
2310       GenerateVariantsOf(MaximalChildren[2], CVariants, CDP, DepVars);
2311
2312       // There are only two ways we can permute the tree:
2313       //   (A op B) op C    and    A op (B op C)
2314       // Within these forms, we can also permute A/B/C.
2315
2316       // Generate legal pair permutations of A/B/C.
2317       std::vector<TreePatternNode*> ABVariants;
2318       std::vector<TreePatternNode*> BAVariants;
2319       std::vector<TreePatternNode*> ACVariants;
2320       std::vector<TreePatternNode*> CAVariants;
2321       std::vector<TreePatternNode*> BCVariants;
2322       std::vector<TreePatternNode*> CBVariants;
2323       CombineChildVariants(N, AVariants, BVariants, ABVariants, CDP, DepVars);
2324       CombineChildVariants(N, BVariants, AVariants, BAVariants, CDP, DepVars);
2325       CombineChildVariants(N, AVariants, CVariants, ACVariants, CDP, DepVars);
2326       CombineChildVariants(N, CVariants, AVariants, CAVariants, CDP, DepVars);
2327       CombineChildVariants(N, BVariants, CVariants, BCVariants, CDP, DepVars);
2328       CombineChildVariants(N, CVariants, BVariants, CBVariants, CDP, DepVars);
2329
2330       // Combine those into the result: (x op x) op x
2331       CombineChildVariants(N, ABVariants, CVariants, OutVariants, CDP, DepVars);
2332       CombineChildVariants(N, BAVariants, CVariants, OutVariants, CDP, DepVars);
2333       CombineChildVariants(N, ACVariants, BVariants, OutVariants, CDP, DepVars);
2334       CombineChildVariants(N, CAVariants, BVariants, OutVariants, CDP, DepVars);
2335       CombineChildVariants(N, BCVariants, AVariants, OutVariants, CDP, DepVars);
2336       CombineChildVariants(N, CBVariants, AVariants, OutVariants, CDP, DepVars);
2337
2338       // Combine those into the result: x op (x op x)
2339       CombineChildVariants(N, CVariants, ABVariants, OutVariants, CDP, DepVars);
2340       CombineChildVariants(N, CVariants, BAVariants, OutVariants, CDP, DepVars);
2341       CombineChildVariants(N, BVariants, ACVariants, OutVariants, CDP, DepVars);
2342       CombineChildVariants(N, BVariants, CAVariants, OutVariants, CDP, DepVars);
2343       CombineChildVariants(N, AVariants, BCVariants, OutVariants, CDP, DepVars);
2344       CombineChildVariants(N, AVariants, CBVariants, OutVariants, CDP, DepVars);
2345       return;
2346     }
2347   }
2348
2349   // Compute permutations of all children.
2350   std::vector<std::vector<TreePatternNode*> > ChildVariants;
2351   ChildVariants.resize(N->getNumChildren());
2352   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
2353     GenerateVariantsOf(N->getChild(i), ChildVariants[i], CDP, DepVars);
2354
2355   // Build all permutations based on how the children were formed.
2356   CombineChildVariants(N, ChildVariants, OutVariants, CDP, DepVars);
2357
2358   // If this node is commutative, consider the commuted order.
2359   bool isCommIntrinsic = N->isCommutativeIntrinsic(CDP);
2360   if (NodeInfo.hasProperty(SDNPCommutative) || isCommIntrinsic) {
2361     assert((N->getNumChildren()==2 || isCommIntrinsic) &&
2362            "Commutative but doesn't have 2 children!");
2363     // Don't count children which are actually register references.
2364     unsigned NC = 0;
2365     for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i) {
2366       TreePatternNode *Child = N->getChild(i);
2367       if (Child->isLeaf())
2368         if (DefInit *DI = dynamic_cast<DefInit*>(Child->getLeafValue())) {
2369           Record *RR = DI->getDef();
2370           if (RR->isSubClassOf("Register"))
2371             continue;
2372         }
2373       NC++;
2374     }
2375     // Consider the commuted order.
2376     if (isCommIntrinsic) {
2377       // Commutative intrinsic. First operand is the intrinsic id, 2nd and 3rd
2378       // operands are the commutative operands, and there might be more operands
2379       // after those.
2380       assert(NC >= 3 &&
2381              "Commutative intrinsic should have at least 3 childrean!");
2382       std::vector<std::vector<TreePatternNode*> > Variants;
2383       Variants.push_back(ChildVariants[0]); // Intrinsic id.
2384       Variants.push_back(ChildVariants[2]);
2385       Variants.push_back(ChildVariants[1]);
2386       for (unsigned i = 3; i != NC; ++i)
2387         Variants.push_back(ChildVariants[i]);
2388       CombineChildVariants(N, Variants, OutVariants, CDP, DepVars);
2389     } else if (NC == 2)
2390       CombineChildVariants(N, ChildVariants[1], ChildVariants[0],
2391                            OutVariants, CDP, DepVars);
2392   }
2393 }
2394
2395
2396 // GenerateVariants - Generate variants.  For example, commutative patterns can
2397 // match multiple ways.  Add them to PatternsToMatch as well.
2398 void CodeGenDAGPatterns::GenerateVariants() {
2399   DEBUG(errs() << "Generating instruction variants.\n");
2400
2401   // Loop over all of the patterns we've collected, checking to see if we can
2402   // generate variants of the instruction, through the exploitation of
2403   // identities.  This permits the target to provide aggressive matching without
2404   // the .td file having to contain tons of variants of instructions.
2405   //
2406   // Note that this loop adds new patterns to the PatternsToMatch list, but we
2407   // intentionally do not reconsider these.  Any variants of added patterns have
2408   // already been added.
2409   //
2410   for (unsigned i = 0, e = PatternsToMatch.size(); i != e; ++i) {
2411     MultipleUseVarSet             DepVars;
2412     std::vector<TreePatternNode*> Variants;
2413     FindDepVars(PatternsToMatch[i].getSrcPattern(), DepVars);
2414     DEBUG(errs() << "Dependent/multiply used variables: ");
2415     DEBUG(DumpDepVars(DepVars));
2416     DEBUG(errs() << "\n");
2417     GenerateVariantsOf(PatternsToMatch[i].getSrcPattern(), Variants, *this, DepVars);
2418
2419     assert(!Variants.empty() && "Must create at least original variant!");
2420     Variants.erase(Variants.begin());  // Remove the original pattern.
2421
2422     if (Variants.empty())  // No variants for this pattern.
2423       continue;
2424
2425     DEBUG(errs() << "FOUND VARIANTS OF: ";
2426           PatternsToMatch[i].getSrcPattern()->dump();
2427           errs() << "\n");
2428
2429     for (unsigned v = 0, e = Variants.size(); v != e; ++v) {
2430       TreePatternNode *Variant = Variants[v];
2431
2432       DEBUG(errs() << "  VAR#" << v <<  ": ";
2433             Variant->dump();
2434             errs() << "\n");
2435
2436       // Scan to see if an instruction or explicit pattern already matches this.
2437       bool AlreadyExists = false;
2438       for (unsigned p = 0, e = PatternsToMatch.size(); p != e; ++p) {
2439         // Skip if the top level predicates do not match.
2440         if (PatternsToMatch[i].getPredicates() !=
2441             PatternsToMatch[p].getPredicates())
2442           continue;
2443         // Check to see if this variant already exists.
2444         if (Variant->isIsomorphicTo(PatternsToMatch[p].getSrcPattern(), DepVars)) {
2445           DEBUG(errs() << "  *** ALREADY EXISTS, ignoring variant.\n");
2446           AlreadyExists = true;
2447           break;
2448         }
2449       }
2450       // If we already have it, ignore the variant.
2451       if (AlreadyExists) continue;
2452
2453       // Otherwise, add it to the list of patterns we have.
2454       PatternsToMatch.
2455         push_back(PatternToMatch(PatternsToMatch[i].getPredicates(),
2456                                  Variant, PatternsToMatch[i].getDstPattern(),
2457                                  PatternsToMatch[i].getDstRegs(),
2458                                  PatternsToMatch[i].getAddedComplexity()));
2459     }
2460
2461     DEBUG(errs() << "\n");
2462   }
2463 }
2464