2003-09-30 20:37:50 +02:00
|
|
|
//===-- llvm/Value.h - Definition of the Value class ------------*- C++ -*-===//
|
2003-10-20 22:19:47 +02:00
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
2001-06-06 22:29:01 +02:00
|
|
|
//
|
|
|
|
// This file defines the very important Value class. This is subclassed by a
|
2002-04-28 06:46:29 +02:00
|
|
|
// bunch of other important classes, like Instruction, Function, Type, etc...
|
2001-06-06 22:29:01 +02:00
|
|
|
//
|
2001-10-01 15:58:13 +02:00
|
|
|
// This file also defines the Use<> template for users of value.
|
|
|
|
//
|
2001-06-06 22:29:01 +02:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_VALUE_H
|
|
|
|
#define LLVM_VALUE_H
|
|
|
|
|
2001-09-07 18:25:23 +02:00
|
|
|
#include "llvm/AbstractTypeUser.h"
|
2003-10-16 18:53:04 +02:00
|
|
|
#include "llvm/Use.h"
|
2004-09-02 00:55:40 +02:00
|
|
|
#include "llvm/Support/Casting.h"
|
2004-07-12 22:25:33 +02:00
|
|
|
#include <string>
|
2001-06-06 22:29:01 +02:00
|
|
|
|
2003-11-11 23:41:34 +01:00
|
|
|
namespace llvm {
|
|
|
|
|
2001-12-03 23:26:30 +01:00
|
|
|
class Constant;
|
2002-04-09 21:59:31 +02:00
|
|
|
class Argument;
|
2001-06-28 01:27:42 +02:00
|
|
|
class Instruction;
|
2004-10-27 18:14:51 +02:00
|
|
|
class BasicBlock;
|
2001-10-03 16:53:21 +02:00
|
|
|
class GlobalValue;
|
2002-03-23 23:51:58 +01:00
|
|
|
class Function;
|
2001-09-10 09:58:01 +02:00
|
|
|
class GlobalVariable;
|
2001-09-07 18:25:23 +02:00
|
|
|
class SymbolTable;
|
2001-06-06 22:29:01 +02:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Value Class
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2002-08-26 00:54:55 +02:00
|
|
|
/// Value - The base class of all values computed by a program that may be used
|
|
|
|
/// as operands to other values.
|
|
|
|
///
|
2004-09-23 16:49:45 +02:00
|
|
|
class Value {
|
2005-02-05 02:37:44 +01:00
|
|
|
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:
|
2004-06-26 22:33:27 +02:00
|
|
|
PATypeHolder Ty;
|
2005-02-01 02:22:06 +01:00
|
|
|
Use *UseList;
|
2005-03-06 03:10:40 +01:00
|
|
|
|
|
|
|
friend class SymbolTable; // Allow SymbolTable to directly poke Name.
|
2002-01-20 23:54:45 +01:00
|
|
|
std::string Name;
|
2001-06-06 22:29:01 +02:00
|
|
|
|
2002-07-24 22:01:57 +02:00
|
|
|
void operator=(const Value &); // Do not implement
|
2001-06-06 22:29:01 +02:00
|
|
|
Value(const Value &); // Do not implement
|
2004-06-26 22:33:27 +02:00
|
|
|
|
2001-06-06 22:29:01 +02:00
|
|
|
public:
|
2004-06-26 22:33:27 +02:00
|
|
|
Value(const Type *Ty, unsigned scid, const std::string &name = "");
|
2001-06-06 22:29:01 +02:00
|
|
|
virtual ~Value();
|
2001-09-18 14:23:40 +02:00
|
|
|
|
2002-08-26 00:54:55 +02:00
|
|
|
/// dump - Support for debugging, callable in GDB: V->dump()
|
|
|
|
//
|
2003-10-02 21:44:23 +02:00
|
|
|
virtual void dump() const;
|
2002-04-08 23:51:32 +02:00
|
|
|
|
2002-08-26 00:54:55 +02:00
|
|
|
/// print - Implement operator<< on Value...
|
|
|
|
///
|
2002-04-08 23:51:32 +02:00
|
|
|
virtual void print(std::ostream &O) const = 0;
|
2001-09-18 14:23:40 +02:00
|
|
|
|
2002-08-26 00:54:55 +02:00
|
|
|
/// All values are typed, get the type of this value.
|
|
|
|
///
|
2001-09-18 19:03:04 +02:00
|
|
|
inline const Type *getType() const { return Ty; }
|
2001-09-18 14:23:40 +02:00
|
|
|
|
2001-06-28 01:27:42 +02:00
|
|
|
// All values can potentially be named...
|
2004-01-10 22:40:29 +01:00
|
|
|
inline bool hasName() const { return !Name.empty(); }
|
2002-01-20 23:54:45 +01:00
|
|
|
inline const std::string &getName() const { return Name; }
|
2001-09-18 19:03:04 +02:00
|
|
|
|
2005-03-05 20:51:50 +01:00
|
|
|
void setName(const std::string &name);
|
2001-09-18 14:23:40 +02:00
|
|
|
|
2002-08-26 00:54:55 +02:00
|
|
|
/// 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);
|
2001-06-06 22:29:01 +02:00
|
|
|
|
2003-08-29 07:08:31 +02:00
|
|
|
// uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
|
|
|
|
// Only use when in type resolution situations!
|
|
|
|
void uncheckedReplaceAllUsesWith(Value *V);
|
|
|
|
|
2001-06-06 22:29:01 +02:00
|
|
|
//----------------------------------------------------------------------
|
2001-09-14 18:56:32 +02:00
|
|
|
// Methods for handling the vector of uses of this Value.
|
2001-06-06 22:29:01 +02:00
|
|
|
//
|
2005-02-01 02:22:06 +01:00
|
|
|
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(); }
|
2003-10-15 18:39:04 +02:00
|
|
|
|
2003-10-16 18:53:04 +02:00
|
|
|
/// 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.
|
2003-10-15 18:39:04 +02:00
|
|
|
///
|
2003-10-16 18:53:04 +02:00
|
|
|
bool hasOneUse() const {
|
2005-02-01 02:22:06 +01:00
|
|
|
use_const_iterator I = use_begin(), E = use_end();
|
2003-10-16 18:53:04 +02:00
|
|
|
if (I == E) return false;
|
|
|
|
return ++I == E;
|
|
|
|
}
|
2001-06-06 22:29:01 +02:00
|
|
|
|
2005-02-01 02:22:06 +01:00
|
|
|
/// hasNUses - Return true if this Value has exactly N users.
|
|
|
|
///
|
|
|
|
bool hasNUses(unsigned N) const;
|
|
|
|
|
2005-02-23 17:50:59 +01:00
|
|
|
/// hasNUsesOrMore - Return true if this value has N users or more. This is
|
|
|
|
/// logically equivalent to getNumUses() >= N.
|
|
|
|
///
|
|
|
|
bool hasNUsesOrMore(unsigned N) const;
|
|
|
|
|
2005-02-01 02:22:06 +01:00
|
|
|
/// getNumUses - This method computes the number of uses of this Value. This
|
2005-02-23 17:50:59 +01:00
|
|
|
/// is a linear time operation. Use hasOneUse, hasNUses, or hasMoreThanNUses
|
|
|
|
/// to check for specific values.
|
2005-02-01 02:22:06 +01:00
|
|
|
unsigned getNumUses() const;
|
|
|
|
|
2003-10-16 18:53:04 +02:00
|
|
|
/// addUse/killUse - These two methods should only be used by the Use class.
|
|
|
|
///
|
2005-02-01 02:22:06 +01:00
|
|
|
void addUse(Use &U) { U.addToList(&UseList); }
|
2004-06-26 22:33:27 +02:00
|
|
|
|
|
|
|
/// 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 {
|
2004-07-19 02:57:40 +02:00
|
|
|
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
|
2004-10-16 20:06:07 +02:00
|
|
|
UndefValueVal, // This is an instance of UndefValue
|
2004-07-19 02:57:40 +02:00
|
|
|
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
|
2004-06-26 22:33:27 +02:00
|
|
|
};
|
|
|
|
unsigned getValueType() const {
|
|
|
|
return SubclassID;
|
|
|
|
}
|
2004-06-27 20:38:24 +02:00
|
|
|
|
2004-07-30 08:59:15 +02:00
|
|
|
// Methods for support type inquiry through isa, cast, and dyn_cast:
|
|
|
|
static inline bool classof(const Value *V) {
|
|
|
|
return true; // Values are always values.
|
|
|
|
}
|
|
|
|
|
2004-08-04 06:45:42 +02:00
|
|
|
/// getRawType - This should only be used to implement the vmcore library.
|
|
|
|
///
|
|
|
|
const Type *getRawType() const { return Ty.getRawType(); }
|
|
|
|
|
2004-06-27 20:38:24 +02:00
|
|
|
private:
|
|
|
|
/// FIXME: this is a gross hack, needed by another gross hack. Eliminate!
|
|
|
|
void setValueType(unsigned VT) { SubclassID = VT; }
|
|
|
|
friend class Instruction;
|
2001-06-06 22:29:01 +02:00
|
|
|
};
|
|
|
|
|
2002-06-25 18:12:52 +02:00
|
|
|
inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
|
|
|
|
V.print(OS);
|
|
|
|
return OS;
|
|
|
|
}
|
|
|
|
|
2005-01-29 01:30:52 +01:00
|
|
|
void Use::init(Value *v, User *user) {
|
|
|
|
Val = v;
|
|
|
|
U = user;
|
2003-10-16 18:53:04 +02:00
|
|
|
if (Val) Val->addUse(*this);
|
|
|
|
}
|
2001-06-06 22:29:01 +02:00
|
|
|
|
2003-10-16 18:53:04 +02:00
|
|
|
Use::~Use() {
|
2005-02-01 02:22:06 +01:00
|
|
|
if (Val) removeFromList();
|
2003-10-16 18:53:04 +02:00
|
|
|
}
|
2001-10-01 18:18:37 +02:00
|
|
|
|
2003-10-16 18:53:04 +02:00
|
|
|
void Use::set(Value *V) {
|
2005-02-01 02:22:06 +01:00
|
|
|
if (Val) removeFromList();
|
2003-10-16 18:53:04 +02:00
|
|
|
Val = V;
|
|
|
|
if (V) V->addUse(*this);
|
|
|
|
}
|
2001-06-06 22:29:01 +02:00
|
|
|
|
2001-10-01 20:26:53 +02:00
|
|
|
|
2002-04-08 23:51:32 +02: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 20:26:53 +02:00
|
|
|
//
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
|
2004-10-16 20:06:07 +02:00
|
|
|
return Val.getValueType() == Value::SimpleConstantVal ||
|
2004-07-18 01:34:47 +02:00
|
|
|
Val.getValueType() == Value::FunctionVal ||
|
2005-03-16 04:46:55 +01:00
|
|
|
Val.getValueType() == Value::GlobalVariableVal ||
|
2004-10-16 20:06:07 +02:00
|
|
|
Val.getValueType() == Value::ConstantExprVal ||
|
|
|
|
Val.getValueType() == Value::ConstantAggregateZeroVal ||
|
|
|
|
Val.getValueType() == Value::UndefValueVal;
|
2001-10-01 20:26:53 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
|
|
|
|
return Val.getValueType() == Value::ArgumentVal;
|
2001-10-01 22:11:19 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
|
2004-06-27 20:38:24 +02:00
|
|
|
return Val.getValueType() >= Value::InstructionVal;
|
2001-10-01 20:26:53 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
|
|
|
|
return Val.getValueType() == Value::BasicBlockVal;
|
2001-10-01 22:11:19 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<Function, Value>(const Value &Val) {
|
|
|
|
return Val.getValueType() == Value::FunctionVal;
|
2001-10-01 20:26:53 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
|
|
|
|
return Val.getValueType() == Value::GlobalVariableVal;
|
2001-10-03 16:53:21 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
|
2002-03-23 23:51:58 +01:00
|
|
|
return isa<GlobalVariable>(Val) || isa<Function>(Val);
|
2001-10-01 22:11:19 +02:00
|
|
|
}
|
2001-10-01 20:26:53 +02:00
|
|
|
|
2003-11-11 23:41:34 +01:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2001-06-06 22:29:01 +02:00
|
|
|
#endif
|