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