X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FMetadata.h;h=a6c3f039a11ec41802f5da0590c0421692b06571;hb=9a376a8003c486054ea4d7c2465cb90b501c9893;hp=c25ce22511eb0bfd8af1dead120c78c60d067ffd;hpb=b17f65829c44142827e4c3b9a062ee5cc84f566d;p=oota-llvm.git diff --git a/include/llvm/Metadata.h b/include/llvm/Metadata.h index c25ce22511e..a6c3f039a11 100644 --- a/include/llvm/Metadata.h +++ b/include/llvm/Metadata.h @@ -25,41 +25,27 @@ class Constant; class Instruction; class LLVMContext; class Module; -class MetadataContextImpl; template class SmallVectorImpl; - -//===----------------------------------------------------------------------===// -// MetadataBase - A base class for MDNode, MDString and NamedMDNode. -class MetadataBase : public Value { -protected: - MetadataBase(const Type *Ty, unsigned scid) - : Value(Ty, scid) {} - -public: - - /// 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; - } -}; - +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 { +class MDString : public Value { MDString(const MDString &); // DO NOT IMPLEMENT StringRef Str; -protected: explicit MDString(LLVMContext &C, StringRef S); public: static MDString *get(LLVMContext &Context, StringRef Str); - static MDString *get(LLVMContext &Context, const char *Str); - + static MDString *get(LLVMContext &Context, const char *Str) { + return get(Context, Str ? StringRef(Str) : StringRef()); + } + StringRef getString() const { return Str; } unsigned getLength() const { return (unsigned)Str.size(); } @@ -82,52 +68,91 @@ public: }; -class MDNodeElement; +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=(const MDNode &); // DO NOT IMPLEMENT - friend class MDNodeElement; + friend class MDNodeOperand; + friend class LLVMContextImpl; - MDNodeElement *Operands; + /// NumOperands - This many 'MDNodeOperand' items are co-allocated onto the + /// end of this MDNode. unsigned NumOperands; // Subclass data enums. enum { - FunctionLocalBit = 1 + /// 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 }; - // Replace each instance of F from the element list of this node with T. - void replaceElement(MDNodeElement *Op, Value *NewVal); + /// 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, - bool isFunctionLocal); + MDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals, + bool isFunctionLocal); + + static MDNode *getMDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals, + FunctionLocalness FL, bool Insert = true); public: // Constructors and destructors. - static MDNode *get(LLVMContext &Context, Value *const *Vals, unsigned NumVals, - bool isFunctionLocal = false); - - /// ~MDNode - Destroy MDNode. - ~MDNode(); + static MDNode *get(LLVMContext &Context, Value *const *Vals, + unsigned NumVals); + // getWhenValsUnresolved - Construct MDNode determining function-localness + // from isFunctionLocal argument, not by analyzing Vals. + static MDNode *getWhenValsUnresolved(LLVMContext &Context, Value *const *Vals, + unsigned NumVals, bool isFunctionLocal); + + static MDNode *getIfExists(LLVMContext &Context, Value *const *Vals, + unsigned NumVals); + + /// 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, Value *const *Vals, + unsigned NumVals); + + /// 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; + /// getOperand - Return specified operand. + Value *getOperand(unsigned i) const; - /// getNumElements - Return number of MDNode elements. - unsigned getNumElements() const { return NumOperands; } + /// getNumOperands - Return number of MDNode operands. + unsigned getNumOperands() const { return NumOperands; } /// isFunctionLocal - Return whether MDNode is local to a function. - /// Note: MDNodes are designated as function-local when created, and keep - /// that designation even if their operands are modified to no longer - /// refer to function-local IR. 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 @@ -139,6 +164,14 @@ public: return V->getValueID() == MDNodeVal; } private: + // destroy - Delete this node. Only when there are no uses. + void destroy(); + + bool isNotUniqued() const { + return (getSubclassDataFromValue() & NotUniquedBit) != 0; + } + void setIsNotUniqued(); + // Shadow Value::setValueSubclassData with a private forwarding method so that // any future subclasses cannot accidentally use it. void setValueSubclassData(unsigned short D) { @@ -147,33 +180,25 @@ private: }; //===----------------------------------------------------------------------===// -/// 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 + std::string Name; Module *Parent; - void *Operands; // SmallVector, 4> + void *Operands; // SmallVector, 4> void setParent(Module *M) { Parent = M; } -protected: - explicit NamedMDNode(LLVMContext &C, const Twine &N, MetadataBase*const *Vals, - unsigned NumVals, Module *M = 0); -public: - static NamedMDNode *Create(LLVMContext &C, const Twine &N, - MetadataBase *const *MDs, - unsigned NumMDs, Module *M = 0) { - return new NamedMDNode(C, N, MDs, NumMDs, 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(); @@ -188,42 +213,20 @@ public: inline Module *getParent() { return Parent; } inline const Module *getParent() const { return Parent; } - /// getElement - Return specified element. - MetadataBase *getElement(unsigned i) const; + /// getOperand - Return specified operand. + MDNode *getOperand(unsigned i) const; - /// getNumElements - Return number of NamedMDNode elements. - unsigned getNumElements() const; - - /// addElement - Add metadata element. - void addElement(MetadataBase *M); - - /// 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; - } -}; + /// getNumOperands - Return the number of NamedMDNode operands. + unsigned getNumOperands() const; -//===----------------------------------------------------------------------===// -/// MetadataContext - MetadataContext handles uniquing and assignment of IDs for -/// custom metadata types. -/// -class MetadataContext { - MetadataContext(MetadataContext&); // DO NOT IMPLEMENT - void operator=(MetadataContext&); // DO NOT IMPLEMENT - - MetadataContextImpl *const pImpl; - friend class Instruction; -public: - MetadataContext(); - ~MetadataContext(); + /// addOperand - Add metadata operand. + void addOperand(MDNode *M); - /// getMDKindID - Return a unique non-zero ID for the specified metadata kind. - unsigned getMDKindID(StringRef Name) const; + /// getName - Return a constant reference to this named metadata's name. + StringRef getName() const; - /// getMDKindNames - Populate client supplied SmallVector with the name for - /// each custom metadata ID. ID #0 is not used, so it is filled in as empty. - void getMDKindNames(SmallVectorImpl &) const; + /// print - Implement operator<< on NamedMDNode. + void print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW = 0) const; }; } // end llvm namespace