X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=include%2Fllvm%2FIR%2FAttributes.h;h=6c014ea10465bba645869a84dbd55d285f1a6727;hp=de214d17c6df7a34ebb32542771a7fafb9931902;hb=b1ac6e617291e2a628bc460933bde97c73466cb0;hpb=28d65722d6f283b327b5815914382077fe9c0ab4 diff --git a/include/llvm/IR/Attributes.h b/include/llvm/IR/Attributes.h index de214d17c6d..6c014ea1046 100644 --- a/include/llvm/IR/Attributes.h +++ b/include/llvm/IR/Attributes.h @@ -17,16 +17,21 @@ #define LLVM_IR_ATTRIBUTES_H #include "llvm/ADT/ArrayRef.h" -#include "llvm/ADT/DenseSet.h" -#include "llvm/Support/MathExtras.h" +#include "llvm/ADT/FoldingSet.h" +#include "llvm/Support/PointerLikeTypeTraits.h" +#include #include +#include #include namespace llvm { class AttrBuilder; class AttributeImpl; +class AttributeSetImpl; +class AttributeSetNode; class Constant; +template struct DenseMapInfo; class LLVMContext; class Type; @@ -39,13 +44,13 @@ class Type; class Attribute { public: /// This enumeration lists the attributes that can be associated with - /// parameters, function results or the function itself. + /// parameters, function results, or the function itself. /// - /// Note: uwtable is about the ABI or the user mandating an entry in the - /// unwind table. The nounwind attribute is about an exception passing by the - /// function. + /// Note: The `uwtable' attribute is about the ABI or the user mandating an + /// entry in the unwind table. The `nounwind' attribute is about an exception + /// passing by the function. /// - /// In a theoretical system that uses tables for profiling and sjlj for + /// In a theoretical system that uses tables for profiling and SjLj for /// exceptions, they would be fully independent. In a normal system that uses /// tables for both, the semantics are: /// @@ -58,7 +63,6 @@ public: enum AttrKind { // IR-Level Attributes None, ///< No attributes have been set - AddressSafety, ///< Address safety checking is on. Alignment, ///< Alignment of parameter (5 bits) ///< stored as log2 of alignment with +1 bias ///< 0 means unaligned (different from align(1)) @@ -70,6 +74,7 @@ public: Naked, ///< Naked function Nest, ///< Nested function static chain NoAlias, ///< Considered to not alias after call + NoBuiltin, ///< Callee isn't recognized as a builtin NoCapture, ///< Function creates no aliases of pointer NoDuplicate, ///< Call cannot be duplicated NoImplicitFloat, ///< Disable implicit floating point insts @@ -90,14 +95,15 @@ public: ///< alignstack=(1)) StackProtect, ///< Stack protection. StackProtectReq, ///< Stack protection required. + StackProtectStrong, ///< Strong Stack protection. StructRet, ///< Hidden pointer to structure to return + SanitizeAddress, ///< AddressSanitizer is on. + SanitizeThread, ///< ThreadSanitizer is on. + SanitizeMemory, ///< MemorySanitizer is on. UWTable, ///< Function must be in a unwind table ZExt, ///< Zero extended before/after call - EndAttrKinds, ///< Sentinal value useful for loops - - AttrKindEmptyKey, ///< Empty key value for DenseMapInfo - AttrKindTombstoneKey ///< Tombstone key value for DenseMapInfo + EndAttrKinds ///< Sentinal value useful for loops }; private: AttributeImpl *pImpl; @@ -105,96 +111,88 @@ private: public: Attribute() : pImpl(0) {} - /// \brief Return a uniquified Attribute object. This takes the uniquified - /// value from the Builder and wraps it in the Attribute class. - static Attribute get(LLVMContext &Context, ArrayRef Vals); - static Attribute get(LLVMContext &Context, AttrBuilder &B); + //===--------------------------------------------------------------------===// + // Attribute Construction + //===--------------------------------------------------------------------===// - /// \brief Return true if the attribute is present. - bool hasAttribute(AttrKind Val) const; + /// \brief Return a uniquified Attribute object. + static Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val = 0); + static Attribute get(LLVMContext &Context, StringRef Kind, + StringRef Val = StringRef()); - /// \brief Return true if attributes exist - bool hasAttributes() const; + /// \brief Return a uniquified Attribute object that has the specific + /// alignment set. + static Attribute getWithAlignment(LLVMContext &Context, uint64_t Align); + static Attribute getWithStackAlignment(LLVMContext &Context, uint64_t Align); - /// \brief Returns the alignment field of an attribute as a byte alignment - /// value. - unsigned getAlignment() const; + //===--------------------------------------------------------------------===// + // Attribute Accessors + //===--------------------------------------------------------------------===// - /// \brief Set the alignment field of an attribute. - void setAlignment(unsigned Align); + /// \brief Return true if the attribute is an Attribute::AttrKind type. + bool isEnumAttribute() const; - /// \brief Returns the stack alignment field of an attribute as a byte - /// alignment value. - unsigned getStackAlignment() const; + /// \brief Return true if the attribute is an alignment attribute. + bool isAlignAttribute() const; - /// \brief Set the stack alignment field of an attribute. - void setStackAlignment(unsigned Align); + /// \brief Return true if the attribute is a string (target-dependent) + /// attribute. + bool isStringAttribute() const; - /// \brief Equality and non-equality query methods. - bool operator==(AttrKind K) const; - bool operator!=(AttrKind K) const; + /// \brief Return true if the attribute is present. + bool hasAttribute(AttrKind Val) const; - // FIXME: Remove these 'operator' methods. - bool operator==(const Attribute &A) const { - return pImpl == A.pImpl; - } - bool operator!=(const Attribute &A) const { - return pImpl != A.pImpl; - } + /// \brief Return true if the target-dependent attribute is present. + bool hasAttribute(StringRef Val) const; + + /// \brief Return the attribute's kind as an enum (Attribute::AttrKind). This + /// requires the attribute to be an enum or alignment attribute. + Attribute::AttrKind getKindAsEnum() const; - uint64_t Raw() const; + /// \brief Return the attribute's value as an integer. This requires that the + /// attribute be an alignment attribute. + uint64_t getValueAsInt() const; - /// \brief Which attributes cannot be applied to a type. - static Attribute typeIncompatible(Type *Ty); + /// \brief Return the attribute's kind as a string. This requires the + /// attribute to be a string attribute. + StringRef getKindAsString() const; - /// \brief This returns an integer containing an encoding of all the LLVM - /// attributes found in the given attribute bitset. Any change to this - /// encoding is a breaking change to bitcode compatibility. - static uint64_t encodeLLVMAttributesForBitcode(Attribute Attrs); + /// \brief Return the attribute's value as a string. This requires the + /// attribute to be a string attribute. + StringRef getValueAsString() const; - /// \brief This returns an attribute bitset containing the LLVM attributes - /// that have been decoded from the given integer. This function must stay in - /// sync with 'encodeLLVMAttributesForBitcode'. - static Attribute decodeLLVMAttributesForBitcode(LLVMContext &C, - uint64_t EncodedAttrs); + /// \brief Returns the alignment field of an attribute as a byte alignment + /// value. + unsigned getAlignment() const; + + /// \brief Returns the stack alignment field of an attribute as a byte + /// alignment value. + unsigned getStackAlignment() const; /// \brief The Attribute is converted to a string of equivalent mnemonic. This /// is, presumably, for writing out the mnemonics for the assembly writer. - std::string getAsString() const; -}; + std::string getAsString(bool InAttrGrp = false) const; -//===----------------------------------------------------------------------===// -/// \class -/// \brief Provide DenseMapInfo for Attribute::AttrKinds. This is used by -/// AttrBuilder. -template<> struct DenseMapInfo { - static inline Attribute::AttrKind getEmptyKey() { - return Attribute::AttrKindEmptyKey; - } - static inline Attribute::AttrKind getTombstoneKey() { - return Attribute::AttrKindTombstoneKey; - } - static unsigned getHashValue(const Attribute::AttrKind &Val) { - return Val * 37U; - } - static bool isEqual(const Attribute::AttrKind &LHS, - const Attribute::AttrKind &RHS) { - return LHS == RHS; - } -}; + /// \brief Equality and non-equality operators. + bool operator==(Attribute A) const { return pImpl == A.pImpl; } + bool operator!=(Attribute A) const { return pImpl != A.pImpl; } -//===----------------------------------------------------------------------===// -// AttributeSet Smart Pointer -//===----------------------------------------------------------------------===// + /// \brief Less-than operator. Useful for sorting the attributes list. + bool operator<(Attribute A) const; -class AttrBuilder; -class AttributeSetImpl; -struct AttributeWithIndex; + void Profile(FoldingSetNodeID &ID) const { + ID.AddPointer(pImpl); + } +}; //===----------------------------------------------------------------------===// /// \class -/// \brief This class manages the ref count for the opaque AttributeSetImpl -/// object and provides accessors for it. +/// \brief This class holds the attributes for a function, its return value, and +/// its parameters. You access the attributes for each of them via an index into +/// the AttributeSet object. The function attributes are at index +/// `AttributeSet::FunctionIndex', the return value is at index +/// `AttributeSet::ReturnIndex', and the attributes for the parameters start at +/// index `1'. class AttributeSet { public: enum AttrIndex { @@ -203,39 +201,40 @@ public: }; private: friend class AttrBuilder; + friend class AttributeSetImpl; + template friend struct DenseMapInfo; - /// \brief The attributes that we are managing. This can be null to represent + /// \brief The attributes that we are managing. This can be null to represent /// the empty attributes list. - AttributeSetImpl *AttrList; + AttributeSetImpl *pImpl; - /// \brief The attributes for the specified index are returned. Attributes - /// for the result are denoted with Idx = 0. - Attribute getAttributes(unsigned Idx) const; + /// \brief The attributes for the specified index are returned. + AttributeSetNode *getAttributes(unsigned Idx) const; - /// \brief Add the specified attribute at the specified index to this - /// attribute list. Since attribute lists are immutable, this returns the new - /// list. - AttributeSet addAttr(LLVMContext &C, unsigned Idx, Attribute Attrs) const; + /// \brief Create an AttributeSet with the specified parameters in it. + static AttributeSet get(LLVMContext &C, + ArrayRef > Attrs); + static AttributeSet get(LLVMContext &C, + ArrayRef > Attrs); - /// \brief Remove the specified attribute at the specified index from this - /// attribute list. Since attribute lists are immutable, this returns the new - /// list. - AttributeSet removeAttr(LLVMContext &C, unsigned Idx, Attribute Attrs) const; + static AttributeSet getImpl(LLVMContext &C, + ArrayRef > Attrs); - explicit AttributeSet(AttributeSetImpl *LI) : AttrList(LI) {} + + explicit AttributeSet(AttributeSetImpl *LI) : pImpl(LI) {} public: - AttributeSet() : AttrList(0) {} - AttributeSet(const AttributeSet &P) : AttrList(P.AttrList) {} - const AttributeSet &operator=(const AttributeSet &RHS); + AttributeSet() : pImpl(0) {} //===--------------------------------------------------------------------===// - // Attribute List Construction and Mutation + // AttributeSet Construction and Mutation //===--------------------------------------------------------------------===// /// \brief Return an AttributeSet with the specified parameters in it. - static AttributeSet get(LLVMContext &C, ArrayRef Attrs); + static AttributeSet get(LLVMContext &C, ArrayRef Attrs); static AttributeSet get(LLVMContext &C, unsigned Idx, - Attribute::AttrKind Kind); + ArrayRef Kind); static AttributeSet get(LLVMContext &C, unsigned Idx, AttrBuilder &B); /// \brief Add an attribute to the attribute set at the given index. Since @@ -243,23 +242,16 @@ public: AttributeSet addAttribute(LLVMContext &C, unsigned Idx, Attribute::AttrKind Attr) const; + /// \brief Add an attribute to the attribute set at the given index. Since + /// attribute sets are immutable, this returns a new set. + AttributeSet addAttribute(LLVMContext &C, unsigned Idx, + StringRef Kind) const; + /// \brief Add attributes to the attribute set at the given index. Since /// attribute sets are immutable, this returns a new set. AttributeSet addAttributes(LLVMContext &C, unsigned Idx, AttributeSet Attrs) const; - /// \brief Add return attributes to this attribute set. Since attribute sets - /// are immutable, this returns a new set. - AttributeSet addRetAttributes(LLVMContext &C, AttributeSet Attrs) const { - return addAttributes(C, ReturnIndex, Attrs); - } - - /// \brief Add function attributes to this attribute set. Since attribute sets - /// are immutable, this returns a new set. - AttributeSet addFnAttributes(LLVMContext &C, AttributeSet Attrs) const { - return addAttributes(C, FunctionIndex, Attrs); - } - /// \brief Remove the specified attribute at the specified index from this /// attribute list. Since attribute lists are immutable, this returns the new /// list. @@ -273,9 +265,12 @@ public: AttributeSet Attrs) const; //===--------------------------------------------------------------------===// - // Attribute List Accessors + // AttributeSet Accessors //===--------------------------------------------------------------------===// + /// \brief Retrieve the LLVM context. + LLVMContext &getContext() const; + /// \brief The attributes for the specified index are returned. AttributeSet getParamAttributes(unsigned Idx) const; @@ -285,51 +280,63 @@ public: /// \brief The function attributes are returned. AttributeSet getFnAttributes() const; - /// \brief Return the alignment for the specified function parameter. - unsigned getParamAlignment(unsigned Idx) const; - /// \brief Return true if the attribute exists at the given index. bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const; + /// \brief Return true if the attribute exists at the given index. + bool hasAttribute(unsigned Index, StringRef Kind) const; + /// \brief Return true if attribute exists at the given index. bool hasAttributes(unsigned Index) const; + /// \brief Return true if the specified attribute is set for at least one + /// parameter or for the return value. + bool hasAttrSomewhere(Attribute::AttrKind Attr) const; + + /// \brief Return the attribute object that exists at the given index. + Attribute getAttribute(unsigned Index, Attribute::AttrKind Kind) const; + + /// \brief Return the attribute object that exists at the given index. + Attribute getAttribute(unsigned Index, StringRef Kind) const; + + /// \brief Return the alignment for the specified function parameter. + unsigned getParamAlignment(unsigned Idx) const; + /// \brief Get the stack alignment. unsigned getStackAlignment(unsigned Index) const; /// \brief Return the attributes at the index as a string. - std::string getAsString(unsigned Index) const; + std::string getAsString(unsigned Index, bool TargetIndependent = false, + bool InAttrGrp = false) const; - uint64_t Raw(unsigned Index) const; + typedef ArrayRef::iterator iterator; - /// \brief Return true if the specified attribute is set for at least one - /// parameter or for the return value. - bool hasAttrSomewhere(Attribute::AttrKind Attr) const; + iterator begin(unsigned Idx) const; + iterator end(unsigned Idx) const; /// operator==/!= - Provide equality predicates. bool operator==(const AttributeSet &RHS) const { - return AttrList == RHS.AttrList; + return pImpl == RHS.pImpl; } bool operator!=(const AttributeSet &RHS) const { - return AttrList != RHS.AttrList; + return pImpl != RHS.pImpl; } //===--------------------------------------------------------------------===// - // Attribute List Introspection + // AttributeSet Introspection //===--------------------------------------------------------------------===// + // FIXME: Remove this. + uint64_t Raw(unsigned Index) const; + /// \brief Return a raw pointer that uniquely identifies this attribute list. void *getRawPointer() const { - return AttrList; + return pImpl; } - // Attributes are stored as a dense set of slots, where there is one slot for - // each argument that has an attribute. This allows walking over the dense - // set instead of walking the sparse list of attributes. - /// \brief Return true if there are no attributes. bool isEmpty() const { - return AttrList == 0; + return getNumSlots() == 0; } /// \brief Return the number of slots used in this attribute list. This is @@ -337,44 +344,34 @@ public: /// function itself). unsigned getNumSlots() const; - /// \brief Return the AttributeWithIndex at the specified slot. This holds a - /// index number plus a set of attributes. - const AttributeWithIndex &getSlot(unsigned Slot) const; + /// \brief Return the index for the given slot. + uint64_t getSlotIndex(unsigned Slot) const; + + /// \brief Return the attributes at the given slot. + AttributeSet getSlotAttributes(unsigned Slot) const; void dump() const; }; //===----------------------------------------------------------------------===// /// \class -/// \brief This is just a pair of values to associate a set of attributes with -/// an index. -struct AttributeWithIndex { - Attribute Attrs; ///< The attributes that are set, or'd together. - Constant *Val; ///< Value attached to attribute, e.g. alignment. - unsigned Index; ///< Index of the parameter for which the attributes apply. - ///< Index 0 is used for return value attributes. - ///< Index ~0U is used for function attributes. - - // FIXME: These methods all need to be revised. The first one is temporary. - static AttributeWithIndex get(LLVMContext &C, unsigned Idx, AttributeSet AS); - static AttributeWithIndex get(LLVMContext &C, unsigned Idx, - ArrayRef Attrs) { - return get(Idx, Attribute::get(C, Attrs)); +/// \brief Provide DenseMapInfo for AttributeSet. +template<> struct DenseMapInfo { + static inline AttributeSet getEmptyKey() { + uintptr_t Val = static_cast(-1); + Val <<= PointerLikeTypeTraits::NumLowBitsAvailable; + return AttributeSet(reinterpret_cast(Val)); } - static AttributeWithIndex get(unsigned Idx, Attribute Attrs) { - AttributeWithIndex P; - P.Index = Idx; - P.Attrs = Attrs; - P.Val = 0; - return P; + static inline AttributeSet getTombstoneKey() { + uintptr_t Val = static_cast(-2); + Val <<= PointerLikeTypeTraits::NumLowBitsAvailable; + return AttributeSet(reinterpret_cast(Val)); } - static AttributeWithIndex get(unsigned Idx, Attribute Attrs, Constant *Val) { - AttributeWithIndex P; - P.Index = Idx; - P.Attrs = Attrs; - P.Val = Val; - return P; + static unsigned getHashValue(AttributeSet AS) { + return (unsigned((uintptr_t)AS.pImpl) >> 4) ^ + (unsigned((uintptr_t)AS.pImpl) >> 9); } + static bool isEqual(AttributeSet LHS, AttributeSet RHS) { return LHS == RHS; } }; //===----------------------------------------------------------------------===// @@ -384,42 +381,64 @@ struct AttributeWithIndex { /// value, however, is not. So this can be used as a quick way to test for /// equality, presence of attributes, etc. class AttrBuilder { - DenseSet Attrs; + std::bitset Attrs; + std::map TargetDepAttrs; uint64_t Alignment; uint64_t StackAlignment; public: - AttrBuilder() : Alignment(0), StackAlignment(0) {} - explicit AttrBuilder(uint64_t B) : Alignment(0), StackAlignment(0) { - addRawValue(B); + AttrBuilder() : Attrs(0), Alignment(0), StackAlignment(0) {} + explicit AttrBuilder(uint64_t Val) + : Attrs(0), Alignment(0), StackAlignment(0) { + addRawValue(Val); } - AttrBuilder(const Attribute &A) : Alignment(0), StackAlignment(0) { - addAttributes(A); + AttrBuilder(const Attribute &A) : Attrs(0), Alignment(0), StackAlignment(0) { + addAttribute(A); } AttrBuilder(AttributeSet AS, unsigned Idx); + AttrBuilder(const AttrBuilder &B) + : Attrs(B.Attrs), + TargetDepAttrs(B.TargetDepAttrs.begin(), B.TargetDepAttrs.end()), + Alignment(B.Alignment), StackAlignment(B.StackAlignment) {} void clear(); /// \brief Add an attribute to the builder. AttrBuilder &addAttribute(Attribute::AttrKind Val); + /// \brief Add the Attribute object to the builder. + AttrBuilder &addAttribute(Attribute A); + + /// \brief Add the target-dependent attribute to the builder. + AttrBuilder &addAttribute(StringRef A, StringRef V = StringRef()); + /// \brief Remove an attribute from the builder. AttrBuilder &removeAttribute(Attribute::AttrKind Val); - /// \brief Add the attributes from A to the builder. - AttrBuilder &addAttributes(const Attribute &A); + /// \brief Remove the attributes from the builder. + AttrBuilder &removeAttributes(AttributeSet A, uint64_t Index); + + /// \brief Remove the target-dependent attribute to the builder. + AttrBuilder &removeAttribute(StringRef A); - /// \brief Remove the attributes from A from the builder. - AttrBuilder &removeAttributes(const Attribute &A); + /// \brief Add the attributes from the builder. + AttrBuilder &merge(const AttrBuilder &B); /// \brief Return true if the builder has the specified attribute. - bool contains(Attribute::AttrKind A) const; + bool contains(Attribute::AttrKind A) const { + assert((unsigned)A < Attribute::EndAttrKinds && "Attribute out of range!"); + return Attrs[A]; + } + + /// \brief Return true if the builder has the specified target-dependent + /// attribute. + bool contains(StringRef A) const; /// \brief Return true if the builder has IR-level attributes. bool hasAttributes() const; /// \brief Return true if the builder has any attribute that's in the /// specified attribute. - bool hasAttributes(const Attribute &A) const; + bool hasAttributes(AttributeSet A, uint64_t Index) const; /// \brief Return true if the builder has an alignment attribute. bool hasAlignmentAttr() const; @@ -438,52 +457,44 @@ public: /// the form used internally in Attribute. AttrBuilder &addStackAlignmentAttr(unsigned Align); - typedef DenseSet::iterator iterator; - typedef DenseSet::const_iterator const_iterator; + /// \brief Return true if the builder contains no target-independent + /// attributes. + bool empty() const { return Attrs.none(); } - iterator begin() { return Attrs.begin(); } - iterator end() { return Attrs.end(); } + // Iterators for target-dependent attributes. + typedef std::pair td_type; + typedef std::map::iterator td_iterator; + typedef std::map::const_iterator td_const_iterator; - const_iterator begin() const { return Attrs.begin(); } - const_iterator end() const { return Attrs.end(); } + td_iterator td_begin() { return TargetDepAttrs.begin(); } + td_iterator td_end() { return TargetDepAttrs.end(); } - /// \brief Add the raw value to the internal representation. - /// - /// N.B. This should be used ONLY for decoding LLVM bitcode! - AttrBuilder &addRawValue(uint64_t Val); + td_const_iterator td_begin() const { return TargetDepAttrs.begin(); } + td_const_iterator td_end() const { return TargetDepAttrs.end(); } - /// \brief Remove attributes that are used on functions only. - void removeFunctionOnlyAttrs() { - removeAttribute(Attribute::NoReturn) - .removeAttribute(Attribute::NoUnwind) - .removeAttribute(Attribute::ReadNone) - .removeAttribute(Attribute::ReadOnly) - .removeAttribute(Attribute::NoInline) - .removeAttribute(Attribute::AlwaysInline) - .removeAttribute(Attribute::OptimizeForSize) - .removeAttribute(Attribute::StackProtect) - .removeAttribute(Attribute::StackProtectReq) - .removeAttribute(Attribute::NoRedZone) - .removeAttribute(Attribute::NoImplicitFloat) - .removeAttribute(Attribute::Naked) - .removeAttribute(Attribute::InlineHint) - .removeAttribute(Attribute::StackAlignment) - .removeAttribute(Attribute::UWTable) - .removeAttribute(Attribute::NonLazyBind) - .removeAttribute(Attribute::ReturnsTwice) - .removeAttribute(Attribute::AddressSafety) - .removeAttribute(Attribute::MinSize) - .removeAttribute(Attribute::NoDuplicate); - } + bool td_empty() const { return TargetDepAttrs.empty(); } - uint64_t Raw() const; + /// \brief Remove attributes that are used on functions only. + void removeFunctionOnlyAttrs(); bool operator==(const AttrBuilder &B); bool operator!=(const AttrBuilder &B) { return !(*this == B); } + + // FIXME: Remove this in 4.0. + + /// \brief Add the raw value to the internal representation. + AttrBuilder &addRawValue(uint64_t Val); }; +namespace AttributeFuncs { + +/// \brief Which attributes cannot be applied to a type. +AttributeSet typeIncompatible(Type *Ty, uint64_t Index); + +} // end AttributeFuncs namespace + } // end llvm namespace #endif