utils/TableGen/DAGISelEmitter.h

   1 //===- DAGISelEmitter.h - Generate an instruction selector ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tablegen backend emits a DAG instruction selector.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef DAGISEL_EMITTER_H
  15 #define DAGISEL_EMITTER_H
  16
  17 #include "TableGenBackend.h"
  18 #include "CodeGenTarget.h"
  19 #include "CodeGenIntrinsics.h"
  20 #include <set>
  21
  22 namespace llvm {
  23   class Record;
  24   struct Init;
  25   class ListInit;
  26   class DagInit;
  27   class SDNodeInfo;
  28   class TreePattern;
  29   class TreePatternNode;
  30   class DAGISelEmitter;
  31   class ComplexPattern;
  32
  33   /// MVT::DAGISelGenValueType - These are some extended forms of MVT::ValueType
  34   /// that we use as lattice values during type inferrence.
  35   namespace MVT {
  36     enum DAGISelGenValueType {
  37       isFP  = MVT::LAST_VALUETYPE,
  38       isInt,
  39       isUnknown
  40     };
  41   }
  42
  43   /// SDTypeConstraint - This is a discriminated union of constraints,
  44   /// corresponding to the SDTypeConstraint tablegen class in Target.td.
  45   struct SDTypeConstraint {
  46     SDTypeConstraint(Record *R);
  47
  48     unsigned OperandNo;   // The operand # this constraint applies to.
  49     enum {
  50       SDTCisVT, SDTCisPtrTy, SDTCisInt, SDTCisFP, SDTCisSameAs,
  51       SDTCisVTSmallerThanOp, SDTCisOpSmallerThanOp, SDTCisIntVectorOfSameSize
  52     } ConstraintType;
  53
  54     union {   // The discriminated union.
  55       struct {
  56         MVT::ValueType VT;
  57       } SDTCisVT_Info;
  58       struct {
  59         unsigned OtherOperandNum;
  60       } SDTCisSameAs_Info;
  61       struct {
  62         unsigned OtherOperandNum;
  63       } SDTCisVTSmallerThanOp_Info;
  64       struct {
  65         unsigned BigOperandNum;
  66       } SDTCisOpSmallerThanOp_Info;
  67       struct {
  68         unsigned OtherOperandNum;
  69       } SDTCisIntVectorOfSameSize_Info;
  70     } x;
  71
  72     /// ApplyTypeConstraint - Given a node in a pattern, apply this type
  73     /// constraint to the nodes operands.  This returns true if it makes a
  74     /// change, false otherwise.  If a type contradiction is found, throw an
  75     /// exception.
  76     bool ApplyTypeConstraint(TreePatternNode *N, const SDNodeInfo &NodeInfo,
  77                              TreePattern &TP) const;
  78
  79     /// getOperandNum - Return the node corresponding to operand #OpNo in tree
  80     /// N, which has NumResults results.
  81     TreePatternNode *getOperandNum(unsigned OpNo, TreePatternNode *N,
  82                                    unsigned NumResults) const;
  83   };
  84
  85   /// SDNodeInfo - One of these records is created for each SDNode instance in
  86   /// the target .td file.  This represents the various dag nodes we will be
  87   /// processing.
  88   class SDNodeInfo {
  89     Record *Def;
  90     std::string EnumName;
  91     std::string SDClassName;
  92     unsigned Properties;
  93     unsigned NumResults;
  94     int NumOperands;
  95     std::vector<SDTypeConstraint> TypeConstraints;
  96   public:
  97     SDNodeInfo(Record *R);  // Parse the specified record.
  98
  99     unsigned getNumResults() const { return NumResults; }
 100     int getNumOperands() const { return NumOperands; }
 101     Record *getRecord() const { return Def; }
 102     const std::string &getEnumName() const { return EnumName; }
 103     const std::string &getSDClassName() const { return SDClassName; }
 104
 105     const std::vector<SDTypeConstraint> &getTypeConstraints() const {
 106       return TypeConstraints;
 107     }
 108
 109     // SelectionDAG node properties.
 110     enum SDNP { SDNPCommutative, SDNPAssociative, SDNPHasChain,
 111                 SDNPOutFlag, SDNPInFlag, SDNPOptInFlag  };
 112
 113     /// hasProperty - Return true if this node has the specified property.
 114     ///
 115     bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
 116
 117     /// ApplyTypeConstraints - Given a node in a pattern, apply the type
 118     /// constraints for this node to the operands of the node.  This returns
 119     /// true if it makes a change, false otherwise.  If a type contradiction is
 120     /// found, throw an exception.
 121     bool ApplyTypeConstraints(TreePatternNode *N, TreePattern &TP) const {
 122       bool MadeChange = false;
 123       for (unsigned i = 0, e = TypeConstraints.size(); i != e; ++i)
 124         MadeChange |= TypeConstraints[i].ApplyTypeConstraint(N, *this, TP);
 125       return MadeChange;
 126     }
 127   };
 128
 129   /// FIXME: TreePatternNode's can be shared in some cases (due to dag-shaped
 130   /// patterns), and as such should be ref counted.  We currently just leak all
 131   /// TreePatternNode objects!
 132   class TreePatternNode {
 133     /// The inferred type for this node, or MVT::isUnknown if it hasn't
 134     /// been determined yet.
 135     std::vector<unsigned char> Types;
 136
 137     /// Operator - The Record for the operator if this is an interior node (not
 138     /// a leaf).
 139     Record *Operator;
 140
 141     /// Val - The init value (e.g. the "GPRC" record, or "7") for a leaf.
 142     ///
 143     Init *Val;
 144
 145     /// Name - The name given to this node with the :$foo notation.
 146     ///
 147     std::string Name;
 148
 149     /// PredicateFn - The predicate function to execute on this node to check
 150     /// for a match.  If this string is empty, no predicate is involved.
 151     std::string PredicateFn;
 152
 153     /// TransformFn - The transformation function to execute on this node before
 154     /// it can be substituted into the resulting instruction on a pattern match.
 155     Record *TransformFn;
 156
 157     std::vector<TreePatternNode*> Children;
 158   public:
 159     TreePatternNode(Record *Op, const std::vector<TreePatternNode*> &Ch)
 160       : Types(), Operator(Op), Val(0), TransformFn(0),
 161       Children(Ch) { Types.push_back(MVT::isUnknown); }
 162     TreePatternNode(Init *val)    // leaf ctor
 163       : Types(), Operator(0), Val(val), TransformFn(0) {
 164       Types.push_back(MVT::isUnknown);
 165     }
 166     ~TreePatternNode();
 167
 168     const std::string &getName() const { return Name; }
 169     void setName(const std::string &N) { Name = N; }
 170
 171     bool isLeaf() const { return Val != 0; }
 172     bool hasTypeSet() const { return Types[0] < MVT::LAST_VALUETYPE; }
 173     bool isTypeCompletelyUnknown() const {
 174       return Types[0] == MVT::isUnknown;
 175     }
 176     MVT::ValueType getTypeNum(unsigned Num) const {
 177       assert(hasTypeSet() && "Doesn't have a type yet!");
 178       assert(Types.size() > Num && "Type num out of range!");
 179       return (MVT::ValueType)Types[Num];
 180     }
 181     unsigned char getExtTypeNum(unsigned Num) const {
 182       assert(Types.size() > Num && "Extended type num out of range!");
 183       return Types[Num];
 184     }
 185     const std::vector<unsigned char> &getExtTypes() const { return Types; }
 186     void setTypes(const std::vector<unsigned char> &T) { Types = T; }
 187     void removeTypes() { Types = std::vector<unsigned char>(1,MVT::isUnknown); }
 188
 189     Init *getLeafValue() const { assert(isLeaf()); return Val; }
 190     Record *getOperator() const { assert(!isLeaf()); return Operator; }
 191
 192     unsigned getNumChildren() const { return Children.size(); }
 193     TreePatternNode *getChild(unsigned N) const { return Children[N]; }
 194     void setChild(unsigned i, TreePatternNode *N) {
 195       Children[i] = N;
 196     }
 197
 198
 199     const std::string &getPredicateFn() const { return PredicateFn; }
 200     void setPredicateFn(const std::string &Fn) { PredicateFn = Fn; }
 201
 202     Record *getTransformFn() const { return TransformFn; }
 203     void setTransformFn(Record *Fn) { TransformFn = Fn; }
 204
 205     void print(std::ostream &OS) const;
 206     void dump() const;
 207
 208   public:   // Higher level manipulation routines.
 209
 210     /// clone - Return a new copy of this tree.
 211     ///
 212     TreePatternNode *clone() const;
 213
 214     /// isIsomorphicTo - Return true if this node is recursively isomorphic to
 215     /// the specified node.  For this comparison, all of the state of the node
 216     /// is considered, except for the assigned name.  Nodes with differing names
 217     /// that are otherwise identical are considered isomorphic.
 218     bool isIsomorphicTo(const TreePatternNode *N) const;
 219
 220     /// SubstituteFormalArguments - Replace the formal arguments in this tree
 221     /// with actual values specified by ArgMap.
 222     void SubstituteFormalArguments(std::map<std::string,
 223                                             TreePatternNode*> &ArgMap);
 224
 225     /// InlinePatternFragments - If this pattern refers to any pattern
 226     /// fragments, inline them into place, giving us a pattern without any
 227     /// PatFrag references.
 228     TreePatternNode *InlinePatternFragments(TreePattern &TP);
 229
 230     /// ApplyTypeConstraints - Apply all of the type constraints relevent to
 231     /// this node and its children in the tree.  This returns true if it makes a
 232     /// change, false otherwise.  If a type contradiction is found, throw an
 233     /// exception.
 234     bool ApplyTypeConstraints(TreePattern &TP, bool NotRegisters);
 235
 236     /// UpdateNodeType - Set the node type of N to VT if VT contains
 237     /// information.  If N already contains a conflicting type, then throw an
 238     /// exception.  This returns true if any information was updated.
 239     ///
 240     bool UpdateNodeType(const std::vector<unsigned char> &ExtVTs,
 241                         TreePattern &TP);
 242     bool UpdateNodeType(unsigned char ExtVT, TreePattern &TP) {
 243       std::vector<unsigned char> ExtVTs(1, ExtVT);
 244       return UpdateNodeType(ExtVTs, TP);
 245     }
 246
 247     /// ContainsUnresolvedType - Return true if this tree contains any
 248     /// unresolved types.
 249     bool ContainsUnresolvedType() const {
 250       if (!hasTypeSet()) return true;
 251       for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
 252         if (getChild(i)->ContainsUnresolvedType()) return true;
 253       return false;
 254     }
 255
 256     /// canPatternMatch - If it is impossible for this pattern to match on this
 257     /// target, fill in Reason and return false.  Otherwise, return true.
 258     bool canPatternMatch(std::string &Reason, DAGISelEmitter &ISE);
 259   };
 260
 261
 262   /// TreePattern - Represent a pattern, used for instructions, pattern
 263   /// fragments, etc.
 264   ///
 265   class TreePattern {
 266     /// Trees - The list of pattern trees which corresponds to this pattern.
 267     /// Note that PatFrag's only have a single tree.
 268     ///
 269     std::vector<TreePatternNode*> Trees;
 270
 271     /// TheRecord - The actual TableGen record corresponding to this pattern.
 272     ///
 273     Record *TheRecord;
 274
 275     /// Args - This is a list of all of the arguments to this pattern (for
 276     /// PatFrag patterns), which are the 'node' markers in this pattern.
 277     std::vector<std::string> Args;
 278
 279     /// ISE - the DAG isel emitter coordinating this madness.
 280     ///
 281     DAGISelEmitter &ISE;
 282
 283     /// isInputPattern - True if this is an input pattern, something to match.
 284     /// False if this is an output pattern, something to emit.
 285     bool isInputPattern;
 286   public:
 287
 288     /// TreePattern constructor - Parse the specified DagInits into the
 289     /// current record.
 290     TreePattern(Record *TheRec, ListInit *RawPat, bool isInput,
 291                 DAGISelEmitter &ise);
 292     TreePattern(Record *TheRec, DagInit *Pat, bool isInput,
 293                 DAGISelEmitter &ise);
 294     TreePattern(Record *TheRec, TreePatternNode *Pat, bool isInput,
 295                 DAGISelEmitter &ise);
 296
 297     /// getTrees - Return the tree patterns which corresponds to this pattern.
 298     ///
 299     const std::vector<TreePatternNode*> &getTrees() const { return Trees; }
 300     unsigned getNumTrees() const { return Trees.size(); }
 301     TreePatternNode *getTree(unsigned i) const { return Trees[i]; }
 302     TreePatternNode *getOnlyTree() const {
 303       assert(Trees.size() == 1 && "Doesn't have exactly one pattern!");
 304       return Trees[0];
 305     }
 306
 307     /// getRecord - Return the actual TableGen record corresponding to this
 308     /// pattern.
 309     ///
 310     Record *getRecord() const { return TheRecord; }
 311
 312     unsigned getNumArgs() const { return Args.size(); }
 313     const std::string &getArgName(unsigned i) const {
 314       assert(i < Args.size() && "Argument reference out of range!");
 315       return Args[i];
 316     }
 317     std::vector<std::string> &getArgList() { return Args; }
 318
 319     DAGISelEmitter &getDAGISelEmitter() const { return ISE; }
 320
 321     /// InlinePatternFragments - If this pattern refers to any pattern
 322     /// fragments, inline them into place, giving us a pattern without any
 323     /// PatFrag references.
 324     void InlinePatternFragments() {
 325       for (unsigned i = 0, e = Trees.size(); i != e; ++i)
 326         Trees[i] = Trees[i]->InlinePatternFragments(*this);
 327     }
 328
 329     /// InferAllTypes - Infer/propagate as many types throughout the expression
 330     /// patterns as possible.  Return true if all types are infered, false
 331     /// otherwise.  Throw an exception if a type contradiction is found.
 332     bool InferAllTypes();
 333
 334     /// error - Throw an exception, prefixing it with information about this
 335     /// pattern.
 336     void error(const std::string &Msg) const;
 337
 338     void print(std::ostream &OS) const;
 339     void dump() const;
 340
 341   private:
 342     TreePatternNode *ParseTreePattern(DagInit *DI);
 343   };
 344
 345
 346   class DAGInstruction {
 347     TreePattern *Pattern;
 348     std::vector<Record*> Results;
 349     std::vector<Record*> Operands;
 350     std::vector<Record*> ImpResults;
 351     std::vector<Record*> ImpOperands;
 352     TreePatternNode *ResultPattern;
 353   public:
 354     DAGInstruction(TreePattern *TP,
 355                    const std::vector<Record*> &results,
 356                    const std::vector<Record*> &operands,
 357                    const std::vector<Record*> &impresults,
 358                    const std::vector<Record*> &impoperands)
 359       : Pattern(TP), Results(results), Operands(operands),
 360         ImpResults(impresults), ImpOperands(impoperands),
 361         ResultPattern(0) {}
 362
 363     TreePattern *getPattern() const { return Pattern; }
 364     unsigned getNumResults() const { return Results.size(); }
 365     unsigned getNumOperands() const { return Operands.size(); }
 366     unsigned getNumImpResults() const { return ImpResults.size(); }
 367     unsigned getNumImpOperands() const { return ImpOperands.size(); }
 368
 369     void setResultPattern(TreePatternNode *R) { ResultPattern = R; }
 370
 371     Record *getResult(unsigned RN) const {
 372       assert(RN < Results.size());
 373       return Results[RN];
 374     }
 375
 376     Record *getOperand(unsigned ON) const {
 377       assert(ON < Operands.size());
 378       return Operands[ON];
 379     }
 380
 381     Record *getImpResult(unsigned RN) const {
 382       assert(RN < ImpResults.size());
 383       return ImpResults[RN];
 384     }
 385
 386     Record *getImpOperand(unsigned ON) const {
 387       assert(ON < ImpOperands.size());
 388       return ImpOperands[ON];
 389     }
 390
 391     TreePatternNode *getResultPattern() const { return ResultPattern; }
 392   };
 393
 394 /// PatternToMatch - Used by DAGISelEmitter to keep tab of patterns processed
 395 /// to produce isel.
 396 struct PatternToMatch {
 397   PatternToMatch(ListInit *preds, TreePatternNode *src, TreePatternNode *dst):
 398     Predicates(preds), SrcPattern(src), DstPattern(dst) {};
 399
 400   ListInit        *Predicates;  // Top level predicate conditions to match.
 401   TreePatternNode *SrcPattern;  // Source pattern to match.
 402   TreePatternNode *DstPattern;  // Resulting pattern.
 403
 404   ListInit        *getPredicates() const { return Predicates; }
 405   TreePatternNode *getSrcPattern() const { return SrcPattern; }
 406   TreePatternNode *getDstPattern() const { return DstPattern; }
 407 };
 408
 409 /// DAGISelEmitter - The top-level class which coordinates construction
 410 /// and emission of the instruction selector.
 411 ///
 412 class DAGISelEmitter : public TableGenBackend {
 413 private:
 414   RecordKeeper &Records;
 415   CodeGenTarget Target;
 416   std::vector<CodeGenIntrinsic> Intrinsics;
 417
 418   std::map<Record*, SDNodeInfo> SDNodes;
 419   std::map<Record*, std::pair<Record*, std::string> > SDNodeXForms;
 420   std::map<Record*, ComplexPattern> ComplexPatterns;
 421   std::map<Record*, TreePattern*> PatternFragments;
 422   std::map<Record*, DAGInstruction> Instructions;
 423
 424   // Specific SDNode definitions:
 425   Record *intrinsic_void_sdnode;
 426   Record *intrinsic_w_chain_sdnode, *intrinsic_wo_chain_sdnode;
 427
 428   /// PatternsToMatch - All of the things we are matching on the DAG.  The first
 429   /// value is the pattern to match, the second pattern is the result to
 430   /// emit.
 431   std::vector<PatternToMatch> PatternsToMatch;
 432 public:
 433   DAGISelEmitter(RecordKeeper &R) : Records(R) {}
 434
 435   // run - Output the isel, returning true on failure.
 436   void run(std::ostream &OS);
 437
 438   const CodeGenTarget &getTargetInfo() const { return Target; }
 439
 440   Record *getSDNodeNamed(const std::string &Name) const;
 441
 442   const SDNodeInfo &getSDNodeInfo(Record *R) const {
 443     assert(SDNodes.count(R) && "Unknown node!");
 444     return SDNodes.find(R)->second;
 445   }
 446
 447   const std::pair<Record*, std::string> &getSDNodeTransform(Record *R) const {
 448     assert(SDNodeXForms.count(R) && "Invalid transform!");
 449     return SDNodeXForms.find(R)->second;
 450   }
 451
 452   const ComplexPattern &getComplexPattern(Record *R) const {
 453     assert(ComplexPatterns.count(R) && "Unknown addressing mode!");
 454     return ComplexPatterns.find(R)->second;
 455   }
 456
 457   const CodeGenIntrinsic &getIntrinsic(Record *R) const {
 458     for (unsigned i = 0, e = Intrinsics.size(); i != e; ++i)
 459       if (Intrinsics[i].TheDef == R) return Intrinsics[i];
 460     assert(0 && "Unknown intrinsic!");
 461     abort();
 462   }
 463
 464   const CodeGenIntrinsic &getIntrinsicInfo(unsigned IID) const {
 465     assert(IID-1 < Intrinsics.size() && "Bad intrinsic ID!");
 466     return Intrinsics[IID-1];
 467   }
 468
 469   unsigned getIntrinsicID(Record *R) const {
 470     for (unsigned i = 0, e = Intrinsics.size(); i != e; ++i)
 471       if (Intrinsics[i].TheDef == R) return i;
 472     assert(0 && "Unknown intrinsic!");
 473     abort();
 474   }
 475
 476   TreePattern *getPatternFragment(Record *R) const {
 477     assert(PatternFragments.count(R) && "Invalid pattern fragment request!");
 478     return PatternFragments.find(R)->second;
 479   }
 480
 481   const DAGInstruction &getInstruction(Record *R) const {
 482     assert(Instructions.count(R) && "Unknown instruction!");
 483     return Instructions.find(R)->second;
 484   }
 485
 486   Record *get_intrinsic_void_sdnode() const {
 487     return intrinsic_void_sdnode;
 488   }
 489   Record *get_intrinsic_w_chain_sdnode() const {
 490     return intrinsic_w_chain_sdnode;
 491   }
 492   Record *get_intrinsic_wo_chain_sdnode() const {
 493     return intrinsic_wo_chain_sdnode;
 494   }
 495
 496
 497 private:
 498   void ParseNodeInfo();
 499   void ParseNodeTransforms(std::ostream &OS);
 500   void ParseComplexPatterns();
 501   void ParsePatternFragments(std::ostream &OS);
 502   void ParseInstructions();
 503   void ParsePatterns();
 504   void GenerateVariants();
 505   void FindPatternInputsAndOutputs(TreePattern *I, TreePatternNode *Pat,
 506                                    std::map<std::string,
 507                                             TreePatternNode*> &InstInputs,
 508                                    std::map<std::string,
 509                                             TreePatternNode*> &InstResults,
 510                                    std::vector<Record*> &InstImpInputs,
 511                                    std::vector<Record*> &InstImpResults);
 512   void GenerateCodeForPattern(PatternToMatch &Pattern,
 513                       std::vector<std::pair<bool, std::string> > &GeneratedCode,
 514                          std::set<std::pair<bool, std::string> > &GeneratedDecl,
 515                               bool UseGoto);
 516   void EmitPatterns(std::vector<std::pair<PatternToMatch*,
 517                     std::vector<std::pair<bool, std::string> > > > &Patterns,
 518                     unsigned Indent, std::ostream &OS);
 519   void EmitInstructionSelector(std::ostream &OS);
 520 };
 521
 522 } // End llvm namespace
 523
 524 #endif