1 //===-- llvm/CodeGen/SelectionDAGNodes.h - SelectionDAG Nodes ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the SDNode class and derived classes, which are used to
11 // represent the nodes and operations present in a SelectionDAG. These nodes
12 // and operations are machine code level operations, with some similarities to
13 // the GCC RTL representation.
15 // Clients should include the SelectionDAG.h file instead of this file directly.
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_CODEGEN_SELECTIONDAGNODES_H
20 #define LLVM_CODEGEN_SELECTIONDAGNODES_H
22 #include "llvm/Constants.h"
23 #include "llvm/ADT/FoldingSet.h"
24 #include "llvm/ADT/GraphTraits.h"
25 #include "llvm/ADT/ilist_node.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/ADT/STLExtras.h"
28 #include "llvm/CodeGen/ISDOpcodes.h"
29 #include "llvm/CodeGen/ValueTypes.h"
30 #include "llvm/CodeGen/MachineMemOperand.h"
31 #include "llvm/Support/MathExtras.h"
32 #include "llvm/System/DataTypes.h"
33 #include "llvm/Support/DebugLoc.h"
40 class MachineBasicBlock;
41 class MachineConstantPoolValue;
45 template <typename T> struct DenseMapInfo;
46 template <typename T> struct simplify_type;
47 template <typename T> struct ilist_traits;
49 void checkForCycles(const SDNode *N);
51 /// SDVTList - This represents a list of ValueType's that has been intern'd by
52 /// a SelectionDAG. Instances of this simple value class are returned by
53 /// SelectionDAG::getVTList(...).
63 /// isBuildVectorAllOnes - Return true if the specified node is a
64 /// BUILD_VECTOR where all of the elements are ~0 or undef.
65 bool isBuildVectorAllOnes(const SDNode *N);
67 /// isBuildVectorAllZeros - Return true if the specified node is a
68 /// BUILD_VECTOR where all of the elements are 0 or undef.
69 bool isBuildVectorAllZeros(const SDNode *N);
71 /// isScalarToVector - Return true if the specified node is a
72 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
73 /// element is not an undef.
74 bool isScalarToVector(const SDNode *N);
75 } // end llvm:ISD namespace
77 //===----------------------------------------------------------------------===//
78 /// SDValue - Unlike LLVM values, Selection DAG nodes may return multiple
79 /// values as the result of a computation. Many nodes return multiple values,
80 /// from loads (which define a token and a return value) to ADDC (which returns
81 /// a result and a carry value), to calls (which may return an arbitrary number
84 /// As such, each use of a SelectionDAG computation must indicate the node that
85 /// computes it as well as which return value to use from that node. This pair
86 /// of information is represented with the SDValue value type.
89 SDNode *Node; // The node defining the value we are using.
90 unsigned ResNo; // Which return value of the node we are using.
92 SDValue() : Node(0), ResNo(0) {}
93 SDValue(SDNode *node, unsigned resno) : Node(node), ResNo(resno) {}
95 /// get the index which selects a specific result in the SDNode
96 unsigned getResNo() const { return ResNo; }
98 /// get the SDNode which holds the desired result
99 SDNode *getNode() const { return Node; }
102 void setNode(SDNode *N) { Node = N; }
104 inline SDNode *operator->() const { return Node; }
106 bool operator==(const SDValue &O) const {
107 return Node == O.Node && ResNo == O.ResNo;
109 bool operator!=(const SDValue &O) const {
110 return !operator==(O);
112 bool operator<(const SDValue &O) const {
113 return Node < O.Node || (Node == O.Node && ResNo < O.ResNo);
116 SDValue getValue(unsigned R) const {
117 return SDValue(Node, R);
120 // isOperandOf - Return true if this node is an operand of N.
121 bool isOperandOf(SDNode *N) const;
123 /// getValueType - Return the ValueType of the referenced return value.
125 inline EVT getValueType() const;
127 /// getValueSizeInBits - Returns the size of the value in bits.
129 unsigned getValueSizeInBits() const {
130 return getValueType().getSizeInBits();
133 // Forwarding methods - These forward to the corresponding methods in SDNode.
134 inline unsigned getOpcode() const;
135 inline unsigned getNumOperands() const;
136 inline const SDValue &getOperand(unsigned i) const;
137 inline uint64_t getConstantOperandVal(unsigned i) const;
138 inline bool isTargetMemoryOpcode() const;
139 inline bool isTargetOpcode() const;
140 inline bool isMachineOpcode() const;
141 inline unsigned getMachineOpcode() const;
142 inline const DebugLoc getDebugLoc() const;
145 /// reachesChainWithoutSideEffects - Return true if this operand (which must
146 /// be a chain) reaches the specified operand without crossing any
147 /// side-effecting instructions. In practice, this looks through token
148 /// factors and non-volatile loads. In order to remain efficient, this only
149 /// looks a couple of nodes in, it does not do an exhaustive search.
150 bool reachesChainWithoutSideEffects(SDValue Dest,
151 unsigned Depth = 2) const;
153 /// use_empty - Return true if there are no nodes using value ResNo
156 inline bool use_empty() const;
158 /// hasOneUse - Return true if there is exactly one node using value
161 inline bool hasOneUse() const;
165 template<> struct DenseMapInfo<SDValue> {
166 static inline SDValue getEmptyKey() {
167 return SDValue((SDNode*)-1, -1U);
169 static inline SDValue getTombstoneKey() {
170 return SDValue((SDNode*)-1, 0);
172 static unsigned getHashValue(const SDValue &Val) {
173 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
174 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
176 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
180 template <> struct isPodLike<SDValue> { static const bool value = true; };
183 /// simplify_type specializations - Allow casting operators to work directly on
184 /// SDValues as if they were SDNode*'s.
185 template<> struct simplify_type<SDValue> {
186 typedef SDNode* SimpleType;
187 static SimpleType getSimplifiedValue(const SDValue &Val) {
188 return static_cast<SimpleType>(Val.getNode());
191 template<> struct simplify_type<const SDValue> {
192 typedef SDNode* SimpleType;
193 static SimpleType getSimplifiedValue(const SDValue &Val) {
194 return static_cast<SimpleType>(Val.getNode());
198 /// SDUse - Represents a use of a SDNode. This class holds an SDValue,
199 /// which records the SDNode being used and the result number, a
200 /// pointer to the SDNode using the value, and Next and Prev pointers,
201 /// which link together all the uses of an SDNode.
204 /// Val - The value being used.
206 /// User - The user of this value.
208 /// Prev, Next - Pointers to the uses list of the SDNode referred by
212 SDUse(const SDUse &U); // Do not implement
213 void operator=(const SDUse &U); // Do not implement
216 SDUse() : Val(), User(NULL), Prev(NULL), Next(NULL) {}
218 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
219 operator const SDValue&() const { return Val; }
221 /// If implicit conversion to SDValue doesn't work, the get() method returns
223 const SDValue &get() const { return Val; }
225 /// getUser - This returns the SDNode that contains this Use.
226 SDNode *getUser() { return User; }
228 /// getNext - Get the next SDUse in the use list.
229 SDUse *getNext() const { return Next; }
231 /// getNode - Convenience function for get().getNode().
232 SDNode *getNode() const { return Val.getNode(); }
233 /// getResNo - Convenience function for get().getResNo().
234 unsigned getResNo() const { return Val.getResNo(); }
235 /// getValueType - Convenience function for get().getValueType().
236 EVT getValueType() const { return Val.getValueType(); }
238 /// operator== - Convenience function for get().operator==
239 bool operator==(const SDValue &V) const {
243 /// operator!= - Convenience function for get().operator!=
244 bool operator!=(const SDValue &V) const {
248 /// operator< - Convenience function for get().operator<
249 bool operator<(const SDValue &V) const {
254 friend class SelectionDAG;
257 void setUser(SDNode *p) { User = p; }
259 /// set - Remove this use from its existing use list, assign it the
260 /// given value, and add it to the new value's node's use list.
261 inline void set(const SDValue &V);
262 /// setInitial - like set, but only supports initializing a newly-allocated
263 /// SDUse with a non-null value.
264 inline void setInitial(const SDValue &V);
265 /// setNode - like set, but only sets the Node portion of the value,
266 /// leaving the ResNo portion unmodified.
267 inline void setNode(SDNode *N);
269 void addToList(SDUse **List) {
271 if (Next) Next->Prev = &Next;
276 void removeFromList() {
278 if (Next) Next->Prev = Prev;
282 /// simplify_type specializations - Allow casting operators to work directly on
283 /// SDValues as if they were SDNode*'s.
284 template<> struct simplify_type<SDUse> {
285 typedef SDNode* SimpleType;
286 static SimpleType getSimplifiedValue(const SDUse &Val) {
287 return static_cast<SimpleType>(Val.getNode());
290 template<> struct simplify_type<const SDUse> {
291 typedef SDNode* SimpleType;
292 static SimpleType getSimplifiedValue(const SDUse &Val) {
293 return static_cast<SimpleType>(Val.getNode());
298 /// SDNode - Represents one node in the SelectionDAG.
300 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
302 /// NodeType - The operation that this node performs.
306 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
307 /// then they will be delete[]'d when the node is destroyed.
308 uint16_t OperandsNeedDelete : 1;
310 /// HasDebugValue - This tracks whether this node has one or more dbg_value
311 /// nodes corresponding to it.
312 uint16_t HasDebugValue : 1;
315 /// SubclassData - This member is defined by this class, but is not used for
316 /// anything. Subclasses can use it to hold whatever state they find useful.
317 /// This field is initialized to zero by the ctor.
318 uint16_t SubclassData : 14;
321 /// NodeId - Unique id per SDNode in the DAG.
324 /// OperandList - The values that are used by this operation.
328 /// ValueList - The types of the values this node defines. SDNode's may
329 /// define multiple values simultaneously.
330 const EVT *ValueList;
332 /// UseList - List of uses for this SDNode.
335 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
336 unsigned short NumOperands, NumValues;
338 /// debugLoc - source line information.
341 /// getValueTypeList - Return a pointer to the specified value type.
342 static const EVT *getValueTypeList(EVT VT);
344 friend class SelectionDAG;
345 friend struct ilist_traits<SDNode>;
348 //===--------------------------------------------------------------------===//
352 /// getOpcode - Return the SelectionDAG opcode value for this node. For
353 /// pre-isel nodes (those for which isMachineOpcode returns false), these
354 /// are the opcode values in the ISD and <target>ISD namespaces. For
355 /// post-isel opcodes, see getMachineOpcode.
356 unsigned getOpcode() const { return (unsigned short)NodeType; }
358 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
359 /// \<target\>ISD namespace).
360 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
362 /// isTargetMemoryOpcode - Test if this node has a target-specific
363 /// memory-referencing opcode (in the \<target\>ISD namespace and
364 /// greater than FIRST_TARGET_MEMORY_OPCODE).
365 bool isTargetMemoryOpcode() const {
366 return NodeType >= ISD::FIRST_TARGET_MEMORY_OPCODE;
369 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
370 /// corresponding to a MachineInstr opcode.
371 bool isMachineOpcode() const { return NodeType < 0; }
373 /// getMachineOpcode - This may only be called if isMachineOpcode returns
374 /// true. It returns the MachineInstr opcode value that the node's opcode
376 unsigned getMachineOpcode() const {
377 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
381 /// getHasDebugValue - get this bit.
382 bool getHasDebugValue() const { return HasDebugValue; }
384 /// setHasDebugValue - set this bit.
385 void setHasDebugValue(bool b) { HasDebugValue = b; }
387 /// use_empty - Return true if there are no uses of this node.
389 bool use_empty() const { return UseList == NULL; }
391 /// hasOneUse - Return true if there is exactly one use of this node.
393 bool hasOneUse() const {
394 return !use_empty() && llvm::next(use_begin()) == use_end();
397 /// use_size - Return the number of uses of this node. This method takes
398 /// time proportional to the number of uses.
400 size_t use_size() const { return std::distance(use_begin(), use_end()); }
402 /// getNodeId - Return the unique node id.
404 int getNodeId() const { return NodeId; }
406 /// setNodeId - Set unique node id.
407 void setNodeId(int Id) { NodeId = Id; }
409 /// getDebugLoc - Return the source location info.
410 const DebugLoc getDebugLoc() const { return debugLoc; }
412 /// setDebugLoc - Set source location info. Try to avoid this, putting
413 /// it in the constructor is preferable.
414 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
416 /// use_iterator - This class provides iterator support for SDUse
417 /// operands that use a specific SDNode.
419 : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
421 explicit use_iterator(SDUse *op) : Op(op) {
425 typedef std::iterator<std::forward_iterator_tag,
426 SDUse, ptrdiff_t>::reference reference;
427 typedef std::iterator<std::forward_iterator_tag,
428 SDUse, ptrdiff_t>::pointer pointer;
430 use_iterator(const use_iterator &I) : Op(I.Op) {}
431 use_iterator() : Op(0) {}
433 bool operator==(const use_iterator &x) const {
436 bool operator!=(const use_iterator &x) const {
437 return !operator==(x);
440 /// atEnd - return true if this iterator is at the end of uses list.
441 bool atEnd() const { return Op == 0; }
443 // Iterator traversal: forward iteration only.
444 use_iterator &operator++() { // Preincrement
445 assert(Op && "Cannot increment end iterator!");
450 use_iterator operator++(int) { // Postincrement
451 use_iterator tmp = *this; ++*this; return tmp;
454 /// Retrieve a pointer to the current user node.
455 SDNode *operator*() const {
456 assert(Op && "Cannot dereference end iterator!");
457 return Op->getUser();
460 SDNode *operator->() const { return operator*(); }
462 SDUse &getUse() const { return *Op; }
464 /// getOperandNo - Retrieve the operand # of this use in its user.
466 unsigned getOperandNo() const {
467 assert(Op && "Cannot dereference end iterator!");
468 return (unsigned)(Op - Op->getUser()->OperandList);
472 /// use_begin/use_end - Provide iteration support to walk over all uses
475 use_iterator use_begin() const {
476 return use_iterator(UseList);
479 static use_iterator use_end() { return use_iterator(0); }
482 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
483 /// indicated value. This method ignores uses of other values defined by this
485 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
487 /// hasAnyUseOfValue - Return true if there are any use of the indicated
488 /// value. This method ignores uses of other values defined by this operation.
489 bool hasAnyUseOfValue(unsigned Value) const;
491 /// isOnlyUserOf - Return true if this node is the only use of N.
493 bool isOnlyUserOf(SDNode *N) const;
495 /// isOperandOf - Return true if this node is an operand of N.
497 bool isOperandOf(SDNode *N) const;
499 /// isPredecessorOf - Return true if this node is a predecessor of N. This
500 /// node is either an operand of N or it can be reached by recursively
501 /// traversing up the operands.
502 /// NOTE: this is an expensive method. Use it carefully.
503 bool isPredecessorOf(SDNode *N) const;
505 /// getNumOperands - Return the number of values used by this operation.
507 unsigned getNumOperands() const { return NumOperands; }
509 /// getConstantOperandVal - Helper method returns the integer value of a
510 /// ConstantSDNode operand.
511 uint64_t getConstantOperandVal(unsigned Num) const;
513 const SDValue &getOperand(unsigned Num) const {
514 assert(Num < NumOperands && "Invalid child # of SDNode!");
515 return OperandList[Num];
518 typedef SDUse* op_iterator;
519 op_iterator op_begin() const { return OperandList; }
520 op_iterator op_end() const { return OperandList+NumOperands; }
522 SDVTList getVTList() const {
523 SDVTList X = { ValueList, NumValues };
527 /// getFlaggedNode - If this node has a flag operand, return the node
528 /// to which the flag operand points. Otherwise return NULL.
529 SDNode *getFlaggedNode() const {
530 if (getNumOperands() != 0 &&
531 getOperand(getNumOperands()-1).getValueType().getSimpleVT() == MVT::Flag)
532 return getOperand(getNumOperands()-1).getNode();
536 // If this is a pseudo op, like copyfromreg, look to see if there is a
537 // real target node flagged to it. If so, return the target node.
538 const SDNode *getFlaggedMachineNode() const {
539 const SDNode *FoundNode = this;
541 // Climb up flag edges until a machine-opcode node is found, or the
542 // end of the chain is reached.
543 while (!FoundNode->isMachineOpcode()) {
544 const SDNode *N = FoundNode->getFlaggedNode();
552 /// getFlaggedUser - If this node has a flag value with a user, return
553 /// the user (there is at most one). Otherwise return NULL.
554 SDNode *getFlaggedUser() const {
555 for (use_iterator UI = use_begin(), UE = use_end(); UI != UE; ++UI)
556 if (UI.getUse().get().getValueType() == MVT::Flag)
561 /// getNumValues - Return the number of values defined/returned by this
564 unsigned getNumValues() const { return NumValues; }
566 /// getValueType - Return the type of a specified result.
568 EVT getValueType(unsigned ResNo) const {
569 assert(ResNo < NumValues && "Illegal result number!");
570 return ValueList[ResNo];
573 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
575 unsigned getValueSizeInBits(unsigned ResNo) const {
576 return getValueType(ResNo).getSizeInBits();
579 typedef const EVT* value_iterator;
580 value_iterator value_begin() const { return ValueList; }
581 value_iterator value_end() const { return ValueList+NumValues; }
583 /// getOperationName - Return the opcode of this operation for printing.
585 std::string getOperationName(const SelectionDAG *G = 0) const;
586 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
587 void print_types(raw_ostream &OS, const SelectionDAG *G) const;
588 void print_details(raw_ostream &OS, const SelectionDAG *G) const;
589 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
590 void printr(raw_ostream &OS, const SelectionDAG *G = 0) const;
592 /// printrFull - Print a SelectionDAG node and all children down to
593 /// the leaves. The given SelectionDAG allows target-specific nodes
594 /// to be printed in human-readable form. Unlike printr, this will
595 /// print the whole DAG, including children that appear multiple
598 void printrFull(raw_ostream &O, const SelectionDAG *G = 0) const;
600 /// printrWithDepth - Print a SelectionDAG node and children up to
601 /// depth "depth." The given SelectionDAG allows target-specific
602 /// nodes to be printed in human-readable form. Unlike printr, this
603 /// will print children that appear multiple times wherever they are
606 void printrWithDepth(raw_ostream &O, const SelectionDAG *G = 0,
607 unsigned depth = 100) const;
610 /// dump - Dump this node, for debugging.
613 /// dumpr - Dump (recursively) this node and its use-def subgraph.
616 /// dump - Dump this node, for debugging.
617 /// The given SelectionDAG allows target-specific nodes to be printed
618 /// in human-readable form.
619 void dump(const SelectionDAG *G) const;
621 /// dumpr - Dump (recursively) this node and its use-def subgraph.
622 /// The given SelectionDAG allows target-specific nodes to be printed
623 /// in human-readable form.
624 void dumpr(const SelectionDAG *G) const;
626 /// dumprFull - printrFull to dbgs(). The given SelectionDAG allows
627 /// target-specific nodes to be printed in human-readable form.
628 /// Unlike dumpr, this will print the whole DAG, including children
629 /// that appear multiple times.
631 void dumprFull(const SelectionDAG *G = 0) const;
633 /// dumprWithDepth - printrWithDepth to dbgs(). The given
634 /// SelectionDAG allows target-specific nodes to be printed in
635 /// human-readable form. Unlike dumpr, this will print children
636 /// that appear multiple times wherever they are used.
638 void dumprWithDepth(const SelectionDAG *G = 0, unsigned depth = 100) const;
641 static bool classof(const SDNode *) { return true; }
643 /// Profile - Gather unique data for the node.
645 void Profile(FoldingSetNodeID &ID) const;
647 /// addUse - This method should only be used by the SDUse class.
649 void addUse(SDUse &U) { U.addToList(&UseList); }
652 static SDVTList getSDVTList(EVT VT) {
653 SDVTList Ret = { getValueTypeList(VT), 1 };
657 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs, const SDValue *Ops,
659 : NodeType(Opc), OperandsNeedDelete(true), HasDebugValue(false),
660 SubclassData(0), NodeId(-1),
661 OperandList(NumOps ? new SDUse[NumOps] : 0),
662 ValueList(VTs.VTs), UseList(NULL),
663 NumOperands(NumOps), NumValues(VTs.NumVTs),
665 for (unsigned i = 0; i != NumOps; ++i) {
666 OperandList[i].setUser(this);
667 OperandList[i].setInitial(Ops[i]);
669 checkForCycles(this);
672 /// This constructor adds no operands itself; operands can be
673 /// set later with InitOperands.
674 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs)
675 : NodeType(Opc), OperandsNeedDelete(false), HasDebugValue(false),
676 SubclassData(0), NodeId(-1), OperandList(0), ValueList(VTs.VTs),
677 UseList(NULL), NumOperands(0), NumValues(VTs.NumVTs),
680 /// InitOperands - Initialize the operands list of this with 1 operand.
681 void InitOperands(SDUse *Ops, const SDValue &Op0) {
682 Ops[0].setUser(this);
683 Ops[0].setInitial(Op0);
686 checkForCycles(this);
689 /// InitOperands - Initialize the operands list of this with 2 operands.
690 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
691 Ops[0].setUser(this);
692 Ops[0].setInitial(Op0);
693 Ops[1].setUser(this);
694 Ops[1].setInitial(Op1);
697 checkForCycles(this);
700 /// InitOperands - Initialize the operands list of this with 3 operands.
701 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
702 const SDValue &Op2) {
703 Ops[0].setUser(this);
704 Ops[0].setInitial(Op0);
705 Ops[1].setUser(this);
706 Ops[1].setInitial(Op1);
707 Ops[2].setUser(this);
708 Ops[2].setInitial(Op2);
711 checkForCycles(this);
714 /// InitOperands - Initialize the operands list of this with 4 operands.
715 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
716 const SDValue &Op2, const SDValue &Op3) {
717 Ops[0].setUser(this);
718 Ops[0].setInitial(Op0);
719 Ops[1].setUser(this);
720 Ops[1].setInitial(Op1);
721 Ops[2].setUser(this);
722 Ops[2].setInitial(Op2);
723 Ops[3].setUser(this);
724 Ops[3].setInitial(Op3);
727 checkForCycles(this);
730 /// InitOperands - Initialize the operands list of this with N operands.
731 void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
732 for (unsigned i = 0; i != N; ++i) {
733 Ops[i].setUser(this);
734 Ops[i].setInitial(Vals[i]);
738 checkForCycles(this);
741 /// DropOperands - Release the operands and set this node to have
747 // Define inline functions from the SDValue class.
749 inline unsigned SDValue::getOpcode() const {
750 return Node->getOpcode();
752 inline EVT SDValue::getValueType() const {
753 return Node->getValueType(ResNo);
755 inline unsigned SDValue::getNumOperands() const {
756 return Node->getNumOperands();
758 inline const SDValue &SDValue::getOperand(unsigned i) const {
759 return Node->getOperand(i);
761 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
762 return Node->getConstantOperandVal(i);
764 inline bool SDValue::isTargetOpcode() const {
765 return Node->isTargetOpcode();
767 inline bool SDValue::isTargetMemoryOpcode() const {
768 return Node->isTargetMemoryOpcode();
770 inline bool SDValue::isMachineOpcode() const {
771 return Node->isMachineOpcode();
773 inline unsigned SDValue::getMachineOpcode() const {
774 return Node->getMachineOpcode();
776 inline bool SDValue::use_empty() const {
777 return !Node->hasAnyUseOfValue(ResNo);
779 inline bool SDValue::hasOneUse() const {
780 return Node->hasNUsesOfValue(1, ResNo);
782 inline const DebugLoc SDValue::getDebugLoc() const {
783 return Node->getDebugLoc();
786 // Define inline functions from the SDUse class.
788 inline void SDUse::set(const SDValue &V) {
789 if (Val.getNode()) removeFromList();
791 if (V.getNode()) V.getNode()->addUse(*this);
794 inline void SDUse::setInitial(const SDValue &V) {
796 V.getNode()->addUse(*this);
799 inline void SDUse::setNode(SDNode *N) {
800 if (Val.getNode()) removeFromList();
802 if (N) N->addUse(*this);
805 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
806 /// to allow co-allocation of node operands with the node itself.
807 class UnarySDNode : public SDNode {
810 UnarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X)
811 : SDNode(Opc, dl, VTs) {
812 InitOperands(&Op, X);
816 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
817 /// to allow co-allocation of node operands with the node itself.
818 class BinarySDNode : public SDNode {
821 BinarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y)
822 : SDNode(Opc, dl, VTs) {
823 InitOperands(Ops, X, Y);
827 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
828 /// to allow co-allocation of node operands with the node itself.
829 class TernarySDNode : public SDNode {
832 TernarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y,
834 : SDNode(Opc, dl, VTs) {
835 InitOperands(Ops, X, Y, Z);
840 /// HandleSDNode - This class is used to form a handle around another node that
841 /// is persistant and is updated across invocations of replaceAllUsesWith on its
842 /// operand. This node should be directly created by end-users and not added to
843 /// the AllNodes list.
844 class HandleSDNode : public SDNode {
847 // FIXME: Remove the "noinline" attribute once <rdar://problem/5852746> is
849 #if __GNUC__==4 && __GNUC_MINOR__==2 && defined(__APPLE__) && !defined(__llvm__)
850 explicit __attribute__((__noinline__)) HandleSDNode(SDValue X)
852 explicit HandleSDNode(SDValue X)
854 : SDNode(ISD::HANDLENODE, DebugLoc(), getSDVTList(MVT::Other)) {
855 InitOperands(&Op, X);
858 const SDValue &getValue() const { return Op; }
861 /// Abstact virtual class for operations for memory operations
862 class MemSDNode : public SDNode {
864 // MemoryVT - VT of in-memory value.
868 /// MMO - Memory reference information.
869 MachineMemOperand *MMO;
872 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, EVT MemoryVT,
873 MachineMemOperand *MMO);
875 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, const SDValue *Ops,
876 unsigned NumOps, EVT MemoryVT, MachineMemOperand *MMO);
878 bool readMem() const { return MMO->isLoad(); }
879 bool writeMem() const { return MMO->isStore(); }
881 /// Returns alignment and volatility of the memory access
882 unsigned getOriginalAlignment() const {
883 return MMO->getBaseAlignment();
885 unsigned getAlignment() const {
886 return MMO->getAlignment();
889 /// getRawSubclassData - Return the SubclassData value, which contains an
890 /// encoding of the volatile flag, as well as bits used by subclasses. This
891 /// function should only be used to compute a FoldingSetNodeID value.
892 unsigned getRawSubclassData() const {
896 // We access subclass data here so that we can check consistency
897 // with MachineMemOperand information.
898 bool isVolatile() const { return (SubclassData >> 5) & 1; }
899 bool isNonTemporal() const { return (SubclassData >> 6) & 1; }
901 /// Returns the SrcValue and offset that describes the location of the access
902 const Value *getSrcValue() const { return MMO->getValue(); }
903 int64_t getSrcValueOffset() const { return MMO->getOffset(); }
905 /// getMemoryVT - Return the type of the in-memory value.
906 EVT getMemoryVT() const { return MemoryVT; }
908 /// getMemOperand - Return a MachineMemOperand object describing the memory
909 /// reference performed by operation.
910 MachineMemOperand *getMemOperand() const { return MMO; }
912 /// refineAlignment - Update this MemSDNode's MachineMemOperand information
913 /// to reflect the alignment of NewMMO, if it has a greater alignment.
914 /// This must only be used when the new alignment applies to all users of
915 /// this MachineMemOperand.
916 void refineAlignment(const MachineMemOperand *NewMMO) {
917 MMO->refineAlignment(NewMMO);
920 const SDValue &getChain() const { return getOperand(0); }
921 const SDValue &getBasePtr() const {
922 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
925 // Methods to support isa and dyn_cast
926 static bool classof(const MemSDNode *) { return true; }
927 static bool classof(const SDNode *N) {
928 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
929 // with either an intrinsic or a target opcode.
930 return N->getOpcode() == ISD::LOAD ||
931 N->getOpcode() == ISD::STORE ||
932 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
933 N->getOpcode() == ISD::ATOMIC_SWAP ||
934 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
935 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
936 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
937 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
938 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
939 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
940 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
941 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
942 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
943 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
944 N->isTargetMemoryOpcode();
948 /// AtomicSDNode - A SDNode reprenting atomic operations.
950 class AtomicSDNode : public MemSDNode {
954 // Opc: opcode for atomic
955 // VTL: value type list
956 // Chain: memory chain for operaand
957 // Ptr: address to update as a SDValue
958 // Cmp: compare value
960 // SrcVal: address to update as a Value (used for MemOperand)
961 // Align: alignment of memory
962 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
963 SDValue Chain, SDValue Ptr,
964 SDValue Cmp, SDValue Swp, MachineMemOperand *MMO)
965 : MemSDNode(Opc, dl, VTL, MemVT, MMO) {
966 assert(readMem() && "Atomic MachineMemOperand is not a load!");
967 assert(writeMem() && "Atomic MachineMemOperand is not a store!");
968 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
970 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
971 SDValue Chain, SDValue Ptr,
972 SDValue Val, MachineMemOperand *MMO)
973 : MemSDNode(Opc, dl, VTL, MemVT, MMO) {
974 assert(readMem() && "Atomic MachineMemOperand is not a load!");
975 assert(writeMem() && "Atomic MachineMemOperand is not a store!");
976 InitOperands(Ops, Chain, Ptr, Val);
979 const SDValue &getBasePtr() const { return getOperand(1); }
980 const SDValue &getVal() const { return getOperand(2); }
982 bool isCompareAndSwap() const {
983 unsigned Op = getOpcode();
984 return Op == ISD::ATOMIC_CMP_SWAP;
987 // Methods to support isa and dyn_cast
988 static bool classof(const AtomicSDNode *) { return true; }
989 static bool classof(const SDNode *N) {
990 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
991 N->getOpcode() == ISD::ATOMIC_SWAP ||
992 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
993 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
994 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
995 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
996 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
997 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
998 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
999 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1000 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1001 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX;
1005 /// MemIntrinsicSDNode - This SDNode is used for target intrinsics that touch
1006 /// memory and need an associated MachineMemOperand. Its opcode may be
1007 /// INTRINSIC_VOID, INTRINSIC_W_CHAIN, or a target-specific opcode with a
1008 /// value not less than FIRST_TARGET_MEMORY_OPCODE.
1009 class MemIntrinsicSDNode : public MemSDNode {
1011 MemIntrinsicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs,
1012 const SDValue *Ops, unsigned NumOps,
1013 EVT MemoryVT, MachineMemOperand *MMO)
1014 : MemSDNode(Opc, dl, VTs, Ops, NumOps, MemoryVT, MMO) {
1017 // Methods to support isa and dyn_cast
1018 static bool classof(const MemIntrinsicSDNode *) { return true; }
1019 static bool classof(const SDNode *N) {
1020 // We lower some target intrinsics to their target opcode
1021 // early a node with a target opcode can be of this class
1022 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1023 N->getOpcode() == ISD::INTRINSIC_VOID ||
1024 N->isTargetMemoryOpcode();
1028 /// ShuffleVectorSDNode - This SDNode is used to implement the code generator
1029 /// support for the llvm IR shufflevector instruction. It combines elements
1030 /// from two input vectors into a new input vector, with the selection and
1031 /// ordering of elements determined by an array of integers, referred to as
1032 /// the shuffle mask. For input vectors of width N, mask indices of 0..N-1
1033 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1034 /// An index of -1 is treated as undef, such that the code generator may put
1035 /// any value in the corresponding element of the result.
1036 class ShuffleVectorSDNode : public SDNode {
1039 // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1040 // is freed when the SelectionDAG object is destroyed.
1043 friend class SelectionDAG;
1044 ShuffleVectorSDNode(EVT VT, DebugLoc dl, SDValue N1, SDValue N2,
1046 : SDNode(ISD::VECTOR_SHUFFLE, dl, getSDVTList(VT)), Mask(M) {
1047 InitOperands(Ops, N1, N2);
1051 void getMask(SmallVectorImpl<int> &M) const {
1052 EVT VT = getValueType(0);
1054 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i)
1055 M.push_back(Mask[i]);
1057 int getMaskElt(unsigned Idx) const {
1058 assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1062 bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1063 int getSplatIndex() const {
1064 assert(isSplat() && "Cannot get splat index for non-splat!");
1065 EVT VT = getValueType(0);
1066 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i) {
1072 static bool isSplatMask(const int *Mask, EVT VT);
1074 static bool classof(const ShuffleVectorSDNode *) { return true; }
1075 static bool classof(const SDNode *N) {
1076 return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1080 class ConstantSDNode : public SDNode {
1081 const ConstantInt *Value;
1082 friend class SelectionDAG;
1083 ConstantSDNode(bool isTarget, const ConstantInt *val, EVT VT)
1084 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1085 DebugLoc(), getSDVTList(VT)), Value(val) {
1089 const ConstantInt *getConstantIntValue() const { return Value; }
1090 const APInt &getAPIntValue() const { return Value->getValue(); }
1091 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1092 int64_t getSExtValue() const { return Value->getSExtValue(); }
1094 bool isOne() const { return Value->isOne(); }
1095 bool isNullValue() const { return Value->isNullValue(); }
1096 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1098 static bool classof(const ConstantSDNode *) { return true; }
1099 static bool classof(const SDNode *N) {
1100 return N->getOpcode() == ISD::Constant ||
1101 N->getOpcode() == ISD::TargetConstant;
1105 class ConstantFPSDNode : public SDNode {
1106 const ConstantFP *Value;
1107 friend class SelectionDAG;
1108 ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1109 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1110 DebugLoc(), getSDVTList(VT)), Value(val) {
1114 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1115 const ConstantFP *getConstantFPValue() const { return Value; }
1117 /// isZero - Return true if the value is positive or negative zero.
1118 bool isZero() const { return Value->isZero(); }
1120 /// isNaN - Return true if the value is a NaN.
1121 bool isNaN() const { return Value->isNaN(); }
1123 /// isExactlyValue - We don't rely on operator== working on double values, as
1124 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1125 /// As such, this method can be used to do an exact bit-for-bit comparison of
1126 /// two floating point values.
1128 /// We leave the version with the double argument here because it's just so
1129 /// convenient to write "2.0" and the like. Without this function we'd
1130 /// have to duplicate its logic everywhere it's called.
1131 bool isExactlyValue(double V) const {
1133 // convert is not supported on this type
1134 if (&Value->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1137 Tmp.convert(Value->getValueAPF().getSemantics(),
1138 APFloat::rmNearestTiesToEven, &ignored);
1139 return isExactlyValue(Tmp);
1141 bool isExactlyValue(const APFloat& V) const;
1143 static bool isValueValidForType(EVT VT, const APFloat& Val);
1145 static bool classof(const ConstantFPSDNode *) { return true; }
1146 static bool classof(const SDNode *N) {
1147 return N->getOpcode() == ISD::ConstantFP ||
1148 N->getOpcode() == ISD::TargetConstantFP;
1152 class GlobalAddressSDNode : public SDNode {
1153 const GlobalValue *TheGlobal;
1155 unsigned char TargetFlags;
1156 friend class SelectionDAG;
1157 GlobalAddressSDNode(unsigned Opc, DebugLoc DL, const GlobalValue *GA, EVT VT,
1158 int64_t o, unsigned char TargetFlags);
1161 const GlobalValue *getGlobal() const { return TheGlobal; }
1162 int64_t getOffset() const { return Offset; }
1163 unsigned char getTargetFlags() const { return TargetFlags; }
1164 // Return the address space this GlobalAddress belongs to.
1165 unsigned getAddressSpace() const;
1167 static bool classof(const GlobalAddressSDNode *) { return true; }
1168 static bool classof(const SDNode *N) {
1169 return N->getOpcode() == ISD::GlobalAddress ||
1170 N->getOpcode() == ISD::TargetGlobalAddress ||
1171 N->getOpcode() == ISD::GlobalTLSAddress ||
1172 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1176 class FrameIndexSDNode : public SDNode {
1178 friend class SelectionDAG;
1179 FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1180 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1181 DebugLoc(), getSDVTList(VT)), FI(fi) {
1185 int getIndex() const { return FI; }
1187 static bool classof(const FrameIndexSDNode *) { return true; }
1188 static bool classof(const SDNode *N) {
1189 return N->getOpcode() == ISD::FrameIndex ||
1190 N->getOpcode() == ISD::TargetFrameIndex;
1194 class JumpTableSDNode : public SDNode {
1196 unsigned char TargetFlags;
1197 friend class SelectionDAG;
1198 JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1199 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1200 DebugLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1204 int getIndex() const { return JTI; }
1205 unsigned char getTargetFlags() const { return TargetFlags; }
1207 static bool classof(const JumpTableSDNode *) { return true; }
1208 static bool classof(const SDNode *N) {
1209 return N->getOpcode() == ISD::JumpTable ||
1210 N->getOpcode() == ISD::TargetJumpTable;
1214 class ConstantPoolSDNode : public SDNode {
1216 const Constant *ConstVal;
1217 MachineConstantPoolValue *MachineCPVal;
1219 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1220 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1221 unsigned char TargetFlags;
1222 friend class SelectionDAG;
1223 ConstantPoolSDNode(bool isTarget, const Constant *c, EVT VT, int o,
1224 unsigned Align, unsigned char TF)
1225 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1227 getSDVTList(VT)), Offset(o), Alignment(Align), TargetFlags(TF) {
1228 assert((int)Offset >= 0 && "Offset is too large");
1231 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1232 EVT VT, int o, unsigned Align, unsigned char TF)
1233 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1235 getSDVTList(VT)), Offset(o), Alignment(Align), TargetFlags(TF) {
1236 assert((int)Offset >= 0 && "Offset is too large");
1237 Val.MachineCPVal = v;
1238 Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1243 bool isMachineConstantPoolEntry() const {
1244 return (int)Offset < 0;
1247 const Constant *getConstVal() const {
1248 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1249 return Val.ConstVal;
1252 MachineConstantPoolValue *getMachineCPVal() const {
1253 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1254 return Val.MachineCPVal;
1257 int getOffset() const {
1258 return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1261 // Return the alignment of this constant pool object, which is either 0 (for
1262 // default alignment) or the desired value.
1263 unsigned getAlignment() const { return Alignment; }
1264 unsigned char getTargetFlags() const { return TargetFlags; }
1266 const Type *getType() const;
1268 static bool classof(const ConstantPoolSDNode *) { return true; }
1269 static bool classof(const SDNode *N) {
1270 return N->getOpcode() == ISD::ConstantPool ||
1271 N->getOpcode() == ISD::TargetConstantPool;
1275 class BasicBlockSDNode : public SDNode {
1276 MachineBasicBlock *MBB;
1277 friend class SelectionDAG;
1278 /// Debug info is meaningful and potentially useful here, but we create
1279 /// blocks out of order when they're jumped to, which makes it a bit
1280 /// harder. Let's see if we need it first.
1281 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1282 : SDNode(ISD::BasicBlock, DebugLoc(), getSDVTList(MVT::Other)), MBB(mbb) {
1286 MachineBasicBlock *getBasicBlock() const { return MBB; }
1288 static bool classof(const BasicBlockSDNode *) { return true; }
1289 static bool classof(const SDNode *N) {
1290 return N->getOpcode() == ISD::BasicBlock;
1294 /// BuildVectorSDNode - A "pseudo-class" with methods for operating on
1296 class BuildVectorSDNode : public SDNode {
1297 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1298 explicit BuildVectorSDNode(); // Do not implement
1300 /// isConstantSplat - Check if this is a constant splat, and if so, find the
1301 /// smallest element size that splats the vector. If MinSplatBits is
1302 /// nonzero, the element size must be at least that large. Note that the
1303 /// splat element may be the entire vector (i.e., a one element vector).
1304 /// Returns the splat element value in SplatValue. Any undefined bits in
1305 /// that value are zero, and the corresponding bits in the SplatUndef mask
1306 /// are set. The SplatBitSize value is set to the splat element size in
1307 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1308 /// undefined. isBigEndian describes the endianness of the target.
1309 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1310 unsigned &SplatBitSize, bool &HasAnyUndefs,
1311 unsigned MinSplatBits = 0, bool isBigEndian = false);
1313 static inline bool classof(const BuildVectorSDNode *) { return true; }
1314 static inline bool classof(const SDNode *N) {
1315 return N->getOpcode() == ISD::BUILD_VECTOR;
1319 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1320 /// used when the SelectionDAG needs to make a simple reference to something
1321 /// in the LLVM IR representation.
1323 class SrcValueSDNode : public SDNode {
1325 friend class SelectionDAG;
1326 /// Create a SrcValue for a general value.
1327 explicit SrcValueSDNode(const Value *v)
1328 : SDNode(ISD::SRCVALUE, DebugLoc(), getSDVTList(MVT::Other)), V(v) {}
1331 /// getValue - return the contained Value.
1332 const Value *getValue() const { return V; }
1334 static bool classof(const SrcValueSDNode *) { return true; }
1335 static bool classof(const SDNode *N) {
1336 return N->getOpcode() == ISD::SRCVALUE;
1340 class MDNodeSDNode : public SDNode {
1342 friend class SelectionDAG;
1343 explicit MDNodeSDNode(const MDNode *md)
1344 : SDNode(ISD::MDNODE_SDNODE, DebugLoc(), getSDVTList(MVT::Other)), MD(md) {}
1347 const MDNode *getMD() const { return MD; }
1349 static bool classof(const MDNodeSDNode *) { return true; }
1350 static bool classof(const SDNode *N) {
1351 return N->getOpcode() == ISD::MDNODE_SDNODE;
1356 class RegisterSDNode : public SDNode {
1358 friend class SelectionDAG;
1359 RegisterSDNode(unsigned reg, EVT VT)
1360 : SDNode(ISD::Register, DebugLoc(), getSDVTList(VT)), Reg(reg) {
1364 unsigned getReg() const { return Reg; }
1366 static bool classof(const RegisterSDNode *) { return true; }
1367 static bool classof(const SDNode *N) {
1368 return N->getOpcode() == ISD::Register;
1372 class BlockAddressSDNode : public SDNode {
1373 const BlockAddress *BA;
1374 unsigned char TargetFlags;
1375 friend class SelectionDAG;
1376 BlockAddressSDNode(unsigned NodeTy, EVT VT, const BlockAddress *ba,
1377 unsigned char Flags)
1378 : SDNode(NodeTy, DebugLoc(), getSDVTList(VT)),
1379 BA(ba), TargetFlags(Flags) {
1382 const BlockAddress *getBlockAddress() const { return BA; }
1383 unsigned char getTargetFlags() const { return TargetFlags; }
1385 static bool classof(const BlockAddressSDNode *) { return true; }
1386 static bool classof(const SDNode *N) {
1387 return N->getOpcode() == ISD::BlockAddress ||
1388 N->getOpcode() == ISD::TargetBlockAddress;
1392 class EHLabelSDNode : public SDNode {
1395 friend class SelectionDAG;
1396 EHLabelSDNode(DebugLoc dl, SDValue ch, MCSymbol *L)
1397 : SDNode(ISD::EH_LABEL, dl, getSDVTList(MVT::Other)), Label(L) {
1398 InitOperands(&Chain, ch);
1401 MCSymbol *getLabel() const { return Label; }
1403 static bool classof(const EHLabelSDNode *) { return true; }
1404 static bool classof(const SDNode *N) {
1405 return N->getOpcode() == ISD::EH_LABEL;
1409 class ExternalSymbolSDNode : public SDNode {
1411 unsigned char TargetFlags;
1413 friend class SelectionDAG;
1414 ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
1415 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1416 DebugLoc(), getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
1420 const char *getSymbol() const { return Symbol; }
1421 unsigned char getTargetFlags() const { return TargetFlags; }
1423 static bool classof(const ExternalSymbolSDNode *) { return true; }
1424 static bool classof(const SDNode *N) {
1425 return N->getOpcode() == ISD::ExternalSymbol ||
1426 N->getOpcode() == ISD::TargetExternalSymbol;
1430 class CondCodeSDNode : public SDNode {
1431 ISD::CondCode Condition;
1432 friend class SelectionDAG;
1433 explicit CondCodeSDNode(ISD::CondCode Cond)
1434 : SDNode(ISD::CONDCODE, DebugLoc(), getSDVTList(MVT::Other)),
1439 ISD::CondCode get() const { return Condition; }
1441 static bool classof(const CondCodeSDNode *) { return true; }
1442 static bool classof(const SDNode *N) {
1443 return N->getOpcode() == ISD::CONDCODE;
1447 /// CvtRndSatSDNode - NOTE: avoid using this node as this may disappear in the
1448 /// future and most targets don't support it.
1449 class CvtRndSatSDNode : public SDNode {
1450 ISD::CvtCode CvtCode;
1451 friend class SelectionDAG;
1452 explicit CvtRndSatSDNode(EVT VT, DebugLoc dl, const SDValue *Ops,
1453 unsigned NumOps, ISD::CvtCode Code)
1454 : SDNode(ISD::CONVERT_RNDSAT, dl, getSDVTList(VT), Ops, NumOps),
1456 assert(NumOps == 5 && "wrong number of operations");
1459 ISD::CvtCode getCvtCode() const { return CvtCode; }
1461 static bool classof(const CvtRndSatSDNode *) { return true; }
1462 static bool classof(const SDNode *N) {
1463 return N->getOpcode() == ISD::CONVERT_RNDSAT;
1470 static const uint64_t NoFlagSet = 0ULL;
1471 static const uint64_t ZExt = 1ULL<<0; ///< Zero extended
1472 static const uint64_t ZExtOffs = 0;
1473 static const uint64_t SExt = 1ULL<<1; ///< Sign extended
1474 static const uint64_t SExtOffs = 1;
1475 static const uint64_t InReg = 1ULL<<2; ///< Passed in register
1476 static const uint64_t InRegOffs = 2;
1477 static const uint64_t SRet = 1ULL<<3; ///< Hidden struct-ret ptr
1478 static const uint64_t SRetOffs = 3;
1479 static const uint64_t ByVal = 1ULL<<4; ///< Struct passed by value
1480 static const uint64_t ByValOffs = 4;
1481 static const uint64_t Nest = 1ULL<<5; ///< Nested fn static chain
1482 static const uint64_t NestOffs = 5;
1483 static const uint64_t ByValAlign = 0xFULL << 6; //< Struct alignment
1484 static const uint64_t ByValAlignOffs = 6;
1485 static const uint64_t Split = 1ULL << 10;
1486 static const uint64_t SplitOffs = 10;
1487 static const uint64_t OrigAlign = 0x1FULL<<27;
1488 static const uint64_t OrigAlignOffs = 27;
1489 static const uint64_t ByValSize = 0xffffffffULL << 32; //< Struct size
1490 static const uint64_t ByValSizeOffs = 32;
1492 static const uint64_t One = 1ULL; //< 1 of this type, for shifts
1496 ArgFlagsTy() : Flags(0) { }
1498 bool isZExt() const { return Flags & ZExt; }
1499 void setZExt() { Flags |= One << ZExtOffs; }
1501 bool isSExt() const { return Flags & SExt; }
1502 void setSExt() { Flags |= One << SExtOffs; }
1504 bool isInReg() const { return Flags & InReg; }
1505 void setInReg() { Flags |= One << InRegOffs; }
1507 bool isSRet() const { return Flags & SRet; }
1508 void setSRet() { Flags |= One << SRetOffs; }
1510 bool isByVal() const { return Flags & ByVal; }
1511 void setByVal() { Flags |= One << ByValOffs; }
1513 bool isNest() const { return Flags & Nest; }
1514 void setNest() { Flags |= One << NestOffs; }
1516 unsigned getByValAlign() const {
1518 ((One << ((Flags & ByValAlign) >> ByValAlignOffs)) / 2);
1520 void setByValAlign(unsigned A) {
1521 Flags = (Flags & ~ByValAlign) |
1522 (uint64_t(Log2_32(A) + 1) << ByValAlignOffs);
1525 bool isSplit() const { return Flags & Split; }
1526 void setSplit() { Flags |= One << SplitOffs; }
1528 unsigned getOrigAlign() const {
1530 ((One << ((Flags & OrigAlign) >> OrigAlignOffs)) / 2);
1532 void setOrigAlign(unsigned A) {
1533 Flags = (Flags & ~OrigAlign) |
1534 (uint64_t(Log2_32(A) + 1) << OrigAlignOffs);
1537 unsigned getByValSize() const {
1538 return (unsigned)((Flags & ByValSize) >> ByValSizeOffs);
1540 void setByValSize(unsigned S) {
1541 Flags = (Flags & ~ByValSize) | (uint64_t(S) << ByValSizeOffs);
1544 /// getArgFlagsString - Returns the flags as a string, eg: "zext align:4".
1545 std::string getArgFlagsString();
1547 /// getRawBits - Represent the flags as a bunch of bits.
1548 uint64_t getRawBits() const { return Flags; }
1551 /// InputArg - This struct carries flags and type information about a
1552 /// single incoming (formal) argument or incoming (from the perspective
1553 /// of the caller) return value virtual register.
1560 InputArg() : VT(MVT::Other), Used(false) {}
1561 InputArg(ISD::ArgFlagsTy flags, EVT vt, bool used)
1562 : Flags(flags), VT(vt), Used(used) {
1563 assert(VT.isSimple() &&
1564 "InputArg value type must be Simple!");
1568 /// OutputArg - This struct carries flags and a value for a
1569 /// single outgoing (actual) argument or outgoing (from the perspective
1570 /// of the caller) return value virtual register.
1576 /// IsFixed - Is this a "fixed" value, ie not passed through a vararg "...".
1579 OutputArg() : IsFixed(false) {}
1580 OutputArg(ISD::ArgFlagsTy flags, SDValue val, bool isfixed)
1581 : Flags(flags), Val(val), IsFixed(isfixed) {
1582 assert(Val.getValueType().isSimple() &&
1583 "OutputArg value type must be Simple!");
1587 /// OutputArgReg - This struct carries flags and a register value for a
1588 /// single outgoing (actual) argument or outgoing (from the perspective
1589 /// of the caller) return value virtual register.
1591 struct OutputArgReg {
1596 /// IsFixed - Is this a "fixed" value, ie not passed through a vararg "...".
1599 OutputArgReg() : IsFixed(false) {}
1600 OutputArgReg(ISD::ArgFlagsTy flags, EVT vt, unsigned reg, bool isfixed)
1601 : Flags(flags), VT(vt), Reg(reg), IsFixed(isfixed) {}
1605 /// VTSDNode - This class is used to represent EVT's, which are used
1606 /// to parameterize some operations.
1607 class VTSDNode : public SDNode {
1609 friend class SelectionDAG;
1610 explicit VTSDNode(EVT VT)
1611 : SDNode(ISD::VALUETYPE, DebugLoc(), getSDVTList(MVT::Other)),
1616 EVT getVT() const { return ValueType; }
1618 static bool classof(const VTSDNode *) { return true; }
1619 static bool classof(const SDNode *N) {
1620 return N->getOpcode() == ISD::VALUETYPE;
1624 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1626 class LSBaseSDNode : public MemSDNode {
1627 //! Operand array for load and store
1629 \note Moving this array to the base class captures more
1630 common functionality shared between LoadSDNode and
1635 LSBaseSDNode(ISD::NodeType NodeTy, DebugLoc dl, SDValue *Operands,
1636 unsigned numOperands, SDVTList VTs, ISD::MemIndexedMode AM,
1637 EVT MemVT, MachineMemOperand *MMO)
1638 : MemSDNode(NodeTy, dl, VTs, MemVT, MMO) {
1639 SubclassData |= AM << 2;
1640 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
1641 InitOperands(Ops, Operands, numOperands);
1642 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1643 "Only indexed loads and stores have a non-undef offset operand");
1646 const SDValue &getOffset() const {
1647 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1650 /// getAddressingMode - Return the addressing mode for this load or store:
1651 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
1652 ISD::MemIndexedMode getAddressingMode() const {
1653 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
1656 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1657 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
1659 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1660 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
1662 static bool classof(const LSBaseSDNode *) { return true; }
1663 static bool classof(const SDNode *N) {
1664 return N->getOpcode() == ISD::LOAD ||
1665 N->getOpcode() == ISD::STORE;
1669 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1671 class LoadSDNode : public LSBaseSDNode {
1672 friend class SelectionDAG;
1673 LoadSDNode(SDValue *ChainPtrOff, DebugLoc dl, SDVTList VTs,
1674 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT MemVT,
1675 MachineMemOperand *MMO)
1676 : LSBaseSDNode(ISD::LOAD, dl, ChainPtrOff, 3,
1677 VTs, AM, MemVT, MMO) {
1678 SubclassData |= (unsigned short)ETy;
1679 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
1680 assert(readMem() && "Load MachineMemOperand is not a load!");
1681 assert(!writeMem() && "Load MachineMemOperand is a store!");
1685 /// getExtensionType - Return whether this is a plain node,
1686 /// or one of the varieties of value-extending loads.
1687 ISD::LoadExtType getExtensionType() const {
1688 return ISD::LoadExtType(SubclassData & 3);
1691 const SDValue &getBasePtr() const { return getOperand(1); }
1692 const SDValue &getOffset() const { return getOperand(2); }
1694 static bool classof(const LoadSDNode *) { return true; }
1695 static bool classof(const SDNode *N) {
1696 return N->getOpcode() == ISD::LOAD;
1700 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
1702 class StoreSDNode : public LSBaseSDNode {
1703 friend class SelectionDAG;
1704 StoreSDNode(SDValue *ChainValuePtrOff, DebugLoc dl, SDVTList VTs,
1705 ISD::MemIndexedMode AM, bool isTrunc, EVT MemVT,
1706 MachineMemOperand *MMO)
1707 : LSBaseSDNode(ISD::STORE, dl, ChainValuePtrOff, 4,
1708 VTs, AM, MemVT, MMO) {
1709 SubclassData |= (unsigned short)isTrunc;
1710 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
1711 assert(!readMem() && "Store MachineMemOperand is a load!");
1712 assert(writeMem() && "Store MachineMemOperand is not a store!");
1716 /// isTruncatingStore - Return true if the op does a truncation before store.
1717 /// For integers this is the same as doing a TRUNCATE and storing the result.
1718 /// For floats, it is the same as doing an FP_ROUND and storing the result.
1719 bool isTruncatingStore() const { return SubclassData & 1; }
1721 const SDValue &getValue() const { return getOperand(1); }
1722 const SDValue &getBasePtr() const { return getOperand(2); }
1723 const SDValue &getOffset() const { return getOperand(3); }
1725 static bool classof(const StoreSDNode *) { return true; }
1726 static bool classof(const SDNode *N) {
1727 return N->getOpcode() == ISD::STORE;
1731 /// MachineSDNode - An SDNode that represents everything that will be needed
1732 /// to construct a MachineInstr. These nodes are created during the
1733 /// instruction selection proper phase.
1735 class MachineSDNode : public SDNode {
1737 typedef MachineMemOperand **mmo_iterator;
1740 friend class SelectionDAG;
1741 MachineSDNode(unsigned Opc, const DebugLoc DL, SDVTList VTs)
1742 : SDNode(Opc, DL, VTs), MemRefs(0), MemRefsEnd(0) {}
1744 /// LocalOperands - Operands for this instruction, if they fit here. If
1745 /// they don't, this field is unused.
1746 SDUse LocalOperands[4];
1748 /// MemRefs - Memory reference descriptions for this instruction.
1749 mmo_iterator MemRefs;
1750 mmo_iterator MemRefsEnd;
1753 mmo_iterator memoperands_begin() const { return MemRefs; }
1754 mmo_iterator memoperands_end() const { return MemRefsEnd; }
1755 bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
1757 /// setMemRefs - Assign this MachineSDNodes's memory reference descriptor
1758 /// list. This does not transfer ownership.
1759 void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
1760 MemRefs = NewMemRefs;
1761 MemRefsEnd = NewMemRefsEnd;
1764 static bool classof(const MachineSDNode *) { return true; }
1765 static bool classof(const SDNode *N) {
1766 return N->isMachineOpcode();
1770 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
1771 SDNode, ptrdiff_t> {
1775 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1777 bool operator==(const SDNodeIterator& x) const {
1778 return Operand == x.Operand;
1780 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1782 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1783 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1784 Operand = I.Operand;
1788 pointer operator*() const {
1789 return Node->getOperand(Operand).getNode();
1791 pointer operator->() const { return operator*(); }
1793 SDNodeIterator& operator++() { // Preincrement
1797 SDNodeIterator operator++(int) { // Postincrement
1798 SDNodeIterator tmp = *this; ++*this; return tmp;
1800 size_t operator-(SDNodeIterator Other) const {
1801 assert(Node == Other.Node &&
1802 "Cannot compare iterators of two different nodes!");
1803 return Operand - Other.Operand;
1806 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
1807 static SDNodeIterator end (SDNode *N) {
1808 return SDNodeIterator(N, N->getNumOperands());
1811 unsigned getOperand() const { return Operand; }
1812 const SDNode *getNode() const { return Node; }
1815 template <> struct GraphTraits<SDNode*> {
1816 typedef SDNode NodeType;
1817 typedef SDNodeIterator ChildIteratorType;
1818 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1819 static inline ChildIteratorType child_begin(NodeType *N) {
1820 return SDNodeIterator::begin(N);
1822 static inline ChildIteratorType child_end(NodeType *N) {
1823 return SDNodeIterator::end(N);
1827 /// LargestSDNode - The largest SDNode class.
1829 typedef LoadSDNode LargestSDNode;
1831 /// MostAlignedSDNode - The SDNode class with the greatest alignment
1834 typedef GlobalAddressSDNode MostAlignedSDNode;
1837 /// isNormalLoad - Returns true if the specified node is a non-extending
1838 /// and unindexed load.
1839 inline bool isNormalLoad(const SDNode *N) {
1840 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
1841 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
1842 Ld->getAddressingMode() == ISD::UNINDEXED;
1845 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1847 inline bool isNON_EXTLoad(const SDNode *N) {
1848 return isa<LoadSDNode>(N) &&
1849 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1852 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1854 inline bool isEXTLoad(const SDNode *N) {
1855 return isa<LoadSDNode>(N) &&
1856 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1859 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1861 inline bool isSEXTLoad(const SDNode *N) {
1862 return isa<LoadSDNode>(N) &&
1863 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1866 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1868 inline bool isZEXTLoad(const SDNode *N) {
1869 return isa<LoadSDNode>(N) &&
1870 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1873 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
1875 inline bool isUNINDEXEDLoad(const SDNode *N) {
1876 return isa<LoadSDNode>(N) &&
1877 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1880 /// isNormalStore - Returns true if the specified node is a non-truncating
1881 /// and unindexed store.
1882 inline bool isNormalStore(const SDNode *N) {
1883 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
1884 return St && !St->isTruncatingStore() &&
1885 St->getAddressingMode() == ISD::UNINDEXED;
1888 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1890 inline bool isNON_TRUNCStore(const SDNode *N) {
1891 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
1894 /// isTRUNCStore - Returns true if the specified node is a truncating
1896 inline bool isTRUNCStore(const SDNode *N) {
1897 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
1900 /// isUNINDEXEDStore - Returns true if the specified node is an
1901 /// unindexed store.
1902 inline bool isUNINDEXEDStore(const SDNode *N) {
1903 return isa<StoreSDNode>(N) &&
1904 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1908 } // end llvm namespace