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