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/Constants.h"
23 #include "llvm/Instructions.h"
24 #include "llvm/ADT/FoldingSet.h"
25 #include "llvm/ADT/GraphTraits.h"
26 #include "llvm/ADT/ilist_node.h"
27 #include "llvm/ADT/SmallPtrSet.h"
28 #include "llvm/ADT/SmallVector.h"
29 #include "llvm/ADT/STLExtras.h"
30 #include "llvm/CodeGen/ISDOpcodes.h"
31 #include "llvm/CodeGen/ValueTypes.h"
32 #include "llvm/CodeGen/MachineMemOperand.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/DataTypes.h"
35 #include "llvm/Support/DebugLoc.h"
42 class MachineBasicBlock;
43 class MachineConstantPoolValue;
47 template <typename T> struct DenseMapInfo;
48 template <typename T> struct simplify_type;
49 template <typename T> struct ilist_traits;
51 void checkForCycles(const SDNode *N);
53 /// SDVTList - This represents a list of ValueType's that has been intern'd by
54 /// a SelectionDAG. Instances of this simple value class are returned by
55 /// SelectionDAG::getVTList(...).
65 /// isBuildVectorAllOnes - Return true if the specified node is a
66 /// BUILD_VECTOR where all of the elements are ~0 or undef.
67 bool isBuildVectorAllOnes(const SDNode *N);
69 /// isBuildVectorAllZeros - Return true if the specified node is a
70 /// BUILD_VECTOR where all of the elements are 0 or undef.
71 bool isBuildVectorAllZeros(const SDNode *N);
73 /// isScalarToVector - Return true if the specified node is a
74 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
75 /// element is not an undef.
76 bool isScalarToVector(const SDNode *N);
78 /// allOperandsUndef - Return true if the node has at least one operand
79 /// and all operands of the specified node are ISD::UNDEF.
80 bool allOperandsUndef(const SDNode *N);
81 } // end llvm:ISD namespace
83 //===----------------------------------------------------------------------===//
84 /// SDValue - Unlike LLVM values, Selection DAG nodes may return multiple
85 /// values as the result of a computation. Many nodes return multiple values,
86 /// from loads (which define a token and a return value) to ADDC (which returns
87 /// a result and a carry value), to calls (which may return an arbitrary number
90 /// As such, each use of a SelectionDAG computation must indicate the node that
91 /// computes it as well as which return value to use from that node. This pair
92 /// of information is represented with the SDValue value type.
95 SDNode *Node; // The node defining the value we are using.
96 unsigned ResNo; // Which return value of the node we are using.
98 SDValue() : Node(0), ResNo(0) {}
99 SDValue(SDNode *node, unsigned resno) : Node(node), ResNo(resno) {}
101 /// get the index which selects a specific result in the SDNode
102 unsigned getResNo() const { return ResNo; }
104 /// get the SDNode which holds the desired result
105 SDNode *getNode() const { return Node; }
108 void setNode(SDNode *N) { Node = N; }
110 inline SDNode *operator->() const { return Node; }
112 bool operator==(const SDValue &O) const {
113 return Node == O.Node && ResNo == O.ResNo;
115 bool operator!=(const SDValue &O) const {
116 return !operator==(O);
118 bool operator<(const SDValue &O) const {
119 return Node < O.Node || (Node == O.Node && ResNo < O.ResNo);
122 SDValue getValue(unsigned R) const {
123 return SDValue(Node, R);
126 // isOperandOf - Return true if this node is an operand of N.
127 bool isOperandOf(SDNode *N) const;
129 /// getValueType - Return the ValueType of the referenced return value.
131 inline EVT getValueType() const;
133 /// getValueSizeInBits - Returns the size of the value in bits.
135 unsigned getValueSizeInBits() const {
136 return getValueType().getSizeInBits();
139 // Forwarding methods - These forward to the corresponding methods in SDNode.
140 inline unsigned getOpcode() const;
141 inline unsigned getNumOperands() const;
142 inline const SDValue &getOperand(unsigned i) const;
143 inline uint64_t getConstantOperandVal(unsigned i) const;
144 inline bool isTargetMemoryOpcode() const;
145 inline bool isTargetOpcode() const;
146 inline bool isMachineOpcode() const;
147 inline unsigned getMachineOpcode() const;
148 inline const DebugLoc getDebugLoc() const;
149 inline void dump() const;
150 inline void dumpr() const;
152 /// reachesChainWithoutSideEffects - Return true if this operand (which must
153 /// be a chain) reaches the specified operand without crossing any
154 /// side-effecting instructions. In practice, this looks through token
155 /// factors and non-volatile loads. In order to remain efficient, this only
156 /// looks a couple of nodes in, it does not do an exhaustive search.
157 bool reachesChainWithoutSideEffects(SDValue Dest,
158 unsigned Depth = 2) const;
160 /// use_empty - Return true if there are no nodes using value ResNo
163 inline bool use_empty() const;
165 /// hasOneUse - Return true if there is exactly one node using value
168 inline bool hasOneUse() const;
172 template<> struct DenseMapInfo<SDValue> {
173 static inline SDValue getEmptyKey() {
174 return SDValue((SDNode*)-1, -1U);
176 static inline SDValue getTombstoneKey() {
177 return SDValue((SDNode*)-1, 0);
179 static unsigned getHashValue(const SDValue &Val) {
180 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
181 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
183 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
187 template <> struct isPodLike<SDValue> { static const bool value = true; };
190 /// simplify_type specializations - Allow casting operators to work directly on
191 /// SDValues as if they were SDNode*'s.
192 template<> struct simplify_type<SDValue> {
193 typedef SDNode* SimpleType;
194 static SimpleType getSimplifiedValue(const SDValue &Val) {
195 return static_cast<SimpleType>(Val.getNode());
198 template<> struct simplify_type<const SDValue> {
199 typedef SDNode* SimpleType;
200 static SimpleType getSimplifiedValue(const SDValue &Val) {
201 return static_cast<SimpleType>(Val.getNode());
205 /// SDUse - Represents a use of a SDNode. This class holds an SDValue,
206 /// which records the SDNode being used and the result number, a
207 /// pointer to the SDNode using the value, and Next and Prev pointers,
208 /// which link together all the uses of an SDNode.
211 /// Val - The value being used.
213 /// User - The user of this value.
215 /// Prev, Next - Pointers to the uses list of the SDNode referred by
219 SDUse(const SDUse &U) LLVM_DELETED_FUNCTION;
220 void operator=(const SDUse &U) LLVM_DELETED_FUNCTION;
223 SDUse() : Val(), User(NULL), Prev(NULL), Next(NULL) {}
225 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
226 operator const SDValue&() const { return Val; }
228 /// If implicit conversion to SDValue doesn't work, the get() method returns
230 const SDValue &get() const { return Val; }
232 /// getUser - This returns the SDNode that contains this Use.
233 SDNode *getUser() { return User; }
235 /// getNext - Get the next SDUse in the use list.
236 SDUse *getNext() const { return Next; }
238 /// getNode - Convenience function for get().getNode().
239 SDNode *getNode() const { return Val.getNode(); }
240 /// getResNo - Convenience function for get().getResNo().
241 unsigned getResNo() const { return Val.getResNo(); }
242 /// getValueType - Convenience function for get().getValueType().
243 EVT getValueType() const { return Val.getValueType(); }
245 /// operator== - Convenience function for get().operator==
246 bool operator==(const SDValue &V) const {
250 /// operator!= - Convenience function for get().operator!=
251 bool operator!=(const SDValue &V) const {
255 /// operator< - Convenience function for get().operator<
256 bool operator<(const SDValue &V) const {
261 friend class SelectionDAG;
264 void setUser(SDNode *p) { User = p; }
266 /// set - Remove this use from its existing use list, assign it the
267 /// given value, and add it to the new value's node's use list.
268 inline void set(const SDValue &V);
269 /// setInitial - like set, but only supports initializing a newly-allocated
270 /// SDUse with a non-null value.
271 inline void setInitial(const SDValue &V);
272 /// setNode - like set, but only sets the Node portion of the value,
273 /// leaving the ResNo portion unmodified.
274 inline void setNode(SDNode *N);
276 void addToList(SDUse **List) {
278 if (Next) Next->Prev = &Next;
283 void removeFromList() {
285 if (Next) Next->Prev = Prev;
289 /// simplify_type specializations - Allow casting operators to work directly on
290 /// SDValues as if they were SDNode*'s.
291 template<> struct simplify_type<SDUse> {
292 typedef SDNode* SimpleType;
293 static SimpleType getSimplifiedValue(const SDUse &Val) {
294 return static_cast<SimpleType>(Val.getNode());
297 template<> struct simplify_type<const SDUse> {
298 typedef SDNode* SimpleType;
299 static SimpleType getSimplifiedValue(const SDUse &Val) {
300 return static_cast<SimpleType>(Val.getNode());
305 /// SDNode - Represents one node in the SelectionDAG.
307 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
309 /// NodeType - The operation that this node performs.
313 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
314 /// then they will be delete[]'d when the node is destroyed.
315 uint16_t OperandsNeedDelete : 1;
317 /// HasDebugValue - This tracks whether this node has one or more dbg_value
318 /// nodes corresponding to it.
319 uint16_t HasDebugValue : 1;
322 /// SubclassData - This member is defined by this class, but is not used for
323 /// anything. Subclasses can use it to hold whatever state they find useful.
324 /// This field is initialized to zero by the ctor.
325 uint16_t SubclassData : 14;
328 /// NodeId - Unique id per SDNode in the DAG.
331 /// OperandList - The values that are used by this operation.
335 /// ValueList - The types of the values this node defines. SDNode's may
336 /// define multiple values simultaneously.
337 const EVT *ValueList;
339 /// UseList - List of uses for this SDNode.
342 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
343 unsigned short NumOperands, NumValues;
345 /// debugLoc - source line information.
348 /// getValueTypeList - Return a pointer to the specified value type.
349 static const EVT *getValueTypeList(EVT VT);
351 friend class SelectionDAG;
352 friend struct ilist_traits<SDNode>;
355 //===--------------------------------------------------------------------===//
359 /// getOpcode - Return the SelectionDAG opcode value for this node. For
360 /// pre-isel nodes (those for which isMachineOpcode returns false), these
361 /// are the opcode values in the ISD and <target>ISD namespaces. For
362 /// post-isel opcodes, see getMachineOpcode.
363 unsigned getOpcode() const { return (unsigned short)NodeType; }
365 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
366 /// \<target\>ISD namespace).
367 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
369 /// isTargetMemoryOpcode - Test if this node has a target-specific
370 /// memory-referencing opcode (in the \<target\>ISD namespace and
371 /// greater than FIRST_TARGET_MEMORY_OPCODE).
372 bool isTargetMemoryOpcode() const {
373 return NodeType >= ISD::FIRST_TARGET_MEMORY_OPCODE;
376 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
377 /// corresponding to a MachineInstr opcode.
378 bool isMachineOpcode() const { return NodeType < 0; }
380 /// getMachineOpcode - This may only be called if isMachineOpcode returns
381 /// true. It returns the MachineInstr opcode value that the node's opcode
383 unsigned getMachineOpcode() const {
384 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
388 /// getHasDebugValue - get this bit.
389 bool getHasDebugValue() const { return HasDebugValue; }
391 /// setHasDebugValue - set this bit.
392 void setHasDebugValue(bool b) { HasDebugValue = b; }
394 /// use_empty - Return true if there are no uses of this node.
396 bool use_empty() const { return UseList == NULL; }
398 /// hasOneUse - Return true if there is exactly one use of this node.
400 bool hasOneUse() const {
401 return !use_empty() && llvm::next(use_begin()) == use_end();
404 /// use_size - Return the number of uses of this node. This method takes
405 /// time proportional to the number of uses.
407 size_t use_size() const { return std::distance(use_begin(), use_end()); }
409 /// getNodeId - Return the unique node id.
411 int getNodeId() const { return NodeId; }
413 /// setNodeId - Set unique node id.
414 void setNodeId(int Id) { NodeId = Id; }
416 /// getDebugLoc - Return the source location info.
417 const DebugLoc getDebugLoc() const { return debugLoc; }
419 /// setDebugLoc - Set source location info. Try to avoid this, putting
420 /// it in the constructor is preferable.
421 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
423 /// use_iterator - This class provides iterator support for SDUse
424 /// operands that use a specific SDNode.
426 : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
428 explicit use_iterator(SDUse *op) : Op(op) {
432 typedef std::iterator<std::forward_iterator_tag,
433 SDUse, ptrdiff_t>::reference reference;
434 typedef std::iterator<std::forward_iterator_tag,
435 SDUse, ptrdiff_t>::pointer pointer;
437 use_iterator(const use_iterator &I) : Op(I.Op) {}
438 use_iterator() : Op(0) {}
440 bool operator==(const use_iterator &x) const {
443 bool operator!=(const use_iterator &x) const {
444 return !operator==(x);
447 /// atEnd - return true if this iterator is at the end of uses list.
448 bool atEnd() const { return Op == 0; }
450 // Iterator traversal: forward iteration only.
451 use_iterator &operator++() { // Preincrement
452 assert(Op && "Cannot increment end iterator!");
457 use_iterator operator++(int) { // Postincrement
458 use_iterator tmp = *this; ++*this; return tmp;
461 /// Retrieve a pointer to the current user node.
462 SDNode *operator*() const {
463 assert(Op && "Cannot dereference end iterator!");
464 return Op->getUser();
467 SDNode *operator->() const { return operator*(); }
469 SDUse &getUse() const { return *Op; }
471 /// getOperandNo - Retrieve the operand # of this use in its user.
473 unsigned getOperandNo() const {
474 assert(Op && "Cannot dereference end iterator!");
475 return (unsigned)(Op - Op->getUser()->OperandList);
479 /// use_begin/use_end - Provide iteration support to walk over all uses
482 use_iterator use_begin() const {
483 return use_iterator(UseList);
486 static use_iterator use_end() { return use_iterator(0); }
489 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
490 /// indicated value. This method ignores uses of other values defined by this
492 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
494 /// hasAnyUseOfValue - Return true if there are any use of the indicated
495 /// value. This method ignores uses of other values defined by this operation.
496 bool hasAnyUseOfValue(unsigned Value) const;
498 /// isOnlyUserOf - Return true if this node is the only use of N.
500 bool isOnlyUserOf(SDNode *N) const;
502 /// isOperandOf - Return true if this node is an operand of N.
504 bool isOperandOf(SDNode *N) const;
506 /// isPredecessorOf - Return true if this node is a predecessor of N.
507 /// NOTE: Implemented on top of hasPredecessor and every bit as
508 /// expensive. Use carefully.
509 bool isPredecessorOf(const SDNode *N) const { return N->hasPredecessor(this); }
511 /// hasPredecessor - Return true if N is a predecessor of this node.
512 /// N is either an operand of this node, or can be reached by recursively
513 /// traversing up the operands.
514 /// NOTE: This is an expensive method. Use it carefully.
515 bool hasPredecessor(const SDNode *N) const;
517 /// hasPredecesorHelper - Return true if N is a predecessor of this node.
518 /// N is either an operand of this node, or can be reached by recursively
519 /// traversing up the operands.
520 /// In this helper the Visited and worklist sets are held externally to
521 /// cache predecessors over multiple invocations. If you want to test for
522 /// multiple predecessors this method is preferable to multiple calls to
523 /// hasPredecessor. Be sure to clear Visited and Worklist if the DAG
525 /// NOTE: This is still very expensive. Use carefully.
526 bool hasPredecessorHelper(const SDNode *N,
527 SmallPtrSet<const SDNode *, 32> &Visited,
528 SmallVector<const SDNode *, 16> &Worklist) const;
530 /// getNumOperands - Return the number of values used by this operation.
532 unsigned getNumOperands() const { return NumOperands; }
534 /// getConstantOperandVal - Helper method returns the integer value of a
535 /// ConstantSDNode operand.
536 uint64_t getConstantOperandVal(unsigned Num) const;
538 const SDValue &getOperand(unsigned Num) const {
539 assert(Num < NumOperands && "Invalid child # of SDNode!");
540 return OperandList[Num];
543 typedef SDUse* op_iterator;
544 op_iterator op_begin() const { return OperandList; }
545 op_iterator op_end() const { return OperandList+NumOperands; }
547 SDVTList getVTList() const {
548 SDVTList X = { ValueList, NumValues };
552 /// getGluedNode - If this node has a glue operand, return the node
553 /// to which the glue operand points. Otherwise return NULL.
554 SDNode *getGluedNode() const {
555 if (getNumOperands() != 0 &&
556 getOperand(getNumOperands()-1).getValueType() == MVT::Glue)
557 return getOperand(getNumOperands()-1).getNode();
561 // If this is a pseudo op, like copyfromreg, look to see if there is a
562 // real target node glued to it. If so, return the target node.
563 const SDNode *getGluedMachineNode() const {
564 const SDNode *FoundNode = this;
566 // Climb up glue edges until a machine-opcode node is found, or the
567 // end of the chain is reached.
568 while (!FoundNode->isMachineOpcode()) {
569 const SDNode *N = FoundNode->getGluedNode();
577 /// getGluedUser - If this node has a glue value with a user, return
578 /// the user (there is at most one). Otherwise return NULL.
579 SDNode *getGluedUser() const {
580 for (use_iterator UI = use_begin(), UE = use_end(); UI != UE; ++UI)
581 if (UI.getUse().get().getValueType() == MVT::Glue)
586 /// getNumValues - Return the number of values defined/returned by this
589 unsigned getNumValues() const { return NumValues; }
591 /// getValueType - Return the type of a specified result.
593 EVT getValueType(unsigned ResNo) const {
594 assert(ResNo < NumValues && "Illegal result number!");
595 return ValueList[ResNo];
598 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
600 unsigned getValueSizeInBits(unsigned ResNo) const {
601 return getValueType(ResNo).getSizeInBits();
604 typedef const EVT* value_iterator;
605 value_iterator value_begin() const { return ValueList; }
606 value_iterator value_end() const { return ValueList+NumValues; }
608 /// getOperationName - Return the opcode of this operation for printing.
610 std::string getOperationName(const SelectionDAG *G = 0) const;
611 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
612 void print_types(raw_ostream &OS, const SelectionDAG *G) const;
613 void print_details(raw_ostream &OS, const SelectionDAG *G) const;
614 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
615 void printr(raw_ostream &OS, const SelectionDAG *G = 0) const;
617 /// printrFull - Print a SelectionDAG node and all children down to
618 /// the leaves. The given SelectionDAG allows target-specific nodes
619 /// to be printed in human-readable form. Unlike printr, this will
620 /// print the whole DAG, including children that appear multiple
623 void printrFull(raw_ostream &O, const SelectionDAG *G = 0) const;
625 /// printrWithDepth - Print a SelectionDAG node and children up to
626 /// depth "depth." The given SelectionDAG allows target-specific
627 /// nodes to be printed in human-readable form. Unlike printr, this
628 /// will print children that appear multiple times wherever they are
631 void printrWithDepth(raw_ostream &O, const SelectionDAG *G = 0,
632 unsigned depth = 100) const;
635 /// dump - Dump this node, for debugging.
638 /// dumpr - Dump (recursively) this node and its use-def subgraph.
641 /// dump - Dump this node, for debugging.
642 /// The given SelectionDAG allows target-specific nodes to be printed
643 /// in human-readable form.
644 void dump(const SelectionDAG *G) const;
646 /// dumpr - Dump (recursively) this node and its use-def subgraph.
647 /// The given SelectionDAG allows target-specific nodes to be printed
648 /// in human-readable form.
649 void dumpr(const SelectionDAG *G) const;
651 /// dumprFull - printrFull to dbgs(). The given SelectionDAG allows
652 /// target-specific nodes to be printed in human-readable form.
653 /// Unlike dumpr, this will print the whole DAG, including children
654 /// that appear multiple times.
656 void dumprFull(const SelectionDAG *G = 0) const;
658 /// dumprWithDepth - printrWithDepth to dbgs(). The given
659 /// SelectionDAG allows target-specific nodes to be printed in
660 /// human-readable form. Unlike dumpr, this will print children
661 /// that appear multiple times wherever they are used.
663 void dumprWithDepth(const SelectionDAG *G = 0, unsigned depth = 100) const;
666 static bool classof(const SDNode *) { return true; }
668 /// Profile - Gather unique data for the node.
670 void Profile(FoldingSetNodeID &ID) const;
672 /// addUse - This method should only be used by the SDUse class.
674 void addUse(SDUse &U) { U.addToList(&UseList); }
677 static SDVTList getSDVTList(EVT VT) {
678 SDVTList Ret = { getValueTypeList(VT), 1 };
682 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs, const SDValue *Ops,
684 : NodeType(Opc), OperandsNeedDelete(true), HasDebugValue(false),
685 SubclassData(0), NodeId(-1),
686 OperandList(NumOps ? new SDUse[NumOps] : 0),
687 ValueList(VTs.VTs), UseList(NULL),
688 NumOperands(NumOps), NumValues(VTs.NumVTs),
690 for (unsigned i = 0; i != NumOps; ++i) {
691 OperandList[i].setUser(this);
692 OperandList[i].setInitial(Ops[i]);
694 checkForCycles(this);
697 /// This constructor adds no operands itself; operands can be
698 /// set later with InitOperands.
699 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs)
700 : NodeType(Opc), OperandsNeedDelete(false), HasDebugValue(false),
701 SubclassData(0), NodeId(-1), OperandList(0), ValueList(VTs.VTs),
702 UseList(NULL), NumOperands(0), NumValues(VTs.NumVTs),
705 /// InitOperands - Initialize the operands list of this with 1 operand.
706 void InitOperands(SDUse *Ops, const SDValue &Op0) {
707 Ops[0].setUser(this);
708 Ops[0].setInitial(Op0);
711 checkForCycles(this);
714 /// InitOperands - Initialize the operands list of this with 2 operands.
715 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
716 Ops[0].setUser(this);
717 Ops[0].setInitial(Op0);
718 Ops[1].setUser(this);
719 Ops[1].setInitial(Op1);
722 checkForCycles(this);
725 /// InitOperands - Initialize the operands list of this with 3 operands.
726 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
727 const SDValue &Op2) {
728 Ops[0].setUser(this);
729 Ops[0].setInitial(Op0);
730 Ops[1].setUser(this);
731 Ops[1].setInitial(Op1);
732 Ops[2].setUser(this);
733 Ops[2].setInitial(Op2);
736 checkForCycles(this);
739 /// InitOperands - Initialize the operands list of this with 4 operands.
740 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
741 const SDValue &Op2, const SDValue &Op3) {
742 Ops[0].setUser(this);
743 Ops[0].setInitial(Op0);
744 Ops[1].setUser(this);
745 Ops[1].setInitial(Op1);
746 Ops[2].setUser(this);
747 Ops[2].setInitial(Op2);
748 Ops[3].setUser(this);
749 Ops[3].setInitial(Op3);
752 checkForCycles(this);
755 /// InitOperands - Initialize the operands list of this with N operands.
756 void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
757 for (unsigned i = 0; i != N; ++i) {
758 Ops[i].setUser(this);
759 Ops[i].setInitial(Vals[i]);
763 checkForCycles(this);
766 /// DropOperands - Release the operands and set this node to have
772 // Define inline functions from the SDValue class.
774 inline unsigned SDValue::getOpcode() const {
775 return Node->getOpcode();
777 inline EVT SDValue::getValueType() const {
778 return Node->getValueType(ResNo);
780 inline unsigned SDValue::getNumOperands() const {
781 return Node->getNumOperands();
783 inline const SDValue &SDValue::getOperand(unsigned i) const {
784 return Node->getOperand(i);
786 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
787 return Node->getConstantOperandVal(i);
789 inline bool SDValue::isTargetOpcode() const {
790 return Node->isTargetOpcode();
792 inline bool SDValue::isTargetMemoryOpcode() const {
793 return Node->isTargetMemoryOpcode();
795 inline bool SDValue::isMachineOpcode() const {
796 return Node->isMachineOpcode();
798 inline unsigned SDValue::getMachineOpcode() const {
799 return Node->getMachineOpcode();
801 inline bool SDValue::use_empty() const {
802 return !Node->hasAnyUseOfValue(ResNo);
804 inline bool SDValue::hasOneUse() const {
805 return Node->hasNUsesOfValue(1, ResNo);
807 inline const DebugLoc SDValue::getDebugLoc() const {
808 return Node->getDebugLoc();
810 inline void SDValue::dump() const {
813 inline void SDValue::dumpr() const {
814 return Node->dumpr();
816 // Define inline functions from the SDUse class.
818 inline void SDUse::set(const SDValue &V) {
819 if (Val.getNode()) removeFromList();
821 if (V.getNode()) V.getNode()->addUse(*this);
824 inline void SDUse::setInitial(const SDValue &V) {
826 V.getNode()->addUse(*this);
829 inline void SDUse::setNode(SDNode *N) {
830 if (Val.getNode()) removeFromList();
832 if (N) N->addUse(*this);
835 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
836 /// to allow co-allocation of node operands with the node itself.
837 class UnarySDNode : public SDNode {
840 UnarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X)
841 : SDNode(Opc, dl, VTs) {
842 InitOperands(&Op, X);
846 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
847 /// to allow co-allocation of node operands with the node itself.
848 class BinarySDNode : public SDNode {
851 BinarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y)
852 : SDNode(Opc, dl, VTs) {
853 InitOperands(Ops, X, Y);
857 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
858 /// to allow co-allocation of node operands with the node itself.
859 class TernarySDNode : public SDNode {
862 TernarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y,
864 : SDNode(Opc, dl, VTs) {
865 InitOperands(Ops, X, Y, Z);
870 /// HandleSDNode - This class is used to form a handle around another node that
871 /// is persistent and is updated across invocations of replaceAllUsesWith on its
872 /// operand. This node should be directly created by end-users and not added to
873 /// the AllNodes list.
874 class HandleSDNode : public SDNode {
877 // FIXME: Remove the "noinline" attribute once <rdar://problem/5852746> is
879 #if __GNUC__==4 && __GNUC_MINOR__==2 && defined(__APPLE__) && !defined(__llvm__)
880 explicit __attribute__((__noinline__)) HandleSDNode(SDValue X)
882 explicit HandleSDNode(SDValue X)
884 : SDNode(ISD::HANDLENODE, DebugLoc(), getSDVTList(MVT::Other)) {
885 InitOperands(&Op, X);
888 const SDValue &getValue() const { return Op; }
891 /// Abstact virtual class for operations for memory operations
892 class MemSDNode : public SDNode {
894 // MemoryVT - VT of in-memory value.
898 /// MMO - Memory reference information.
899 MachineMemOperand *MMO;
902 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, EVT MemoryVT,
903 MachineMemOperand *MMO);
905 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, const SDValue *Ops,
906 unsigned NumOps, EVT MemoryVT, MachineMemOperand *MMO);
908 bool readMem() const { return MMO->isLoad(); }
909 bool writeMem() const { return MMO->isStore(); }
911 /// Returns alignment and volatility of the memory access
912 unsigned getOriginalAlignment() const {
913 return MMO->getBaseAlignment();
915 unsigned getAlignment() const {
916 return MMO->getAlignment();
919 /// getRawSubclassData - Return the SubclassData value, which contains an
920 /// encoding of the volatile flag, as well as bits used by subclasses. This
921 /// function should only be used to compute a FoldingSetNodeID value.
922 unsigned getRawSubclassData() const {
926 // We access subclass data here so that we can check consistency
927 // with MachineMemOperand information.
928 bool isVolatile() const { return (SubclassData >> 5) & 1; }
929 bool isNonTemporal() const { return (SubclassData >> 6) & 1; }
930 bool isInvariant() const { return (SubclassData >> 7) & 1; }
932 AtomicOrdering getOrdering() const {
933 return AtomicOrdering((SubclassData >> 8) & 15);
935 SynchronizationScope getSynchScope() const {
936 return SynchronizationScope((SubclassData >> 12) & 1);
939 /// Returns the SrcValue and offset that describes the location of the access
940 const Value *getSrcValue() const { return MMO->getValue(); }
941 int64_t getSrcValueOffset() const { return MMO->getOffset(); }
943 /// Returns the TBAAInfo that describes the dereference.
944 const MDNode *getTBAAInfo() const { return MMO->getTBAAInfo(); }
946 /// Returns the Ranges that describes the dereference.
947 const MDNode *getRanges() const { return MMO->getRanges(); }
949 /// getMemoryVT - Return the type of the in-memory value.
950 EVT getMemoryVT() const { return MemoryVT; }
952 /// getMemOperand - Return a MachineMemOperand object describing the memory
953 /// reference performed by operation.
954 MachineMemOperand *getMemOperand() const { return MMO; }
956 const MachinePointerInfo &getPointerInfo() const {
957 return MMO->getPointerInfo();
960 /// refineAlignment - Update this MemSDNode's MachineMemOperand information
961 /// to reflect the alignment of NewMMO, if it has a greater alignment.
962 /// This must only be used when the new alignment applies to all users of
963 /// this MachineMemOperand.
964 void refineAlignment(const MachineMemOperand *NewMMO) {
965 MMO->refineAlignment(NewMMO);
968 const SDValue &getChain() const { return getOperand(0); }
969 const SDValue &getBasePtr() const {
970 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
973 // Methods to support isa and dyn_cast
974 static bool classof(const MemSDNode *) { return true; }
975 static bool classof(const SDNode *N) {
976 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
977 // with either an intrinsic or a target opcode.
978 return N->getOpcode() == ISD::LOAD ||
979 N->getOpcode() == ISD::STORE ||
980 N->getOpcode() == ISD::PREFETCH ||
981 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
982 N->getOpcode() == ISD::ATOMIC_SWAP ||
983 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
984 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
985 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
986 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
987 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
988 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
989 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
990 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
991 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
992 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
993 N->getOpcode() == ISD::ATOMIC_LOAD ||
994 N->getOpcode() == ISD::ATOMIC_STORE ||
995 N->isTargetMemoryOpcode();
999 /// AtomicSDNode - A SDNode reprenting atomic operations.
1001 class AtomicSDNode : public MemSDNode {
1004 void InitAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope) {
1005 // This must match encodeMemSDNodeFlags() in SelectionDAG.cpp.
1006 assert((Ordering & 15) == Ordering &&
1007 "Ordering may not require more than 4 bits!");
1008 assert((SynchScope & 1) == SynchScope &&
1009 "SynchScope may not require more than 1 bit!");
1010 SubclassData |= Ordering << 8;
1011 SubclassData |= SynchScope << 12;
1012 assert(getOrdering() == Ordering && "Ordering encoding error!");
1013 assert(getSynchScope() == SynchScope && "Synch-scope encoding error!");
1017 // Opc: opcode for atomic
1018 // VTL: value type list
1019 // Chain: memory chain for operaand
1020 // Ptr: address to update as a SDValue
1021 // Cmp: compare value
1023 // SrcVal: address to update as a Value (used for MemOperand)
1024 // Align: alignment of memory
1025 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
1026 SDValue Chain, SDValue Ptr,
1027 SDValue Cmp, SDValue Swp, MachineMemOperand *MMO,
1028 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1029 : MemSDNode(Opc, dl, VTL, MemVT, MMO) {
1030 InitAtomic(Ordering, SynchScope);
1031 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1033 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
1034 SDValue Chain, SDValue Ptr,
1035 SDValue Val, MachineMemOperand *MMO,
1036 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1037 : MemSDNode(Opc, dl, VTL, MemVT, MMO) {
1038 InitAtomic(Ordering, SynchScope);
1039 InitOperands(Ops, Chain, Ptr, Val);
1041 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
1042 SDValue Chain, SDValue Ptr,
1043 MachineMemOperand *MMO,
1044 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1045 : MemSDNode(Opc, dl, VTL, MemVT, MMO) {
1046 InitAtomic(Ordering, SynchScope);
1047 InitOperands(Ops, Chain, Ptr);
1050 const SDValue &getBasePtr() const { return getOperand(1); }
1051 const SDValue &getVal() const { return getOperand(2); }
1053 bool isCompareAndSwap() const {
1054 unsigned Op = getOpcode();
1055 return Op == ISD::ATOMIC_CMP_SWAP;
1058 // Methods to support isa and dyn_cast
1059 static bool classof(const AtomicSDNode *) { return true; }
1060 static bool classof(const SDNode *N) {
1061 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1062 N->getOpcode() == ISD::ATOMIC_SWAP ||
1063 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1064 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1065 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1066 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1067 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1068 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1069 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1070 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1071 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1072 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1073 N->getOpcode() == ISD::ATOMIC_LOAD ||
1074 N->getOpcode() == ISD::ATOMIC_STORE;
1078 /// MemIntrinsicSDNode - This SDNode is used for target intrinsics that touch
1079 /// memory and need an associated MachineMemOperand. Its opcode may be
1080 /// INTRINSIC_VOID, INTRINSIC_W_CHAIN, PREFETCH, or a target-specific opcode
1081 /// with a value not less than FIRST_TARGET_MEMORY_OPCODE.
1082 class MemIntrinsicSDNode : public MemSDNode {
1084 MemIntrinsicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs,
1085 const SDValue *Ops, unsigned NumOps,
1086 EVT MemoryVT, MachineMemOperand *MMO)
1087 : MemSDNode(Opc, dl, VTs, Ops, NumOps, MemoryVT, MMO) {
1090 // Methods to support isa and dyn_cast
1091 static bool classof(const MemIntrinsicSDNode *) { return true; }
1092 static bool classof(const SDNode *N) {
1093 // We lower some target intrinsics to their target opcode
1094 // early a node with a target opcode can be of this class
1095 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1096 N->getOpcode() == ISD::INTRINSIC_VOID ||
1097 N->getOpcode() == ISD::PREFETCH ||
1098 N->isTargetMemoryOpcode();
1102 /// ShuffleVectorSDNode - This SDNode is used to implement the code generator
1103 /// support for the llvm IR shufflevector instruction. It combines elements
1104 /// from two input vectors into a new input vector, with the selection and
1105 /// ordering of elements determined by an array of integers, referred to as
1106 /// the shuffle mask. For input vectors of width N, mask indices of 0..N-1
1107 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1108 /// An index of -1 is treated as undef, such that the code generator may put
1109 /// any value in the corresponding element of the result.
1110 class ShuffleVectorSDNode : public SDNode {
1113 // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1114 // is freed when the SelectionDAG object is destroyed.
1117 friend class SelectionDAG;
1118 ShuffleVectorSDNode(EVT VT, DebugLoc dl, SDValue N1, SDValue N2,
1120 : SDNode(ISD::VECTOR_SHUFFLE, dl, getSDVTList(VT)), Mask(M) {
1121 InitOperands(Ops, N1, N2);
1125 ArrayRef<int> getMask() const {
1126 EVT VT = getValueType(0);
1127 return makeArrayRef(Mask, VT.getVectorNumElements());
1129 int getMaskElt(unsigned Idx) const {
1130 assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1134 bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1135 int getSplatIndex() const {
1136 assert(isSplat() && "Cannot get splat index for non-splat!");
1137 EVT VT = getValueType(0);
1138 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i) {
1144 static bool isSplatMask(const int *Mask, EVT VT);
1146 static bool classof(const ShuffleVectorSDNode *) { return true; }
1147 static bool classof(const SDNode *N) {
1148 return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1152 class ConstantSDNode : public SDNode {
1153 const ConstantInt *Value;
1154 friend class SelectionDAG;
1155 ConstantSDNode(bool isTarget, const ConstantInt *val, EVT VT)
1156 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1157 DebugLoc(), getSDVTList(VT)), Value(val) {
1161 const ConstantInt *getConstantIntValue() const { return Value; }
1162 const APInt &getAPIntValue() const { return Value->getValue(); }
1163 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1164 int64_t getSExtValue() const { return Value->getSExtValue(); }
1166 bool isOne() const { return Value->isOne(); }
1167 bool isNullValue() const { return Value->isNullValue(); }
1168 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1170 static bool classof(const ConstantSDNode *) { return true; }
1171 static bool classof(const SDNode *N) {
1172 return N->getOpcode() == ISD::Constant ||
1173 N->getOpcode() == ISD::TargetConstant;
1177 class ConstantFPSDNode : public SDNode {
1178 const ConstantFP *Value;
1179 friend class SelectionDAG;
1180 ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1181 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1182 DebugLoc(), getSDVTList(VT)), Value(val) {
1186 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1187 const ConstantFP *getConstantFPValue() const { return Value; }
1189 /// isZero - Return true if the value is positive or negative zero.
1190 bool isZero() const { return Value->isZero(); }
1192 /// isNaN - Return true if the value is a NaN.
1193 bool isNaN() const { return Value->isNaN(); }
1195 /// isExactlyValue - We don't rely on operator== working on double values, as
1196 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1197 /// As such, this method can be used to do an exact bit-for-bit comparison of
1198 /// two floating point values.
1200 /// We leave the version with the double argument here because it's just so
1201 /// convenient to write "2.0" and the like. Without this function we'd
1202 /// have to duplicate its logic everywhere it's called.
1203 bool isExactlyValue(double V) const {
1205 // convert is not supported on this type
1206 if (&Value->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1209 Tmp.convert(Value->getValueAPF().getSemantics(),
1210 APFloat::rmNearestTiesToEven, &ignored);
1211 return isExactlyValue(Tmp);
1213 bool isExactlyValue(const APFloat& V) const;
1215 static bool isValueValidForType(EVT VT, const APFloat& Val);
1217 static bool classof(const ConstantFPSDNode *) { return true; }
1218 static bool classof(const SDNode *N) {
1219 return N->getOpcode() == ISD::ConstantFP ||
1220 N->getOpcode() == ISD::TargetConstantFP;
1224 class GlobalAddressSDNode : public SDNode {
1225 const GlobalValue *TheGlobal;
1227 unsigned char TargetFlags;
1228 friend class SelectionDAG;
1229 GlobalAddressSDNode(unsigned Opc, DebugLoc DL, const GlobalValue *GA, EVT VT,
1230 int64_t o, unsigned char TargetFlags);
1233 const GlobalValue *getGlobal() const { return TheGlobal; }
1234 int64_t getOffset() const { return Offset; }
1235 unsigned char getTargetFlags() const { return TargetFlags; }
1236 // Return the address space this GlobalAddress belongs to.
1237 unsigned getAddressSpace() const;
1239 static bool classof(const GlobalAddressSDNode *) { return true; }
1240 static bool classof(const SDNode *N) {
1241 return N->getOpcode() == ISD::GlobalAddress ||
1242 N->getOpcode() == ISD::TargetGlobalAddress ||
1243 N->getOpcode() == ISD::GlobalTLSAddress ||
1244 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1248 class FrameIndexSDNode : public SDNode {
1250 friend class SelectionDAG;
1251 FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1252 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1253 DebugLoc(), getSDVTList(VT)), FI(fi) {
1257 int getIndex() const { return FI; }
1259 static bool classof(const FrameIndexSDNode *) { return true; }
1260 static bool classof(const SDNode *N) {
1261 return N->getOpcode() == ISD::FrameIndex ||
1262 N->getOpcode() == ISD::TargetFrameIndex;
1266 class JumpTableSDNode : public SDNode {
1268 unsigned char TargetFlags;
1269 friend class SelectionDAG;
1270 JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1271 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1272 DebugLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1276 int getIndex() const { return JTI; }
1277 unsigned char getTargetFlags() const { return TargetFlags; }
1279 static bool classof(const JumpTableSDNode *) { return true; }
1280 static bool classof(const SDNode *N) {
1281 return N->getOpcode() == ISD::JumpTable ||
1282 N->getOpcode() == ISD::TargetJumpTable;
1286 class ConstantPoolSDNode : public SDNode {
1288 const Constant *ConstVal;
1289 MachineConstantPoolValue *MachineCPVal;
1291 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1292 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1293 unsigned char TargetFlags;
1294 friend class SelectionDAG;
1295 ConstantPoolSDNode(bool isTarget, const Constant *c, EVT VT, int o,
1296 unsigned Align, unsigned char TF)
1297 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1299 getSDVTList(VT)), Offset(o), Alignment(Align), TargetFlags(TF) {
1300 assert((int)Offset >= 0 && "Offset is too large");
1303 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1304 EVT VT, int o, unsigned Align, unsigned char TF)
1305 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1307 getSDVTList(VT)), Offset(o), Alignment(Align), TargetFlags(TF) {
1308 assert((int)Offset >= 0 && "Offset is too large");
1309 Val.MachineCPVal = v;
1310 Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1315 bool isMachineConstantPoolEntry() const {
1316 return (int)Offset < 0;
1319 const Constant *getConstVal() const {
1320 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1321 return Val.ConstVal;
1324 MachineConstantPoolValue *getMachineCPVal() const {
1325 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1326 return Val.MachineCPVal;
1329 int getOffset() const {
1330 return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1333 // Return the alignment of this constant pool object, which is either 0 (for
1334 // default alignment) or the desired value.
1335 unsigned getAlignment() const { return Alignment; }
1336 unsigned char getTargetFlags() const { return TargetFlags; }
1338 Type *getType() const;
1340 static bool classof(const ConstantPoolSDNode *) { return true; }
1341 static bool classof(const SDNode *N) {
1342 return N->getOpcode() == ISD::ConstantPool ||
1343 N->getOpcode() == ISD::TargetConstantPool;
1347 /// Completely target-dependent object reference.
1348 class TargetIndexSDNode : public SDNode {
1349 unsigned char TargetFlags;
1352 friend class SelectionDAG;
1355 TargetIndexSDNode(int Idx, EVT VT, int64_t Ofs, unsigned char TF)
1356 : SDNode(ISD::TargetIndex, DebugLoc(), getSDVTList(VT)),
1357 TargetFlags(TF), Index(Idx), Offset(Ofs) {}
1360 unsigned char getTargetFlags() const { return TargetFlags; }
1361 int getIndex() const { return Index; }
1362 int64_t getOffset() const { return Offset; }
1364 static bool classof(const TargetIndexSDNode*) { return true; }
1365 static bool classof(const SDNode *N) {
1366 return N->getOpcode() == ISD::TargetIndex;
1370 class BasicBlockSDNode : public SDNode {
1371 MachineBasicBlock *MBB;
1372 friend class SelectionDAG;
1373 /// Debug info is meaningful and potentially useful here, but we create
1374 /// blocks out of order when they're jumped to, which makes it a bit
1375 /// harder. Let's see if we need it first.
1376 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1377 : SDNode(ISD::BasicBlock, DebugLoc(), getSDVTList(MVT::Other)), MBB(mbb) {
1381 MachineBasicBlock *getBasicBlock() const { return MBB; }
1383 static bool classof(const BasicBlockSDNode *) { return true; }
1384 static bool classof(const SDNode *N) {
1385 return N->getOpcode() == ISD::BasicBlock;
1389 /// BuildVectorSDNode - A "pseudo-class" with methods for operating on
1391 class BuildVectorSDNode : public SDNode {
1392 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1393 explicit BuildVectorSDNode() LLVM_DELETED_FUNCTION;
1395 /// isConstantSplat - Check if this is a constant splat, and if so, find the
1396 /// smallest element size that splats the vector. If MinSplatBits is
1397 /// nonzero, the element size must be at least that large. Note that the
1398 /// splat element may be the entire vector (i.e., a one element vector).
1399 /// Returns the splat element value in SplatValue. Any undefined bits in
1400 /// that value are zero, and the corresponding bits in the SplatUndef mask
1401 /// are set. The SplatBitSize value is set to the splat element size in
1402 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1403 /// undefined. isBigEndian describes the endianness of the target.
1404 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1405 unsigned &SplatBitSize, bool &HasAnyUndefs,
1406 unsigned MinSplatBits = 0, bool isBigEndian = false);
1408 static inline bool classof(const BuildVectorSDNode *) { return true; }
1409 static inline bool classof(const SDNode *N) {
1410 return N->getOpcode() == ISD::BUILD_VECTOR;
1414 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1415 /// used when the SelectionDAG needs to make a simple reference to something
1416 /// in the LLVM IR representation.
1418 class SrcValueSDNode : public SDNode {
1420 friend class SelectionDAG;
1421 /// Create a SrcValue for a general value.
1422 explicit SrcValueSDNode(const Value *v)
1423 : SDNode(ISD::SRCVALUE, DebugLoc(), getSDVTList(MVT::Other)), V(v) {}
1426 /// getValue - return the contained Value.
1427 const Value *getValue() const { return V; }
1429 static bool classof(const SrcValueSDNode *) { return true; }
1430 static bool classof(const SDNode *N) {
1431 return N->getOpcode() == ISD::SRCVALUE;
1435 class MDNodeSDNode : public SDNode {
1437 friend class SelectionDAG;
1438 explicit MDNodeSDNode(const MDNode *md)
1439 : SDNode(ISD::MDNODE_SDNODE, DebugLoc(), getSDVTList(MVT::Other)), MD(md) {}
1442 const MDNode *getMD() const { return MD; }
1444 static bool classof(const MDNodeSDNode *) { return true; }
1445 static bool classof(const SDNode *N) {
1446 return N->getOpcode() == ISD::MDNODE_SDNODE;
1451 class RegisterSDNode : public SDNode {
1453 friend class SelectionDAG;
1454 RegisterSDNode(unsigned reg, EVT VT)
1455 : SDNode(ISD::Register, DebugLoc(), getSDVTList(VT)), Reg(reg) {
1459 unsigned getReg() const { return Reg; }
1461 static bool classof(const RegisterSDNode *) { return true; }
1462 static bool classof(const SDNode *N) {
1463 return N->getOpcode() == ISD::Register;
1467 class RegisterMaskSDNode : public SDNode {
1468 // The memory for RegMask is not owned by the node.
1469 const uint32_t *RegMask;
1470 friend class SelectionDAG;
1471 RegisterMaskSDNode(const uint32_t *mask)
1472 : SDNode(ISD::RegisterMask, DebugLoc(), getSDVTList(MVT::Untyped)),
1476 const uint32_t *getRegMask() const { return RegMask; }
1478 static bool classof(const RegisterMaskSDNode *) { return true; }
1479 static bool classof(const SDNode *N) {
1480 return N->getOpcode() == ISD::RegisterMask;
1484 class BlockAddressSDNode : public SDNode {
1485 const BlockAddress *BA;
1487 unsigned char TargetFlags;
1488 friend class SelectionDAG;
1489 BlockAddressSDNode(unsigned NodeTy, EVT VT, const BlockAddress *ba,
1490 int64_t o, unsigned char Flags)
1491 : SDNode(NodeTy, DebugLoc(), getSDVTList(VT)),
1492 BA(ba), Offset(o), TargetFlags(Flags) {
1495 const BlockAddress *getBlockAddress() const { return BA; }
1496 int64_t getOffset() const { return Offset; }
1497 unsigned char getTargetFlags() const { return TargetFlags; }
1499 static bool classof(const BlockAddressSDNode *) { return true; }
1500 static bool classof(const SDNode *N) {
1501 return N->getOpcode() == ISD::BlockAddress ||
1502 N->getOpcode() == ISD::TargetBlockAddress;
1506 class EHLabelSDNode : public SDNode {
1509 friend class SelectionDAG;
1510 EHLabelSDNode(DebugLoc dl, SDValue ch, MCSymbol *L)
1511 : SDNode(ISD::EH_LABEL, dl, getSDVTList(MVT::Other)), Label(L) {
1512 InitOperands(&Chain, ch);
1515 MCSymbol *getLabel() const { return Label; }
1517 static bool classof(const EHLabelSDNode *) { return true; }
1518 static bool classof(const SDNode *N) {
1519 return N->getOpcode() == ISD::EH_LABEL;
1523 class ExternalSymbolSDNode : public SDNode {
1525 unsigned char TargetFlags;
1527 friend class SelectionDAG;
1528 ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
1529 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1530 DebugLoc(), getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
1534 const char *getSymbol() const { return Symbol; }
1535 unsigned char getTargetFlags() const { return TargetFlags; }
1537 static bool classof(const ExternalSymbolSDNode *) { return true; }
1538 static bool classof(const SDNode *N) {
1539 return N->getOpcode() == ISD::ExternalSymbol ||
1540 N->getOpcode() == ISD::TargetExternalSymbol;
1544 class CondCodeSDNode : public SDNode {
1545 ISD::CondCode Condition;
1546 friend class SelectionDAG;
1547 explicit CondCodeSDNode(ISD::CondCode Cond)
1548 : SDNode(ISD::CONDCODE, DebugLoc(), getSDVTList(MVT::Other)),
1553 ISD::CondCode get() const { return Condition; }
1555 static bool classof(const CondCodeSDNode *) { return true; }
1556 static bool classof(const SDNode *N) {
1557 return N->getOpcode() == ISD::CONDCODE;
1561 /// CvtRndSatSDNode - NOTE: avoid using this node as this may disappear in the
1562 /// future and most targets don't support it.
1563 class CvtRndSatSDNode : public SDNode {
1564 ISD::CvtCode CvtCode;
1565 friend class SelectionDAG;
1566 explicit CvtRndSatSDNode(EVT VT, DebugLoc dl, const SDValue *Ops,
1567 unsigned NumOps, ISD::CvtCode Code)
1568 : SDNode(ISD::CONVERT_RNDSAT, dl, getSDVTList(VT), Ops, NumOps),
1570 assert(NumOps == 5 && "wrong number of operations");
1573 ISD::CvtCode getCvtCode() const { return CvtCode; }
1575 static bool classof(const CvtRndSatSDNode *) { return true; }
1576 static bool classof(const SDNode *N) {
1577 return N->getOpcode() == ISD::CONVERT_RNDSAT;
1581 /// VTSDNode - This class is used to represent EVT's, which are used
1582 /// to parameterize some operations.
1583 class VTSDNode : public SDNode {
1585 friend class SelectionDAG;
1586 explicit VTSDNode(EVT VT)
1587 : SDNode(ISD::VALUETYPE, DebugLoc(), getSDVTList(MVT::Other)),
1592 EVT getVT() const { return ValueType; }
1594 static bool classof(const VTSDNode *) { return true; }
1595 static bool classof(const SDNode *N) {
1596 return N->getOpcode() == ISD::VALUETYPE;
1600 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1602 class LSBaseSDNode : public MemSDNode {
1603 //! Operand array for load and store
1605 \note Moving this array to the base class captures more
1606 common functionality shared between LoadSDNode and
1611 LSBaseSDNode(ISD::NodeType NodeTy, DebugLoc dl, SDValue *Operands,
1612 unsigned numOperands, SDVTList VTs, ISD::MemIndexedMode AM,
1613 EVT MemVT, MachineMemOperand *MMO)
1614 : MemSDNode(NodeTy, dl, VTs, MemVT, MMO) {
1615 SubclassData |= AM << 2;
1616 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
1617 InitOperands(Ops, Operands, numOperands);
1618 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1619 "Only indexed loads and stores have a non-undef offset operand");
1622 const SDValue &getOffset() const {
1623 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1626 /// getAddressingMode - Return the addressing mode for this load or store:
1627 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
1628 ISD::MemIndexedMode getAddressingMode() const {
1629 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
1632 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1633 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
1635 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1636 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
1638 static bool classof(const LSBaseSDNode *) { return true; }
1639 static bool classof(const SDNode *N) {
1640 return N->getOpcode() == ISD::LOAD ||
1641 N->getOpcode() == ISD::STORE;
1645 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1647 class LoadSDNode : public LSBaseSDNode {
1648 friend class SelectionDAG;
1649 LoadSDNode(SDValue *ChainPtrOff, DebugLoc dl, SDVTList VTs,
1650 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT MemVT,
1651 MachineMemOperand *MMO)
1652 : LSBaseSDNode(ISD::LOAD, dl, ChainPtrOff, 3,
1653 VTs, AM, MemVT, MMO) {
1654 SubclassData |= (unsigned short)ETy;
1655 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
1656 assert(readMem() && "Load MachineMemOperand is not a load!");
1657 assert(!writeMem() && "Load MachineMemOperand is a store!");
1661 /// getExtensionType - Return whether this is a plain node,
1662 /// or one of the varieties of value-extending loads.
1663 ISD::LoadExtType getExtensionType() const {
1664 return ISD::LoadExtType(SubclassData & 3);
1667 const SDValue &getBasePtr() const { return getOperand(1); }
1668 const SDValue &getOffset() const { return getOperand(2); }
1670 static bool classof(const LoadSDNode *) { return true; }
1671 static bool classof(const SDNode *N) {
1672 return N->getOpcode() == ISD::LOAD;
1676 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
1678 class StoreSDNode : public LSBaseSDNode {
1679 friend class SelectionDAG;
1680 StoreSDNode(SDValue *ChainValuePtrOff, DebugLoc dl, SDVTList VTs,
1681 ISD::MemIndexedMode AM, bool isTrunc, EVT MemVT,
1682 MachineMemOperand *MMO)
1683 : LSBaseSDNode(ISD::STORE, dl, ChainValuePtrOff, 4,
1684 VTs, AM, MemVT, MMO) {
1685 SubclassData |= (unsigned short)isTrunc;
1686 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
1687 assert(!readMem() && "Store MachineMemOperand is a load!");
1688 assert(writeMem() && "Store MachineMemOperand is not a store!");
1692 /// isTruncatingStore - Return true if the op does a truncation before store.
1693 /// For integers this is the same as doing a TRUNCATE and storing the result.
1694 /// For floats, it is the same as doing an FP_ROUND and storing the result.
1695 bool isTruncatingStore() const { return SubclassData & 1; }
1697 const SDValue &getValue() const { return getOperand(1); }
1698 const SDValue &getBasePtr() const { return getOperand(2); }
1699 const SDValue &getOffset() const { return getOperand(3); }
1701 static bool classof(const StoreSDNode *) { return true; }
1702 static bool classof(const SDNode *N) {
1703 return N->getOpcode() == ISD::STORE;
1707 /// MachineSDNode - An SDNode that represents everything that will be needed
1708 /// to construct a MachineInstr. These nodes are created during the
1709 /// instruction selection proper phase.
1711 class MachineSDNode : public SDNode {
1713 typedef MachineMemOperand **mmo_iterator;
1716 friend class SelectionDAG;
1717 MachineSDNode(unsigned Opc, const DebugLoc DL, SDVTList VTs)
1718 : SDNode(Opc, DL, VTs), MemRefs(0), MemRefsEnd(0) {}
1720 /// LocalOperands - Operands for this instruction, if they fit here. If
1721 /// they don't, this field is unused.
1722 SDUse LocalOperands[4];
1724 /// MemRefs - Memory reference descriptions for this instruction.
1725 mmo_iterator MemRefs;
1726 mmo_iterator MemRefsEnd;
1729 mmo_iterator memoperands_begin() const { return MemRefs; }
1730 mmo_iterator memoperands_end() const { return MemRefsEnd; }
1731 bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
1733 /// setMemRefs - Assign this MachineSDNodes's memory reference descriptor
1734 /// list. This does not transfer ownership.
1735 void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
1736 for (mmo_iterator MMI = NewMemRefs, MME = NewMemRefsEnd; MMI != MME; ++MMI)
1737 assert(*MMI && "Null mem ref detected!");
1738 MemRefs = NewMemRefs;
1739 MemRefsEnd = NewMemRefsEnd;
1742 static bool classof(const MachineSDNode *) { return true; }
1743 static bool classof(const SDNode *N) {
1744 return N->isMachineOpcode();
1748 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
1749 SDNode, ptrdiff_t> {
1753 SDNodeIterator(const SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1755 bool operator==(const SDNodeIterator& x) const {
1756 return Operand == x.Operand;
1758 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1760 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1761 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1762 Operand = I.Operand;
1766 pointer operator*() const {
1767 return Node->getOperand(Operand).getNode();
1769 pointer operator->() const { return operator*(); }
1771 SDNodeIterator& operator++() { // Preincrement
1775 SDNodeIterator operator++(int) { // Postincrement
1776 SDNodeIterator tmp = *this; ++*this; return tmp;
1778 size_t operator-(SDNodeIterator Other) const {
1779 assert(Node == Other.Node &&
1780 "Cannot compare iterators of two different nodes!");
1781 return Operand - Other.Operand;
1784 static SDNodeIterator begin(const SDNode *N) { return SDNodeIterator(N, 0); }
1785 static SDNodeIterator end (const SDNode *N) {
1786 return SDNodeIterator(N, N->getNumOperands());
1789 unsigned getOperand() const { return Operand; }
1790 const SDNode *getNode() const { return Node; }
1793 template <> struct GraphTraits<SDNode*> {
1794 typedef SDNode NodeType;
1795 typedef SDNodeIterator ChildIteratorType;
1796 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1797 static inline ChildIteratorType child_begin(NodeType *N) {
1798 return SDNodeIterator::begin(N);
1800 static inline ChildIteratorType child_end(NodeType *N) {
1801 return SDNodeIterator::end(N);
1805 /// LargestSDNode - The largest SDNode class.
1807 typedef LoadSDNode LargestSDNode;
1809 /// MostAlignedSDNode - The SDNode class with the greatest alignment
1812 typedef GlobalAddressSDNode MostAlignedSDNode;
1815 /// isNormalLoad - Returns true if the specified node is a non-extending
1816 /// and unindexed load.
1817 inline bool isNormalLoad(const SDNode *N) {
1818 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
1819 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
1820 Ld->getAddressingMode() == ISD::UNINDEXED;
1823 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1825 inline bool isNON_EXTLoad(const SDNode *N) {
1826 return isa<LoadSDNode>(N) &&
1827 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1830 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1832 inline bool isEXTLoad(const SDNode *N) {
1833 return isa<LoadSDNode>(N) &&
1834 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1837 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1839 inline bool isSEXTLoad(const SDNode *N) {
1840 return isa<LoadSDNode>(N) &&
1841 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1844 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1846 inline bool isZEXTLoad(const SDNode *N) {
1847 return isa<LoadSDNode>(N) &&
1848 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1851 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
1853 inline bool isUNINDEXEDLoad(const SDNode *N) {
1854 return isa<LoadSDNode>(N) &&
1855 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1858 /// isNormalStore - Returns true if the specified node is a non-truncating
1859 /// and unindexed store.
1860 inline bool isNormalStore(const SDNode *N) {
1861 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
1862 return St && !St->isTruncatingStore() &&
1863 St->getAddressingMode() == ISD::UNINDEXED;
1866 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1868 inline bool isNON_TRUNCStore(const SDNode *N) {
1869 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
1872 /// isTRUNCStore - Returns true if the specified node is a truncating
1874 inline bool isTRUNCStore(const SDNode *N) {
1875 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
1878 /// isUNINDEXEDStore - Returns true if the specified node is an
1879 /// unindexed store.
1880 inline bool isUNINDEXEDStore(const SDNode *N) {
1881 return isa<StoreSDNode>(N) &&
1882 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1886 } // end llvm namespace