//===----------------------------------------------------------------------===//
//
// This file declares the Value class.
-// This file also defines the Use<> template for users of value.
//
//===----------------------------------------------------------------------===//
#include "llvm/AbstractTypeUser.h"
#include "llvm/Use.h"
#include "llvm/Support/Casting.h"
-#include "llvm/Support/Streams.h"
+#include <iosfwd>
#include <string>
namespace llvm {
class ValueSymbolTable;
class TypeSymbolTable;
template<typename ValueTy> class StringMapEntry;
+template <typename ValueTy = Value>
+class AssertingVH;
typedef StringMapEntry<Value*> ValueName;
+class raw_ostream;
+class AssemblyAnnotationWriter;
+class ValueHandleBase;
//===----------------------------------------------------------------------===//
// Value Class
/// automatically updates the module's symbol table.
///
/// Every value has a "use list" that keeps track of which other Values are
-/// using this Value.
+/// using this Value. A Value can also have an arbitrary number of ValueHandle
+/// objects that watch it and listen to RAUW and Destroy events see
+/// llvm/Support/ValueHandle.h for details.
+///
/// @brief LLVM Value Representation
class Value {
- const unsigned short SubclassID; // Subclass identifier (for isa/dyn_cast)
+ const unsigned char SubclassID; // Subclass identifier (for isa/dyn_cast)
+ unsigned char HasValueHandle : 1; // Has a ValueHandle pointing to this?
protected:
/// SubclassData - This member is defined by this class, but is not used for
/// anything. Subclasses can use it to hold whatever state they find useful.
/// This field is initialized to zero by the ctor.
unsigned short SubclassData;
private:
- PATypeHolder Ty;
+ PATypeHolder VTy;
Use *UseList;
friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name.
friend class SymbolTable; // Allow SymbolTable to directly poke Name.
+ friend class ValueHandleBase;
ValueName *Name;
void operator=(const Value &); // Do not implement
//
virtual void dump() const;
- /// print - Implement operator<< on Value...
+ /// print - Implement operator<< on Value.
///
- virtual void print(std::ostream &O) const = 0;
- void print(std::ostream *O) const { if (O) print(*O); }
+ void print(std::ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
+ void print(raw_ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
/// All values are typed, get the type of this value.
///
- inline const Type *getType() const { return Ty; }
+ inline const Type *getType() const { return VTy; }
// All values can potentially be named...
inline bool hasName() const { return Name != 0; }
/// Note that names can have null characters within the string as well as at
/// their end. This always returns a non-null pointer.
const char *getNameStart() const;
+ /// getNameEnd - Return a pointer to the end of the name.
+ const char *getNameEnd() const { return getNameStart() + getNameLen(); }
/// isName - Return true if this value has the name specified by the provided
/// nul terminated string.
void uncheckedReplaceAllUsesWith(Value *V);
//----------------------------------------------------------------------
- // Methods for handling the vector of uses of this Value.
+ // Methods for handling the chain of uses of this Value.
//
typedef value_use_iterator<User> use_iterator;
typedef value_use_iterator<const User> use_const_iterator;
use_iterator use_end() { return use_iterator(0); }
use_const_iterator use_end() const { return use_const_iterator(0); }
User *use_back() { return *use_begin(); }
- const User *use_back() const { return *use_begin(); }
+ const User *use_back() const { return *use_begin(); }
/// hasOneUse - Return true if there is exactly one user of this value. This
/// is specialized because it is a common request and does not require
///
bool hasNUsesOrMore(unsigned N) const;
+ bool isUsedInBasicBlock(const BasicBlock *BB) const;
+
/// getNumUses - This method computes the number of uses of this Value. This
/// is a linear time operation. Use hasOneUse, hasNUses, or hasMoreThanNUses
/// to check for specific values.
ConstantStructVal, // This is an instance of ConstantStruct
ConstantVectorVal, // This is an instance of ConstantVector
ConstantPointerNullVal, // This is an instance of ConstantPointerNull
+ MDStringVal, // This is an instance of MDString
+ MDNodeVal, // This is an instance of MDNode
InlineAsmVal, // This is an instance of InlineAsm
PseudoSourceValueVal, // This is an instance of PseudoSourceValue
InstructionVal, // This is an instance of Instruction
// Markers:
ConstantFirstVal = FunctionVal,
- ConstantLastVal = ConstantPointerNullVal
+ ConstantLastVal = MDNodeVal
};
/// getValueID - Return an ID for the concrete type of this object. This is
/// getRawType - This should only be used to implement the vmcore library.
///
- const Type *getRawType() const { return Ty.getRawType(); }
+ const Type *getRawType() const { return VTy.getRawType(); }
/// stripPointerCasts - This method strips off any unneeded pointer
/// casts from the specified value, returning the original uncasted value.
- /// Note that the returned value is guaranteed to have pointer type.
+ /// Note that the returned value has pointer type if the specified value does.
Value *stripPointerCasts();
+ const Value *stripPointerCasts() const {
+ return const_cast<Value*>(this)->stripPointerCasts();
+ }
+
+ /// getUnderlyingObject - This method strips off any GEP address adjustments
+ /// and pointer casts from the specified value, returning the original object
+ /// being addressed. Note that the returned value has pointer type if the
+ /// specified value does.
+ Value *getUnderlyingObject();
+ const Value *getUnderlyingObject() const {
+ return const_cast<Value*>(this)->getUnderlyingObject();
+ }
+
+ /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
+ /// return the value in the PHI node corresponding to PredBB. If not, return
+ /// ourself. This is useful if you want to know the value something has in a
+ /// predecessor block.
+ Value *DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB);
+
+ const Value *DoPHITranslation(const BasicBlock *CurBB,
+ const BasicBlock *PredBB) const{
+ return const_cast<Value*>(this)->DoPHITranslation(CurBB, PredBB);
+ }
};
inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
V.print(OS);
return OS;
}
-
-void Use::init(Value *V, User *) {
- Val = V;
- if (V) V->addUse(*this);
+inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
+ V.print(OS);
+ return OS;
}
-
+
void Use::set(Value *V) {
if (Val) removeFromList();
Val = V;
return Val.getValueID() == Value::GlobalAliasVal;
}
template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
- return isa<GlobalVariable>(Val) || isa<Function>(Val) || isa<GlobalAlias>(Val);
+ return isa<GlobalVariable>(Val) || isa<Function>(Val) ||
+ isa<GlobalAlias>(Val);
}
+
+
+// Value* is only 4-byte aligned.
+template<>
+class PointerLikeTypeTraits<Value*> {
+ typedef Value* PT;
+public:
+ static inline void *getAsVoidPointer(PT P) { return P; }
+ static inline PT getFromVoidPointer(void *P) {
+ return static_cast<PT>(P);
+ }
+ enum { NumLowBitsAvailable = 2 };
+};
} // End llvm namespace