X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FAttributes.h;h=e0b6a507bc42a9000b3f4b25c5a5ecd300fcf712;hb=8b8fa7b2f403ae2f342413239c4151e075022c97;hp=86a963419e5d25049983438f99a0af5661f26bee;hpb=943c29135e03e55f9a5dab393786171a4a536482;p=oota-llvm.git diff --git a/include/llvm/Attributes.h b/include/llvm/Attributes.h index 86a963419e5..e0b6a507bc4 100644 --- a/include/llvm/Attributes.h +++ b/include/llvm/Attributes.h @@ -26,109 +26,6 @@ namespace llvm { class LLVMContext; class Type; -namespace Attribute { - -/// 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 { - AttrConst Res = {v | Attrs.v}; - return Res; - } - AttrConst operator ~ () const { - AttrConst Res = {~v}; - return Res; - } -}; - -/// Function parameters and results can have attributes to indicate how they -/// should be treated by optimizations and code generation. This enumeration -/// lists the attributes that can be associated with parameters, function -/// results or the function itself. -/// @brief Function attributes. - -/// We declare AttrConst objects that will be used throughout the code and also -/// raw uint64_t objects with _i suffix to be used below for other constant -/// declarations. This is done to avoid static CTORs and at the same time to -/// keep type-safety of Attributes. -#define DECLARE_LLVM_ATTRIBUTE(name, value) \ - const uint64_t name##_i = value; \ - const AttrConst name = {value}; - -DECLARE_LLVM_ATTRIBUTE(None,0) ///< No attributes have been set -DECLARE_LLVM_ATTRIBUTE(ZExt,1<<0) ///< Zero extended before/after call -DECLARE_LLVM_ATTRIBUTE(SExt,1<<1) ///< Sign extended before/after call -DECLARE_LLVM_ATTRIBUTE(NoReturn,1<<2) ///< Mark the function as not returning -DECLARE_LLVM_ATTRIBUTE(InReg,1<<3) ///< Force argument to be passed in register -DECLARE_LLVM_ATTRIBUTE(StructRet,1<<4) ///< Hidden pointer to structure to return -DECLARE_LLVM_ATTRIBUTE(NoUnwind,1<<5) ///< Function doesn't unwind stack -DECLARE_LLVM_ATTRIBUTE(NoAlias,1<<6) ///< Considered to not alias after call -DECLARE_LLVM_ATTRIBUTE(ByVal,1<<7) ///< Pass structure by value -DECLARE_LLVM_ATTRIBUTE(Nest,1<<8) ///< Nested function static chain -DECLARE_LLVM_ATTRIBUTE(ReadNone,1<<9) ///< Function does not access memory -DECLARE_LLVM_ATTRIBUTE(ReadOnly,1<<10) ///< Function only reads from memory -DECLARE_LLVM_ATTRIBUTE(NoInline,1<<11) ///< inline=never -DECLARE_LLVM_ATTRIBUTE(AlwaysInline,1<<12) ///< inline=always -DECLARE_LLVM_ATTRIBUTE(OptimizeForSize,1<<13) ///< opt_size -DECLARE_LLVM_ATTRIBUTE(StackProtect,1<<14) ///< Stack protection. -DECLARE_LLVM_ATTRIBUTE(StackProtectReq,1<<15) ///< Stack protection required. -DECLARE_LLVM_ATTRIBUTE(Alignment,31<<16) ///< Alignment of parameter (5 bits) - // stored as log2 of alignment with +1 bias - // 0 means unaligned different from align 1 -DECLARE_LLVM_ATTRIBUTE(NoCapture,1<<21) ///< Function creates no aliases of pointer -DECLARE_LLVM_ATTRIBUTE(NoRedZone,1<<22) /// disable redzone -DECLARE_LLVM_ATTRIBUTE(NoImplicitFloat,1<<23) /// disable implicit floating point - /// instructions. -DECLARE_LLVM_ATTRIBUTE(Naked,1<<24) ///< Naked function -DECLARE_LLVM_ATTRIBUTE(InlineHint,1<<25) ///< source said inlining was - ///desirable -DECLARE_LLVM_ATTRIBUTE(StackAlignment,7<<26) ///< Alignment of stack for - ///function (3 bits) stored as log2 - ///of alignment with +1 bias - ///0 means unaligned (different from - ///alignstack= {1)) -DECLARE_LLVM_ATTRIBUTE(ReturnsTwice,1<<29) ///< Function can return twice -DECLARE_LLVM_ATTRIBUTE(UWTable,1<<30) ///< Function must be in a unwind - ///table -DECLARE_LLVM_ATTRIBUTE(NonLazyBind,1U<<31) ///< Function is called early and/or - /// often, so lazy binding isn't - /// worthwhile. -DECLARE_LLVM_ATTRIBUTE(AddressSafety,1ULL<<32) ///< Address safety checking is on. - -#undef DECLARE_LLVM_ATTRIBUTE - -/// Note that 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. -/// 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: -/// nil = Needs an entry because an exception might pass by. -/// nounwind = No need for an entry -/// uwtable = Needs an entry because the ABI says so and because -/// an exception might pass by. -/// uwtable + nounwind = Needs an entry because the ABI says so. - -/// @brief Attributes that may be applied to the function itself. These cannot -/// be used on return values or function parameters. -const AttrConst FunctionOnly = {NoReturn_i | NoUnwind_i | ReadNone_i | - ReadOnly_i | NoInline_i | AlwaysInline_i | OptimizeForSize_i | - StackProtect_i | StackProtectReq_i | NoRedZone_i | NoImplicitFloat_i | - Naked_i | InlineHint_i | StackAlignment_i | - UWTable_i | NonLazyBind_i | ReturnsTwice_i | AddressSafety_i}; - -/// @brief Attributes that are mutually incompatible. -const AttrConst MutuallyIncompatible[5] = { - {ByVal_i | Nest_i | StructRet_i}, - {ByVal_i | Nest_i | InReg_i }, - {ZExt_i | SExt_i}, - {ReadNone_i | ReadOnly_i}, - {NoInline_i | AlwaysInline_i} -}; - -} // namespace Attribute - /// AttributeImpl - The internal representation of the Attributes class. This is /// uniquified. class AttributesImpl; @@ -136,41 +33,60 @@ class AttributesImpl; /// Attributes - A bitset of attributes. class Attributes { public: + /// Function parameters and results can have attributes to indicate how they + /// should be treated by optimizations and code generation. This enumeration + /// lists the attributes that can be associated with parameters, function + /// results or the function itself. + /// + /// Note that 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. + /// + /// 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: + /// + /// nil = Needs an entry because an exception might pass by. + /// nounwind = No need for an entry + /// uwtable = Needs an entry because the ABI says so and because + /// an exception might pass by. + /// uwtable + nounwind = Needs an entry because the ABI says so. + 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) + AddressSafety = 1, ///< Address safety checking is on. + Alignment = 2, ///< 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) + AlwaysInline = 3, ///< inline=always + ByVal = 4, ///< Pass structure by value + InlineHint = 5, ///< Source said inlining was desirable + InReg = 6, ///< Force argument to be passed in register + Naked = 7, ///< Naked function + Nest = 8, ///< Nested function static chain + NoAlias = 9, ///< Considered to not alias after call + NoCapture = 10, ///< Function creates no aliases of pointer + NoImplicitFloat = 11, ///< Disable implicit floating point insts + NoInline = 12, ///< inline=never + NonLazyBind = 13, ///< Function is called early and/or + ///< often, so lazy binding isn't worthwhile + NoRedZone = 14, ///< Disable redzone + NoReturn = 15, ///< Mark the function as not returning + NoUnwind = 16, ///< Function doesn't unwind stack + OptimizeForSize = 17, ///< opt_size + ReadNone = 18, ///< Function does not access memory + ReadOnly = 19, ///< Function only reads from memory + ReturnsTwice = 20, ///< Function can return twice + SExt = 21, ///< Sign extended before/after call + StackAlignment = 22, ///< 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. + StackProtect = 23, ///< Stack protection. + StackProtectReq = 24, ///< Stack protection required. + StructRet = 25, ///< Hidden pointer to structure to return + UWTable = 26, ///< Function must be in a unwind table + ZExt = 27 ///< Zero extended before/after call }; private: AttributesImpl Attrs; @@ -179,7 +95,7 @@ private: public: Attributes() : Attrs(0) {} explicit Attributes(uint64_t Val); - /*implicit*/ Attributes(Attribute::AttrConst Val); + explicit Attributes(LLVMContext &C, AttrVal Val); Attributes(const Attributes &A); class Builder { @@ -191,19 +107,43 @@ public: void clear() { Bits = 0; } + bool hasAttribute(Attributes::AttrVal A) const; bool hasAttributes() const; bool hasAttributes(const Attributes &A) const; bool hasAlignmentAttr() const; uint64_t getAlignment() const; + uint64_t getStackAlignment() const; - void addAttribute(Attributes::AttrVal Val); - void removeAttribute(Attributes::AttrVal Val); + Builder &addAttribute(Attributes::AttrVal Val); + Builder &removeAttribute(Attributes::AttrVal Val); void addAlignmentAttr(unsigned Align); void addStackAlignmentAttr(unsigned Align); void removeAttributes(const Attributes &A); + + /// @brief Remove attributes that are used on functions only. + void removeFunctionOnlyAttrs() { + removeAttribute(Attributes::NoReturn) + .removeAttribute(Attributes::NoUnwind) + .removeAttribute(Attributes::ReadNone) + .removeAttribute(Attributes::ReadOnly) + .removeAttribute(Attributes::NoInline) + .removeAttribute(Attributes::AlwaysInline) + .removeAttribute(Attributes::OptimizeForSize) + .removeAttribute(Attributes::StackProtect) + .removeAttribute(Attributes::StackProtectReq) + .removeAttribute(Attributes::NoRedZone) + .removeAttribute(Attributes::NoImplicitFloat) + .removeAttribute(Attributes::Naked) + .removeAttribute(Attributes::InlineHint) + .removeAttribute(Attributes::StackAlignment) + .removeAttribute(Attributes::UWTable) + .removeAttribute(Attributes::NonLazyBind) + .removeAttribute(Attributes::ReturnsTwice) + .removeAttribute(Attributes::AddressSafety); + } }; /// get - Return a uniquified Attributes object. This takes the uniquified @@ -243,6 +183,29 @@ public: hasAttribute(Attributes::NoCapture); } + /// @brief Attributes that may be applied to the function itself. These cannot + /// be used on return values or function parameters. + bool hasFunctionOnlyAttrs() const { + return hasAttribute(Attributes::NoReturn) || + hasAttribute(Attributes::NoUnwind) || + hasAttribute(Attributes::ReadNone) || + hasAttribute(Attributes::ReadOnly) || + hasAttribute(Attributes::NoInline) || + hasAttribute(Attributes::AlwaysInline) || + hasAttribute(Attributes::OptimizeForSize) || + hasAttribute(Attributes::StackProtect) || + hasAttribute(Attributes::StackProtectReq) || + hasAttribute(Attributes::NoRedZone) || + hasAttribute(Attributes::NoImplicitFloat) || + hasAttribute(Attributes::Naked) || + hasAttribute(Attributes::InlineHint) || + hasAttribute(Attributes::StackAlignment) || + hasAttribute(Attributes::UWTable) || + hasAttribute(Attributes::NonLazyBind) || + hasAttribute(Attributes::ReturnsTwice) || + hasAttribute(Attributes::AddressSafety); + } + bool isEmptyOrSingleton() const; // This is a "safe bool() operator". @@ -268,7 +231,7 @@ public: static Attributes constructAlignmentFromInt(unsigned i) { // Default alignment, allow the target to define how to align it. if (i == 0) - return Attribute::None; + return Attributes(); assert(isPowerOf2_32(i) && "Alignment must be a power of two."); assert(i <= 0x40000000 && "Alignment too large."); @@ -280,7 +243,7 @@ public: static Attributes constructStackAlignmentFromInt(unsigned i) { // Default alignment, allow the target to define how to align it. if (i == 0) - return Attribute::None; + return Attributes(); assert(isPowerOf2_32(i) && "Alignment must be a power of two."); assert(i <= 0x100 && "Alignment too large."); @@ -306,8 +269,7 @@ public: // bits. uint64_t EncodedAttrs = Attrs.Raw() & 0xffff; if (Attrs.hasAttribute(Attributes::Alignment)) - EncodedAttrs |= (1ULL << 16) << - (((Attrs.Raw() & Attribute::Alignment_i) - 1) >> 16); + EncodedAttrs |= Attrs.getAlignment() << 16; EncodedAttrs |= (Attrs.Raw() & (0xfffULL << 21)) << 11; return EncodedAttrs; } @@ -349,6 +311,19 @@ struct AttributeWithIndex { ///< Index 0 is used for return value attributes. ///< Index ~0U is used for function attributes. + static AttributeWithIndex get(unsigned Idx, + ArrayRef Attrs) { + Attributes::Builder B; + + for (ArrayRef::iterator I = Attrs.begin(), + E = Attrs.end(); I != E; ++I) + B.addAttribute(*I); + + AttributeWithIndex P; + P.Index = Idx; + P.Attrs = Attributes::get(B); + return P; + } static AttributeWithIndex get(unsigned Idx, Attributes Attrs) { AttributeWithIndex P; P.Index = Idx; @@ -426,7 +401,7 @@ public: /// hasAttrSomewhere - Return true if the specified attribute is set for at /// least one parameter or for the return value. - bool hasAttrSomewhere(Attributes Attr) const; + bool hasAttrSomewhere(Attributes::AttrVal Attr) const; unsigned getNumAttrs() const; Attributes &getAttributesAtIndex(unsigned i) const;