X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FValue.h;h=fc1cf482095745012b91c8f220b435fc824eceee;hb=7ed47a13356daed2a34cd2209a31f92552e3bdd8;hp=dd97d3577d762e9baddea8785faed68928921c86;hpb=70cc3397f84c2e1fd69c059a0ef89e398e847b00;p=oota-llvm.git diff --git a/include/llvm/Value.h b/include/llvm/Value.h index dd97d3577d7..fc1cf482095 100644 --- a/include/llvm/Value.h +++ b/include/llvm/Value.h @@ -1,194 +1,276 @@ -//===-- 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 is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// This file declares the Value class. +// This file also defines the Use<> template for users of value. // //===----------------------------------------------------------------------===// #ifndef LLVM_VALUE_H #define LLVM_VALUE_H -#include -#include "llvm/Annotation.h" #include "llvm/AbstractTypeUser.h" +#include "llvm/Use.h" +#include "llvm/Support/Casting.h" +#include "llvm/Support/Streams.h" +#include + +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 ValueHolder; +class GlobalAlias; +class InlineAsm; +class ValueSymbolTable; +class TypeSymbolTable; +template class StringMapEntry; +typedef StringMapEntry ValueName; //===----------------------------------------------------------------------===// // 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 - }; - +/// 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. All types can have +/// a name and they should belong to some Module. Setting the name on the Value +/// automatically update's the module's symbol table. +/// +/// Every value has a "use list" that keeps track of which other Values are +/// using this Value. +/// @brief LLVM Value Representation +class Value { + const 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: - list Uses; - string Name; - PATypeHandle Ty; - ValueTy VTy; + PATypeHolder Ty; + Use *UseList; + + friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name. + friend class SymbolTable; // Allow SymbolTable to directly poke Name. + ValueName *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); virtual ~Value(); + /// 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; + void print(std::ostream *O) const { if (O) print(*O); } + + /// 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; } - 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 - // equilivent to using dynamic_cast<>... if the cast is successful, this is - // returned, otherwise you get a null pointer, allowing expressions like this: - // - // if (Instruction *I = Val->castInstruction()) { ... } - // - // This section also defines a family of isType, isConstant, isMethodArgument, - // etc functions... - // - // The family of functions Val->castAsserting() is used in the same - // way as the Val->cast() 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; - } + inline 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); + /// getNameStart - Return a pointer to a null terminated string for this name. + /// Note that names can have null characters within the string as well as at + /// their end. This always returns a non-null pointer. + const char *getNameStart() const; + + /// getNameLen - Return the length of the string, correctly handling nul + /// characters embedded into them. + unsigned getNameLen() const; - // 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); + /// getName()/getNameStr() - Return the name of the specified value, + /// *constructing a string* to hold it. Because these are guaranteed to + /// construct a string, they are very expensive and should be avoided. + std::string getName() const { return getNameStr(); } + std::string getNameStr() const; + + + void setName(const std::string &name); + void setName(const char *Name, unsigned NameLen); + void setName(const char *Name); // Takes a null-terminated string. + + + /// 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); + + // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous. + // Only use when in type resolution situations! + void uncheckedReplaceAllUsesWith(Value *V); //---------------------------------------------------------------------- - // Methods for handling the list of uses of this DEF. + // Methods for handling the vector of uses of this Value. // - typedef list::iterator use_iterator; - typedef list::const_iterator use_const_iterator; + typedef value_use_iterator use_iterator; + typedef value_use_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(); } + 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(); } - inline void use_push_back(User *I) { Uses.push_back(I); } - User *use_remove(use_iterator &I); + /// 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 void addUse(User *I) { Uses.push_back(I); } - void killUse(User *I); -}; + /// hasNUses - Return true if this Value has exactly N users. + /// + bool hasNUses(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 UseTy { - ValueSubclass *Val; - User *U; -public: - inline UseTy(ValueSubclass *v, User *user) { - Val = v; U = user; - if (Val) Val->addUse(U); - } + /// hasNUsesOrMore - Return true if this value has N users or more. This is + /// logically equivalent to getNumUses() >= N. + /// + bool hasNUsesOrMore(unsigned N) const; - inline ~UseTy() { if (Val) Val->killUse(U); } + /// 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; - inline operator ValueSubclass *() const { return Val; } + /// addUse/killUse - These two methods should only be used by the Use class. + /// + void addUse(Use &U) { U.addToList(&UseList); } - inline UseTy(const UseTy &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; - } + /// 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 + ConstantExprVal, // This is an instance of ConstantExpr + ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull + 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 + InlineAsmVal, // This is an instance of InlineAsm + InstructionVal, // This is an instance of Instruction + + // Markers: + ConstantFirstVal = FunctionVal, + ConstantLastVal = ConstantPointerNullVal + }; - inline ValueSubclass *operator->() { return Val; } - inline const ValueSubclass *operator->() const { return Val; } + /// 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 &operator=(const UseTy &user) { - if (Val) Val->killUse(U); - Val = user.Val; - Val->addUse(U); - return *this; + // Methods for support type inquiry through isa, cast, and dyn_cast: + static inline bool classof(const Value *) { + return true; // Values are always values. } + + /// getRawType - This should only be used to implement the vmcore library. + /// + const Type *getRawType() const { return Ty.getRawType(); } }; -typedef UseTy Use; +inline std::ostream &operator<<(std::ostream &OS, const Value &V) { + V.print(OS); + return OS; +} + +void Use::init(Value *v, User *user) { + Val = v; + U = user; + if (Val) Val->addUse(*this); +} + +Use::~Use() { + if (Val) removeFromList(); +} + +void Use::set(Value *V) { + if (Val) removeFromList(); + Val = V; + if (V) V->addUse(*this); +} + + +// 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(const Value &Val) { + return Val.getValueID() >= Value::ConstantFirstVal && + Val.getValueID() <= Value::ConstantLastVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() == Value::ArgumentVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() == Value::InlineAsmVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() >= Value::InstructionVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() == Value::BasicBlockVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() == Value::FunctionVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() == Value::GlobalVariableVal; +} +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() == Value::GlobalAliasVal; +} +template <> inline bool isa_impl(const Value &Val) { + return isa(Val) || isa(Val) || isa(Val); +} + +} // End llvm namespace #endif