include/llvm/Value.h

   1 //===-- llvm/Value.h - Definition of the Value class ------------*- 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 file declares the Value class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_VALUE_H
  15 #define LLVM_VALUE_H
  16
  17 #include "llvm/AbstractTypeUser.h"
  18 #include "llvm/Use.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/ADT/Twine.h"
  21 #include "llvm/Support/Casting.h"
  22 #include <iosfwd>
  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 GlobalAlias;
  35 class InlineAsm;
  36 class ValueSymbolTable;
  37 class TypeSymbolTable;
  38 template<typename ValueTy> class StringMapEntry;
  39 template <typename ValueTy = Value>
  40 class AssertingVH;
  41 typedef StringMapEntry<Value*> ValueName;
  42 class raw_ostream;
  43 class AssemblyAnnotationWriter;
  44 class ValueHandleBase;
  45 struct LLVMContext;
  46
  47 //===----------------------------------------------------------------------===//
  48 //                                 Value Class
  49 //===----------------------------------------------------------------------===//
  50
  51 /// This is a very important LLVM class. It is the base class of all values
  52 /// computed by a program that may be used as operands to other values. Value is
  53 /// the super class of other important classes such as Instruction and Function.
  54 /// All Values have a Type. Type is not a subclass of Value. All types can have
  55 /// a name and they should belong to some Module. Setting the name on the Value
  56 /// automatically updates the module's symbol table.
  57 ///
  58 /// Every value has a "use list" that keeps track of which other Values are
  59 /// using this Value.  A Value can also have an arbitrary number of ValueHandle
  60 /// objects that watch it and listen to RAUW and Destroy events see
  61 /// llvm/Support/ValueHandle.h for details.
  62 ///
  63 /// @brief LLVM Value Representation
  64 class Value {
  65   const unsigned char SubclassID;   // Subclass identifier (for isa/dyn_cast)
  66   unsigned char HasValueHandle : 1; // Has a ValueHandle pointing to this?
  67 protected:
  68   /// SubclassOptionalData - This member is similar to SubclassData, however it
  69   /// is for holding information which may be used to aid optimization, but
  70   /// which may be cleared to zero without affecting conservative
  71   /// interpretation.
  72   unsigned char SubclassOptionalData : 7;
  73
  74   /// SubclassData - This member is defined by this class, but is not used for
  75   /// anything.  Subclasses can use it to hold whatever state they find useful.
  76   /// This field is initialized to zero by the ctor.
  77   unsigned short SubclassData;
  78 private:
  79   PATypeHolder VTy;
  80   Use *UseList;
  81
  82   friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name.
  83   friend class SymbolTable;      // Allow SymbolTable to directly poke Name.
  84   friend class ValueHandleBase;
  85   ValueName *Name;
  86
  87   void operator=(const Value &);     // Do not implement
  88   Value(const Value &);              // Do not implement
  89
  90 public:
  91   Value(const Type *Ty, unsigned scid);
  92   virtual ~Value();
  93
  94   /// dump - Support for debugging, callable in GDB: V->dump()
  95   //
  96   virtual void dump() const;
  97
  98   /// print - Implement operator<< on Value.
  99   ///
 100   void print(std::ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
 101   void print(raw_ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
 102
 103   /// All values are typed, get the type of this value.
 104   ///
 105   inline const Type *getType() const { return VTy; }
 106
 107   /// All values hold a context through their type.
 108   LLVMContext &getContext() const;
 109
 110   // All values can potentially be named...
 111   inline bool hasName() const { return Name != 0; }
 112   ValueName *getValueName() const { return Name; }
 113
 114   /// getName() - Return a constant reference to the value's name. This is cheap
 115   /// and guaranteed to return the same reference as long as the value is not
 116   /// modified.
 117   ///
 118   /// This is currently guaranteed to return a StringRef for which data() points
 119   /// to a valid null terminated string. The use of StringRef.data() is
 120   /// deprecated here, however, and clients should not rely on it. If such
 121   /// behavior is needed, clients should use expensive getNameStr(), or switch
 122   /// to an interface that does not depend on null termination.
 123   StringRef getName() const;
 124
 125   /// getNameStr() - Return the name of the specified value, *constructing a
 126   /// string* to hold it.  This is guaranteed to construct a string and is very
 127   /// expensive, clients should use getName() unless necessary.
 128   std::string getNameStr() const;
 129
 130   /// setName() - Change the name of the value, choosing a new unique name if
 131   /// the provided name is taken.
 132   ///
 133   /// \arg Name - The new name; or "" if the value's name should be removed.
 134   void setName(const Twine &Name);
 135
 136
 137   /// takeName - transfer the name from V to this value, setting V's name to
 138   /// empty.  It is an error to call V->takeName(V).
 139   void takeName(Value *V);
 140
 141   /// replaceAllUsesWith - Go through the uses list for this definition and make
 142   /// each use point to "V" instead of "this".  After this completes, 'this's
 143   /// use list is guaranteed to be empty.
 144   ///
 145   void replaceAllUsesWith(Value *V);
 146
 147   // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
 148   // Only use when in type resolution situations!
 149   void uncheckedReplaceAllUsesWith(Value *V);
 150
 151   /// clearOptionalData - Clear any optional optimization data from this Value.
 152   /// Transformation passes must call this method whenever changing the IR
 153   /// in a way that would affect the values produced by this Value, unless
 154   /// it takes special care to ensure correctness in some other way.
 155   void clearOptionalData() { SubclassOptionalData = 0; }
 156
 157   //----------------------------------------------------------------------
 158   // Methods for handling the chain of uses of this Value.
 159   //
 160   typedef value_use_iterator<User>       use_iterator;
 161   typedef value_use_iterator<const User> use_const_iterator;
 162
 163   bool               use_empty() const { return UseList == 0; }
 164   use_iterator       use_begin()       { return use_iterator(UseList); }
 165   use_const_iterator use_begin() const { return use_const_iterator(UseList); }
 166   use_iterator       use_end()         { return use_iterator(0);   }
 167   use_const_iterator use_end()   const { return use_const_iterator(0);   }
 168   User              *use_back()        { return *use_begin(); }
 169   const User        *use_back()  const { return *use_begin(); }
 170
 171   /// hasOneUse - Return true if there is exactly one user of this value.  This
 172   /// is specialized because it is a common request and does not require
 173   /// traversing the whole use list.
 174   ///
 175   bool hasOneUse() const {
 176     use_const_iterator I = use_begin(), E = use_end();
 177     if (I == E) return false;
 178     return ++I == E;
 179   }
 180
 181   /// hasNUses - Return true if this Value has exactly N users.
 182   ///
 183   bool hasNUses(unsigned N) const;
 184
 185   /// hasNUsesOrMore - Return true if this value has N users or more.  This is
 186   /// logically equivalent to getNumUses() >= N.
 187   ///
 188   bool hasNUsesOrMore(unsigned N) const;
 189
 190   bool isUsedInBasicBlock(const BasicBlock *BB) const;
 191
 192   /// getNumUses - This method computes the number of uses of this Value.  This
 193   /// is a linear time operation.  Use hasOneUse, hasNUses, or hasMoreThanNUses
 194   /// to check for specific values.
 195   unsigned getNumUses() const;
 196
 197   /// addUse - This method should only be used by the Use class.
 198   ///
 199   void addUse(Use &U) { U.addToList(&UseList); }
 200
 201   /// An enumeration for keeping track of the concrete subclass of Value that
 202   /// is actually instantiated. Values of this enumeration are kept in the
 203   /// Value classes SubclassID field. They are used for concrete type
 204   /// identification.
 205   enum ValueTy {
 206     ArgumentVal,              // This is an instance of Argument
 207     BasicBlockVal,            // This is an instance of BasicBlock
 208     FunctionVal,              // This is an instance of Function
 209     GlobalAliasVal,           // This is an instance of GlobalAlias
 210     GlobalVariableVal,        // This is an instance of GlobalVariable
 211     UndefValueVal,            // This is an instance of UndefValue
 212     ConstantExprVal,          // This is an instance of ConstantExpr
 213     ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
 214     ConstantIntVal,           // This is an instance of ConstantInt
 215     ConstantFPVal,            // This is an instance of ConstantFP
 216     ConstantArrayVal,         // This is an instance of ConstantArray
 217     ConstantStructVal,        // This is an instance of ConstantStruct
 218     ConstantVectorVal,        // This is an instance of ConstantVector
 219     ConstantPointerNullVal,   // This is an instance of ConstantPointerNull
 220     MDNodeVal,                // This is an instance of MDNode
 221     MDStringVal,              // This is an instance of MDString
 222     NamedMDNodeVal,           // This is an instance of NamedMDNode
 223     InlineAsmVal,             // This is an instance of InlineAsm
 224     PseudoSourceValueVal,     // This is an instance of PseudoSourceValue
 225     InstructionVal,           // This is an instance of Instruction
 226
 227     // Markers:
 228     ConstantFirstVal = FunctionVal,
 229     ConstantLastVal  = ConstantPointerNullVal
 230   };
 231
 232   /// getValueID - Return an ID for the concrete type of this object.  This is
 233   /// used to implement the classof checks.  This should not be used for any
 234   /// other purpose, as the values may change as LLVM evolves.  Also, note that
 235   /// for instructions, the Instruction's opcode is added to InstructionVal. So
 236   /// this means three things:
 237   /// # there is no value with code InstructionVal (no opcode==0).
 238   /// # there are more possible values for the value type than in ValueTy enum.
 239   /// # the InstructionVal enumerator must be the highest valued enumerator in
 240   ///   the ValueTy enum.
 241   unsigned getValueID() const {
 242     return SubclassID;
 243   }
 244
 245   // Methods for support type inquiry through isa, cast, and dyn_cast:
 246   static inline bool classof(const Value *) {
 247     return true; // Values are always values.
 248   }
 249
 250   /// getRawType - This should only be used to implement the vmcore library.
 251   ///
 252   const Type *getRawType() const { return VTy.getRawType(); }
 253
 254   /// stripPointerCasts - This method strips off any unneeded pointer
 255   /// casts from the specified value, returning the original uncasted value.
 256   /// Note that the returned value has pointer type if the specified value does.
 257   Value *stripPointerCasts();
 258   const Value *stripPointerCasts() const {
 259     return const_cast<Value*>(this)->stripPointerCasts();
 260   }
 261
 262   /// getUnderlyingObject - This method strips off any GEP address adjustments
 263   /// and pointer casts from the specified value, returning the original object
 264   /// being addressed.  Note that the returned value has pointer type if the
 265   /// specified value does.
 266   Value *getUnderlyingObject();
 267   const Value *getUnderlyingObject() const {
 268     return const_cast<Value*>(this)->getUnderlyingObject();
 269   }
 270
 271   /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
 272   /// return the value in the PHI node corresponding to PredBB.  If not, return
 273   /// ourself.  This is useful if you want to know the value something has in a
 274   /// predecessor block.
 275   Value *DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB);
 276
 277   const Value *DoPHITranslation(const BasicBlock *CurBB,
 278                                 const BasicBlock *PredBB) const{
 279     return const_cast<Value*>(this)->DoPHITranslation(CurBB, PredBB);
 280   }
 281 };
 282
 283 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
 284   V.print(OS);
 285   return OS;
 286 }
 287 inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
 288   V.print(OS);
 289   return OS;
 290 }
 291
 292 void Use::set(Value *V) {
 293   if (Val) removeFromList();
 294   Val = V;
 295   if (V) V->addUse(*this);
 296 }
 297
 298
 299 // isa - Provide some specializations of isa so that we don't have to include
 300 // the subtype header files to test to see if the value is a subclass...
 301 //
 302 template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
 303   return Val.getValueID() >= Value::ConstantFirstVal &&
 304          Val.getValueID() <= Value::ConstantLastVal;
 305 }
 306 template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
 307   return Val.getValueID() == Value::ArgumentVal;
 308 }
 309 template <> inline bool isa_impl<InlineAsm, Value>(const Value &Val) {
 310   return Val.getValueID() == Value::InlineAsmVal;
 311 }
 312 template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
 313   return Val.getValueID() >= Value::InstructionVal;
 314 }
 315 template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
 316   return Val.getValueID() == Value::BasicBlockVal;
 317 }
 318 template <> inline bool isa_impl<Function, Value>(const Value &Val) {
 319   return Val.getValueID() == Value::FunctionVal;
 320 }
 321 template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
 322   return Val.getValueID() == Value::GlobalVariableVal;
 323 }
 324 template <> inline bool isa_impl<GlobalAlias, Value>(const Value &Val) {
 325   return Val.getValueID() == Value::GlobalAliasVal;
 326 }
 327 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
 328   return isa<GlobalVariable>(Val) || isa<Function>(Val) ||
 329          isa<GlobalAlias>(Val);
 330 }
 331
 332
 333 // Value* is only 4-byte aligned.
 334 template<>
 335 class PointerLikeTypeTraits<Value*> {
 336   typedef Value* PT;
 337 public:
 338   static inline void *getAsVoidPointer(PT P) { return P; }
 339   static inline PT getFromVoidPointer(void *P) {
 340     return static_cast<PT>(P);
 341   }
 342   enum { NumLowBitsAvailable = 2 };
 343 };
 344
 345 } // End llvm namespace
 346
 347 #endif