1 //===-- llvm/User.h - User class definition ---------------------*- 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 class defines the interface that one who uses a Value must implement.
11 // Each instance of the Value class keeps track of what User's have handles
14 // * Instructions are the largest class of Users.
15 // * Constants may be users of other constants (think arrays and stuff)
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_IR_USER_H
20 #define LLVM_IR_USER_H
22 #include "llvm/ADT/iterator.h"
23 #include "llvm/ADT/iterator_range.h"
24 #include "llvm/IR/Value.h"
25 #include "llvm/Support/ErrorHandling.h"
29 /// \brief Compile-time customization of User operands.
31 /// Customizes operand-related allocators and accessors.
35 class User : public Value {
36 User(const User &) = delete;
38 friend struct HungoffOperandTraits;
39 virtual void anchor();
42 /// Allocate a User with an operand pointer co-allocated.
44 /// This is used for subclasses which need to allocate a variable number
45 /// of operands, ie, 'hung off uses'.
46 void *operator new(size_t Size);
48 /// Allocate a User with the operands co-allocated.
50 /// This is used for subclasses which have a fixed number of operands.
51 void *operator new(size_t Size, unsigned Us);
53 User(Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
55 assert(NumOps < (1u << NumUserOperandsBits) && "Too many operands");
56 NumUserOperands = NumOps;
57 // If we have hung off uses, then the operand list should initially be
59 assert((!HasHungOffUses || !getOperandList()) &&
60 "Error in initializing hung off uses for User");
63 /// \brief Allocate the array of Uses, followed by a pointer
64 /// (with bottom bit set) to the User.
65 /// \param IsPhi identifies callers which are phi nodes and which need
66 /// N BasicBlock* allocated along with N
67 void allocHungoffUses(unsigned N, bool IsPhi = false);
69 /// \brief Grow the number of hung off uses. Note that allocHungoffUses
70 /// should be called if there are no uses.
71 void growHungoffUses(unsigned N, bool IsPhi = false);
76 /// \brief Free memory allocated for User and Use objects.
77 void operator delete(void *Usr);
78 /// \brief Placement delete - required by std, but never called.
79 void operator delete(void*, unsigned) {
80 llvm_unreachable("Constructor throws?");
82 /// \brief Placement delete - required by std, but never called.
83 void operator delete(void*, unsigned, bool) {
84 llvm_unreachable("Constructor throws?");
87 template <int Idx, typename U> static Use &OpFrom(const U *that) {
89 ? OperandTraits<U>::op_end(const_cast<U*>(that))[Idx]
90 : OperandTraits<U>::op_begin(const_cast<U*>(that))[Idx];
92 template <int Idx> Use &Op() {
93 return OpFrom<Idx>(this);
95 template <int Idx> const Use &Op() const {
96 return OpFrom<Idx>(this);
99 Use *&getHungOffOperands() { return *(reinterpret_cast<Use **>(this) - 1); }
101 Use *getIntrusiveOperands() {
102 return reinterpret_cast<Use *>(this) - NumUserOperands;
105 void setOperandList(Use *NewList) {
106 assert(HasHungOffUses &&
107 "Setting operand list only required for hung off uses");
108 getHungOffOperands() = NewList;
111 Use *getOperandList() {
112 return HasHungOffUses ? getHungOffOperands() : getIntrusiveOperands();
114 const Use *getOperandList() const {
115 return const_cast<User *>(this)->getOperandList();
117 Value *getOperand(unsigned i) const {
118 assert(i < NumUserOperands && "getOperand() out of range!");
119 return getOperandList()[i];
121 void setOperand(unsigned i, Value *Val) {
122 assert(i < NumUserOperands && "setOperand() out of range!");
123 assert((!isa<Constant>((const Value*)this) ||
124 isa<GlobalValue>((const Value*)this)) &&
125 "Cannot mutate a constant with setOperand!");
126 getOperandList()[i] = Val;
128 const Use &getOperandUse(unsigned i) const {
129 assert(i < NumUserOperands && "getOperandUse() out of range!");
130 return getOperandList()[i];
132 Use &getOperandUse(unsigned i) {
133 assert(i < NumUserOperands && "getOperandUse() out of range!");
134 return getOperandList()[i];
137 unsigned getNumOperands() const { return NumUserOperands; }
139 /// Set the number of operands on a GlobalVariable.
141 /// GlobalVariable always allocates space for a single operands, but
142 /// doesn't always use it.
144 /// FIXME: As that the number of operands is used to find the start of
145 /// the allocated memory in operator delete, we need to always think we have
146 /// 1 operand before delete.
147 void setGlobalVariableNumOperands(unsigned NumOps) {
148 assert(NumOps <= 1 && "GlobalVariable can only have 0 or 1 operands");
149 NumUserOperands = NumOps;
152 /// \brief Subclasses with hung off uses need to manage the operand count
153 /// themselves. In these instances, the operand count isn't used to find the
154 /// OperandList, so there's no issue in having the operand count change.
155 void setNumHungOffUseOperands(unsigned NumOps) {
156 assert(HasHungOffUses && "Must have hung off uses to use this method");
157 assert(NumOps < (1u << NumUserOperandsBits) && "Too many operands");
158 NumUserOperands = NumOps;
161 // ---------------------------------------------------------------------------
162 // Operand Iterator interface...
164 typedef Use* op_iterator;
165 typedef const Use* const_op_iterator;
166 typedef iterator_range<op_iterator> op_range;
167 typedef iterator_range<const_op_iterator> const_op_range;
169 inline op_iterator op_begin() { return getOperandList(); }
170 inline const_op_iterator op_begin() const { return getOperandList(); }
171 inline op_iterator op_end() {
172 return getOperandList() + NumUserOperands;
174 inline const_op_iterator op_end() const {
175 return getOperandList() + NumUserOperands;
177 inline op_range operands() {
178 return op_range(op_begin(), op_end());
180 inline const_op_range operands() const {
181 return const_op_range(op_begin(), op_end());
184 /// \brief Iterator for directly iterating over the operand Values.
185 struct value_op_iterator
186 : iterator_adaptor_base<value_op_iterator, op_iterator,
187 std::random_access_iterator_tag, Value *,
188 ptrdiff_t, Value *, Value *> {
189 explicit value_op_iterator(Use *U = nullptr) : iterator_adaptor_base(U) {}
191 Value *operator*() const { return *I; }
192 Value *operator->() const { return operator*(); }
195 inline value_op_iterator value_op_begin() {
196 return value_op_iterator(op_begin());
198 inline value_op_iterator value_op_end() {
199 return value_op_iterator(op_end());
201 inline iterator_range<value_op_iterator> operand_values() {
202 return iterator_range<value_op_iterator>(value_op_begin(), value_op_end());
205 /// \brief Drop all references to operands.
207 /// This function is in charge of "letting go" of all objects that this User
208 /// refers to. This allows one to 'delete' a whole class at a time, even
209 /// though there may be circular references... First all references are
210 /// dropped, and all use counts go to zero. Then everything is deleted for
211 /// real. Note that no operations are valid on an object that has "dropped
212 /// all references", except operator delete.
213 void dropAllReferences() {
214 for (Use &U : operands())
218 /// \brief Replace uses of one Value with another.
220 /// Replaces all references to the "From" definition with references to the
222 void replaceUsesOfWith(Value *From, Value *To);
224 // Methods for support type inquiry through isa, cast, and dyn_cast:
225 static inline bool classof(const Value *V) {
226 return isa<Instruction>(V) || isa<Constant>(V);
230 template<> struct simplify_type<User::op_iterator> {
231 typedef Value* SimpleType;
232 static SimpleType getSimplifiedValue(User::op_iterator &Val) {
236 template<> struct simplify_type<User::const_op_iterator> {
237 typedef /*const*/ Value* SimpleType;
238 static SimpleType getSimplifiedValue(User::const_op_iterator &Val) {
243 } // End llvm namespace