PR2957
[oota-llvm.git] / include / llvm / User.h
1 //===-- llvm/User.h - User class definition ---------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This class defines the interface that one who 'use's a Value must implement.
11 // Each instance of the Value class keeps track of what User's have handles
12 // to it.
13 //
14 //  * Instructions are the largest class of User's.
15 //  * Constants may be users of other constants (think arrays and stuff)
16 //
17 //===----------------------------------------------------------------------===//
18
19 #ifndef LLVM_USER_H
20 #define LLVM_USER_H
21
22 #include "llvm/Value.h"
23
24 namespace llvm {
25
26 /// OperandTraits - Compile-time customization of
27 /// operand-related allocators and accessors
28 /// for use of the User class
29 template <class>
30 struct OperandTraits;
31
32 class User;
33
34 /// OperandTraits<User> - specialization to User
35 template <>
36 struct OperandTraits<User> {
37   static inline Use *op_begin(User*);
38   static inline Use *op_end(User*);
39   static inline unsigned operands(const User*);
40   template <class U>
41   struct Layout {
42     typedef U overlay;
43   };
44   static inline void *allocate(unsigned);
45 };
46
47 class User : public Value {
48   User(const User &);             // Do not implement
49   void *operator new(size_t);     // Do not implement
50   template <unsigned>
51   friend struct HungoffOperandTraits;
52 protected:
53   /// OperandList - This is a pointer to the array of Uses for this User.
54   /// For nodes of fixed arity (e.g. a binary operator) this array will live
55   /// prefixed to some derived class instance.  For nodes of resizable variable
56   /// arity (e.g. PHINodes, SwitchInst etc.), this memory will be dynamically
57   /// allocated and should be destroyed by the classes' virtual dtor.
58   Use *OperandList;
59
60   /// NumOperands - The number of values used by this User.
61   ///
62   unsigned NumOperands;
63
64   void *operator new(size_t s, unsigned Us);
65   void *operator new(size_t s, unsigned Us, bool Prefix);
66   User(const Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
67     : Value(ty, vty), OperandList(OpList), NumOperands(NumOps) {}
68   Use *allocHungoffUses(unsigned) const;
69   void dropHungoffUses(Use *U) {
70     if (OperandList == U) {
71       OperandList = 0;
72       NumOperands = 0;
73     }
74     Use::zap(U, U->getImpliedUser(), true);
75   }
76 public:
77   ~User() {
78     if ((intptr_t(OperandList) & 1) == 0)
79       Use::zap(OperandList, OperandList + NumOperands);
80   }
81   /// operator delete - free memory allocated for User and Use objects
82   void operator delete(void *Usr);
83   /// placement delete - required by std, but never called.
84   void operator delete(void*, unsigned) {
85     assert(0 && "Constructor throws?");
86   }
87   /// placement delete - required by std, but never called.
88   void operator delete(void*, unsigned, bool) {
89     assert(0 && "Constructor throws?");
90   }
91 protected:
92   template <int Idx, typename U> static Use &OpFrom(const U *that) {
93     return Idx < 0
94       ? OperandTraits<U>::op_end(const_cast<U*>(that))[Idx]
95       : OperandTraits<U>::op_begin(const_cast<U*>(that))[Idx];
96   }
97   template <int Idx> Use &Op() {
98     return OpFrom<Idx>(this);
99   }
100   template <int Idx> const Use &Op() const {
101     return OpFrom<Idx>(this);
102   }
103 public:
104   Value *getOperand(unsigned i) const {
105     assert(i < NumOperands && "getOperand() out of range!");
106     return OperandList[i];
107   }
108   void setOperand(unsigned i, Value *Val) {
109     assert(i < NumOperands && "setOperand() out of range!");
110     assert((!isa<Constant>((const Value*)this) ||
111             isa<GlobalValue>((const Value*)this)) &&
112            "Cannot mutate a constant with setOperand!");
113     OperandList[i] = Val;
114   }
115   const Use &getOperandUse(unsigned i) const {
116     assert(i < NumOperands && "getOperand() out of range!");
117     return OperandList[i];
118   }
119   Use &getOperandUse(unsigned i) {
120     assert(i < NumOperands && "getOperand() out of range!");
121     return OperandList[i];
122   }
123   
124   unsigned getNumOperands() const { return NumOperands; }
125
126   // ---------------------------------------------------------------------------
127   // Operand Iterator interface...
128   //
129   typedef Use*       op_iterator;
130   typedef const Use* const_op_iterator;
131
132   inline op_iterator       op_begin()       { return OperandList; }
133   inline const_op_iterator op_begin() const { return OperandList; }
134   inline op_iterator       op_end()         { return OperandList+NumOperands; }
135   inline const_op_iterator op_end()   const { return OperandList+NumOperands; }
136
137   // dropAllReferences() - This function is in charge of "letting go" of all
138   // objects that this User refers to.  This allows one to
139   // 'delete' a whole class at a time, even though there may be circular
140   // references...  First all references are dropped, and all use counts go to
141   // zero.  Then everything is deleted for real.  Note that no operations are
142   // valid on an object that has "dropped all references", except operator
143   // delete.
144   //
145   void dropAllReferences() {
146     for (op_iterator i = op_begin(), e = op_end(); i != e; ++i)
147       i->set(0);
148   }
149
150   /// replaceUsesOfWith - Replaces all references to the "From" definition with
151   /// references to the "To" definition.
152   ///
153   void replaceUsesOfWith(Value *From, Value *To);
154
155   // Methods for support type inquiry through isa, cast, and dyn_cast:
156   static inline bool classof(const User *) { return true; }
157   static inline bool classof(const Value *V) {
158     return isa<Instruction>(V) || isa<Constant>(V);
159   }
160 };
161
162 inline Use *OperandTraits<User>::op_begin(User *U) {
163   return U->op_begin();
164 }
165
166 inline Use *OperandTraits<User>::op_end(User *U) {
167   return U->op_end();
168 }
169
170 inline unsigned OperandTraits<User>::operands(const User *U) {
171   return U->getNumOperands();
172 }
173
174 template<> struct simplify_type<User::op_iterator> {
175   typedef Value* SimpleType;
176
177   static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
178     return static_cast<SimpleType>(Val->get());
179   }
180 };
181
182 template<> struct simplify_type<const User::op_iterator>
183   : public simplify_type<User::op_iterator> {};
184
185 template<> struct simplify_type<User::const_op_iterator> {
186   typedef Value* SimpleType;
187
188   static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
189     return static_cast<SimpleType>(Val->get());
190   }
191 };
192
193 template<> struct simplify_type<const User::const_op_iterator>
194   : public simplify_type<User::const_op_iterator> {};
195
196
197 // value_use_iterator::getOperandNo - Requires the definition of the User class.
198 template<typename UserTy>
199 unsigned value_use_iterator<UserTy>::getOperandNo() const {
200   return U - U->getUser()->op_begin();
201 }
202
203 } // End llvm namespace
204
205 #endif