1 //===-- llvm/CodeGen/SelectionDAGNodes.h - SelectionDAG Nodes ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
15 // Clients should include the SelectionDAG.h file instead of this file directly.
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_CODEGEN_SELECTIONDAGNODES_H
20 #define LLVM_CODEGEN_SELECTIONDAGNODES_H
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"
44 class MachineBasicBlock;
45 class MachineConstantPoolValue;
49 template <typename T> struct DenseMapInfo;
50 template <typename T> struct simplify_type;
51 template <typename T> struct ilist_traits;
53 void checkForCycles(const SDNode *N, const SelectionDAG *DAG = nullptr,
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(...).
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);
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);
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);
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);
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);
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
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
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.
106 friend struct DenseMapInfo<SDValue>;
108 SDNode *Node; // The node defining the value we are using.
109 unsigned ResNo; // Which return value of the node we are using.
111 SDValue() : Node(nullptr), ResNo(0) {}
112 SDValue(SDNode *node, unsigned resno);
114 /// get the index which selects a specific result in the SDNode
115 unsigned getResNo() const { return ResNo; }
117 /// get the SDNode which holds the desired result
118 SDNode *getNode() const { return Node; }
121 void setNode(SDNode *N) { Node = N; }
123 inline SDNode *operator->() const { return Node; }
125 bool operator==(const SDValue &O) const {
126 return Node == O.Node && ResNo == O.ResNo;
128 bool operator!=(const SDValue &O) const {
129 return !operator==(O);
131 bool operator<(const SDValue &O) const {
132 return std::tie(Node, ResNo) < std::tie(O.Node, O.ResNo);
134 explicit operator bool() const {
135 return Node != nullptr;
138 SDValue getValue(unsigned R) const {
139 return SDValue(Node, R);
142 // Return true if this node is an operand of N.
143 bool isOperandOf(SDNode *N) const;
145 /// Return the ValueType of the referenced return value.
146 inline EVT getValueType() const;
148 /// Return the simple ValueType of the referenced return value.
149 MVT getSimpleValueType() const {
150 return getValueType().getSimpleVT();
153 /// Returns the size of the value in bits.
154 unsigned getValueSizeInBits() const {
155 return getValueType().getSizeInBits();
158 unsigned getScalarValueSizeInBits() const {
159 return getValueType().getScalarType().getSizeInBits();
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;
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;
183 /// Return true if there are no nodes using value ResNo of Node.
184 inline bool use_empty() const;
186 /// Return true if there is exactly one node using value ResNo of Node.
187 inline bool hasOneUse() const;
191 template<> struct DenseMapInfo<SDValue> {
192 static inline SDValue getEmptyKey() {
197 static inline SDValue getTombstoneKey() {
202 static unsigned getHashValue(const SDValue &Val) {
203 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
204 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
206 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
210 template <> struct isPodLike<SDValue> { static const bool value = true; };
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();
221 template<> struct simplify_type<const SDValue> {
222 typedef /*const*/ SDNode* SimpleType;
223 static SimpleType getSimplifiedValue(const SDValue &Val) {
224 return Val.getNode();
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.
234 /// Val - The value being used.
236 /// User - The user of this value.
238 /// Prev, Next - Pointers to the uses list of the SDNode referred by
242 SDUse(const SDUse &U) = delete;
243 void operator=(const SDUse &U) = delete;
246 SDUse() : Val(), User(nullptr), Prev(nullptr), Next(nullptr) {}
248 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
249 operator const SDValue&() const { return Val; }
251 /// If implicit conversion to SDValue doesn't work, the get() method returns
253 const SDValue &get() const { return Val; }
255 /// This returns the SDNode that contains this Use.
256 SDNode *getUser() { return User; }
258 /// Get the next SDUse in the use list.
259 SDUse *getNext() const { return Next; }
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(); }
268 /// Convenience function for get().operator==
269 bool operator==(const SDValue &V) const {
273 /// Convenience function for get().operator!=
274 bool operator!=(const SDValue &V) const {
278 /// Convenience function for get().operator<
279 bool operator<(const SDValue &V) const {
284 friend class SelectionDAG;
287 void setUser(SDNode *p) { User = p; }
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);
299 void addToList(SDUse **List) {
301 if (Next) Next->Prev = &Next;
306 void removeFromList() {
308 if (Next) Next->Prev = Prev;
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();
322 /// Represents one node in the SelectionDAG.
324 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
326 /// The operation that this node performs.
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;
333 /// This tracks whether this node has one or more dbg_value
334 /// nodes corresponding to it.
335 uint16_t HasDebugValue : 1;
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;
344 /// Unique id per SDNode in the DAG.
347 /// The values that are used by this operation.
350 /// The types of the values this node defines. SDNode's may
351 /// define multiple values simultaneously.
352 const EVT *ValueList;
354 /// List of uses for this SDNode.
357 /// The number of entries in the Operand/Value list.
358 unsigned short NumOperands, NumValues;
360 /// Source line information.
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
370 /// Return a pointer to the specified value type.
371 static const EVT *getValueTypeList(EVT VT);
373 friend class SelectionDAG;
374 friend struct ilist_traits<SDNode>;
377 //===--------------------------------------------------------------------===//
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; }
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; }
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;
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);
408 /// Test if this node has a post-isel opcode, directly
409 /// corresponding to a MachineInstr opcode.
410 bool isMachineOpcode() const { return NodeType < 0; }
412 /// This may only be called if isMachineOpcode returns
413 /// true. It returns the MachineInstr opcode value that the node's opcode
415 unsigned getMachineOpcode() const {
416 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
421 bool getHasDebugValue() const { return HasDebugValue; }
424 void setHasDebugValue(bool b) { HasDebugValue = b; }
426 /// Return true if there are no uses of this node.
427 bool use_empty() const { return UseList == nullptr; }
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();
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()); }
438 /// Return the unique node id.
439 int getNodeId() const { return NodeId; }
441 /// Set unique node id.
442 void setNodeId(int Id) { NodeId = Id; }
444 /// Return the node ordering.
445 unsigned getIROrder() const { return IROrder; }
447 /// Set the node ordering.
448 void setIROrder(unsigned Order) { IROrder = Order; }
450 /// Return the source location info.
451 const DebugLoc &getDebugLoc() const { return debugLoc; }
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); }
457 /// This class provides iterator support for SDUse
458 /// operands that use a specific SDNode.
460 : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
462 explicit use_iterator(SDUse *op) : Op(op) {
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;
471 use_iterator(const use_iterator &I) : Op(I.Op) {}
472 use_iterator() : Op(nullptr) {}
474 bool operator==(const use_iterator &x) const {
477 bool operator!=(const use_iterator &x) const {
478 return !operator==(x);
481 /// Return true if this iterator is at the end of uses list.
482 bool atEnd() const { return Op == nullptr; }
484 // Iterator traversal: forward iteration only.
485 use_iterator &operator++() { // Preincrement
486 assert(Op && "Cannot increment end iterator!");
491 use_iterator operator++(int) { // Postincrement
492 use_iterator tmp = *this; ++*this; return tmp;
495 /// Retrieve a pointer to the current user node.
496 SDNode *operator*() const {
497 assert(Op && "Cannot dereference end iterator!");
498 return Op->getUser();
501 SDNode *operator->() const { return operator*(); }
503 SDUse &getUse() const { return *Op; }
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);
512 /// Provide iteration support to walk over all uses of an SDNode.
513 use_iterator use_begin() const {
514 return use_iterator(UseList);
517 static use_iterator use_end() { return use_iterator(nullptr); }
519 inline iterator_range<use_iterator> uses() {
520 return iterator_range<use_iterator>(use_begin(), use_end());
522 inline iterator_range<use_iterator> uses() const {
523 return iterator_range<use_iterator>(use_begin(), use_end());
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;
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;
534 /// Return true if this node is the only use of N.
535 bool isOnlyUserOf(SDNode *N) const;
537 /// Return true if this node is an operand of N.
538 bool isOperandOf(SDNode *N) const;
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);
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;
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
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;
566 /// Return the number of values used by this operation.
567 unsigned getNumOperands() const { return NumOperands; }
569 /// Helper method returns the integer value of a ConstantSDNode operand.
570 uint64_t getConstantOperandVal(unsigned Num) const;
572 const SDValue &getOperand(unsigned Num) const {
573 assert(Num < NumOperands && "Invalid child # of SDNode!");
574 return OperandList[Num];
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()); }
582 SDVTList getVTList() const {
583 SDVTList X = { ValueList, NumValues };
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();
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;
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();
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)
621 /// Return the number of values defined/returned by this operator.
622 unsigned getNumValues() const { return NumValues; }
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];
630 /// Return the type of a specified result as a simple type.
631 MVT getSimpleValueType(unsigned ResNo) const {
632 return getValueType(ResNo).getSimpleVT();
635 /// Returns MVT::getSizeInBits(getValueType(ResNo)).
636 unsigned getValueSizeInBits(unsigned ResNo) const {
637 return getValueType(ResNo).getSizeInBits();
640 typedef const EVT* value_iterator;
641 value_iterator value_begin() const { return ValueList; }
642 value_iterator value_end() const { return ValueList+NumValues; }
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;
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
658 void printrFull(raw_ostream &O, const SelectionDAG *G = nullptr) const;
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
666 void printrWithDepth(raw_ostream &O, const SelectionDAG *G = nullptr,
667 unsigned depth = 100) const;
670 /// Dump this node, for debugging.
673 /// Dump (recursively) this node and its use-def subgraph.
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;
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;
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;
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.
697 void dumprWithDepth(const SelectionDAG *G = nullptr,
698 unsigned depth = 100) const;
700 /// Gather unique data for the node.
701 void Profile(FoldingSetNodeID &ID) const;
703 /// This method should only be used by the SDUse class.
704 void addUse(SDUse &U) { U.addToList(&UseList); }
707 static SDVTList getSDVTList(EVT VT) {
708 SDVTList Ret = { getValueTypeList(VT), 1 };
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]);
729 checkForCycles(this);
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!");
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);
750 checkForCycles(this);
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);
761 checkForCycles(this);
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);
775 checkForCycles(this);
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);
791 checkForCycles(this);
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]);
801 assert(NumOperands == N &&
802 "NumOperands wasn't wide enough for its operands!");
804 checkForCycles(this);
807 /// Release the operands and set this node to have zero operands.
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
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.
822 // Ptr could be used for either Instruction* or SDNode*. It is used for
823 // Instruction* if IROrder is not -1.
828 SDLoc() : Ptr(nullptr), IROrder(0) {}
829 SDLoc(const SDNode *N) : Ptr(N), IROrder(-1) {
830 assert(N && "null SDNode");
832 SDLoc(const SDValue V) : Ptr(V.getNode()), IROrder(-1) {
833 assert(Ptr && "null SDNode");
835 SDLoc(const Instruction *I, int Order) : Ptr(I), IROrder(Order) {
836 assert(Order >= 0 && "bad IROrder");
838 unsigned getIROrder() {
839 if (IROrder >= 0 || Ptr == nullptr) {
840 return (unsigned)IROrder;
842 const SDNode *N = (const SDNode*)(Ptr);
843 return N->getIROrder();
845 DebugLoc getDebugLoc() {
850 const Instruction *I = (const Instruction*)(Ptr);
851 return I->getDebugLoc();
853 const SDNode *N = (const SDNode*)(Ptr);
854 return N->getDebugLoc();
859 // Define inline functions from the SDValue class.
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.");
868 inline unsigned SDValue::getOpcode() const {
869 return Node->getOpcode();
871 inline EVT SDValue::getValueType() const {
872 return Node->getValueType(ResNo);
874 inline unsigned SDValue::getNumOperands() const {
875 return Node->getNumOperands();
877 inline const SDValue &SDValue::getOperand(unsigned i) const {
878 return Node->getOperand(i);
880 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
881 return Node->getConstantOperandVal(i);
883 inline bool SDValue::isTargetOpcode() const {
884 return Node->isTargetOpcode();
886 inline bool SDValue::isTargetMemoryOpcode() const {
887 return Node->isTargetMemoryOpcode();
889 inline bool SDValue::isMachineOpcode() const {
890 return Node->isMachineOpcode();
892 inline unsigned SDValue::getMachineOpcode() const {
893 return Node->getMachineOpcode();
895 inline bool SDValue::use_empty() const {
896 return !Node->hasAnyUseOfValue(ResNo);
898 inline bool SDValue::hasOneUse() const {
899 return Node->hasNUsesOfValue(1, ResNo);
901 inline const DebugLoc &SDValue::getDebugLoc() const {
902 return Node->getDebugLoc();
904 inline void SDValue::dump() const {
907 inline void SDValue::dumpr() const {
908 return Node->dumpr();
910 // Define inline functions from the SDUse class.
912 inline void SDUse::set(const SDValue &V) {
913 if (Val.getNode()) removeFromList();
915 if (V.getNode()) V.getNode()->addUse(*this);
918 inline void SDUse::setInitial(const SDValue &V) {
920 V.getNode()->addUse(*this);
923 inline void SDUse::setNode(SDNode *N) {
924 if (Val.getNode()) removeFromList();
926 if (N) N->addUse(*this);
929 /// This class is used for single-operand SDNodes. This is solely
930 /// to allow co-allocation of node operands with the node itself.
931 class UnarySDNode : public SDNode {
934 UnarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
936 : SDNode(Opc, Order, dl, VTs) {
937 InitOperands(&Op, X);
941 /// This class is used for two-operand SDNodes. This is solely
942 /// to allow co-allocation of node operands with the node itself.
943 class BinarySDNode : public SDNode {
946 BinarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
947 SDValue X, SDValue Y)
948 : SDNode(Opc, Order, dl, VTs) {
949 InitOperands(Ops, X, Y);
953 /// Returns true if the opcode is a binary operation with flags.
954 static bool isBinOpWithFlags(unsigned Opcode) {
970 /// This class is an extension of BinarySDNode
971 /// used from those opcodes that have associated extra flags.
972 class BinaryWithFlagsSDNode : public BinarySDNode {
973 enum { NUW = (1 << 0), NSW = (1 << 1), EXACT = (1 << 2) };
976 BinaryWithFlagsSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
977 SDValue X, SDValue Y)
978 : BinarySDNode(Opc, Order, dl, VTs, X, Y) {}
979 /// Return the SubclassData value, which contains an encoding of the flags.
980 /// This function should be used to add subclass data to the NodeID value.
981 unsigned getRawSubclassData() const { return SubclassData; }
982 void setHasNoUnsignedWrap(bool b) {
983 SubclassData = (SubclassData & ~NUW) | (b ? NUW : 0);
985 void setHasNoSignedWrap(bool b) {
986 SubclassData = (SubclassData & ~NSW) | (b ? NSW : 0);
988 void setIsExact(bool b) {
989 SubclassData = (SubclassData & ~EXACT) | (b ? EXACT : 0);
991 bool hasNoUnsignedWrap() const { return SubclassData & NUW; }
992 bool hasNoSignedWrap() const { return SubclassData & NSW; }
993 bool isExact() const { return SubclassData & EXACT; }
994 static bool classof(const SDNode *N) {
995 return isBinOpWithFlags(N->getOpcode());
999 /// This class is used for three-operand SDNodes. This is solely
1000 /// to allow co-allocation of node operands with the node itself.
1001 class TernarySDNode : public SDNode {
1004 TernarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1005 SDValue X, SDValue Y, SDValue Z)
1006 : SDNode(Opc, Order, dl, VTs) {
1007 InitOperands(Ops, X, Y, Z);
1012 /// This class is used to form a handle around another node that
1013 /// is persistent and is updated across invocations of replaceAllUsesWith on its
1014 /// operand. This node should be directly created by end-users and not added to
1015 /// the AllNodes list.
1016 class HandleSDNode : public SDNode {
1019 explicit HandleSDNode(SDValue X)
1020 : SDNode(ISD::HANDLENODE, 0, DebugLoc(), getSDVTList(MVT::Other)) {
1021 InitOperands(&Op, X);
1024 const SDValue &getValue() const { return Op; }
1027 class AddrSpaceCastSDNode : public UnarySDNode {
1029 unsigned SrcAddrSpace;
1030 unsigned DestAddrSpace;
1033 AddrSpaceCastSDNode(unsigned Order, DebugLoc dl, EVT VT, SDValue X,
1034 unsigned SrcAS, unsigned DestAS);
1036 unsigned getSrcAddressSpace() const { return SrcAddrSpace; }
1037 unsigned getDestAddressSpace() const { return DestAddrSpace; }
1039 static bool classof(const SDNode *N) {
1040 return N->getOpcode() == ISD::ADDRSPACECAST;
1044 /// Abstact virtual class for operations for memory operations
1045 class MemSDNode : public SDNode {
1047 // VT of in-memory value.
1051 /// Memory reference information.
1052 MachineMemOperand *MMO;
1055 MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1056 EVT MemoryVT, MachineMemOperand *MMO);
1058 MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1059 ArrayRef<SDValue> Ops, EVT MemoryVT, MachineMemOperand *MMO);
1061 bool readMem() const { return MMO->isLoad(); }
1062 bool writeMem() const { return MMO->isStore(); }
1064 /// Returns alignment and volatility of the memory access
1065 unsigned getOriginalAlignment() const {
1066 return MMO->getBaseAlignment();
1068 unsigned getAlignment() const {
1069 return MMO->getAlignment();
1072 /// Return the SubclassData value, which contains an
1073 /// encoding of the volatile flag, as well as bits used by subclasses. This
1074 /// function should only be used to compute a FoldingSetNodeID value.
1075 unsigned getRawSubclassData() const {
1076 return SubclassData;
1079 // We access subclass data here so that we can check consistency
1080 // with MachineMemOperand information.
1081 bool isVolatile() const { return (SubclassData >> 5) & 1; }
1082 bool isNonTemporal() const { return (SubclassData >> 6) & 1; }
1083 bool isInvariant() const { return (SubclassData >> 7) & 1; }
1085 AtomicOrdering getOrdering() const {
1086 return AtomicOrdering((SubclassData >> 8) & 15);
1088 SynchronizationScope getSynchScope() const {
1089 return SynchronizationScope((SubclassData >> 12) & 1);
1092 // Returns the offset from the location of the access.
1093 int64_t getSrcValueOffset() const { return MMO->getOffset(); }
1095 /// Returns the AA info that describes the dereference.
1096 AAMDNodes getAAInfo() const { return MMO->getAAInfo(); }
1098 /// Returns the Ranges that describes the dereference.
1099 const MDNode *getRanges() const { return MMO->getRanges(); }
1101 /// Return the type of the in-memory value.
1102 EVT getMemoryVT() const { return MemoryVT; }
1104 /// Return a MachineMemOperand object describing the memory
1105 /// reference performed by operation.
1106 MachineMemOperand *getMemOperand() const { return MMO; }
1108 const MachinePointerInfo &getPointerInfo() const {
1109 return MMO->getPointerInfo();
1112 /// Return the address space for the associated pointer
1113 unsigned getAddressSpace() const {
1114 return getPointerInfo().getAddrSpace();
1117 /// Update this MemSDNode's MachineMemOperand information
1118 /// to reflect the alignment of NewMMO, if it has a greater alignment.
1119 /// This must only be used when the new alignment applies to all users of
1120 /// this MachineMemOperand.
1121 void refineAlignment(const MachineMemOperand *NewMMO) {
1122 MMO->refineAlignment(NewMMO);
1125 const SDValue &getChain() const { return getOperand(0); }
1126 const SDValue &getBasePtr() const {
1127 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1130 // Methods to support isa and dyn_cast
1131 static bool classof(const SDNode *N) {
1132 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1133 // with either an intrinsic or a target opcode.
1134 return N->getOpcode() == ISD::LOAD ||
1135 N->getOpcode() == ISD::STORE ||
1136 N->getOpcode() == ISD::PREFETCH ||
1137 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1138 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS ||
1139 N->getOpcode() == ISD::ATOMIC_SWAP ||
1140 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1141 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1142 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1143 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1144 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1145 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1146 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1147 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1148 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1149 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1150 N->getOpcode() == ISD::ATOMIC_LOAD ||
1151 N->getOpcode() == ISD::ATOMIC_STORE ||
1152 N->getOpcode() == ISD::MLOAD ||
1153 N->getOpcode() == ISD::MSTORE ||
1154 N->getOpcode() == ISD::MGATHER ||
1155 N->getOpcode() == ISD::MSCATTER ||
1156 N->isMemIntrinsic() ||
1157 N->isTargetMemoryOpcode();
1161 /// A SDNode reprenting atomic operations.
1162 class AtomicSDNode : public MemSDNode {
1165 /// For cmpxchg instructions, the ordering requirements when a store does not
1167 AtomicOrdering FailureOrdering;
1169 void InitAtomic(AtomicOrdering SuccessOrdering,
1170 AtomicOrdering FailureOrdering,
1171 SynchronizationScope SynchScope) {
1172 // This must match encodeMemSDNodeFlags() in SelectionDAG.cpp.
1173 assert((SuccessOrdering & 15) == SuccessOrdering &&
1174 "Ordering may not require more than 4 bits!");
1175 assert((FailureOrdering & 15) == FailureOrdering &&
1176 "Ordering may not require more than 4 bits!");
1177 assert((SynchScope & 1) == SynchScope &&
1178 "SynchScope may not require more than 1 bit!");
1179 SubclassData |= SuccessOrdering << 8;
1180 SubclassData |= SynchScope << 12;
1181 this->FailureOrdering = FailureOrdering;
1182 assert(getSuccessOrdering() == SuccessOrdering &&
1183 "Ordering encoding error!");
1184 assert(getFailureOrdering() == FailureOrdering &&
1185 "Ordering encoding error!");
1186 assert(getSynchScope() == SynchScope && "Synch-scope encoding error!");
1190 // Opc: opcode for atomic
1191 // VTL: value type list
1192 // Chain: memory chain for operaand
1193 // Ptr: address to update as a SDValue
1194 // Cmp: compare value
1196 // SrcVal: address to update as a Value (used for MemOperand)
1197 // Align: alignment of memory
1198 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1199 EVT MemVT, SDValue Chain, SDValue Ptr, SDValue Cmp, SDValue Swp,
1200 MachineMemOperand *MMO, AtomicOrdering Ordering,
1201 SynchronizationScope SynchScope)
1202 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1203 InitAtomic(Ordering, Ordering, SynchScope);
1204 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1206 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1208 SDValue Chain, SDValue Ptr,
1209 SDValue Val, MachineMemOperand *MMO,
1210 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1211 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1212 InitAtomic(Ordering, Ordering, SynchScope);
1213 InitOperands(Ops, Chain, Ptr, Val);
1215 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1217 SDValue Chain, SDValue Ptr,
1218 MachineMemOperand *MMO,
1219 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1220 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1221 InitAtomic(Ordering, Ordering, SynchScope);
1222 InitOperands(Ops, Chain, Ptr);
1224 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL, EVT MemVT,
1225 const SDValue* AllOps, SDUse *DynOps, unsigned NumOps,
1226 MachineMemOperand *MMO,
1227 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
1228 SynchronizationScope SynchScope)
1229 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1230 InitAtomic(SuccessOrdering, FailureOrdering, SynchScope);
1231 assert((DynOps || NumOps <= array_lengthof(Ops)) &&
1232 "Too many ops for internal storage!");
1233 InitOperands(DynOps ? DynOps : Ops, AllOps, NumOps);
1236 const SDValue &getBasePtr() const { return getOperand(1); }
1237 const SDValue &getVal() const { return getOperand(2); }
1239 AtomicOrdering getSuccessOrdering() const {
1240 return getOrdering();
1243 // Not quite enough room in SubclassData for everything, so failure gets its
1245 AtomicOrdering getFailureOrdering() const {
1246 return FailureOrdering;
1249 bool isCompareAndSwap() const {
1250 unsigned Op = getOpcode();
1251 return Op == ISD::ATOMIC_CMP_SWAP || Op == ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS;
1254 // Methods to support isa and dyn_cast
1255 static bool classof(const SDNode *N) {
1256 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1257 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS ||
1258 N->getOpcode() == ISD::ATOMIC_SWAP ||
1259 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1260 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1261 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1262 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1263 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1264 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1265 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1266 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1267 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1268 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1269 N->getOpcode() == ISD::ATOMIC_LOAD ||
1270 N->getOpcode() == ISD::ATOMIC_STORE;
1274 /// This SDNode is used for target intrinsics that touch
1275 /// memory and need an associated MachineMemOperand. Its opcode may be
1276 /// INTRINSIC_VOID, INTRINSIC_W_CHAIN, PREFETCH, or a target-specific opcode
1277 /// with a value not less than FIRST_TARGET_MEMORY_OPCODE.
1278 class MemIntrinsicSDNode : public MemSDNode {
1280 MemIntrinsicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1281 ArrayRef<SDValue> Ops, EVT MemoryVT,
1282 MachineMemOperand *MMO)
1283 : MemSDNode(Opc, Order, dl, VTs, Ops, MemoryVT, MMO) {
1284 SubclassData |= 1u << 13;
1287 // Methods to support isa and dyn_cast
1288 static bool classof(const SDNode *N) {
1289 // We lower some target intrinsics to their target opcode
1290 // early a node with a target opcode can be of this class
1291 return N->isMemIntrinsic() ||
1292 N->getOpcode() == ISD::PREFETCH ||
1293 N->isTargetMemoryOpcode();
1297 /// This SDNode is used to implement the code generator
1298 /// support for the llvm IR shufflevector instruction. It combines elements
1299 /// from two input vectors into a new input vector, with the selection and
1300 /// ordering of elements determined by an array of integers, referred to as
1301 /// the shuffle mask. For input vectors of width N, mask indices of 0..N-1
1302 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1303 /// An index of -1 is treated as undef, such that the code generator may put
1304 /// any value in the corresponding element of the result.
1305 class ShuffleVectorSDNode : public SDNode {
1308 // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1309 // is freed when the SelectionDAG object is destroyed.
1312 friend class SelectionDAG;
1313 ShuffleVectorSDNode(EVT VT, unsigned Order, DebugLoc dl, SDValue N1,
1314 SDValue N2, const int *M)
1315 : SDNode(ISD::VECTOR_SHUFFLE, Order, dl, getSDVTList(VT)), Mask(M) {
1316 InitOperands(Ops, N1, N2);
1320 ArrayRef<int> getMask() const {
1321 EVT VT = getValueType(0);
1322 return makeArrayRef(Mask, VT.getVectorNumElements());
1324 int getMaskElt(unsigned Idx) const {
1325 assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1329 bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1330 int getSplatIndex() const {
1331 assert(isSplat() && "Cannot get splat index for non-splat!");
1332 EVT VT = getValueType(0);
1333 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i) {
1337 llvm_unreachable("Splat with all undef indices?");
1339 static bool isSplatMask(const int *Mask, EVT VT);
1341 /// Change values in a shuffle permute mask assuming
1342 /// the two vector operands have swapped position.
1343 static void commuteMask(SmallVectorImpl<int> &Mask) {
1344 unsigned NumElems = Mask.size();
1345 for (unsigned i = 0; i != NumElems; ++i) {
1349 else if (idx < (int)NumElems)
1350 Mask[i] = idx + NumElems;
1352 Mask[i] = idx - NumElems;
1356 static bool classof(const SDNode *N) {
1357 return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1361 class ConstantSDNode : public SDNode {
1362 const ConstantInt *Value;
1363 friend class SelectionDAG;
1364 ConstantSDNode(bool isTarget, bool isOpaque, const ConstantInt *val,
1365 DebugLoc DL, EVT VT)
1366 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1367 0, DL, getSDVTList(VT)), Value(val) {
1368 SubclassData |= (uint16_t)isOpaque;
1372 const ConstantInt *getConstantIntValue() const { return Value; }
1373 const APInt &getAPIntValue() const { return Value->getValue(); }
1374 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1375 int64_t getSExtValue() const { return Value->getSExtValue(); }
1377 bool isOne() const { return Value->isOne(); }
1378 bool isNullValue() const { return Value->isNullValue(); }
1379 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1381 bool isOpaque() const { return SubclassData & 1; }
1383 static bool classof(const SDNode *N) {
1384 return N->getOpcode() == ISD::Constant ||
1385 N->getOpcode() == ISD::TargetConstant;
1389 class ConstantFPSDNode : public SDNode {
1390 const ConstantFP *Value;
1391 friend class SelectionDAG;
1392 ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1393 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1394 0, DebugLoc(), getSDVTList(VT)), Value(val) {
1398 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1399 const ConstantFP *getConstantFPValue() const { return Value; }
1401 /// Return true if the value is positive or negative zero.
1402 bool isZero() const { return Value->isZero(); }
1404 /// Return true if the value is a NaN.
1405 bool isNaN() const { return Value->isNaN(); }
1407 /// Return true if the value is an infinity
1408 bool isInfinity() const { return Value->isInfinity(); }
1410 /// Return true if the value is negative.
1411 bool isNegative() const { return Value->isNegative(); }
1413 /// We don't rely on operator== working on double values, as
1414 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1415 /// As such, this method can be used to do an exact bit-for-bit comparison of
1416 /// two floating point values.
1418 /// We leave the version with the double argument here because it's just so
1419 /// convenient to write "2.0" and the like. Without this function we'd
1420 /// have to duplicate its logic everywhere it's called.
1421 bool isExactlyValue(double V) const {
1424 Tmp.convert(Value->getValueAPF().getSemantics(),
1425 APFloat::rmNearestTiesToEven, &ignored);
1426 return isExactlyValue(Tmp);
1428 bool isExactlyValue(const APFloat& V) const;
1430 static bool isValueValidForType(EVT VT, const APFloat& Val);
1432 static bool classof(const SDNode *N) {
1433 return N->getOpcode() == ISD::ConstantFP ||
1434 N->getOpcode() == ISD::TargetConstantFP;
1438 class GlobalAddressSDNode : public SDNode {
1439 const GlobalValue *TheGlobal;
1441 unsigned char TargetFlags;
1442 friend class SelectionDAG;
1443 GlobalAddressSDNode(unsigned Opc, unsigned Order, DebugLoc DL,
1444 const GlobalValue *GA, EVT VT, int64_t o,
1445 unsigned char TargetFlags);
1448 const GlobalValue *getGlobal() const { return TheGlobal; }
1449 int64_t getOffset() const { return Offset; }
1450 unsigned char getTargetFlags() const { return TargetFlags; }
1451 // Return the address space this GlobalAddress belongs to.
1452 unsigned getAddressSpace() const;
1454 static bool classof(const SDNode *N) {
1455 return N->getOpcode() == ISD::GlobalAddress ||
1456 N->getOpcode() == ISD::TargetGlobalAddress ||
1457 N->getOpcode() == ISD::GlobalTLSAddress ||
1458 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1462 class FrameIndexSDNode : public SDNode {
1464 friend class SelectionDAG;
1465 FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1466 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1467 0, DebugLoc(), getSDVTList(VT)), FI(fi) {
1471 int getIndex() const { return FI; }
1473 static bool classof(const SDNode *N) {
1474 return N->getOpcode() == ISD::FrameIndex ||
1475 N->getOpcode() == ISD::TargetFrameIndex;
1479 class JumpTableSDNode : public SDNode {
1481 unsigned char TargetFlags;
1482 friend class SelectionDAG;
1483 JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1484 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1485 0, DebugLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1489 int getIndex() const { return JTI; }
1490 unsigned char getTargetFlags() const { return TargetFlags; }
1492 static bool classof(const SDNode *N) {
1493 return N->getOpcode() == ISD::JumpTable ||
1494 N->getOpcode() == ISD::TargetJumpTable;
1498 class ConstantPoolSDNode : public SDNode {
1500 const Constant *ConstVal;
1501 MachineConstantPoolValue *MachineCPVal;
1503 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1504 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1505 unsigned char TargetFlags;
1506 friend class SelectionDAG;
1507 ConstantPoolSDNode(bool isTarget, const Constant *c, EVT VT, int o,
1508 unsigned Align, unsigned char TF)
1509 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1510 DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1512 assert(Offset >= 0 && "Offset is too large");
1515 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1516 EVT VT, int o, unsigned Align, unsigned char TF)
1517 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1518 DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1520 assert(Offset >= 0 && "Offset is too large");
1521 Val.MachineCPVal = v;
1522 Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1526 bool isMachineConstantPoolEntry() const {
1530 const Constant *getConstVal() const {
1531 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1532 return Val.ConstVal;
1535 MachineConstantPoolValue *getMachineCPVal() const {
1536 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1537 return Val.MachineCPVal;
1540 int getOffset() const {
1541 return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1544 // Return the alignment of this constant pool object, which is either 0 (for
1545 // default alignment) or the desired value.
1546 unsigned getAlignment() const { return Alignment; }
1547 unsigned char getTargetFlags() const { return TargetFlags; }
1549 Type *getType() const;
1551 static bool classof(const SDNode *N) {
1552 return N->getOpcode() == ISD::ConstantPool ||
1553 N->getOpcode() == ISD::TargetConstantPool;
1557 /// Completely target-dependent object reference.
1558 class TargetIndexSDNode : public SDNode {
1559 unsigned char TargetFlags;
1562 friend class SelectionDAG;
1565 TargetIndexSDNode(int Idx, EVT VT, int64_t Ofs, unsigned char TF)
1566 : SDNode(ISD::TargetIndex, 0, DebugLoc(), getSDVTList(VT)),
1567 TargetFlags(TF), Index(Idx), Offset(Ofs) {}
1570 unsigned char getTargetFlags() const { return TargetFlags; }
1571 int getIndex() const { return Index; }
1572 int64_t getOffset() const { return Offset; }
1574 static bool classof(const SDNode *N) {
1575 return N->getOpcode() == ISD::TargetIndex;
1579 class BasicBlockSDNode : public SDNode {
1580 MachineBasicBlock *MBB;
1581 friend class SelectionDAG;
1582 /// Debug info is meaningful and potentially useful here, but we create
1583 /// blocks out of order when they're jumped to, which makes it a bit
1584 /// harder. Let's see if we need it first.
1585 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1586 : SDNode(ISD::BasicBlock, 0, DebugLoc(), getSDVTList(MVT::Other)), MBB(mbb)
1590 MachineBasicBlock *getBasicBlock() const { return MBB; }
1592 static bool classof(const SDNode *N) {
1593 return N->getOpcode() == ISD::BasicBlock;
1597 /// A "pseudo-class" with methods for operating on BUILD_VECTORs.
1598 class BuildVectorSDNode : public SDNode {
1599 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1600 explicit BuildVectorSDNode() = delete;
1602 /// Check if this is a constant splat, and if so, find the
1603 /// smallest element size that splats the vector. If MinSplatBits is
1604 /// nonzero, the element size must be at least that large. Note that the
1605 /// splat element may be the entire vector (i.e., a one element vector).
1606 /// Returns the splat element value in SplatValue. Any undefined bits in
1607 /// that value are zero, and the corresponding bits in the SplatUndef mask
1608 /// are set. The SplatBitSize value is set to the splat element size in
1609 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1610 /// undefined. isBigEndian describes the endianness of the target.
1611 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1612 unsigned &SplatBitSize, bool &HasAnyUndefs,
1613 unsigned MinSplatBits = 0,
1614 bool isBigEndian = false) const;
1616 /// \brief Returns the splatted value or a null value if this is not a splat.
1618 /// If passed a non-null UndefElements bitvector, it will resize it to match
1619 /// the vector width and set the bits where elements are undef.
1620 SDValue getSplatValue(BitVector *UndefElements = nullptr) const;
1622 /// \brief Returns the splatted constant or null if this is not a constant
1625 /// If passed a non-null UndefElements bitvector, it will resize it to match
1626 /// the vector width and set the bits where elements are undef.
1628 getConstantSplatNode(BitVector *UndefElements = nullptr) const;
1630 /// \brief Returns the splatted constant FP or null if this is not a constant
1633 /// If passed a non-null UndefElements bitvector, it will resize it to match
1634 /// the vector width and set the bits where elements are undef.
1636 getConstantFPSplatNode(BitVector *UndefElements = nullptr) const;
1638 bool isConstant() const;
1640 static inline bool classof(const SDNode *N) {
1641 return N->getOpcode() == ISD::BUILD_VECTOR;
1645 /// An SDNode that holds an arbitrary LLVM IR Value. This is
1646 /// used when the SelectionDAG needs to make a simple reference to something
1647 /// in the LLVM IR representation.
1649 class SrcValueSDNode : public SDNode {
1651 friend class SelectionDAG;
1652 /// Create a SrcValue for a general value.
1653 explicit SrcValueSDNode(const Value *v)
1654 : SDNode(ISD::SRCVALUE, 0, DebugLoc(), getSDVTList(MVT::Other)), V(v) {}
1657 /// Return the contained Value.
1658 const Value *getValue() const { return V; }
1660 static bool classof(const SDNode *N) {
1661 return N->getOpcode() == ISD::SRCVALUE;
1665 class MDNodeSDNode : public SDNode {
1667 friend class SelectionDAG;
1668 explicit MDNodeSDNode(const MDNode *md)
1669 : SDNode(ISD::MDNODE_SDNODE, 0, DebugLoc(), getSDVTList(MVT::Other)), MD(md)
1673 const MDNode *getMD() const { return MD; }
1675 static bool classof(const SDNode *N) {
1676 return N->getOpcode() == ISD::MDNODE_SDNODE;
1680 class RegisterSDNode : public SDNode {
1682 friend class SelectionDAG;
1683 RegisterSDNode(unsigned reg, EVT VT)
1684 : SDNode(ISD::Register, 0, DebugLoc(), getSDVTList(VT)), Reg(reg) {
1688 unsigned getReg() const { return Reg; }
1690 static bool classof(const SDNode *N) {
1691 return N->getOpcode() == ISD::Register;
1695 class RegisterMaskSDNode : public SDNode {
1696 // The memory for RegMask is not owned by the node.
1697 const uint32_t *RegMask;
1698 friend class SelectionDAG;
1699 RegisterMaskSDNode(const uint32_t *mask)
1700 : SDNode(ISD::RegisterMask, 0, DebugLoc(), getSDVTList(MVT::Untyped)),
1704 const uint32_t *getRegMask() const { return RegMask; }
1706 static bool classof(const SDNode *N) {
1707 return N->getOpcode() == ISD::RegisterMask;
1711 class BlockAddressSDNode : public SDNode {
1712 const BlockAddress *BA;
1714 unsigned char TargetFlags;
1715 friend class SelectionDAG;
1716 BlockAddressSDNode(unsigned NodeTy, EVT VT, const BlockAddress *ba,
1717 int64_t o, unsigned char Flags)
1718 : SDNode(NodeTy, 0, DebugLoc(), getSDVTList(VT)),
1719 BA(ba), Offset(o), TargetFlags(Flags) {
1722 const BlockAddress *getBlockAddress() const { return BA; }
1723 int64_t getOffset() const { return Offset; }
1724 unsigned char getTargetFlags() const { return TargetFlags; }
1726 static bool classof(const SDNode *N) {
1727 return N->getOpcode() == ISD::BlockAddress ||
1728 N->getOpcode() == ISD::TargetBlockAddress;
1732 class EHLabelSDNode : public SDNode {
1735 friend class SelectionDAG;
1736 EHLabelSDNode(unsigned Order, DebugLoc dl, SDValue ch, MCSymbol *L)
1737 : SDNode(ISD::EH_LABEL, Order, dl, getSDVTList(MVT::Other)), Label(L) {
1738 InitOperands(&Chain, ch);
1741 MCSymbol *getLabel() const { return Label; }
1743 static bool classof(const SDNode *N) {
1744 return N->getOpcode() == ISD::EH_LABEL;
1748 class ExternalSymbolSDNode : public SDNode {
1750 unsigned char TargetFlags;
1752 friend class SelectionDAG;
1753 ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
1754 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1755 0, DebugLoc(), getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
1759 const char *getSymbol() const { return Symbol; }
1760 unsigned char getTargetFlags() const { return TargetFlags; }
1762 static bool classof(const SDNode *N) {
1763 return N->getOpcode() == ISD::ExternalSymbol ||
1764 N->getOpcode() == ISD::TargetExternalSymbol;
1768 class CondCodeSDNode : public SDNode {
1769 ISD::CondCode Condition;
1770 friend class SelectionDAG;
1771 explicit CondCodeSDNode(ISD::CondCode Cond)
1772 : SDNode(ISD::CONDCODE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1777 ISD::CondCode get() const { return Condition; }
1779 static bool classof(const SDNode *N) {
1780 return N->getOpcode() == ISD::CONDCODE;
1784 /// NOTE: avoid using this node as this may disappear in the
1785 /// future and most targets don't support it.
1786 class CvtRndSatSDNode : public SDNode {
1787 ISD::CvtCode CvtCode;
1788 friend class SelectionDAG;
1789 explicit CvtRndSatSDNode(EVT VT, unsigned Order, DebugLoc dl,
1790 ArrayRef<SDValue> Ops, ISD::CvtCode Code)
1791 : SDNode(ISD::CONVERT_RNDSAT, Order, dl, getSDVTList(VT), Ops),
1793 assert(Ops.size() == 5 && "wrong number of operations");
1796 ISD::CvtCode getCvtCode() const { return CvtCode; }
1798 static bool classof(const SDNode *N) {
1799 return N->getOpcode() == ISD::CONVERT_RNDSAT;
1803 /// This class is used to represent EVT's, which are used
1804 /// to parameterize some operations.
1805 class VTSDNode : public SDNode {
1807 friend class SelectionDAG;
1808 explicit VTSDNode(EVT VT)
1809 : SDNode(ISD::VALUETYPE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1814 EVT getVT() const { return ValueType; }
1816 static bool classof(const SDNode *N) {
1817 return N->getOpcode() == ISD::VALUETYPE;
1821 /// Base class for LoadSDNode and StoreSDNode
1822 class LSBaseSDNode : public MemSDNode {
1823 //! Operand array for load and store
1825 \note Moving this array to the base class captures more
1826 common functionality shared between LoadSDNode and
1831 LSBaseSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
1832 SDValue *Operands, unsigned numOperands,
1833 SDVTList VTs, ISD::MemIndexedMode AM, EVT MemVT,
1834 MachineMemOperand *MMO)
1835 : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
1836 SubclassData |= AM << 2;
1837 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
1838 InitOperands(Ops, Operands, numOperands);
1839 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1840 "Only indexed loads and stores have a non-undef offset operand");
1843 const SDValue &getOffset() const {
1844 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1847 /// Return the addressing mode for this load or store:
1848 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
1849 ISD::MemIndexedMode getAddressingMode() const {
1850 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
1853 /// Return true if this is a pre/post inc/dec load/store.
1854 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
1856 /// Return true if this is NOT a pre/post inc/dec load/store.
1857 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
1859 static bool classof(const SDNode *N) {
1860 return N->getOpcode() == ISD::LOAD ||
1861 N->getOpcode() == ISD::STORE;
1865 /// This class is used to represent ISD::LOAD nodes.
1866 class LoadSDNode : public LSBaseSDNode {
1867 friend class SelectionDAG;
1868 LoadSDNode(SDValue *ChainPtrOff, unsigned Order, DebugLoc dl, SDVTList VTs,
1869 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT MemVT,
1870 MachineMemOperand *MMO)
1871 : LSBaseSDNode(ISD::LOAD, Order, dl, ChainPtrOff, 3, VTs, AM, MemVT, MMO) {
1872 SubclassData |= (unsigned short)ETy;
1873 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
1874 assert(readMem() && "Load MachineMemOperand is not a load!");
1875 assert(!writeMem() && "Load MachineMemOperand is a store!");
1879 /// Return whether this is a plain node,
1880 /// or one of the varieties of value-extending loads.
1881 ISD::LoadExtType getExtensionType() const {
1882 return ISD::LoadExtType(SubclassData & 3);
1885 const SDValue &getBasePtr() const { return getOperand(1); }
1886 const SDValue &getOffset() const { return getOperand(2); }
1888 static bool classof(const SDNode *N) {
1889 return N->getOpcode() == ISD::LOAD;
1893 /// This class is used to represent ISD::STORE nodes.
1894 class StoreSDNode : public LSBaseSDNode {
1895 friend class SelectionDAG;
1896 StoreSDNode(SDValue *ChainValuePtrOff, unsigned Order, DebugLoc dl,
1897 SDVTList VTs, ISD::MemIndexedMode AM, bool isTrunc, EVT MemVT,
1898 MachineMemOperand *MMO)
1899 : LSBaseSDNode(ISD::STORE, Order, dl, ChainValuePtrOff, 4,
1900 VTs, AM, MemVT, MMO) {
1901 SubclassData |= (unsigned short)isTrunc;
1902 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
1903 assert(!readMem() && "Store MachineMemOperand is a load!");
1904 assert(writeMem() && "Store MachineMemOperand is not a store!");
1908 /// Return true if the op does a truncation before store.
1909 /// For integers this is the same as doing a TRUNCATE and storing the result.
1910 /// For floats, it is the same as doing an FP_ROUND and storing the result.
1911 bool isTruncatingStore() const { return SubclassData & 1; }
1913 const SDValue &getValue() const { return getOperand(1); }
1914 const SDValue &getBasePtr() const { return getOperand(2); }
1915 const SDValue &getOffset() const { return getOperand(3); }
1917 static bool classof(const SDNode *N) {
1918 return N->getOpcode() == ISD::STORE;
1922 /// This base class is used to represent MLOAD and MSTORE nodes
1923 class MaskedLoadStoreSDNode : public MemSDNode {
1927 friend class SelectionDAG;
1928 MaskedLoadStoreSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
1929 SDValue *Operands, unsigned numOperands,
1930 SDVTList VTs, EVT MemVT, MachineMemOperand *MMO)
1931 : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
1932 InitOperands(Ops, Operands, numOperands);
1935 // In the both nodes address is Op1, mask is Op2:
1936 // MaskedLoadSDNode (Chain, ptr, mask, src0), src0 is a passthru value
1937 // MaskedStoreSDNode (Chain, ptr, mask, data)
1938 // Mask is a vector of i1 elements
1939 const SDValue &getBasePtr() const { return getOperand(1); }
1940 const SDValue &getMask() const { return getOperand(2); }
1942 static bool classof(const SDNode *N) {
1943 return N->getOpcode() == ISD::MLOAD ||
1944 N->getOpcode() == ISD::MSTORE;
1948 /// This class is used to represent an MLOAD node
1949 class MaskedLoadSDNode : public MaskedLoadStoreSDNode {
1951 friend class SelectionDAG;
1952 MaskedLoadSDNode(unsigned Order, DebugLoc dl, SDValue *Operands,
1953 unsigned numOperands, SDVTList VTs, ISD::LoadExtType ETy,
1954 EVT MemVT, MachineMemOperand *MMO)
1955 : MaskedLoadStoreSDNode(ISD::MLOAD, Order, dl, Operands, numOperands,
1957 SubclassData |= (unsigned short)ETy;
1960 ISD::LoadExtType getExtensionType() const {
1961 return ISD::LoadExtType(SubclassData & 3);
1963 const SDValue &getSrc0() const { return getOperand(3); }
1964 static bool classof(const SDNode *N) {
1965 return N->getOpcode() == ISD::MLOAD;
1969 /// This class is used to represent an MSTORE node
1970 class MaskedStoreSDNode : public MaskedLoadStoreSDNode {
1973 friend class SelectionDAG;
1974 MaskedStoreSDNode(unsigned Order, DebugLoc dl, SDValue *Operands,
1975 unsigned numOperands, SDVTList VTs, bool isTrunc, EVT MemVT,
1976 MachineMemOperand *MMO)
1977 : MaskedLoadStoreSDNode(ISD::MSTORE, Order, dl, Operands, numOperands,
1979 SubclassData |= (unsigned short)isTrunc;
1981 /// Return true if the op does a truncation before store.
1982 /// For integers this is the same as doing a TRUNCATE and storing the result.
1983 /// For floats, it is the same as doing an FP_ROUND and storing the result.
1984 bool isTruncatingStore() const { return SubclassData & 1; }
1986 const SDValue &getValue() const { return getOperand(3); }
1988 static bool classof(const SDNode *N) {
1989 return N->getOpcode() == ISD::MSTORE;
1993 /// This is a base class is used to represent
1994 /// MGATHER and MSCATTER nodes
1996 class MaskedGatherScatterSDNode : public MemSDNode {
2000 friend class SelectionDAG;
2001 MaskedGatherScatterSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
2002 ArrayRef<SDValue> Operands, SDVTList VTs, EVT MemVT,
2003 MachineMemOperand *MMO)
2004 : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
2005 assert(Operands.size() == 5 && "Incompatible number of operands");
2006 InitOperands(Ops, Operands.data(), Operands.size());
2009 // In the both nodes address is Op1, mask is Op2:
2010 // MaskedGatherSDNode (Chain, src0, mask, base, index), src0 is a passthru value
2011 // MaskedScatterSDNode (Chain, value, mask, base, index)
2012 // Mask is a vector of i1 elements
2013 const SDValue &getBasePtr() const { return getOperand(3); }
2014 const SDValue &getIndex() const { return getOperand(4); }
2015 const SDValue &getMask() const { return getOperand(2); }
2016 const SDValue &getValue() const { return getOperand(1); }
2018 static bool classof(const SDNode *N) {
2019 return N->getOpcode() == ISD::MGATHER ||
2020 N->getOpcode() == ISD::MSCATTER;
2024 /// This class is used to represent an MGATHER node
2026 class MaskedGatherSDNode : public MaskedGatherScatterSDNode {
2028 friend class SelectionDAG;
2029 MaskedGatherSDNode(unsigned Order, DebugLoc dl, ArrayRef<SDValue> Operands,
2030 SDVTList VTs, EVT MemVT, MachineMemOperand *MMO)
2031 : MaskedGatherScatterSDNode(ISD::MGATHER, Order, dl, Operands, VTs, MemVT,
2033 assert(getValue().getValueType() == getValueType(0) &&
2034 "Incompatible type of the PathThru value in MaskedGatherSDNode");
2035 assert(getMask().getValueType().getVectorNumElements() ==
2036 getValueType(0).getVectorNumElements() &&
2037 "Vector width mismatch between mask and data");
2038 assert(getMask().getValueType().getScalarType() == MVT::i1 &&
2039 "Vector width mismatch between mask and data");
2042 static bool classof(const SDNode *N) {
2043 return N->getOpcode() == ISD::MGATHER;
2047 /// This class is used to represent an MSCATTER node
2049 class MaskedScatterSDNode : public MaskedGatherScatterSDNode {
2052 friend class SelectionDAG;
2053 MaskedScatterSDNode(unsigned Order, DebugLoc dl,ArrayRef<SDValue> Operands,
2054 SDVTList VTs, EVT MemVT, MachineMemOperand *MMO)
2055 : MaskedGatherScatterSDNode(ISD::MSCATTER, Order, dl, Operands, VTs, MemVT,
2057 assert(getMask().getValueType().getVectorNumElements() ==
2058 getValue().getValueType().getVectorNumElements() &&
2059 "Vector width mismatch between mask and data");
2060 assert(getMask().getValueType().getScalarType() == MVT::i1 &&
2061 "Vector width mismatch between mask and data");
2064 static bool classof(const SDNode *N) {
2065 return N->getOpcode() == ISD::MSCATTER;
2069 /// An SDNode that represents everything that will be needed
2070 /// to construct a MachineInstr. These nodes are created during the
2071 /// instruction selection proper phase.
2072 class MachineSDNode : public SDNode {
2074 typedef MachineMemOperand **mmo_iterator;
2077 friend class SelectionDAG;
2078 MachineSDNode(unsigned Opc, unsigned Order, const DebugLoc DL, SDVTList VTs)
2079 : SDNode(Opc, Order, DL, VTs), MemRefs(nullptr), MemRefsEnd(nullptr) {}
2081 /// Operands for this instruction, if they fit here. If
2082 /// they don't, this field is unused.
2083 SDUse LocalOperands[4];
2085 /// Memory reference descriptions for this instruction.
2086 mmo_iterator MemRefs;
2087 mmo_iterator MemRefsEnd;
2090 mmo_iterator memoperands_begin() const { return MemRefs; }
2091 mmo_iterator memoperands_end() const { return MemRefsEnd; }
2092 bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
2094 /// Assign this MachineSDNodes's memory reference descriptor
2095 /// list. This does not transfer ownership.
2096 void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
2097 for (mmo_iterator MMI = NewMemRefs, MME = NewMemRefsEnd; MMI != MME; ++MMI)
2098 assert(*MMI && "Null mem ref detected!");
2099 MemRefs = NewMemRefs;
2100 MemRefsEnd = NewMemRefsEnd;
2103 static bool classof(const SDNode *N) {
2104 return N->isMachineOpcode();
2108 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
2109 SDNode, ptrdiff_t> {
2113 SDNodeIterator(const SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
2115 bool operator==(const SDNodeIterator& x) const {
2116 return Operand == x.Operand;
2118 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
2120 pointer operator*() const {
2121 return Node->getOperand(Operand).getNode();
2123 pointer operator->() const { return operator*(); }
2125 SDNodeIterator& operator++() { // Preincrement
2129 SDNodeIterator operator++(int) { // Postincrement
2130 SDNodeIterator tmp = *this; ++*this; return tmp;
2132 size_t operator-(SDNodeIterator Other) const {
2133 assert(Node == Other.Node &&
2134 "Cannot compare iterators of two different nodes!");
2135 return Operand - Other.Operand;
2138 static SDNodeIterator begin(const SDNode *N) { return SDNodeIterator(N, 0); }
2139 static SDNodeIterator end (const SDNode *N) {
2140 return SDNodeIterator(N, N->getNumOperands());
2143 unsigned getOperand() const { return Operand; }
2144 const SDNode *getNode() const { return Node; }
2147 template <> struct GraphTraits<SDNode*> {
2148 typedef SDNode NodeType;
2149 typedef SDNodeIterator ChildIteratorType;
2150 static inline NodeType *getEntryNode(SDNode *N) { return N; }
2151 static inline ChildIteratorType child_begin(NodeType *N) {
2152 return SDNodeIterator::begin(N);
2154 static inline ChildIteratorType child_end(NodeType *N) {
2155 return SDNodeIterator::end(N);
2159 /// The largest SDNode class.
2160 typedef MaskedGatherScatterSDNode LargestSDNode;
2162 /// The SDNode class with the greatest alignment requirement.
2163 typedef GlobalAddressSDNode MostAlignedSDNode;
2166 /// Returns true if the specified node is a non-extending and unindexed load.
2167 inline bool isNormalLoad(const SDNode *N) {
2168 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
2169 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
2170 Ld->getAddressingMode() == ISD::UNINDEXED;
2173 /// Returns true if the specified node is a non-extending load.
2174 inline bool isNON_EXTLoad(const SDNode *N) {
2175 return isa<LoadSDNode>(N) &&
2176 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
2179 /// Returns true if the specified node is a EXTLOAD.
2180 inline bool isEXTLoad(const SDNode *N) {
2181 return isa<LoadSDNode>(N) &&
2182 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
2185 /// Returns true if the specified node is a SEXTLOAD.
2186 inline bool isSEXTLoad(const SDNode *N) {
2187 return isa<LoadSDNode>(N) &&
2188 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
2191 /// Returns true if the specified node is a ZEXTLOAD.
2192 inline bool isZEXTLoad(const SDNode *N) {
2193 return isa<LoadSDNode>(N) &&
2194 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
2197 /// Returns true if the specified node is an unindexed load.
2198 inline bool isUNINDEXEDLoad(const SDNode *N) {
2199 return isa<LoadSDNode>(N) &&
2200 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2203 /// Returns true if the specified node is a non-truncating
2204 /// and unindexed store.
2205 inline bool isNormalStore(const SDNode *N) {
2206 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
2207 return St && !St->isTruncatingStore() &&
2208 St->getAddressingMode() == ISD::UNINDEXED;
2211 /// Returns true if the specified node is a non-truncating store.
2212 inline bool isNON_TRUNCStore(const SDNode *N) {
2213 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
2216 /// Returns true if the specified node is a truncating store.
2217 inline bool isTRUNCStore(const SDNode *N) {
2218 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
2221 /// Returns true if the specified node is an unindexed store.
2222 inline bool isUNINDEXEDStore(const SDNode *N) {
2223 return isa<StoreSDNode>(N) &&
2224 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2228 } // end llvm namespace