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