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