utils/TableGen/CodeGenDAGPatterns.cpp

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