Remove the bitwise assignment OR operator from the Attributes class. Replace it with...
[oota-llvm.git] / include / llvm / Attributes.h
index 00eb325cacda98417c3934625c387c948421baec..08cfb86898c9e45305876f7702ca3638387da64b 100644 (file)
@@ -26,116 +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 only apply to function parameters.
-const AttrConst ParameterOnly = {ByVal_i | Nest_i |
-    StructRet_i | NoCapture_i};
-
-/// @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 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},
-  {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;
@@ -143,51 +33,69 @@ 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:
-  // Currently, we need less than 64 bits.
   AttributesImpl Attrs;
 
   explicit Attributes(AttributesImpl *A);
 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 {
@@ -195,52 +103,65 @@ public:
     uint64_t Bits;
   public:
     Builder() : Bits(0) {}
+    explicit Builder(uint64_t B) : Bits(B) {}
     Builder(const Attributes &A) : Bits(A.Raw()) {}
 
     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;
-
-    void addAttribute(Attributes::AttrVal Val);
-    void removeAttribute(Attributes::AttrVal Val);
-
-    void addAlignmentAttr(unsigned Align);
-    void addStackAlignmentAttr(unsigned Align);
-
-    void removeAttributes(const Attributes &A);
-
-    void removeAddressSafetyAttr();
-    void removeAlwaysInlineAttr();
-    void removeByValAttr();
-    void removeInlineHintAttr();
-    void removeInRegAttr();
-    void removeNakedAttr();
-    void removeNestAttr();
-    void removeNoAliasAttr();
-    void removeNoCaptureAttr();
-    void removeNoImplicitFloatAttr();
-    void removeNoInlineAttr();
-    void removeNonLazyBindAttr();
-    void removeNoRedZoneAttr();
-    void removeNoReturnAttr();
-    void removeNoUnwindAttr();
-    void removeOptimizeForSizeAttr();
-    void removeReadNoneAttr();
-    void removeReadOnlyAttr();
-    void removeReturnsTwiceAttr();
-    void removeSExtAttr();
-    void removeStackProtectAttr();
-    void removeStackProtectReqAttr();
-    void removeStructRetAttr();
-    void removeUWTableAttr();
-    void removeZExtAttr();
-
-    void removeAlignmentAttr();
-    void removeStackAlignmentAttr();
+    uint64_t getStackAlignment() const;
+
+    Builder &addAttribute(Attributes::AttrVal Val);
+    Builder &removeAttribute(Attributes::AttrVal Val);
+
+    /// addRawValue - Add the raw value to the internal representation. This
+    /// should be used ONLY for decoding bitcode!
+    Builder &addRawValue(uint64_t Val);
+
+    /// addAlignmentAttr - This turns an int alignment (which must be a power of
+    /// 2) into the form used internally in Attributes.
+    Builder &addAlignmentAttr(unsigned Align);
+
+    /// addStackAlignmentAttr - This turns an int stack alignment (which must be
+    /// a power of 2) into the form used internally in Attributes.
+    Builder &addStackAlignmentAttr(unsigned Align);
+
+    Builder &addAttributes(const Attributes &A);
+    Builder &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);
+    }
+
+    bool operator==(const Builder &B) {
+      return Bits == B.Bits;
+    }
+    bool operator!=(const Builder &B) {
+      return Bits != B.Bits;
+    }
   };
 
   /// get - Return a uniquified Attributes object. This takes the uniquified
@@ -248,11 +169,6 @@ public:
   static Attributes get(Builder &B);
   static Attributes get(LLVMContext &Context, Builder &B);
 
-  /// @brief Parameter attributes that do not apply to vararg call arguments.
-  bool hasIncompatibleWithVarArgsAttrs() const {
-    return hasAttribute(Attributes::StructRet);
-  }
-
   /// @brief Return true if the attribute is present.
   bool hasAttribute(AttrVal Val) const;
 
@@ -264,14 +180,50 @@ public:
   /// @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
+  /// @brief Returns the alignment field of an attribute as a byte alignment
   /// value.
   unsigned getAlignment() const;
 
-  /// This returns the stack alignment field of an attribute as a byte alignment
-  /// value.
+  /// @brief Returns the stack alignment field of an attribute as a byte
+  /// alignment value.
   unsigned getStackAlignment() const;
 
+  /// @brief Parameter attributes that do not apply to vararg call arguments.
+  bool hasIncompatibleWithVarArgsAttrs() const {
+    return hasAttribute(Attributes::StructRet);
+  }
+
+  /// @brief Attributes that only apply to function parameters.
+  bool hasParameterOnlyAttrs() const {
+    return hasAttribute(Attributes::ByVal) ||
+      hasAttribute(Attributes::Nest) ||
+      hasAttribute(Attributes::StructRet) ||
+      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".
@@ -283,39 +235,11 @@ public:
     return Attrs.Bits != A.Attrs.Bits;
   }
 
-  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)
-      return Attribute::None;
-
-    assert(isPowerOf2_32(i) && "Alignment must be a power of two.");
-    assert(i <= 0x40000000 && "Alignment too large.");
-    return Attributes((Log2_32(i)+1) << 16);
-  }
-
-  /// 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)
-      return Attribute::None;
-
-    assert(isPowerOf2_32(i) && "Alignment must be a power of two.");
-    assert(i <= 0x100 && "Alignment too large.");
-    return Attributes((Log2_32(i)+1) << 26);
-  }
-
   /// @brief Which attributes cannot be applied to a type.
   static Attributes typeIncompatible(Type *Ty);
 
@@ -335,8 +259,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;
   }
@@ -352,11 +275,11 @@ public:
     assert((!Alignment || isPowerOf2_32(Alignment)) &&
            "Alignment must be a power of two.");
 
-    Attributes Attrs(EncodedAttrs & 0xffff);
+    Attributes::Builder B(EncodedAttrs & 0xffff);
     if (Alignment)
-      Attrs |= Attributes::constructAlignmentFromInt(Alignment);
-    Attrs |= Attributes((EncodedAttrs & (0xfffULL << 32)) >> 11);
-    return Attrs;
+      B.addAlignmentAttr(Alignment);
+    B.addRawValue((EncodedAttrs & (0xfffULL << 32)) >> 11);
+    return Attributes::get(B);
   }
 
   /// getAsString - The set of Attributes set in Attributes is converted to a
@@ -378,6 +301,19 @@ struct AttributeWithIndex {
                      ///< Index 0 is used for return value attributes.
                      ///< Index ~0U is used for function attributes.
 
+  static AttributeWithIndex get(unsigned Idx,
+                                ArrayRef<Attributes::AttrVal> Attrs) {
+    Attributes::Builder B;
+
+    for (ArrayRef<Attributes::AttrVal>::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;
@@ -414,12 +350,12 @@ public:
   /// addAttr - Add the specified attribute at the specified index to this
   /// attribute list.  Since attribute lists are immutable, this
   /// returns the new list.
-  AttrListPtr addAttr(unsigned Idx, Attributes Attrs) const;
+  AttrListPtr addAttr(LLVMContext &C, unsigned Idx, Attributes Attrs) const;
 
   /// removeAttr - Remove the specified attribute at the specified index from
   /// this attribute list.  Since attribute lists are immutable, this
   /// returns the new list.
-  AttrListPtr removeAttr(unsigned Idx, Attributes Attrs) const;
+  AttrListPtr removeAttr(LLVMContext &C, unsigned Idx, Attributes Attrs) const;
 
   //===--------------------------------------------------------------------===//
   // Attribute List Accessors
@@ -455,7 +391,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;