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