include/llvm/CodeGen/SelectionDAG.h

   1 //===-- llvm/CodeGen/SelectionDAG.h - InstSelection DAG ---------*- 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 SelectionDAG class, and transitively defines the
  11 // SDNode class and subclasses.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CODEGEN_SELECTIONDAG_H
  16 #define LLVM_CODEGEN_SELECTIONDAG_H
  17
  18 #include "llvm/ADT/DenseSet.h"
  19 #include "llvm/ADT/StringMap.h"
  20 #include "llvm/ADT/ilist.h"
  21 #include "llvm/CodeGen/DAGCombine.h"
  22 #include "llvm/CodeGen/SelectionDAGNodes.h"
  23 #include "llvm/Support/RecyclingAllocator.h"
  24 #include "llvm/Target/TargetMachine.h"
  25 #include <cassert>
  26 #include <map>
  27 #include <string>
  28 #include <vector>
  29
  30 namespace llvm {
  31
  32 class AliasAnalysis;
  33 class MachineConstantPoolValue;
  34 class MachineFunction;
  35 class MDNode;
  36 class SDDbgValue;
  37 class TargetLowering;
  38 class TargetSelectionDAGInfo;
  39
  40 class SDVTListNode : public FoldingSetNode {
  41   friend struct FoldingSetTrait<SDVTListNode>;
  42   /// FastID - A reference to an Interned FoldingSetNodeID for this node.
  43   /// The Allocator in SelectionDAG holds the data.
  44   /// SDVTList contains all types which are frequently accessed in SelectionDAG.
  45   /// The size of this list is not expected big so it won't introduce memory penalty.
  46   FoldingSetNodeIDRef FastID;
  47   const EVT *VTs;
  48   unsigned int NumVTs;
  49   /// The hash value for SDVTList is fixed so cache it to avoid hash calculation
  50   unsigned HashValue;
  51 public:
  52   SDVTListNode(const FoldingSetNodeIDRef ID, const EVT *VT, unsigned int Num) :
  53       FastID(ID), VTs(VT), NumVTs(Num) {
  54     HashValue = ID.ComputeHash();
  55   }
  56   SDVTList getSDVTList() {
  57     SDVTList result = {VTs, NumVTs};
  58     return result;
  59   }
  60 };
  61
  62 // Specialize FoldingSetTrait for SDVTListNode
  63 // To avoid computing temp FoldingSetNodeID and hash value.
  64 template<> struct FoldingSetTrait<SDVTListNode> : DefaultFoldingSetTrait<SDVTListNode> {
  65   static void Profile(const SDVTListNode &X, FoldingSetNodeID& ID) {
  66     ID = X.FastID;
  67   }
  68   static bool Equals(const SDVTListNode &X, const FoldingSetNodeID &ID,
  69                      unsigned IDHash, FoldingSetNodeID &TempID) {
  70     if (X.HashValue != IDHash)
  71       return false;
  72     return ID == X.FastID;
  73   }
  74   static unsigned ComputeHash(const SDVTListNode &X, FoldingSetNodeID &TempID) {
  75     return X.HashValue;
  76   }
  77 };
  78
  79 template<> struct ilist_traits<SDNode> : public ilist_default_traits<SDNode> {
  80 private:
  81   mutable ilist_half_node<SDNode> Sentinel;
  82 public:
  83   SDNode *createSentinel() const {
  84     return static_cast<SDNode*>(&Sentinel);
  85   }
  86   static void destroySentinel(SDNode *) {}
  87
  88   SDNode *provideInitialHead() const { return createSentinel(); }
  89   SDNode *ensureHead(SDNode*) const { return createSentinel(); }
  90   static void noteHead(SDNode*, SDNode*) {}
  91
  92   static void deleteNode(SDNode *) {
  93     llvm_unreachable("ilist_traits<SDNode> shouldn't see a deleteNode call!");
  94   }
  95 private:
  96   static void createNode(const SDNode &);
  97 };
  98
  99 /// SDDbgInfo - Keeps track of dbg_value information through SDISel.  We do
 100 /// not build SDNodes for these so as not to perturb the generated code;
 101 /// instead the info is kept off to the side in this structure. Each SDNode may
 102 /// have one or more associated dbg_value entries. This information is kept in
 103 /// DbgValMap.
 104 /// Byval parameters are handled separately because they don't use alloca's,
 105 /// which busts the normal mechanism.  There is good reason for handling all
 106 /// parameters separately:  they may not have code generated for them, they
 107 /// should always go at the beginning of the function regardless of other code
 108 /// motion, and debug info for them is potentially useful even if the parameter
 109 /// is unused.  Right now only byval parameters are handled separately.
 110 class SDDbgInfo {
 111   SmallVector<SDDbgValue*, 32> DbgValues;
 112   SmallVector<SDDbgValue*, 32> ByvalParmDbgValues;
 113   typedef DenseMap<const SDNode*, SmallVector<SDDbgValue*, 2> > DbgValMapType;
 114   DbgValMapType DbgValMap;
 115
 116   void operator=(const SDDbgInfo&) LLVM_DELETED_FUNCTION;
 117   SDDbgInfo(const SDDbgInfo&) LLVM_DELETED_FUNCTION;
 118 public:
 119   SDDbgInfo() {}
 120
 121   void add(SDDbgValue *V, const SDNode *Node, bool isParameter) {
 122     if (isParameter) {
 123       ByvalParmDbgValues.push_back(V);
 124     } else     DbgValues.push_back(V);
 125     if (Node)
 126       DbgValMap[Node].push_back(V);
 127   }
 128
 129   void clear() {
 130     DbgValMap.clear();
 131     DbgValues.clear();
 132     ByvalParmDbgValues.clear();
 133   }
 134
 135   bool empty() const {
 136     return DbgValues.empty() && ByvalParmDbgValues.empty();
 137   }
 138
 139   ArrayRef<SDDbgValue*> getSDDbgValues(const SDNode *Node) {
 140     DbgValMapType::iterator I = DbgValMap.find(Node);
 141     if (I != DbgValMap.end())
 142       return I->second;
 143     return ArrayRef<SDDbgValue*>();
 144   }
 145
 146   typedef SmallVectorImpl<SDDbgValue*>::iterator DbgIterator;
 147   DbgIterator DbgBegin() { return DbgValues.begin(); }
 148   DbgIterator DbgEnd()   { return DbgValues.end(); }
 149   DbgIterator ByvalParmDbgBegin() { return ByvalParmDbgValues.begin(); }
 150   DbgIterator ByvalParmDbgEnd()   { return ByvalParmDbgValues.end(); }
 151 };
 152
 153 class SelectionDAG;
 154 void checkForCycles(const SDNode *N);
 155 void checkForCycles(const SelectionDAG *DAG);
 156
 157 /// SelectionDAG class - This is used to represent a portion of an LLVM function
 158 /// in a low-level Data Dependence DAG representation suitable for instruction
 159 /// selection.  This DAG is constructed as the first step of instruction
 160 /// selection in order to allow implementation of machine specific optimizations
 161 /// and code simplifications.
 162 ///
 163 /// The representation used by the SelectionDAG is a target-independent
 164 /// representation, which has some similarities to the GCC RTL representation,
 165 /// but is significantly more simple, powerful, and is a graph form instead of a
 166 /// linear form.
 167 ///
 168 class SelectionDAG {
 169   const TargetMachine &TM;
 170   const TargetSelectionDAGInfo &TSI;
 171   const TargetLowering *TLI;
 172   MachineFunction *MF;
 173   LLVMContext *Context;
 174   CodeGenOpt::Level OptLevel;
 175
 176   /// EntryNode - The starting token.
 177   SDNode EntryNode;
 178
 179   /// Root - The root of the entire DAG.
 180   SDValue Root;
 181
 182   /// AllNodes - A linked list of nodes in the current DAG.
 183   ilist<SDNode> AllNodes;
 184
 185   /// NodeAllocatorType - The AllocatorType for allocating SDNodes. We use
 186   /// pool allocation with recycling.
 187   typedef RecyclingAllocator<BumpPtrAllocator, SDNode, sizeof(LargestSDNode),
 188                              AlignOf<MostAlignedSDNode>::Alignment>
 189     NodeAllocatorType;
 190
 191   /// NodeAllocator - Pool allocation for nodes.
 192   NodeAllocatorType NodeAllocator;
 193
 194   /// CSEMap - This structure is used to memoize nodes, automatically performing
 195   /// CSE with existing nodes when a duplicate is requested.
 196   FoldingSet<SDNode> CSEMap;
 197
 198   /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
 199   BumpPtrAllocator OperandAllocator;
 200
 201   /// Allocator - Pool allocation for misc. objects that are created once per
 202   /// SelectionDAG.
 203   BumpPtrAllocator Allocator;
 204
 205   /// DbgInfo - Tracks dbg_value information through SDISel.
 206   SDDbgInfo *DbgInfo;
 207
 208 public:
 209   /// DAGUpdateListener - Clients of various APIs that cause global effects on
 210   /// the DAG can optionally implement this interface.  This allows the clients
 211   /// to handle the various sorts of updates that happen.
 212   ///
 213   /// A DAGUpdateListener automatically registers itself with DAG when it is
 214   /// constructed, and removes itself when destroyed in RAII fashion.
 215   struct DAGUpdateListener {
 216     DAGUpdateListener *const Next;
 217     SelectionDAG &DAG;
 218
 219     explicit DAGUpdateListener(SelectionDAG &D)
 220       : Next(D.UpdateListeners), DAG(D) {
 221       DAG.UpdateListeners = this;
 222     }
 223
 224     virtual ~DAGUpdateListener() {
 225       assert(DAG.UpdateListeners == this &&
 226              "DAGUpdateListeners must be destroyed in LIFO order");
 227       DAG.UpdateListeners = Next;
 228     }
 229
 230     /// NodeDeleted - The node N that was deleted and, if E is not null, an
 231     /// equivalent node E that replaced it.
 232     virtual void NodeDeleted(SDNode *N, SDNode *E);
 233
 234     /// NodeUpdated - The node N that was updated.
 235     virtual void NodeUpdated(SDNode *N);
 236   };
 237
 238   /// NewNodesMustHaveLegalTypes - When true, additional steps are taken to
 239   /// ensure that getConstant() and similar functions return DAG nodes that
 240   /// have legal types. This is important after type legalization since
 241   /// any illegally typed nodes generated after this point will not experience
 242   /// type legalization.
 243   bool NewNodesMustHaveLegalTypes;
 244
 245 private:
 246   /// DAGUpdateListener is a friend so it can manipulate the listener stack.
 247   friend struct DAGUpdateListener;
 248
 249   /// UpdateListeners - Linked list of registered DAGUpdateListener instances.
 250   /// This stack is maintained by DAGUpdateListener RAII.
 251   DAGUpdateListener *UpdateListeners;
 252
 253   /// setGraphColorHelper - Implementation of setSubgraphColor.
 254   /// Return whether we had to truncate the search.
 255   ///
 256   bool setSubgraphColorHelper(SDNode *N, const char *Color,
 257                               DenseSet<SDNode *> &visited,
 258                               int level, bool &printed);
 259
 260   void operator=(const SelectionDAG&) LLVM_DELETED_FUNCTION;
 261   SelectionDAG(const SelectionDAG&) LLVM_DELETED_FUNCTION;
 262
 263 public:
 264   explicit SelectionDAG(const TargetMachine &TM, llvm::CodeGenOpt::Level);
 265   ~SelectionDAG();
 266
 267   /// init - Prepare this SelectionDAG to process code in the given
 268   /// MachineFunction.
 269   ///
 270   void init(MachineFunction &mf, const TargetLowering *TLI);
 271
 272   /// clear - Clear state and free memory necessary to make this
 273   /// SelectionDAG ready to process a new block.
 274   ///
 275   void clear();
 276
 277   MachineFunction &getMachineFunction() const { return *MF; }
 278   const TargetMachine &getTarget() const { return TM; }
 279   const TargetLowering &getTargetLoweringInfo() const { return *TLI; }
 280   const TargetSelectionDAGInfo &getSelectionDAGInfo() const { return TSI; }
 281   LLVMContext *getContext() const {return Context; }
 282
 283   /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
 284   ///
 285   void viewGraph(const std::string &Title);
 286   void viewGraph();
 287
 288 #ifndef NDEBUG
 289   std::map<const SDNode *, std::string> NodeGraphAttrs;
 290 #endif
 291
 292   /// clearGraphAttrs - Clear all previously defined node graph attributes.
 293   /// Intended to be used from a debugging tool (eg. gdb).
 294   void clearGraphAttrs();
 295
 296   /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
 297   ///
 298   void setGraphAttrs(const SDNode *N, const char *Attrs);
 299
 300   /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
 301   /// Used from getNodeAttributes.
 302   const std::string getGraphAttrs(const SDNode *N) const;
 303
 304   /// setGraphColor - Convenience for setting node color attribute.
 305   ///
 306   void setGraphColor(const SDNode *N, const char *Color);
 307
 308   /// setGraphColor - Convenience for setting subgraph color attribute.
 309   ///
 310   void setSubgraphColor(SDNode *N, const char *Color);
 311
 312   typedef ilist<SDNode>::const_iterator allnodes_const_iterator;
 313   allnodes_const_iterator allnodes_begin() const { return AllNodes.begin(); }
 314   allnodes_const_iterator allnodes_end() const { return AllNodes.end(); }
 315   typedef ilist<SDNode>::iterator allnodes_iterator;
 316   allnodes_iterator allnodes_begin() { return AllNodes.begin(); }
 317   allnodes_iterator allnodes_end() { return AllNodes.end(); }
 318   ilist<SDNode>::size_type allnodes_size() const {
 319     return AllNodes.size();
 320   }
 321
 322   /// getRoot - Return the root tag of the SelectionDAG.
 323   ///
 324   const SDValue &getRoot() const { return Root; }
 325
 326   /// getEntryNode - Return the token chain corresponding to the entry of the
 327   /// function.
 328   SDValue getEntryNode() const {
 329     return SDValue(const_cast<SDNode *>(&EntryNode), 0);
 330   }
 331
 332   /// setRoot - Set the current root tag of the SelectionDAG.
 333   ///
 334   const SDValue &setRoot(SDValue N) {
 335     assert((!N.getNode() || N.getValueType() == MVT::Other) &&
 336            "DAG root value is not a chain!");
 337     if (N.getNode())
 338       checkForCycles(N.getNode());
 339     Root = N;
 340     if (N.getNode())
 341       checkForCycles(this);
 342     return Root;
 343   }
 344
 345   /// Combine - This iterates over the nodes in the SelectionDAG, folding
 346   /// certain types of nodes together, or eliminating superfluous nodes.  The
 347   /// Level argument controls whether Combine is allowed to produce nodes and
 348   /// types that are illegal on the target.
 349   void Combine(CombineLevel Level, AliasAnalysis &AA,
 350                CodeGenOpt::Level OptLevel);
 351
 352   /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
 353   /// only uses types natively supported by the target.  Returns "true" if it
 354   /// made any changes.
 355   ///
 356   /// Note that this is an involved process that may invalidate pointers into
 357   /// the graph.
 358   bool LegalizeTypes();
 359
 360   /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
 361   /// compatible with the target instruction selector, as indicated by the
 362   /// TargetLowering object.
 363   ///
 364   /// Note that this is an involved process that may invalidate pointers into
 365   /// the graph.
 366   void Legalize();
 367
 368   /// LegalizeVectors - This transforms the SelectionDAG into a SelectionDAG
 369   /// that only uses vector math operations supported by the target.  This is
 370   /// necessary as a separate step from Legalize because unrolling a vector
 371   /// operation can introduce illegal types, which requires running
 372   /// LegalizeTypes again.
 373   ///
 374   /// This returns true if it made any changes; in that case, LegalizeTypes
 375   /// is called again before Legalize.
 376   ///
 377   /// Note that this is an involved process that may invalidate pointers into
 378   /// the graph.
 379   bool LegalizeVectors();
 380
 381   /// RemoveDeadNodes - This method deletes all unreachable nodes in the
 382   /// SelectionDAG.
 383   void RemoveDeadNodes();
 384
 385   /// DeleteNode - Remove the specified node from the system.  This node must
 386   /// have no referrers.
 387   void DeleteNode(SDNode *N);
 388
 389   /// getVTList - Return an SDVTList that represents the list of values
 390   /// specified.
 391   SDVTList getVTList(EVT VT);
 392   SDVTList getVTList(EVT VT1, EVT VT2);
 393   SDVTList getVTList(EVT VT1, EVT VT2, EVT VT3);
 394   SDVTList getVTList(EVT VT1, EVT VT2, EVT VT3, EVT VT4);
 395   SDVTList getVTList(ArrayRef<EVT> VTs);
 396
 397   //===--------------------------------------------------------------------===//
 398   // Node creation methods.
 399   //
 400   SDValue getConstant(uint64_t Val, EVT VT, bool isTarget = false,
 401                       bool isOpaque = false);
 402   SDValue getConstant(const APInt &Val, EVT VT, bool isTarget = false,
 403                       bool isOpaque = false);
 404   SDValue getConstant(const ConstantInt &Val, EVT VT, bool isTarget = false,
 405                       bool isOpaque = false);
 406   SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
 407   SDValue getTargetConstant(uint64_t Val, EVT VT, bool isOpaque = false) {
 408     return getConstant(Val, VT, true, isOpaque);
 409   }
 410   SDValue getTargetConstant(const APInt &Val, EVT VT, bool isOpaque = false) {
 411     return getConstant(Val, VT, true, isOpaque);
 412   }
 413   SDValue getTargetConstant(const ConstantInt &Val, EVT VT,
 414                             bool isOpaque = false) {
 415     return getConstant(Val, VT, true, isOpaque);
 416   }
 417   // The forms below that take a double should only be used for simple
 418   // constants that can be exactly represented in VT.  No checks are made.
 419   SDValue getConstantFP(double Val, EVT VT, bool isTarget = false);
 420   SDValue getConstantFP(const APFloat& Val, EVT VT, bool isTarget = false);
 421   SDValue getConstantFP(const ConstantFP &CF, EVT VT, bool isTarget = false);
 422   SDValue getTargetConstantFP(double Val, EVT VT) {
 423     return getConstantFP(Val, VT, true);
 424   }
 425   SDValue getTargetConstantFP(const APFloat& Val, EVT VT) {
 426     return getConstantFP(Val, VT, true);
 427   }
 428   SDValue getTargetConstantFP(const ConstantFP &Val, EVT VT) {
 429     return getConstantFP(Val, VT, true);
 430   }
 431   SDValue getGlobalAddress(const GlobalValue *GV, SDLoc DL, EVT VT,
 432                            int64_t offset = 0, bool isTargetGA = false,
 433                            unsigned char TargetFlags = 0);
 434   SDValue getTargetGlobalAddress(const GlobalValue *GV, SDLoc DL, EVT VT,
 435                                  int64_t offset = 0,
 436                                  unsigned char TargetFlags = 0) {
 437     return getGlobalAddress(GV, DL, VT, offset, true, TargetFlags);
 438   }
 439   SDValue getFrameIndex(int FI, EVT VT, bool isTarget = false);
 440   SDValue getTargetFrameIndex(int FI, EVT VT) {
 441     return getFrameIndex(FI, VT, true);
 442   }
 443   SDValue getJumpTable(int JTI, EVT VT, bool isTarget = false,
 444                        unsigned char TargetFlags = 0);
 445   SDValue getTargetJumpTable(int JTI, EVT VT, unsigned char TargetFlags = 0) {
 446     return getJumpTable(JTI, VT, true, TargetFlags);
 447   }
 448   SDValue getConstantPool(const Constant *C, EVT VT,
 449                           unsigned Align = 0, int Offs = 0, bool isT=false,
 450                           unsigned char TargetFlags = 0);
 451   SDValue getTargetConstantPool(const Constant *C, EVT VT,
 452                                 unsigned Align = 0, int Offset = 0,
 453                                 unsigned char TargetFlags = 0) {
 454     return getConstantPool(C, VT, Align, Offset, true, TargetFlags);
 455   }
 456   SDValue getConstantPool(MachineConstantPoolValue *C, EVT VT,
 457                           unsigned Align = 0, int Offs = 0, bool isT=false,
 458                           unsigned char TargetFlags = 0);
 459   SDValue getTargetConstantPool(MachineConstantPoolValue *C,
 460                                   EVT VT, unsigned Align = 0,
 461                                   int Offset = 0, unsigned char TargetFlags=0) {
 462     return getConstantPool(C, VT, Align, Offset, true, TargetFlags);
 463   }
 464   SDValue getTargetIndex(int Index, EVT VT, int64_t Offset = 0,
 465                          unsigned char TargetFlags = 0);
 466   // When generating a branch to a BB, we don't in general know enough
 467   // to provide debug info for the BB at that time, so keep this one around.
 468   SDValue getBasicBlock(MachineBasicBlock *MBB);
 469   SDValue getBasicBlock(MachineBasicBlock *MBB, SDLoc dl);
 470   SDValue getExternalSymbol(const char *Sym, EVT VT);
 471   SDValue getExternalSymbol(const char *Sym, SDLoc dl, EVT VT);
 472   SDValue getTargetExternalSymbol(const char *Sym, EVT VT,
 473                                   unsigned char TargetFlags = 0);
 474   SDValue getValueType(EVT);
 475   SDValue getRegister(unsigned Reg, EVT VT);
 476   SDValue getRegisterMask(const uint32_t *RegMask);
 477   SDValue getEHLabel(SDLoc dl, SDValue Root, MCSymbol *Label);
 478   SDValue getBlockAddress(const BlockAddress *BA, EVT VT,
 479                           int64_t Offset = 0, bool isTarget = false,
 480                           unsigned char TargetFlags = 0);
 481   SDValue getTargetBlockAddress(const BlockAddress *BA, EVT VT,
 482                                 int64_t Offset = 0,
 483                                 unsigned char TargetFlags = 0) {
 484     return getBlockAddress(BA, VT, Offset, true, TargetFlags);
 485   }
 486
 487   SDValue getCopyToReg(SDValue Chain, SDLoc dl, unsigned Reg, SDValue N) {
 488     return getNode(ISD::CopyToReg, dl, MVT::Other, Chain,
 489                    getRegister(Reg, N.getValueType()), N);
 490   }
 491
 492   // This version of the getCopyToReg method takes an extra operand, which
 493   // indicates that there is potentially an incoming glue value (if Glue is not
 494   // null) and that there should be a glue result.
 495   SDValue getCopyToReg(SDValue Chain, SDLoc dl, unsigned Reg, SDValue N,
 496                        SDValue Glue) {
 497     SDVTList VTs = getVTList(MVT::Other, MVT::Glue);
 498     SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Glue };
 499     return getNode(ISD::CopyToReg, dl, VTs, Ops, Glue.getNode() ? 4 : 3);
 500   }
 501
 502   // Similar to last getCopyToReg() except parameter Reg is a SDValue
 503   SDValue getCopyToReg(SDValue Chain, SDLoc dl, SDValue Reg, SDValue N,
 504                          SDValue Glue) {
 505     SDVTList VTs = getVTList(MVT::Other, MVT::Glue);
 506     SDValue Ops[] = { Chain, Reg, N, Glue };
 507     return getNode(ISD::CopyToReg, dl, VTs, Ops, Glue.getNode() ? 4 : 3);
 508   }
 509
 510   SDValue getCopyFromReg(SDValue Chain, SDLoc dl, unsigned Reg, EVT VT) {
 511     SDVTList VTs = getVTList(VT, MVT::Other);
 512     SDValue Ops[] = { Chain, getRegister(Reg, VT) };
 513     return getNode(ISD::CopyFromReg, dl, VTs, Ops, 2);
 514   }
 515
 516   // This version of the getCopyFromReg method takes an extra operand, which
 517   // indicates that there is potentially an incoming glue value (if Glue is not
 518   // null) and that there should be a glue result.
 519   SDValue getCopyFromReg(SDValue Chain, SDLoc dl, unsigned Reg, EVT VT,
 520                            SDValue Glue) {
 521     SDVTList VTs = getVTList(VT, MVT::Other, MVT::Glue);
 522     SDValue Ops[] = { Chain, getRegister(Reg, VT), Glue };
 523     return getNode(ISD::CopyFromReg, dl, VTs, Ops, Glue.getNode() ? 3 : 2);
 524   }
 525
 526   SDValue getCondCode(ISD::CondCode Cond);
 527
 528   /// Returns the ConvertRndSat Note: Avoid using this node because it may
 529   /// disappear in the future and most targets don't support it.
 530   SDValue getConvertRndSat(EVT VT, SDLoc dl, SDValue Val, SDValue DTy,
 531                            SDValue STy,
 532                            SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
 533
 534   /// getVectorShuffle - Return an ISD::VECTOR_SHUFFLE node.  The number of
 535   /// elements in VT, which must be a vector type, must match the number of
 536   /// mask elements NumElts.  A integer mask element equal to -1 is treated as
 537   /// undefined.
 538   SDValue getVectorShuffle(EVT VT, SDLoc dl, SDValue N1, SDValue N2,
 539                            const int *MaskElts);
 540
 541   /// getAnyExtOrTrunc - Convert Op, which must be of integer type, to the
 542   /// integer type VT, by either any-extending or truncating it.
 543   SDValue getAnyExtOrTrunc(SDValue Op, SDLoc DL, EVT VT);
 544
 545   /// getSExtOrTrunc - Convert Op, which must be of integer type, to the
 546   /// integer type VT, by either sign-extending or truncating it.
 547   SDValue getSExtOrTrunc(SDValue Op, SDLoc DL, EVT VT);
 548
 549   /// getZExtOrTrunc - Convert Op, which must be of integer type, to the
 550   /// integer type VT, by either zero-extending or truncating it.
 551   SDValue getZExtOrTrunc(SDValue Op, SDLoc DL, EVT VT);
 552
 553   /// getZeroExtendInReg - Return the expression required to zero extend the Op
 554   /// value assuming it was the smaller SrcTy value.
 555   SDValue getZeroExtendInReg(SDValue Op, SDLoc DL, EVT SrcTy);
 556
 557   /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
 558   SDValue getNOT(SDLoc DL, SDValue Val, EVT VT);
 559
 560   /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
 561   /// a glue result (to ensure it's not CSE'd).  CALLSEQ_START does not have a
 562   /// useful SDLoc.
 563   SDValue getCALLSEQ_START(SDValue Chain, SDValue Op, SDLoc DL) {
 564     SDVTList VTs = getVTList(MVT::Other, MVT::Glue);
 565     SDValue Ops[] = { Chain,  Op };
 566     return getNode(ISD::CALLSEQ_START, DL, VTs, Ops, 2);
 567   }
 568
 569   /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
 570   /// glue result (to ensure it's not CSE'd).  CALLSEQ_END does not have
 571   /// a useful SDLoc.
 572   SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
 573                            SDValue InGlue, SDLoc DL) {
 574     SDVTList NodeTys = getVTList(MVT::Other, MVT::Glue);
 575     SmallVector<SDValue, 4> Ops;
 576     Ops.push_back(Chain);
 577     Ops.push_back(Op1);
 578     Ops.push_back(Op2);
 579     Ops.push_back(InGlue);
 580     return getNode(ISD::CALLSEQ_END, DL, NodeTys, &Ops[0],
 581                    (unsigned)Ops.size() - (InGlue.getNode()==nullptr ? 1 : 0));
 582   }
 583
 584   /// getUNDEF - Return an UNDEF node.  UNDEF does not have a useful SDLoc.
 585   SDValue getUNDEF(EVT VT) {
 586     return getNode(ISD::UNDEF, SDLoc(), VT);
 587   }
 588
 589   /// getGLOBAL_OFFSET_TABLE - Return a GLOBAL_OFFSET_TABLE node.  This does
 590   /// not have a useful SDLoc.
 591   SDValue getGLOBAL_OFFSET_TABLE(EVT VT) {
 592     return getNode(ISD::GLOBAL_OFFSET_TABLE, SDLoc(), VT);
 593   }
 594
 595   /// getNode - Gets or creates the specified node.
 596   ///
 597   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT);
 598   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT, SDValue N);
 599   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT, SDValue N1, SDValue N2);
 600   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT,
 601                   SDValue N1, SDValue N2, SDValue N3);
 602   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT,
 603                   SDValue N1, SDValue N2, SDValue N3, SDValue N4);
 604   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT,
 605                   SDValue N1, SDValue N2, SDValue N3, SDValue N4,
 606                   SDValue N5);
 607   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT,
 608                   const SDUse *Ops, unsigned NumOps);
 609   SDValue getNode(unsigned Opcode, SDLoc DL, EVT VT,
 610                   const SDValue *Ops, unsigned NumOps);
 611   SDValue getNode(unsigned Opcode, SDLoc DL,
 612                   ArrayRef<EVT> ResultTys,
 613                   const SDValue *Ops, unsigned NumOps);
 614   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs,
 615                   const SDValue *Ops, unsigned NumOps);
 616   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs);
 617   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs, SDValue N);
 618   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs,
 619                   SDValue N1, SDValue N2);
 620   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs,
 621                   SDValue N1, SDValue N2, SDValue N3);
 622   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs,
 623                   SDValue N1, SDValue N2, SDValue N3, SDValue N4);
 624   SDValue getNode(unsigned Opcode, SDLoc DL, SDVTList VTs,
 625                   SDValue N1, SDValue N2, SDValue N3, SDValue N4,
 626                   SDValue N5);
 627
 628   /// getStackArgumentTokenFactor - Compute a TokenFactor to force all
 629   /// the incoming stack arguments to be loaded from the stack. This is
 630   /// used in tail call lowering to protect stack arguments from being
 631   /// clobbered.
 632   SDValue getStackArgumentTokenFactor(SDValue Chain);
 633
 634   SDValue getMemcpy(SDValue Chain, SDLoc dl, SDValue Dst, SDValue Src,
 635                     SDValue Size, unsigned Align, bool isVol, bool AlwaysInline,
 636                     MachinePointerInfo DstPtrInfo,
 637                     MachinePointerInfo SrcPtrInfo);
 638
 639   SDValue getMemmove(SDValue Chain, SDLoc dl, SDValue Dst, SDValue Src,
 640                      SDValue Size, unsigned Align, bool isVol,
 641                      MachinePointerInfo DstPtrInfo,
 642                      MachinePointerInfo SrcPtrInfo);
 643
 644   SDValue getMemset(SDValue Chain, SDLoc dl, SDValue Dst, SDValue Src,
 645                     SDValue Size, unsigned Align, bool isVol,
 646                     MachinePointerInfo DstPtrInfo);
 647
 648   /// getSetCC - Helper function to make it easier to build SetCC's if you just
 649   /// have an ISD::CondCode instead of an SDValue.
 650   ///
 651   SDValue getSetCC(SDLoc DL, EVT VT, SDValue LHS, SDValue RHS,
 652                    ISD::CondCode Cond) {
 653     assert(LHS.getValueType().isVector() == RHS.getValueType().isVector() &&
 654       "Cannot compare scalars to vectors");
 655     assert(LHS.getValueType().isVector() == VT.isVector() &&
 656       "Cannot compare scalars to vectors");
 657     assert(Cond != ISD::SETCC_INVALID &&
 658         "Cannot create a setCC of an invalid node.");
 659     return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
 660   }
 661
 662   // getSelect - Helper function to make it easier to build Select's if you just
 663   // have operands and don't want to check for vector.
 664   SDValue getSelect(SDLoc DL, EVT VT, SDValue Cond,
 665                     SDValue LHS, SDValue RHS) {
 666     assert(LHS.getValueType() == RHS.getValueType() &&
 667            "Cannot use select on differing types");
 668     assert(VT.isVector() == LHS.getValueType().isVector() &&
 669            "Cannot mix vectors and scalars");
 670     return getNode(Cond.getValueType().isVector() ? ISD::VSELECT : ISD::SELECT, DL, VT,
 671                    Cond, LHS, RHS);
 672   }
 673
 674   /// getSelectCC - Helper function to make it easier to build SelectCC's if you
 675   /// just have an ISD::CondCode instead of an SDValue.
 676   ///
 677   SDValue getSelectCC(SDLoc DL, SDValue LHS, SDValue RHS,
 678                       SDValue True, SDValue False, ISD::CondCode Cond) {
 679     return getNode(ISD::SELECT_CC, DL, True.getValueType(),
 680                    LHS, RHS, True, False, getCondCode(Cond));
 681   }
 682
 683   /// getVAArg - VAArg produces a result and token chain, and takes a pointer
 684   /// and a source value as input.
 685   SDValue getVAArg(EVT VT, SDLoc dl, SDValue Chain, SDValue Ptr,
 686                    SDValue SV, unsigned Align);
 687
 688   /// getAtomic - Gets a node for an atomic op, produces result and chain and
 689   /// takes 3 operands
 690   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, SDValue Chain,
 691                     SDValue Ptr, SDValue Cmp, SDValue Swp,
 692                     MachinePointerInfo PtrInfo, unsigned Alignment,
 693                     AtomicOrdering SuccessOrdering,
 694                     AtomicOrdering FailureOrdering,
 695                     SynchronizationScope SynchScope);
 696   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, SDValue Chain,
 697                     SDValue Ptr, SDValue Cmp, SDValue Swp,
 698                     MachineMemOperand *MMO,
 699                     AtomicOrdering SuccessOrdering,
 700                     AtomicOrdering FailureOrdering,
 701                     SynchronizationScope SynchScope);
 702
 703   /// getAtomic - Gets a node for an atomic op, produces result (if relevant)
 704   /// and chain and takes 2 operands.
 705   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, SDValue Chain,
 706                     SDValue Ptr, SDValue Val, const Value *PtrVal,
 707                     unsigned Alignment, AtomicOrdering Ordering,
 708                     SynchronizationScope SynchScope);
 709   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, SDValue Chain,
 710                     SDValue Ptr, SDValue Val, MachineMemOperand *MMO,
 711                     AtomicOrdering Ordering,
 712                     SynchronizationScope SynchScope);
 713
 714   /// getAtomic - Gets a node for an atomic op, produces result and chain and
 715   /// takes 1 operand.
 716   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, EVT VT,
 717                     SDValue Chain, SDValue Ptr, MachineMemOperand *MMO,
 718                     AtomicOrdering Ordering,
 719                     SynchronizationScope SynchScope);
 720
 721   /// getAtomic - Gets a node for an atomic op, produces result and chain and
 722   /// takes N operands.
 723   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, SDVTList VTList,
 724                     SDValue *Ops, unsigned NumOps, MachineMemOperand *MMO,
 725                     AtomicOrdering SuccessOrdering,
 726                     AtomicOrdering FailureOrdering,
 727                     SynchronizationScope SynchScope);
 728   SDValue getAtomic(unsigned Opcode, SDLoc dl, EVT MemVT, SDVTList VTList,
 729                     SDValue *Ops, unsigned NumOps, MachineMemOperand *MMO,
 730                     AtomicOrdering Ordering, SynchronizationScope SynchScope);
 731
 732   /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
 733   /// result and takes a list of operands. Opcode may be INTRINSIC_VOID,
 734   /// INTRINSIC_W_CHAIN, or a target-specific opcode with a value not
 735   /// less than FIRST_TARGET_MEMORY_OPCODE.
 736   SDValue getMemIntrinsicNode(unsigned Opcode, SDLoc dl, SDVTList VTList,
 737                               const SDValue *Ops, unsigned NumOps,
 738                               EVT MemVT, MachinePointerInfo PtrInfo,
 739                               unsigned Align = 0, bool Vol = false,
 740                               bool ReadMem = true, bool WriteMem = true);
 741
 742   SDValue getMemIntrinsicNode(unsigned Opcode, SDLoc dl, SDVTList VTList,
 743                               const SDValue *Ops, unsigned NumOps,
 744                               EVT MemVT, MachineMemOperand *MMO);
 745
 746   /// getMergeValues - Create a MERGE_VALUES node from the given operands.
 747   SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, SDLoc dl);
 748
 749   /// getLoad - Loads are not normal binary operators: their result type is not
 750   /// determined by their operands, and they produce a value AND a token chain.
 751   ///
 752   SDValue getLoad(EVT VT, SDLoc dl, SDValue Chain, SDValue Ptr,
 753                   MachinePointerInfo PtrInfo, bool isVolatile,
 754                   bool isNonTemporal, bool isInvariant, unsigned Alignment,
 755                   const MDNode *TBAAInfo = nullptr,
 756                   const MDNode *Ranges = nullptr);
 757   SDValue getLoad(EVT VT, SDLoc dl, SDValue Chain, SDValue Ptr,
 758                   MachineMemOperand *MMO);
 759   SDValue getExtLoad(ISD::LoadExtType ExtType, SDLoc dl, EVT VT,
 760                      SDValue Chain, SDValue Ptr, MachinePointerInfo PtrInfo,
 761                      EVT MemVT, bool isVolatile,
 762                      bool isNonTemporal, unsigned Alignment,
 763                      const MDNode *TBAAInfo = nullptr);
 764   SDValue getExtLoad(ISD::LoadExtType ExtType, SDLoc dl, EVT VT,
 765                      SDValue Chain, SDValue Ptr, EVT MemVT,
 766                      MachineMemOperand *MMO);
 767   SDValue getIndexedLoad(SDValue OrigLoad, SDLoc dl, SDValue Base,
 768                          SDValue Offset, ISD::MemIndexedMode AM);
 769   SDValue getLoad(ISD::MemIndexedMode AM, ISD::LoadExtType ExtType,
 770                   EVT VT, SDLoc dl,
 771                   SDValue Chain, SDValue Ptr, SDValue Offset,
 772                   MachinePointerInfo PtrInfo, EVT MemVT,
 773                   bool isVolatile, bool isNonTemporal, bool isInvariant,
 774                   unsigned Alignment, const MDNode *TBAAInfo = nullptr,
 775                   const MDNode *Ranges = nullptr);
 776   SDValue getLoad(ISD::MemIndexedMode AM, ISD::LoadExtType ExtType,
 777                   EVT VT, SDLoc dl,
 778                   SDValue Chain, SDValue Ptr, SDValue Offset,
 779                   EVT MemVT, MachineMemOperand *MMO);
 780
 781   /// getStore - Helper function to build ISD::STORE nodes.
 782   ///
 783   SDValue getStore(SDValue Chain, SDLoc dl, SDValue Val, SDValue Ptr,
 784                    MachinePointerInfo PtrInfo, bool isVolatile,
 785                    bool isNonTemporal, unsigned Alignment,
 786                    const MDNode *TBAAInfo = nullptr);
 787   SDValue getStore(SDValue Chain, SDLoc dl, SDValue Val, SDValue Ptr,
 788                    MachineMemOperand *MMO);
 789   SDValue getTruncStore(SDValue Chain, SDLoc dl, SDValue Val, SDValue Ptr,
 790                         MachinePointerInfo PtrInfo, EVT TVT,
 791                         bool isNonTemporal, bool isVolatile,
 792                         unsigned Alignment,
 793                         const MDNode *TBAAInfo = nullptr);
 794   SDValue getTruncStore(SDValue Chain, SDLoc dl, SDValue Val, SDValue Ptr,
 795                         EVT TVT, MachineMemOperand *MMO);
 796   SDValue getIndexedStore(SDValue OrigStoe, SDLoc dl, SDValue Base,
 797                            SDValue Offset, ISD::MemIndexedMode AM);
 798
 799   /// getSrcValue - Construct a node to track a Value* through the backend.
 800   SDValue getSrcValue(const Value *v);
 801
 802   /// getMDNode - Return an MDNodeSDNode which holds an MDNode.
 803   SDValue getMDNode(const MDNode *MD);
 804
 805   /// getAddrSpaceCast - Return an AddrSpaceCastSDNode.
 806   SDValue getAddrSpaceCast(SDLoc dl, EVT VT, SDValue Ptr,
 807                            unsigned SrcAS, unsigned DestAS);
 808
 809   /// getShiftAmountOperand - Return the specified value casted to
 810   /// the target's desired shift amount type.
 811   SDValue getShiftAmountOperand(EVT LHSTy, SDValue Op);
 812
 813   /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
 814   /// specified operands.  If the resultant node already exists in the DAG,
 815   /// this does not modify the specified node, instead it returns the node that
 816   /// already exists.  If the resultant node does not exist in the DAG, the
 817   /// input node is returned.  As a degenerate case, if you specify the same
 818   /// input operands as the node already has, the input node is returned.
 819   SDNode *UpdateNodeOperands(SDNode *N, SDValue Op);
 820   SDNode *UpdateNodeOperands(SDNode *N, SDValue Op1, SDValue Op2);
 821   SDNode *UpdateNodeOperands(SDNode *N, SDValue Op1, SDValue Op2,
 822                                SDValue Op3);
 823   SDNode *UpdateNodeOperands(SDNode *N, SDValue Op1, SDValue Op2,
 824                                SDValue Op3, SDValue Op4);
 825   SDNode *UpdateNodeOperands(SDNode *N, SDValue Op1, SDValue Op2,
 826                                SDValue Op3, SDValue Op4, SDValue Op5);
 827   SDNode *UpdateNodeOperands(SDNode *N,
 828                                const SDValue *Ops, unsigned NumOps);
 829
 830   /// SelectNodeTo - These are used for target selectors to *mutate* the
 831   /// specified node to have the specified return type, Target opcode, and
 832   /// operands.  Note that target opcodes are stored as
 833   /// ~TargetOpcode in the node opcode field.  The resultant node is returned.
 834   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT);
 835   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT, SDValue Op1);
 836   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
 837                        SDValue Op1, SDValue Op2);
 838   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
 839                        SDValue Op1, SDValue Op2, SDValue Op3);
 840   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
 841                        const SDValue *Ops, unsigned NumOps);
 842   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1, EVT VT2);
 843   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
 844                        EVT VT2, const SDValue *Ops, unsigned NumOps);
 845   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
 846                        EVT VT2, EVT VT3, const SDValue *Ops, unsigned NumOps);
 847   SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, EVT VT1,
 848                        EVT VT2, EVT VT3, EVT VT4, const SDValue *Ops,
 849                        unsigned NumOps);
 850   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
 851                        EVT VT2, SDValue Op1);
 852   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
 853                        EVT VT2, SDValue Op1, SDValue Op2);
 854   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
 855                        EVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
 856   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
 857                        EVT VT2, EVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
 858   SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
 859                        const SDValue *Ops, unsigned NumOps);
 860
 861   /// MorphNodeTo - This *mutates* the specified node to have the specified
 862   /// return type, opcode, and operands.
 863   SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
 864                       const SDValue *Ops, unsigned NumOps);
 865
 866   /// getMachineNode - These are used for target selectors to create a new node
 867   /// with specified return type(s), MachineInstr opcode, and operands.
 868   ///
 869   /// Note that getMachineNode returns the resultant node.  If there is already
 870   /// a node of the specified opcode and operands, it returns that node instead
 871   /// of the current one.
 872   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT);
 873   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT,
 874                                 SDValue Op1);
 875   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT,
 876                                 SDValue Op1, SDValue Op2);
 877   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT,
 878                                 SDValue Op1, SDValue Op2, SDValue Op3);
 879   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT,
 880                                 ArrayRef<SDValue> Ops);
 881   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2);
 882   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 883                                 SDValue Op1);
 884   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 885                                 SDValue Op1, SDValue Op2);
 886   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 887                                 SDValue Op1, SDValue Op2, SDValue Op3);
 888   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 889                                 ArrayRef<SDValue> Ops);
 890   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 891                                 EVT VT3, SDValue Op1, SDValue Op2);
 892   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 893                                 EVT VT3, SDValue Op1, SDValue Op2,
 894                                 SDValue Op3);
 895   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 896                                 EVT VT3, ArrayRef<SDValue> Ops);
 897   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, EVT VT1, EVT VT2,
 898                                 EVT VT3, EVT VT4, ArrayRef<SDValue> Ops);
 899   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl,
 900                                 ArrayRef<EVT> ResultTys,
 901                                 ArrayRef<SDValue> Ops);
 902   MachineSDNode *getMachineNode(unsigned Opcode, SDLoc dl, SDVTList VTs,
 903                                 ArrayRef<SDValue> Ops);
 904
 905   /// getTargetExtractSubreg - A convenience function for creating
 906   /// TargetInstrInfo::EXTRACT_SUBREG nodes.
 907   SDValue getTargetExtractSubreg(int SRIdx, SDLoc DL, EVT VT,
 908                                  SDValue Operand);
 909
 910   /// getTargetInsertSubreg - A convenience function for creating
 911   /// TargetInstrInfo::INSERT_SUBREG nodes.
 912   SDValue getTargetInsertSubreg(int SRIdx, SDLoc DL, EVT VT,
 913                                 SDValue Operand, SDValue Subreg);
 914
 915   /// getNodeIfExists - Get the specified node if it's already available, or
 916   /// else return NULL.
 917   SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
 918                           const SDValue *Ops, unsigned NumOps);
 919
 920   /// getDbgValue - Creates a SDDbgValue node.
 921   ///
 922   SDDbgValue *getDbgValue(MDNode *MDPtr, SDNode *N, unsigned R,
 923                           bool IsIndirect, uint64_t Off,
 924                           DebugLoc DL, unsigned O);
 925   /// Constant.
 926   SDDbgValue *getConstantDbgValue(MDNode *MDPtr, const Value *C, uint64_t Off,
 927                                   DebugLoc DL, unsigned O);
 928   /// Frame index.
 929   SDDbgValue *getFrameIndexDbgValue(MDNode *MDPtr, unsigned FI, uint64_t Off,
 930                                     DebugLoc DL, unsigned O);
 931
 932   /// RemoveDeadNode - Remove the specified node from the system. If any of its
 933   /// operands then becomes dead, remove them as well. Inform UpdateListener
 934   /// for each node deleted.
 935   void RemoveDeadNode(SDNode *N);
 936
 937   /// RemoveDeadNodes - This method deletes the unreachable nodes in the
 938   /// given list, and any nodes that become unreachable as a result.
 939   void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes);
 940
 941   /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
 942   /// This can cause recursive merging of nodes in the DAG.  Use the first
 943   /// version if 'From' is known to have a single result, use the second
 944   /// if you have two nodes with identical results (or if 'To' has a superset
 945   /// of the results of 'From'), use the third otherwise.
 946   ///
 947   /// These methods all take an optional UpdateListener, which (if not null) is
 948   /// informed about nodes that are deleted and modified due to recursive
 949   /// changes in the dag.
 950   ///
 951   /// These functions only replace all existing uses. It's possible that as
 952   /// these replacements are being performed, CSE may cause the From node
 953   /// to be given new uses. These new uses of From are left in place, and
 954   /// not automatically transferred to To.
 955   ///
 956   void ReplaceAllUsesWith(SDValue From, SDValue Op);
 957   void ReplaceAllUsesWith(SDNode *From, SDNode *To);
 958   void ReplaceAllUsesWith(SDNode *From, const SDValue *To);
 959
 960   /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
 961   /// uses of other values produced by From.Val alone.
 962   void ReplaceAllUsesOfValueWith(SDValue From, SDValue To);
 963
 964   /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
 965   /// for multiple values at once. This correctly handles the case where
 966   /// there is an overlap between the From values and the To values.
 967   void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
 968                                   unsigned Num);
 969
 970   /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
 971   /// assign a unique node id for each node in the DAG based on their
 972   /// topological order. Returns the number of nodes.
 973   unsigned AssignTopologicalOrder();
 974
 975   /// RepositionNode - Move node N in the AllNodes list to be immediately
 976   /// before the given iterator Position. This may be used to update the
 977   /// topological ordering when the list of nodes is modified.
 978   void RepositionNode(allnodes_iterator Position, SDNode *N) {
 979     AllNodes.insert(Position, AllNodes.remove(N));
 980   }
 981
 982   /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
 983   /// operation.
 984   static bool isCommutativeBinOp(unsigned Opcode) {
 985     // FIXME: This should get its info from the td file, so that we can include
 986     // target info.
 987     switch (Opcode) {
 988     case ISD::ADD:
 989     case ISD::MUL:
 990     case ISD::MULHU:
 991     case ISD::MULHS:
 992     case ISD::SMUL_LOHI:
 993     case ISD::UMUL_LOHI:
 994     case ISD::FADD:
 995     case ISD::FMUL:
 996     case ISD::AND:
 997     case ISD::OR:
 998     case ISD::XOR:
 999     case ISD::SADDO:
1000     case ISD::UADDO:
1001     case ISD::ADDC:
1002     case ISD::ADDE: return true;
1003     default: return false;
1004     }
1005   }
1006
1007   /// Returns an APFloat semantics tag appropriate for the given type. If VT is
1008   /// a vector type, the element semantics are returned.
1009   static const fltSemantics &EVTToAPFloatSemantics(EVT VT) {
1010     switch (VT.getScalarType().getSimpleVT().SimpleTy) {
1011     default: llvm_unreachable("Unknown FP format");
1012     case MVT::f16:     return APFloat::IEEEhalf;
1013     case MVT::f32:     return APFloat::IEEEsingle;
1014     case MVT::f64:     return APFloat::IEEEdouble;
1015     case MVT::f80:     return APFloat::x87DoubleExtended;
1016     case MVT::f128:    return APFloat::IEEEquad;
1017     case MVT::ppcf128: return APFloat::PPCDoubleDouble;
1018     }
1019   }
1020
1021   /// AddDbgValue - Add a dbg_value SDNode. If SD is non-null that means the
1022   /// value is produced by SD.
1023   void AddDbgValue(SDDbgValue *DB, SDNode *SD, bool isParameter);
1024
1025   /// GetDbgValues - Get the debug values which reference the given SDNode.
1026   ArrayRef<SDDbgValue*> GetDbgValues(const SDNode* SD) {
1027     return DbgInfo->getSDDbgValues(SD);
1028   }
1029
1030   /// TransferDbgValues - Transfer SDDbgValues.
1031   void TransferDbgValues(SDValue From, SDValue To);
1032
1033   /// hasDebugValues - Return true if there are any SDDbgValue nodes associated
1034   /// with this SelectionDAG.
1035   bool hasDebugValues() const { return !DbgInfo->empty(); }
1036
1037   SDDbgInfo::DbgIterator DbgBegin() { return DbgInfo->DbgBegin(); }
1038   SDDbgInfo::DbgIterator DbgEnd()   { return DbgInfo->DbgEnd(); }
1039   SDDbgInfo::DbgIterator ByvalParmDbgBegin() {
1040     return DbgInfo->ByvalParmDbgBegin();
1041   }
1042   SDDbgInfo::DbgIterator ByvalParmDbgEnd()   {
1043     return DbgInfo->ByvalParmDbgEnd();
1044   }
1045
1046   void dump() const;
1047
1048   /// CreateStackTemporary - Create a stack temporary, suitable for holding the
1049   /// specified value type.  If minAlign is specified, the slot size will have
1050   /// at least that alignment.
1051   SDValue CreateStackTemporary(EVT VT, unsigned minAlign = 1);
1052
1053   /// CreateStackTemporary - Create a stack temporary suitable for holding
1054   /// either of the specified value types.
1055   SDValue CreateStackTemporary(EVT VT1, EVT VT2);
1056
1057   /// FoldConstantArithmetic -
1058   SDValue FoldConstantArithmetic(unsigned Opcode, EVT VT,
1059                                  SDNode *Cst1, SDNode *Cst2);
1060
1061   /// FoldSetCC - Constant fold a setcc to true or false.
1062   SDValue FoldSetCC(EVT VT, SDValue N1,
1063                     SDValue N2, ISD::CondCode Cond, SDLoc dl);
1064
1065   /// SignBitIsZero - Return true if the sign bit of Op is known to be zero.  We
1066   /// use this predicate to simplify operations downstream.
1067   bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
1068
1069   /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero.  We
1070   /// use this predicate to simplify operations downstream.  Op and Mask are
1071   /// known to be the same type.
1072   bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
1073     const;
1074
1075   /// ComputeMaskedBits - Determine which of the bits specified in Mask are
1076   /// known to be either zero or one and return them in the KnownZero/KnownOne
1077   /// bitsets.  This code only analyzes bits in Mask, in order to short-circuit
1078   /// processing.  Targets can implement the computeMaskedBitsForTargetNode
1079   /// method in the TargetLowering class to allow target nodes to be understood.
1080   void ComputeMaskedBits(SDValue Op, APInt &KnownZero, APInt &KnownOne,
1081                          unsigned Depth = 0) const;
1082
1083   /// ComputeNumSignBits - Return the number of times the sign bit of the
1084   /// register is replicated into the other bits.  We know that at least 1 bit
1085   /// is always equal to the sign bit (itself), but other cases can give us
1086   /// information.  For example, immediately after an "SRA X, 2", we know that
1087   /// the top 3 bits are all equal to each other, so we return 3.  Targets can
1088   /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
1089   /// class to allow target nodes to be understood.
1090   unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
1091
1092   /// isBaseWithConstantOffset - Return true if the specified operand is an
1093   /// ISD::ADD with a ConstantSDNode on the right-hand side, or if it is an
1094   /// ISD::OR with a ConstantSDNode that is guaranteed to have the same
1095   /// semantics as an ADD.  This handles the equivalence:
1096   ///     X|Cst == X+Cst iff X&Cst = 0.
1097   bool isBaseWithConstantOffset(SDValue Op) const;
1098
1099   /// isKnownNeverNan - Test whether the given SDValue is known to never be NaN.
1100   bool isKnownNeverNaN(SDValue Op) const;
1101
1102   /// isKnownNeverZero - Test whether the given SDValue is known to never be
1103   /// positive or negative Zero.
1104   bool isKnownNeverZero(SDValue Op) const;
1105
1106   /// isEqualTo - Test whether two SDValues are known to compare equal. This
1107   /// is true if they are the same value, or if one is negative zero and the
1108   /// other positive zero.
1109   bool isEqualTo(SDValue A, SDValue B) const;
1110
1111   /// UnrollVectorOp - Utility function used by legalize and lowering to
1112   /// "unroll" a vector operation by splitting out the scalars and operating
1113   /// on each element individually.  If the ResNE is 0, fully unroll the vector
1114   /// op. If ResNE is less than the width of the vector op, unroll up to ResNE.
1115   /// If the  ResNE is greater than the width of the vector op, unroll the
1116   /// vector op and fill the end of the resulting vector with UNDEFS.
1117   SDValue UnrollVectorOp(SDNode *N, unsigned ResNE = 0);
1118
1119   /// isConsecutiveLoad - Return true if LD is loading 'Bytes' bytes from a
1120   /// location that is 'Dist' units away from the location that the 'Base' load
1121   /// is loading from.
1122   bool isConsecutiveLoad(LoadSDNode *LD, LoadSDNode *Base,
1123                          unsigned Bytes, int Dist) const;
1124
1125   /// InferPtrAlignment - Infer alignment of a load / store address. Return 0 if
1126   /// it cannot be inferred.
1127   unsigned InferPtrAlignment(SDValue Ptr) const;
1128
1129   /// GetSplitDestVTs - Compute the VTs needed for the low/hi parts of a type
1130   /// which is split (or expanded) into two not necessarily identical pieces.
1131   std::pair<EVT, EVT> GetSplitDestVTs(const EVT &VT) const;
1132
1133   /// SplitVector - Split the vector with EXTRACT_SUBVECTOR using the provides
1134   /// VTs and return the low/high part.
1135   std::pair<SDValue, SDValue> SplitVector(const SDValue &N, const SDLoc &DL,
1136                                           const EVT &LoVT, const EVT &HiVT);
1137
1138   /// SplitVector - Split the vector with EXTRACT_SUBVECTOR and return the
1139   /// low/high part.
1140   std::pair<SDValue, SDValue> SplitVector(const SDValue &N, const SDLoc &DL) {
1141     EVT LoVT, HiVT;
1142     std::tie(LoVT, HiVT) = GetSplitDestVTs(N.getValueType());
1143     return SplitVector(N, DL, LoVT, HiVT);
1144   }
1145
1146   /// SplitVectorOperand - Split the node's operand with EXTRACT_SUBVECTOR and
1147   /// return the low/high part.
1148   std::pair<SDValue, SDValue> SplitVectorOperand(const SDNode *N, unsigned OpNo)
1149   {
1150     return SplitVector(N->getOperand(OpNo), SDLoc(N));
1151   }
1152
1153   /// ExtractVectorElements - Append the extracted elements from Start to Count
1154   /// out of the vector Op in Args. If Count is 0, all of the elements will be
1155   /// extracted.
1156   void ExtractVectorElements(SDValue Op, SmallVectorImpl<SDValue> &Args,
1157                              unsigned Start = 0, unsigned Count = 0);
1158
1159   unsigned getEVTAlignment(EVT MemoryVT) const;
1160
1161 private:
1162   bool RemoveNodeFromCSEMaps(SDNode *N);
1163   void AddModifiedNodeToCSEMaps(SDNode *N);
1164   SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
1165   SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
1166                                void *&InsertPos);
1167   SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
1168                                void *&InsertPos);
1169   SDNode *UpdadeSDLocOnMergedSDNode(SDNode *N, SDLoc loc);
1170
1171   void DeleteNodeNotInCSEMaps(SDNode *N);
1172   void DeallocateNode(SDNode *N);
1173
1174   void allnodes_clear();
1175
1176   /// VTList - List of non-single value types.
1177   FoldingSet<SDVTListNode> VTListMap;
1178
1179   /// CondCodeNodes - Maps to auto-CSE operations.
1180   std::vector<CondCodeSDNode*> CondCodeNodes;
1181
1182   std::vector<SDNode*> ValueTypeNodes;
1183   std::map<EVT, SDNode*, EVT::compareRawBits> ExtendedValueTypeNodes;
1184   StringMap<SDNode*> ExternalSymbols;
1185
1186   std::map<std::pair<std::string, unsigned char>,SDNode*> TargetExternalSymbols;
1187 };
1188
1189 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
1190   typedef SelectionDAG::allnodes_iterator nodes_iterator;
1191   static nodes_iterator nodes_begin(SelectionDAG *G) {
1192     return G->allnodes_begin();
1193   }
1194   static nodes_iterator nodes_end(SelectionDAG *G) {
1195     return G->allnodes_end();
1196   }
1197 };
1198
1199 }  // end namespace llvm
1200
1201 #endif