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 class 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   /// getNameStart - Return a pointer to a null terminated string for this name.
 115   /// Note that names can have null characters within the string as well as at
 116   /// their end.  This always returns a non-null pointer.
 117   const char *getNameStart() const { return getName().begin(); }
 118   /// getNameEnd - Return a pointer to the end of the name.
 119   const char *getNameEnd() const { return getName().end(); }
 120
 121   /// getNameLen - Return the length of the string, correctly handling nul
 122   /// characters embedded into them.
 123   unsigned getNameLen() const { return getName().size(); }
 124
 125   /// getName() - Return a constant reference to the value's name. This is cheap
 126   /// and guaranteed to return the same reference as long as the value is not
 127   /// modified.
 128   StringRef getName() const;
 129
 130   /// getNameStr() - Return the name of the specified value, *constructing a
 131   /// string* to hold it.  This is guaranteed to construct a string and is very
 132   /// expensive, clients should use getName() unless necessary.
 133   std::string getNameStr() const;
 134
 135   /// setName() - Change the name of the value, choosing a new unique name if
 136   /// the provided name is taken.
 137   ///
 138   /// \arg Name - The new name; or "" if the value's name should be removed.
 139   void setName(const Twine &Name);
 140
 141
 142   /// takeName - transfer the name from V to this value, setting V's name to
 143   /// empty.  It is an error to call V->takeName(V).
 144   void takeName(Value *V);
 145
 146   /// replaceAllUsesWith - Go through the uses list for this definition and make
 147   /// each use point to "V" instead of "this".  After this completes, 'this's
 148   /// use list is guaranteed to be empty.
 149   ///
 150   void replaceAllUsesWith(Value *V);
 151
 152   // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
 153   // Only use when in type resolution situations!
 154   void uncheckedReplaceAllUsesWith(Value *V);
 155
 156   /// clearOptionalData - Clear any optional optimization data from this Value.
 157   /// Transformation passes must call this method whenever changing the IR
 158   /// in a way that would affect the values produced by this Value, unless
 159   /// it takes special care to ensure correctness in some other way.
 160   void clearOptionalData() { SubclassOptionalData = 0; }
 161
 162   //----------------------------------------------------------------------
 163   // Methods for handling the chain of uses of this Value.
 164   //
 165   typedef value_use_iterator<User>       use_iterator;
 166   typedef value_use_iterator<const User> use_const_iterator;
 167
 168   bool               use_empty() const { return UseList == 0; }
 169   use_iterator       use_begin()       { return use_iterator(UseList); }
 170   use_const_iterator use_begin() const { return use_const_iterator(UseList); }
 171   use_iterator       use_end()         { return use_iterator(0);   }
 172   use_const_iterator use_end()   const { return use_const_iterator(0);   }
 173   User              *use_back()        { return *use_begin(); }
 174   const User        *use_back()  const { return *use_begin(); }
 175
 176   /// hasOneUse - Return true if there is exactly one user of this value.  This
 177   /// is specialized because it is a common request and does not require
 178   /// traversing the whole use list.
 179   ///
 180   bool hasOneUse() const {
 181     use_const_iterator I = use_begin(), E = use_end();
 182     if (I == E) return false;
 183     return ++I == E;
 184   }
 185
 186   /// hasNUses - Return true if this Value has exactly N users.
 187   ///
 188   bool hasNUses(unsigned N) const;
 189
 190   /// hasNUsesOrMore - Return true if this value has N users or more.  This is
 191   /// logically equivalent to getNumUses() >= N.
 192   ///
 193   bool hasNUsesOrMore(unsigned N) const;
 194
 195   bool isUsedInBasicBlock(const BasicBlock *BB) const;
 196
 197   /// getNumUses - This method computes the number of uses of this Value.  This
 198   /// is a linear time operation.  Use hasOneUse, hasNUses, or hasMoreThanNUses
 199   /// to check for specific values.
 200   unsigned getNumUses() const;
 201
 202   /// addUse - This method should only be used by the Use class.
 203   ///
 204   void addUse(Use &U) { U.addToList(&UseList); }
 205
 206   /// An enumeration for keeping track of the concrete subclass of Value that
 207   /// is actually instantiated. Values of this enumeration are kept in the
 208   /// Value classes SubclassID field. They are used for concrete type
 209   /// identification.
 210   enum ValueTy {
 211     ArgumentVal,              // This is an instance of Argument
 212     BasicBlockVal,            // This is an instance of BasicBlock
 213     FunctionVal,              // This is an instance of Function
 214     GlobalAliasVal,           // This is an instance of GlobalAlias
 215     GlobalVariableVal,        // This is an instance of GlobalVariable
 216     UndefValueVal,            // This is an instance of UndefValue
 217     ConstantExprVal,          // This is an instance of ConstantExpr
 218     ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
 219     ConstantIntVal,           // This is an instance of ConstantInt
 220     ConstantFPVal,            // This is an instance of ConstantFP
 221     ConstantArrayVal,         // This is an instance of ConstantArray
 222     ConstantStructVal,        // This is an instance of ConstantStruct
 223     ConstantVectorVal,        // This is an instance of ConstantVector
 224     ConstantPointerNullVal,   // This is an instance of ConstantPointerNull
 225     MDNodeVal,                // This is an instance of MDNode
 226     MDStringVal,              // This is an instance of MDString
 227     InlineAsmVal,             // This is an instance of InlineAsm
 228     PseudoSourceValueVal,     // This is an instance of PseudoSourceValue
 229     InstructionVal,           // This is an instance of Instruction
 230
 231     // Markers:
 232     ConstantFirstVal = FunctionVal,
 233     ConstantLastVal  = ConstantPointerNullVal
 234   };
 235
 236   /// getValueID - Return an ID for the concrete type of this object.  This is
 237   /// used to implement the classof checks.  This should not be used for any
 238   /// other purpose, as the values may change as LLVM evolves.  Also, note that
 239   /// for instructions, the Instruction's opcode is added to InstructionVal. So
 240   /// this means three things:
 241   /// # there is no value with code InstructionVal (no opcode==0).
 242   /// # there are more possible values for the value type than in ValueTy enum.
 243   /// # the InstructionVal enumerator must be the highest valued enumerator in
 244   ///   the ValueTy enum.
 245   unsigned getValueID() const {
 246     return SubclassID;
 247   }
 248
 249   // Methods for support type inquiry through isa, cast, and dyn_cast:
 250   static inline bool classof(const Value *) {
 251     return true; // Values are always values.
 252   }
 253
 254   /// getRawType - This should only be used to implement the vmcore library.
 255   ///
 256   const Type *getRawType() const { return VTy.getRawType(); }
 257
 258   /// stripPointerCasts - This method strips off any unneeded pointer
 259   /// casts from the specified value, returning the original uncasted value.
 260   /// Note that the returned value has pointer type if the specified value does.
 261   Value *stripPointerCasts();
 262   const Value *stripPointerCasts() const {
 263     return const_cast<Value*>(this)->stripPointerCasts();
 264   }
 265
 266   /// getUnderlyingObject - This method strips off any GEP address adjustments
 267   /// and pointer casts from the specified value, returning the original object
 268   /// being addressed.  Note that the returned value has pointer type if the
 269   /// specified value does.
 270   Value *getUnderlyingObject();
 271   const Value *getUnderlyingObject() const {
 272     return const_cast<Value*>(this)->getUnderlyingObject();
 273   }
 274
 275   /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
 276   /// return the value in the PHI node corresponding to PredBB.  If not, return
 277   /// ourself.  This is useful if you want to know the value something has in a
 278   /// predecessor block.
 279   Value *DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB);
 280
 281   const Value *DoPHITranslation(const BasicBlock *CurBB,
 282                                 const BasicBlock *PredBB) const{
 283     return const_cast<Value*>(this)->DoPHITranslation(CurBB, PredBB);
 284   }
 285 };
 286
 287 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
 288   V.print(OS);
 289   return OS;
 290 }
 291 inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
 292   V.print(OS);
 293   return OS;
 294 }
 295
 296 void Use::set(Value *V) {
 297   if (Val) removeFromList();
 298   Val = V;
 299   if (V) V->addUse(*this);
 300 }
 301
 302
 303 // isa - Provide some specializations of isa so that we don't have to include
 304 // the subtype header files to test to see if the value is a subclass...
 305 //
 306 template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
 307   return Val.getValueID() >= Value::ConstantFirstVal &&
 308          Val.getValueID() <= Value::ConstantLastVal;
 309 }
 310 template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
 311   return Val.getValueID() == Value::ArgumentVal;
 312 }
 313 template <> inline bool isa_impl<InlineAsm, Value>(const Value &Val) {
 314   return Val.getValueID() == Value::InlineAsmVal;
 315 }
 316 template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
 317   return Val.getValueID() >= Value::InstructionVal;
 318 }
 319 template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
 320   return Val.getValueID() == Value::BasicBlockVal;
 321 }
 322 template <> inline bool isa_impl<Function, Value>(const Value &Val) {
 323   return Val.getValueID() == Value::FunctionVal;
 324 }
 325 template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
 326   return Val.getValueID() == Value::GlobalVariableVal;
 327 }
 328 template <> inline bool isa_impl<GlobalAlias, Value>(const Value &Val) {
 329   return Val.getValueID() == Value::GlobalAliasVal;
 330 }
 331 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
 332   return isa<GlobalVariable>(Val) || isa<Function>(Val) ||
 333          isa<GlobalAlias>(Val);
 334 }
 335
 336
 337 // Value* is only 4-byte aligned.
 338 template<>
 339 class PointerLikeTypeTraits<Value*> {
 340   typedef Value* PT;
 341 public:
 342   static inline void *getAsVoidPointer(PT P) { return P; }
 343   static inline PT getFromVoidPointer(void *P) {
 344     return static_cast<PT>(P);
 345   }
 346   enum { NumLowBitsAvailable = 2 };
 347 };
 348
 349 } // End llvm namespace
 350
 351 #endif