utils/TableGen/CodeGenDAGPatterns.h

   1 //===- CodeGenDAGPatterns.h - Read DAG patterns from .td file ---*- C++ -*-===//
   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 declares the CodeGenDAGPatterns class, which is used to read and
  11 // represent the patterns present in a .td file for instructions.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef CODEGEN_DAGPATTERNS_H
  16 #define CODEGEN_DAGPATTERNS_H
  17
  18 #include <set>
  19 #include <algorithm>
  20 #include <vector>
  21
  22 #include "CodeGenTarget.h"
  23 #include "CodeGenIntrinsics.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/ADT/StringMap.h"
  26
  27 namespace llvm {
  28   class Record;
  29   struct Init;
  30   class ListInit;
  31   class DagInit;
  32   class SDNodeInfo;
  33   class TreePattern;
  34   class TreePatternNode;
  35   class CodeGenDAGPatterns;
  36   class ComplexPattern;
  37
  38 /// EEVT::DAGISelGenValueType - These are some extended forms of
  39 /// MVT::SimpleValueType that we use as lattice values during type inference.
  40 /// The existing MVT iAny, fAny and vAny types suffice to represent
  41 /// arbitrary integer, floating-point, and vector types, so only an unknown
  42 /// value is needed.
  43 namespace EEVT {
  44   enum DAGISelGenValueType {
  45     // FIXME: Remove EEVT::isUnknown!
  46     isUnknown  = MVT::LAST_VALUETYPE
  47   };
  48
  49   /// TypeSet - This is either empty if it's completely unknown, or holds a set
  50   /// of types.  It is used during type inference because register classes can
  51   /// have multiple possible types and we don't know which one they get until
  52   /// type inference is complete.
  53   ///
  54   /// TypeSet can have three states:
  55   ///    Vector is empty: The type is completely unknown, it can be any valid
  56   ///       target type.
  57   ///    Vector has multiple constrained types: (e.g. v4i32 + v4f32) it is one
  58   ///       of those types only.
  59   ///    Vector has one concrete type: The type is completely known.
  60   ///
  61   class TypeSet {
  62     SmallVector<MVT::SimpleValueType, 2> TypeVec;
  63   public:
  64     TypeSet() {}
  65     TypeSet(MVT::SimpleValueType VT, TreePattern &TP);
  66     TypeSet(const std::vector<MVT::SimpleValueType> &VTList);
  67
  68     bool isCompletelyUnknown() const { return TypeVec.empty(); }
  69
  70     bool isConcrete() const {
  71       if (TypeVec.size() != 1) return false;
  72       unsigned char T = TypeVec[0]; (void)T;
  73       assert(T < MVT::LAST_VALUETYPE || T == MVT::iPTR || T == MVT::iPTRAny);
  74       return true;
  75     }
  76
  77     MVT::SimpleValueType getConcrete() const {
  78       assert(isConcrete() && "Type isn't concrete yet");
  79       return (MVT::SimpleValueType)TypeVec[0];
  80     }
  81
  82     bool isDynamicallyResolved() const {
  83       return getConcrete() == MVT::iPTR || getConcrete() == MVT::iPTRAny;
  84     }
  85
  86     const SmallVectorImpl<MVT::SimpleValueType> &getTypeList() const {
  87       assert(!TypeVec.empty() && "Not a type list!");
  88       return TypeVec;
  89     }
  90
  91     bool isVoid() const {
  92       return TypeVec.size() == 1 && TypeVec[0] == MVT::isVoid;
  93     }
  94
  95     /// hasIntegerTypes - Return true if this TypeSet contains any integer value
  96     /// types.
  97     bool hasIntegerTypes() const;
  98
  99     /// hasFloatingPointTypes - Return true if this TypeSet contains an fAny or
 100     /// a floating point value type.
 101     bool hasFloatingPointTypes() const;
 102
 103     /// hasVectorTypes - Return true if this TypeSet contains a vector value
 104     /// type.
 105     bool hasVectorTypes() const;
 106
 107     /// getName() - Return this TypeSet as a string.
 108     std::string getName() const;
 109
 110     /// MergeInTypeInfo - This merges in type information from the specified
 111     /// argument.  If 'this' changes, it returns true.  If the two types are
 112     /// contradictory (e.g. merge f32 into i32) then this throws an exception.
 113     bool MergeInTypeInfo(const EEVT::TypeSet &InVT, TreePattern &TP);
 114
 115     bool MergeInTypeInfo(MVT::SimpleValueType InVT, TreePattern &TP) {
 116       return MergeInTypeInfo(EEVT::TypeSet(InVT, TP), TP);
 117     }
 118
 119     /// Force this type list to only contain integer types.
 120     bool EnforceInteger(TreePattern &TP);
 121
 122     /// Force this type list to only contain floating point types.
 123     bool EnforceFloatingPoint(TreePattern &TP);
 124
 125     /// EnforceScalar - Remove all vector types from this type list.
 126     bool EnforceScalar(TreePattern &TP);
 127
 128     /// EnforceVector - Remove all non-vector types from this type list.
 129     bool EnforceVector(TreePattern &TP);
 130
 131     /// EnforceSmallerThan - 'this' must be a smaller VT than Other.  Update
 132     /// this an other based on this information.
 133     bool EnforceSmallerThan(EEVT::TypeSet &Other, TreePattern &TP);
 134
 135     /// EnforceVectorEltTypeIs - 'this' is now constrainted to be a vector type
 136     /// whose element is VT.
 137     bool EnforceVectorEltTypeIs(MVT::SimpleValueType VT, TreePattern &TP);
 138
 139     bool operator!=(const TypeSet &RHS) const { return TypeVec != RHS.TypeVec; }
 140     bool operator==(const TypeSet &RHS) const { return TypeVec == RHS.TypeVec; }
 141   };
 142 }
 143
 144 /// Set type used to track multiply used variables in patterns
 145 typedef std::set<std::string> MultipleUseVarSet;
 146
 147 /// SDTypeConstraint - This is a discriminated union of constraints,
 148 /// corresponding to the SDTypeConstraint tablegen class in Target.td.
 149 struct SDTypeConstraint {
 150   SDTypeConstraint(Record *R);
 151
 152   unsigned OperandNo;   // The operand # this constraint applies to.
 153   enum {
 154     SDTCisVT, SDTCisPtrTy, SDTCisInt, SDTCisFP, SDTCisVec, SDTCisSameAs,
 155     SDTCisVTSmallerThanOp, SDTCisOpSmallerThanOp, SDTCisEltOfVec
 156   } ConstraintType;
 157
 158   union {   // The discriminated union.
 159     struct {
 160       MVT::SimpleValueType VT;
 161     } SDTCisVT_Info;
 162     struct {
 163       unsigned OtherOperandNum;
 164     } SDTCisSameAs_Info;
 165     struct {
 166       unsigned OtherOperandNum;
 167     } SDTCisVTSmallerThanOp_Info;
 168     struct {
 169       unsigned BigOperandNum;
 170     } SDTCisOpSmallerThanOp_Info;
 171     struct {
 172       unsigned OtherOperandNum;
 173     } SDTCisEltOfVec_Info;
 174   } x;
 175
 176   /// ApplyTypeConstraint - Given a node in a pattern, apply this type
 177   /// constraint to the nodes operands.  This returns true if it makes a
 178   /// change, false otherwise.  If a type contradiction is found, throw an
 179   /// exception.
 180   bool ApplyTypeConstraint(TreePatternNode *N, const SDNodeInfo &NodeInfo,
 181                            TreePattern &TP) const;
 182
 183   /// getOperandNum - Return the node corresponding to operand #OpNo in tree
 184   /// N, which has NumResults results.
 185   TreePatternNode *getOperandNum(unsigned OpNo, TreePatternNode *N,
 186                                  unsigned NumResults) const;
 187 };
 188
 189 /// SDNodeInfo - One of these records is created for each SDNode instance in
 190 /// the target .td file.  This represents the various dag nodes we will be
 191 /// processing.
 192 class SDNodeInfo {
 193   Record *Def;
 194   std::string EnumName;
 195   std::string SDClassName;
 196   unsigned Properties;
 197   unsigned NumResults;
 198   int NumOperands;
 199   std::vector<SDTypeConstraint> TypeConstraints;
 200 public:
 201   SDNodeInfo(Record *R);  // Parse the specified record.
 202
 203   unsigned getNumResults() const { return NumResults; }
 204   int getNumOperands() const { return NumOperands; }
 205   Record *getRecord() const { return Def; }
 206   const std::string &getEnumName() const { return EnumName; }
 207   const std::string &getSDClassName() const { return SDClassName; }
 208
 209   const std::vector<SDTypeConstraint> &getTypeConstraints() const {
 210     return TypeConstraints;
 211   }
 212
 213   /// getKnownType - If the type constraints on this node imply a fixed type
 214   /// (e.g. all stores return void, etc), then return it as an
 215   /// MVT::SimpleValueType.  Otherwise, return EEVT::isUnknown.
 216   unsigned getKnownType() const;
 217
 218   /// hasProperty - Return true if this node has the specified property.
 219   ///
 220   bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
 221
 222   /// ApplyTypeConstraints - Given a node in a pattern, apply the type
 223   /// constraints for this node to the operands of the node.  This returns
 224   /// true if it makes a change, false otherwise.  If a type contradiction is
 225   /// found, throw an exception.
 226   bool ApplyTypeConstraints(TreePatternNode *N, TreePattern &TP) const {
 227     bool MadeChange = false;
 228     for (unsigned i = 0, e = TypeConstraints.size(); i != e; ++i)
 229       MadeChange |= TypeConstraints[i].ApplyTypeConstraint(N, *this, TP);
 230     return MadeChange;
 231   }
 232 };
 233
 234 /// FIXME: TreePatternNode's can be shared in some cases (due to dag-shaped
 235 /// patterns), and as such should be ref counted.  We currently just leak all
 236 /// TreePatternNode objects!
 237 class TreePatternNode {
 238   /// The type of this node.  Before and during type inference, this may be a
 239   /// set of possible types.  After (successful) type inference, this is a
 240   /// single type.
 241   EEVT::TypeSet Type;
 242
 243   /// Operator - The Record for the operator if this is an interior node (not
 244   /// a leaf).
 245   Record *Operator;
 246
 247   /// Val - The init value (e.g. the "GPRC" record, or "7") for a leaf.
 248   ///
 249   Init *Val;
 250
 251   /// Name - The name given to this node with the :$foo notation.
 252   ///
 253   std::string Name;
 254
 255   /// PredicateFns - The predicate functions to execute on this node to check
 256   /// for a match.  If this list is empty, no predicate is involved.
 257   std::vector<std::string> PredicateFns;
 258
 259   /// TransformFn - The transformation function to execute on this node before
 260   /// it can be substituted into the resulting instruction on a pattern match.
 261   Record *TransformFn;
 262
 263   std::vector<TreePatternNode*> Children;
 264 public:
 265   TreePatternNode(Record *Op, const std::vector<TreePatternNode*> &Ch)
 266     : Operator(Op), Val(0), TransformFn(0), Children(Ch) { }
 267   TreePatternNode(Init *val)    // leaf ctor
 268     : Operator(0), Val(val), TransformFn(0) {
 269   }
 270   ~TreePatternNode();
 271
 272   const std::string &getName() const { return Name; }
 273   void setName(const std::string &N) { Name = N; }
 274
 275   bool isLeaf() const { return Val != 0; }
 276
 277   // Type accessors.
 278   MVT::SimpleValueType getType() const { return Type.getConcrete(); }
 279   const EEVT::TypeSet &getExtType() const { return Type; }
 280   EEVT::TypeSet &getExtType() { return Type; }
 281   void setType(const EEVT::TypeSet &T) { Type = T; }
 282
 283   bool hasTypeSet() const { return Type.isConcrete(); }
 284   bool isTypeCompletelyUnknown() const { return Type.isCompletelyUnknown(); }
 285   bool isTypeDynamicallyResolved() const { return Type.isDynamicallyResolved();}
 286
 287   Init *getLeafValue() const { assert(isLeaf()); return Val; }
 288   Record *getOperator() const { assert(!isLeaf()); return Operator; }
 289
 290   unsigned getNumChildren() const { return Children.size(); }
 291   TreePatternNode *getChild(unsigned N) const { return Children[N]; }
 292   void setChild(unsigned i, TreePatternNode *N) {
 293     Children[i] = N;
 294   }
 295
 296   /// hasChild - Return true if N is any of our children.
 297   bool hasChild(const TreePatternNode *N) const {
 298     for (unsigned i = 0, e = Children.size(); i != e; ++i)
 299       if (Children[i] == N) return true;
 300     return false;
 301   }
 302
 303   const std::vector<std::string> &getPredicateFns() const {return PredicateFns;}
 304   void clearPredicateFns() { PredicateFns.clear(); }
 305   void setPredicateFns(const std::vector<std::string> &Fns) {
 306     assert(PredicateFns.empty() && "Overwriting non-empty predicate list!");
 307     PredicateFns = Fns;
 308   }
 309   void addPredicateFn(const std::string &Fn) {
 310     assert(!Fn.empty() && "Empty predicate string!");
 311     if (std::find(PredicateFns.begin(), PredicateFns.end(), Fn) ==
 312           PredicateFns.end())
 313       PredicateFns.push_back(Fn);
 314   }
 315
 316   Record *getTransformFn() const { return TransformFn; }
 317   void setTransformFn(Record *Fn) { TransformFn = Fn; }
 318
 319   /// getIntrinsicInfo - If this node corresponds to an intrinsic, return the
 320   /// CodeGenIntrinsic information for it, otherwise return a null pointer.
 321   const CodeGenIntrinsic *getIntrinsicInfo(const CodeGenDAGPatterns &CDP) const;
 322
 323   /// getComplexPatternInfo - If this node corresponds to a ComplexPattern,
 324   /// return the ComplexPattern information, otherwise return null.
 325   const ComplexPattern *
 326   getComplexPatternInfo(const CodeGenDAGPatterns &CGP) const;
 327
 328   /// NodeHasProperty - Return true if this node has the specified property.
 329   bool NodeHasProperty(SDNP Property, const CodeGenDAGPatterns &CGP) const;
 330
 331   /// TreeHasProperty - Return true if any node in this tree has the specified
 332   /// property.
 333   bool TreeHasProperty(SDNP Property, const CodeGenDAGPatterns &CGP) const;
 334
 335   /// isCommutativeIntrinsic - Return true if the node is an intrinsic which is
 336   /// marked isCommutative.
 337   bool isCommutativeIntrinsic(const CodeGenDAGPatterns &CDP) const;
 338
 339   void print(raw_ostream &OS) const;
 340   void dump() const;
 341
 342 public:   // Higher level manipulation routines.
 343
 344   /// clone - Return a new copy of this tree.
 345   ///
 346   TreePatternNode *clone() const;
 347
 348   /// RemoveAllTypes - Recursively strip all the types of this tree.
 349   void RemoveAllTypes();
 350
 351   /// isIsomorphicTo - Return true if this node is recursively isomorphic to
 352   /// the specified node.  For this comparison, all of the state of the node
 353   /// is considered, except for the assigned name.  Nodes with differing names
 354   /// that are otherwise identical are considered isomorphic.
 355   bool isIsomorphicTo(const TreePatternNode *N,
 356                       const MultipleUseVarSet &DepVars) const;
 357
 358   /// SubstituteFormalArguments - Replace the formal arguments in this tree
 359   /// with actual values specified by ArgMap.
 360   void SubstituteFormalArguments(std::map<std::string,
 361                                           TreePatternNode*> &ArgMap);
 362
 363   /// InlinePatternFragments - If this pattern refers to any pattern
 364   /// fragments, inline them into place, giving us a pattern without any
 365   /// PatFrag references.
 366   TreePatternNode *InlinePatternFragments(TreePattern &TP);
 367
 368   /// ApplyTypeConstraints - Apply all of the type constraints relevant to
 369   /// this node and its children in the tree.  This returns true if it makes a
 370   /// change, false otherwise.  If a type contradiction is found, throw an
 371   /// exception.
 372   bool ApplyTypeConstraints(TreePattern &TP, bool NotRegisters);
 373
 374   /// UpdateNodeType - Set the node type of N to VT if VT contains
 375   /// information.  If N already contains a conflicting type, then throw an
 376   /// exception.  This returns true if any information was updated.
 377   ///
 378   bool UpdateNodeType(const EEVT::TypeSet &InTy, TreePattern &TP) {
 379     return Type.MergeInTypeInfo(InTy, TP);
 380   }
 381
 382   bool UpdateNodeType(MVT::SimpleValueType InTy, TreePattern &TP) {
 383     return Type.MergeInTypeInfo(EEVT::TypeSet(InTy, TP), TP);
 384   }
 385
 386   /// ContainsUnresolvedType - Return true if this tree contains any
 387   /// unresolved types.
 388   bool ContainsUnresolvedType() const {
 389     if (!hasTypeSet()) return true;
 390     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
 391       if (getChild(i)->ContainsUnresolvedType()) return true;
 392     return false;
 393   }
 394
 395   /// canPatternMatch - If it is impossible for this pattern to match on this
 396   /// target, fill in Reason and return false.  Otherwise, return true.
 397   bool canPatternMatch(std::string &Reason, const CodeGenDAGPatterns &CDP);
 398 };
 399
 400 inline raw_ostream &operator<<(raw_ostream &OS, const TreePatternNode &TPN) {
 401   TPN.print(OS);
 402   return OS;
 403 }
 404
 405
 406 /// TreePattern - Represent a pattern, used for instructions, pattern
 407 /// fragments, etc.
 408 ///
 409 class TreePattern {
 410   /// Trees - The list of pattern trees which corresponds to this pattern.
 411   /// Note that PatFrag's only have a single tree.
 412   ///
 413   std::vector<TreePatternNode*> Trees;
 414
 415   /// NamedNodes - This is all of the nodes that have names in the trees in this
 416   /// pattern.
 417   StringMap<SmallVector<TreePatternNode*,1> > NamedNodes;
 418
 419   /// TheRecord - The actual TableGen record corresponding to this pattern.
 420   ///
 421   Record *TheRecord;
 422
 423   /// Args - This is a list of all of the arguments to this pattern (for
 424   /// PatFrag patterns), which are the 'node' markers in this pattern.
 425   std::vector<std::string> Args;
 426
 427   /// CDP - the top-level object coordinating this madness.
 428   ///
 429   CodeGenDAGPatterns &CDP;
 430
 431   /// isInputPattern - True if this is an input pattern, something to match.
 432   /// False if this is an output pattern, something to emit.
 433   bool isInputPattern;
 434 public:
 435
 436   /// TreePattern constructor - Parse the specified DagInits into the
 437   /// current record.
 438   TreePattern(Record *TheRec, ListInit *RawPat, bool isInput,
 439               CodeGenDAGPatterns &ise);
 440   TreePattern(Record *TheRec, DagInit *Pat, bool isInput,
 441               CodeGenDAGPatterns &ise);
 442   TreePattern(Record *TheRec, TreePatternNode *Pat, bool isInput,
 443               CodeGenDAGPatterns &ise);
 444
 445   /// getTrees - Return the tree patterns which corresponds to this pattern.
 446   ///
 447   const std::vector<TreePatternNode*> &getTrees() const { return Trees; }
 448   unsigned getNumTrees() const { return Trees.size(); }
 449   TreePatternNode *getTree(unsigned i) const { return Trees[i]; }
 450   TreePatternNode *getOnlyTree() const {
 451     assert(Trees.size() == 1 && "Doesn't have exactly one pattern!");
 452     return Trees[0];
 453   }
 454
 455   const StringMap<SmallVector<TreePatternNode*,1> > &getNamedNodesMap() {
 456     if (NamedNodes.empty())
 457       ComputeNamedNodes();
 458     return NamedNodes;
 459   }
 460
 461   /// getRecord - Return the actual TableGen record corresponding to this
 462   /// pattern.
 463   ///
 464   Record *getRecord() const { return TheRecord; }
 465
 466   unsigned getNumArgs() const { return Args.size(); }
 467   const std::string &getArgName(unsigned i) const {
 468     assert(i < Args.size() && "Argument reference out of range!");
 469     return Args[i];
 470   }
 471   std::vector<std::string> &getArgList() { return Args; }
 472
 473   CodeGenDAGPatterns &getDAGPatterns() const { return CDP; }
 474
 475   /// InlinePatternFragments - If this pattern refers to any pattern
 476   /// fragments, inline them into place, giving us a pattern without any
 477   /// PatFrag references.
 478   void InlinePatternFragments() {
 479     for (unsigned i = 0, e = Trees.size(); i != e; ++i)
 480       Trees[i] = Trees[i]->InlinePatternFragments(*this);
 481   }
 482
 483   /// InferAllTypes - Infer/propagate as many types throughout the expression
 484   /// patterns as possible.  Return true if all types are inferred, false
 485   /// otherwise.  Throw an exception if a type contradiction is found.
 486   bool InferAllTypes(const StringMap<SmallVector<TreePatternNode*,1> >
 487                           *NamedTypes=0);
 488
 489   /// error - Throw an exception, prefixing it with information about this
 490   /// pattern.
 491   void error(const std::string &Msg) const;
 492
 493   void print(raw_ostream &OS) const;
 494   void dump() const;
 495
 496 private:
 497   TreePatternNode *ParseTreePattern(DagInit *DI);
 498   void ComputeNamedNodes();
 499   void ComputeNamedNodes(TreePatternNode *N);
 500 };
 501
 502 /// DAGDefaultOperand - One of these is created for each PredicateOperand
 503 /// or OptionalDefOperand that has a set ExecuteAlways / DefaultOps field.
 504 struct DAGDefaultOperand {
 505   std::vector<TreePatternNode*> DefaultOps;
 506 };
 507
 508 class DAGInstruction {
 509   TreePattern *Pattern;
 510   std::vector<Record*> Results;
 511   std::vector<Record*> Operands;
 512   std::vector<Record*> ImpResults;
 513   std::vector<Record*> ImpOperands;
 514   TreePatternNode *ResultPattern;
 515 public:
 516   DAGInstruction(TreePattern *TP,
 517                  const std::vector<Record*> &results,
 518                  const std::vector<Record*> &operands,
 519                  const std::vector<Record*> &impresults,
 520                  const std::vector<Record*> &impoperands)
 521     : Pattern(TP), Results(results), Operands(operands),
 522       ImpResults(impresults), ImpOperands(impoperands),
 523       ResultPattern(0) {}
 524
 525   const TreePattern *getPattern() const { return Pattern; }
 526   unsigned getNumResults() const { return Results.size(); }
 527   unsigned getNumOperands() const { return Operands.size(); }
 528   unsigned getNumImpResults() const { return ImpResults.size(); }
 529   unsigned getNumImpOperands() const { return ImpOperands.size(); }
 530   const std::vector<Record*>& getImpResults() const { return ImpResults; }
 531
 532   void setResultPattern(TreePatternNode *R) { ResultPattern = R; }
 533
 534   Record *getResult(unsigned RN) const {
 535     assert(RN < Results.size());
 536     return Results[RN];
 537   }
 538
 539   Record *getOperand(unsigned ON) const {
 540     assert(ON < Operands.size());
 541     return Operands[ON];
 542   }
 543
 544   Record *getImpResult(unsigned RN) const {
 545     assert(RN < ImpResults.size());
 546     return ImpResults[RN];
 547   }
 548
 549   Record *getImpOperand(unsigned ON) const {
 550     assert(ON < ImpOperands.size());
 551     return ImpOperands[ON];
 552   }
 553
 554   TreePatternNode *getResultPattern() const { return ResultPattern; }
 555 };
 556
 557 /// PatternToMatch - Used by CodeGenDAGPatterns to keep tab of patterns
 558 /// processed to produce isel.
 559 class PatternToMatch {
 560 public:
 561   PatternToMatch(ListInit *preds,
 562                  TreePatternNode *src, TreePatternNode *dst,
 563                  const std::vector<Record*> &dstregs,
 564                  unsigned complexity, unsigned uid)
 565     : Predicates(preds), SrcPattern(src), DstPattern(dst),
 566       Dstregs(dstregs), AddedComplexity(complexity), ID(uid) {}
 567
 568   ListInit        *Predicates;  // Top level predicate conditions to match.
 569   TreePatternNode *SrcPattern;  // Source pattern to match.
 570   TreePatternNode *DstPattern;  // Resulting pattern.
 571   std::vector<Record*> Dstregs; // Physical register defs being matched.
 572   unsigned         AddedComplexity; // Add to matching pattern complexity.
 573   unsigned         ID;          // Unique ID for the record.
 574
 575   ListInit        *getPredicates() const { return Predicates; }
 576   TreePatternNode *getSrcPattern() const { return SrcPattern; }
 577   TreePatternNode *getDstPattern() const { return DstPattern; }
 578   const std::vector<Record*> &getDstRegs() const { return Dstregs; }
 579   unsigned         getAddedComplexity() const { return AddedComplexity; }
 580
 581   std::string getPredicateCheck() const;
 582 };
 583
 584 // Deterministic comparison of Record*.
 585 struct RecordPtrCmp {
 586   bool operator()(const Record *LHS, const Record *RHS) const;
 587 };
 588
 589 class CodeGenDAGPatterns {
 590   RecordKeeper &Records;
 591   CodeGenTarget Target;
 592   std::vector<CodeGenIntrinsic> Intrinsics;
 593   std::vector<CodeGenIntrinsic> TgtIntrinsics;
 594
 595   std::map<Record*, SDNodeInfo, RecordPtrCmp> SDNodes;
 596   std::map<Record*, std::pair<Record*, std::string>, RecordPtrCmp> SDNodeXForms;
 597   std::map<Record*, ComplexPattern, RecordPtrCmp> ComplexPatterns;
 598   std::map<Record*, TreePattern*, RecordPtrCmp> PatternFragments;
 599   std::map<Record*, DAGDefaultOperand, RecordPtrCmp> DefaultOperands;
 600   std::map<Record*, DAGInstruction, RecordPtrCmp> Instructions;
 601
 602   // Specific SDNode definitions:
 603   Record *intrinsic_void_sdnode;
 604   Record *intrinsic_w_chain_sdnode, *intrinsic_wo_chain_sdnode;
 605
 606   /// PatternsToMatch - All of the things we are matching on the DAG.  The first
 607   /// value is the pattern to match, the second pattern is the result to
 608   /// emit.
 609   std::vector<PatternToMatch> PatternsToMatch;
 610 public:
 611   CodeGenDAGPatterns(RecordKeeper &R);
 612   ~CodeGenDAGPatterns();
 613
 614   CodeGenTarget &getTargetInfo() { return Target; }
 615   const CodeGenTarget &getTargetInfo() const { return Target; }
 616
 617   Record *getSDNodeNamed(const std::string &Name) const;
 618
 619   const SDNodeInfo &getSDNodeInfo(Record *R) const {
 620     assert(SDNodes.count(R) && "Unknown node!");
 621     return SDNodes.find(R)->second;
 622   }
 623
 624   // Node transformation lookups.
 625   typedef std::pair<Record*, std::string> NodeXForm;
 626   const NodeXForm &getSDNodeTransform(Record *R) const {
 627     assert(SDNodeXForms.count(R) && "Invalid transform!");
 628     return SDNodeXForms.find(R)->second;
 629   }
 630
 631   typedef std::map<Record*, NodeXForm, RecordPtrCmp>::const_iterator
 632           nx_iterator;
 633   nx_iterator nx_begin() const { return SDNodeXForms.begin(); }
 634   nx_iterator nx_end() const { return SDNodeXForms.end(); }
 635
 636
 637   const ComplexPattern &getComplexPattern(Record *R) const {
 638     assert(ComplexPatterns.count(R) && "Unknown addressing mode!");
 639     return ComplexPatterns.find(R)->second;
 640   }
 641
 642   const CodeGenIntrinsic &getIntrinsic(Record *R) const {
 643     for (unsigned i = 0, e = Intrinsics.size(); i != e; ++i)
 644       if (Intrinsics[i].TheDef == R) return Intrinsics[i];
 645     for (unsigned i = 0, e = TgtIntrinsics.size(); i != e; ++i)
 646       if (TgtIntrinsics[i].TheDef == R) return TgtIntrinsics[i];
 647     assert(0 && "Unknown intrinsic!");
 648     abort();
 649   }
 650
 651   const CodeGenIntrinsic &getIntrinsicInfo(unsigned IID) const {
 652     if (IID-1 < Intrinsics.size())
 653       return Intrinsics[IID-1];
 654     if (IID-Intrinsics.size()-1 < TgtIntrinsics.size())
 655       return TgtIntrinsics[IID-Intrinsics.size()-1];
 656     assert(0 && "Bad intrinsic ID!");
 657     abort();
 658   }
 659
 660   unsigned getIntrinsicID(Record *R) const {
 661     for (unsigned i = 0, e = Intrinsics.size(); i != e; ++i)
 662       if (Intrinsics[i].TheDef == R) return i;
 663     for (unsigned i = 0, e = TgtIntrinsics.size(); i != e; ++i)
 664       if (TgtIntrinsics[i].TheDef == R) return i + Intrinsics.size();
 665     assert(0 && "Unknown intrinsic!");
 666     abort();
 667   }
 668
 669   const DAGDefaultOperand &getDefaultOperand(Record *R) const {
 670     assert(DefaultOperands.count(R) &&"Isn't an analyzed default operand!");
 671     return DefaultOperands.find(R)->second;
 672   }
 673
 674   // Pattern Fragment information.
 675   TreePattern *getPatternFragment(Record *R) const {
 676     assert(PatternFragments.count(R) && "Invalid pattern fragment request!");
 677     return PatternFragments.find(R)->second;
 678   }
 679   typedef std::map<Record*, TreePattern*, RecordPtrCmp>::const_iterator
 680           pf_iterator;
 681   pf_iterator pf_begin() const { return PatternFragments.begin(); }
 682   pf_iterator pf_end() const { return PatternFragments.end(); }
 683
 684   // Patterns to match information.
 685   typedef std::vector<PatternToMatch>::const_iterator ptm_iterator;
 686   ptm_iterator ptm_begin() const { return PatternsToMatch.begin(); }
 687   ptm_iterator ptm_end() const { return PatternsToMatch.end(); }
 688
 689
 690
 691   const DAGInstruction &getInstruction(Record *R) const {
 692     assert(Instructions.count(R) && "Unknown instruction!");
 693     return Instructions.find(R)->second;
 694   }
 695
 696   Record *get_intrinsic_void_sdnode() const {
 697     return intrinsic_void_sdnode;
 698   }
 699   Record *get_intrinsic_w_chain_sdnode() const {
 700     return intrinsic_w_chain_sdnode;
 701   }
 702   Record *get_intrinsic_wo_chain_sdnode() const {
 703     return intrinsic_wo_chain_sdnode;
 704   }
 705
 706   bool hasTargetIntrinsics() { return !TgtIntrinsics.empty(); }
 707
 708 private:
 709   void ParseNodeInfo();
 710   void ParseNodeTransforms();
 711   void ParseComplexPatterns();
 712   void ParsePatternFragments();
 713   void ParseDefaultOperands();
 714   void ParseInstructions();
 715   void ParsePatterns();
 716   void InferInstructionFlags();
 717   void GenerateVariants();
 718
 719   void AddPatternToMatch(const TreePattern *Pattern, const PatternToMatch &PTM);
 720   void FindPatternInputsAndOutputs(TreePattern *I, TreePatternNode *Pat,
 721                                    std::map<std::string,
 722                                    TreePatternNode*> &InstInputs,
 723                                    std::map<std::string,
 724                                    TreePatternNode*> &InstResults,
 725                                    std::vector<Record*> &InstImpInputs,
 726                                    std::vector<Record*> &InstImpResults);
 727 };
 728 } // end namespace llvm
 729
 730 #endif