2001-06-06 20:29:01 +00:00
|
|
|
//===-- llvm/Value.h - Definition of the Value class -------------*- C++ -*--=//
|
|
|
|
//
|
|
|
|
// This file defines the very important Value class. This is subclassed by a
|
2002-04-28 04:46:29 +00:00
|
|
|
// bunch of other important classes, like Instruction, Function, Type, etc...
|
2001-06-06 20:29:01 +00:00
|
|
|
//
|
2001-10-01 13:58:13 +00:00
|
|
|
// This file also defines the Use<> template for users of value.
|
|
|
|
//
|
2001-06-06 20:29:01 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_VALUE_H
|
|
|
|
#define LLVM_VALUE_H
|
|
|
|
|
2001-09-14 16:56:32 +00:00
|
|
|
#include <vector>
|
2001-08-23 17:06:21 +00:00
|
|
|
#include "llvm/Annotation.h"
|
2001-09-07 16:25:23 +00:00
|
|
|
#include "llvm/AbstractTypeUser.h"
|
2002-04-08 21:51:32 +00:00
|
|
|
#include "Support/Casting.h"
|
2001-06-06 20:29:01 +00:00
|
|
|
|
|
|
|
class User;
|
|
|
|
class Type;
|
2001-12-03 22:26:30 +00:00
|
|
|
class Constant;
|
2002-04-09 19:59:31 +00:00
|
|
|
class Argument;
|
2001-06-27 23:27:42 +00:00
|
|
|
class Instruction;
|
|
|
|
class BasicBlock;
|
2001-10-03 14:53:21 +00:00
|
|
|
class GlobalValue;
|
2002-03-23 22:51:58 +00:00
|
|
|
class Function;
|
2001-09-10 07:58:01 +00:00
|
|
|
class GlobalVariable;
|
2001-09-07 16:25:23 +00:00
|
|
|
class SymbolTable;
|
2001-07-14 06:07:58 +00:00
|
|
|
template<class ValueSubclass, class ItemParentType, class SymTabType>
|
|
|
|
class ValueHolder;
|
2001-06-06 20:29:01 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Value Class
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2001-09-07 16:25:23 +00:00
|
|
|
class Value : public Annotable, // Values are annotable
|
|
|
|
public AbstractTypeUser { // Values use potentially abstract types
|
2001-06-06 20:29:01 +00:00
|
|
|
public:
|
|
|
|
enum ValueTy {
|
|
|
|
TypeVal, // This is an instance of Type
|
2001-12-03 22:26:30 +00:00
|
|
|
ConstantVal, // This is an instance of Constant
|
2002-04-09 19:59:31 +00:00
|
|
|
ArgumentVal, // This is an instance of Argument
|
2001-06-06 20:29:01 +00:00
|
|
|
InstructionVal, // This is an instance of Instruction
|
|
|
|
BasicBlockVal, // This is an instance of BasicBlock
|
2002-03-26 17:48:08 +00:00
|
|
|
FunctionVal, // This is an instance of Function
|
2001-10-03 14:53:21 +00:00
|
|
|
GlobalVariableVal, // This is an instance of GlobalVariable
|
2001-06-06 20:29:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
2002-01-20 22:54:45 +00:00
|
|
|
std::vector<User *> Uses;
|
|
|
|
std::string Name;
|
2001-09-07 16:25:23 +00:00
|
|
|
PATypeHandle<Type> Ty;
|
2001-06-06 20:29:01 +00:00
|
|
|
ValueTy VTy;
|
|
|
|
|
|
|
|
Value(const Value &); // Do not implement
|
|
|
|
protected:
|
|
|
|
inline void setType(const Type *ty) { Ty = ty; }
|
|
|
|
public:
|
2002-01-20 22:54:45 +00:00
|
|
|
Value(const Type *Ty, ValueTy vty, const std::string &name = "");
|
2001-06-06 20:29:01 +00:00
|
|
|
virtual ~Value();
|
2001-09-18 12:23:40 +00:00
|
|
|
|
|
|
|
// Support for debugging
|
2001-09-18 17:03:04 +00:00
|
|
|
void dump() const;
|
2002-04-08 21:51:32 +00:00
|
|
|
|
|
|
|
// Implement operator<< on Value...
|
|
|
|
virtual void print(std::ostream &O) const = 0;
|
2001-09-18 12:23:40 +00:00
|
|
|
|
|
|
|
// All values can potentially be typed
|
2001-09-18 17:03:04 +00:00
|
|
|
inline const Type *getType() const { return Ty; }
|
2001-09-18 12:23:40 +00:00
|
|
|
|
2001-06-27 23:27:42 +00:00
|
|
|
// All values can potentially be named...
|
2002-01-20 22:54:45 +00:00
|
|
|
inline bool hasName() const { return Name != ""; }
|
|
|
|
inline const std::string &getName() const { return Name; }
|
2001-09-18 17:03:04 +00:00
|
|
|
|
2002-01-20 22:54:45 +00:00
|
|
|
virtual void setName(const std::string &name, SymbolTable * = 0) {
|
2001-09-18 17:03:04 +00:00
|
|
|
Name = name;
|
|
|
|
}
|
2001-09-18 12:23:40 +00:00
|
|
|
|
2001-06-27 23:27:42 +00:00
|
|
|
// Methods for determining the subtype of this Value. The getValueType()
|
|
|
|
// method returns the type of the value directly. The cast*() methods are
|
2001-09-18 12:23:40 +00:00
|
|
|
// equivalent to using dynamic_cast<>... if the cast is successful, this is
|
2001-10-01 16:18:37 +00:00
|
|
|
// returned, otherwise you get a null pointer.
|
2001-06-27 23:27:42 +00:00
|
|
|
//
|
|
|
|
// 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; }
|
2001-09-18 12:23:40 +00:00
|
|
|
|
2001-06-06 20:29:01 +00:00
|
|
|
// 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);
|
|
|
|
|
2001-09-07 16:25:23 +00:00
|
|
|
// 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);
|
2001-09-18 12:23:40 +00:00
|
|
|
|
2001-06-06 20:29:01 +00:00
|
|
|
//----------------------------------------------------------------------
|
2001-09-14 16:56:32 +00:00
|
|
|
// Methods for handling the vector of uses of this Value.
|
2001-06-06 20:29:01 +00:00
|
|
|
//
|
2002-01-20 22:54:45 +00:00
|
|
|
typedef std::vector<User*>::iterator use_iterator;
|
|
|
|
typedef std::vector<User*>::const_iterator use_const_iterator;
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-06-07 16:58:36 +00:00
|
|
|
inline unsigned use_size() const { return Uses.size(); }
|
2001-06-06 20:29:01 +00:00
|
|
|
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(); }
|
2001-10-13 06:18:19 +00:00
|
|
|
inline User *use_back() { return Uses.back(); }
|
|
|
|
inline const User *use_back() const { return Uses.back(); }
|
2001-06-06 20:29:01 +00:00
|
|
|
|
|
|
|
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);
|
|
|
|
};
|
|
|
|
|
2002-04-08 21:51:32 +00:00
|
|
|
inline std::ostream &operator<<(std::ostream &OS, const Value *V) {
|
|
|
|
if (V == 0)
|
|
|
|
OS << "<null> value!\n";
|
|
|
|
else
|
|
|
|
V->print(OS);
|
|
|
|
return OS;
|
|
|
|
}
|
|
|
|
|
2001-10-01 13:58:13 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// UseTy Class
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2001-06-06 20:29:01 +00:00
|
|
|
// 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);
|
|
|
|
}
|
|
|
|
|
|
|
|
inline ~UseTy<ValueSubclass>() { if (Val) Val->killUse(U); }
|
|
|
|
|
|
|
|
inline operator ValueSubclass *() const { return Val; }
|
|
|
|
|
|
|
|
inline UseTy<ValueSubclass>(const UseTy<ValueSubclass> &user) {
|
|
|
|
Val = 0;
|
|
|
|
U = user.U;
|
2001-06-11 15:04:06 +00:00
|
|
|
operator=(user.Val);
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
inline ValueSubclass *operator=(ValueSubclass *V) {
|
|
|
|
if (Val) Val->killUse(U);
|
|
|
|
Val = V;
|
|
|
|
if (V) V->addUse(U);
|
|
|
|
return V;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline ValueSubclass *operator->() { return Val; }
|
|
|
|
inline const ValueSubclass *operator->() const { return Val; }
|
|
|
|
|
2001-10-01 16:18:37 +00:00
|
|
|
inline ValueSubclass *get() { return Val; }
|
|
|
|
inline const ValueSubclass *get() const { return Val; }
|
|
|
|
|
2001-06-06 20:29:01 +00:00
|
|
|
inline UseTy<ValueSubclass> &operator=(const UseTy<ValueSubclass> &user) {
|
|
|
|
if (Val) Val->killUse(U);
|
|
|
|
Val = user.Val;
|
|
|
|
Val->addUse(U);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2001-10-01 13:58:13 +00:00
|
|
|
typedef UseTy<Value> Use; // Provide Use as a common UseTy type
|
|
|
|
|
2002-04-08 21:51:32 +00:00
|
|
|
// Provide a specialization of real_type to work with use's... to make them a
|
|
|
|
// bit more transparent.
|
2001-10-01 16:18:37 +00:00
|
|
|
//
|
|
|
|
template <class X> class real_type <class UseTy<X> > { typedef X *Type; };
|
2001-10-01 13:58:13 +00:00
|
|
|
|
2001-10-01 18:26:53 +00:00
|
|
|
|
2002-04-08 21:51:32 +00:00
|
|
|
// 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...
|
2001-10-01 18:26:53 +00:00
|
|
|
//
|
2001-10-01 20:11:19 +00:00
|
|
|
template <> inline bool isa<Type, const Value*>(const Value *Val) {
|
2001-10-01 18:26:53 +00:00
|
|
|
return Val->getValueType() == Value::TypeVal;
|
|
|
|
}
|
2001-10-01 20:11:19 +00:00
|
|
|
template <> inline bool isa<Type, Value*>(Value *Val) {
|
|
|
|
return Val->getValueType() == Value::TypeVal;
|
|
|
|
}
|
2001-12-03 22:26:30 +00:00
|
|
|
template <> inline bool isa<Constant, const Value*>(const Value *Val) {
|
2001-10-01 18:26:53 +00:00
|
|
|
return Val->getValueType() == Value::ConstantVal;
|
|
|
|
}
|
2001-12-03 22:26:30 +00:00
|
|
|
template <> inline bool isa<Constant, Value*>(Value *Val) {
|
2001-10-01 20:11:19 +00:00
|
|
|
return Val->getValueType() == Value::ConstantVal;
|
|
|
|
}
|
2002-04-09 19:59:31 +00:00
|
|
|
template <> inline bool isa<Argument, const Value*>(const Value *Val) {
|
|
|
|
return Val->getValueType() == Value::ArgumentVal;
|
2001-10-01 20:11:19 +00:00
|
|
|
}
|
2002-04-09 19:59:31 +00:00
|
|
|
template <> inline bool isa<Argument, Value*>(Value *Val) {
|
|
|
|
return Val->getValueType() == Value::ArgumentVal;
|
2001-10-01 18:26:53 +00:00
|
|
|
}
|
2001-10-01 20:11:19 +00:00
|
|
|
template <> inline bool isa<Instruction, const Value*>(const Value *Val) {
|
|
|
|
return Val->getValueType() == Value::InstructionVal;
|
|
|
|
}
|
|
|
|
template <> inline bool isa<Instruction, Value*>(Value *Val) {
|
2001-10-01 18:26:53 +00:00
|
|
|
return Val->getValueType() == Value::InstructionVal;
|
|
|
|
}
|
2001-10-01 20:11:19 +00:00
|
|
|
template <> inline bool isa<BasicBlock, const Value*>(const Value *Val) {
|
|
|
|
return Val->getValueType() == Value::BasicBlockVal;
|
|
|
|
}
|
|
|
|
template <> inline bool isa<BasicBlock, Value*>(Value *Val) {
|
2001-10-01 18:26:53 +00:00
|
|
|
return Val->getValueType() == Value::BasicBlockVal;
|
|
|
|
}
|
2002-03-23 22:51:58 +00:00
|
|
|
template <> inline bool isa<Function, const Value*>(const Value *Val) {
|
2002-03-26 17:48:08 +00:00
|
|
|
return Val->getValueType() == Value::FunctionVal;
|
2001-10-01 20:11:19 +00:00
|
|
|
}
|
2002-03-23 22:51:58 +00:00
|
|
|
template <> inline bool isa<Function, Value*>(Value *Val) {
|
2002-03-26 17:48:08 +00:00
|
|
|
return Val->getValueType() == Value::FunctionVal;
|
2001-10-01 18:26:53 +00:00
|
|
|
}
|
2001-10-01 20:11:19 +00:00
|
|
|
template <> inline bool isa<GlobalVariable, const Value*>(const Value *Val) {
|
2001-10-03 14:53:21 +00:00
|
|
|
return Val->getValueType() == Value::GlobalVariableVal;
|
2001-10-01 18:26:53 +00:00
|
|
|
}
|
2001-10-01 20:11:19 +00:00
|
|
|
template <> inline bool isa<GlobalVariable, Value*>(Value *Val) {
|
2001-10-03 14:53:21 +00:00
|
|
|
return Val->getValueType() == Value::GlobalVariableVal;
|
|
|
|
}
|
|
|
|
template <> inline bool isa<GlobalValue, const Value*>(const Value *Val) {
|
2002-03-23 22:51:58 +00:00
|
|
|
return isa<GlobalVariable>(Val) || isa<Function>(Val);
|
2001-10-03 14:53:21 +00:00
|
|
|
}
|
|
|
|
template <> inline bool isa<GlobalValue, Value*>(Value *Val) {
|
2002-03-23 22:51:58 +00:00
|
|
|
return isa<GlobalVariable>(Val) || isa<Function>(Val);
|
2001-10-01 20:11:19 +00:00
|
|
|
}
|
2001-10-01 18:26:53 +00:00
|
|
|
|
2001-06-06 20:29:01 +00:00
|
|
|
#endif
|