include/llvm/Value.h

   1 //===-- llvm/Value.h - Definition of the Value class ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the very important Value class.  This is subclassed by a
  11 // bunch of other important classes, like Instruction, Function, Type, etc...
  12 //
  13 // This file also defines the Use<> template for users of value.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_VALUE_H
  18 #define LLVM_VALUE_H
  19
  20 #include "llvm/AbstractTypeUser.h"
  21 #include "llvm/Use.h"
  22 #include "llvm/Support/Casting.h"
  23 #include <string>
  24
  25 namespace llvm {
  26
  27 class Constant;
  28 class Argument;
  29 class Instruction;
  30 class BasicBlock;
  31 class GlobalValue;
  32 class Function;
  33 class GlobalVariable;
  34 class SymbolTable;
  35
  36 //===----------------------------------------------------------------------===//
  37 //                                 Value Class
  38 //===----------------------------------------------------------------------===//
  39
  40 /// Value - The base class of all values computed by a program that may be used
  41 /// as operands to other values.
  42 ///
  43 class Value {
  44   unsigned SubclassID;               // Subclass identifier (for isa/dyn_cast)
  45   PATypeHolder Ty;
  46   iplist<Use> Uses;
  47   std::string Name;
  48
  49   void operator=(const Value &);     // Do not implement
  50   Value(const Value &);              // Do not implement
  51
  52 public:
  53   Value(const Type *Ty, unsigned scid, const std::string &name = "");
  54   virtual ~Value();
  55
  56   /// dump - Support for debugging, callable in GDB: V->dump()
  57   //
  58   virtual void dump() const;
  59
  60   /// print - Implement operator<< on Value...
  61   ///
  62   virtual void print(std::ostream &O) const = 0;
  63
  64   /// All values are typed, get the type of this value.
  65   ///
  66   inline const Type *getType() const { return Ty; }
  67
  68   // All values can potentially be named...
  69   inline bool               hasName() const { return !Name.empty(); }
  70   inline const std::string &getName() const { return Name; }
  71
  72   virtual void setName(const std::string &name, SymbolTable * = 0) {
  73     Name = name;
  74   }
  75
  76   /// replaceAllUsesWith - Go through the uses list for this definition and make
  77   /// each use point to "V" instead of "this".  After this completes, 'this's
  78   /// use list is guaranteed to be empty.
  79   ///
  80   void replaceAllUsesWith(Value *V);
  81
  82   // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
  83   // Only use when in type resolution situations!
  84   void uncheckedReplaceAllUsesWith(Value *V);
  85
  86   //----------------------------------------------------------------------
  87   // Methods for handling the vector of uses of this Value.
  88   //
  89   typedef UseListIteratorWrapper      use_iterator;
  90   typedef UseListConstIteratorWrapper use_const_iterator;
  91   typedef iplist<Use>::size_type      size_type;
  92
  93   size_type          use_size()  const { return Uses.size();  }
  94   bool               use_empty() const { return Uses.empty(); }
  95   use_iterator       use_begin()       { return Uses.begin(); }
  96   use_const_iterator use_begin() const { return Uses.begin(); }
  97   use_iterator       use_end()         { return Uses.end();   }
  98   use_const_iterator use_end()   const { return Uses.end();   }
  99   User             *use_back()         { return Uses.back().getUser(); }
 100   const User       *use_back()  const  { return Uses.back().getUser(); }
 101
 102   /// hasOneUse - Return true if there is exactly one user of this value.  This
 103   /// is specialized because it is a common request and does not require
 104   /// traversing the whole use list.
 105   ///
 106   bool hasOneUse() const {
 107     iplist<Use>::const_iterator I = Uses.begin(), E = Uses.end();
 108     if (I == E) return false;
 109     return ++I == E;
 110   }
 111
 112   /// addUse/killUse - These two methods should only be used by the Use class.
 113   ///
 114   void addUse(Use &U)  { Uses.push_back(&U); }
 115   void killUse(Use &U) { Uses.remove(&U); }
 116
 117   /// getValueType - Return an ID for the concrete type of this object.  This is
 118   /// used to implement the classof checks.  This should not be used for any
 119   /// other purpose, as the values may change as LLVM evolves.  Also, note that
 120   /// starting with the InstructionVal value, the value stored is actually the
 121   /// Instruction opcode, so there are more than just these values possible here
 122   /// (and Instruction must be last).
 123   ///
 124   enum ValueTy {
 125     ArgumentVal,              // This is an instance of Argument
 126     BasicBlockVal,            // This is an instance of BasicBlock
 127     FunctionVal,              // This is an instance of Function
 128     GlobalVariableVal,        // This is an instance of GlobalVariable
 129     UndefValueVal,            // This is an instance of UndefValue
 130     ConstantExprVal,          // This is an instance of ConstantExpr
 131     ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
 132     SimpleConstantVal,        // This is some other type of Constant
 133     InstructionVal,           // This is an instance of Instruction
 134     ValueListVal              // This is for bcreader, a special ValTy
 135   };
 136   unsigned getValueType() const {
 137     return SubclassID;
 138   }
 139
 140   // Methods for support type inquiry through isa, cast, and dyn_cast:
 141   static inline bool classof(const Value *V) {
 142     return true; // Values are always values.
 143   }
 144
 145   /// getRawType - This should only be used to implement the vmcore library.
 146   ///
 147   const Type *getRawType() const { return Ty.getRawType(); }
 148
 149 private:
 150   /// FIXME: this is a gross hack, needed by another gross hack.  Eliminate!
 151   void setValueType(unsigned VT) { SubclassID = VT; }
 152   friend class Instruction;
 153 };
 154
 155 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
 156   V.print(OS);
 157   return OS;
 158 }
 159
 160
 161 inline User *UseListIteratorWrapper::operator*() const {
 162   return Super::operator*().getUser();
 163 }
 164
 165 inline const User *UseListConstIteratorWrapper::operator*() const {
 166   return Super::operator*().getUser();
 167 }
 168
 169
 170 void Use::init(Value *v, User *user) {
 171   Val = v;
 172   U = user;
 173   if (Val) Val->addUse(*this);
 174 }
 175
 176 Use::~Use() {
 177   if (Val) Val->killUse(*this);
 178 }
 179
 180 void Use::set(Value *V) {
 181   if (Val) Val->killUse(*this);
 182   Val = V;
 183   if (V) V->addUse(*this);
 184 }
 185
 186
 187 // isa - Provide some specializations of isa so that we don't have to include
 188 // the subtype header files to test to see if the value is a subclass...
 189 //
 190 template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
 191   return Val.getValueType() == Value::SimpleConstantVal ||
 192          Val.getValueType() == Value::FunctionVal ||
 193          Val.getValueType() == Value::GlobalVariableVal ||
 194          Val.getValueType() == Value::ConstantExprVal ||
 195          Val.getValueType() == Value::ConstantAggregateZeroVal ||
 196          Val.getValueType() == Value::UndefValueVal;
 197 }
 198 template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
 199   return Val.getValueType() == Value::ArgumentVal;
 200 }
 201 template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
 202   return Val.getValueType() >= Value::InstructionVal;
 203 }
 204 template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
 205   return Val.getValueType() == Value::BasicBlockVal;
 206 }
 207 template <> inline bool isa_impl<Function, Value>(const Value &Val) {
 208   return Val.getValueType() == Value::FunctionVal;
 209 }
 210 template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
 211   return Val.getValueType() == Value::GlobalVariableVal;
 212 }
 213 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
 214   return isa<GlobalVariable>(Val) || isa<Function>(Val);
 215 }
 216
 217 } // End llvm namespace
 218
 219 #endif