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