6419fd3c4ec9a04431534d76d8eebfd1a46dc343
[oota-llvm.git] / include / llvm / CodeGen / SelectionDAGNodes.h
1 //===-- llvm/CodeGen/SelectionDAGNodes.h - SelectionDAG Nodes ---*- 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 SDNode class and derived classes, which are used to
11 // represent the nodes and operations present in a SelectionDAG.  These nodes
12 // and operations are machine code level operations, with some similarities to
13 // the GCC RTL representation.
14 //
15 // Clients should include the SelectionDAG.h file instead of this file directly.
16 //
17 //===----------------------------------------------------------------------===//
18
19 #ifndef LLVM_CODEGEN_SELECTIONDAGNODES_H
20 #define LLVM_CODEGEN_SELECTIONDAGNODES_H
21
22 #include "llvm/ADT/BitVector.h"
23 #include "llvm/ADT/FoldingSet.h"
24 #include "llvm/ADT/GraphTraits.h"
25 #include "llvm/ADT/STLExtras.h"
26 #include "llvm/ADT/SmallPtrSet.h"
27 #include "llvm/ADT/SmallVector.h"
28 #include "llvm/ADT/ilist_node.h"
29 #include "llvm/ADT/iterator_range.h"
30 #include "llvm/CodeGen/ISDOpcodes.h"
31 #include "llvm/CodeGen/MachineMemOperand.h"
32 #include "llvm/CodeGen/ValueTypes.h"
33 #include "llvm/IR/Constants.h"
34 #include "llvm/IR/DebugLoc.h"
35 #include "llvm/IR/Instructions.h"
36 #include "llvm/Support/DataTypes.h"
37 #include "llvm/Support/MathExtras.h"
38 #include <cassert>
39
40 namespace llvm {
41
42 class SelectionDAG;
43 class GlobalValue;
44 class MachineBasicBlock;
45 class MachineConstantPoolValue;
46 class SDNode;
47 class Value;
48 class MCSymbol;
49 template <typename T> struct DenseMapInfo;
50 template <typename T> struct simplify_type;
51 template <typename T> struct ilist_traits;
52
53 void checkForCycles(const SDNode *N, const SelectionDAG *DAG = nullptr,
54                     bool force = false);
55
56 /// This represents a list of ValueType's that has been intern'd by
57 /// a SelectionDAG.  Instances of this simple value class are returned by
58 /// SelectionDAG::getVTList(...).
59 ///
60 struct SDVTList {
61   const EVT *VTs;
62   unsigned int NumVTs;
63 };
64
65 namespace ISD {
66   /// Node predicates
67
68   /// Return true if the specified node is a
69   /// BUILD_VECTOR where all of the elements are ~0 or undef.
70   bool isBuildVectorAllOnes(const SDNode *N);
71
72   /// Return true if the specified node is a
73   /// BUILD_VECTOR where all of the elements are 0 or undef.
74   bool isBuildVectorAllZeros(const SDNode *N);
75
76   /// \brief Return true if the specified node is a BUILD_VECTOR node of
77   /// all ConstantSDNode or undef.
78   bool isBuildVectorOfConstantSDNodes(const SDNode *N);
79
80   /// \brief Return true if the specified node is a BUILD_VECTOR node of
81   /// all ConstantFPSDNode or undef.
82   bool isBuildVectorOfConstantFPSDNodes(const SDNode *N);
83
84   /// Return true if the specified node is a
85   /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
86   /// element is not an undef.
87   bool isScalarToVector(const SDNode *N);
88
89   /// Return true if the node has at least one operand
90   /// and all operands of the specified node are ISD::UNDEF.
91   bool allOperandsUndef(const SDNode *N);
92 }  // end llvm:ISD namespace
93
94 //===----------------------------------------------------------------------===//
95 /// Unlike LLVM values, Selection DAG nodes may return multiple
96 /// values as the result of a computation.  Many nodes return multiple values,
97 /// from loads (which define a token and a return value) to ADDC (which returns
98 /// a result and a carry value), to calls (which may return an arbitrary number
99 /// of values).
100 ///
101 /// As such, each use of a SelectionDAG computation must indicate the node that
102 /// computes it as well as which return value to use from that node.  This pair
103 /// of information is represented with the SDValue value type.
104 ///
105 class SDValue {
106   friend struct DenseMapInfo<SDValue>;
107
108   SDNode *Node;       // The node defining the value we are using.
109   unsigned ResNo;     // Which return value of the node we are using.
110 public:
111   SDValue() : Node(nullptr), ResNo(0) {}
112   SDValue(SDNode *node, unsigned resno);
113
114   /// get the index which selects a specific result in the SDNode
115   unsigned getResNo() const { return ResNo; }
116
117   /// get the SDNode which holds the desired result
118   SDNode *getNode() const { return Node; }
119
120   /// set the SDNode
121   void setNode(SDNode *N) { Node = N; }
122
123   inline SDNode *operator->() const { return Node; }
124
125   bool operator==(const SDValue &O) const {
126     return Node == O.Node && ResNo == O.ResNo;
127   }
128   bool operator!=(const SDValue &O) const {
129     return !operator==(O);
130   }
131   bool operator<(const SDValue &O) const {
132     return std::tie(Node, ResNo) < std::tie(O.Node, O.ResNo);
133   }
134   explicit operator bool() const {
135     return Node != nullptr;
136   }
137
138   SDValue getValue(unsigned R) const {
139     return SDValue(Node, R);
140   }
141
142   // Return true if this node is an operand of N.
143   bool isOperandOf(SDNode *N) const;
144
145   /// Return the ValueType of the referenced return value.
146   inline EVT getValueType() const;
147
148   /// Return the simple ValueType of the referenced return value.
149   MVT getSimpleValueType() const {
150     return getValueType().getSimpleVT();
151   }
152
153   /// Returns the size of the value in bits.
154   unsigned getValueSizeInBits() const {
155     return getValueType().getSizeInBits();
156   }
157
158   unsigned getScalarValueSizeInBits() const {
159     return getValueType().getScalarType().getSizeInBits();
160   }
161
162   // Forwarding methods - These forward to the corresponding methods in SDNode.
163   inline unsigned getOpcode() const;
164   inline unsigned getNumOperands() const;
165   inline const SDValue &getOperand(unsigned i) const;
166   inline uint64_t getConstantOperandVal(unsigned i) const;
167   inline bool isTargetMemoryOpcode() const;
168   inline bool isTargetOpcode() const;
169   inline bool isMachineOpcode() const;
170   inline unsigned getMachineOpcode() const;
171   inline const DebugLoc &getDebugLoc() const;
172   inline void dump() const;
173   inline void dumpr() const;
174
175   /// Return true if this operand (which must be a chain) reaches the
176   /// specified operand without crossing any side-effecting instructions.
177   /// In practice, this looks through token factors and non-volatile loads.
178   /// In order to remain efficient, this only
179   /// looks a couple of nodes in, it does not do an exhaustive search.
180   bool reachesChainWithoutSideEffects(SDValue Dest,
181                                       unsigned Depth = 2) const;
182
183   /// Return true if there are no nodes using value ResNo of Node.
184   inline bool use_empty() const;
185
186   /// Return true if there is exactly one node using value ResNo of Node.
187   inline bool hasOneUse() const;
188 };
189
190
191 template<> struct DenseMapInfo<SDValue> {
192   static inline SDValue getEmptyKey() {
193     SDValue V;
194     V.ResNo = -1U;
195     return V;
196   }
197   static inline SDValue getTombstoneKey() {
198     SDValue V;
199     V.ResNo = -2U;
200     return V;
201   }
202   static unsigned getHashValue(const SDValue &Val) {
203     return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
204             (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
205   }
206   static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
207     return LHS == RHS;
208   }
209 };
210 template <> struct isPodLike<SDValue> { static const bool value = true; };
211
212
213 /// Allow casting operators to work directly on
214 /// SDValues as if they were SDNode*'s.
215 template<> struct simplify_type<SDValue> {
216   typedef SDNode* SimpleType;
217   static SimpleType getSimplifiedValue(SDValue &Val) {
218     return Val.getNode();
219   }
220 };
221 template<> struct simplify_type<const SDValue> {
222   typedef /*const*/ SDNode* SimpleType;
223   static SimpleType getSimplifiedValue(const SDValue &Val) {
224     return Val.getNode();
225   }
226 };
227
228 /// Represents a use of a SDNode. This class holds an SDValue,
229 /// which records the SDNode being used and the result number, a
230 /// pointer to the SDNode using the value, and Next and Prev pointers,
231 /// which link together all the uses of an SDNode.
232 ///
233 class SDUse {
234   /// Val - The value being used.
235   SDValue Val;
236   /// User - The user of this value.
237   SDNode *User;
238   /// Prev, Next - Pointers to the uses list of the SDNode referred by
239   /// this operand.
240   SDUse **Prev, *Next;
241
242   SDUse(const SDUse &U) = delete;
243   void operator=(const SDUse &U) = delete;
244
245 public:
246   SDUse() : Val(), User(nullptr), Prev(nullptr), Next(nullptr) {}
247
248   /// Normally SDUse will just implicitly convert to an SDValue that it holds.
249   operator const SDValue&() const { return Val; }
250
251   /// If implicit conversion to SDValue doesn't work, the get() method returns
252   /// the SDValue.
253   const SDValue &get() const { return Val; }
254
255   /// This returns the SDNode that contains this Use.
256   SDNode *getUser() { return User; }
257
258   /// Get the next SDUse in the use list.
259   SDUse *getNext() const { return Next; }
260
261   /// Convenience function for get().getNode().
262   SDNode *getNode() const { return Val.getNode(); }
263   /// Convenience function for get().getResNo().
264   unsigned getResNo() const { return Val.getResNo(); }
265   /// Convenience function for get().getValueType().
266   EVT getValueType() const { return Val.getValueType(); }
267
268   /// Convenience function for get().operator==
269   bool operator==(const SDValue &V) const {
270     return Val == V;
271   }
272
273   /// Convenience function for get().operator!=
274   bool operator!=(const SDValue &V) const {
275     return Val != V;
276   }
277
278   /// Convenience function for get().operator<
279   bool operator<(const SDValue &V) const {
280     return Val < V;
281   }
282
283 private:
284   friend class SelectionDAG;
285   friend class SDNode;
286
287   void setUser(SDNode *p) { User = p; }
288
289   /// Remove this use from its existing use list, assign it the
290   /// given value, and add it to the new value's node's use list.
291   inline void set(const SDValue &V);
292   /// Like set, but only supports initializing a newly-allocated
293   /// SDUse with a non-null value.
294   inline void setInitial(const SDValue &V);
295   /// Like set, but only sets the Node portion of the value,
296   /// leaving the ResNo portion unmodified.
297   inline void setNode(SDNode *N);
298
299   void addToList(SDUse **List) {
300     Next = *List;
301     if (Next) Next->Prev = &Next;
302     Prev = List;
303     *List = this;
304   }
305
306   void removeFromList() {
307     *Prev = Next;
308     if (Next) Next->Prev = Prev;
309   }
310 };
311
312 /// simplify_type specializations - Allow casting operators to work directly on
313 /// SDValues as if they were SDNode*'s.
314 template<> struct simplify_type<SDUse> {
315   typedef SDNode* SimpleType;
316   static SimpleType getSimplifiedValue(SDUse &Val) {
317     return Val.getNode();
318   }
319 };
320
321
322 /// Represents one node in the SelectionDAG.
323 ///
324 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
325 private:
326   /// The operation that this node performs.
327   int16_t NodeType;
328
329   /// This is true if OperandList was new[]'d.  If true,
330   /// then they will be delete[]'d when the node is destroyed.
331   uint16_t OperandsNeedDelete : 1;
332
333   /// This tracks whether this node has one or more dbg_value
334   /// nodes corresponding to it.
335   uint16_t HasDebugValue : 1;
336
337 protected:
338   /// This member is defined by this class, but is not used for
339   /// anything.  Subclasses can use it to hold whatever state they find useful.
340   /// This field is initialized to zero by the ctor.
341   uint16_t SubclassData : 14;
342
343 private:
344   /// Unique id per SDNode in the DAG.
345   int NodeId;
346
347   /// The values that are used by this operation.
348   SDUse *OperandList;
349
350   /// The types of the values this node defines.  SDNode's may
351   /// define multiple values simultaneously.
352   const EVT *ValueList;
353
354   /// List of uses for this SDNode.
355   SDUse *UseList;
356
357   /// The number of entries in the Operand/Value list.
358   unsigned short NumOperands, NumValues;
359
360   /// Source line information.
361   DebugLoc debugLoc;
362
363   // The ordering of the SDNodes. It roughly corresponds to the ordering of the
364   // original LLVM instructions.
365   // This is used for turning off scheduling, because we'll forgo
366   // the normal scheduling algorithms and output the instructions according to
367   // this ordering.
368   unsigned IROrder;
369
370   /// Return a pointer to the specified value type.
371   static const EVT *getValueTypeList(EVT VT);
372
373   friend class SelectionDAG;
374   friend struct ilist_traits<SDNode>;
375
376 public:
377   //===--------------------------------------------------------------------===//
378   //  Accessors
379   //
380
381   /// Return the SelectionDAG opcode value for this node. For
382   /// pre-isel nodes (those for which isMachineOpcode returns false), these
383   /// are the opcode values in the ISD and <target>ISD namespaces. For
384   /// post-isel opcodes, see getMachineOpcode.
385   unsigned getOpcode()  const { return (unsigned short)NodeType; }
386
387   /// Test if this node has a target-specific opcode (in the
388   /// \<target\>ISD namespace).
389   bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
390
391   /// Test if this node has a target-specific
392   /// memory-referencing opcode (in the \<target\>ISD namespace and
393   /// greater than FIRST_TARGET_MEMORY_OPCODE).
394   bool isTargetMemoryOpcode() const {
395     return NodeType >= ISD::FIRST_TARGET_MEMORY_OPCODE;
396   }
397
398   /// Test if this node is a memory intrinsic (with valid pointer information).
399   /// INTRINSIC_W_CHAIN and INTRINSIC_VOID nodes are sometimes created for
400   /// non-memory intrinsics (with chains) that are not really instances of
401   /// MemSDNode. For such nodes, we need some extra state to determine the
402   /// proper classof relationship.
403   bool isMemIntrinsic() const {
404     return (NodeType == ISD::INTRINSIC_W_CHAIN ||
405             NodeType == ISD::INTRINSIC_VOID) && ((SubclassData >> 13) & 1);
406   }
407
408   /// Test if this node has a post-isel opcode, directly
409   /// corresponding to a MachineInstr opcode.
410   bool isMachineOpcode() const { return NodeType < 0; }
411
412   /// This may only be called if isMachineOpcode returns
413   /// true. It returns the MachineInstr opcode value that the node's opcode
414   /// corresponds to.
415   unsigned getMachineOpcode() const {
416     assert(isMachineOpcode() && "Not a MachineInstr opcode!");
417     return ~NodeType;
418   }
419
420   /// Get this bit.
421   bool getHasDebugValue() const { return HasDebugValue; }
422
423   /// Set this bit.
424   void setHasDebugValue(bool b) { HasDebugValue = b; }
425
426   /// Return true if there are no uses of this node.
427   bool use_empty() const { return UseList == nullptr; }
428
429   /// Return true if there is exactly one use of this node.
430   bool hasOneUse() const {
431     return !use_empty() && std::next(use_begin()) == use_end();
432   }
433
434   /// Return the number of uses of this node. This method takes
435   /// time proportional to the number of uses.
436   size_t use_size() const { return std::distance(use_begin(), use_end()); }
437
438   /// Return the unique node id.
439   int getNodeId() const { return NodeId; }
440
441   /// Set unique node id.
442   void setNodeId(int Id) { NodeId = Id; }
443
444   /// Return the node ordering.
445   unsigned getIROrder() const { return IROrder; }
446
447   /// Set the node ordering.
448   void setIROrder(unsigned Order) { IROrder = Order; }
449
450   /// Return the source location info.
451   const DebugLoc &getDebugLoc() const { return debugLoc; }
452
453   /// Set source location info.  Try to avoid this, putting
454   /// it in the constructor is preferable.
455   void setDebugLoc(DebugLoc dl) { debugLoc = std::move(dl); }
456
457   /// This class provides iterator support for SDUse
458   /// operands that use a specific SDNode.
459   class use_iterator
460     : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
461     SDUse *Op;
462     explicit use_iterator(SDUse *op) : Op(op) {
463     }
464     friend class SDNode;
465   public:
466     typedef std::iterator<std::forward_iterator_tag,
467                           SDUse, ptrdiff_t>::reference reference;
468     typedef std::iterator<std::forward_iterator_tag,
469                           SDUse, ptrdiff_t>::pointer pointer;
470
471     use_iterator(const use_iterator &I) : Op(I.Op) {}
472     use_iterator() : Op(nullptr) {}
473
474     bool operator==(const use_iterator &x) const {
475       return Op == x.Op;
476     }
477     bool operator!=(const use_iterator &x) const {
478       return !operator==(x);
479     }
480
481     /// Return true if this iterator is at the end of uses list.
482     bool atEnd() const { return Op == nullptr; }
483
484     // Iterator traversal: forward iteration only.
485     use_iterator &operator++() {          // Preincrement
486       assert(Op && "Cannot increment end iterator!");
487       Op = Op->getNext();
488       return *this;
489     }
490
491     use_iterator operator++(int) {        // Postincrement
492       use_iterator tmp = *this; ++*this; return tmp;
493     }
494
495     /// Retrieve a pointer to the current user node.
496     SDNode *operator*() const {
497       assert(Op && "Cannot dereference end iterator!");
498       return Op->getUser();
499     }
500
501     SDNode *operator->() const { return operator*(); }
502
503     SDUse &getUse() const { return *Op; }
504
505     /// Retrieve the operand # of this use in its user.
506     unsigned getOperandNo() const {
507       assert(Op && "Cannot dereference end iterator!");
508       return (unsigned)(Op - Op->getUser()->OperandList);
509     }
510   };
511
512   /// Provide iteration support to walk over all uses of an SDNode.
513   use_iterator use_begin() const {
514     return use_iterator(UseList);
515   }
516
517   static use_iterator use_end() { return use_iterator(nullptr); }
518
519   inline iterator_range<use_iterator> uses() {
520     return iterator_range<use_iterator>(use_begin(), use_end());
521   }
522   inline iterator_range<use_iterator> uses() const {
523     return iterator_range<use_iterator>(use_begin(), use_end());
524   }
525
526   /// Return true if there are exactly NUSES uses of the indicated value.
527   /// This method ignores uses of other values defined by this operation.
528   bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
529
530   /// Return true if there are any use of the indicated value.
531   /// This method ignores uses of other values defined by this operation.
532   bool hasAnyUseOfValue(unsigned Value) const;
533
534   /// Return true if this node is the only use of N.
535   bool isOnlyUserOf(SDNode *N) const;
536
537   /// Return true if this node is an operand of N.
538   bool isOperandOf(SDNode *N) const;
539
540   /// Return true if this node is a predecessor of N.
541   /// NOTE: Implemented on top of hasPredecessor and every bit as
542   /// expensive. Use carefully.
543   bool isPredecessorOf(const SDNode *N) const {
544     return N->hasPredecessor(this);
545   }
546
547   /// Return true if N is a predecessor of this node.
548   /// N is either an operand of this node, or can be reached by recursively
549   /// traversing up the operands.
550   /// NOTE: This is an expensive method. Use it carefully.
551   bool hasPredecessor(const SDNode *N) const;
552
553   /// Return true if N is a predecessor of this node.
554   /// N is either an operand of this node, or can be reached by recursively
555   /// traversing up the operands.
556   /// In this helper the Visited and worklist sets are held externally to
557   /// cache predecessors over multiple invocations. If you want to test for
558   /// multiple predecessors this method is preferable to multiple calls to
559   /// hasPredecessor. Be sure to clear Visited and Worklist if the DAG
560   /// changes.
561   /// NOTE: This is still very expensive. Use carefully.
562   bool hasPredecessorHelper(const SDNode *N,
563                             SmallPtrSetImpl<const SDNode *> &Visited,
564                             SmallVectorImpl<const SDNode *> &Worklist) const;
565
566   /// Return the number of values used by this operation.
567   unsigned getNumOperands() const { return NumOperands; }
568
569   /// Helper method returns the integer value of a ConstantSDNode operand.
570   uint64_t getConstantOperandVal(unsigned Num) const;
571
572   const SDValue &getOperand(unsigned Num) const {
573     assert(Num < NumOperands && "Invalid child # of SDNode!");
574     return OperandList[Num];
575   }
576
577   typedef SDUse* op_iterator;
578   op_iterator op_begin() const { return OperandList; }
579   op_iterator op_end() const { return OperandList+NumOperands; }
580   ArrayRef<SDUse> ops() const { return makeArrayRef(op_begin(), op_end()); }
581
582   SDVTList getVTList() const {
583     SDVTList X = { ValueList, NumValues };
584     return X;
585   }
586
587   /// If this node has a glue operand, return the node
588   /// to which the glue operand points. Otherwise return NULL.
589   SDNode *getGluedNode() const {
590     if (getNumOperands() != 0 &&
591       getOperand(getNumOperands()-1).getValueType() == MVT::Glue)
592       return getOperand(getNumOperands()-1).getNode();
593     return nullptr;
594   }
595
596   // If this is a pseudo op, like copyfromreg, look to see if there is a
597   // real target node glued to it.  If so, return the target node.
598   const SDNode *getGluedMachineNode() const {
599     const SDNode *FoundNode = this;
600
601     // Climb up glue edges until a machine-opcode node is found, or the
602     // end of the chain is reached.
603     while (!FoundNode->isMachineOpcode()) {
604       const SDNode *N = FoundNode->getGluedNode();
605       if (!N) break;
606       FoundNode = N;
607     }
608
609     return FoundNode;
610   }
611
612   /// If this node has a glue value with a user, return
613   /// the user (there is at most one). Otherwise return NULL.
614   SDNode *getGluedUser() const {
615     for (use_iterator UI = use_begin(), UE = use_end(); UI != UE; ++UI)
616       if (UI.getUse().get().getValueType() == MVT::Glue)
617         return *UI;
618     return nullptr;
619   }
620
621   /// Return the number of values defined/returned by this operator.
622   unsigned getNumValues() const { return NumValues; }
623
624   /// Return the type of a specified result.
625   EVT getValueType(unsigned ResNo) const {
626     assert(ResNo < NumValues && "Illegal result number!");
627     return ValueList[ResNo];
628   }
629
630   /// Return the type of a specified result as a simple type.
631   MVT getSimpleValueType(unsigned ResNo) const {
632     return getValueType(ResNo).getSimpleVT();
633   }
634
635   /// Returns MVT::getSizeInBits(getValueType(ResNo)).
636   unsigned getValueSizeInBits(unsigned ResNo) const {
637     return getValueType(ResNo).getSizeInBits();
638   }
639
640   typedef const EVT* value_iterator;
641   value_iterator value_begin() const { return ValueList; }
642   value_iterator value_end() const { return ValueList+NumValues; }
643
644   /// Return the opcode of this operation for printing.
645   std::string getOperationName(const SelectionDAG *G = nullptr) const;
646   static const char* getIndexedModeName(ISD::MemIndexedMode AM);
647   void print_types(raw_ostream &OS, const SelectionDAG *G) const;
648   void print_details(raw_ostream &OS, const SelectionDAG *G) const;
649   void print(raw_ostream &OS, const SelectionDAG *G = nullptr) const;
650   void printr(raw_ostream &OS, const SelectionDAG *G = nullptr) const;
651
652   /// Print a SelectionDAG node and all children down to
653   /// the leaves.  The given SelectionDAG allows target-specific nodes
654   /// to be printed in human-readable form.  Unlike printr, this will
655   /// print the whole DAG, including children that appear multiple
656   /// times.
657   ///
658   void printrFull(raw_ostream &O, const SelectionDAG *G = nullptr) const;
659
660   /// Print a SelectionDAG node and children up to
661   /// depth "depth."  The given SelectionDAG allows target-specific
662   /// nodes to be printed in human-readable form.  Unlike printr, this
663   /// will print children that appear multiple times wherever they are
664   /// used.
665   ///
666   void printrWithDepth(raw_ostream &O, const SelectionDAG *G = nullptr,
667                        unsigned depth = 100) const;
668
669
670   /// Dump this node, for debugging.
671   void dump() const;
672
673   /// Dump (recursively) this node and its use-def subgraph.
674   void dumpr() const;
675
676   /// Dump this node, for debugging.
677   /// The given SelectionDAG allows target-specific nodes to be printed
678   /// in human-readable form.
679   void dump(const SelectionDAG *G) const;
680
681   /// Dump (recursively) this node and its use-def subgraph.
682   /// The given SelectionDAG allows target-specific nodes to be printed
683   /// in human-readable form.
684   void dumpr(const SelectionDAG *G) const;
685
686   /// printrFull to dbgs().  The given SelectionDAG allows
687   /// target-specific nodes to be printed in human-readable form.
688   /// Unlike dumpr, this will print the whole DAG, including children
689   /// that appear multiple times.
690   void dumprFull(const SelectionDAG *G = nullptr) const;
691
692   /// printrWithDepth to dbgs().  The given
693   /// SelectionDAG allows target-specific nodes to be printed in
694   /// human-readable form.  Unlike dumpr, this will print children
695   /// that appear multiple times wherever they are used.
696   ///
697   void dumprWithDepth(const SelectionDAG *G = nullptr,
698                       unsigned depth = 100) const;
699
700   /// Gather unique data for the node.
701   void Profile(FoldingSetNodeID &ID) const;
702
703   /// This method should only be used by the SDUse class.
704   void addUse(SDUse &U) { U.addToList(&UseList); }
705
706 protected:
707   static SDVTList getSDVTList(EVT VT) {
708     SDVTList Ret = { getValueTypeList(VT), 1 };
709     return Ret;
710   }
711
712   SDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
713          ArrayRef<SDValue> Ops)
714       : NodeType(Opc), OperandsNeedDelete(true), HasDebugValue(false),
715         SubclassData(0), NodeId(-1),
716         OperandList(Ops.size() ? new SDUse[Ops.size()] : nullptr),
717         ValueList(VTs.VTs), UseList(nullptr), NumOperands(Ops.size()),
718         NumValues(VTs.NumVTs), debugLoc(std::move(dl)), IROrder(Order) {
719     assert(debugLoc.hasTrivialDestructor() && "Expected trivial destructor");
720     assert(NumOperands == Ops.size() &&
721            "NumOperands wasn't wide enough for its operands!");
722     assert(NumValues == VTs.NumVTs &&
723            "NumValues wasn't wide enough for its operands!");
724     for (unsigned i = 0; i != Ops.size(); ++i) {
725       assert(OperandList && "no operands available");
726       OperandList[i].setUser(this);
727       OperandList[i].setInitial(Ops[i]);
728     }
729     checkForCycles(this);
730   }
731
732   /// This constructor adds no operands itself; operands can be
733   /// set later with InitOperands.
734   SDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs)
735       : NodeType(Opc), OperandsNeedDelete(false), HasDebugValue(false),
736         SubclassData(0), NodeId(-1), OperandList(nullptr), ValueList(VTs.VTs),
737         UseList(nullptr), NumOperands(0), NumValues(VTs.NumVTs),
738         debugLoc(std::move(dl)), IROrder(Order) {
739     assert(debugLoc.hasTrivialDestructor() && "Expected trivial destructor");
740     assert(NumValues == VTs.NumVTs &&
741            "NumValues wasn't wide enough for its operands!");
742   }
743
744   /// Initialize the operands list of this with 1 operand.
745   void InitOperands(SDUse *Ops, const SDValue &Op0) {
746     Ops[0].setUser(this);
747     Ops[0].setInitial(Op0);
748     NumOperands = 1;
749     OperandList = Ops;
750     checkForCycles(this);
751   }
752
753   /// Initialize the operands list of this with 2 operands.
754   void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
755     Ops[0].setUser(this);
756     Ops[0].setInitial(Op0);
757     Ops[1].setUser(this);
758     Ops[1].setInitial(Op1);
759     NumOperands = 2;
760     OperandList = Ops;
761     checkForCycles(this);
762   }
763
764   /// Initialize the operands list of this with 3 operands.
765   void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
766                     const SDValue &Op2) {
767     Ops[0].setUser(this);
768     Ops[0].setInitial(Op0);
769     Ops[1].setUser(this);
770     Ops[1].setInitial(Op1);
771     Ops[2].setUser(this);
772     Ops[2].setInitial(Op2);
773     NumOperands = 3;
774     OperandList = Ops;
775     checkForCycles(this);
776   }
777
778   /// Initialize the operands list of this with 4 operands.
779   void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
780                     const SDValue &Op2, const SDValue &Op3) {
781     Ops[0].setUser(this);
782     Ops[0].setInitial(Op0);
783     Ops[1].setUser(this);
784     Ops[1].setInitial(Op1);
785     Ops[2].setUser(this);
786     Ops[2].setInitial(Op2);
787     Ops[3].setUser(this);
788     Ops[3].setInitial(Op3);
789     NumOperands = 4;
790     OperandList = Ops;
791     checkForCycles(this);
792   }
793
794   /// Initialize the operands list of this with N operands.
795   void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
796     for (unsigned i = 0; i != N; ++i) {
797       Ops[i].setUser(this);
798       Ops[i].setInitial(Vals[i]);
799     }
800     NumOperands = N;
801     assert(NumOperands == N &&
802            "NumOperands wasn't wide enough for its operands!");
803     OperandList = Ops;
804     checkForCycles(this);
805   }
806
807   /// Release the operands and set this node to have zero operands.
808   void DropOperands();
809 };
810
811 /// Wrapper class for IR location info (IR ordering and DebugLoc) to be passed
812 /// into SDNode creation functions.
813 /// When an SDNode is created from the DAGBuilder, the DebugLoc is extracted
814 /// from the original Instruction, and IROrder is the ordinal position of
815 /// the instruction.
816 /// When an SDNode is created after the DAG is being built, both DebugLoc and
817 /// the IROrder are propagated from the original SDNode.
818 /// So SDLoc class provides two constructors besides the default one, one to
819 /// be used by the DAGBuilder, the other to be used by others.
820 class SDLoc {
821 private:
822   // Ptr could be used for either Instruction* or SDNode*. It is used for
823   // Instruction* if IROrder is not -1.
824   const void *Ptr;
825   int IROrder;
826
827 public:
828   SDLoc() : Ptr(nullptr), IROrder(0) {}
829   SDLoc(const SDNode *N) : Ptr(N), IROrder(-1) {
830     assert(N && "null SDNode");
831   }
832   SDLoc(const SDValue V) : Ptr(V.getNode()), IROrder(-1) {
833     assert(Ptr && "null SDNode");
834   }
835   SDLoc(const Instruction *I, int Order) : Ptr(I), IROrder(Order) {
836     assert(Order >= 0 && "bad IROrder");
837   }
838   unsigned getIROrder() {
839     if (IROrder >= 0 || Ptr == nullptr) {
840       return (unsigned)IROrder;
841     }
842     const SDNode *N = (const SDNode*)(Ptr);
843     return N->getIROrder();
844   }
845   DebugLoc getDebugLoc() {
846     if (!Ptr) {
847       return DebugLoc();
848     }
849     if (IROrder >= 0) {
850       const Instruction *I = (const Instruction*)(Ptr);
851       return I->getDebugLoc();
852     }
853     const SDNode *N = (const SDNode*)(Ptr);
854     return N->getDebugLoc();
855   }
856 };
857
858
859 // Define inline functions from the SDValue class.
860
861 inline SDValue::SDValue(SDNode *node, unsigned resno)
862     : Node(node), ResNo(resno) {
863   assert((!Node || ResNo < Node->getNumValues()) &&
864          "Invalid result number for the given node!");
865   assert(ResNo < -2U && "Cannot use result numbers reserved for DenseMaps.");
866 }
867
868 inline unsigned SDValue::getOpcode() const {
869   return Node->getOpcode();
870 }
871 inline EVT SDValue::getValueType() const {
872   return Node->getValueType(ResNo);
873 }
874 inline unsigned SDValue::getNumOperands() const {
875   return Node->getNumOperands();
876 }
877 inline const SDValue &SDValue::getOperand(unsigned i) const {
878   return Node->getOperand(i);
879 }
880 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
881   return Node->getConstantOperandVal(i);
882 }
883 inline bool SDValue::isTargetOpcode() const {
884   return Node->isTargetOpcode();
885 }
886 inline bool SDValue::isTargetMemoryOpcode() const {
887   return Node->isTargetMemoryOpcode();
888 }
889 inline bool SDValue::isMachineOpcode() const {
890   return Node->isMachineOpcode();
891 }
892 inline unsigned SDValue::getMachineOpcode() const {
893   return Node->getMachineOpcode();
894 }
895 inline bool SDValue::use_empty() const {
896   return !Node->hasAnyUseOfValue(ResNo);
897 }
898 inline bool SDValue::hasOneUse() const {
899   return Node->hasNUsesOfValue(1, ResNo);
900 }
901 inline const DebugLoc &SDValue::getDebugLoc() const {
902   return Node->getDebugLoc();
903 }
904 inline void SDValue::dump() const {
905   return Node->dump();
906 }
907 inline void SDValue::dumpr() const {
908   return Node->dumpr();
909 }
910 // Define inline functions from the SDUse class.
911
912 inline void SDUse::set(const SDValue &V) {
913   if (Val.getNode()) removeFromList();
914   Val = V;
915   if (V.getNode()) V.getNode()->addUse(*this);
916 }
917
918 inline void SDUse::setInitial(const SDValue &V) {
919   Val = V;
920   V.getNode()->addUse(*this);
921 }
922
923 inline void SDUse::setNode(SDNode *N) {
924   if (Val.getNode()) removeFromList();
925   Val.setNode(N);
926   if (N) N->addUse(*this);
927 }
928
929 /// These are IR-level optimization flags that may be propagated to SDNodes.
930 /// TODO: This data structure should be shared by the IR optimizer and the
931 /// the backend.
932 struct SDNodeFlags {
933 private:
934   bool NoUnsignedWrap : 1;
935   bool NoSignedWrap : 1;
936   bool Exact : 1;
937   bool UnsafeAlgebra : 1;
938   bool NoNaNs : 1;
939   bool NoInfs : 1;
940   bool NoSignedZeros : 1;
941   bool AllowReciprocal : 1;
942
943 public:
944   /// Default constructor turns off all optimization flags.
945   SDNodeFlags() {
946     NoUnsignedWrap = false;
947     NoSignedWrap = false;
948     Exact = false;
949     UnsafeAlgebra = false;
950     NoNaNs = false;
951     NoInfs = false;
952     NoSignedZeros = false;
953     AllowReciprocal = false;
954   }
955
956   // These are mutators for each flag.
957   void setNoUnsignedWrap(bool b) { NoUnsignedWrap = b; }
958   void setNoSignedWrap(bool b) { NoSignedWrap = b; }
959   void setExact(bool b) { Exact = b; }
960   void setUnsafeAlgebra(bool b) { UnsafeAlgebra = b; }
961   void setNoNaNs(bool b) { NoNaNs = b; }
962   void setNoInfs(bool b) { NoInfs = b; }
963   void setNoSignedZeros(bool b) { NoSignedZeros = b; }
964   void setAllowReciprocal(bool b) { AllowReciprocal = b; }
965
966   // These are accessors for each flag.
967   bool hasNoUnsignedWrap() const { return NoUnsignedWrap; }
968   bool hasNoSignedWrap() const { return NoSignedWrap; }
969   bool hasExact() const { return Exact; }
970   bool hasUnsafeAlgebra() const { return UnsafeAlgebra; }
971   bool hasNoNaNs() const { return NoNaNs; }
972   bool hasNoInfs() const { return NoInfs; }
973   bool hasNoSignedZeros() const { return NoSignedZeros; }
974   bool hasAllowReciprocal() const { return AllowReciprocal; }
975
976   /// Return a raw encoding of the flags.
977   /// This function should only be used to add data to the NodeID value.
978   unsigned getRawFlags() const {
979     return (NoUnsignedWrap << 0) | (NoSignedWrap << 1) | (Exact << 2) |
980            (UnsafeAlgebra << 3) | (NoNaNs << 4) | (NoInfs << 5) |
981            (NoSignedZeros << 6) | (AllowReciprocal << 7);
982   }
983 };
984
985 /// This class is used for single-operand SDNodes.  This is solely
986 /// to allow co-allocation of node operands with the node itself.
987 class UnarySDNode : public SDNode {
988   SDUse Op;
989 public:
990   UnarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
991               SDValue X)
992     : SDNode(Opc, Order, dl, VTs) {
993     InitOperands(&Op, X);
994   }
995 };
996
997 /// This class is used for two-operand SDNodes.  This is solely
998 /// to allow co-allocation of node operands with the node itself.
999 class BinarySDNode : public SDNode {
1000   SDUse Ops[2];
1001 public:
1002   BinarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1003                SDValue X, SDValue Y)
1004     : SDNode(Opc, Order, dl, VTs) {
1005     InitOperands(Ops, X, Y);
1006   }
1007 };
1008
1009 /// Returns true if the opcode is a binary operation with flags.
1010 static bool isBinOpWithFlags(unsigned Opcode) {
1011   switch (Opcode) {
1012   case ISD::SDIV:
1013   case ISD::UDIV:
1014   case ISD::SRA:
1015   case ISD::SRL:
1016   case ISD::MUL:
1017   case ISD::ADD:
1018   case ISD::SUB:
1019   case ISD::SHL:
1020     return true;
1021   default:
1022     return false;
1023   }
1024 }
1025
1026 /// This class is an extension of BinarySDNode
1027 /// used from those opcodes that have associated extra flags.
1028 class BinaryWithFlagsSDNode : public BinarySDNode {
1029 public:
1030   SDNodeFlags Flags;
1031   BinaryWithFlagsSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1032                         SDValue X, SDValue Y)
1033       : BinarySDNode(Opc, Order, dl, VTs, X, Y), Flags() {}
1034   static bool classof(const SDNode *N) {
1035     return isBinOpWithFlags(N->getOpcode());
1036   }
1037 };
1038
1039 /// This class is used for three-operand SDNodes. This is solely
1040 /// to allow co-allocation of node operands with the node itself.
1041 class TernarySDNode : public SDNode {
1042   SDUse Ops[3];
1043 public:
1044   TernarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1045                 SDValue X, SDValue Y, SDValue Z)
1046     : SDNode(Opc, Order, dl, VTs) {
1047     InitOperands(Ops, X, Y, Z);
1048   }
1049 };
1050
1051
1052 /// This class is used to form a handle around another node that
1053 /// is persistent and is updated across invocations of replaceAllUsesWith on its
1054 /// operand.  This node should be directly created by end-users and not added to
1055 /// the AllNodes list.
1056 class HandleSDNode : public SDNode {
1057   SDUse Op;
1058 public:
1059   explicit HandleSDNode(SDValue X)
1060     : SDNode(ISD::HANDLENODE, 0, DebugLoc(), getSDVTList(MVT::Other)) {
1061     InitOperands(&Op, X);
1062   }
1063   ~HandleSDNode();
1064   const SDValue &getValue() const { return Op; }
1065 };
1066
1067 class AddrSpaceCastSDNode : public UnarySDNode {
1068 private:
1069   unsigned SrcAddrSpace;
1070   unsigned DestAddrSpace;
1071
1072 public:
1073   AddrSpaceCastSDNode(unsigned Order, DebugLoc dl, EVT VT, SDValue X,
1074                       unsigned SrcAS, unsigned DestAS);
1075
1076   unsigned getSrcAddressSpace() const { return SrcAddrSpace; }
1077   unsigned getDestAddressSpace() const { return DestAddrSpace; }
1078
1079   static bool classof(const SDNode *N) {
1080     return N->getOpcode() == ISD::ADDRSPACECAST;
1081   }
1082 };
1083
1084 /// Abstact virtual class for operations for memory operations
1085 class MemSDNode : public SDNode {
1086 private:
1087   // VT of in-memory value.
1088   EVT MemoryVT;
1089
1090 protected:
1091   /// Memory reference information.
1092   MachineMemOperand *MMO;
1093
1094 public:
1095   MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1096             EVT MemoryVT, MachineMemOperand *MMO);
1097
1098   MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1099             ArrayRef<SDValue> Ops, EVT MemoryVT, MachineMemOperand *MMO);
1100
1101   bool readMem() const { return MMO->isLoad(); }
1102   bool writeMem() const { return MMO->isStore(); }
1103
1104   /// Returns alignment and volatility of the memory access
1105   unsigned getOriginalAlignment() const {
1106     return MMO->getBaseAlignment();
1107   }
1108   unsigned getAlignment() const {
1109     return MMO->getAlignment();
1110   }
1111
1112   /// Return the SubclassData value, which contains an
1113   /// encoding of the volatile flag, as well as bits used by subclasses. This
1114   /// function should only be used to compute a FoldingSetNodeID value.
1115   unsigned getRawSubclassData() const {
1116     return SubclassData;
1117   }
1118
1119   // We access subclass data here so that we can check consistency
1120   // with MachineMemOperand information.
1121   bool isVolatile() const { return (SubclassData >> 5) & 1; }
1122   bool isNonTemporal() const { return (SubclassData >> 6) & 1; }
1123   bool isInvariant() const { return (SubclassData >> 7) & 1; }
1124
1125   AtomicOrdering getOrdering() const {
1126     return AtomicOrdering((SubclassData >> 8) & 15);
1127   }
1128   SynchronizationScope getSynchScope() const {
1129     return SynchronizationScope((SubclassData >> 12) & 1);
1130   }
1131
1132   // Returns the offset from the location of the access.
1133   int64_t getSrcValueOffset() const { return MMO->getOffset(); }
1134
1135   /// Returns the AA info that describes the dereference.
1136   AAMDNodes getAAInfo() const { return MMO->getAAInfo(); }
1137
1138   /// Returns the Ranges that describes the dereference.
1139   const MDNode *getRanges() const { return MMO->getRanges(); }
1140
1141   /// Return the type of the in-memory value.
1142   EVT getMemoryVT() const { return MemoryVT; }
1143
1144   /// Return a MachineMemOperand object describing the memory
1145   /// reference performed by operation.
1146   MachineMemOperand *getMemOperand() const { return MMO; }
1147
1148   const MachinePointerInfo &getPointerInfo() const {
1149     return MMO->getPointerInfo();
1150   }
1151
1152   /// Return the address space for the associated pointer
1153   unsigned getAddressSpace() const {
1154     return getPointerInfo().getAddrSpace();
1155   }
1156
1157   /// Update this MemSDNode's MachineMemOperand information
1158   /// to reflect the alignment of NewMMO, if it has a greater alignment.
1159   /// This must only be used when the new alignment applies to all users of
1160   /// this MachineMemOperand.
1161   void refineAlignment(const MachineMemOperand *NewMMO) {
1162     MMO->refineAlignment(NewMMO);
1163   }
1164
1165   const SDValue &getChain() const { return getOperand(0); }
1166   const SDValue &getBasePtr() const {
1167     return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1168   }
1169
1170   // Methods to support isa and dyn_cast
1171   static bool classof(const SDNode *N) {
1172     // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1173     // with either an intrinsic or a target opcode.
1174     return N->getOpcode() == ISD::LOAD                ||
1175            N->getOpcode() == ISD::STORE               ||
1176            N->getOpcode() == ISD::PREFETCH            ||
1177            N->getOpcode() == ISD::ATOMIC_CMP_SWAP     ||
1178            N->getOpcode() == ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS ||
1179            N->getOpcode() == ISD::ATOMIC_SWAP         ||
1180            N->getOpcode() == ISD::ATOMIC_LOAD_ADD     ||
1181            N->getOpcode() == ISD::ATOMIC_LOAD_SUB     ||
1182            N->getOpcode() == ISD::ATOMIC_LOAD_AND     ||
1183            N->getOpcode() == ISD::ATOMIC_LOAD_OR      ||
1184            N->getOpcode() == ISD::ATOMIC_LOAD_XOR     ||
1185            N->getOpcode() == ISD::ATOMIC_LOAD_NAND    ||
1186            N->getOpcode() == ISD::ATOMIC_LOAD_MIN     ||
1187            N->getOpcode() == ISD::ATOMIC_LOAD_MAX     ||
1188            N->getOpcode() == ISD::ATOMIC_LOAD_UMIN    ||
1189            N->getOpcode() == ISD::ATOMIC_LOAD_UMAX    ||
1190            N->getOpcode() == ISD::ATOMIC_LOAD         ||
1191            N->getOpcode() == ISD::ATOMIC_STORE        ||
1192            N->getOpcode() == ISD::MLOAD               ||
1193            N->getOpcode() == ISD::MSTORE              ||
1194            N->getOpcode() == ISD::MGATHER             ||
1195            N->getOpcode() == ISD::MSCATTER            ||
1196            N->isMemIntrinsic()                        ||
1197            N->isTargetMemoryOpcode();
1198   }
1199 };
1200
1201 /// A SDNode reprenting atomic operations.
1202 class AtomicSDNode : public MemSDNode {
1203   SDUse Ops[4];
1204
1205   /// For cmpxchg instructions, the ordering requirements when a store does not
1206   /// occur.
1207   AtomicOrdering FailureOrdering;
1208
1209   void InitAtomic(AtomicOrdering SuccessOrdering,
1210                   AtomicOrdering FailureOrdering,
1211                   SynchronizationScope SynchScope) {
1212     // This must match encodeMemSDNodeFlags() in SelectionDAG.cpp.
1213     assert((SuccessOrdering & 15) == SuccessOrdering &&
1214            "Ordering may not require more than 4 bits!");
1215     assert((FailureOrdering & 15) == FailureOrdering &&
1216            "Ordering may not require more than 4 bits!");
1217     assert((SynchScope & 1) == SynchScope &&
1218            "SynchScope may not require more than 1 bit!");
1219     SubclassData |= SuccessOrdering << 8;
1220     SubclassData |= SynchScope << 12;
1221     this->FailureOrdering = FailureOrdering;
1222     assert(getSuccessOrdering() == SuccessOrdering &&
1223            "Ordering encoding error!");
1224     assert(getFailureOrdering() == FailureOrdering &&
1225            "Ordering encoding error!");
1226     assert(getSynchScope() == SynchScope && "Synch-scope encoding error!");
1227   }
1228
1229 public:
1230   // Opc:   opcode for atomic
1231   // VTL:    value type list
1232   // Chain:  memory chain for operaand
1233   // Ptr:    address to update as a SDValue
1234   // Cmp:    compare value
1235   // Swp:    swap value
1236   // SrcVal: address to update as a Value (used for MemOperand)
1237   // Align:  alignment of memory
1238   AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1239                EVT MemVT, SDValue Chain, SDValue Ptr, SDValue Cmp, SDValue Swp,
1240                MachineMemOperand *MMO, AtomicOrdering Ordering,
1241                SynchronizationScope SynchScope)
1242       : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1243     InitAtomic(Ordering, Ordering, SynchScope);
1244     InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1245   }
1246   AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1247                EVT MemVT,
1248                SDValue Chain, SDValue Ptr,
1249                SDValue Val, MachineMemOperand *MMO,
1250                AtomicOrdering Ordering, SynchronizationScope SynchScope)
1251     : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1252     InitAtomic(Ordering, Ordering, SynchScope);
1253     InitOperands(Ops, Chain, Ptr, Val);
1254   }
1255   AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1256                EVT MemVT,
1257                SDValue Chain, SDValue Ptr,
1258                MachineMemOperand *MMO,
1259                AtomicOrdering Ordering, SynchronizationScope SynchScope)
1260     : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1261     InitAtomic(Ordering, Ordering, SynchScope);
1262     InitOperands(Ops, Chain, Ptr);
1263   }
1264   AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL, EVT MemVT,
1265                const SDValue* AllOps, SDUse *DynOps, unsigned NumOps,
1266                MachineMemOperand *MMO,
1267                AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
1268                SynchronizationScope SynchScope)
1269     : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1270     InitAtomic(SuccessOrdering, FailureOrdering, SynchScope);
1271     assert((DynOps || NumOps <= array_lengthof(Ops)) &&
1272            "Too many ops for internal storage!");
1273     InitOperands(DynOps ? DynOps : Ops, AllOps, NumOps);
1274   }
1275
1276   const SDValue &getBasePtr() const { return getOperand(1); }
1277   const SDValue &getVal() const { return getOperand(2); }
1278
1279   AtomicOrdering getSuccessOrdering() const {
1280     return getOrdering();
1281   }
1282
1283   // Not quite enough room in SubclassData for everything, so failure gets its
1284   // own field.
1285   AtomicOrdering getFailureOrdering() const {
1286     return FailureOrdering;
1287   }
1288
1289   bool isCompareAndSwap() const {
1290     unsigned Op = getOpcode();
1291     return Op == ISD::ATOMIC_CMP_SWAP || Op == ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS;
1292   }
1293
1294   // Methods to support isa and dyn_cast
1295   static bool classof(const SDNode *N) {
1296     return N->getOpcode() == ISD::ATOMIC_CMP_SWAP     ||
1297            N->getOpcode() == ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS ||
1298            N->getOpcode() == ISD::ATOMIC_SWAP         ||
1299            N->getOpcode() == ISD::ATOMIC_LOAD_ADD     ||
1300            N->getOpcode() == ISD::ATOMIC_LOAD_SUB     ||
1301            N->getOpcode() == ISD::ATOMIC_LOAD_AND     ||
1302            N->getOpcode() == ISD::ATOMIC_LOAD_OR      ||
1303            N->getOpcode() == ISD::ATOMIC_LOAD_XOR     ||
1304            N->getOpcode() == ISD::ATOMIC_LOAD_NAND    ||
1305            N->getOpcode() == ISD::ATOMIC_LOAD_MIN     ||
1306            N->getOpcode() == ISD::ATOMIC_LOAD_MAX     ||
1307            N->getOpcode() == ISD::ATOMIC_LOAD_UMIN    ||
1308            N->getOpcode() == ISD::ATOMIC_LOAD_UMAX    ||
1309            N->getOpcode() == ISD::ATOMIC_LOAD         ||
1310            N->getOpcode() == ISD::ATOMIC_STORE;
1311   }
1312 };
1313
1314 /// This SDNode is used for target intrinsics that touch
1315 /// memory and need an associated MachineMemOperand. Its opcode may be
1316 /// INTRINSIC_VOID, INTRINSIC_W_CHAIN, PREFETCH, or a target-specific opcode
1317 /// with a value not less than FIRST_TARGET_MEMORY_OPCODE.
1318 class MemIntrinsicSDNode : public MemSDNode {
1319 public:
1320   MemIntrinsicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1321                      ArrayRef<SDValue> Ops, EVT MemoryVT,
1322                      MachineMemOperand *MMO)
1323     : MemSDNode(Opc, Order, dl, VTs, Ops, MemoryVT, MMO) {
1324     SubclassData |= 1u << 13;
1325   }
1326
1327   // Methods to support isa and dyn_cast
1328   static bool classof(const SDNode *N) {
1329     // We lower some target intrinsics to their target opcode
1330     // early a node with a target opcode can be of this class
1331     return N->isMemIntrinsic()             ||
1332            N->getOpcode() == ISD::PREFETCH ||
1333            N->isTargetMemoryOpcode();
1334   }
1335 };
1336
1337 /// This SDNode is used to implement the code generator
1338 /// support for the llvm IR shufflevector instruction.  It combines elements
1339 /// from two input vectors into a new input vector, with the selection and
1340 /// ordering of elements determined by an array of integers, referred to as
1341 /// the shuffle mask.  For input vectors of width N, mask indices of 0..N-1
1342 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1343 /// An index of -1 is treated as undef, such that the code generator may put
1344 /// any value in the corresponding element of the result.
1345 class ShuffleVectorSDNode : public SDNode {
1346   SDUse Ops[2];
1347
1348   // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1349   // is freed when the SelectionDAG object is destroyed.
1350   const int *Mask;
1351 protected:
1352   friend class SelectionDAG;
1353   ShuffleVectorSDNode(EVT VT, unsigned Order, DebugLoc dl, SDValue N1,
1354                       SDValue N2, const int *M)
1355     : SDNode(ISD::VECTOR_SHUFFLE, Order, dl, getSDVTList(VT)), Mask(M) {
1356     InitOperands(Ops, N1, N2);
1357   }
1358 public:
1359
1360   ArrayRef<int> getMask() const {
1361     EVT VT = getValueType(0);
1362     return makeArrayRef(Mask, VT.getVectorNumElements());
1363   }
1364   int getMaskElt(unsigned Idx) const {
1365     assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1366     return Mask[Idx];
1367   }
1368
1369   bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1370   int  getSplatIndex() const {
1371     assert(isSplat() && "Cannot get splat index for non-splat!");
1372     EVT VT = getValueType(0);
1373     for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i) {
1374       if (Mask[i] >= 0)
1375         return Mask[i];
1376     }
1377     llvm_unreachable("Splat with all undef indices?");
1378   }
1379   static bool isSplatMask(const int *Mask, EVT VT);
1380
1381   /// Change values in a shuffle permute mask assuming
1382   /// the two vector operands have swapped position.
1383   static void commuteMask(SmallVectorImpl<int> &Mask) {
1384     unsigned NumElems = Mask.size();
1385     for (unsigned i = 0; i != NumElems; ++i) {
1386       int idx = Mask[i];
1387       if (idx < 0)
1388         continue;
1389       else if (idx < (int)NumElems)
1390         Mask[i] = idx + NumElems;
1391       else
1392         Mask[i] = idx - NumElems;
1393     }
1394   }
1395
1396   static bool classof(const SDNode *N) {
1397     return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1398   }
1399 };
1400
1401 class ConstantSDNode : public SDNode {
1402   const ConstantInt *Value;
1403   friend class SelectionDAG;
1404   ConstantSDNode(bool isTarget, bool isOpaque, const ConstantInt *val,
1405                  DebugLoc DL, EVT VT)
1406     : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1407              0, DL, getSDVTList(VT)), Value(val) {
1408     SubclassData |= (uint16_t)isOpaque;
1409   }
1410 public:
1411
1412   const ConstantInt *getConstantIntValue() const { return Value; }
1413   const APInt &getAPIntValue() const { return Value->getValue(); }
1414   uint64_t getZExtValue() const { return Value->getZExtValue(); }
1415   int64_t getSExtValue() const { return Value->getSExtValue(); }
1416
1417   bool isOne() const { return Value->isOne(); }
1418   bool isNullValue() const { return Value->isNullValue(); }
1419   bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1420
1421   bool isOpaque() const { return SubclassData & 1; }
1422
1423   static bool classof(const SDNode *N) {
1424     return N->getOpcode() == ISD::Constant ||
1425            N->getOpcode() == ISD::TargetConstant;
1426   }
1427 };
1428
1429 class ConstantFPSDNode : public SDNode {
1430   const ConstantFP *Value;
1431   friend class SelectionDAG;
1432   ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1433     : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1434              0, DebugLoc(), getSDVTList(VT)), Value(val) {
1435   }
1436 public:
1437
1438   const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1439   const ConstantFP *getConstantFPValue() const { return Value; }
1440
1441   /// Return true if the value is positive or negative zero.
1442   bool isZero() const { return Value->isZero(); }
1443
1444   /// Return true if the value is a NaN.
1445   bool isNaN() const { return Value->isNaN(); }
1446
1447   /// Return true if the value is an infinity
1448   bool isInfinity() const { return Value->isInfinity(); }
1449
1450   /// Return true if the value is negative.
1451   bool isNegative() const { return Value->isNegative(); }
1452
1453   /// We don't rely on operator== working on double values, as
1454   /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1455   /// As such, this method can be used to do an exact bit-for-bit comparison of
1456   /// two floating point values.
1457
1458   /// We leave the version with the double argument here because it's just so
1459   /// convenient to write "2.0" and the like.  Without this function we'd
1460   /// have to duplicate its logic everywhere it's called.
1461   bool isExactlyValue(double V) const {
1462     bool ignored;
1463     APFloat Tmp(V);
1464     Tmp.convert(Value->getValueAPF().getSemantics(),
1465                 APFloat::rmNearestTiesToEven, &ignored);
1466     return isExactlyValue(Tmp);
1467   }
1468   bool isExactlyValue(const APFloat& V) const;
1469
1470   static bool isValueValidForType(EVT VT, const APFloat& Val);
1471
1472   static bool classof(const SDNode *N) {
1473     return N->getOpcode() == ISD::ConstantFP ||
1474            N->getOpcode() == ISD::TargetConstantFP;
1475   }
1476 };
1477
1478 class GlobalAddressSDNode : public SDNode {
1479   const GlobalValue *TheGlobal;
1480   int64_t Offset;
1481   unsigned char TargetFlags;
1482   friend class SelectionDAG;
1483   GlobalAddressSDNode(unsigned Opc, unsigned Order, DebugLoc DL,
1484                       const GlobalValue *GA, EVT VT, int64_t o,
1485                       unsigned char TargetFlags);
1486 public:
1487
1488   const GlobalValue *getGlobal() const { return TheGlobal; }
1489   int64_t getOffset() const { return Offset; }
1490   unsigned char getTargetFlags() const { return TargetFlags; }
1491   // Return the address space this GlobalAddress belongs to.
1492   unsigned getAddressSpace() const;
1493
1494   static bool classof(const SDNode *N) {
1495     return N->getOpcode() == ISD::GlobalAddress ||
1496            N->getOpcode() == ISD::TargetGlobalAddress ||
1497            N->getOpcode() == ISD::GlobalTLSAddress ||
1498            N->getOpcode() == ISD::TargetGlobalTLSAddress;
1499   }
1500 };
1501
1502 class FrameIndexSDNode : public SDNode {
1503   int FI;
1504   friend class SelectionDAG;
1505   FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1506     : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1507       0, DebugLoc(), getSDVTList(VT)), FI(fi) {
1508   }
1509 public:
1510
1511   int getIndex() const { return FI; }
1512
1513   static bool classof(const SDNode *N) {
1514     return N->getOpcode() == ISD::FrameIndex ||
1515            N->getOpcode() == ISD::TargetFrameIndex;
1516   }
1517 };
1518
1519 class JumpTableSDNode : public SDNode {
1520   int JTI;
1521   unsigned char TargetFlags;
1522   friend class SelectionDAG;
1523   JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1524     : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1525       0, DebugLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1526   }
1527 public:
1528
1529   int getIndex() const { return JTI; }
1530   unsigned char getTargetFlags() const { return TargetFlags; }
1531
1532   static bool classof(const SDNode *N) {
1533     return N->getOpcode() == ISD::JumpTable ||
1534            N->getOpcode() == ISD::TargetJumpTable;
1535   }
1536 };
1537
1538 class ConstantPoolSDNode : public SDNode {
1539   union {
1540     const Constant *ConstVal;
1541     MachineConstantPoolValue *MachineCPVal;
1542   } Val;
1543   int Offset;  // It's a MachineConstantPoolValue if top bit is set.
1544   unsigned Alignment;  // Minimum alignment requirement of CP (not log2 value).
1545   unsigned char TargetFlags;
1546   friend class SelectionDAG;
1547   ConstantPoolSDNode(bool isTarget, const Constant *c, EVT VT, int o,
1548                      unsigned Align, unsigned char TF)
1549     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1550              DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1551              TargetFlags(TF) {
1552     assert(Offset >= 0 && "Offset is too large");
1553     Val.ConstVal = c;
1554   }
1555   ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1556                      EVT VT, int o, unsigned Align, unsigned char TF)
1557     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1558              DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1559              TargetFlags(TF) {
1560     assert(Offset >= 0 && "Offset is too large");
1561     Val.MachineCPVal = v;
1562     Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1563   }
1564 public:
1565
1566   bool isMachineConstantPoolEntry() const {
1567     return Offset < 0;
1568   }
1569
1570   const Constant *getConstVal() const {
1571     assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1572     return Val.ConstVal;
1573   }
1574
1575   MachineConstantPoolValue *getMachineCPVal() const {
1576     assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1577     return Val.MachineCPVal;
1578   }
1579
1580   int getOffset() const {
1581     return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1582   }
1583
1584   // Return the alignment of this constant pool object, which is either 0 (for
1585   // default alignment) or the desired value.
1586   unsigned getAlignment() const { return Alignment; }
1587   unsigned char getTargetFlags() const { return TargetFlags; }
1588
1589   Type *getType() const;
1590
1591   static bool classof(const SDNode *N) {
1592     return N->getOpcode() == ISD::ConstantPool ||
1593            N->getOpcode() == ISD::TargetConstantPool;
1594   }
1595 };
1596
1597 /// Completely target-dependent object reference.
1598 class TargetIndexSDNode : public SDNode {
1599   unsigned char TargetFlags;
1600   int Index;
1601   int64_t Offset;
1602   friend class SelectionDAG;
1603 public:
1604
1605   TargetIndexSDNode(int Idx, EVT VT, int64_t Ofs, unsigned char TF)
1606     : SDNode(ISD::TargetIndex, 0, DebugLoc(), getSDVTList(VT)),
1607       TargetFlags(TF), Index(Idx), Offset(Ofs) {}
1608 public:
1609
1610   unsigned char getTargetFlags() const { return TargetFlags; }
1611   int getIndex() const { return Index; }
1612   int64_t getOffset() const { return Offset; }
1613
1614   static bool classof(const SDNode *N) {
1615     return N->getOpcode() == ISD::TargetIndex;
1616   }
1617 };
1618
1619 class BasicBlockSDNode : public SDNode {
1620   MachineBasicBlock *MBB;
1621   friend class SelectionDAG;
1622   /// Debug info is meaningful and potentially useful here, but we create
1623   /// blocks out of order when they're jumped to, which makes it a bit
1624   /// harder.  Let's see if we need it first.
1625   explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1626     : SDNode(ISD::BasicBlock, 0, DebugLoc(), getSDVTList(MVT::Other)), MBB(mbb)
1627   {}
1628 public:
1629
1630   MachineBasicBlock *getBasicBlock() const { return MBB; }
1631
1632   static bool classof(const SDNode *N) {
1633     return N->getOpcode() == ISD::BasicBlock;
1634   }
1635 };
1636
1637 /// A "pseudo-class" with methods for operating on BUILD_VECTORs.
1638 class BuildVectorSDNode : public SDNode {
1639   // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1640   explicit BuildVectorSDNode() = delete;
1641 public:
1642   /// Check if this is a constant splat, and if so, find the
1643   /// smallest element size that splats the vector.  If MinSplatBits is
1644   /// nonzero, the element size must be at least that large.  Note that the
1645   /// splat element may be the entire vector (i.e., a one element vector).
1646   /// Returns the splat element value in SplatValue.  Any undefined bits in
1647   /// that value are zero, and the corresponding bits in the SplatUndef mask
1648   /// are set.  The SplatBitSize value is set to the splat element size in
1649   /// bits.  HasAnyUndefs is set to true if any bits in the vector are
1650   /// undefined.  isBigEndian describes the endianness of the target.
1651   bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1652                        unsigned &SplatBitSize, bool &HasAnyUndefs,
1653                        unsigned MinSplatBits = 0,
1654                        bool isBigEndian = false) const;
1655
1656   /// \brief Returns the splatted value or a null value if this is not a splat.
1657   ///
1658   /// If passed a non-null UndefElements bitvector, it will resize it to match
1659   /// the vector width and set the bits where elements are undef.
1660   SDValue getSplatValue(BitVector *UndefElements = nullptr) const;
1661
1662   /// \brief Returns the splatted constant or null if this is not a constant
1663   /// splat.
1664   ///
1665   /// If passed a non-null UndefElements bitvector, it will resize it to match
1666   /// the vector width and set the bits where elements are undef.
1667   ConstantSDNode *
1668   getConstantSplatNode(BitVector *UndefElements = nullptr) const;
1669
1670   /// \brief Returns the splatted constant FP or null if this is not a constant
1671   /// FP splat.
1672   ///
1673   /// If passed a non-null UndefElements bitvector, it will resize it to match
1674   /// the vector width and set the bits where elements are undef.
1675   ConstantFPSDNode *
1676   getConstantFPSplatNode(BitVector *UndefElements = nullptr) const;
1677
1678   bool isConstant() const;
1679
1680   static inline bool classof(const SDNode *N) {
1681     return N->getOpcode() == ISD::BUILD_VECTOR;
1682   }
1683 };
1684
1685 /// An SDNode that holds an arbitrary LLVM IR Value. This is
1686 /// used when the SelectionDAG needs to make a simple reference to something
1687 /// in the LLVM IR representation.
1688 ///
1689 class SrcValueSDNode : public SDNode {
1690   const Value *V;
1691   friend class SelectionDAG;
1692   /// Create a SrcValue for a general value.
1693   explicit SrcValueSDNode(const Value *v)
1694     : SDNode(ISD::SRCVALUE, 0, DebugLoc(), getSDVTList(MVT::Other)), V(v) {}
1695
1696 public:
1697   /// Return the contained Value.
1698   const Value *getValue() const { return V; }
1699
1700   static bool classof(const SDNode *N) {
1701     return N->getOpcode() == ISD::SRCVALUE;
1702   }
1703 };
1704
1705 class MDNodeSDNode : public SDNode {
1706   const MDNode *MD;
1707   friend class SelectionDAG;
1708   explicit MDNodeSDNode(const MDNode *md)
1709   : SDNode(ISD::MDNODE_SDNODE, 0, DebugLoc(), getSDVTList(MVT::Other)), MD(md)
1710   {}
1711 public:
1712
1713   const MDNode *getMD() const { return MD; }
1714
1715   static bool classof(const SDNode *N) {
1716     return N->getOpcode() == ISD::MDNODE_SDNODE;
1717   }
1718 };
1719
1720 class RegisterSDNode : public SDNode {
1721   unsigned Reg;
1722   friend class SelectionDAG;
1723   RegisterSDNode(unsigned reg, EVT VT)
1724     : SDNode(ISD::Register, 0, DebugLoc(), getSDVTList(VT)), Reg(reg) {
1725   }
1726 public:
1727
1728   unsigned getReg() const { return Reg; }
1729
1730   static bool classof(const SDNode *N) {
1731     return N->getOpcode() == ISD::Register;
1732   }
1733 };
1734
1735 class RegisterMaskSDNode : public SDNode {
1736   // The memory for RegMask is not owned by the node.
1737   const uint32_t *RegMask;
1738   friend class SelectionDAG;
1739   RegisterMaskSDNode(const uint32_t *mask)
1740     : SDNode(ISD::RegisterMask, 0, DebugLoc(), getSDVTList(MVT::Untyped)),
1741       RegMask(mask) {}
1742 public:
1743
1744   const uint32_t *getRegMask() const { return RegMask; }
1745
1746   static bool classof(const SDNode *N) {
1747     return N->getOpcode() == ISD::RegisterMask;
1748   }
1749 };
1750
1751 class BlockAddressSDNode : public SDNode {
1752   const BlockAddress *BA;
1753   int64_t Offset;
1754   unsigned char TargetFlags;
1755   friend class SelectionDAG;
1756   BlockAddressSDNode(unsigned NodeTy, EVT VT, const BlockAddress *ba,
1757                      int64_t o, unsigned char Flags)
1758     : SDNode(NodeTy, 0, DebugLoc(), getSDVTList(VT)),
1759              BA(ba), Offset(o), TargetFlags(Flags) {
1760   }
1761 public:
1762   const BlockAddress *getBlockAddress() const { return BA; }
1763   int64_t getOffset() const { return Offset; }
1764   unsigned char getTargetFlags() const { return TargetFlags; }
1765
1766   static bool classof(const SDNode *N) {
1767     return N->getOpcode() == ISD::BlockAddress ||
1768            N->getOpcode() == ISD::TargetBlockAddress;
1769   }
1770 };
1771
1772 class EHLabelSDNode : public SDNode {
1773   SDUse Chain;
1774   MCSymbol *Label;
1775   friend class SelectionDAG;
1776   EHLabelSDNode(unsigned Order, DebugLoc dl, SDValue ch, MCSymbol *L)
1777     : SDNode(ISD::EH_LABEL, Order, dl, getSDVTList(MVT::Other)), Label(L) {
1778     InitOperands(&Chain, ch);
1779   }
1780 public:
1781   MCSymbol *getLabel() const { return Label; }
1782
1783   static bool classof(const SDNode *N) {
1784     return N->getOpcode() == ISD::EH_LABEL;
1785   }
1786 };
1787
1788 class ExternalSymbolSDNode : public SDNode {
1789   const char *Symbol;
1790   unsigned char TargetFlags;
1791
1792   friend class SelectionDAG;
1793   ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
1794     : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1795              0, DebugLoc(), getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
1796   }
1797 public:
1798
1799   const char *getSymbol() const { return Symbol; }
1800   unsigned char getTargetFlags() const { return TargetFlags; }
1801
1802   static bool classof(const SDNode *N) {
1803     return N->getOpcode() == ISD::ExternalSymbol ||
1804            N->getOpcode() == ISD::TargetExternalSymbol;
1805   }
1806 };
1807
1808 class CondCodeSDNode : public SDNode {
1809   ISD::CondCode Condition;
1810   friend class SelectionDAG;
1811   explicit CondCodeSDNode(ISD::CondCode Cond)
1812     : SDNode(ISD::CONDCODE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1813       Condition(Cond) {
1814   }
1815 public:
1816
1817   ISD::CondCode get() const { return Condition; }
1818
1819   static bool classof(const SDNode *N) {
1820     return N->getOpcode() == ISD::CONDCODE;
1821   }
1822 };
1823
1824 /// NOTE: avoid using this node as this may disappear in the
1825 /// future and most targets don't support it.
1826 class CvtRndSatSDNode : public SDNode {
1827   ISD::CvtCode CvtCode;
1828   friend class SelectionDAG;
1829   explicit CvtRndSatSDNode(EVT VT, unsigned Order, DebugLoc dl,
1830                            ArrayRef<SDValue> Ops, ISD::CvtCode Code)
1831     : SDNode(ISD::CONVERT_RNDSAT, Order, dl, getSDVTList(VT), Ops),
1832       CvtCode(Code) {
1833     assert(Ops.size() == 5 && "wrong number of operations");
1834   }
1835 public:
1836   ISD::CvtCode getCvtCode() const { return CvtCode; }
1837
1838   static bool classof(const SDNode *N) {
1839     return N->getOpcode() == ISD::CONVERT_RNDSAT;
1840   }
1841 };
1842
1843 /// This class is used to represent EVT's, which are used
1844 /// to parameterize some operations.
1845 class VTSDNode : public SDNode {
1846   EVT ValueType;
1847   friend class SelectionDAG;
1848   explicit VTSDNode(EVT VT)
1849     : SDNode(ISD::VALUETYPE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1850       ValueType(VT) {
1851   }
1852 public:
1853
1854   EVT getVT() const { return ValueType; }
1855
1856   static bool classof(const SDNode *N) {
1857     return N->getOpcode() == ISD::VALUETYPE;
1858   }
1859 };
1860
1861 /// Base class for LoadSDNode and StoreSDNode
1862 class LSBaseSDNode : public MemSDNode {
1863   //! Operand array for load and store
1864   /*!
1865     \note Moving this array to the base class captures more
1866     common functionality shared between LoadSDNode and
1867     StoreSDNode
1868    */
1869   SDUse Ops[4];
1870 public:
1871   LSBaseSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
1872                SDValue *Operands, unsigned numOperands,
1873                SDVTList VTs, ISD::MemIndexedMode AM, EVT MemVT,
1874                MachineMemOperand *MMO)
1875     : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
1876     SubclassData |= AM << 2;
1877     assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
1878     InitOperands(Ops, Operands, numOperands);
1879     assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1880            "Only indexed loads and stores have a non-undef offset operand");
1881   }
1882
1883   const SDValue &getOffset() const {
1884     return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1885   }
1886
1887   /// Return the addressing mode for this load or store:
1888   /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
1889   ISD::MemIndexedMode getAddressingMode() const {
1890     return ISD::MemIndexedMode((SubclassData >> 2) & 7);
1891   }
1892
1893   /// Return true if this is a pre/post inc/dec load/store.
1894   bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
1895
1896   /// Return true if this is NOT a pre/post inc/dec load/store.
1897   bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
1898
1899   static bool classof(const SDNode *N) {
1900     return N->getOpcode() == ISD::LOAD ||
1901            N->getOpcode() == ISD::STORE;
1902   }
1903 };
1904
1905 /// This class is used to represent ISD::LOAD nodes.
1906 class LoadSDNode : public LSBaseSDNode {
1907   friend class SelectionDAG;
1908   LoadSDNode(SDValue *ChainPtrOff, unsigned Order, DebugLoc dl, SDVTList VTs,
1909              ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT MemVT,
1910              MachineMemOperand *MMO)
1911     : LSBaseSDNode(ISD::LOAD, Order, dl, ChainPtrOff, 3, VTs, AM, MemVT, MMO) {
1912     SubclassData |= (unsigned short)ETy;
1913     assert(getExtensionType() == ETy && "LoadExtType encoding error!");
1914     assert(readMem() && "Load MachineMemOperand is not a load!");
1915     assert(!writeMem() && "Load MachineMemOperand is a store!");
1916   }
1917 public:
1918
1919   /// Return whether this is a plain node,
1920   /// or one of the varieties of value-extending loads.
1921   ISD::LoadExtType getExtensionType() const {
1922     return ISD::LoadExtType(SubclassData & 3);
1923   }
1924
1925   const SDValue &getBasePtr() const { return getOperand(1); }
1926   const SDValue &getOffset() const { return getOperand(2); }
1927
1928   static bool classof(const SDNode *N) {
1929     return N->getOpcode() == ISD::LOAD;
1930   }
1931 };
1932
1933 /// This class is used to represent ISD::STORE nodes.
1934 class StoreSDNode : public LSBaseSDNode {
1935   friend class SelectionDAG;
1936   StoreSDNode(SDValue *ChainValuePtrOff, unsigned Order, DebugLoc dl,
1937               SDVTList VTs, ISD::MemIndexedMode AM, bool isTrunc, EVT MemVT,
1938               MachineMemOperand *MMO)
1939     : LSBaseSDNode(ISD::STORE, Order, dl, ChainValuePtrOff, 4,
1940                    VTs, AM, MemVT, MMO) {
1941     SubclassData |= (unsigned short)isTrunc;
1942     assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
1943     assert(!readMem() && "Store MachineMemOperand is a load!");
1944     assert(writeMem() && "Store MachineMemOperand is not a store!");
1945   }
1946 public:
1947
1948   /// Return true if the op does a truncation before store.
1949   /// For integers this is the same as doing a TRUNCATE and storing the result.
1950   /// For floats, it is the same as doing an FP_ROUND and storing the result.
1951   bool isTruncatingStore() const { return SubclassData & 1; }
1952
1953   const SDValue &getValue() const { return getOperand(1); }
1954   const SDValue &getBasePtr() const { return getOperand(2); }
1955   const SDValue &getOffset() const { return getOperand(3); }
1956
1957   static bool classof(const SDNode *N) {
1958     return N->getOpcode() == ISD::STORE;
1959   }
1960 };
1961
1962 /// This base class is used to represent MLOAD and MSTORE nodes
1963 class MaskedLoadStoreSDNode : public MemSDNode {
1964   // Operands
1965   SDUse Ops[4];
1966 public:
1967   friend class SelectionDAG;
1968   MaskedLoadStoreSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
1969                    SDValue *Operands, unsigned numOperands, 
1970                    SDVTList VTs, EVT MemVT, MachineMemOperand *MMO)
1971     : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
1972     InitOperands(Ops, Operands, numOperands);
1973   }
1974
1975   // In the both nodes address is Op1, mask is Op2:
1976   // MaskedLoadSDNode (Chain, ptr, mask, src0), src0 is a passthru value
1977   // MaskedStoreSDNode (Chain, ptr, mask, data)
1978   // Mask is a vector of i1 elements
1979   const SDValue &getBasePtr() const { return getOperand(1); }
1980   const SDValue &getMask() const    { return getOperand(2); }
1981
1982   static bool classof(const SDNode *N) {
1983     return N->getOpcode() == ISD::MLOAD ||
1984            N->getOpcode() == ISD::MSTORE;
1985   }
1986 };
1987
1988 /// This class is used to represent an MLOAD node
1989 class MaskedLoadSDNode : public MaskedLoadStoreSDNode {
1990 public:
1991   friend class SelectionDAG;
1992   MaskedLoadSDNode(unsigned Order, DebugLoc dl, SDValue *Operands,
1993                    unsigned numOperands, SDVTList VTs, ISD::LoadExtType ETy,
1994                    EVT MemVT, MachineMemOperand *MMO)
1995     : MaskedLoadStoreSDNode(ISD::MLOAD, Order, dl, Operands, numOperands,
1996                             VTs, MemVT, MMO) {
1997     SubclassData |= (unsigned short)ETy;
1998   }
1999
2000   ISD::LoadExtType getExtensionType() const {
2001     return ISD::LoadExtType(SubclassData & 3);
2002   } 
2003   const SDValue &getSrc0() const { return getOperand(3); }
2004   static bool classof(const SDNode *N) {
2005     return N->getOpcode() == ISD::MLOAD;
2006   }
2007 };
2008
2009 /// This class is used to represent an MSTORE node
2010 class MaskedStoreSDNode : public MaskedLoadStoreSDNode {
2011
2012 public:
2013   friend class SelectionDAG;
2014   MaskedStoreSDNode(unsigned Order, DebugLoc dl, SDValue *Operands,
2015                     unsigned numOperands, SDVTList VTs, bool isTrunc, EVT MemVT,
2016                     MachineMemOperand *MMO)
2017     : MaskedLoadStoreSDNode(ISD::MSTORE, Order, dl, Operands, numOperands,
2018                             VTs, MemVT, MMO) {
2019       SubclassData |= (unsigned short)isTrunc;
2020   }
2021   /// Return true if the op does a truncation before store.
2022   /// For integers this is the same as doing a TRUNCATE and storing the result.
2023   /// For floats, it is the same as doing an FP_ROUND and storing the result.
2024   bool isTruncatingStore() const { return SubclassData & 1; }
2025
2026   const SDValue &getValue() const { return getOperand(3); }
2027
2028   static bool classof(const SDNode *N) {
2029     return N->getOpcode() == ISD::MSTORE;
2030   }
2031 };
2032
2033 /// This is a base class used to represent
2034 /// MGATHER and MSCATTER nodes
2035 ///
2036 class MaskedGatherScatterSDNode : public MemSDNode {
2037   // Operands
2038   SDUse Ops[5];
2039 public:
2040   friend class SelectionDAG;
2041   MaskedGatherScatterSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
2042                             ArrayRef<SDValue> Operands, SDVTList VTs, EVT MemVT,
2043                             MachineMemOperand *MMO)
2044     : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
2045     assert(Operands.size() == 5 && "Incompatible number of operands");
2046     InitOperands(Ops, Operands.data(), Operands.size());
2047   }
2048
2049   // In the both nodes address is Op1, mask is Op2:
2050   // MaskedGatherSDNode  (Chain, src0, mask, base, index), src0 is a passthru value
2051   // MaskedScatterSDNode (Chain, value, mask, base, index)
2052   // Mask is a vector of i1 elements
2053   const SDValue &getBasePtr() const { return getOperand(3); }
2054   const SDValue &getIndex()   const { return getOperand(4); }
2055   const SDValue &getMask()    const { return getOperand(2); }
2056   const SDValue &getValue()   const { return getOperand(1); }
2057
2058   static bool classof(const SDNode *N) {
2059     return N->getOpcode() == ISD::MGATHER ||
2060            N->getOpcode() == ISD::MSCATTER;
2061   }
2062 };
2063
2064 /// This class is used to represent an MGATHER node
2065 ///
2066 class MaskedGatherSDNode : public MaskedGatherScatterSDNode {
2067 public:
2068   friend class SelectionDAG;
2069   MaskedGatherSDNode(unsigned Order, DebugLoc dl, ArrayRef<SDValue> Operands, 
2070                      SDVTList VTs, EVT MemVT, MachineMemOperand *MMO)
2071     : MaskedGatherScatterSDNode(ISD::MGATHER, Order, dl, Operands, VTs, MemVT,
2072                                 MMO) {
2073     assert(getValue().getValueType() == getValueType(0) &&
2074            "Incompatible type of the PathThru value in MaskedGatherSDNode");
2075     assert(getMask().getValueType().getVectorNumElements() == 
2076            getValueType(0).getVectorNumElements() && 
2077            "Vector width mismatch between mask and data");
2078     assert(getMask().getValueType().getScalarType() == MVT::i1 && 
2079            "Vector width mismatch between mask and data");
2080   }
2081
2082   static bool classof(const SDNode *N) {
2083     return N->getOpcode() == ISD::MGATHER;
2084   }
2085 };
2086
2087 /// This class is used to represent an MSCATTER node
2088 ///
2089 class MaskedScatterSDNode : public MaskedGatherScatterSDNode {
2090
2091 public:
2092   friend class SelectionDAG;
2093   MaskedScatterSDNode(unsigned Order, DebugLoc dl,ArrayRef<SDValue> Operands,
2094                       SDVTList VTs, EVT MemVT, MachineMemOperand *MMO)
2095     : MaskedGatherScatterSDNode(ISD::MSCATTER, Order, dl, Operands, VTs, MemVT,
2096                                 MMO) {
2097     assert(getMask().getValueType().getVectorNumElements() == 
2098            getValue().getValueType().getVectorNumElements() && 
2099            "Vector width mismatch between mask and data");
2100     assert(getMask().getValueType().getScalarType() == MVT::i1 && 
2101            "Vector width mismatch between mask and data");
2102   }
2103
2104   static bool classof(const SDNode *N) {
2105     return N->getOpcode() == ISD::MSCATTER;
2106   }
2107 };
2108
2109 /// An SDNode that represents everything that will be needed
2110 /// to construct a MachineInstr. These nodes are created during the
2111 /// instruction selection proper phase.
2112 class MachineSDNode : public SDNode {
2113 public:
2114   typedef MachineMemOperand **mmo_iterator;
2115
2116 private:
2117   friend class SelectionDAG;
2118   MachineSDNode(unsigned Opc, unsigned Order, const DebugLoc DL, SDVTList VTs)
2119     : SDNode(Opc, Order, DL, VTs), MemRefs(nullptr), MemRefsEnd(nullptr) {}
2120
2121   /// Operands for this instruction, if they fit here. If
2122   /// they don't, this field is unused.
2123   SDUse LocalOperands[4];
2124
2125   /// Memory reference descriptions for this instruction.
2126   mmo_iterator MemRefs;
2127   mmo_iterator MemRefsEnd;
2128
2129 public:
2130   mmo_iterator memoperands_begin() const { return MemRefs; }
2131   mmo_iterator memoperands_end() const { return MemRefsEnd; }
2132   bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
2133
2134   /// Assign this MachineSDNodes's memory reference descriptor
2135   /// list. This does not transfer ownership.
2136   void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
2137     for (mmo_iterator MMI = NewMemRefs, MME = NewMemRefsEnd; MMI != MME; ++MMI)
2138       assert(*MMI && "Null mem ref detected!");
2139     MemRefs = NewMemRefs;
2140     MemRefsEnd = NewMemRefsEnd;
2141   }
2142
2143   static bool classof(const SDNode *N) {
2144     return N->isMachineOpcode();
2145   }
2146 };
2147
2148 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
2149                                             SDNode, ptrdiff_t> {
2150   const SDNode *Node;
2151   unsigned Operand;
2152
2153   SDNodeIterator(const SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
2154 public:
2155   bool operator==(const SDNodeIterator& x) const {
2156     return Operand == x.Operand;
2157   }
2158   bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
2159
2160   pointer operator*() const {
2161     return Node->getOperand(Operand).getNode();
2162   }
2163   pointer operator->() const { return operator*(); }
2164
2165   SDNodeIterator& operator++() {                // Preincrement
2166     ++Operand;
2167     return *this;
2168   }
2169   SDNodeIterator operator++(int) { // Postincrement
2170     SDNodeIterator tmp = *this; ++*this; return tmp;
2171   }
2172   size_t operator-(SDNodeIterator Other) const {
2173     assert(Node == Other.Node &&
2174            "Cannot compare iterators of two different nodes!");
2175     return Operand - Other.Operand;
2176   }
2177
2178   static SDNodeIterator begin(const SDNode *N) { return SDNodeIterator(N, 0); }
2179   static SDNodeIterator end  (const SDNode *N) {
2180     return SDNodeIterator(N, N->getNumOperands());
2181   }
2182
2183   unsigned getOperand() const { return Operand; }
2184   const SDNode *getNode() const { return Node; }
2185 };
2186
2187 template <> struct GraphTraits<SDNode*> {
2188   typedef SDNode NodeType;
2189   typedef SDNodeIterator ChildIteratorType;
2190   static inline NodeType *getEntryNode(SDNode *N) { return N; }
2191   static inline ChildIteratorType child_begin(NodeType *N) {
2192     return SDNodeIterator::begin(N);
2193   }
2194   static inline ChildIteratorType child_end(NodeType *N) {
2195     return SDNodeIterator::end(N);
2196   }
2197 };
2198
2199 /// The largest SDNode class.
2200 typedef MaskedGatherScatterSDNode LargestSDNode;
2201
2202 /// The SDNode class with the greatest alignment requirement.
2203 typedef GlobalAddressSDNode MostAlignedSDNode;
2204
2205 namespace ISD {
2206   /// Returns true if the specified node is a non-extending and unindexed load.
2207   inline bool isNormalLoad(const SDNode *N) {
2208     const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
2209     return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
2210       Ld->getAddressingMode() == ISD::UNINDEXED;
2211   }
2212
2213   /// Returns true if the specified node is a non-extending load.
2214   inline bool isNON_EXTLoad(const SDNode *N) {
2215     return isa<LoadSDNode>(N) &&
2216       cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
2217   }
2218
2219   /// Returns true if the specified node is a EXTLOAD.
2220   inline bool isEXTLoad(const SDNode *N) {
2221     return isa<LoadSDNode>(N) &&
2222       cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
2223   }
2224
2225   /// Returns true if the specified node is a SEXTLOAD.
2226   inline bool isSEXTLoad(const SDNode *N) {
2227     return isa<LoadSDNode>(N) &&
2228       cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
2229   }
2230
2231   /// Returns true if the specified node is a ZEXTLOAD.
2232   inline bool isZEXTLoad(const SDNode *N) {
2233     return isa<LoadSDNode>(N) &&
2234       cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
2235   }
2236
2237   /// Returns true if the specified node is an unindexed load.
2238   inline bool isUNINDEXEDLoad(const SDNode *N) {
2239     return isa<LoadSDNode>(N) &&
2240       cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2241   }
2242
2243   /// Returns true if the specified node is a non-truncating
2244   /// and unindexed store.
2245   inline bool isNormalStore(const SDNode *N) {
2246     const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
2247     return St && !St->isTruncatingStore() &&
2248       St->getAddressingMode() == ISD::UNINDEXED;
2249   }
2250
2251   /// Returns true if the specified node is a non-truncating store.
2252   inline bool isNON_TRUNCStore(const SDNode *N) {
2253     return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
2254   }
2255
2256   /// Returns true if the specified node is a truncating store.
2257   inline bool isTRUNCStore(const SDNode *N) {
2258     return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
2259   }
2260
2261   /// Returns true if the specified node is an unindexed store.
2262   inline bool isUNINDEXEDStore(const SDNode *N) {
2263     return isa<StoreSDNode>(N) &&
2264       cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2265   }
2266 }
2267
2268 } // end llvm namespace
2269
2270 #endif