-//===-- 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 Def, Method, Module, Type, etc...
+// bunch of other important classes, like Instruction, Function, Type, etc...
//
// This file also defines the Use<> template for users of value.
//
-// This file also defines the isa<X>(), cast<X>(), and dyn_cast<X>() templates.
-//
//===----------------------------------------------------------------------===//
#ifndef LLVM_VALUE_H
#define LLVM_VALUE_H
-#include <vector>
-#include "llvm/Annotation.h"
#include "llvm/AbstractTypeUser.h"
+#include "llvm/Use.h"
+#include "llvm/Support/Casting.h"
+#include <string>
+
+namespace llvm {
-class User;
-class Type;
-class ConstPoolVal;
-class MethodArgument;
+class Constant;
+class Argument;
class Instruction;
class BasicBlock;
-class Method;
+class GlobalValue;
+class Function;
class GlobalVariable;
-class Module;
class SymbolTable;
-template<class ValueSubclass, class ItemParentType, class SymTabType>
- class ValueHolder;
//===----------------------------------------------------------------------===//
// 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
- GlobalVal, // This is an instance of GlobalVariable
- ModuleVal, // This is an instance of Module
- };
-
+/// Value - The base class of all values computed by a program that may be used
+/// as operands to other values.
+///
+class Value {
private:
- vector<User *> Uses;
- string Name;
- PATypeHandle<Type> Ty;
- ValueTy VTy;
+ unsigned SubclassID; // Subclass identifier (for isa/dyn_cast)
+ PATypeHolder Ty;
+ iplist<Use> Uses;
+ std::string Name;
+ void operator=(const Value &); // Do not implement
Value(const Value &); // Do not implement
-protected:
- inline void setType(const Type *ty) { Ty = ty; }
+
public:
- Value(const Type *Ty, ValueTy vty, const string &name = "");
+ Value(const Type *Ty, unsigned scid, const std::string &name = "");
virtual ~Value();
- // Support for debugging
- void dump() const;
+ /// dump - Support for debugging, callable in GDB: V->dump()
+ //
+ virtual void dump() const;
+
+ /// print - Implement operator<< on Value...
+ ///
+ virtual void print(std::ostream &O) const = 0;
- // All values can potentially be typed
+ /// All values are typed, get the type of this value.
+ ///
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; }
+ inline bool hasName() const { return !Name.empty(); }
+ inline const std::string &getName() const { return Name; }
- virtual void setName(const string &name, SymbolTable * = 0) {
+ virtual void setName(const std::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, allowing expressions like:
- //
- // if (Instruction *I = Val->castInstruction()) { ... }
- //
- // This section also defines a family of isType, isConstant,
- // isMethodArgument, etc functions...
- //
- // 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.
- //
- inline ValueTy getValueType() const { return VTy; }
-
- // Use a macro to define the functions, otherwise these definitions are just
- // really long and ugly.
-#define CAST_FN(NAME, CLASS) \
- inline bool is##NAME() const { return VTy == NAME##Val; } \
- inline const CLASS *cast##NAME() const { /*const version */ \
- return is##NAME() ? (const CLASS*)this : 0; \
- } \
- inline CLASS *cast##NAME() { /* nonconst version */ \
- return is##NAME() ? (CLASS*)this : 0; \
- } \
- inline const CLASS *cast##NAME##Asserting() const { /*const version */ \
- assert(is##NAME() && "Expected Value Type: " #NAME); \
- return (const CLASS*)this; \
- } \
- inline CLASS *cast##NAME##Asserting() { /* nonconst version */ \
- assert(is##NAME() && "Expected Value Type: " #NAME); \
- return (CLASS*)this; \
- } \
-
- CAST_FN(Constant , ConstPoolVal )
- CAST_FN(MethodArgument, MethodArgument)
- CAST_FN(Instruction , Instruction )
- CAST_FN(BasicBlock , BasicBlock )
- CAST_FN(Method , Method )
- CAST_FN(Global , GlobalVariable)
- CAST_FN(Module , Module )
-#undef CAST_FN
-
- // Type value is special, because there is no nonconst version of functions!
- inline bool isType() const { return VTy == TypeVal; }
- inline const Type *castType() const {
- return (VTy == TypeVal) ? (const Type*)this : 0;
- }
- inline const Type *castTypeAsserting() const {
- assert(isType() && "Expected Value Type: Type");
- return (const Type*)this;
- }
+ /// 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);
- // 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);
+ // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
+ // Only use when in type resolution situations!
+ void uncheckedReplaceAllUsesWith(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);
-
//----------------------------------------------------------------------
// Methods for handling the vector 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 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 UseListIteratorWrapper use_iterator;
+ typedef UseListConstIteratorWrapper use_const_iterator;
+ typedef iplist<Use>::size_type size_type;
+
+ size_type use_size() const { return Uses.size(); }
+ bool use_empty() const { return Uses.empty(); }
+ use_iterator use_begin() { return Uses.begin(); }
+ use_const_iterator use_begin() const { return Uses.begin(); }
+ use_iterator use_end() { return Uses.end(); }
+ use_const_iterator use_end() const { return Uses.end(); }
+ User *use_back() { return Uses.back().getUser(); }
+ const User *use_back() const { return Uses.back().getUser(); }
+
+ /// 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 {
+ iplist<Use>::const_iterator I = Uses.begin(), E = Uses.end();
+ if (I == E) return false;
+ return ++I == E;
+ }
-//===----------------------------------------------------------------------===//
-// UseTy Class
-//===----------------------------------------------------------------------===//
+ /// addUse/killUse - These two methods should only be used by the Use class.
+ ///
+ void addUse(Use &U) { Uses.push_back(&U); }
+ void killUse(Use &U) { Uses.remove(&U); }
+
+ /// 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;
+ }
-// 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);
+ // 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 ~UseTy<ValueSubclass>() { if (Val) Val->killUse(U); }
+ /// getRawType - This should only be used to implement the vmcore library.
+ ///
+ const Type *getRawType() const { return Ty.getRawType(); }
- inline operator ValueSubclass *() const { return Val; }
+private:
+ /// FIXME: this is a gross hack, needed by another gross hack. Eliminate!
+ void setValueType(unsigned VT) { SubclassID = VT; }
+ friend class Instruction;
+};
- 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;
- }
+inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
+ V.print(OS);
+ return OS;
+}
- inline ValueSubclass *operator->() { return Val; }
- inline const ValueSubclass *operator->() const { return Val; }
- inline UseTy<ValueSubclass> &operator=(const UseTy<ValueSubclass> &user) {
- if (Val) Val->killUse(U);
- Val = user.Val;
- Val->addUse(U);
- return *this;
- }
-};
+inline User *UseListIteratorWrapper::operator*() const {
+ return Super::operator*().getUser();
+}
-typedef UseTy<Value> Use; // Provide Use as a common UseTy type
+inline const User *UseListConstIteratorWrapper::operator*() const {
+ return Super::operator*().getUser();
+}
-//===----------------------------------------------------------------------===//
-// Type Checking Templates
-//===----------------------------------------------------------------------===//
+Use::Use(Value *v, User *user) : Val(v), U(user) {
+ if (Val) Val->addUse(*this);
+}
-// 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>
-bool isa(Y *Val) { return X::isa(Val); }
+Use::Use(const Use &u) : Val(u.Val), U(u.U) {
+ if (Val) Val->addUse(*this);
+}
+Use::~Use() {
+ if (Val) Val->killUse(*this);
+}
-// 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. Used Like this:
-//
-// cast< Instruction>(myVal)->getParent()
-// cast<const Instruction>(myVal)->getParent()
-//
-template <class X, class Y>
-X *cast(Y *Val) {
- assert(isa<X>(Val) && "Invalid cast argument type!");
- return (X*)Val;
+void Use::set(Value *V) {
+ if (Val) Val->killUse(*this);
+ Val = V;
+ if (V) V->addUse(*this);
}
-// 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)) { ... }
+// 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 Y>
-X *dyn_cast(Y *Val) {
- return isa<X>(Val) ? (X*)Val : 0;
+template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
+ 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;
+}
+template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
+ return Val.getValueType() == Value::BasicBlockVal;
+}
+template <> inline bool isa_impl<Function, Value>(const Value &Val) {
+ return Val.getValueType() == Value::FunctionVal;
+}
+template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
+ return Val.getValueType() == Value::GlobalVariableVal;
+}
+template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
+ return isa<GlobalVariable>(Val) || isa<Function>(Val);
+}
+
+} // End llvm namespace
#endif