X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FAttributes.h;h=2a0fbc0ee13fe74d3365d7c070794b02b9cf0e16;hb=15c3789763e82b7c781ea1ebcae24de826259b75;hp=c9589603f9a52083888a7e922194ead84a837131;hpb=6eec6ffb9b4ffed8aa07f051fd35466c424a3d8c;p=oota-llvm.git diff --git a/include/llvm/Attributes.h b/include/llvm/Attributes.h index c9589603f9a..2a0fbc0ee13 100644 --- a/include/llvm/Attributes.h +++ b/include/llvm/Attributes.h @@ -15,6 +15,7 @@ #ifndef LLVM_ATTRIBUTES_H #define LLVM_ATTRIBUTES_H +#include "llvm/AttributesImpl.h" #include "llvm/Support/MathExtras.h" #include "llvm/ADT/ArrayRef.h" #include @@ -27,8 +28,8 @@ class Type; namespace Attribute { -/// We use this proxy POD type to allow constructing Attributes constants using -/// initializer lists. Do not use this class directly. +/// AttrConst - We use this proxy POD type to allow constructing Attributes +/// constants using initializer lists. Do not use this class directly. struct AttrConst { uint64_t v; AttrConst operator | (const AttrConst Attrs) const { @@ -121,9 +122,6 @@ const AttrConst FunctionOnly = {NoReturn_i | NoUnwind_i | ReadNone_i | Naked_i | InlineHint_i | StackAlignment_i | UWTable_i | NonLazyBind_i | ReturnsTwice_i | AddressSafety_i}; -/// @brief Parameter attributes that do not apply to vararg call arguments. -const AttrConst VarArgsIncompatible = {StructRet_i}; - /// @brief Attributes that are mutually incompatible. const AttrConst MutuallyIncompatible[5] = { {ByVal_i | Nest_i | StructRet_i}, @@ -141,255 +139,128 @@ class AttributesImpl; /// Attributes - A bitset of attributes. class Attributes { - // Currently, we need less than 64 bits. - uint64_t Bits; +public: + enum AttrVal { + None = 0, ///< No attributes have been set + ZExt = 1, ///< Zero extended before/after call + SExt = 2, ///< Sign extended before/after call + NoReturn = 3, ///< Mark the function as not returning + InReg = 4, ///< Force argument to be passed in register + StructRet = 5, ///< Hidden pointer to structure to return + NoUnwind = 6, ///< Function doesn't unwind stack + NoAlias = 7, ///< Considered to not alias after call + ByVal = 8, ///< Pass structure by value + Nest = 9, ///< Nested function static chain + ReadNone = 10, ///< Function does not access memory + ReadOnly = 11, ///< Function only reads from memory + NoInline = 12, ///< inline=never + AlwaysInline = 13, ///< inline=always + OptimizeForSize = 14, ///< opt_size + StackProtect = 15, ///< Stack protection. + StackProtectReq = 16, ///< Stack protection required. + Alignment = 17, ///< Alignment of parameter (5 bits) + ///< stored as log2 of alignment with +1 bias + ///< 0 means unaligned different from align 1 + NoCapture = 18, ///< Function creates no aliases of pointer + NoRedZone = 19, ///< Disable redzone + NoImplicitFloat = 20, ///< Disable implicit floating point insts + Naked = 21, ///< Naked function + InlineHint = 22, ///< Source said inlining was desirable + StackAlignment = 23, ///< Alignment of stack for function (3 bits) + ///< stored as log2 of alignment with +1 bias 0 + ///< means unaligned (different from + ///< alignstack={1)) + ReturnsTwice = 24, ///< Function can return twice + UWTable = 25, ///< Function must be in a unwind table + NonLazyBind = 26, ///< Function is called early and/or + ///< often, so lazy binding isn't worthwhile + AddressSafety = 27 ///< Address safety checking is on. + }; +private: + AttributesImpl Attrs; explicit Attributes(AttributesImpl *A); public: - Attributes() : Bits(0) {} - explicit Attributes(uint64_t Val) : Bits(Val) {} - /*implicit*/ Attributes(Attribute::AttrConst Val) : Bits(Val.v) {} + Attributes() : Attrs(0) {} + explicit Attributes(uint64_t Val); + /*implicit*/ Attributes(Attribute::AttrConst Val); + Attributes(const Attributes &A); class Builder { friend class Attributes; uint64_t Bits; public: Builder() : Bits(0) {} - Builder(const Attributes &A) : Bits(A.Bits) {} - - void addZExtAttr() { - Bits |= Attribute::ZExt_i; - } - void addSExtAttr() { - Bits |= Attribute::SExt_i; - } - void addNoReturnAttr() { - Bits |= Attribute::NoReturn_i; - } - void addInRegAttr() { - Bits |= Attribute::InReg_i; - } - void addStructRetAttr() { - Bits |= Attribute::StructRet_i; - } - void addNoUnwindAttr() { - Bits |= Attribute::NoUnwind_i; - } - void addNoAliasAttr() { - Bits |= Attribute::NoAlias_i; - } - void addByValAttr() { - Bits |= Attribute::ByVal_i; - } - void addNestAttr() { - Bits |= Attribute::Nest_i; - } - void addReadNoneAttr() { - Bits |= Attribute::ReadNone_i; - } - void addReadOnlyAttr() { - Bits |= Attribute::ReadOnly_i; - } - void addNoInlineAttr() { - Bits |= Attribute::NoInline_i; - } - void addAlwaysInlineAttr() { - Bits |= Attribute::AlwaysInline_i; - } - void addOptimizeForSizeAttr() { - Bits |= Attribute::OptimizeForSize_i; - } - void addStackProtectAttr() { - Bits |= Attribute::StackProtect_i; - } - void addStackProtectReqAttr() { - Bits |= Attribute::StackProtectReq_i; - } - void addNoCaptureAttr() { - Bits |= Attribute::NoCapture_i; - } - void addNoRedZoneAttr() { - Bits |= Attribute::NoRedZone_i; - } - void addNoImplicitFloatAttr() { - Bits |= Attribute::NoImplicitFloat_i; - } - void addNakedAttr() { - Bits |= Attribute::Naked_i; - } - void addInlineHintAttr() { - Bits |= Attribute::InlineHint_i; - } - void addReturnsTwiceAttr() { - Bits |= Attribute::ReturnsTwice_i; - } - void addUWTableAttr() { - Bits |= Attribute::UWTable_i; - } - void addNonLazyBindAttr() { - Bits |= Attribute::NonLazyBind_i; - } - void addAddressSafetyAttr() { - Bits |= Attribute::AddressSafety_i; - } - void addAlignmentAttr(unsigned Align) { - if (Align == 0) return; - assert(isPowerOf2_32(Align) && "Alignment must be a power of two."); - assert(Align <= 0x40000000 && "Alignment too large."); - Bits |= (Log2_32(Align) + 1) << 16; - } - void addStackAlignmentAttr(unsigned Align) { - // Default alignment, allow the target to define how to align it. - if (Align == 0) return; - - assert(isPowerOf2_32(Align) && "Alignment must be a power of two."); - assert(Align <= 0x100 && "Alignment too large."); - Bits |= (Log2_32(Align) + 1) << 26; - } + Builder(const Attributes &A) : Bits(A.Raw()) {} + + void clear() { Bits = 0; } + + bool hasAttributes() const; + bool hasAttributes(const Attributes &A) const; + bool hasAlignmentAttr() const; + + uint64_t getAlignment() const; + + void addAttribute(Attributes::AttrVal Val); + void removeAttribute(Attributes::AttrVal Val); + + void addAlignmentAttr(unsigned Align); + void addStackAlignmentAttr(unsigned Align); + + void removeAttributes(const Attributes &A); }; /// get - Return a uniquified Attributes object. This takes the uniquified /// value from the Builder and wraps it in the Attributes class. + static Attributes get(Builder &B); static Attributes get(LLVMContext &Context, Builder &B); - // Attribute query methods. - // FIXME: StackAlignment & Alignment attributes have no predicate methods. - bool hasAttributes() const { - return Bits != 0; - } - bool hasAttributes(const Attributes &A) const { - return Bits & A.Bits; + /// @brief Parameter attributes that do not apply to vararg call arguments. + bool hasIncompatibleWithVarArgsAttrs() const { + return hasAttribute(Attributes::StructRet); } - bool hasZExtAttr() const { - return Bits & Attribute::ZExt_i; - } - bool hasSExtAttr() const { - return Bits & Attribute::SExt_i; - } - bool hasNoReturnAttr() const { - return Bits & Attribute::NoReturn_i; - } - bool hasInRegAttr() const { - return Bits & Attribute::InReg_i; - } - bool hasStructRetAttr() const { - return Bits & Attribute::StructRet_i; - } - bool hasNoUnwindAttr() const { - return Bits & Attribute::NoUnwind_i; - } - bool hasNoAliasAttr() const { - return Bits & Attribute::NoAlias_i; - } - bool hasByValAttr() const { - return Bits & Attribute::ByVal_i; - } - bool hasNestAttr() const { - return Bits & Attribute::Nest_i; - } - bool hasReadNoneAttr() const { - return Bits & Attribute::ReadNone_i; - } - bool hasReadOnlyAttr() const { - return Bits & Attribute::ReadOnly_i; - } - bool hasNoInlineAttr() const { - return Bits & Attribute::NoInline_i; - } - bool hasAlwaysInlineAttr() const { - return Bits & Attribute::AlwaysInline_i; - } - bool hasOptimizeForSizeAttr() const { - return Bits & Attribute::OptimizeForSize_i; - } - bool hasStackProtectAttr() const { - return Bits & Attribute::StackProtect_i; - } - bool hasStackProtectReqAttr() const { - return Bits & Attribute::StackProtectReq_i; - } - bool hasAlignmentAttr() const { - return Bits & Attribute::Alignment_i; - } - bool hasNoCaptureAttr() const { - return Bits & Attribute::NoCapture_i; - } - bool hasNoRedZoneAttr() const { - return Bits & Attribute::NoRedZone_i; - } - bool hasNoImplicitFloatAttr() const { - return Bits & Attribute::NoImplicitFloat_i; - } - bool hasNakedAttr() const { - return Bits & Attribute::Naked_i; - } - bool hasInlineHintAttr() const { - return Bits & Attribute::InlineHint_i; - } - bool hasReturnsTwiceAttr() const { - return Bits & Attribute::ReturnsTwice_i; - } - bool hasStackAlignmentAttr() const { - return Bits & Attribute::StackAlignment_i; - } - bool hasUWTableAttr() const { - return Bits & Attribute::UWTable_i; - } - bool hasNonLazyBindAttr() const { - return Bits & Attribute::NonLazyBind_i; - } - bool hasAddressSafetyAttr() const { - return Bits & Attribute::AddressSafety_i; + /// @brief Return true if the attribute is present. + bool hasAttribute(AttrVal Val) const; + + /// @brief Return true if attributes exist + bool hasAttributes() const { + return Attrs.hasAttributes(); } + /// @brief Return true if the attributes are a non-null intersection. + bool hasAttributes(const Attributes &A) const; + /// This returns the alignment field of an attribute as a byte alignment /// value. - unsigned getAlignment() const { - if (!hasAlignmentAttr()) - return 0; - return 1U << (((Bits & Attribute::Alignment_i) >> 16) - 1); - } + unsigned getAlignment() const; /// This returns the stack alignment field of an attribute as a byte alignment /// value. - unsigned getStackAlignment() const { - if (!hasStackAlignmentAttr()) - return 0; - return 1U << (((Bits & Attribute::StackAlignment_i) >> 26) - 1); - } + unsigned getStackAlignment() const; + + bool isEmptyOrSingleton() const; // This is a "safe bool() operator". - operator const void *() const { return Bits ? this : 0; } - bool isEmptyOrSingleton() const { return (Bits & (Bits - 1)) == 0; } - bool operator == (const Attributes &Attrs) const { - return Bits == Attrs.Bits; - } - bool operator != (const Attributes &Attrs) const { - return Bits != Attrs.Bits; - } - Attributes operator | (const Attributes &Attrs) const { - return Attributes(Bits | Attrs.Bits); - } - Attributes operator & (const Attributes &Attrs) const { - return Attributes(Bits & Attrs.Bits); - } - Attributes operator ^ (const Attributes &Attrs) const { - return Attributes(Bits ^ Attrs.Bits); - } - Attributes &operator |= (const Attributes &Attrs) { - Bits |= Attrs.Bits; - return *this; + operator const void *() const { return Attrs.Bits ? this : 0; } + bool operator == (const Attributes &A) const { + return Attrs.Bits == A.Attrs.Bits; } - Attributes &operator &= (const Attributes &Attrs) { - Bits &= Attrs.Bits; - return *this; + bool operator != (const Attributes &A) const { + return Attrs.Bits != A.Attrs.Bits; } - Attributes operator ~ () const { return Attributes(~Bits); } - uint64_t Raw() const { return Bits; } - /// This turns an int alignment (a power of 2, normally) into the form used - /// internally in Attributes. + Attributes operator | (const Attributes &A) const; + Attributes operator & (const Attributes &A) const; + Attributes operator ^ (const Attributes &A) const; + Attributes &operator |= (const Attributes &A); + Attributes &operator &= (const Attributes &A); + Attributes operator ~ () const; + + uint64_t Raw() const; + + /// constructAlignmentFromInt - This turns an int alignment (a power of 2, + /// normally) into the form used internally in Attributes. static Attributes constructAlignmentFromInt(unsigned i) { // Default alignment, allow the target to define how to align it. if (i == 0) @@ -400,8 +271,8 @@ public: return Attributes((Log2_32(i)+1) << 16); } - /// This turns an int stack alignment (which must be a power of 2) into the - /// form used internally in Attributes. + /// constructStackAlignmentFromInt - This turns an int stack alignment (which + /// must be a power of 2) into the form used internally in Attributes. static Attributes constructStackAlignmentFromInt(unsigned i) { // Default alignment, allow the target to define how to align it. if (i == 0) @@ -415,9 +286,9 @@ public: /// @brief Which attributes cannot be applied to a type. static Attributes typeIncompatible(Type *Ty); - /// 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. + /// encodeLLVMAttributesForBitcode - 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(Attributes Attrs) { // FIXME: It doesn't make sense to store the alignment information as an // expanded out value, we should store it as a log2 value. However, we @@ -430,15 +301,16 @@ public: // 5-bit log2 encoded value. Shift the bits above the alignment up by 11 // bits. uint64_t EncodedAttrs = Attrs.Raw() & 0xffff; - if (Attrs.hasAlignmentAttr()) + if (Attrs.hasAttribute(Attributes::Alignment)) EncodedAttrs |= (1ULL << 16) << - (((Attrs.Bits & Attribute::Alignment_i) - 1) >> 16); + (((Attrs.Raw() & Attribute::Alignment_i) - 1) >> 16); EncodedAttrs |= (Attrs.Raw() & (0xfffULL << 21)) << 11; return EncodedAttrs; } - /// This returns an attribute bitset containing the LLVM attributes that have - /// been decoded from the given integer. This function must stay in sync with + /// decodeLLVMAttributesForBitcode - 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 Attributes decodeLLVMAttributesForBitcode(uint64_t EncodedAttrs) { // The alignment is stored as a 16-bit raw value from bits 31--16. We shift @@ -454,15 +326,19 @@ public: return Attrs; } - /// The set of Attributes set in Attributes is converted to a string of - /// equivalent mnemonics. This is, presumably, for writing out the mnemonics - /// for the assembly writer. + /// getAsString - The set of Attributes set in Attributes is converted to a + /// string of equivalent mnemonics. This is, presumably, for writing out the + /// mnemonics for the assembly writer. /// @brief Convert attribute bits to text std::string getAsString() const; }; -/// This is just a pair of values to associate a set of attributes -/// with an index. +//===----------------------------------------------------------------------===// +// AttributeWithIndex +//===----------------------------------------------------------------------===// + +/// AttributeWithIndex - This is just a pair of values to associate a set of +/// attributes with an index. struct AttributeWithIndex { Attributes Attrs; ///< The attributes that are set, or'd together. unsigned Index; ///< Index of the parameter for which the attributes apply. @@ -518,7 +394,6 @@ public: /// getParamAttributes - The attributes for the specified index are /// returned. Attributes getParamAttributes(unsigned Idx) const { - assert (Idx && Idx != ~0U && "Invalid parameter index!"); return getAttributes(Idx); } @@ -549,6 +424,9 @@ public: /// least one parameter or for the return value. bool hasAttrSomewhere(Attributes Attr) const; + unsigned getNumAttrs() const; + Attributes &getAttributesAtIndex(unsigned i) const; + /// operator==/!= - Provide equality predicates. bool operator==(const AttrListPtr &RHS) const { return AttrList == RHS.AttrList; } @@ -592,7 +470,6 @@ private: /// getAttributes - The attributes for the specified index are /// returned. Attributes for the result are denoted with Idx = 0. Attributes getAttributes(unsigned Idx) const; - }; } // End llvm namespace