X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FValue.h;h=44c4453b04a045577ec5181f8f692023c406f4d0;hb=7adb53e7b1a4ec0cda17cbc946da44147c141d69;hp=b9db5d643a6bce5de68c5370a484605d352e4063;hpb=977a39570fcade4dfed60124f67eabc51efa76c6;p=oota-llvm.git diff --git a/include/llvm/Value.h b/include/llvm/Value.h index b9db5d643a6..44c4453b04a 100644 --- a/include/llvm/Value.h +++ b/include/llvm/Value.h @@ -1,15 +1,13 @@ //===-- 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... +//===----------------------------------------------------------------------===// // +// This file declares the Value class. // This file also defines the Use<> template for users of value. // //===----------------------------------------------------------------------===// @@ -20,6 +18,7 @@ #include "llvm/AbstractTypeUser.h" #include "llvm/Use.h" #include "llvm/Support/Casting.h" +#include "llvm/Support/Streams.h" #include namespace llvm { @@ -31,17 +30,29 @@ class BasicBlock; class GlobalValue; class Function; class GlobalVariable; -class SymbolTable; +class GlobalAlias; +class InlineAsm; +class ValueSymbolTable; +class TypeSymbolTable; +template class StringMapEntry; +typedef StringMapEntry ValueName; //===----------------------------------------------------------------------===// // Value Class //===----------------------------------------------------------------------===// -/// Value - The base class of all values computed by a program that may be used -/// as operands to other values. +/// 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 { - unsigned short SubclassID; // Subclass identifier (for isa/dyn_cast) + 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. @@ -50,15 +61,18 @@ protected: private: PATypeHolder Ty; Use *UseList; - std::string Name; + + 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 public: - Value(const Type *Ty, unsigned scid, const std::string &name = ""); + Value(const Type *Ty, unsigned scid); virtual ~Value(); - + /// dump - Support for debugging, callable in GDB: V->dump() // virtual void dump() const; @@ -66,21 +80,29 @@ public: /// 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.empty(); } - inline const std::string &getName() const { return Name; } + inline bool hasName() const { return Name != 0; } + std::string getName() const { return getNameStr(); } + std::string getNameStr() const; + ValueName *getValueName() const { return Name; } + + void setName(const std::string &name); + void setName(const char *Name, unsigned NameLen); + void setName(const char *Name); // Takes a null-terminated string. - virtual void setName(const std::string &name, SymbolTable * = 0) { - Name = name; - } + /// 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 + /// each use point to "V" instead of "this". After this completes, 'this's /// use list is guaranteed to be empty. /// void replaceAllUsesWith(Value *V); @@ -131,42 +153,54 @@ public: /// 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). - /// + /// 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 - SimpleConstantVal, // This is some other type of Constant + 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 - ValueListVal // This is for bcreader, a special ValTy + + // Markers: + ConstantFirstVal = FunctionVal, + ConstantLastVal = ConstantPointerNullVal }; - unsigned getValueType() const { + + /// 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; } // Methods for support type inquiry through isa, cast, and dyn_cast: - static inline bool classof(const Value *V) { + 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(); } - -private: - /// FIXME: this is a gross hack, needed by another gross hack. Eliminate! - void setValueType(unsigned VT) { SubclassID = VT; } - friend class Instruction; }; inline std::ostream &operator<<(std::ostream &OS, const Value &V) { @@ -184,7 +218,7 @@ Use::~Use() { if (Val) removeFromList(); } -void Use::set(Value *V) { +void Use::set(Value *V) { if (Val) removeFromList(); Val = V; if (V) V->addUse(*this); @@ -194,31 +228,33 @@ void Use::set(Value *V) { // 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.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(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.getValueType() == Value::ArgumentVal; +template <> inline bool isa_impl(const Value &Val) { + return Val.getValueID() >= Value::InstructionVal; } -template <> inline bool isa_impl(const Value &Val) { - return Val.getValueType() >= 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.getValueType() == 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.getValueType() == 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.getValueType() == 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); +template <> inline bool isa_impl(const Value &Val) { + return isa(Val) || isa(Val) || isa(Val); } } // End llvm namespace