X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FMetadata.h;h=59b4b2619629ee9cd33bc378c11e442126435fa8;hb=127a669d09e21ddcd525f493c19dc399093bef35;hp=0844006396d8a0e2f7b56d7ace1be4d47fa6f2e0;hpb=d9489cbb0cf933da9e2154a5336533d6254a5c30;p=oota-llvm.git diff --git a/include/llvm/Metadata.h b/include/llvm/Metadata.h index 0844006396d..59b4b261962 100644 --- a/include/llvm/Metadata.h +++ b/include/llvm/Metadata.h @@ -13,84 +13,53 @@ // //===----------------------------------------------------------------------===// -#ifndef LLVM_MDNODE_H -#define LLVM_MDNODE_H +#ifndef LLVM_METADATA_H +#define LLVM_METADATA_H -#include "llvm/User.h" -#include "llvm/Type.h" -#include "llvm/OperandTraits.h" +#include "llvm/Value.h" +#include "llvm/ADT/ArrayRef.h" #include "llvm/ADT/FoldingSet.h" -#include "llvm/ADT/SmallVector.h" -#include "llvm/ADT/SmallPtrSet.h" #include "llvm/ADT/ilist_node.h" -#include "llvm/Support/ErrorHandling.h" -#include "llvm/Support/ValueHandle.h" namespace llvm { class Constant; +class Instruction; class LLVMContext; - -//===----------------------------------------------------------------------===// -// MetadataBase - A base class for MDNode, MDString and NamedMDNode. -class MetadataBase : public User { -private: - /// ReservedSpace - The number of operands actually allocated. NumOperands is - /// the number actually in use. - unsigned ReservedSpace; - -protected: - MetadataBase(const Type *Ty, unsigned scid) - : User(Ty, scid, NULL, 0), ReservedSpace(0) {} - - void resizeOperands(unsigned NumOps); -public: - /// isNullValue - Return true if this is the value that would be returned by - /// getNullValue. This always returns false because getNullValue will never - /// produce metadata. - virtual bool isNullValue() const { - return false; - } - - /// Methods for support type inquiry through isa, cast, and dyn_cast: - static inline bool classof(const MetadataBase *) { return true; } - static bool classof(const Value *V) { - return V->getValueID() == MDStringVal || V->getValueID() == MDNodeVal - || V->getValueID() == NamedMDNodeVal; - } -}; - +class Module; +template class SmallVectorImpl; +template + class SymbolTableListTraits; + + //===----------------------------------------------------------------------===// /// MDString - a single uniqued string. /// These are used to efficiently contain a byte sequence for metadata. -/// MDString is always unnamd. -class MDString : public MetadataBase { +/// MDString is always unnamed. +class MDString : public Value { MDString(const MDString &); // DO NOT IMPLEMENT - void *operator new(size_t, unsigned); // DO NOT IMPLEMENT - unsigned getNumOperands(); // DO NOT IMPLEMENT StringRef Str; -protected: - explicit MDString(LLVMContext &C, const char *begin, unsigned l) - : MetadataBase(Type::getMetadataTy(C), Value::MDStringVal), Str(begin, l) {} + explicit MDString(LLVMContext &C, StringRef S); public: - // Do not allocate any space for operands. - void *operator new(size_t s) { - return User::operator new(s, 0); + static MDString *get(LLVMContext &Context, StringRef Str); + static MDString *get(LLVMContext &Context, const char *Str) { + return get(Context, Str ? StringRef(Str) : StringRef()); } - static MDString *get(LLVMContext &Context, const StringRef &Str); - + StringRef getString() const { return Str; } - unsigned length() const { return Str.size(); } + unsigned getLength() const { return (unsigned)Str.size(); } + typedef StringRef::iterator iterator; + /// begin() - Pointer to the first byte of the string. /// - const char *begin() const { return Str.begin(); } + iterator begin() const { return Str.begin(); } /// end() - Pointer to one byte past the end of the string. /// - const char *end() const { return Str.end(); } + iterator end() const { return Str.end(); } /// Methods for support type inquiry through isa, cast, and dyn_cast: static inline bool classof(const MDString *) { return true; } @@ -99,148 +68,135 @@ public: } }; + +class MDNodeOperand; + //===----------------------------------------------------------------------===// /// MDNode - a tuple of other values. -/// These contain a list of the values that represent the metadata. -/// MDNode is always unnamed. -class MDNode : public MetadataBase, public FoldingSetNode { +class MDNode : public Value, public FoldingSetNode { MDNode(const MDNode &); // DO NOT IMPLEMENT - void *operator new(size_t, unsigned); // DO NOT IMPLEMENT - // getNumOperands - Make this only available for private uses. - unsigned getNumOperands() { return User::getNumOperands(); } - - friend class ElementVH; - // Use CallbackVH to hold MDNOde elements. - struct ElementVH : public CallbackVH { - MDNode *Parent; - ElementVH(Value *V, MDNode *P) : CallbackVH(V), Parent(P) {} - ~ElementVH() {} - - virtual void deleted() { - Parent->replaceElement(this->operator Value*(), 0); - } - - virtual void allUsesReplacedWith(Value *NV) { - Parent->replaceElement(this->operator Value*(), NV); - } - }; - // Replace each instance of F from the element list of this node with T. - void replaceElement(Value *F, Value *T); + void operator=(const MDNode &); // DO NOT IMPLEMENT + friend class MDNodeOperand; + friend class LLVMContextImpl; - SmallVector Node; + /// NumOperands - This many 'MDNodeOperand' items are co-allocated onto the + /// end of this MDNode. + unsigned NumOperands; + + // Subclass data enums. + enum { + /// FunctionLocalBit - This bit is set if this MDNode is function local. + /// This is true when it (potentially transitively) contains a reference to + /// something in a function, like an argument, basicblock, or instruction. + FunctionLocalBit = 1 << 0, + + /// NotUniquedBit - This is set on MDNodes that are not uniqued because they + /// have a null operand. + NotUniquedBit = 1 << 1, + + /// DestroyFlag - This bit is set by destroy() so the destructor can assert + /// that the node isn't being destroyed with a plain 'delete'. + DestroyFlag = 1 << 2 + }; + + // FunctionLocal enums. + enum FunctionLocalness { + FL_Unknown = -1, + FL_No = 0, + FL_Yes = 1 + }; + + /// replaceOperand - Replace each instance of F from the operand list of this + /// node with T. + void replaceOperand(MDNodeOperand *Op, Value *NewVal); + ~MDNode(); -protected: - explicit MDNode(LLVMContext &C, Value*const* Vals, unsigned NumVals); + MDNode(LLVMContext &C, ArrayRef Vals, bool isFunctionLocal); + + static MDNode *getMDNode(LLVMContext &C, ArrayRef Vals, + FunctionLocalness FL, bool Insert = true); public: - // Do not allocate any space for operands. - void *operator new(size_t s) { - return User::operator new(s, 0); - } // Constructors and destructors. - static MDNode *get(LLVMContext &Context, - Value* const* Vals, unsigned NumVals); - - /// dropAllReferences - Remove all uses and clear node vector. - void dropAllReferences(); - - /// ~MDNode - Destroy MDNode. - ~MDNode(); + static MDNode *get(LLVMContext &Context, ArrayRef Vals); + // getWhenValsUnresolved - Construct MDNode determining function-localness + // from isFunctionLocal argument, not by analyzing Vals. + static MDNode *getWhenValsUnresolved(LLVMContext &Context, + ArrayRef Vals, + bool isFunctionLocal); + + static MDNode *getIfExists(LLVMContext &Context, ArrayRef Vals); + + /// getTemporary - Return a temporary MDNode, for use in constructing + /// cyclic MDNode structures. A temporary MDNode is not uniqued, + /// may be RAUW'd, and must be manually deleted with deleteTemporary. + static MDNode *getTemporary(LLVMContext &Context, ArrayRef Vals); + + /// deleteTemporary - Deallocate a node created by getTemporary. The + /// node must not have any users. + static void deleteTemporary(MDNode *N); - /// getElement - Return specified element. - Value *getElement(unsigned i) const { - assert (getNumElements() > i && "Invalid element number!"); - return Node[i]; - } - - /// getNumElements - Return number of MDNode elements. - unsigned getNumElements() const { - return Node.size(); - } - - // Element access - typedef SmallVectorImpl::const_iterator const_elem_iterator; - typedef SmallVectorImpl::iterator elem_iterator; - /// elem_empty - Return true if MDNode is empty. - bool elem_empty() const { return Node.empty(); } - const_elem_iterator elem_begin() const { return Node.begin(); } - const_elem_iterator elem_end() const { return Node.end(); } - elem_iterator elem_begin() { return Node.begin(); } - elem_iterator elem_end() { return Node.end(); } - - /// isNullValue - Return true if this is the value that would be returned by - /// getNullValue. This always returns false because getNullValue will never - /// produce metadata. - virtual bool isNullValue() const { - return false; + /// getOperand - Return specified operand. + Value *getOperand(unsigned i) const; + + /// getNumOperands - Return number of MDNode operands. + unsigned getNumOperands() const { return NumOperands; } + + /// isFunctionLocal - Return whether MDNode is local to a function. + bool isFunctionLocal() const { + return (getSubclassDataFromValue() & FunctionLocalBit) != 0; } + + // getFunction - If this metadata is function-local and recursively has a + // function-local operand, return the first such operand's parent function. + // Otherwise, return null. getFunction() should not be used for performance- + // critical code because it recursively visits all the MDNode's operands. + const Function *getFunction() const; /// Profile - calculate a unique identifier for this MDNode to collapse /// duplicates void Profile(FoldingSetNodeID &ID) const; - virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) { - llvm_unreachable("This should never be called because MDNodes have no ops"); - } - /// Methods for support type inquiry through isa, cast, and dyn_cast: static inline bool classof(const MDNode *) { return true; } static bool classof(const Value *V) { return V->getValueID() == MDNodeVal; } -}; +private: + // destroy - Delete this node. Only when there are no uses. + void destroy(); -//===----------------------------------------------------------------------===// -/// WeakMetadataVH - a weak value handle for metadata. -class WeakMetadataVH : public WeakVH { -public: - WeakMetadataVH() : WeakVH() {} - WeakMetadataVH(MetadataBase *M) : WeakVH(M) {} - WeakMetadataVH(const WeakMetadataVH &RHS) : WeakVH(RHS) {} - - operator Value*() const { - llvm_unreachable("WeakMetadataVH only handles Metadata"); + bool isNotUniqued() const { + return (getSubclassDataFromValue() & NotUniquedBit) != 0; } - - operator MetadataBase*() const { - return dyn_cast_or_null(getValPtr()); + void setIsNotUniqued(); + + // Shadow Value::setValueSubclassData with a private forwarding method so that + // any future subclasses cannot accidentally use it. + void setValueSubclassData(unsigned short D) { + Value::setValueSubclassData(D); } }; //===----------------------------------------------------------------------===// -/// NamedMDNode - a tuple of other metadata. -/// NamedMDNode is always named. All NamedMDNode element has a type of metadata. -template - class SymbolTableListTraits; - -class NamedMDNode : public MetadataBase, public ilist_node { +/// NamedMDNode - a tuple of MDNodes. Despite its name, a NamedMDNode isn't +/// itself an MDNode. NamedMDNodes belong to modules, have names, and contain +/// lists of MDNodes. +class NamedMDNode : public ilist_node { friend class SymbolTableListTraits; + friend struct ilist_traits; friend class LLVMContextImpl; - + friend class Module; NamedMDNode(const NamedMDNode &); // DO NOT IMPLEMENT - void *operator new(size_t, unsigned); // DO NOT IMPLEMENT - // getNumOperands - Make this only available for private uses. - unsigned getNumOperands() { return User::getNumOperands(); } + std::string Name; Module *Parent; - SmallVector Node; - typedef SmallVectorImpl::iterator elem_iterator; + void *Operands; // SmallVector, 4> -protected: - explicit NamedMDNode(LLVMContext &C, const Twine &N, MetadataBase*const* Vals, - unsigned NumVals, Module *M = 0); -public: - // Do not allocate any space for operands. - void *operator new(size_t s) { - return User::operator new(s, 0); - } - static NamedMDNode *Create(LLVMContext &C, const Twine &N, - MetadataBase*const*MDs, - unsigned NumMDs, Module *M = 0) { - return new NamedMDNode(C, N, MDs, NumMDs, M); - } + void setParent(Module *M) { Parent = M; } - static NamedMDNode *Create(const NamedMDNode *NMD, Module *M = 0); + explicit NamedMDNode(const Twine &N); +public: /// eraseFromParent - Drop all references and remove the node from parent /// module. void eraseFromParent(); @@ -254,50 +210,24 @@ public: /// getParent - Get the module that holds this named metadata collection. inline Module *getParent() { return Parent; } inline const Module *getParent() const { return Parent; } - void setParent(Module *M) { Parent = M; } - - /// getElement - Return specified element. - MetadataBase *getElement(unsigned i) const { - assert (getNumElements() > i && "Invalid element number!"); - return Node[i]; - } - /// getNumElements - Return number of NamedMDNode elements. - unsigned getNumElements() const { - return Node.size(); - } + /// getOperand - Return specified operand. + MDNode *getOperand(unsigned i) const; + + /// getNumOperands - Return the number of NamedMDNode operands. + unsigned getNumOperands() const; - /// addElement - Add metadata element. - void addElement(MetadataBase *M) { - resizeOperands(0); - OperandList[NumOperands++] = M; - Node.push_back(WeakMetadataVH(M)); - } + /// addOperand - Add metadata operand. + void addOperand(MDNode *M); - typedef SmallVectorImpl::const_iterator const_elem_iterator; - bool elem_empty() const { return Node.empty(); } - const_elem_iterator elem_begin() const { return Node.begin(); } - const_elem_iterator elem_end() const { return Node.end(); } - elem_iterator elem_begin() { return Node.begin(); } - elem_iterator elem_end() { return Node.end(); } - - /// isNullValue - Return true if this is the value that would be returned by - /// getNullValue. This always returns false because getNullValue will never - /// produce metadata. - virtual bool isNullValue() const { - return false; - } + /// getName - Return a constant reference to this named metadata's name. + StringRef getName() const; - virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) { - llvm_unreachable( - "This should never be called because NamedMDNodes have no ops"); - } + /// print - Implement operator<< on NamedMDNode. + void print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW = 0) const; - /// Methods for support type inquiry through isa, cast, and dyn_cast: - static inline bool classof(const NamedMDNode *) { return true; } - static bool classof(const Value *V) { - return V->getValueID() == NamedMDNodeVal; - } + /// dump() - Allow printing of NamedMDNodes from the debugger. + void dump() const; }; } // end llvm namespace