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/FoldingSet.h"
23 #include "llvm/ADT/GraphTraits.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/ADT/SmallPtrSet.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/ADT/ilist_node.h"
28 #include "llvm/CodeGen/ISDOpcodes.h"
29 #include "llvm/CodeGen/MachineMemOperand.h"
30 #include "llvm/CodeGen/ValueTypes.h"
31 #include "llvm/IR/Constants.h"
32 #include "llvm/IR/Instructions.h"
33 #include "llvm/Support/DataTypes.h"
34 #include "llvm/Support/DebugLoc.h"
35 #include "llvm/Support/MathExtras.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 /// \brief Return true if the specified node is a BUILD_VECTOR node of
74 /// all ConstantSDNode or undef.
75 bool isBuildVectorOfConstantSDNodes(const SDNode *N);
77 /// isScalarToVector - Return true if the specified node is a
78 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
79 /// element is not an undef.
80 bool isScalarToVector(const SDNode *N);
82 /// allOperandsUndef - Return true if the node has at least one operand
83 /// and all operands of the specified node are ISD::UNDEF.
84 bool allOperandsUndef(const SDNode *N);
85 } // end llvm:ISD namespace
87 //===----------------------------------------------------------------------===//
88 /// SDValue - Unlike LLVM values, Selection DAG nodes may return multiple
89 /// values as the result of a computation. Many nodes return multiple values,
90 /// from loads (which define a token and a return value) to ADDC (which returns
91 /// a result and a carry value), to calls (which may return an arbitrary number
94 /// As such, each use of a SelectionDAG computation must indicate the node that
95 /// computes it as well as which return value to use from that node. This pair
96 /// of information is represented with the SDValue value type.
99 SDNode *Node; // The node defining the value we are using.
100 unsigned ResNo; // Which return value of the node we are using.
102 SDValue() : Node(0), ResNo(0) {}
103 SDValue(SDNode *node, unsigned resno) : Node(node), ResNo(resno) {}
105 /// get the index which selects a specific result in the SDNode
106 unsigned getResNo() const { return ResNo; }
108 /// get the SDNode which holds the desired result
109 SDNode *getNode() const { return Node; }
112 void setNode(SDNode *N) { Node = N; }
114 inline SDNode *operator->() const { return Node; }
116 bool operator==(const SDValue &O) const {
117 return Node == O.Node && ResNo == O.ResNo;
119 bool operator!=(const SDValue &O) const {
120 return !operator==(O);
122 bool operator<(const SDValue &O) const {
123 return Node < O.Node || (Node == O.Node && ResNo < O.ResNo);
126 SDValue getValue(unsigned R) const {
127 return SDValue(Node, R);
130 // isOperandOf - Return true if this node is an operand of N.
131 bool isOperandOf(SDNode *N) const;
133 /// getValueType - Return the ValueType of the referenced return value.
135 inline EVT getValueType() const;
137 /// Return the simple ValueType of the referenced return value.
138 MVT getSimpleValueType() const {
139 return getValueType().getSimpleVT();
142 /// getValueSizeInBits - Returns the size of the value in bits.
144 unsigned getValueSizeInBits() const {
145 return getValueType().getSizeInBits();
148 // Forwarding methods - These forward to the corresponding methods in SDNode.
149 inline unsigned getOpcode() const;
150 inline unsigned getNumOperands() const;
151 inline const SDValue &getOperand(unsigned i) const;
152 inline uint64_t getConstantOperandVal(unsigned i) const;
153 inline bool isTargetMemoryOpcode() const;
154 inline bool isTargetOpcode() const;
155 inline bool isMachineOpcode() const;
156 inline unsigned getMachineOpcode() const;
157 inline const DebugLoc getDebugLoc() const;
158 inline void dump() const;
159 inline void dumpr() const;
161 /// reachesChainWithoutSideEffects - Return true if this operand (which must
162 /// be a chain) reaches the specified operand without crossing any
163 /// side-effecting instructions. In practice, this looks through token
164 /// factors and non-volatile loads. In order to remain efficient, this only
165 /// looks a couple of nodes in, it does not do an exhaustive search.
166 bool reachesChainWithoutSideEffects(SDValue Dest,
167 unsigned Depth = 2) const;
169 /// use_empty - Return true if there are no nodes using value ResNo
172 inline bool use_empty() const;
174 /// hasOneUse - Return true if there is exactly one node using value
177 inline bool hasOneUse() const;
181 template<> struct DenseMapInfo<SDValue> {
182 static inline SDValue getEmptyKey() {
183 return SDValue((SDNode*)-1, -1U);
185 static inline SDValue getTombstoneKey() {
186 return SDValue((SDNode*)-1, 0);
188 static unsigned getHashValue(const SDValue &Val) {
189 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
190 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
192 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
196 template <> struct isPodLike<SDValue> { static const bool value = true; };
199 /// simplify_type specializations - Allow casting operators to work directly on
200 /// SDValues as if they were SDNode*'s.
201 template<> struct simplify_type<SDValue> {
202 typedef SDNode* SimpleType;
203 static SimpleType getSimplifiedValue(SDValue &Val) {
204 return Val.getNode();
207 template<> struct simplify_type<const SDValue> {
208 typedef /*const*/ SDNode* SimpleType;
209 static SimpleType getSimplifiedValue(const SDValue &Val) {
210 return Val.getNode();
214 /// SDUse - Represents a use of a SDNode. This class holds an SDValue,
215 /// which records the SDNode being used and the result number, a
216 /// pointer to the SDNode using the value, and Next and Prev pointers,
217 /// which link together all the uses of an SDNode.
220 /// Val - The value being used.
222 /// User - The user of this value.
224 /// Prev, Next - Pointers to the uses list of the SDNode referred by
228 SDUse(const SDUse &U) LLVM_DELETED_FUNCTION;
229 void operator=(const SDUse &U) LLVM_DELETED_FUNCTION;
232 SDUse() : Val(), User(NULL), Prev(NULL), Next(NULL) {}
234 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
235 operator const SDValue&() const { return Val; }
237 /// If implicit conversion to SDValue doesn't work, the get() method returns
239 const SDValue &get() const { return Val; }
241 /// getUser - This returns the SDNode that contains this Use.
242 SDNode *getUser() { return User; }
244 /// getNext - Get the next SDUse in the use list.
245 SDUse *getNext() const { return Next; }
247 /// getNode - Convenience function for get().getNode().
248 SDNode *getNode() const { return Val.getNode(); }
249 /// getResNo - Convenience function for get().getResNo().
250 unsigned getResNo() const { return Val.getResNo(); }
251 /// getValueType - Convenience function for get().getValueType().
252 EVT getValueType() const { return Val.getValueType(); }
254 /// operator== - Convenience function for get().operator==
255 bool operator==(const SDValue &V) const {
259 /// operator!= - Convenience function for get().operator!=
260 bool operator!=(const SDValue &V) const {
264 /// operator< - Convenience function for get().operator<
265 bool operator<(const SDValue &V) const {
270 friend class SelectionDAG;
273 void setUser(SDNode *p) { User = p; }
275 /// set - Remove this use from its existing use list, assign it the
276 /// given value, and add it to the new value's node's use list.
277 inline void set(const SDValue &V);
278 /// setInitial - like set, but only supports initializing a newly-allocated
279 /// SDUse with a non-null value.
280 inline void setInitial(const SDValue &V);
281 /// setNode - like set, but only sets the Node portion of the value,
282 /// leaving the ResNo portion unmodified.
283 inline void setNode(SDNode *N);
285 void addToList(SDUse **List) {
287 if (Next) Next->Prev = &Next;
292 void removeFromList() {
294 if (Next) Next->Prev = Prev;
298 /// simplify_type specializations - Allow casting operators to work directly on
299 /// SDValues as if they were SDNode*'s.
300 template<> struct simplify_type<SDUse> {
301 typedef SDNode* SimpleType;
302 static SimpleType getSimplifiedValue(SDUse &Val) {
303 return Val.getNode();
308 /// SDNode - Represents one node in the SelectionDAG.
310 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
312 /// NodeType - The operation that this node performs.
316 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
317 /// then they will be delete[]'d when the node is destroyed.
318 uint16_t OperandsNeedDelete : 1;
320 /// HasDebugValue - This tracks whether this node has one or more dbg_value
321 /// nodes corresponding to it.
322 uint16_t HasDebugValue : 1;
325 /// SubclassData - This member is defined by this class, but is not used for
326 /// anything. Subclasses can use it to hold whatever state they find useful.
327 /// This field is initialized to zero by the ctor.
328 uint16_t SubclassData : 14;
331 /// NodeId - Unique id per SDNode in the DAG.
334 /// OperandList - The values that are used by this operation.
338 /// ValueList - The types of the values this node defines. SDNode's may
339 /// define multiple values simultaneously.
340 const EVT *ValueList;
342 /// UseList - List of uses for this SDNode.
345 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
346 unsigned short NumOperands, NumValues;
348 /// debugLoc - source line information.
351 // The ordering of the SDNodes. It roughly corresponds to the ordering of the
352 // original LLVM instructions.
353 // This is used for turning off scheduling, because we'll forgo
354 // the normal scheduling algorithms and output the instructions according to
358 /// getValueTypeList - Return a pointer to the specified value type.
359 static const EVT *getValueTypeList(EVT VT);
361 friend class SelectionDAG;
362 friend struct ilist_traits<SDNode>;
365 //===--------------------------------------------------------------------===//
369 /// getOpcode - Return the SelectionDAG opcode value for this node. For
370 /// pre-isel nodes (those for which isMachineOpcode returns false), these
371 /// are the opcode values in the ISD and <target>ISD namespaces. For
372 /// post-isel opcodes, see getMachineOpcode.
373 unsigned getOpcode() const { return (unsigned short)NodeType; }
375 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
376 /// \<target\>ISD namespace).
377 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
379 /// isTargetMemoryOpcode - Test if this node has a target-specific
380 /// memory-referencing opcode (in the \<target\>ISD namespace and
381 /// greater than FIRST_TARGET_MEMORY_OPCODE).
382 bool isTargetMemoryOpcode() const {
383 return NodeType >= ISD::FIRST_TARGET_MEMORY_OPCODE;
386 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
387 /// corresponding to a MachineInstr opcode.
388 bool isMachineOpcode() const { return NodeType < 0; }
390 /// getMachineOpcode - This may only be called if isMachineOpcode returns
391 /// true. It returns the MachineInstr opcode value that the node's opcode
393 unsigned getMachineOpcode() const {
394 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
398 /// getHasDebugValue - get this bit.
399 bool getHasDebugValue() const { return HasDebugValue; }
401 /// setHasDebugValue - set this bit.
402 void setHasDebugValue(bool b) { HasDebugValue = b; }
404 /// use_empty - Return true if there are no uses of this node.
406 bool use_empty() const { return UseList == NULL; }
408 /// hasOneUse - Return true if there is exactly one use of this node.
410 bool hasOneUse() const {
411 return !use_empty() && llvm::next(use_begin()) == use_end();
414 /// use_size - Return the number of uses of this node. This method takes
415 /// time proportional to the number of uses.
417 size_t use_size() const { return std::distance(use_begin(), use_end()); }
419 /// getNodeId - Return the unique node id.
421 int getNodeId() const { return NodeId; }
423 /// setNodeId - Set unique node id.
424 void setNodeId(int Id) { NodeId = Id; }
426 /// getIROrder - Return the node ordering.
428 unsigned getIROrder() const { return IROrder; }
430 /// setIROrder - Set the node ordering.
432 void setIROrder(unsigned Order) { IROrder = Order; }
434 /// getDebugLoc - Return the source location info.
435 const DebugLoc getDebugLoc() const { return debugLoc; }
437 /// setDebugLoc - Set source location info. Try to avoid this, putting
438 /// it in the constructor is preferable.
439 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
441 /// use_iterator - This class provides iterator support for SDUse
442 /// operands that use a specific SDNode.
444 : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
446 explicit use_iterator(SDUse *op) : Op(op) {
450 typedef std::iterator<std::forward_iterator_tag,
451 SDUse, ptrdiff_t>::reference reference;
452 typedef std::iterator<std::forward_iterator_tag,
453 SDUse, ptrdiff_t>::pointer pointer;
455 use_iterator(const use_iterator &I) : Op(I.Op) {}
456 use_iterator() : Op(0) {}
458 bool operator==(const use_iterator &x) const {
461 bool operator!=(const use_iterator &x) const {
462 return !operator==(x);
465 /// atEnd - return true if this iterator is at the end of uses list.
466 bool atEnd() const { return Op == 0; }
468 // Iterator traversal: forward iteration only.
469 use_iterator &operator++() { // Preincrement
470 assert(Op && "Cannot increment end iterator!");
475 use_iterator operator++(int) { // Postincrement
476 use_iterator tmp = *this; ++*this; return tmp;
479 /// Retrieve a pointer to the current user node.
480 SDNode *operator*() const {
481 assert(Op && "Cannot dereference end iterator!");
482 return Op->getUser();
485 SDNode *operator->() const { return operator*(); }
487 SDUse &getUse() const { return *Op; }
489 /// getOperandNo - Retrieve the operand # of this use in its user.
491 unsigned getOperandNo() const {
492 assert(Op && "Cannot dereference end iterator!");
493 return (unsigned)(Op - Op->getUser()->OperandList);
497 /// use_begin/use_end - Provide iteration support to walk over all uses
500 use_iterator use_begin() const {
501 return use_iterator(UseList);
504 static use_iterator use_end() { return use_iterator(0); }
507 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
508 /// indicated value. This method ignores uses of other values defined by this
510 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
512 /// hasAnyUseOfValue - Return true if there are any use of the indicated
513 /// value. This method ignores uses of other values defined by this operation.
514 bool hasAnyUseOfValue(unsigned Value) const;
516 /// isOnlyUserOf - Return true if this node is the only use of N.
518 bool isOnlyUserOf(SDNode *N) const;
520 /// isOperandOf - Return true if this node is an operand of N.
522 bool isOperandOf(SDNode *N) const;
524 /// isPredecessorOf - Return true if this node is a predecessor of N.
525 /// NOTE: Implemented on top of hasPredecessor and every bit as
526 /// expensive. Use carefully.
527 bool isPredecessorOf(const SDNode *N) const {
528 return N->hasPredecessor(this);
531 /// hasPredecessor - Return true if N is a predecessor of this node.
532 /// N is either an operand of this node, or can be reached by recursively
533 /// traversing up the operands.
534 /// NOTE: This is an expensive method. Use it carefully.
535 bool hasPredecessor(const SDNode *N) const;
537 /// hasPredecesorHelper - Return true if N is a predecessor of this node.
538 /// N is either an operand of this node, or can be reached by recursively
539 /// traversing up the operands.
540 /// In this helper the Visited and worklist sets are held externally to
541 /// cache predecessors over multiple invocations. If you want to test for
542 /// multiple predecessors this method is preferable to multiple calls to
543 /// hasPredecessor. Be sure to clear Visited and Worklist if the DAG
545 /// NOTE: This is still very expensive. Use carefully.
546 bool hasPredecessorHelper(const SDNode *N,
547 SmallPtrSet<const SDNode *, 32> &Visited,
548 SmallVectorImpl<const SDNode *> &Worklist) const;
550 /// getNumOperands - Return the number of values used by this operation.
552 unsigned getNumOperands() const { return NumOperands; }
554 /// getConstantOperandVal - Helper method returns the integer value of a
555 /// ConstantSDNode operand.
556 uint64_t getConstantOperandVal(unsigned Num) const;
558 const SDValue &getOperand(unsigned Num) const {
559 assert(Num < NumOperands && "Invalid child # of SDNode!");
560 return OperandList[Num];
563 typedef SDUse* op_iterator;
564 op_iterator op_begin() const { return OperandList; }
565 op_iterator op_end() const { return OperandList+NumOperands; }
567 SDVTList getVTList() const {
568 SDVTList X = { ValueList, NumValues };
572 /// getGluedNode - If this node has a glue operand, return the node
573 /// to which the glue operand points. Otherwise return NULL.
574 SDNode *getGluedNode() const {
575 if (getNumOperands() != 0 &&
576 getOperand(getNumOperands()-1).getValueType() == MVT::Glue)
577 return getOperand(getNumOperands()-1).getNode();
581 // If this is a pseudo op, like copyfromreg, look to see if there is a
582 // real target node glued to it. If so, return the target node.
583 const SDNode *getGluedMachineNode() const {
584 const SDNode *FoundNode = this;
586 // Climb up glue edges until a machine-opcode node is found, or the
587 // end of the chain is reached.
588 while (!FoundNode->isMachineOpcode()) {
589 const SDNode *N = FoundNode->getGluedNode();
597 /// getGluedUser - If this node has a glue value with a user, return
598 /// the user (there is at most one). Otherwise return NULL.
599 SDNode *getGluedUser() const {
600 for (use_iterator UI = use_begin(), UE = use_end(); UI != UE; ++UI)
601 if (UI.getUse().get().getValueType() == MVT::Glue)
606 /// getNumValues - Return the number of values defined/returned by this
609 unsigned getNumValues() const { return NumValues; }
611 /// getValueType - Return the type of a specified result.
613 EVT getValueType(unsigned ResNo) const {
614 assert(ResNo < NumValues && "Illegal result number!");
615 return ValueList[ResNo];
618 /// Return the type of a specified result as a simple type.
620 MVT getSimpleValueType(unsigned ResNo) const {
621 return getValueType(ResNo).getSimpleVT();
624 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
626 unsigned getValueSizeInBits(unsigned ResNo) const {
627 return getValueType(ResNo).getSizeInBits();
630 typedef const EVT* value_iterator;
631 value_iterator value_begin() const { return ValueList; }
632 value_iterator value_end() const { return ValueList+NumValues; }
634 /// getOperationName - Return the opcode of this operation for printing.
636 std::string getOperationName(const SelectionDAG *G = 0) const;
637 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
638 void print_types(raw_ostream &OS, const SelectionDAG *G) const;
639 void print_details(raw_ostream &OS, const SelectionDAG *G) const;
640 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
641 void printr(raw_ostream &OS, const SelectionDAG *G = 0) const;
643 /// printrFull - Print a SelectionDAG node and all children down to
644 /// the leaves. The given SelectionDAG allows target-specific nodes
645 /// to be printed in human-readable form. Unlike printr, this will
646 /// print the whole DAG, including children that appear multiple
649 void printrFull(raw_ostream &O, const SelectionDAG *G = 0) const;
651 /// printrWithDepth - Print a SelectionDAG node and children up to
652 /// depth "depth." The given SelectionDAG allows target-specific
653 /// nodes to be printed in human-readable form. Unlike printr, this
654 /// will print children that appear multiple times wherever they are
657 void printrWithDepth(raw_ostream &O, const SelectionDAG *G = 0,
658 unsigned depth = 100) const;
661 /// dump - Dump this node, for debugging.
664 /// dumpr - Dump (recursively) this node and its use-def subgraph.
667 /// dump - Dump this node, for debugging.
668 /// The given SelectionDAG allows target-specific nodes to be printed
669 /// in human-readable form.
670 void dump(const SelectionDAG *G) const;
672 /// dumpr - Dump (recursively) this node and its use-def subgraph.
673 /// The given SelectionDAG allows target-specific nodes to be printed
674 /// in human-readable form.
675 void dumpr(const SelectionDAG *G) const;
677 /// dumprFull - printrFull to dbgs(). The given SelectionDAG allows
678 /// target-specific nodes to be printed in human-readable form.
679 /// Unlike dumpr, this will print the whole DAG, including children
680 /// that appear multiple times.
682 void dumprFull(const SelectionDAG *G = 0) const;
684 /// dumprWithDepth - printrWithDepth to dbgs(). The given
685 /// SelectionDAG allows target-specific nodes to be printed in
686 /// human-readable form. Unlike dumpr, this will print children
687 /// that appear multiple times wherever they are used.
689 void dumprWithDepth(const SelectionDAG *G = 0, unsigned depth = 100) const;
691 /// Profile - Gather unique data for the node.
693 void Profile(FoldingSetNodeID &ID) const;
695 /// addUse - This method should only be used by the SDUse class.
697 void addUse(SDUse &U) { U.addToList(&UseList); }
700 static SDVTList getSDVTList(EVT VT) {
701 SDVTList Ret = { getValueTypeList(VT), 1 };
705 SDNode(unsigned Opc, unsigned Order, const DebugLoc dl, SDVTList VTs,
706 const SDValue *Ops, unsigned NumOps)
707 : NodeType(Opc), OperandsNeedDelete(true), HasDebugValue(false),
708 SubclassData(0), NodeId(-1),
709 OperandList(NumOps ? new SDUse[NumOps] : 0),
710 ValueList(VTs.VTs), UseList(NULL),
711 NumOperands(NumOps), NumValues(VTs.NumVTs),
712 debugLoc(dl), IROrder(Order) {
713 for (unsigned i = 0; i != NumOps; ++i) {
714 OperandList[i].setUser(this);
715 OperandList[i].setInitial(Ops[i]);
717 checkForCycles(this);
720 /// This constructor adds no operands itself; operands can be
721 /// set later with InitOperands.
722 SDNode(unsigned Opc, unsigned Order, const DebugLoc dl, SDVTList VTs)
723 : NodeType(Opc), OperandsNeedDelete(false), HasDebugValue(false),
724 SubclassData(0), NodeId(-1), OperandList(0),
725 ValueList(VTs.VTs), UseList(NULL), NumOperands(0), NumValues(VTs.NumVTs),
726 debugLoc(dl), IROrder(Order) {}
728 /// InitOperands - Initialize the operands list of this with 1 operand.
729 void InitOperands(SDUse *Ops, const SDValue &Op0) {
730 Ops[0].setUser(this);
731 Ops[0].setInitial(Op0);
734 checkForCycles(this);
737 /// InitOperands - Initialize the operands list of this with 2 operands.
738 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
739 Ops[0].setUser(this);
740 Ops[0].setInitial(Op0);
741 Ops[1].setUser(this);
742 Ops[1].setInitial(Op1);
745 checkForCycles(this);
748 /// InitOperands - Initialize the operands list of this with 3 operands.
749 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
750 const SDValue &Op2) {
751 Ops[0].setUser(this);
752 Ops[0].setInitial(Op0);
753 Ops[1].setUser(this);
754 Ops[1].setInitial(Op1);
755 Ops[2].setUser(this);
756 Ops[2].setInitial(Op2);
759 checkForCycles(this);
762 /// InitOperands - Initialize the operands list of this with 4 operands.
763 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
764 const SDValue &Op2, const SDValue &Op3) {
765 Ops[0].setUser(this);
766 Ops[0].setInitial(Op0);
767 Ops[1].setUser(this);
768 Ops[1].setInitial(Op1);
769 Ops[2].setUser(this);
770 Ops[2].setInitial(Op2);
771 Ops[3].setUser(this);
772 Ops[3].setInitial(Op3);
775 checkForCycles(this);
778 /// InitOperands - Initialize the operands list of this with N operands.
779 void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
780 for (unsigned i = 0; i != N; ++i) {
781 Ops[i].setUser(this);
782 Ops[i].setInitial(Vals[i]);
786 checkForCycles(this);
789 /// DropOperands - Release the operands and set this node to have
794 /// Wrapper class for IR location info (IR ordering and DebugLoc) to be passed
795 /// into SDNode creation functions.
796 /// When an SDNode is created from the DAGBuilder, the DebugLoc is extracted
797 /// from the original Instruction, and IROrder is the ordinal position of
799 /// When an SDNode is created after the DAG is being built, both DebugLoc and
800 /// the IROrder are propagated from the original SDNode.
801 /// So SDLoc class provides two constructors besides the default one, one to
802 /// be used by the DAGBuilder, the other to be used by others.
805 // Ptr could be used for either Instruction* or SDNode*. It is used for
806 // Instruction* if IROrder is not -1.
811 SDLoc() : Ptr(NULL), IROrder(0) {}
812 SDLoc(const SDNode *N) : Ptr(N), IROrder(-1) {
813 assert(N && "null SDNode");
815 SDLoc(const SDValue V) : Ptr(V.getNode()), IROrder(-1) {
816 assert(Ptr && "null SDNode");
818 SDLoc(const Instruction *I, int Order) : Ptr(I), IROrder(Order) {
819 assert(Order >= 0 && "bad IROrder");
821 unsigned getIROrder() {
822 if (IROrder >= 0 || Ptr == NULL) {
823 return (unsigned)IROrder;
825 const SDNode *N = (const SDNode*)(Ptr);
826 return N->getIROrder();
828 DebugLoc getDebugLoc() {
833 const Instruction *I = (const Instruction*)(Ptr);
834 return I->getDebugLoc();
836 const SDNode *N = (const SDNode*)(Ptr);
837 return N->getDebugLoc();
842 // Define inline functions from the SDValue class.
844 inline unsigned SDValue::getOpcode() const {
845 return Node->getOpcode();
847 inline EVT SDValue::getValueType() const {
848 return Node->getValueType(ResNo);
850 inline unsigned SDValue::getNumOperands() const {
851 return Node->getNumOperands();
853 inline const SDValue &SDValue::getOperand(unsigned i) const {
854 return Node->getOperand(i);
856 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
857 return Node->getConstantOperandVal(i);
859 inline bool SDValue::isTargetOpcode() const {
860 return Node->isTargetOpcode();
862 inline bool SDValue::isTargetMemoryOpcode() const {
863 return Node->isTargetMemoryOpcode();
865 inline bool SDValue::isMachineOpcode() const {
866 return Node->isMachineOpcode();
868 inline unsigned SDValue::getMachineOpcode() const {
869 return Node->getMachineOpcode();
871 inline bool SDValue::use_empty() const {
872 return !Node->hasAnyUseOfValue(ResNo);
874 inline bool SDValue::hasOneUse() const {
875 return Node->hasNUsesOfValue(1, ResNo);
877 inline const DebugLoc SDValue::getDebugLoc() const {
878 return Node->getDebugLoc();
880 inline void SDValue::dump() const {
883 inline void SDValue::dumpr() const {
884 return Node->dumpr();
886 // Define inline functions from the SDUse class.
888 inline void SDUse::set(const SDValue &V) {
889 if (Val.getNode()) removeFromList();
891 if (V.getNode()) V.getNode()->addUse(*this);
894 inline void SDUse::setInitial(const SDValue &V) {
896 V.getNode()->addUse(*this);
899 inline void SDUse::setNode(SDNode *N) {
900 if (Val.getNode()) removeFromList();
902 if (N) N->addUse(*this);
905 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
906 /// to allow co-allocation of node operands with the node itself.
907 class UnarySDNode : public SDNode {
910 UnarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
912 : SDNode(Opc, Order, dl, VTs) {
913 InitOperands(&Op, X);
917 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
918 /// to allow co-allocation of node operands with the node itself.
919 class BinarySDNode : public SDNode {
922 BinarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
923 SDValue X, SDValue Y)
924 : SDNode(Opc, Order, dl, VTs) {
925 InitOperands(Ops, X, Y);
929 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
930 /// to allow co-allocation of node operands with the node itself.
931 class TernarySDNode : public SDNode {
934 TernarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
935 SDValue X, SDValue Y, SDValue Z)
936 : SDNode(Opc, Order, dl, VTs) {
937 InitOperands(Ops, X, Y, Z);
942 /// HandleSDNode - This class is used to form a handle around another node that
943 /// is persistent and is updated across invocations of replaceAllUsesWith on its
944 /// operand. This node should be directly created by end-users and not added to
945 /// the AllNodes list.
946 class HandleSDNode : public SDNode {
949 explicit HandleSDNode(SDValue X)
950 : SDNode(ISD::HANDLENODE, 0, DebugLoc(), getSDVTList(MVT::Other)) {
951 InitOperands(&Op, X);
954 const SDValue &getValue() const { return Op; }
957 class AddrSpaceCastSDNode : public UnarySDNode {
959 unsigned SrcAddrSpace;
960 unsigned DestAddrSpace;
963 AddrSpaceCastSDNode(unsigned Order, DebugLoc dl, EVT VT, SDValue X,
964 unsigned SrcAS, unsigned DestAS);
966 unsigned getSrcAddressSpace() const { return SrcAddrSpace; }
967 unsigned getDestAddressSpace() const { return DestAddrSpace; }
969 static bool classof(const SDNode *N) {
970 return N->getOpcode() == ISD::ADDRSPACECAST;
974 /// Abstact virtual class for operations for memory operations
975 class MemSDNode : public SDNode {
977 // MemoryVT - VT of in-memory value.
981 /// MMO - Memory reference information.
982 MachineMemOperand *MMO;
985 MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
986 EVT MemoryVT, MachineMemOperand *MMO);
988 MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
990 unsigned NumOps, EVT MemoryVT, MachineMemOperand *MMO);
992 bool readMem() const { return MMO->isLoad(); }
993 bool writeMem() const { return MMO->isStore(); }
995 /// Returns alignment and volatility of the memory access
996 unsigned getOriginalAlignment() const {
997 return MMO->getBaseAlignment();
999 unsigned getAlignment() const {
1000 return MMO->getAlignment();
1003 /// getRawSubclassData - Return the SubclassData value, which contains an
1004 /// encoding of the volatile flag, as well as bits used by subclasses. This
1005 /// function should only be used to compute a FoldingSetNodeID value.
1006 unsigned getRawSubclassData() const {
1007 return SubclassData;
1010 // We access subclass data here so that we can check consistency
1011 // with MachineMemOperand information.
1012 bool isVolatile() const { return (SubclassData >> 5) & 1; }
1013 bool isNonTemporal() const { return (SubclassData >> 6) & 1; }
1014 bool isInvariant() const { return (SubclassData >> 7) & 1; }
1016 AtomicOrdering getOrdering() const {
1017 return AtomicOrdering((SubclassData >> 8) & 15);
1019 SynchronizationScope getSynchScope() const {
1020 return SynchronizationScope((SubclassData >> 12) & 1);
1023 /// Returns the SrcValue and offset that describes the location of the access
1024 const Value *getSrcValue() const { return MMO->getValue(); }
1025 int64_t getSrcValueOffset() const { return MMO->getOffset(); }
1027 /// Returns the TBAAInfo that describes the dereference.
1028 const MDNode *getTBAAInfo() const { return MMO->getTBAAInfo(); }
1030 /// Returns the Ranges that describes the dereference.
1031 const MDNode *getRanges() const { return MMO->getRanges(); }
1033 /// getMemoryVT - Return the type of the in-memory value.
1034 EVT getMemoryVT() const { return MemoryVT; }
1036 /// getMemOperand - Return a MachineMemOperand object describing the memory
1037 /// reference performed by operation.
1038 MachineMemOperand *getMemOperand() const { return MMO; }
1040 const MachinePointerInfo &getPointerInfo() const {
1041 return MMO->getPointerInfo();
1044 /// getAddressSpace - Return the address space for the associated pointer
1045 unsigned getAddressSpace() const {
1046 return getPointerInfo().getAddrSpace();
1049 /// refineAlignment - Update this MemSDNode's MachineMemOperand information
1050 /// to reflect the alignment of NewMMO, if it has a greater alignment.
1051 /// This must only be used when the new alignment applies to all users of
1052 /// this MachineMemOperand.
1053 void refineAlignment(const MachineMemOperand *NewMMO) {
1054 MMO->refineAlignment(NewMMO);
1057 const SDValue &getChain() const { return getOperand(0); }
1058 const SDValue &getBasePtr() const {
1059 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1062 // Methods to support isa and dyn_cast
1063 static bool classof(const SDNode *N) {
1064 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1065 // with either an intrinsic or a target opcode.
1066 return N->getOpcode() == ISD::LOAD ||
1067 N->getOpcode() == ISD::STORE ||
1068 N->getOpcode() == ISD::PREFETCH ||
1069 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1070 N->getOpcode() == ISD::ATOMIC_SWAP ||
1071 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1072 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1073 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1074 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1075 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1076 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1077 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1078 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1079 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1080 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1081 N->getOpcode() == ISD::ATOMIC_LOAD ||
1082 N->getOpcode() == ISD::ATOMIC_STORE ||
1083 N->isTargetMemoryOpcode();
1087 /// AtomicSDNode - A SDNode reprenting atomic operations.
1089 class AtomicSDNode : public MemSDNode {
1092 void InitAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope) {
1093 // This must match encodeMemSDNodeFlags() in SelectionDAG.cpp.
1094 assert((Ordering & 15) == Ordering &&
1095 "Ordering may not require more than 4 bits!");
1096 assert((SynchScope & 1) == SynchScope &&
1097 "SynchScope may not require more than 1 bit!");
1098 SubclassData |= Ordering << 8;
1099 SubclassData |= SynchScope << 12;
1100 assert(getOrdering() == Ordering && "Ordering encoding error!");
1101 assert(getSynchScope() == SynchScope && "Synch-scope encoding error!");
1105 // Opc: opcode for atomic
1106 // VTL: value type list
1107 // Chain: memory chain for operaand
1108 // Ptr: address to update as a SDValue
1109 // Cmp: compare value
1111 // SrcVal: address to update as a Value (used for MemOperand)
1112 // Align: alignment of memory
1113 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1115 SDValue Chain, SDValue Ptr,
1116 SDValue Cmp, SDValue Swp, MachineMemOperand *MMO,
1117 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1118 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1119 InitAtomic(Ordering, SynchScope);
1120 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1122 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1124 SDValue Chain, SDValue Ptr,
1125 SDValue Val, MachineMemOperand *MMO,
1126 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1127 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1128 InitAtomic(Ordering, SynchScope);
1129 InitOperands(Ops, Chain, Ptr, Val);
1131 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1133 SDValue Chain, SDValue Ptr,
1134 MachineMemOperand *MMO,
1135 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1136 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1137 InitAtomic(Ordering, SynchScope);
1138 InitOperands(Ops, Chain, Ptr);
1140 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL, EVT MemVT,
1141 SDValue* AllOps, SDUse *DynOps, unsigned NumOps,
1142 MachineMemOperand *MMO,
1143 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1144 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1145 InitAtomic(Ordering, SynchScope);
1146 assert((DynOps || NumOps <= array_lengthof(Ops)) &&
1147 "Too many ops for internal storage!");
1148 InitOperands(DynOps ? DynOps : Ops, AllOps, NumOps);
1151 const SDValue &getBasePtr() const { return getOperand(1); }
1152 const SDValue &getVal() const { return getOperand(2); }
1154 bool isCompareAndSwap() const {
1155 unsigned Op = getOpcode();
1156 return Op == ISD::ATOMIC_CMP_SWAP;
1159 // Methods to support isa and dyn_cast
1160 static bool classof(const SDNode *N) {
1161 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1162 N->getOpcode() == ISD::ATOMIC_SWAP ||
1163 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1164 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1165 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1166 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1167 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1168 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1169 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1170 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1171 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1172 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1173 N->getOpcode() == ISD::ATOMIC_LOAD ||
1174 N->getOpcode() == ISD::ATOMIC_STORE;
1178 /// MemIntrinsicSDNode - This SDNode is used for target intrinsics that touch
1179 /// memory and need an associated MachineMemOperand. Its opcode may be
1180 /// INTRINSIC_VOID, INTRINSIC_W_CHAIN, PREFETCH, or a target-specific opcode
1181 /// with a value not less than FIRST_TARGET_MEMORY_OPCODE.
1182 class MemIntrinsicSDNode : public MemSDNode {
1184 MemIntrinsicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1185 const SDValue *Ops, unsigned NumOps,
1186 EVT MemoryVT, MachineMemOperand *MMO)
1187 : MemSDNode(Opc, Order, dl, VTs, Ops, NumOps, MemoryVT, MMO) {
1190 // Methods to support isa and dyn_cast
1191 static bool classof(const SDNode *N) {
1192 // We lower some target intrinsics to their target opcode
1193 // early a node with a target opcode can be of this class
1194 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1195 N->getOpcode() == ISD::INTRINSIC_VOID ||
1196 N->getOpcode() == ISD::PREFETCH ||
1197 N->isTargetMemoryOpcode();
1201 /// ShuffleVectorSDNode - This SDNode is used to implement the code generator
1202 /// support for the llvm IR shufflevector instruction. It combines elements
1203 /// from two input vectors into a new input vector, with the selection and
1204 /// ordering of elements determined by an array of integers, referred to as
1205 /// the shuffle mask. For input vectors of width N, mask indices of 0..N-1
1206 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1207 /// An index of -1 is treated as undef, such that the code generator may put
1208 /// any value in the corresponding element of the result.
1209 class ShuffleVectorSDNode : public SDNode {
1212 // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1213 // is freed when the SelectionDAG object is destroyed.
1216 friend class SelectionDAG;
1217 ShuffleVectorSDNode(EVT VT, unsigned Order, DebugLoc dl, SDValue N1,
1218 SDValue N2, const int *M)
1219 : SDNode(ISD::VECTOR_SHUFFLE, Order, dl, getSDVTList(VT)), Mask(M) {
1220 InitOperands(Ops, N1, N2);
1224 ArrayRef<int> getMask() const {
1225 EVT VT = getValueType(0);
1226 return makeArrayRef(Mask, VT.getVectorNumElements());
1228 int getMaskElt(unsigned Idx) const {
1229 assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1233 bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1234 int getSplatIndex() const {
1235 assert(isSplat() && "Cannot get splat index for non-splat!");
1236 EVT VT = getValueType(0);
1237 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i) {
1241 llvm_unreachable("Splat with all undef indices?");
1243 static bool isSplatMask(const int *Mask, EVT VT);
1245 static bool classof(const SDNode *N) {
1246 return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1250 class ConstantSDNode : public SDNode {
1251 const ConstantInt *Value;
1252 friend class SelectionDAG;
1253 ConstantSDNode(bool isTarget, bool isOpaque, const ConstantInt *val, EVT VT)
1254 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1255 0, DebugLoc(), getSDVTList(VT)), Value(val) {
1256 SubclassData |= isOpaque;
1260 const ConstantInt *getConstantIntValue() const { return Value; }
1261 const APInt &getAPIntValue() const { return Value->getValue(); }
1262 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1263 int64_t getSExtValue() const { return Value->getSExtValue(); }
1265 bool isOne() const { return Value->isOne(); }
1266 bool isNullValue() const { return Value->isNullValue(); }
1267 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1269 bool isOpaque() const { return SubclassData & 1; }
1271 static bool classof(const SDNode *N) {
1272 return N->getOpcode() == ISD::Constant ||
1273 N->getOpcode() == ISD::TargetConstant;
1277 class ConstantFPSDNode : public SDNode {
1278 const ConstantFP *Value;
1279 friend class SelectionDAG;
1280 ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1281 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1282 0, DebugLoc(), getSDVTList(VT)), Value(val) {
1286 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1287 const ConstantFP *getConstantFPValue() const { return Value; }
1289 /// isZero - Return true if the value is positive or negative zero.
1290 bool isZero() const { return Value->isZero(); }
1292 /// isNaN - Return true if the value is a NaN.
1293 bool isNaN() const { return Value->isNaN(); }
1295 /// isExactlyValue - We don't rely on operator== working on double values, as
1296 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1297 /// As such, this method can be used to do an exact bit-for-bit comparison of
1298 /// two floating point values.
1300 /// We leave the version with the double argument here because it's just so
1301 /// convenient to write "2.0" and the like. Without this function we'd
1302 /// have to duplicate its logic everywhere it's called.
1303 bool isExactlyValue(double V) const {
1306 Tmp.convert(Value->getValueAPF().getSemantics(),
1307 APFloat::rmNearestTiesToEven, &ignored);
1308 return isExactlyValue(Tmp);
1310 bool isExactlyValue(const APFloat& V) const;
1312 static bool isValueValidForType(EVT VT, const APFloat& Val);
1314 static bool classof(const SDNode *N) {
1315 return N->getOpcode() == ISD::ConstantFP ||
1316 N->getOpcode() == ISD::TargetConstantFP;
1320 class GlobalAddressSDNode : public SDNode {
1321 const GlobalValue *TheGlobal;
1323 unsigned char TargetFlags;
1324 friend class SelectionDAG;
1325 GlobalAddressSDNode(unsigned Opc, unsigned Order, DebugLoc DL,
1326 const GlobalValue *GA, EVT VT, int64_t o,
1327 unsigned char TargetFlags);
1330 const GlobalValue *getGlobal() const { return TheGlobal; }
1331 int64_t getOffset() const { return Offset; }
1332 unsigned char getTargetFlags() const { return TargetFlags; }
1333 // Return the address space this GlobalAddress belongs to.
1334 unsigned getAddressSpace() const;
1336 static bool classof(const SDNode *N) {
1337 return N->getOpcode() == ISD::GlobalAddress ||
1338 N->getOpcode() == ISD::TargetGlobalAddress ||
1339 N->getOpcode() == ISD::GlobalTLSAddress ||
1340 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1344 class FrameIndexSDNode : public SDNode {
1346 friend class SelectionDAG;
1347 FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1348 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1349 0, DebugLoc(), getSDVTList(VT)), FI(fi) {
1353 int getIndex() const { return FI; }
1355 static bool classof(const SDNode *N) {
1356 return N->getOpcode() == ISD::FrameIndex ||
1357 N->getOpcode() == ISD::TargetFrameIndex;
1361 class JumpTableSDNode : public SDNode {
1363 unsigned char TargetFlags;
1364 friend class SelectionDAG;
1365 JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1366 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1367 0, DebugLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1371 int getIndex() const { return JTI; }
1372 unsigned char getTargetFlags() const { return TargetFlags; }
1374 static bool classof(const SDNode *N) {
1375 return N->getOpcode() == ISD::JumpTable ||
1376 N->getOpcode() == ISD::TargetJumpTable;
1380 class ConstantPoolSDNode : public SDNode {
1382 const Constant *ConstVal;
1383 MachineConstantPoolValue *MachineCPVal;
1385 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1386 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1387 unsigned char TargetFlags;
1388 friend class SelectionDAG;
1389 ConstantPoolSDNode(bool isTarget, const Constant *c, EVT VT, int o,
1390 unsigned Align, unsigned char TF)
1391 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1392 DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1394 assert(Offset >= 0 && "Offset is too large");
1397 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1398 EVT VT, int o, unsigned Align, unsigned char TF)
1399 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1400 DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1402 assert(Offset >= 0 && "Offset is too large");
1403 Val.MachineCPVal = v;
1404 Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1408 bool isMachineConstantPoolEntry() const {
1412 const Constant *getConstVal() const {
1413 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1414 return Val.ConstVal;
1417 MachineConstantPoolValue *getMachineCPVal() const {
1418 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1419 return Val.MachineCPVal;
1422 int getOffset() const {
1423 return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1426 // Return the alignment of this constant pool object, which is either 0 (for
1427 // default alignment) or the desired value.
1428 unsigned getAlignment() const { return Alignment; }
1429 unsigned char getTargetFlags() const { return TargetFlags; }
1431 Type *getType() const;
1433 static bool classof(const SDNode *N) {
1434 return N->getOpcode() == ISD::ConstantPool ||
1435 N->getOpcode() == ISD::TargetConstantPool;
1439 /// Completely target-dependent object reference.
1440 class TargetIndexSDNode : public SDNode {
1441 unsigned char TargetFlags;
1444 friend class SelectionDAG;
1447 TargetIndexSDNode(int Idx, EVT VT, int64_t Ofs, unsigned char TF)
1448 : SDNode(ISD::TargetIndex, 0, DebugLoc(), getSDVTList(VT)),
1449 TargetFlags(TF), Index(Idx), Offset(Ofs) {}
1452 unsigned char getTargetFlags() const { return TargetFlags; }
1453 int getIndex() const { return Index; }
1454 int64_t getOffset() const { return Offset; }
1456 static bool classof(const SDNode *N) {
1457 return N->getOpcode() == ISD::TargetIndex;
1461 class BasicBlockSDNode : public SDNode {
1462 MachineBasicBlock *MBB;
1463 friend class SelectionDAG;
1464 /// Debug info is meaningful and potentially useful here, but we create
1465 /// blocks out of order when they're jumped to, which makes it a bit
1466 /// harder. Let's see if we need it first.
1467 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1468 : SDNode(ISD::BasicBlock, 0, DebugLoc(), getSDVTList(MVT::Other)), MBB(mbb)
1472 MachineBasicBlock *getBasicBlock() const { return MBB; }
1474 static bool classof(const SDNode *N) {
1475 return N->getOpcode() == ISD::BasicBlock;
1479 /// BuildVectorSDNode - A "pseudo-class" with methods for operating on
1481 class BuildVectorSDNode : public SDNode {
1482 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1483 explicit BuildVectorSDNode() LLVM_DELETED_FUNCTION;
1485 /// isConstantSplat - Check if this is a constant splat, and if so, find the
1486 /// smallest element size that splats the vector. If MinSplatBits is
1487 /// nonzero, the element size must be at least that large. Note that the
1488 /// splat element may be the entire vector (i.e., a one element vector).
1489 /// Returns the splat element value in SplatValue. Any undefined bits in
1490 /// that value are zero, and the corresponding bits in the SplatUndef mask
1491 /// are set. The SplatBitSize value is set to the splat element size in
1492 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1493 /// undefined. isBigEndian describes the endianness of the target.
1494 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1495 unsigned &SplatBitSize, bool &HasAnyUndefs,
1496 unsigned MinSplatBits = 0, bool isBigEndian = false);
1498 bool isConstant() const;
1500 static inline bool classof(const SDNode *N) {
1501 return N->getOpcode() == ISD::BUILD_VECTOR;
1505 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1506 /// used when the SelectionDAG needs to make a simple reference to something
1507 /// in the LLVM IR representation.
1509 class SrcValueSDNode : public SDNode {
1511 friend class SelectionDAG;
1512 /// Create a SrcValue for a general value.
1513 explicit SrcValueSDNode(const Value *v)
1514 : SDNode(ISD::SRCVALUE, 0, DebugLoc(), getSDVTList(MVT::Other)), V(v) {}
1517 /// getValue - return the contained Value.
1518 const Value *getValue() const { return V; }
1520 static bool classof(const SDNode *N) {
1521 return N->getOpcode() == ISD::SRCVALUE;
1525 class MDNodeSDNode : public SDNode {
1527 friend class SelectionDAG;
1528 explicit MDNodeSDNode(const MDNode *md)
1529 : SDNode(ISD::MDNODE_SDNODE, 0, DebugLoc(), getSDVTList(MVT::Other)), MD(md)
1533 const MDNode *getMD() const { return MD; }
1535 static bool classof(const SDNode *N) {
1536 return N->getOpcode() == ISD::MDNODE_SDNODE;
1540 class RegisterSDNode : public SDNode {
1542 friend class SelectionDAG;
1543 RegisterSDNode(unsigned reg, EVT VT)
1544 : SDNode(ISD::Register, 0, DebugLoc(), getSDVTList(VT)), Reg(reg) {
1548 unsigned getReg() const { return Reg; }
1550 static bool classof(const SDNode *N) {
1551 return N->getOpcode() == ISD::Register;
1555 class RegisterMaskSDNode : public SDNode {
1556 // The memory for RegMask is not owned by the node.
1557 const uint32_t *RegMask;
1558 friend class SelectionDAG;
1559 RegisterMaskSDNode(const uint32_t *mask)
1560 : SDNode(ISD::RegisterMask, 0, DebugLoc(), getSDVTList(MVT::Untyped)),
1564 const uint32_t *getRegMask() const { return RegMask; }
1566 static bool classof(const SDNode *N) {
1567 return N->getOpcode() == ISD::RegisterMask;
1571 class BlockAddressSDNode : public SDNode {
1572 const BlockAddress *BA;
1574 unsigned char TargetFlags;
1575 friend class SelectionDAG;
1576 BlockAddressSDNode(unsigned NodeTy, EVT VT, const BlockAddress *ba,
1577 int64_t o, unsigned char Flags)
1578 : SDNode(NodeTy, 0, DebugLoc(), getSDVTList(VT)),
1579 BA(ba), Offset(o), TargetFlags(Flags) {
1582 const BlockAddress *getBlockAddress() const { return BA; }
1583 int64_t getOffset() const { return Offset; }
1584 unsigned char getTargetFlags() const { return TargetFlags; }
1586 static bool classof(const SDNode *N) {
1587 return N->getOpcode() == ISD::BlockAddress ||
1588 N->getOpcode() == ISD::TargetBlockAddress;
1592 class EHLabelSDNode : public SDNode {
1595 friend class SelectionDAG;
1596 EHLabelSDNode(unsigned Order, DebugLoc dl, SDValue ch, MCSymbol *L)
1597 : SDNode(ISD::EH_LABEL, Order, dl, getSDVTList(MVT::Other)), Label(L) {
1598 InitOperands(&Chain, ch);
1601 MCSymbol *getLabel() const { return Label; }
1603 static bool classof(const SDNode *N) {
1604 return N->getOpcode() == ISD::EH_LABEL;
1608 class ExternalSymbolSDNode : public SDNode {
1610 unsigned char TargetFlags;
1612 friend class SelectionDAG;
1613 ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
1614 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1615 0, DebugLoc(), getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
1619 const char *getSymbol() const { return Symbol; }
1620 unsigned char getTargetFlags() const { return TargetFlags; }
1622 static bool classof(const SDNode *N) {
1623 return N->getOpcode() == ISD::ExternalSymbol ||
1624 N->getOpcode() == ISD::TargetExternalSymbol;
1628 class CondCodeSDNode : public SDNode {
1629 ISD::CondCode Condition;
1630 friend class SelectionDAG;
1631 explicit CondCodeSDNode(ISD::CondCode Cond)
1632 : SDNode(ISD::CONDCODE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1637 ISD::CondCode get() const { return Condition; }
1639 static bool classof(const SDNode *N) {
1640 return N->getOpcode() == ISD::CONDCODE;
1644 /// CvtRndSatSDNode - NOTE: avoid using this node as this may disappear in the
1645 /// future and most targets don't support it.
1646 class CvtRndSatSDNode : public SDNode {
1647 ISD::CvtCode CvtCode;
1648 friend class SelectionDAG;
1649 explicit CvtRndSatSDNode(EVT VT, unsigned Order, DebugLoc dl,
1650 const SDValue *Ops, unsigned NumOps,
1652 : SDNode(ISD::CONVERT_RNDSAT, Order, dl, getSDVTList(VT), Ops, NumOps),
1654 assert(NumOps == 5 && "wrong number of operations");
1657 ISD::CvtCode getCvtCode() const { return CvtCode; }
1659 static bool classof(const SDNode *N) {
1660 return N->getOpcode() == ISD::CONVERT_RNDSAT;
1664 /// VTSDNode - This class is used to represent EVT's, which are used
1665 /// to parameterize some operations.
1666 class VTSDNode : public SDNode {
1668 friend class SelectionDAG;
1669 explicit VTSDNode(EVT VT)
1670 : SDNode(ISD::VALUETYPE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1675 EVT getVT() const { return ValueType; }
1677 static bool classof(const SDNode *N) {
1678 return N->getOpcode() == ISD::VALUETYPE;
1682 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1684 class LSBaseSDNode : public MemSDNode {
1685 //! Operand array for load and store
1687 \note Moving this array to the base class captures more
1688 common functionality shared between LoadSDNode and
1693 LSBaseSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
1694 SDValue *Operands, unsigned numOperands,
1695 SDVTList VTs, ISD::MemIndexedMode AM, EVT MemVT,
1696 MachineMemOperand *MMO)
1697 : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
1698 SubclassData |= AM << 2;
1699 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
1700 InitOperands(Ops, Operands, numOperands);
1701 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1702 "Only indexed loads and stores have a non-undef offset operand");
1705 const SDValue &getOffset() const {
1706 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1709 /// getAddressingMode - Return the addressing mode for this load or store:
1710 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
1711 ISD::MemIndexedMode getAddressingMode() const {
1712 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
1715 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1716 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
1718 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1719 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
1721 static bool classof(const SDNode *N) {
1722 return N->getOpcode() == ISD::LOAD ||
1723 N->getOpcode() == ISD::STORE;
1727 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1729 class LoadSDNode : public LSBaseSDNode {
1730 friend class SelectionDAG;
1731 LoadSDNode(SDValue *ChainPtrOff, unsigned Order, DebugLoc dl, SDVTList VTs,
1732 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT MemVT,
1733 MachineMemOperand *MMO)
1734 : LSBaseSDNode(ISD::LOAD, Order, dl, ChainPtrOff, 3, VTs, AM, MemVT, MMO) {
1735 SubclassData |= (unsigned short)ETy;
1736 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
1737 assert(readMem() && "Load MachineMemOperand is not a load!");
1738 assert(!writeMem() && "Load MachineMemOperand is a store!");
1742 /// getExtensionType - Return whether this is a plain node,
1743 /// or one of the varieties of value-extending loads.
1744 ISD::LoadExtType getExtensionType() const {
1745 return ISD::LoadExtType(SubclassData & 3);
1748 const SDValue &getBasePtr() const { return getOperand(1); }
1749 const SDValue &getOffset() const { return getOperand(2); }
1751 static bool classof(const SDNode *N) {
1752 return N->getOpcode() == ISD::LOAD;
1756 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
1758 class StoreSDNode : public LSBaseSDNode {
1759 friend class SelectionDAG;
1760 StoreSDNode(SDValue *ChainValuePtrOff, unsigned Order, DebugLoc dl,
1761 SDVTList VTs, ISD::MemIndexedMode AM, bool isTrunc, EVT MemVT,
1762 MachineMemOperand *MMO)
1763 : LSBaseSDNode(ISD::STORE, Order, dl, ChainValuePtrOff, 4,
1764 VTs, AM, MemVT, MMO) {
1765 SubclassData |= (unsigned short)isTrunc;
1766 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
1767 assert(!readMem() && "Store MachineMemOperand is a load!");
1768 assert(writeMem() && "Store MachineMemOperand is not a store!");
1772 /// isTruncatingStore - Return true if the op does a truncation before store.
1773 /// For integers this is the same as doing a TRUNCATE and storing the result.
1774 /// For floats, it is the same as doing an FP_ROUND and storing the result.
1775 bool isTruncatingStore() const { return SubclassData & 1; }
1777 const SDValue &getValue() const { return getOperand(1); }
1778 const SDValue &getBasePtr() const { return getOperand(2); }
1779 const SDValue &getOffset() const { return getOperand(3); }
1781 static bool classof(const SDNode *N) {
1782 return N->getOpcode() == ISD::STORE;
1786 /// MachineSDNode - An SDNode that represents everything that will be needed
1787 /// to construct a MachineInstr. These nodes are created during the
1788 /// instruction selection proper phase.
1790 class MachineSDNode : public SDNode {
1792 typedef MachineMemOperand **mmo_iterator;
1795 friend class SelectionDAG;
1796 MachineSDNode(unsigned Opc, unsigned Order, const DebugLoc DL, SDVTList VTs)
1797 : SDNode(Opc, Order, DL, VTs), MemRefs(0), MemRefsEnd(0) {}
1799 /// LocalOperands - Operands for this instruction, if they fit here. If
1800 /// they don't, this field is unused.
1801 SDUse LocalOperands[4];
1803 /// MemRefs - Memory reference descriptions for this instruction.
1804 mmo_iterator MemRefs;
1805 mmo_iterator MemRefsEnd;
1808 mmo_iterator memoperands_begin() const { return MemRefs; }
1809 mmo_iterator memoperands_end() const { return MemRefsEnd; }
1810 bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
1812 /// setMemRefs - Assign this MachineSDNodes's memory reference descriptor
1813 /// list. This does not transfer ownership.
1814 void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
1815 for (mmo_iterator MMI = NewMemRefs, MME = NewMemRefsEnd; MMI != MME; ++MMI)
1816 assert(*MMI && "Null mem ref detected!");
1817 MemRefs = NewMemRefs;
1818 MemRefsEnd = NewMemRefsEnd;
1821 static bool classof(const SDNode *N) {
1822 return N->isMachineOpcode();
1826 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
1827 SDNode, ptrdiff_t> {
1831 SDNodeIterator(const SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1833 bool operator==(const SDNodeIterator& x) const {
1834 return Operand == x.Operand;
1836 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1838 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1839 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1840 Operand = I.Operand;
1844 pointer operator*() const {
1845 return Node->getOperand(Operand).getNode();
1847 pointer operator->() const { return operator*(); }
1849 SDNodeIterator& operator++() { // Preincrement
1853 SDNodeIterator operator++(int) { // Postincrement
1854 SDNodeIterator tmp = *this; ++*this; return tmp;
1856 size_t operator-(SDNodeIterator Other) const {
1857 assert(Node == Other.Node &&
1858 "Cannot compare iterators of two different nodes!");
1859 return Operand - Other.Operand;
1862 static SDNodeIterator begin(const SDNode *N) { return SDNodeIterator(N, 0); }
1863 static SDNodeIterator end (const SDNode *N) {
1864 return SDNodeIterator(N, N->getNumOperands());
1867 unsigned getOperand() const { return Operand; }
1868 const SDNode *getNode() const { return Node; }
1871 template <> struct GraphTraits<SDNode*> {
1872 typedef SDNode NodeType;
1873 typedef SDNodeIterator ChildIteratorType;
1874 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1875 static inline ChildIteratorType child_begin(NodeType *N) {
1876 return SDNodeIterator::begin(N);
1878 static inline ChildIteratorType child_end(NodeType *N) {
1879 return SDNodeIterator::end(N);
1883 /// LargestSDNode - The largest SDNode class.
1885 typedef AtomicSDNode LargestSDNode;
1887 /// MostAlignedSDNode - The SDNode class with the greatest alignment
1890 typedef GlobalAddressSDNode MostAlignedSDNode;
1893 /// isNormalLoad - Returns true if the specified node is a non-extending
1894 /// and unindexed load.
1895 inline bool isNormalLoad(const SDNode *N) {
1896 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
1897 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
1898 Ld->getAddressingMode() == ISD::UNINDEXED;
1901 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1903 inline bool isNON_EXTLoad(const SDNode *N) {
1904 return isa<LoadSDNode>(N) &&
1905 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1908 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1910 inline bool isEXTLoad(const SDNode *N) {
1911 return isa<LoadSDNode>(N) &&
1912 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1915 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1917 inline bool isSEXTLoad(const SDNode *N) {
1918 return isa<LoadSDNode>(N) &&
1919 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1922 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1924 inline bool isZEXTLoad(const SDNode *N) {
1925 return isa<LoadSDNode>(N) &&
1926 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1929 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
1931 inline bool isUNINDEXEDLoad(const SDNode *N) {
1932 return isa<LoadSDNode>(N) &&
1933 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1936 /// isNormalStore - Returns true if the specified node is a non-truncating
1937 /// and unindexed store.
1938 inline bool isNormalStore(const SDNode *N) {
1939 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
1940 return St && !St->isTruncatingStore() &&
1941 St->getAddressingMode() == ISD::UNINDEXED;
1944 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1946 inline bool isNON_TRUNCStore(const SDNode *N) {
1947 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
1950 /// isTRUNCStore - Returns true if the specified node is a truncating
1952 inline bool isTRUNCStore(const SDNode *N) {
1953 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
1956 /// isUNINDEXEDStore - Returns true if the specified node is an
1957 /// unindexed store.
1958 inline bool isUNINDEXEDStore(const SDNode *N) {
1959 return isa<StoreSDNode>(N) &&
1960 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1964 } // end llvm namespace