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 /// 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 /// Return the simple ValueType of the referenced return value.
134 MVT getSimpleValueType() const {
135 return getValueType().getSimpleVT();
138 /// getValueSizeInBits - Returns the size of the value in bits.
140 unsigned getValueSizeInBits() const {
141 return getValueType().getSizeInBits();
144 // Forwarding methods - These forward to the corresponding methods in SDNode.
145 inline unsigned getOpcode() const;
146 inline unsigned getNumOperands() const;
147 inline const SDValue &getOperand(unsigned i) const;
148 inline uint64_t getConstantOperandVal(unsigned i) const;
149 inline bool isTargetMemoryOpcode() const;
150 inline bool isTargetOpcode() const;
151 inline bool isMachineOpcode() const;
152 inline unsigned getMachineOpcode() const;
153 inline const DebugLoc getDebugLoc() const;
154 inline void dump() const;
155 inline void dumpr() const;
157 /// reachesChainWithoutSideEffects - Return true if this operand (which must
158 /// be a chain) reaches the specified operand without crossing any
159 /// side-effecting instructions. In practice, this looks through token
160 /// factors and non-volatile loads. In order to remain efficient, this only
161 /// looks a couple of nodes in, it does not do an exhaustive search.
162 bool reachesChainWithoutSideEffects(SDValue Dest,
163 unsigned Depth = 2) const;
165 /// use_empty - Return true if there are no nodes using value ResNo
168 inline bool use_empty() const;
170 /// hasOneUse - Return true if there is exactly one node using value
173 inline bool hasOneUse() const;
177 template<> struct DenseMapInfo<SDValue> {
178 static inline SDValue getEmptyKey() {
179 return SDValue((SDNode*)-1, -1U);
181 static inline SDValue getTombstoneKey() {
182 return SDValue((SDNode*)-1, 0);
184 static unsigned getHashValue(const SDValue &Val) {
185 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
186 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
188 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
192 template <> struct isPodLike<SDValue> { static const bool value = true; };
195 /// simplify_type specializations - Allow casting operators to work directly on
196 /// SDValues as if they were SDNode*'s.
197 template<> struct simplify_type<SDValue> {
198 typedef SDNode* SimpleType;
199 static SimpleType getSimplifiedValue(SDValue &Val) {
200 return Val.getNode();
203 template<> struct simplify_type<const SDValue> {
204 typedef /*const*/ SDNode* SimpleType;
205 static SimpleType getSimplifiedValue(const SDValue &Val) {
206 return Val.getNode();
210 /// SDUse - Represents a use of a SDNode. This class holds an SDValue,
211 /// which records the SDNode being used and the result number, a
212 /// pointer to the SDNode using the value, and Next and Prev pointers,
213 /// which link together all the uses of an SDNode.
216 /// Val - The value being used.
218 /// User - The user of this value.
220 /// Prev, Next - Pointers to the uses list of the SDNode referred by
224 SDUse(const SDUse &U) LLVM_DELETED_FUNCTION;
225 void operator=(const SDUse &U) LLVM_DELETED_FUNCTION;
228 SDUse() : Val(), User(NULL), Prev(NULL), Next(NULL) {}
230 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
231 operator const SDValue&() const { return Val; }
233 /// If implicit conversion to SDValue doesn't work, the get() method returns
235 const SDValue &get() const { return Val; }
237 /// getUser - This returns the SDNode that contains this Use.
238 SDNode *getUser() { return User; }
240 /// getNext - Get the next SDUse in the use list.
241 SDUse *getNext() const { return Next; }
243 /// getNode - Convenience function for get().getNode().
244 SDNode *getNode() const { return Val.getNode(); }
245 /// getResNo - Convenience function for get().getResNo().
246 unsigned getResNo() const { return Val.getResNo(); }
247 /// getValueType - Convenience function for get().getValueType().
248 EVT getValueType() const { return Val.getValueType(); }
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 {
260 /// operator< - Convenience function for get().operator<
261 bool operator<(const SDValue &V) const {
266 friend class SelectionDAG;
269 void setUser(SDNode *p) { User = p; }
271 /// set - Remove this use from its existing use list, assign it the
272 /// given value, and add it to the new value's node's use list.
273 inline void set(const SDValue &V);
274 /// setInitial - like set, but only supports initializing a newly-allocated
275 /// SDUse with a non-null value.
276 inline void setInitial(const SDValue &V);
277 /// setNode - like set, but only sets the Node portion of the value,
278 /// leaving the ResNo portion unmodified.
279 inline void setNode(SDNode *N);
281 void addToList(SDUse **List) {
283 if (Next) Next->Prev = &Next;
288 void removeFromList() {
290 if (Next) Next->Prev = Prev;
294 /// simplify_type specializations - Allow casting operators to work directly on
295 /// SDValues as if they were SDNode*'s.
296 template<> struct simplify_type<SDUse> {
297 typedef SDNode* SimpleType;
298 static SimpleType getSimplifiedValue(SDUse &Val) {
299 return Val.getNode();
304 /// SDNode - Represents one node in the SelectionDAG.
306 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
308 /// NodeType - The operation that this node performs.
312 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
313 /// then they will be delete[]'d when the node is destroyed.
314 uint16_t OperandsNeedDelete : 1;
316 /// HasDebugValue - This tracks whether this node has one or more dbg_value
317 /// nodes corresponding to it.
318 uint16_t HasDebugValue : 1;
321 /// SubclassData - This member is defined by this class, but is not used for
322 /// anything. Subclasses can use it to hold whatever state they find useful.
323 /// This field is initialized to zero by the ctor.
324 uint16_t SubclassData : 14;
327 /// NodeId - Unique id per SDNode in the DAG.
330 /// OperandList - The values that are used by this operation.
334 /// ValueList - The types of the values this node defines. SDNode's may
335 /// define multiple values simultaneously.
336 const EVT *ValueList;
338 /// UseList - List of uses for this SDNode.
341 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
342 unsigned short NumOperands, NumValues;
344 /// debugLoc - source line information.
347 // The ordering of the SDNodes. It roughly corresponds to the ordering of the
348 // original LLVM instructions.
349 // This is used for turning off scheduling, because we'll forgo
350 // the normal scheduling algorithms and output the instructions according to
354 /// getValueTypeList - Return a pointer to the specified value type.
355 static const EVT *getValueTypeList(EVT VT);
357 friend class SelectionDAG;
358 friend struct ilist_traits<SDNode>;
361 //===--------------------------------------------------------------------===//
365 /// getOpcode - Return the SelectionDAG opcode value for this node. For
366 /// pre-isel nodes (those for which isMachineOpcode returns false), these
367 /// are the opcode values in the ISD and <target>ISD namespaces. For
368 /// post-isel opcodes, see getMachineOpcode.
369 unsigned getOpcode() const { return (unsigned short)NodeType; }
371 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
372 /// \<target\>ISD namespace).
373 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
375 /// isTargetMemoryOpcode - Test if this node has a target-specific
376 /// memory-referencing opcode (in the \<target\>ISD namespace and
377 /// greater than FIRST_TARGET_MEMORY_OPCODE).
378 bool isTargetMemoryOpcode() const {
379 return NodeType >= ISD::FIRST_TARGET_MEMORY_OPCODE;
382 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
383 /// corresponding to a MachineInstr opcode.
384 bool isMachineOpcode() const { return NodeType < 0; }
386 /// getMachineOpcode - This may only be called if isMachineOpcode returns
387 /// true. It returns the MachineInstr opcode value that the node's opcode
389 unsigned getMachineOpcode() const {
390 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
394 /// getHasDebugValue - get this bit.
395 bool getHasDebugValue() const { return HasDebugValue; }
397 /// setHasDebugValue - set this bit.
398 void setHasDebugValue(bool b) { HasDebugValue = b; }
400 /// use_empty - Return true if there are no uses of this node.
402 bool use_empty() const { return UseList == NULL; }
404 /// hasOneUse - Return true if there is exactly one use of this node.
406 bool hasOneUse() const {
407 return !use_empty() && llvm::next(use_begin()) == use_end();
410 /// use_size - Return the number of uses of this node. This method takes
411 /// time proportional to the number of uses.
413 size_t use_size() const { return std::distance(use_begin(), use_end()); }
415 /// getNodeId - Return the unique node id.
417 int getNodeId() const { return NodeId; }
419 /// setNodeId - Set unique node id.
420 void setNodeId(int Id) { NodeId = Id; }
422 /// getIROrder - Return the node ordering.
424 unsigned getIROrder() const { return IROrder; }
426 /// setIROrder - Set the node ordering.
428 void setIROrder(unsigned Order) { IROrder = Order; }
430 /// getDebugLoc - Return the source location info.
431 const DebugLoc getDebugLoc() const { return debugLoc; }
433 /// setDebugLoc - Set source location info. Try to avoid this, putting
434 /// it in the constructor is preferable.
435 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
437 /// use_iterator - This class provides iterator support for SDUse
438 /// operands that use a specific SDNode.
440 : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
442 explicit use_iterator(SDUse *op) : Op(op) {
446 typedef std::iterator<std::forward_iterator_tag,
447 SDUse, ptrdiff_t>::reference reference;
448 typedef std::iterator<std::forward_iterator_tag,
449 SDUse, ptrdiff_t>::pointer pointer;
451 use_iterator(const use_iterator &I) : Op(I.Op) {}
452 use_iterator() : Op(0) {}
454 bool operator==(const use_iterator &x) const {
457 bool operator!=(const use_iterator &x) const {
458 return !operator==(x);
461 /// atEnd - return true if this iterator is at the end of uses list.
462 bool atEnd() const { return Op == 0; }
464 // Iterator traversal: forward iteration only.
465 use_iterator &operator++() { // Preincrement
466 assert(Op && "Cannot increment end iterator!");
471 use_iterator operator++(int) { // Postincrement
472 use_iterator tmp = *this; ++*this; return tmp;
475 /// Retrieve a pointer to the current user node.
476 SDNode *operator*() const {
477 assert(Op && "Cannot dereference end iterator!");
478 return Op->getUser();
481 SDNode *operator->() const { return operator*(); }
483 SDUse &getUse() const { return *Op; }
485 /// getOperandNo - Retrieve the operand # of this use in its user.
487 unsigned getOperandNo() const {
488 assert(Op && "Cannot dereference end iterator!");
489 return (unsigned)(Op - Op->getUser()->OperandList);
493 /// use_begin/use_end - Provide iteration support to walk over all uses
496 use_iterator use_begin() const {
497 return use_iterator(UseList);
500 static use_iterator use_end() { return use_iterator(0); }
503 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
504 /// indicated value. This method ignores uses of other values defined by this
506 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
508 /// hasAnyUseOfValue - Return true if there are any use of the indicated
509 /// value. This method ignores uses of other values defined by this operation.
510 bool hasAnyUseOfValue(unsigned Value) const;
512 /// isOnlyUserOf - Return true if this node is the only use of N.
514 bool isOnlyUserOf(SDNode *N) const;
516 /// isOperandOf - Return true if this node is an operand of N.
518 bool isOperandOf(SDNode *N) const;
520 /// isPredecessorOf - Return true if this node is a predecessor of N.
521 /// NOTE: Implemented on top of hasPredecessor and every bit as
522 /// expensive. Use carefully.
523 bool isPredecessorOf(const SDNode *N) const {
524 return N->hasPredecessor(this);
527 /// hasPredecessor - Return true if N is a predecessor of this node.
528 /// N is either an operand of this node, or can be reached by recursively
529 /// traversing up the operands.
530 /// NOTE: This is an expensive method. Use it carefully.
531 bool hasPredecessor(const SDNode *N) const;
533 /// hasPredecesorHelper - Return true if N is a predecessor of this node.
534 /// N is either an operand of this node, or can be reached by recursively
535 /// traversing up the operands.
536 /// In this helper the Visited and worklist sets are held externally to
537 /// cache predecessors over multiple invocations. If you want to test for
538 /// multiple predecessors this method is preferable to multiple calls to
539 /// hasPredecessor. Be sure to clear Visited and Worklist if the DAG
541 /// NOTE: This is still very expensive. Use carefully.
542 bool hasPredecessorHelper(const SDNode *N,
543 SmallPtrSet<const SDNode *, 32> &Visited,
544 SmallVectorImpl<const SDNode *> &Worklist) const;
546 /// getNumOperands - Return the number of values used by this operation.
548 unsigned getNumOperands() const { return NumOperands; }
550 /// getConstantOperandVal - Helper method returns the integer value of a
551 /// ConstantSDNode operand.
552 uint64_t getConstantOperandVal(unsigned Num) const;
554 const SDValue &getOperand(unsigned Num) const {
555 assert(Num < NumOperands && "Invalid child # of SDNode!");
556 return OperandList[Num];
559 typedef SDUse* op_iterator;
560 op_iterator op_begin() const { return OperandList; }
561 op_iterator op_end() const { return OperandList+NumOperands; }
563 SDVTList getVTList() const {
564 SDVTList X = { ValueList, NumValues };
568 /// getGluedNode - If this node has a glue operand, return the node
569 /// to which the glue operand points. Otherwise return NULL.
570 SDNode *getGluedNode() const {
571 if (getNumOperands() != 0 &&
572 getOperand(getNumOperands()-1).getValueType() == MVT::Glue)
573 return getOperand(getNumOperands()-1).getNode();
577 // If this is a pseudo op, like copyfromreg, look to see if there is a
578 // real target node glued to it. If so, return the target node.
579 const SDNode *getGluedMachineNode() const {
580 const SDNode *FoundNode = this;
582 // Climb up glue edges until a machine-opcode node is found, or the
583 // end of the chain is reached.
584 while (!FoundNode->isMachineOpcode()) {
585 const SDNode *N = FoundNode->getGluedNode();
593 /// getGluedUser - If this node has a glue value with a user, return
594 /// the user (there is at most one). Otherwise return NULL.
595 SDNode *getGluedUser() const {
596 for (use_iterator UI = use_begin(), UE = use_end(); UI != UE; ++UI)
597 if (UI.getUse().get().getValueType() == MVT::Glue)
602 /// getNumValues - Return the number of values defined/returned by this
605 unsigned getNumValues() const { return NumValues; }
607 /// getValueType - Return the type of a specified result.
609 EVT getValueType(unsigned ResNo) const {
610 assert(ResNo < NumValues && "Illegal result number!");
611 return ValueList[ResNo];
614 /// Return the type of a specified result as a simple type.
616 MVT getSimpleValueType(unsigned ResNo) const {
617 return getValueType(ResNo).getSimpleVT();
620 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
622 unsigned getValueSizeInBits(unsigned ResNo) const {
623 return getValueType(ResNo).getSizeInBits();
626 typedef const EVT* value_iterator;
627 value_iterator value_begin() const { return ValueList; }
628 value_iterator value_end() const { return ValueList+NumValues; }
630 /// getOperationName - Return the opcode of this operation for printing.
632 std::string getOperationName(const SelectionDAG *G = 0) const;
633 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
634 void print_types(raw_ostream &OS, const SelectionDAG *G) const;
635 void print_details(raw_ostream &OS, const SelectionDAG *G) const;
636 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
637 void printr(raw_ostream &OS, const SelectionDAG *G = 0) const;
639 /// printrFull - Print a SelectionDAG node and all children down to
640 /// the leaves. The given SelectionDAG allows target-specific nodes
641 /// to be printed in human-readable form. Unlike printr, this will
642 /// print the whole DAG, including children that appear multiple
645 void printrFull(raw_ostream &O, const SelectionDAG *G = 0) const;
647 /// printrWithDepth - Print a SelectionDAG node and children up to
648 /// depth "depth." The given SelectionDAG allows target-specific
649 /// nodes to be printed in human-readable form. Unlike printr, this
650 /// will print children that appear multiple times wherever they are
653 void printrWithDepth(raw_ostream &O, const SelectionDAG *G = 0,
654 unsigned depth = 100) const;
657 /// dump - Dump this node, for debugging.
660 /// dumpr - Dump (recursively) this node and its use-def subgraph.
663 /// dump - Dump this node, for debugging.
664 /// The given SelectionDAG allows target-specific nodes to be printed
665 /// in human-readable form.
666 void dump(const SelectionDAG *G) const;
668 /// dumpr - Dump (recursively) this node and its use-def subgraph.
669 /// The given SelectionDAG allows target-specific nodes to be printed
670 /// in human-readable form.
671 void dumpr(const SelectionDAG *G) const;
673 /// dumprFull - printrFull to dbgs(). The given SelectionDAG allows
674 /// target-specific nodes to be printed in human-readable form.
675 /// Unlike dumpr, this will print the whole DAG, including children
676 /// that appear multiple times.
678 void dumprFull(const SelectionDAG *G = 0) const;
680 /// dumprWithDepth - printrWithDepth to dbgs(). The given
681 /// SelectionDAG allows target-specific nodes to be printed in
682 /// human-readable form. Unlike dumpr, this will print children
683 /// that appear multiple times wherever they are used.
685 void dumprWithDepth(const SelectionDAG *G = 0, unsigned depth = 100) const;
687 /// Profile - Gather unique data for the node.
689 void Profile(FoldingSetNodeID &ID) const;
691 /// addUse - This method should only be used by the SDUse class.
693 void addUse(SDUse &U) { U.addToList(&UseList); }
696 static SDVTList getSDVTList(EVT VT) {
697 SDVTList Ret = { getValueTypeList(VT), 1 };
701 SDNode(unsigned Opc, unsigned Order, const DebugLoc dl, SDVTList VTs,
702 const SDValue *Ops, unsigned NumOps)
703 : NodeType(Opc), OperandsNeedDelete(true), HasDebugValue(false),
704 SubclassData(0), NodeId(-1),
705 OperandList(NumOps ? new SDUse[NumOps] : 0),
706 ValueList(VTs.VTs), UseList(NULL),
707 NumOperands(NumOps), NumValues(VTs.NumVTs),
708 debugLoc(dl), IROrder(Order) {
709 for (unsigned i = 0; i != NumOps; ++i) {
710 OperandList[i].setUser(this);
711 OperandList[i].setInitial(Ops[i]);
713 checkForCycles(this);
716 /// This constructor adds no operands itself; operands can be
717 /// set later with InitOperands.
718 SDNode(unsigned Opc, unsigned Order, const DebugLoc dl, SDVTList VTs)
719 : NodeType(Opc), OperandsNeedDelete(false), HasDebugValue(false),
720 SubclassData(0), NodeId(-1), OperandList(0),
721 ValueList(VTs.VTs), UseList(NULL), NumOperands(0), NumValues(VTs.NumVTs),
722 debugLoc(dl), IROrder(Order) {}
724 /// InitOperands - Initialize the operands list of this with 1 operand.
725 void InitOperands(SDUse *Ops, const SDValue &Op0) {
726 Ops[0].setUser(this);
727 Ops[0].setInitial(Op0);
730 checkForCycles(this);
733 /// InitOperands - Initialize the operands list of this with 2 operands.
734 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
735 Ops[0].setUser(this);
736 Ops[0].setInitial(Op0);
737 Ops[1].setUser(this);
738 Ops[1].setInitial(Op1);
741 checkForCycles(this);
744 /// InitOperands - Initialize the operands list of this with 3 operands.
745 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
746 const SDValue &Op2) {
747 Ops[0].setUser(this);
748 Ops[0].setInitial(Op0);
749 Ops[1].setUser(this);
750 Ops[1].setInitial(Op1);
751 Ops[2].setUser(this);
752 Ops[2].setInitial(Op2);
755 checkForCycles(this);
758 /// InitOperands - Initialize the operands list of this with 4 operands.
759 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
760 const SDValue &Op2, const SDValue &Op3) {
761 Ops[0].setUser(this);
762 Ops[0].setInitial(Op0);
763 Ops[1].setUser(this);
764 Ops[1].setInitial(Op1);
765 Ops[2].setUser(this);
766 Ops[2].setInitial(Op2);
767 Ops[3].setUser(this);
768 Ops[3].setInitial(Op3);
771 checkForCycles(this);
774 /// InitOperands - Initialize the operands list of this with N operands.
775 void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
776 for (unsigned i = 0; i != N; ++i) {
777 Ops[i].setUser(this);
778 Ops[i].setInitial(Vals[i]);
782 checkForCycles(this);
785 /// DropOperands - Release the operands and set this node to have
790 /// Wrapper class for IR location info (IR ordering and DebugLoc) to be passed
791 /// into SDNode creation functions.
792 /// When an SDNode is created from the DAGBuilder, the DebugLoc is extracted
793 /// from the original Instruction, and IROrder is the ordinal position of
795 /// When an SDNode is created after the DAG is being built, both DebugLoc and
796 /// the IROrder are propagated from the original SDNode.
797 /// So SDLoc class provides two constructors besides the default one, one to
798 /// be used by the DAGBuilder, the other to be used by others.
801 // Ptr could be used for either Instruction* or SDNode*. It is used for
802 // Instruction* if IROrder is not -1.
807 SDLoc() : Ptr(NULL), IROrder(0) {}
808 SDLoc(const SDNode *N) : Ptr(N), IROrder(-1) {
809 assert(N && "null SDNode");
811 SDLoc(const SDValue V) : Ptr(V.getNode()), IROrder(-1) {
812 assert(Ptr && "null SDNode");
814 SDLoc(const Instruction *I, int Order) : Ptr(I), IROrder(Order) {
815 assert(Order >= 0 && "bad IROrder");
817 unsigned getIROrder() {
818 if (IROrder >= 0 || Ptr == NULL) {
819 return (unsigned)IROrder;
821 const SDNode *N = (const SDNode*)(Ptr);
822 return N->getIROrder();
824 DebugLoc getDebugLoc() {
829 const Instruction *I = (const Instruction*)(Ptr);
830 return I->getDebugLoc();
832 const SDNode *N = (const SDNode*)(Ptr);
833 return N->getDebugLoc();
838 // Define inline functions from the SDValue class.
840 inline unsigned SDValue::getOpcode() const {
841 return Node->getOpcode();
843 inline EVT SDValue::getValueType() const {
844 return Node->getValueType(ResNo);
846 inline unsigned SDValue::getNumOperands() const {
847 return Node->getNumOperands();
849 inline const SDValue &SDValue::getOperand(unsigned i) const {
850 return Node->getOperand(i);
852 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
853 return Node->getConstantOperandVal(i);
855 inline bool SDValue::isTargetOpcode() const {
856 return Node->isTargetOpcode();
858 inline bool SDValue::isTargetMemoryOpcode() const {
859 return Node->isTargetMemoryOpcode();
861 inline bool SDValue::isMachineOpcode() const {
862 return Node->isMachineOpcode();
864 inline unsigned SDValue::getMachineOpcode() const {
865 return Node->getMachineOpcode();
867 inline bool SDValue::use_empty() const {
868 return !Node->hasAnyUseOfValue(ResNo);
870 inline bool SDValue::hasOneUse() const {
871 return Node->hasNUsesOfValue(1, ResNo);
873 inline const DebugLoc SDValue::getDebugLoc() const {
874 return Node->getDebugLoc();
876 inline void SDValue::dump() const {
879 inline void SDValue::dumpr() const {
880 return Node->dumpr();
882 // Define inline functions from the SDUse class.
884 inline void SDUse::set(const SDValue &V) {
885 if (Val.getNode()) removeFromList();
887 if (V.getNode()) V.getNode()->addUse(*this);
890 inline void SDUse::setInitial(const SDValue &V) {
892 V.getNode()->addUse(*this);
895 inline void SDUse::setNode(SDNode *N) {
896 if (Val.getNode()) removeFromList();
898 if (N) N->addUse(*this);
901 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
902 /// to allow co-allocation of node operands with the node itself.
903 class UnarySDNode : public SDNode {
906 UnarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
908 : SDNode(Opc, Order, dl, VTs) {
909 InitOperands(&Op, X);
913 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
914 /// to allow co-allocation of node operands with the node itself.
915 class BinarySDNode : public SDNode {
918 BinarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
919 SDValue X, SDValue Y)
920 : SDNode(Opc, Order, dl, VTs) {
921 InitOperands(Ops, X, Y);
925 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
926 /// to allow co-allocation of node operands with the node itself.
927 class TernarySDNode : public SDNode {
930 TernarySDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
931 SDValue X, SDValue Y, SDValue Z)
932 : SDNode(Opc, Order, dl, VTs) {
933 InitOperands(Ops, X, Y, Z);
938 /// HandleSDNode - This class is used to form a handle around another node that
939 /// is persistent and is updated across invocations of replaceAllUsesWith on its
940 /// operand. This node should be directly created by end-users and not added to
941 /// the AllNodes list.
942 class HandleSDNode : public SDNode {
945 explicit HandleSDNode(SDValue X)
946 : SDNode(ISD::HANDLENODE, 0, DebugLoc(), getSDVTList(MVT::Other)) {
947 InitOperands(&Op, X);
950 const SDValue &getValue() const { return Op; }
953 /// Abstact virtual class for operations for memory operations
954 class MemSDNode : public SDNode {
956 // MemoryVT - VT of in-memory value.
960 /// MMO - Memory reference information.
961 MachineMemOperand *MMO;
964 MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
965 EVT MemoryVT, MachineMemOperand *MMO);
967 MemSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
969 unsigned NumOps, EVT MemoryVT, MachineMemOperand *MMO);
971 bool readMem() const { return MMO->isLoad(); }
972 bool writeMem() const { return MMO->isStore(); }
974 /// Returns alignment and volatility of the memory access
975 unsigned getOriginalAlignment() const {
976 return MMO->getBaseAlignment();
978 unsigned getAlignment() const {
979 return MMO->getAlignment();
982 /// getRawSubclassData - Return the SubclassData value, which contains an
983 /// encoding of the volatile flag, as well as bits used by subclasses. This
984 /// function should only be used to compute a FoldingSetNodeID value.
985 unsigned getRawSubclassData() const {
989 // We access subclass data here so that we can check consistency
990 // with MachineMemOperand information.
991 bool isVolatile() const { return (SubclassData >> 5) & 1; }
992 bool isNonTemporal() const { return (SubclassData >> 6) & 1; }
993 bool isInvariant() const { return (SubclassData >> 7) & 1; }
995 AtomicOrdering getOrdering() const {
996 return AtomicOrdering((SubclassData >> 8) & 15);
998 SynchronizationScope getSynchScope() const {
999 return SynchronizationScope((SubclassData >> 12) & 1);
1002 /// Returns the SrcValue and offset that describes the location of the access
1003 const Value *getSrcValue() const { return MMO->getValue(); }
1004 int64_t getSrcValueOffset() const { return MMO->getOffset(); }
1006 /// Returns the TBAAInfo that describes the dereference.
1007 const MDNode *getTBAAInfo() const { return MMO->getTBAAInfo(); }
1009 /// Returns the Ranges that describes the dereference.
1010 const MDNode *getRanges() const { return MMO->getRanges(); }
1012 /// getMemoryVT - Return the type of the in-memory value.
1013 EVT getMemoryVT() const { return MemoryVT; }
1015 /// getMemOperand - Return a MachineMemOperand object describing the memory
1016 /// reference performed by operation.
1017 MachineMemOperand *getMemOperand() const { return MMO; }
1019 const MachinePointerInfo &getPointerInfo() const {
1020 return MMO->getPointerInfo();
1023 /// getAddressSpace - Return the address space for the associated pointer
1024 unsigned getAddressSpace() const {
1025 return getPointerInfo().getAddrSpace();
1028 /// refineAlignment - Update this MemSDNode's MachineMemOperand information
1029 /// to reflect the alignment of NewMMO, if it has a greater alignment.
1030 /// This must only be used when the new alignment applies to all users of
1031 /// this MachineMemOperand.
1032 void refineAlignment(const MachineMemOperand *NewMMO) {
1033 MMO->refineAlignment(NewMMO);
1036 const SDValue &getChain() const { return getOperand(0); }
1037 const SDValue &getBasePtr() const {
1038 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1041 // Methods to support isa and dyn_cast
1042 static bool classof(const SDNode *N) {
1043 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1044 // with either an intrinsic or a target opcode.
1045 return N->getOpcode() == ISD::LOAD ||
1046 N->getOpcode() == ISD::STORE ||
1047 N->getOpcode() == ISD::PREFETCH ||
1048 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1049 N->getOpcode() == ISD::ATOMIC_SWAP ||
1050 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1051 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1052 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1053 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1054 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1055 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1056 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1057 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1058 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1059 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1060 N->getOpcode() == ISD::ATOMIC_LOAD ||
1061 N->getOpcode() == ISD::ATOMIC_STORE ||
1062 N->isTargetMemoryOpcode();
1066 /// AtomicSDNode - A SDNode reprenting atomic operations.
1068 class AtomicSDNode : public MemSDNode {
1071 void InitAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope) {
1072 // This must match encodeMemSDNodeFlags() in SelectionDAG.cpp.
1073 assert((Ordering & 15) == Ordering &&
1074 "Ordering may not require more than 4 bits!");
1075 assert((SynchScope & 1) == SynchScope &&
1076 "SynchScope may not require more than 1 bit!");
1077 SubclassData |= Ordering << 8;
1078 SubclassData |= SynchScope << 12;
1079 assert(getOrdering() == Ordering && "Ordering encoding error!");
1080 assert(getSynchScope() == SynchScope && "Synch-scope encoding error!");
1084 // Opc: opcode for atomic
1085 // VTL: value type list
1086 // Chain: memory chain for operaand
1087 // Ptr: address to update as a SDValue
1088 // Cmp: compare value
1090 // SrcVal: address to update as a Value (used for MemOperand)
1091 // Align: alignment of memory
1092 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1094 SDValue Chain, SDValue Ptr,
1095 SDValue Cmp, SDValue Swp, MachineMemOperand *MMO,
1096 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1097 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1098 InitAtomic(Ordering, SynchScope);
1099 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1101 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1103 SDValue Chain, SDValue Ptr,
1104 SDValue Val, MachineMemOperand *MMO,
1105 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1106 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1107 InitAtomic(Ordering, SynchScope);
1108 InitOperands(Ops, Chain, Ptr, Val);
1110 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL,
1112 SDValue Chain, SDValue Ptr,
1113 MachineMemOperand *MMO,
1114 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1115 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1116 InitAtomic(Ordering, SynchScope);
1117 InitOperands(Ops, Chain, Ptr);
1119 AtomicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTL, EVT MemVT,
1120 SDValue* AllOps, SDUse *DynOps, unsigned NumOps,
1121 MachineMemOperand *MMO,
1122 AtomicOrdering Ordering, SynchronizationScope SynchScope)
1123 : MemSDNode(Opc, Order, dl, VTL, MemVT, MMO) {
1124 InitAtomic(Ordering, SynchScope);
1125 assert((DynOps || NumOps <= array_lengthof(Ops)) &&
1126 "Too many ops for internal storage!");
1127 InitOperands(DynOps ? DynOps : Ops, AllOps, NumOps);
1130 const SDValue &getBasePtr() const { return getOperand(1); }
1131 const SDValue &getVal() const { return getOperand(2); }
1133 bool isCompareAndSwap() const {
1134 unsigned Op = getOpcode();
1135 return Op == ISD::ATOMIC_CMP_SWAP;
1138 // Methods to support isa and dyn_cast
1139 static bool classof(const SDNode *N) {
1140 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1141 N->getOpcode() == ISD::ATOMIC_SWAP ||
1142 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1143 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1144 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1145 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1146 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1147 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1148 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1149 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1150 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1151 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1152 N->getOpcode() == ISD::ATOMIC_LOAD ||
1153 N->getOpcode() == ISD::ATOMIC_STORE;
1157 /// MemIntrinsicSDNode - This SDNode is used for target intrinsics that touch
1158 /// memory and need an associated MachineMemOperand. Its opcode may be
1159 /// INTRINSIC_VOID, INTRINSIC_W_CHAIN, PREFETCH, or a target-specific opcode
1160 /// with a value not less than FIRST_TARGET_MEMORY_OPCODE.
1161 class MemIntrinsicSDNode : public MemSDNode {
1163 MemIntrinsicSDNode(unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs,
1164 const SDValue *Ops, unsigned NumOps,
1165 EVT MemoryVT, MachineMemOperand *MMO)
1166 : MemSDNode(Opc, Order, dl, VTs, Ops, NumOps, MemoryVT, MMO) {
1169 // Methods to support isa and dyn_cast
1170 static bool classof(const SDNode *N) {
1171 // We lower some target intrinsics to their target opcode
1172 // early a node with a target opcode can be of this class
1173 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1174 N->getOpcode() == ISD::INTRINSIC_VOID ||
1175 N->getOpcode() == ISD::PREFETCH ||
1176 N->isTargetMemoryOpcode();
1180 /// ShuffleVectorSDNode - This SDNode is used to implement the code generator
1181 /// support for the llvm IR shufflevector instruction. It combines elements
1182 /// from two input vectors into a new input vector, with the selection and
1183 /// ordering of elements determined by an array of integers, referred to as
1184 /// the shuffle mask. For input vectors of width N, mask indices of 0..N-1
1185 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1186 /// An index of -1 is treated as undef, such that the code generator may put
1187 /// any value in the corresponding element of the result.
1188 class ShuffleVectorSDNode : public SDNode {
1191 // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1192 // is freed when the SelectionDAG object is destroyed.
1195 friend class SelectionDAG;
1196 ShuffleVectorSDNode(EVT VT, unsigned Order, DebugLoc dl, SDValue N1,
1197 SDValue N2, const int *M)
1198 : SDNode(ISD::VECTOR_SHUFFLE, Order, dl, getSDVTList(VT)), Mask(M) {
1199 InitOperands(Ops, N1, N2);
1203 ArrayRef<int> getMask() const {
1204 EVT VT = getValueType(0);
1205 return makeArrayRef(Mask, VT.getVectorNumElements());
1207 int getMaskElt(unsigned Idx) const {
1208 assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1212 bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1213 int getSplatIndex() const {
1214 assert(isSplat() && "Cannot get splat index for non-splat!");
1215 EVT VT = getValueType(0);
1216 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i) {
1220 llvm_unreachable("Splat with all undef indices?");
1222 static bool isSplatMask(const int *Mask, EVT VT);
1224 static bool classof(const SDNode *N) {
1225 return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1229 class ConstantSDNode : public SDNode {
1230 const ConstantInt *Value;
1231 friend class SelectionDAG;
1232 ConstantSDNode(bool isTarget, const ConstantInt *val, EVT VT)
1233 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1234 0, DebugLoc(), getSDVTList(VT)), Value(val) {
1238 const ConstantInt *getConstantIntValue() const { return Value; }
1239 const APInt &getAPIntValue() const { return Value->getValue(); }
1240 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1241 int64_t getSExtValue() const { return Value->getSExtValue(); }
1243 bool isOne() const { return Value->isOne(); }
1244 bool isNullValue() const { return Value->isNullValue(); }
1245 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1247 static bool classof(const SDNode *N) {
1248 return N->getOpcode() == ISD::Constant ||
1249 N->getOpcode() == ISD::TargetConstant;
1253 class ConstantFPSDNode : public SDNode {
1254 const ConstantFP *Value;
1255 friend class SelectionDAG;
1256 ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1257 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1258 0, DebugLoc(), getSDVTList(VT)), Value(val) {
1262 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1263 const ConstantFP *getConstantFPValue() const { return Value; }
1265 /// isZero - Return true if the value is positive or negative zero.
1266 bool isZero() const { return Value->isZero(); }
1268 /// isNaN - Return true if the value is a NaN.
1269 bool isNaN() const { return Value->isNaN(); }
1271 /// isExactlyValue - We don't rely on operator== working on double values, as
1272 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1273 /// As such, this method can be used to do an exact bit-for-bit comparison of
1274 /// two floating point values.
1276 /// We leave the version with the double argument here because it's just so
1277 /// convenient to write "2.0" and the like. Without this function we'd
1278 /// have to duplicate its logic everywhere it's called.
1279 bool isExactlyValue(double V) const {
1282 Tmp.convert(Value->getValueAPF().getSemantics(),
1283 APFloat::rmNearestTiesToEven, &ignored);
1284 return isExactlyValue(Tmp);
1286 bool isExactlyValue(const APFloat& V) const;
1288 static bool isValueValidForType(EVT VT, const APFloat& Val);
1290 static bool classof(const SDNode *N) {
1291 return N->getOpcode() == ISD::ConstantFP ||
1292 N->getOpcode() == ISD::TargetConstantFP;
1296 class GlobalAddressSDNode : public SDNode {
1297 const GlobalValue *TheGlobal;
1299 unsigned char TargetFlags;
1300 friend class SelectionDAG;
1301 GlobalAddressSDNode(unsigned Opc, unsigned Order, DebugLoc DL,
1302 const GlobalValue *GA, EVT VT, int64_t o,
1303 unsigned char TargetFlags);
1306 const GlobalValue *getGlobal() const { return TheGlobal; }
1307 int64_t getOffset() const { return Offset; }
1308 unsigned char getTargetFlags() const { return TargetFlags; }
1309 // Return the address space this GlobalAddress belongs to.
1310 unsigned getAddressSpace() const;
1312 static bool classof(const SDNode *N) {
1313 return N->getOpcode() == ISD::GlobalAddress ||
1314 N->getOpcode() == ISD::TargetGlobalAddress ||
1315 N->getOpcode() == ISD::GlobalTLSAddress ||
1316 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1320 class FrameIndexSDNode : public SDNode {
1322 friend class SelectionDAG;
1323 FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1324 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1325 0, DebugLoc(), getSDVTList(VT)), FI(fi) {
1329 int getIndex() const { return FI; }
1331 static bool classof(const SDNode *N) {
1332 return N->getOpcode() == ISD::FrameIndex ||
1333 N->getOpcode() == ISD::TargetFrameIndex;
1337 class JumpTableSDNode : public SDNode {
1339 unsigned char TargetFlags;
1340 friend class SelectionDAG;
1341 JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1342 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1343 0, DebugLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1347 int getIndex() const { return JTI; }
1348 unsigned char getTargetFlags() const { return TargetFlags; }
1350 static bool classof(const SDNode *N) {
1351 return N->getOpcode() == ISD::JumpTable ||
1352 N->getOpcode() == ISD::TargetJumpTable;
1356 class ConstantPoolSDNode : public SDNode {
1358 const Constant *ConstVal;
1359 MachineConstantPoolValue *MachineCPVal;
1361 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1362 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1363 unsigned char TargetFlags;
1364 friend class SelectionDAG;
1365 ConstantPoolSDNode(bool isTarget, const Constant *c, EVT VT, int o,
1366 unsigned Align, unsigned char TF)
1367 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1368 DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1370 assert(Offset >= 0 && "Offset is too large");
1373 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1374 EVT VT, int o, unsigned Align, unsigned char TF)
1375 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 0,
1376 DebugLoc(), getSDVTList(VT)), Offset(o), Alignment(Align),
1378 assert(Offset >= 0 && "Offset is too large");
1379 Val.MachineCPVal = v;
1380 Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1384 bool isMachineConstantPoolEntry() const {
1388 const Constant *getConstVal() const {
1389 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1390 return Val.ConstVal;
1393 MachineConstantPoolValue *getMachineCPVal() const {
1394 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1395 return Val.MachineCPVal;
1398 int getOffset() const {
1399 return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1402 // Return the alignment of this constant pool object, which is either 0 (for
1403 // default alignment) or the desired value.
1404 unsigned getAlignment() const { return Alignment; }
1405 unsigned char getTargetFlags() const { return TargetFlags; }
1407 Type *getType() const;
1409 static bool classof(const SDNode *N) {
1410 return N->getOpcode() == ISD::ConstantPool ||
1411 N->getOpcode() == ISD::TargetConstantPool;
1415 /// Completely target-dependent object reference.
1416 class TargetIndexSDNode : public SDNode {
1417 unsigned char TargetFlags;
1420 friend class SelectionDAG;
1423 TargetIndexSDNode(int Idx, EVT VT, int64_t Ofs, unsigned char TF)
1424 : SDNode(ISD::TargetIndex, 0, DebugLoc(), getSDVTList(VT)),
1425 TargetFlags(TF), Index(Idx), Offset(Ofs) {}
1428 unsigned char getTargetFlags() const { return TargetFlags; }
1429 int getIndex() const { return Index; }
1430 int64_t getOffset() const { return Offset; }
1432 static bool classof(const SDNode *N) {
1433 return N->getOpcode() == ISD::TargetIndex;
1437 class BasicBlockSDNode : public SDNode {
1438 MachineBasicBlock *MBB;
1439 friend class SelectionDAG;
1440 /// Debug info is meaningful and potentially useful here, but we create
1441 /// blocks out of order when they're jumped to, which makes it a bit
1442 /// harder. Let's see if we need it first.
1443 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1444 : SDNode(ISD::BasicBlock, 0, DebugLoc(), getSDVTList(MVT::Other)), MBB(mbb)
1448 MachineBasicBlock *getBasicBlock() const { return MBB; }
1450 static bool classof(const SDNode *N) {
1451 return N->getOpcode() == ISD::BasicBlock;
1455 /// BuildVectorSDNode - A "pseudo-class" with methods for operating on
1457 class BuildVectorSDNode : public SDNode {
1458 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1459 explicit BuildVectorSDNode() LLVM_DELETED_FUNCTION;
1461 /// isConstantSplat - Check if this is a constant splat, and if so, find the
1462 /// smallest element size that splats the vector. If MinSplatBits is
1463 /// nonzero, the element size must be at least that large. Note that the
1464 /// splat element may be the entire vector (i.e., a one element vector).
1465 /// Returns the splat element value in SplatValue. Any undefined bits in
1466 /// that value are zero, and the corresponding bits in the SplatUndef mask
1467 /// are set. The SplatBitSize value is set to the splat element size in
1468 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1469 /// undefined. isBigEndian describes the endianness of the target.
1470 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1471 unsigned &SplatBitSize, bool &HasAnyUndefs,
1472 unsigned MinSplatBits = 0, bool isBigEndian = false);
1474 static inline bool classof(const SDNode *N) {
1475 return N->getOpcode() == ISD::BUILD_VECTOR;
1479 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1480 /// used when the SelectionDAG needs to make a simple reference to something
1481 /// in the LLVM IR representation.
1483 class SrcValueSDNode : public SDNode {
1485 friend class SelectionDAG;
1486 /// Create a SrcValue for a general value.
1487 explicit SrcValueSDNode(const Value *v)
1488 : SDNode(ISD::SRCVALUE, 0, DebugLoc(), getSDVTList(MVT::Other)), V(v) {}
1491 /// getValue - return the contained Value.
1492 const Value *getValue() const { return V; }
1494 static bool classof(const SDNode *N) {
1495 return N->getOpcode() == ISD::SRCVALUE;
1499 class MDNodeSDNode : public SDNode {
1501 friend class SelectionDAG;
1502 explicit MDNodeSDNode(const MDNode *md)
1503 : SDNode(ISD::MDNODE_SDNODE, 0, DebugLoc(), getSDVTList(MVT::Other)), MD(md)
1507 const MDNode *getMD() const { return MD; }
1509 static bool classof(const SDNode *N) {
1510 return N->getOpcode() == ISD::MDNODE_SDNODE;
1514 class RegisterSDNode : public SDNode {
1516 friend class SelectionDAG;
1517 RegisterSDNode(unsigned reg, EVT VT)
1518 : SDNode(ISD::Register, 0, DebugLoc(), getSDVTList(VT)), Reg(reg) {
1522 unsigned getReg() const { return Reg; }
1524 static bool classof(const SDNode *N) {
1525 return N->getOpcode() == ISD::Register;
1529 class RegisterMaskSDNode : public SDNode {
1530 // The memory for RegMask is not owned by the node.
1531 const uint32_t *RegMask;
1532 friend class SelectionDAG;
1533 RegisterMaskSDNode(const uint32_t *mask)
1534 : SDNode(ISD::RegisterMask, 0, DebugLoc(), getSDVTList(MVT::Untyped)),
1538 const uint32_t *getRegMask() const { return RegMask; }
1540 static bool classof(const SDNode *N) {
1541 return N->getOpcode() == ISD::RegisterMask;
1545 class BlockAddressSDNode : public SDNode {
1546 const BlockAddress *BA;
1548 unsigned char TargetFlags;
1549 friend class SelectionDAG;
1550 BlockAddressSDNode(unsigned NodeTy, EVT VT, const BlockAddress *ba,
1551 int64_t o, unsigned char Flags)
1552 : SDNode(NodeTy, 0, DebugLoc(), getSDVTList(VT)),
1553 BA(ba), Offset(o), TargetFlags(Flags) {
1556 const BlockAddress *getBlockAddress() const { return BA; }
1557 int64_t getOffset() const { return Offset; }
1558 unsigned char getTargetFlags() const { return TargetFlags; }
1560 static bool classof(const SDNode *N) {
1561 return N->getOpcode() == ISD::BlockAddress ||
1562 N->getOpcode() == ISD::TargetBlockAddress;
1566 class EHLabelSDNode : public SDNode {
1569 friend class SelectionDAG;
1570 EHLabelSDNode(unsigned Order, DebugLoc dl, SDValue ch, MCSymbol *L)
1571 : SDNode(ISD::EH_LABEL, Order, dl, getSDVTList(MVT::Other)), Label(L) {
1572 InitOperands(&Chain, ch);
1575 MCSymbol *getLabel() const { return Label; }
1577 static bool classof(const SDNode *N) {
1578 return N->getOpcode() == ISD::EH_LABEL;
1582 class ExternalSymbolSDNode : public SDNode {
1584 unsigned char TargetFlags;
1586 friend class SelectionDAG;
1587 ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
1588 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1589 0, DebugLoc(), getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
1593 const char *getSymbol() const { return Symbol; }
1594 unsigned char getTargetFlags() const { return TargetFlags; }
1596 static bool classof(const SDNode *N) {
1597 return N->getOpcode() == ISD::ExternalSymbol ||
1598 N->getOpcode() == ISD::TargetExternalSymbol;
1602 class CondCodeSDNode : public SDNode {
1603 ISD::CondCode Condition;
1604 friend class SelectionDAG;
1605 explicit CondCodeSDNode(ISD::CondCode Cond)
1606 : SDNode(ISD::CONDCODE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1611 ISD::CondCode get() const { return Condition; }
1613 static bool classof(const SDNode *N) {
1614 return N->getOpcode() == ISD::CONDCODE;
1618 /// CvtRndSatSDNode - NOTE: avoid using this node as this may disappear in the
1619 /// future and most targets don't support it.
1620 class CvtRndSatSDNode : public SDNode {
1621 ISD::CvtCode CvtCode;
1622 friend class SelectionDAG;
1623 explicit CvtRndSatSDNode(EVT VT, unsigned Order, DebugLoc dl,
1624 const SDValue *Ops, unsigned NumOps,
1626 : SDNode(ISD::CONVERT_RNDSAT, Order, dl, getSDVTList(VT), Ops, NumOps),
1628 assert(NumOps == 5 && "wrong number of operations");
1631 ISD::CvtCode getCvtCode() const { return CvtCode; }
1633 static bool classof(const SDNode *N) {
1634 return N->getOpcode() == ISD::CONVERT_RNDSAT;
1638 /// VTSDNode - This class is used to represent EVT's, which are used
1639 /// to parameterize some operations.
1640 class VTSDNode : public SDNode {
1642 friend class SelectionDAG;
1643 explicit VTSDNode(EVT VT)
1644 : SDNode(ISD::VALUETYPE, 0, DebugLoc(), getSDVTList(MVT::Other)),
1649 EVT getVT() const { return ValueType; }
1651 static bool classof(const SDNode *N) {
1652 return N->getOpcode() == ISD::VALUETYPE;
1656 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1658 class LSBaseSDNode : public MemSDNode {
1659 //! Operand array for load and store
1661 \note Moving this array to the base class captures more
1662 common functionality shared between LoadSDNode and
1667 LSBaseSDNode(ISD::NodeType NodeTy, unsigned Order, DebugLoc dl,
1668 SDValue *Operands, unsigned numOperands,
1669 SDVTList VTs, ISD::MemIndexedMode AM, EVT MemVT,
1670 MachineMemOperand *MMO)
1671 : MemSDNode(NodeTy, Order, dl, VTs, MemVT, MMO) {
1672 SubclassData |= AM << 2;
1673 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
1674 InitOperands(Ops, Operands, numOperands);
1675 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1676 "Only indexed loads and stores have a non-undef offset operand");
1679 const SDValue &getOffset() const {
1680 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1683 /// getAddressingMode - Return the addressing mode for this load or store:
1684 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
1685 ISD::MemIndexedMode getAddressingMode() const {
1686 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
1689 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1690 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
1692 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1693 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
1695 static bool classof(const SDNode *N) {
1696 return N->getOpcode() == ISD::LOAD ||
1697 N->getOpcode() == ISD::STORE;
1701 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1703 class LoadSDNode : public LSBaseSDNode {
1704 friend class SelectionDAG;
1705 LoadSDNode(SDValue *ChainPtrOff, unsigned Order, DebugLoc dl, SDVTList VTs,
1706 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT MemVT,
1707 MachineMemOperand *MMO)
1708 : LSBaseSDNode(ISD::LOAD, Order, dl, ChainPtrOff, 3, VTs, AM, MemVT, MMO) {
1709 SubclassData |= (unsigned short)ETy;
1710 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
1711 assert(readMem() && "Load MachineMemOperand is not a load!");
1712 assert(!writeMem() && "Load MachineMemOperand is a store!");
1716 /// getExtensionType - Return whether this is a plain node,
1717 /// or one of the varieties of value-extending loads.
1718 ISD::LoadExtType getExtensionType() const {
1719 return ISD::LoadExtType(SubclassData & 3);
1722 const SDValue &getBasePtr() const { return getOperand(1); }
1723 const SDValue &getOffset() const { return getOperand(2); }
1725 static bool classof(const SDNode *N) {
1726 return N->getOpcode() == ISD::LOAD;
1730 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
1732 class StoreSDNode : public LSBaseSDNode {
1733 friend class SelectionDAG;
1734 StoreSDNode(SDValue *ChainValuePtrOff, unsigned Order, DebugLoc dl,
1735 SDVTList VTs, ISD::MemIndexedMode AM, bool isTrunc, EVT MemVT,
1736 MachineMemOperand *MMO)
1737 : LSBaseSDNode(ISD::STORE, Order, dl, ChainValuePtrOff, 4,
1738 VTs, AM, MemVT, MMO) {
1739 SubclassData |= (unsigned short)isTrunc;
1740 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
1741 assert(!readMem() && "Store MachineMemOperand is a load!");
1742 assert(writeMem() && "Store MachineMemOperand is not a store!");
1746 /// isTruncatingStore - Return true if the op does a truncation before store.
1747 /// For integers this is the same as doing a TRUNCATE and storing the result.
1748 /// For floats, it is the same as doing an FP_ROUND and storing the result.
1749 bool isTruncatingStore() const { return SubclassData & 1; }
1751 const SDValue &getValue() const { return getOperand(1); }
1752 const SDValue &getBasePtr() const { return getOperand(2); }
1753 const SDValue &getOffset() const { return getOperand(3); }
1755 static bool classof(const SDNode *N) {
1756 return N->getOpcode() == ISD::STORE;
1760 /// MachineSDNode - An SDNode that represents everything that will be needed
1761 /// to construct a MachineInstr. These nodes are created during the
1762 /// instruction selection proper phase.
1764 class MachineSDNode : public SDNode {
1766 typedef MachineMemOperand **mmo_iterator;
1769 friend class SelectionDAG;
1770 MachineSDNode(unsigned Opc, unsigned Order, const DebugLoc DL, SDVTList VTs)
1771 : SDNode(Opc, Order, DL, VTs), MemRefs(0), MemRefsEnd(0) {}
1773 /// LocalOperands - Operands for this instruction, if they fit here. If
1774 /// they don't, this field is unused.
1775 SDUse LocalOperands[4];
1777 /// MemRefs - Memory reference descriptions for this instruction.
1778 mmo_iterator MemRefs;
1779 mmo_iterator MemRefsEnd;
1782 mmo_iterator memoperands_begin() const { return MemRefs; }
1783 mmo_iterator memoperands_end() const { return MemRefsEnd; }
1784 bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
1786 /// setMemRefs - Assign this MachineSDNodes's memory reference descriptor
1787 /// list. This does not transfer ownership.
1788 void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
1789 for (mmo_iterator MMI = NewMemRefs, MME = NewMemRefsEnd; MMI != MME; ++MMI)
1790 assert(*MMI && "Null mem ref detected!");
1791 MemRefs = NewMemRefs;
1792 MemRefsEnd = NewMemRefsEnd;
1795 static bool classof(const SDNode *N) {
1796 return N->isMachineOpcode();
1800 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
1801 SDNode, ptrdiff_t> {
1805 SDNodeIterator(const SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1807 bool operator==(const SDNodeIterator& x) const {
1808 return Operand == x.Operand;
1810 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1812 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1813 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1814 Operand = I.Operand;
1818 pointer operator*() const {
1819 return Node->getOperand(Operand).getNode();
1821 pointer operator->() const { return operator*(); }
1823 SDNodeIterator& operator++() { // Preincrement
1827 SDNodeIterator operator++(int) { // Postincrement
1828 SDNodeIterator tmp = *this; ++*this; return tmp;
1830 size_t operator-(SDNodeIterator Other) const {
1831 assert(Node == Other.Node &&
1832 "Cannot compare iterators of two different nodes!");
1833 return Operand - Other.Operand;
1836 static SDNodeIterator begin(const SDNode *N) { return SDNodeIterator(N, 0); }
1837 static SDNodeIterator end (const SDNode *N) {
1838 return SDNodeIterator(N, N->getNumOperands());
1841 unsigned getOperand() const { return Operand; }
1842 const SDNode *getNode() const { return Node; }
1845 template <> struct GraphTraits<SDNode*> {
1846 typedef SDNode NodeType;
1847 typedef SDNodeIterator ChildIteratorType;
1848 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1849 static inline ChildIteratorType child_begin(NodeType *N) {
1850 return SDNodeIterator::begin(N);
1852 static inline ChildIteratorType child_end(NodeType *N) {
1853 return SDNodeIterator::end(N);
1857 /// LargestSDNode - The largest SDNode class.
1859 typedef AtomicSDNode LargestSDNode;
1861 /// MostAlignedSDNode - The SDNode class with the greatest alignment
1864 typedef GlobalAddressSDNode MostAlignedSDNode;
1867 /// isNormalLoad - Returns true if the specified node is a non-extending
1868 /// and unindexed load.
1869 inline bool isNormalLoad(const SDNode *N) {
1870 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
1871 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
1872 Ld->getAddressingMode() == ISD::UNINDEXED;
1875 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1877 inline bool isNON_EXTLoad(const SDNode *N) {
1878 return isa<LoadSDNode>(N) &&
1879 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1882 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1884 inline bool isEXTLoad(const SDNode *N) {
1885 return isa<LoadSDNode>(N) &&
1886 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1889 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1891 inline bool isSEXTLoad(const SDNode *N) {
1892 return isa<LoadSDNode>(N) &&
1893 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1896 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1898 inline bool isZEXTLoad(const SDNode *N) {
1899 return isa<LoadSDNode>(N) &&
1900 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1903 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
1905 inline bool isUNINDEXEDLoad(const SDNode *N) {
1906 return isa<LoadSDNode>(N) &&
1907 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1910 /// isNormalStore - Returns true if the specified node is a non-truncating
1911 /// and unindexed store.
1912 inline bool isNormalStore(const SDNode *N) {
1913 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
1914 return St && !St->isTruncatingStore() &&
1915 St->getAddressingMode() == ISD::UNINDEXED;
1918 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1920 inline bool isNON_TRUNCStore(const SDNode *N) {
1921 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
1924 /// isTRUNCStore - Returns true if the specified node is a truncating
1926 inline bool isTRUNCStore(const SDNode *N) {
1927 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
1930 /// isUNINDEXEDStore - Returns true if the specified node is an
1931 /// unindexed store.
1932 inline bool isUNINDEXEDStore(const SDNode *N) {
1933 return isa<StoreSDNode>(N) &&
1934 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1938 } // end llvm namespace