-//===-- llvm/Value.h - Definition of the Value class -------------*- C++ -*--=//
+//===-- llvm/Value.h - Definition of the Value class ------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file defines the very important Value class. This is subclassed by a
// bunch of other important classes, like Instruction, Function, Type, etc...
#ifndef LLVM_VALUE_H
#define LLVM_VALUE_H
-#include "llvm/Annotation.h"
#include "llvm/AbstractTypeUser.h"
-#include "Support/Casting.h"
-#include <iostream>
-#include <vector>
+#include "llvm/Use.h"
+#include "llvm/Support/Casting.h"
+#include <string>
+
+namespace llvm {
-class User;
-class Type;
class Constant;
class Argument;
class Instruction;
/// Value - The base class of all values computed by a program that may be used
/// as operands to other values.
///
-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 Constant
- ArgumentVal, // This is an instance of Argument
- InstructionVal, // This is an instance of Instruction
- BasicBlockVal, // This is an instance of BasicBlock
- FunctionVal, // This is an instance of Function
- GlobalVariableVal, // This is an instance of GlobalVariable
- };
-
+class Value {
+ unsigned short SubclassID; // Subclass identifier (for isa/dyn_cast)
+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:
- std::vector<User *> Uses;
+ PATypeHolder Ty;
+ Use *UseList;
std::string Name;
- PATypeHandle<Type> Ty;
- ValueTy VTy;
void operator=(const Value &); // Do not implement
Value(const Value &); // Do not implement
+
public:
- Value(const Type *Ty, ValueTy vty, const std::string &name = "");
+ Value(const Type *Ty, unsigned scid, const std::string &name = "");
virtual ~Value();
/// dump - Support for debugging, callable in GDB: V->dump()
//
- void dump() const;
+ virtual void dump() const;
/// print - Implement operator<< on Value...
///
inline const Type *getType() const { return Ty; }
// All values can potentially be named...
- inline bool hasName() const { return Name != ""; }
+ inline bool hasName() const { return !Name.empty(); }
inline const std::string &getName() const { return Name; }
virtual void setName(const std::string &name, SymbolTable * = 0) {
Name = name;
}
- /// getValueType - Return the immediate subclass of this Value.
- ///
- inline ValueTy getValueType() const { return VTy; }
-
/// 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);
- /// 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);
-
+ // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
+ // Only use when in type resolution situations!
+ void uncheckedReplaceAllUsesWith(Value *V);
+
//----------------------------------------------------------------------
// Methods for handling the vector of uses of this Value.
//
- typedef std::vector<User*>::iterator use_iterator;
- typedef std::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(); }
-
- /// addUse/killUse - These two methods should only be used by the Use class
- /// below.
- inline void addUse(User *I) { Uses.push_back(I); }
- void killUse(User *I);
-};
-
-inline std::ostream &operator<<(std::ostream &OS, const Value *V) {
- if (V == 0)
- OS << "<null> value!\n";
- else
- V->print(OS);
- return OS;
-}
+ typedef value_use_iterator<User> use_iterator;
+ typedef value_use_iterator<const User> use_const_iterator;
+
+ bool use_empty() const { return UseList == 0; }
+ use_iterator use_begin() { return use_iterator(UseList); }
+ use_const_iterator use_begin() const { return use_const_iterator(UseList); }
+ 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(); }
+
+ /// 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 {
+ use_const_iterator I = use_begin(), E = use_end();
+ if (I == E) return false;
+ return ++I == E;
+ }
-inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
- V.print(OS);
- return OS;
-}
+ /// hasNUses - Return true if this Value has exactly N users.
+ ///
+ bool hasNUses(unsigned N) const;
+ /// hasNUsesOrMore - Return true if this value has N users or more. This is
+ /// logically equivalent to getNumUses() >= N.
+ ///
+ bool hasNUsesOrMore(unsigned N) const;
-//===----------------------------------------------------------------------===//
-// UseTy Class
-//===----------------------------------------------------------------------===//
+ /// 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.
+ unsigned getNumUses() 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);
+ /// addUse/killUse - These two methods should only be used by the Use class.
+ ///
+ void addUse(Use &U) { U.addToList(&UseList); }
+
+ /// getValueType - 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
+ /// starting with the InstructionVal value, the value stored is actually the
+ /// Instruction opcode, so there are more than just these values possible here
+ /// (and Instruction must be last).
+ ///
+ enum ValueTy {
+ ArgumentVal, // This is an instance of Argument
+ BasicBlockVal, // This is an instance of BasicBlock
+ FunctionVal, // This is an instance of Function
+ GlobalVariableVal, // This is an instance of GlobalVariable
+ UndefValueVal, // This is an instance of UndefValue
+ ConstantExprVal, // This is an instance of ConstantExpr
+ ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
+ SimpleConstantVal, // This is some other type of Constant
+ InstructionVal, // This is an instance of Instruction
+ ValueListVal // This is for bcreader, a special ValTy
+ };
+ unsigned getValueType() const {
+ return SubclassID;
}
- inline ~UseTy<ValueSubclass>() { if (Val) Val->killUse(U); }
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const Value *V) {
+ return true; // Values are always values.
+ }
- inline operator ValueSubclass *() const { return Val; }
+ /// getRawType - This should only be used to implement the vmcore library.
+ ///
+ const Type *getRawType() const { return Ty.getRawType(); }
- inline UseTy<ValueSubclass>(const UseTy<ValueSubclass> &user) {
- Val = 0;
- U = user.U;
- operator=(user.Val);
- }
- inline ValueSubclass *operator=(ValueSubclass *V) {
- if (Val) Val->killUse(U);
- Val = V;
- if (V) V->addUse(U);
- return V;
- }
+private:
+ /// FIXME: this is a gross hack, needed by another gross hack. Eliminate!
+ void setValueType(unsigned VT) { SubclassID = VT; }
+ friend class Instruction;
+};
- inline ValueSubclass *operator->() { return Val; }
- inline const ValueSubclass *operator->() const { return Val; }
+inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
+ V.print(OS);
+ return OS;
+}
- inline ValueSubclass *get() { return Val; }
- inline const ValueSubclass *get() const { return Val; }
+void Use::init(Value *v, User *user) {
+ Val = v;
+ U = user;
+ if (Val) Val->addUse(*this);
+}
- inline UseTy<ValueSubclass> &operator=(const UseTy<ValueSubclass> &user) {
- if (Val) Val->killUse(U);
- Val = user.Val;
- Val->addUse(U);
- return *this;
- }
-};
+Use::~Use() {
+ if (Val) removeFromList();
+}
-typedef UseTy<Value> Use; // Provide Use as a common UseTy type
+void Use::set(Value *V) {
+ if (Val) removeFromList();
+ Val = V;
+ if (V) V->addUse(*this);
+}
-template<typename From> struct simplify_type<UseTy<From> > {
- typedef typename simplify_type<From*>::SimpleType SimpleType;
-
- static SimpleType getSimplifiedValue(const UseTy<From> &Val) {
- return (SimpleType)Val.get();
- }
-};
-template<typename From> struct simplify_type<const UseTy<From> > {
- typedef typename simplify_type<From*>::SimpleType SimpleType;
-
- static SimpleType getSimplifiedValue(const UseTy<From> &Val) {
- return (SimpleType)Val.get();
- }
-};
// 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 <> inline bool isa_impl<Type, Value>(const Value &Val) {
- return Val.getValueType() == Value::TypeVal;
-}
template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
- return Val.getValueType() == Value::ConstantVal;
+ return Val.getValueType() == Value::SimpleConstantVal ||
+ Val.getValueType() == Value::FunctionVal ||
+ Val.getValueType() == Value::GlobalVariableVal ||
+ Val.getValueType() == Value::ConstantExprVal ||
+ Val.getValueType() == Value::ConstantAggregateZeroVal ||
+ Val.getValueType() == Value::UndefValueVal;
}
template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
return Val.getValueType() == Value::ArgumentVal;
}
template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
- return Val.getValueType() == Value::InstructionVal;
+ return Val.getValueType() >= Value::InstructionVal;
}
template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
return Val.getValueType() == Value::BasicBlockVal;
return isa<GlobalVariable>(Val) || isa<Function>(Val);
}
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff