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 protected:
  88   template <int Idx, typename U> static Use &OpFrom(const U *that) {
  89     return Idx < 0
  90       ? OperandTraits<U>::op_end(const_cast<U*>(that))[Idx]
  91       : OperandTraits<U>::op_begin(const_cast<U*>(that))[Idx];
  92   }
  93   template <int Idx> Use &Op() {
  94     return OpFrom<Idx>(this);
  95   }
  96   template <int Idx> const Use &Op() const {
  97     return OpFrom<Idx>(this);
  98   }
  99 public:
 100   Value *getOperand(unsigned i) const {
 101     assert(i < NumOperands && "getOperand() out of range!");
 102     return OperandList[i];
 103   }
 104   void setOperand(unsigned i, Value *Val) {
 105     assert(i < NumOperands && "setOperand() out of range!");
 106     assert((!isa<Constant>((const Value*)this) ||
 107             isa<GlobalValue>((const Value*)this)) &&
 108            "Cannot mutate a constant with setOperand!");
 109     OperandList[i] = Val;
 110   }
 111   const Use &getOperandUse(unsigned i) const {
 112     assert(i < NumOperands && "getOperand() out of range!");
 113     return OperandList[i];
 114   }
 115   Use &getOperandUse(unsigned i) {
 116     assert(i < NumOperands && "getOperand() out of range!");
 117     return OperandList[i];
 118   }
 119
 120   unsigned getNumOperands() const { return NumOperands; }
 121
 122   // ---------------------------------------------------------------------------
 123   // Operand Iterator interface...
 124   //
 125   typedef Use*       op_iterator;
 126   typedef const Use* const_op_iterator;
 127
 128   inline op_iterator       op_begin()       { return OperandList; }
 129   inline const_op_iterator op_begin() const { return OperandList; }
 130   inline op_iterator       op_end()         { return OperandList+NumOperands; }
 131   inline const_op_iterator op_end()   const { return OperandList+NumOperands; }
 132
 133   // dropAllReferences() - This function is in charge of "letting go" of all
 134   // objects that this User refers to.  This allows one to
 135   // 'delete' a whole class at a time, even though there may be circular
 136   // references...  First all references are dropped, and all use counts go to
 137   // zero.  Then everything is deleted for real.  Note that no operations are
 138   // valid on an object that has "dropped all references", except operator
 139   // delete.
 140   //
 141   void dropAllReferences() {
 142     for (op_iterator i = op_begin(), e = op_end(); i != e; ++i)
 143       i->set(0);
 144   }
 145
 146   /// replaceUsesOfWith - Replaces all references to the "From" definition with
 147   /// references to the "To" definition.
 148   ///
 149   void replaceUsesOfWith(Value *From, Value *To);
 150
 151   // Methods for support type inquiry through isa, cast, and dyn_cast:
 152   static inline bool classof(const User *) { return true; }
 153   static inline bool classof(const Value *V) {
 154     return isa<Instruction>(V) || isa<Constant>(V);
 155   }
 156 };
 157
 158 inline Use *OperandTraits<User>::op_begin(User *U) {
 159   return U->op_begin();
 160 }
 161
 162 inline Use *OperandTraits<User>::op_end(User *U) {
 163   return U->op_end();
 164 }
 165
 166 inline unsigned OperandTraits<User>::operands(const User *U) {
 167   return U->getNumOperands();
 168 }
 169
 170 template<> struct simplify_type<User::op_iterator> {
 171   typedef Value* SimpleType;
 172
 173   static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
 174     return static_cast<SimpleType>(Val->get());
 175   }
 176 };
 177
 178 template<> struct simplify_type<const User::op_iterator>
 179   : public simplify_type<User::op_iterator> {};
 180
 181 template<> struct simplify_type<User::const_op_iterator> {
 182   typedef Value* SimpleType;
 183
 184   static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
 185     return static_cast<SimpleType>(Val->get());
 186   }
 187 };
 188
 189 template<> struct simplify_type<const User::const_op_iterator>
 190   : public simplify_type<User::const_op_iterator> {};
 191
 192
 193 // value_use_iterator::getOperandNo - Requires the definition of the User class.
 194 template<typename UserTy>
 195 unsigned value_use_iterator<UserTy>::getOperandNo() const {
 196   return U - U->getUser()->op_begin();
 197 }
 198
 199 } // End llvm namespace
 200
 201 #endif