-//===-- llvm/Value.h - Definition of the Value class -------------*- C++ -*--=//
+//===-- llvm/Value.h - Definition of the Value class ------------*- C++ -*-===//
//
-// This file defines the very important Value class. This is subclassed by a
-// bunch of other important classes, like Def, Method, Module, Type, etc...
+// The LLVM Compiler Infrastructure
//
-// This file also defines the Use<> template for users of value.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
-// This file also defines the isa<X>(), cast<X>(), and dyn_cast<X>() templates.
+//===----------------------------------------------------------------------===//
+//
+// This file declares the Value class.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_VALUE_H
#define LLVM_VALUE_H
-#include <vector>
-#include "llvm/Annotation.h"
-#include "llvm/AbstractTypeUser.h"
+#include "llvm/Use.h"
+#include "llvm/ADT/StringRef.h"
+#include "llvm/Support/Casting.h"
+#include <string>
-class User;
-class Type;
-class ConstPoolVal;
-class MethodArgument;
+namespace llvm {
+
+class Constant;
+class Argument;
class Instruction;
class BasicBlock;
class GlobalValue;
-class Method;
+class Function;
class GlobalVariable;
-class Module;
-class SymbolTable;
-template<class ValueSubclass, class ItemParentType, class SymTabType>
- class ValueHolder;
+class GlobalAlias;
+class InlineAsm;
+class ValueSymbolTable;
+template<typename ValueTy> class StringMapEntry;
+template <typename ValueTy = Value>
+class AssertingVH;
+typedef StringMapEntry<Value*> ValueName;
+class raw_ostream;
+class AssemblyAnnotationWriter;
+class ValueHandleBase;
+class LLVMContext;
+class Twine;
+class MDNode;
+class Type;
//===----------------------------------------------------------------------===//
// Value Class
//===----------------------------------------------------------------------===//
-class Value : public Annotable, // Values are annotable
- public AbstractTypeUser { // Values use potentially abstract types
-public:
- enum ValueTy {
- TypeVal, // This is an instance of Type
- ConstantVal, // This is an instance of ConstPoolVal
- MethodArgumentVal, // This is an instance of MethodArgument
- InstructionVal, // This is an instance of Instruction
- BasicBlockVal, // This is an instance of BasicBlock
- MethodVal, // This is an instance of Method
- GlobalVariableVal, // This is an instance of GlobalVariable
- ModuleVal, // This is an instance of Module
- };
+/// This is a very important LLVM class. It is the base class of all values
+/// computed by a program that may be used as operands to other values. Value is
+/// the super class of other important classes such as Instruction and Function.
+/// All Values have a Type. Type is not a subclass of Value. Some values can
+/// have a name and they belong to some Module. Setting the name on the Value
+/// automatically updates the module's symbol table.
+///
+/// Every value has a "use list" that keeps track of which other Values are
+/// 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 char SubclassID; // Subclass identifier (for isa/dyn_cast)
+ unsigned char HasValueHandle : 1; // Has a ValueHandle pointing to this?
+protected:
+ /// SubclassOptionalData - This member is similar to SubclassData, however it
+ /// is for holding information which may be used to aid optimization, but
+ /// which may be cleared to zero without affecting conservative
+ /// interpretation.
+ unsigned char SubclassOptionalData : 7;
private:
- vector<User *> Uses;
- string Name;
- PATypeHandle<Type> Ty;
- ValueTy VTy;
+ /// 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;
+
+ Type *VTy;
+ Use *UseList;
+ friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name.
+ friend class ValueHandleBase;
+ ValueName *Name;
+
+ void operator=(const Value &); // Do not implement
Value(const Value &); // Do not implement
+
protected:
- inline void setType(const Type *ty) { Ty = ty; }
+ /// printCustom - Value subclasses can override this to implement custom
+ /// printing behavior.
+ virtual void printCustom(raw_ostream &O) const;
+
+ Value(Type *Ty, unsigned scid);
public:
- Value(const Type *Ty, ValueTy vty, const string &name = "");
virtual ~Value();
-
- // Support for debugging
- void dump() const;
-
- // All values can potentially be typed
- inline const Type *getType() const { return Ty; }
-
- // All values can potentially be named...
- inline bool hasName() const { return Name != ""; }
- inline const string &getName() const { return Name; }
- virtual void setName(const string &name, SymbolTable * = 0) {
- Name = name;
- }
-
- // Methods for determining the subtype of this Value. The getValueType()
- // method returns the type of the value directly. The cast*() methods are
- // equivalent to using dynamic_cast<>... if the cast is successful, this is
- // returned, otherwise you get a null pointer.
- //
- // The family of functions Val->cast<type>Asserting() is used in the same
- // way as the Val->cast<type>() instructions, but they assert the expected
- // type instead of checking it at runtime.
+ /// dump - Support for debugging, callable in GDB: V->dump()
//
- inline ValueTy getValueType() const { return VTy; }
+ void dump() const;
+
+ /// print - Implement operator<< on Value.
+ ///
+ void print(raw_ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
+
+ /// All values are typed, get the type of this value.
+ ///
+ Type *getType() const { return VTy; }
+
+ /// All values hold a context through their type.
+ LLVMContext &getContext() const;
+
+ // All values can potentially be named...
+ bool hasName() const { return Name != 0; }
+ ValueName *getValueName() const { return Name; }
- // replaceAllUsesWith - Go through the uses list for this definition and make
- // each use point to "D" instead of "this". After this completes, 'this's
- // use list should be empty.
- //
- void replaceAllUsesWith(Value *D);
+ /// getName() - Return a constant reference to the value's name. This is cheap
+ /// and guaranteed to return the same reference as long as the value is not
+ /// modified.
+ ///
+ /// This is currently guaranteed to return a StringRef for which data() points
+ /// to a valid null terminated string. The use of StringRef.data() is
+ /// deprecated here, however, and clients should not rely on it. If such
+ /// behavior is needed, clients should use expensive getNameStr(), or switch
+ /// to an interface that does not depend on null termination.
+ StringRef getName() const;
+
+ /// getNameStr() - Return the name of the specified value, *constructing a
+ /// string* to hold it. This is guaranteed to construct a string and is very
+ /// expensive, clients should use getName() unless necessary.
+ std::string getNameStr() const;
+
+ /// setName() - Change the name of the value, choosing a new unique name if
+ /// the provided name is taken.
+ ///
+ /// \arg Name - The new name; or "" if the value's name should be removed.
+ void setName(const Twine &Name);
- // refineAbstractType - This function is implemented because we use
- // potentially abstract types, and these types may be resolved to more
- // concrete types after we are constructed.
- //
- virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ /// takeName - transfer the name from V to this value, setting V's name to
+ /// empty. It is an error to call V->takeName(V).
+ void takeName(Value *V);
+
+ /// replaceAllUsesWith - Go through the uses list for this definition and make
+ /// each use point to "V" instead of "this". After this completes, 'this's
+ /// use list is guaranteed to be empty.
+ ///
+ void replaceAllUsesWith(Value *V);
+
//----------------------------------------------------------------------
- // Methods for handling the vector of uses of this Value.
+ // Methods for handling the chain of uses of this Value.
//
- typedef vector<User*>::iterator use_iterator;
- typedef vector<User*>::const_iterator use_const_iterator;
-
- inline unsigned use_size() const { return Uses.size(); }
- inline bool use_empty() const { return Uses.empty(); }
- inline use_iterator use_begin() { return Uses.begin(); }
- inline use_const_iterator use_begin() const { return Uses.begin(); }
- inline use_iterator use_end() { return Uses.end(); }
- inline use_const_iterator use_end() const { return Uses.end(); }
- inline User *use_back() { return Uses.back(); }
- inline const User *use_back() const { return Uses.back(); }
-
- inline void use_push_back(User *I) { Uses.push_back(I); }
- User *use_remove(use_iterator &I);
-
- inline void addUse(User *I) { Uses.push_back(I); }
- void killUse(User *I);
-};
+ typedef value_use_iterator<User> use_iterator;
+ typedef value_use_iterator<const User> const_use_iterator;
+
+ bool use_empty() const { return UseList == 0; }
+ use_iterator use_begin() { return use_iterator(UseList); }
+ const_use_iterator use_begin() const { return const_use_iterator(UseList); }
+ use_iterator use_end() { return use_iterator(0); }
+ const_use_iterator use_end() const { return const_use_iterator(0); }
+ User *use_back() { 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
+ /// traversing the whole use list.
+ ///
+ bool hasOneUse() const {
+ const_use_iterator I = use_begin(), E = use_end();
+ if (I == E) return false;
+ return ++I == E;
+ }
+ /// hasNUses - Return true if this Value has exactly N users.
+ ///
+ bool hasNUses(unsigned N) const;
-//===----------------------------------------------------------------------===//
-// UseTy Class
-//===----------------------------------------------------------------------===//
+ /// hasNUsesOrMore - Return true if this value has N users or more. This is
+ /// logically equivalent to getNumUses() >= N.
+ ///
+ bool hasNUsesOrMore(unsigned N) const;
-// UseTy and it's friendly typedefs (Use) are here to make keeping the "use"
-// list of a definition node up-to-date really easy.
-//
-template<class ValueSubclass>
-class UseTy {
- ValueSubclass *Val;
- User *U;
-public:
- inline UseTy<ValueSubclass>(ValueSubclass *v, User *user) {
- Val = v; U = user;
- if (Val) Val->addUse(U);
+ 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 hasNUsesOrMore
+ /// to check for specific values.
+ unsigned getNumUses() const;
+
+ /// addUse - This method should only be used by the Use class.
+ ///
+ void addUse(Use &U) { U.addToList(&UseList); }
+
+ /// An enumeration for keeping track of the concrete subclass of Value that
+ /// is actually instantiated. Values of this enumeration are kept in the
+ /// Value classes SubclassID field. They are used for concrete type
+ /// identification.
+ enum ValueTy {
+ ArgumentVal, // This is an instance of Argument
+ BasicBlockVal, // This is an instance of BasicBlock
+ FunctionVal, // This is an instance of Function
+ GlobalAliasVal, // This is an instance of GlobalAlias
+ GlobalVariableVal, // This is an instance of GlobalVariable
+ UndefValueVal, // This is an instance of UndefValue
+ BlockAddressVal, // This is an instance of BlockAddress
+ ConstantExprVal, // This is an instance of ConstantExpr
+ ConstantAggregateZeroVal, // This is an instance of ConstantAggregateZero
+ ConstantIntVal, // This is an instance of ConstantInt
+ ConstantFPVal, // This is an instance of ConstantFP
+ ConstantArrayVal, // This is an instance of ConstantArray
+ ConstantStructVal, // This is an instance of ConstantStruct
+ ConstantVectorVal, // This is an instance of ConstantVector
+ ConstantPointerNullVal, // This is an instance of ConstantPointerNull
+ MDNodeVal, // This is an instance of MDNode
+ MDStringVal, // This is an instance of MDString
+ InlineAsmVal, // This is an instance of InlineAsm
+ PseudoSourceValueVal, // This is an instance of PseudoSourceValue
+ FixedStackPseudoSourceValueVal, // This is an instance of
+ // FixedStackPseudoSourceValue
+ InstructionVal, // This is an instance of Instruction
+ // Enum values starting at InstructionVal are used for Instructions;
+ // don't add new values here!
+
+ // Markers:
+ ConstantFirstVal = FunctionVal,
+ ConstantLastVal = ConstantPointerNullVal
+ };
+
+ /// getValueID - Return an ID for the concrete type of this object. This is
+ /// used to implement the classof checks. This should not be used for any
+ /// other purpose, as the values may change as LLVM evolves. Also, note that
+ /// for instructions, the Instruction's opcode is added to InstructionVal. So
+ /// this means three things:
+ /// # there is no value with code InstructionVal (no opcode==0).
+ /// # there are more possible values for the value type than in ValueTy enum.
+ /// # the InstructionVal enumerator must be the highest valued enumerator in
+ /// the ValueTy enum.
+ unsigned getValueID() const {
+ return SubclassID;
}
- inline ~UseTy<ValueSubclass>() { if (Val) Val->killUse(U); }
+ /// getRawSubclassOptionalData - Return the raw optional flags value
+ /// contained in this value. This should only be used when testing two
+ /// Values for equivalence.
+ unsigned getRawSubclassOptionalData() const {
+ return SubclassOptionalData;
+ }
- inline operator ValueSubclass *() const { return Val; }
+ /// clearSubclassOptionalData - Clear the optional flags contained in
+ /// this value.
+ void clearSubclassOptionalData() {
+ SubclassOptionalData = 0;
+ }
- inline UseTy<ValueSubclass>(const UseTy<ValueSubclass> &user) {
- Val = 0;
- U = user.U;
- operator=(user.Val);
+ /// hasSameSubclassOptionalData - Test whether the optional flags contained
+ /// in this value are equal to the optional flags in the given value.
+ bool hasSameSubclassOptionalData(const Value *V) const {
+ return SubclassOptionalData == V->SubclassOptionalData;
}
- inline ValueSubclass *operator=(ValueSubclass *V) {
- if (Val) Val->killUse(U);
- Val = V;
- if (V) V->addUse(U);
- return V;
+
+ /// intersectOptionalDataWith - Clear any optional flags in this value
+ /// that are not also set in the given value.
+ void intersectOptionalDataWith(const Value *V) {
+ SubclassOptionalData &= V->SubclassOptionalData;
}
- inline ValueSubclass *operator->() { return Val; }
- inline const ValueSubclass *operator->() const { return Val; }
+ /// hasValueHandle - Return true if there is a value handle associated with
+ /// this value.
+ bool hasValueHandle() const { return HasValueHandle; }
+
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const Value *) {
+ return true; // Values are always values.
+ }
- inline ValueSubclass *get() { return Val; }
- inline const ValueSubclass *get() const { return Val; }
+ /// stripPointerCasts - This method strips off any unneeded pointer
+ /// casts from the specified value, returning the original uncasted value.
+ /// 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();
+ }
- inline UseTy<ValueSubclass> &operator=(const UseTy<ValueSubclass> &user) {
- if (Val) Val->killUse(U);
- Val = user.Val;
- Val->addUse(U);
- return *this;
+ /// isDereferenceablePointer - Test if this value is always a pointer to
+ /// allocated and suitably aligned memory for a simple load or store.
+ bool isDereferenceablePointer() const;
+
+ /// 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);
}
+
+ /// MaximumAlignment - This is the greatest alignment value supported by
+ /// load, store, and alloca instructions, and global values.
+ static const unsigned MaximumAlignment = 1u << 29;
+
+ /// mutateType - Mutate the type of this Value to be of the specified type.
+ /// Note that this is an extremely dangerous operation which can create
+ /// completely invalid IR very easily. It is strongly recommended that you
+ /// recreate IR objects with the right types instead of mutating them in
+ /// place.
+ void mutateType(Type *Ty) {
+ VTy = Ty;
+ }
+
+protected:
+ unsigned short getSubclassDataFromValue() const { return SubclassData; }
+ void setValueSubclassData(unsigned short D) { SubclassData = D; }
};
-typedef UseTy<Value> Use; // Provide Use as a common UseTy type
+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;
+ if (V) V->addUse(*this);
+}
+
-// real_type - Provide a macro to get the real type of a value that might be
-// a use. This provides a typedef 'Type' that is the argument type for all
-// non UseTy types, and is the contained pointer type of the use if it is a
-// UseTy.
+// isa - Provide some specializations of isa so that we don't have to include
+// the subtype header files to test to see if the value is a subclass...
//
-template <class X> class real_type { typedef X Type; };
-template <class X> class real_type <class UseTy<X> > { typedef X *Type; };
+template <> struct isa_impl<Constant, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() >= Value::ConstantFirstVal &&
+ Val.getValueID() <= Value::ConstantLastVal;
+ }
+};
-//===----------------------------------------------------------------------===//
-// Type Checking Templates
-//===----------------------------------------------------------------------===//
+template <> struct isa_impl<Argument, Value> {
+ static inline bool doit (const Value &Val) {
+ return Val.getValueID() == Value::ArgumentVal;
+ }
+};
-// isa<X> - Return true if the parameter to the template is an instance of the
-// template type argument. Used like this:
-//
-// if (isa<Type>(myVal)) { ... }
-//
-template <class X, class Y>
-inline bool isa(Y Val) {
- assert(Val && "isa<Ty>(NULL) invoked!");
- return X::classof(Val);
-}
+template <> struct isa_impl<InlineAsm, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() == Value::InlineAsmVal;
+ }
+};
+template <> struct isa_impl<Instruction, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() >= Value::InstructionVal;
+ }
+};
-// cast<X> - Return the argument parameter cast to the specified type. This
-// casting operator asserts that the type is correct, so it does not return null
-// on failure. But it will correctly return NULL when the input is NULL.
-// Used Like this:
-//
-// cast< Instruction>(myVal)->getParent()
-// cast<const Instruction>(myVal)->getParent()
-//
-template <class X, class Y>
-inline X *cast(Y Val) {
- assert((Val == 0 || isa<X>(Val)) &&
- "cast<Ty>() argument of uncompatible type!");
- return (X*)(real_type<Y>::Type)Val;
-}
+template <> struct isa_impl<BasicBlock, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() == Value::BasicBlockVal;
+ }
+};
+template <> struct isa_impl<Function, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() == Value::FunctionVal;
+ }
+};
-// dyn_cast<X> - Return the argument parameter cast to the specified type. This
-// casting operator returns null if the argument is of the wrong type, so it can
-// be used to test for a type as well as cast if successful. This should be
-// used in the context of an if statement like this:
-//
-// if (const Instruction *I = dyn_cast<const Instruction>(myVal)) { ... }
-//
+template <> struct isa_impl<GlobalVariable, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() == Value::GlobalVariableVal;
+ }
+};
-template <class X, class Y>
-inline X *dyn_cast(Y Val) {
- return isa<X>(Val) ? cast<X>(Val) : 0;
-}
+template <> struct isa_impl<GlobalAlias, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() == Value::GlobalAliasVal;
+ }
+};
+template <> struct isa_impl<GlobalValue, Value> {
+ static inline bool doit(const Value &Val) {
+ return isa<GlobalVariable>(Val) || isa<Function>(Val) ||
+ isa<GlobalAlias>(Val);
+ }
+};
-// isa - Provide some specializations of isa so that we have to include the
-// subtype header files to test to see if the value is a subclass...
-//
-template <> inline bool isa<Type, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::TypeVal;
-}
-template <> inline bool isa<Type, Value*>(Value *Val) {
- return Val->getValueType() == Value::TypeVal;
-}
-template <> inline bool isa<ConstPoolVal, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::ConstantVal;
-}
-template <> inline bool isa<ConstPoolVal, Value*>(Value *Val) {
- return Val->getValueType() == Value::ConstantVal;
-}
-template <> inline bool isa<MethodArgument, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::MethodArgumentVal;
-}
-template <> inline bool isa<MethodArgument, Value*>(Value *Val) {
- return Val->getValueType() == Value::MethodArgumentVal;
-}
-template <> inline bool isa<Instruction, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::InstructionVal;
-}
-template <> inline bool isa<Instruction, Value*>(Value *Val) {
- return Val->getValueType() == Value::InstructionVal;
-}
-template <> inline bool isa<BasicBlock, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::BasicBlockVal;
-}
-template <> inline bool isa<BasicBlock, Value*>(Value *Val) {
- return Val->getValueType() == Value::BasicBlockVal;
-}
-template <> inline bool isa<Method, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::MethodVal;
-}
-template <> inline bool isa<Method, Value*>(Value *Val) {
- return Val->getValueType() == Value::MethodVal;
-}
-template <> inline bool isa<GlobalVariable, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::GlobalVariableVal;
-}
-template <> inline bool isa<GlobalVariable, Value*>(Value *Val) {
- return Val->getValueType() == Value::GlobalVariableVal;
-}
-template <> inline bool isa<GlobalValue, const Value*>(const Value *Val) {
- return isa<GlobalVariable>(Val) || isa<Method>(Val);
-}
-template <> inline bool isa<GlobalValue, Value*>(Value *Val) {
- return isa<GlobalVariable>(Val) || isa<Method>(Val);
-}
-template <> inline bool isa<Module, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::ModuleVal;
-}
-template <> inline bool isa<Module, Value*>(Value *Val) {
- return Val->getValueType() == Value::ModuleVal;
-}
+template <> struct isa_impl<MDNode, Value> {
+ static inline bool doit(const Value &Val) {
+ return Val.getValueID() == Value::MDNodeVal;
+ }
+};
+
+// 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
#endif
projects / oota-llvm.git / blobdiff