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 short SubclassID;         // Subclass identifier (for isa/dyn_cast)
  45 protected:
  46   /// SubclassData - This member is defined by this class, but is not used for
  47   /// anything.  Subclasses can use it to hold whatever state they find useful.
  48   /// This field is initialized to zero by the ctor.
  49   unsigned short SubclassData;
  50 private:
  51   PATypeHolder Ty;
  52   Use *UseList;
  53   std::string Name;
  54
  55   void operator=(const Value &);     // Do not implement
  56   Value(const Value &);              // Do not implement
  57
  58 public:
  59   Value(const Type *Ty, unsigned scid, const std::string &name = "");
  60   virtual ~Value();
  61
  62   /// dump - Support for debugging, callable in GDB: V->dump()
  63   //
  64   virtual void dump() const;
  65
  66   /// print - Implement operator<< on Value...
  67   ///
  68   virtual void print(std::ostream &O) const = 0;
  69
  70   /// All values are typed, get the type of this value.
  71   ///
  72   inline const Type *getType() const { return Ty; }
  73
  74   // All values can potentially be named...
  75   inline bool               hasName() const { return !Name.empty(); }
  76   inline const std::string &getName() const { return Name; }
  77
  78   virtual void setName(const std::string &name, SymbolTable * = 0) {
  79     Name = name;
  80   }
  81
  82   /// replaceAllUsesWith - Go through the uses list for this definition and make
  83   /// each use point to "V" instead of "this".  After this completes, 'this's
  84   /// use list is guaranteed to be empty.
  85   ///
  86   void replaceAllUsesWith(Value *V);
  87
  88   // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
  89   // Only use when in type resolution situations!
  90   void uncheckedReplaceAllUsesWith(Value *V);
  91
  92   //----------------------------------------------------------------------
  93   // Methods for handling the vector of uses of this Value.
  94   //
  95   typedef value_use_iterator<User>       use_iterator;
  96   typedef value_use_iterator<const User> use_const_iterator;
  97
  98   bool               use_empty() const { return UseList == 0; }
  99   use_iterator       use_begin()       { return use_iterator(UseList); }
 100   use_const_iterator use_begin() const { return use_const_iterator(UseList); }
 101   use_iterator       use_end()         { return use_iterator(0);   }
 102   use_const_iterator use_end()   const { return use_const_iterator(0);   }
 103   User              *use_back()        { return *use_begin(); }
 104   const User        *use_back() const  { return *use_begin(); }
 105
 106   /// hasOneUse - Return true if there is exactly one user of this value.  This
 107   /// is specialized because it is a common request and does not require
 108   /// traversing the whole use list.
 109   ///
 110   bool hasOneUse() const {
 111     use_const_iterator I = use_begin(), E = use_end();
 112     if (I == E) return false;
 113     return ++I == E;
 114   }
 115
 116   /// hasNUses - Return true if this Value has exactly N users.
 117   ///
 118   bool hasNUses(unsigned N) const;
 119
 120   /// getNumUses - This method computes the number of uses of this Value.  This
 121   /// is a linear time operation.  Use hasOneUse or hasNUses to check for
 122   /// specific values.
 123   unsigned getNumUses() const;
 124
 125   /// addUse/killUse - These two methods should only be used by the Use class.
 126   ///
 127   void addUse(Use &U) { U.addToList(&UseList); }
 128
 129   /// getValueType - Return an ID for the concrete type of this object.  This is
 130   /// used to implement the classof checks.  This should not be used for any
 131   /// other purpose, as the values may change as LLVM evolves.  Also, note that
 132   /// starting with the InstructionVal value, the value stored is actually the
 133   /// Instruction opcode, so there are more than just these values possible here
 134   /// (and Instruction must be last).
 135   ///
 136   enum ValueTy {
 137     ArgumentVal,              // This is an instance of Argument
 138     BasicBlockVal,            // This is an instance of BasicBlock
 139     FunctionVal,              // This is an instance of Function
 140     GlobalVariableVal,        // This is an instance of GlobalVariable
 141     UndefValueVal,            // This is an instance of UndefValue
 142     ConstantExprVal,          // This is an instance of ConstantExpr
 143     ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
 144     SimpleConstantVal,        // This is some other type of Constant
 145     InstructionVal,           // This is an instance of Instruction
 146     ValueListVal              // This is for bcreader, a special ValTy
 147   };
 148   unsigned getValueType() const {
 149     return SubclassID;
 150   }
 151
 152   // Methods for support type inquiry through isa, cast, and dyn_cast:
 153   static inline bool classof(const Value *V) {
 154     return true; // Values are always values.
 155   }
 156
 157   /// getRawType - This should only be used to implement the vmcore library.
 158   ///
 159   const Type *getRawType() const { return Ty.getRawType(); }
 160
 161 private:
 162   /// FIXME: this is a gross hack, needed by another gross hack.  Eliminate!
 163   void setValueType(unsigned VT) { SubclassID = VT; }
 164   friend class Instruction;
 165 };
 166
 167 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
 168   V.print(OS);
 169   return OS;
 170 }
 171
 172 void Use::init(Value *v, User *user) {
 173   Val = v;
 174   U = user;
 175   if (Val) Val->addUse(*this);
 176 }
 177
 178 Use::~Use() {
 179   if (Val) removeFromList();
 180 }
 181
 182 void Use::set(Value *V) {
 183   if (Val) removeFromList();
 184   Val = V;
 185   if (V) V->addUse(*this);
 186 }
 187
 188
 189 // isa - Provide some specializations of isa so that we don't have to include
 190 // the subtype header files to test to see if the value is a subclass...
 191 //
 192 template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
 193   return Val.getValueType() == Value::SimpleConstantVal ||
 194          Val.getValueType() == Value::FunctionVal ||
 195          Val.getValueType() == Value::GlobalVariableVal ||
 196          Val.getValueType() == Value::ConstantExprVal ||
 197          Val.getValueType() == Value::ConstantAggregateZeroVal ||
 198          Val.getValueType() == Value::UndefValueVal;
 199 }
 200 template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
 201   return Val.getValueType() == Value::ArgumentVal;
 202 }
 203 template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
 204   return Val.getValueType() >= Value::InstructionVal;
 205 }
 206 template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
 207   return Val.getValueType() == Value::BasicBlockVal;
 208 }
 209 template <> inline bool isa_impl<Function, Value>(const Value &Val) {
 210   return Val.getValueType() == Value::FunctionVal;
 211 }
 212 template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
 213   return Val.getValueType() == Value::GlobalVariableVal;
 214 }
 215 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
 216   return isa<GlobalVariable>(Val) || isa<Function>(Val);
 217 }
 218
 219 } // End llvm namespace
 220
 221 #endif