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 declares the Value class.
  11 // This file also defines the Use<> template for users of value.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_VALUE_H
  16 #define LLVM_VALUE_H
  17
  18 #include "llvm/AbstractTypeUser.h"
  19 #include "llvm/Use.h"
  20 #include "llvm/Support/Casting.h"
  21 #include "llvm/Support/Streams.h"
  22 #include <string>
  23
  24 namespace llvm {
  25
  26 class Constant;
  27 class Argument;
  28 class Instruction;
  29 class BasicBlock;
  30 class GlobalValue;
  31 class Function;
  32 class GlobalVariable;
  33 class GlobalAlias;
  34 class InlineAsm;
  35 class ValueSymbolTable;
  36 class TypeSymbolTable;
  37 template<typename ValueTy> class StringMapEntry;
  38 typedef StringMapEntry<Value*> ValueName;
  39
  40 //===----------------------------------------------------------------------===//
  41 //                                 Value Class
  42 //===----------------------------------------------------------------------===//
  43
  44 /// This is a very important LLVM class. It is the base class of all values
  45 /// computed by a program that may be used as operands to other values. Value is
  46 /// the super class of other important classes such as Instruction and Function.
  47 /// All Values have a Type. Type is not a subclass of Value. All types can have
  48 /// a name and they should belong to some Module. Setting the name on the Value
  49 /// automatically update's the module's symbol table.
  50 ///
  51 /// Every value has a "use list" that keeps track of which other Values are
  52 /// using this Value.
  53 /// @brief LLVM Value Representation
  54 class Value {
  55   const unsigned short SubclassID;   // Subclass identifier (for isa/dyn_cast)
  56 protected:
  57   /// SubclassData - This member is defined by this class, but is not used for
  58   /// anything.  Subclasses can use it to hold whatever state they find useful.
  59   /// This field is initialized to zero by the ctor.
  60   unsigned short SubclassData;
  61 private:
  62   PATypeHolder Ty;
  63   Use *UseList;
  64
  65   friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name.
  66   friend class SymbolTable;      // Allow SymbolTable to directly poke Name.
  67   ValueName *Name;
  68
  69 private:
  70   void operator=(const Value &);     // Do not implement
  71   Value(const Value &);              // Do not implement
  72 protected:
  73   static void destroyThis(Value*);
  74
  75 public:
  76   Value(const Type *Ty, unsigned scid);
  77   virtual ~Value();
  78
  79   /// dump - Support for debugging, callable in GDB: V->dump()
  80   //
  81   virtual void dump() const;
  82
  83   /// print - Implement operator<< on Value...
  84   ///
  85   virtual void print(std::ostream &O) const = 0;
  86   void print(std::ostream *O) const { if (O) print(*O); }
  87
  88   /// All values are typed, get the type of this value.
  89   ///
  90   inline const Type *getType() const { return Ty; }
  91
  92   // All values can potentially be named...
  93   inline bool hasName() const { return Name != 0; }
  94   ValueName *getValueName() const { return Name; }
  95
  96   /// getNameStart - Return a pointer to a null terminated string for this name.
  97   /// Note that names can have null characters within the string as well as at
  98   /// their end.  This always returns a non-null pointer.
  99   const char *getNameStart() const;
 100
 101   /// getNameLen - Return the length of the string, correctly handling nul
 102   /// characters embedded into them.
 103   unsigned getNameLen() const;
 104
 105   /// getName()/getNameStr() - Return the name of the specified value,
 106   /// *constructing a string* to hold it.  Because these are guaranteed to
 107   /// construct a string, they are very expensive and should be avoided.
 108   std::string getName() const { return getNameStr(); }
 109   std::string getNameStr() const;
 110
 111
 112   void setName(const std::string &name);
 113   void setName(const char *Name, unsigned NameLen);
 114   void setName(const char *Name);  // Takes a null-terminated string.
 115
 116
 117   /// takeName - transfer the name from V to this value, setting V's name to
 118   /// empty.  It is an error to call V->takeName(V).
 119   void takeName(Value *V);
 120
 121   /// replaceAllUsesWith - Go through the uses list for this definition and make
 122   /// each use point to "V" instead of "this".  After this completes, 'this's
 123   /// use list is guaranteed to be empty.
 124   ///
 125   void replaceAllUsesWith(Value *V);
 126
 127   // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
 128   // Only use when in type resolution situations!
 129   void uncheckedReplaceAllUsesWith(Value *V);
 130
 131   //----------------------------------------------------------------------
 132   // Methods for handling the vector of uses of this Value.
 133   //
 134   typedef value_use_iterator<User>       use_iterator;
 135   typedef value_use_iterator<const User> use_const_iterator;
 136
 137   bool               use_empty() const { return UseList == 0; }
 138   use_iterator       use_begin()       { return use_iterator(UseList); }
 139   use_const_iterator use_begin() const { return use_const_iterator(UseList); }
 140   use_iterator       use_end()         { return use_iterator(0);   }
 141   use_const_iterator use_end()   const { return use_const_iterator(0);   }
 142   User              *use_back()        { return *use_begin(); }
 143   const User        *use_back() const  { return *use_begin(); }
 144
 145   /// hasOneUse - Return true if there is exactly one user of this value.  This
 146   /// is specialized because it is a common request and does not require
 147   /// traversing the whole use list.
 148   ///
 149   bool hasOneUse() const {
 150     use_const_iterator I = use_begin(), E = use_end();
 151     if (I == E) return false;
 152     return ++I == E;
 153   }
 154
 155   /// hasNUses - Return true if this Value has exactly N users.
 156   ///
 157   bool hasNUses(unsigned N) const;
 158
 159   /// hasNUsesOrMore - Return true if this value has N users or more.  This is
 160   /// logically equivalent to getNumUses() >= N.
 161   ///
 162   bool hasNUsesOrMore(unsigned N) const;
 163
 164   /// getNumUses - This method computes the number of uses of this Value.  This
 165   /// is a linear time operation.  Use hasOneUse, hasNUses, or hasMoreThanNUses
 166   /// to check for specific values.
 167   unsigned getNumUses() const;
 168
 169   /// addUse/killUse - These two methods should only be used by the Use class.
 170   ///
 171   void addUse(Use &U) { U.addToList(&UseList); }
 172
 173   /// An enumeration for keeping track of the concrete subclass of Value that
 174   /// is actually instantiated. Values of this enumeration are kept in the
 175   /// Value classes SubclassID field. They are used for concrete type
 176   /// identification.
 177   enum ValueTy {
 178     ArgumentVal,              // This is an instance of Argument
 179     BasicBlockVal,            // This is an instance of BasicBlock
 180     FunctionVal,              // This is an instance of Function
 181     GlobalAliasVal,           // This is an instance of GlobalAlias
 182     GlobalVariableVal,        // This is an instance of GlobalVariable
 183     UndefValueVal,            // This is an instance of UndefValue
 184     ConstantExprVal,          // This is an instance of ConstantExpr
 185     ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
 186     ConstantIntVal,           // This is an instance of ConstantInt
 187     ConstantFPVal,            // This is an instance of ConstantFP
 188     ConstantArrayVal,         // This is an instance of ConstantArray
 189     ConstantStructVal,        // This is an instance of ConstantStruct
 190     ConstantVectorVal,        // This is an instance of ConstantVector
 191     ConstantPointerNullVal,   // This is an instance of ConstantPointerNull
 192     InlineAsmVal,             // This is an instance of InlineAsm
 193     InstructionVal,           // This is an instance of Instruction
 194
 195     // Markers:
 196     ConstantFirstVal = FunctionVal,
 197     ConstantLastVal  = ConstantPointerNullVal
 198   };
 199
 200   /// getValueID - Return an ID for the concrete type of this object.  This is
 201   /// used to implement the classof checks.  This should not be used for any
 202   /// other purpose, as the values may change as LLVM evolves.  Also, note that
 203   /// for instructions, the Instruction's opcode is added to InstructionVal. So
 204   /// this means three things:
 205   /// # there is no value with code InstructionVal (no opcode==0).
 206   /// # there are more possible values for the value type than in ValueTy enum.
 207   /// # the InstructionVal enumerator must be the highest valued enumerator in
 208   ///   the ValueTy enum.
 209   unsigned getValueID() const {
 210     return SubclassID;
 211   }
 212
 213   // Methods for support type inquiry through isa, cast, and dyn_cast:
 214   static inline bool classof(const Value *) {
 215     return true; // Values are always values.
 216   }
 217
 218   /// getRawType - This should only be used to implement the vmcore library.
 219   ///
 220   const Type *getRawType() const { return Ty.getRawType(); }
 221 };
 222
 223 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
 224   V.print(OS);
 225   return OS;
 226 }
 227
 228 void Use::init(Value *v, User *user) {
 229   Val = v;
 230   U = user;
 231   if (Val) Val->addUse(*this);
 232 }
 233
 234 Use::~Use() {
 235   if (Val) removeFromList();
 236 }
 237
 238 void Use::set(Value *V) {
 239   if (Val) removeFromList();
 240   Val = V;
 241   if (V) V->addUse(*this);
 242 }
 243
 244
 245 // isa - Provide some specializations of isa so that we don't have to include
 246 // the subtype header files to test to see if the value is a subclass...
 247 //
 248 template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
 249   return Val.getValueID() >= Value::ConstantFirstVal &&
 250          Val.getValueID() <= Value::ConstantLastVal;
 251 }
 252 template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
 253   return Val.getValueID() == Value::ArgumentVal;
 254 }
 255 template <> inline bool isa_impl<InlineAsm, Value>(const Value &Val) {
 256   return Val.getValueID() == Value::InlineAsmVal;
 257 }
 258 template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
 259   return Val.getValueID() >= Value::InstructionVal;
 260 }
 261 template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
 262   return Val.getValueID() == Value::BasicBlockVal;
 263 }
 264 template <> inline bool isa_impl<Function, Value>(const Value &Val) {
 265   return Val.getValueID() == Value::FunctionVal;
 266 }
 267 template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
 268   return Val.getValueID() == Value::GlobalVariableVal;
 269 }
 270 template <> inline bool isa_impl<GlobalAlias, Value>(const Value &Val) {
 271   return Val.getValueID() == Value::GlobalAliasVal;
 272 }
 273 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
 274   return isa<GlobalVariable>(Val) || isa<Function>(Val) || isa<GlobalAlias>(Val);
 275 }
 276
 277 } // End llvm namespace
 278
 279 #endif