include/llvm/Attributes.h

   1 //===-- llvm/Attributes.h - Container for Attributes ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the simple types necessary to represent the
  11 // attributes associated with functions and their calls.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ATTRIBUTES_H
  16 #define LLVM_ATTRIBUTES_H
  17
  18 #include "llvm/AttributesImpl.h"
  19 #include "llvm/Support/MathExtras.h"
  20 #include "llvm/ADT/ArrayRef.h"
  21 #include <cassert>
  22 #include <string>
  23
  24 namespace llvm {
  25
  26 class LLVMContext;
  27 class Type;
  28
  29 /// AttributeImpl - The internal representation of the Attributes class. This is
  30 /// uniquified.
  31 class AttributesImpl;
  32
  33 /// Attributes - A bitset of attributes.
  34 class Attributes {
  35 public:
  36   /// Function parameters and results can have attributes to indicate how they
  37   /// should be treated by optimizations and code generation. This enumeration
  38   /// lists the attributes that can be associated with parameters, function
  39   /// results or the function itself.
  40   ///
  41   /// Note that uwtable is about the ABI or the user mandating an entry in the
  42   /// unwind table. The nounwind attribute is about an exception passing by the
  43   /// function.
  44   ///
  45   /// In a theoretical system that uses tables for profiling and sjlj for
  46   /// exceptions, they would be fully independent. In a normal system that uses
  47   /// tables for both, the semantics are:
  48   ///
  49   /// nil                = Needs an entry because an exception might pass by.
  50   /// nounwind           = No need for an entry
  51   /// uwtable            = Needs an entry because the ABI says so and because
  52   ///                      an exception might pass by.
  53   /// uwtable + nounwind = Needs an entry because the ABI says so.
  54
  55   enum AttrVal {
  56     None            = 0,   ///< No attributes have been set
  57     AddressSafety   = 1,   ///< Address safety checking is on.
  58     Alignment       = 2,   ///< Alignment of parameter (5 bits)
  59                            ///< stored as log2 of alignment with +1 bias
  60                            ///< 0 means unaligned different from align 1
  61     AlwaysInline    = 3,   ///< inline=always
  62     ByVal           = 4,   ///< Pass structure by value
  63     InlineHint      = 5,   ///< Source said inlining was desirable
  64     InReg           = 6,   ///< Force argument to be passed in register
  65     Naked           = 7,   ///< Naked function
  66     Nest            = 8,   ///< Nested function static chain
  67     NoAlias         = 9,   ///< Considered to not alias after call
  68     NoCapture       = 10,  ///< Function creates no aliases of pointer
  69     NoImplicitFloat = 11,  ///< Disable implicit floating point insts
  70     NoInline        = 12,  ///< inline=never
  71     NonLazyBind     = 13,  ///< Function is called early and/or
  72                            ///< often, so lazy binding isn't worthwhile
  73     NoRedZone       = 14,  ///< Disable redzone
  74     NoReturn        = 15,  ///< Mark the function as not returning
  75     NoUnwind        = 16,  ///< Function doesn't unwind stack
  76     OptimizeForSize = 17,  ///< opt_size
  77     ReadNone        = 18,  ///< Function does not access memory
  78     ReadOnly        = 19,  ///< Function only reads from memory
  79     ReturnsTwice    = 20,  ///< Function can return twice
  80     SExt            = 21,  ///< Sign extended before/after call
  81     StackAlignment  = 22,  ///< Alignment of stack for function (3 bits)
  82                            ///< stored as log2 of alignment with +1 bias 0
  83                            ///< means unaligned (different from
  84                            ///< alignstack={1))
  85     StackProtect    = 23,  ///< Stack protection.
  86     StackProtectReq = 24,  ///< Stack protection required.
  87     StructRet       = 25,  ///< Hidden pointer to structure to return
  88     UWTable         = 26,  ///< Function must be in a unwind table
  89     ZExt            = 27   ///< Zero extended before/after call
  90   };
  91 private:
  92   AttributesImpl Attrs;
  93
  94   explicit Attributes(AttributesImpl *A);
  95 public:
  96   Attributes() : Attrs(0) {}
  97   explicit Attributes(uint64_t Val);
  98   explicit Attributes(LLVMContext &C, AttrVal Val);
  99   Attributes(const Attributes &A);
 100
 101   class Builder {
 102     friend class Attributes;
 103     uint64_t Bits;
 104   public:
 105     Builder() : Bits(0) {}
 106     Builder(const Attributes &A) : Bits(A.Raw()) {}
 107
 108     void clear() { Bits = 0; }
 109
 110     bool hasAttribute(Attributes::AttrVal A) const;
 111     bool hasAttributes() const;
 112     bool hasAttributes(const Attributes &A) const;
 113     bool hasAlignmentAttr() const;
 114
 115     uint64_t getAlignment() const;
 116     uint64_t getStackAlignment() const;
 117
 118     Builder &addAttribute(Attributes::AttrVal Val);
 119     Builder &removeAttribute(Attributes::AttrVal Val);
 120
 121     /// addAlignmentAttr - This turns an int alignment (which must be a power of
 122     /// 2) into the form used internally in Attributes.
 123     Builder &addAlignmentAttr(unsigned Align);
 124
 125     /// addStackAlignmentAttr - This turns an int stack alignment (which must be
 126     /// a power of 2) into the form used internally in Attributes.
 127     Builder &addStackAlignmentAttr(unsigned Align);
 128
 129     void removeAttributes(const Attributes &A);
 130
 131     /// @brief Remove attributes that are used on functions only.
 132     void removeFunctionOnlyAttrs() {
 133       removeAttribute(Attributes::NoReturn)
 134         .removeAttribute(Attributes::NoUnwind)
 135         .removeAttribute(Attributes::ReadNone)
 136         .removeAttribute(Attributes::ReadOnly)
 137         .removeAttribute(Attributes::NoInline)
 138         .removeAttribute(Attributes::AlwaysInline)
 139         .removeAttribute(Attributes::OptimizeForSize)
 140         .removeAttribute(Attributes::StackProtect)
 141         .removeAttribute(Attributes::StackProtectReq)
 142         .removeAttribute(Attributes::NoRedZone)
 143         .removeAttribute(Attributes::NoImplicitFloat)
 144         .removeAttribute(Attributes::Naked)
 145         .removeAttribute(Attributes::InlineHint)
 146         .removeAttribute(Attributes::StackAlignment)
 147         .removeAttribute(Attributes::UWTable)
 148         .removeAttribute(Attributes::NonLazyBind)
 149         .removeAttribute(Attributes::ReturnsTwice)
 150         .removeAttribute(Attributes::AddressSafety);
 151     }
 152   };
 153
 154   /// get - Return a uniquified Attributes object. This takes the uniquified
 155   /// value from the Builder and wraps it in the Attributes class.
 156   static Attributes get(Builder &B);
 157   static Attributes get(LLVMContext &Context, Builder &B);
 158
 159   /// @brief Return true if the attribute is present.
 160   bool hasAttribute(AttrVal Val) const;
 161
 162   /// @brief Return true if attributes exist
 163   bool hasAttributes() const {
 164     return Attrs.hasAttributes();
 165   }
 166
 167   /// @brief Return true if the attributes are a non-null intersection.
 168   bool hasAttributes(const Attributes &A) const;
 169
 170   /// @brief Returns the alignment field of an attribute as a byte alignment
 171   /// value.
 172   unsigned getAlignment() const;
 173
 174   /// @brief Returns the stack alignment field of an attribute as a byte
 175   /// alignment value.
 176   unsigned getStackAlignment() const;
 177
 178   /// @brief Parameter attributes that do not apply to vararg call arguments.
 179   bool hasIncompatibleWithVarArgsAttrs() const {
 180     return hasAttribute(Attributes::StructRet);
 181   }
 182
 183   /// @brief Attributes that only apply to function parameters.
 184   bool hasParameterOnlyAttrs() const {
 185     return hasAttribute(Attributes::ByVal) ||
 186       hasAttribute(Attributes::Nest) ||
 187       hasAttribute(Attributes::StructRet) ||
 188       hasAttribute(Attributes::NoCapture);
 189   }
 190
 191   /// @brief Attributes that may be applied to the function itself.  These cannot
 192   /// be used on return values or function parameters.
 193   bool hasFunctionOnlyAttrs() const {
 194     return hasAttribute(Attributes::NoReturn) ||
 195       hasAttribute(Attributes::NoUnwind) ||
 196       hasAttribute(Attributes::ReadNone) ||
 197       hasAttribute(Attributes::ReadOnly) ||
 198       hasAttribute(Attributes::NoInline) ||
 199       hasAttribute(Attributes::AlwaysInline) ||
 200       hasAttribute(Attributes::OptimizeForSize) ||
 201       hasAttribute(Attributes::StackProtect) ||
 202       hasAttribute(Attributes::StackProtectReq) ||
 203       hasAttribute(Attributes::NoRedZone) ||
 204       hasAttribute(Attributes::NoImplicitFloat) ||
 205       hasAttribute(Attributes::Naked) ||
 206       hasAttribute(Attributes::InlineHint) ||
 207       hasAttribute(Attributes::StackAlignment) ||
 208       hasAttribute(Attributes::UWTable) ||
 209       hasAttribute(Attributes::NonLazyBind) ||
 210       hasAttribute(Attributes::ReturnsTwice) ||
 211       hasAttribute(Attributes::AddressSafety);
 212   }
 213
 214   bool isEmptyOrSingleton() const;
 215
 216   // This is a "safe bool() operator".
 217   operator const void *() const { return Attrs.Bits ? this : 0; }
 218   bool operator == (const Attributes &A) const {
 219     return Attrs.Bits == A.Attrs.Bits;
 220   }
 221   bool operator != (const Attributes &A) const {
 222     return Attrs.Bits != A.Attrs.Bits;
 223   }
 224
 225   Attributes operator | (const Attributes &A) const;
 226   Attributes operator & (const Attributes &A) const;
 227   Attributes operator ^ (const Attributes &A) const;
 228   Attributes &operator |= (const Attributes &A);
 229   Attributes &operator &= (const Attributes &A);
 230   Attributes operator ~ () const;
 231
 232   uint64_t Raw() const;
 233
 234   /// @brief Which attributes cannot be applied to a type.
 235   static Attributes typeIncompatible(Type *Ty);
 236
 237   /// encodeLLVMAttributesForBitcode - This returns an integer containing an
 238   /// encoding of all the LLVM attributes found in the given attribute bitset.
 239   /// Any change to this encoding is a breaking change to bitcode compatibility.
 240   static uint64_t encodeLLVMAttributesForBitcode(Attributes Attrs) {
 241     // FIXME: It doesn't make sense to store the alignment information as an
 242     // expanded out value, we should store it as a log2 value.  However, we
 243     // can't just change that here without breaking bitcode compatibility.  If
 244     // this ever becomes a problem in practice, we should introduce new tag
 245     // numbers in the bitcode file and have those tags use a more efficiently
 246     // encoded alignment field.
 247
 248     // Store the alignment in the bitcode as a 16-bit raw value instead of a
 249     // 5-bit log2 encoded value. Shift the bits above the alignment up by 11
 250     // bits.
 251     uint64_t EncodedAttrs = Attrs.Raw() & 0xffff;
 252     if (Attrs.hasAttribute(Attributes::Alignment))
 253       EncodedAttrs |= Attrs.getAlignment() << 16;
 254     EncodedAttrs |= (Attrs.Raw() & (0xfffULL << 21)) << 11;
 255     return EncodedAttrs;
 256   }
 257
 258   /// decodeLLVMAttributesForBitcode - This returns an attribute bitset
 259   /// containing the LLVM attributes that have been decoded from the given
 260   /// integer.  This function must stay in sync with
 261   /// 'encodeLLVMAttributesForBitcode'.
 262   static Attributes decodeLLVMAttributesForBitcode(uint64_t EncodedAttrs) {
 263     // The alignment is stored as a 16-bit raw value from bits 31--16.  We shift
 264     // the bits above 31 down by 11 bits.
 265     unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
 266     assert((!Alignment || isPowerOf2_32(Alignment)) &&
 267            "Alignment must be a power of two.");
 268
 269     Attributes Attrs(EncodedAttrs & 0xffff);
 270     if (Alignment) {
 271       Attributes::Builder B;
 272       B.addAlignmentAttr(Alignment);
 273       Attrs |= Attributes::get(B);
 274     }
 275     Attrs |= Attributes((EncodedAttrs & (0xfffULL << 32)) >> 11);
 276     return Attrs;
 277   }
 278
 279   /// getAsString - The set of Attributes set in Attributes is converted to a
 280   /// string of equivalent mnemonics. This is, presumably, for writing out the
 281   /// mnemonics for the assembly writer.
 282   /// @brief Convert attribute bits to text
 283   std::string getAsString() const;
 284 };
 285
 286 //===----------------------------------------------------------------------===//
 287 // AttributeWithIndex
 288 //===----------------------------------------------------------------------===//
 289
 290 /// AttributeWithIndex - This is just a pair of values to associate a set of
 291 /// attributes with an index.
 292 struct AttributeWithIndex {
 293   Attributes Attrs;  ///< The attributes that are set, or'd together.
 294   unsigned Index;    ///< Index of the parameter for which the attributes apply.
 295                      ///< Index 0 is used for return value attributes.
 296                      ///< Index ~0U is used for function attributes.
 297
 298   static AttributeWithIndex get(unsigned Idx,
 299                                 ArrayRef<Attributes::AttrVal> Attrs) {
 300     Attributes::Builder B;
 301
 302     for (ArrayRef<Attributes::AttrVal>::iterator I = Attrs.begin(),
 303            E = Attrs.end(); I != E; ++I)
 304       B.addAttribute(*I);
 305
 306     AttributeWithIndex P;
 307     P.Index = Idx;
 308     P.Attrs = Attributes::get(B);
 309     return P;
 310   }
 311   static AttributeWithIndex get(unsigned Idx, Attributes Attrs) {
 312     AttributeWithIndex P;
 313     P.Index = Idx;
 314     P.Attrs = Attrs;
 315     return P;
 316   }
 317 };
 318
 319 //===----------------------------------------------------------------------===//
 320 // AttrListPtr Smart Pointer
 321 //===----------------------------------------------------------------------===//
 322
 323 class AttributeListImpl;
 324
 325 /// AttrListPtr - This class manages the ref count for the opaque
 326 /// AttributeListImpl object and provides accessors for it.
 327 class AttrListPtr {
 328   /// AttrList - The attributes that we are managing.  This can be null
 329   /// to represent the empty attributes list.
 330   AttributeListImpl *AttrList;
 331 public:
 332   AttrListPtr() : AttrList(0) {}
 333   AttrListPtr(const AttrListPtr &P);
 334   const AttrListPtr &operator=(const AttrListPtr &RHS);
 335   ~AttrListPtr();
 336
 337   //===--------------------------------------------------------------------===//
 338   // Attribute List Construction and Mutation
 339   //===--------------------------------------------------------------------===//
 340
 341   /// get - Return a Attributes list with the specified parameters in it.
 342   static AttrListPtr get(ArrayRef<AttributeWithIndex> Attrs);
 343
 344   /// addAttr - Add the specified attribute at the specified index to this
 345   /// attribute list.  Since attribute lists are immutable, this
 346   /// returns the new list.
 347   AttrListPtr addAttr(unsigned Idx, Attributes Attrs) const;
 348
 349   /// removeAttr - Remove the specified attribute at the specified index from
 350   /// this attribute list.  Since attribute lists are immutable, this
 351   /// returns the new list.
 352   AttrListPtr removeAttr(unsigned Idx, Attributes Attrs) const;
 353
 354   //===--------------------------------------------------------------------===//
 355   // Attribute List Accessors
 356   //===--------------------------------------------------------------------===//
 357   /// getParamAttributes - The attributes for the specified index are
 358   /// returned.
 359   Attributes getParamAttributes(unsigned Idx) const {
 360     return getAttributes(Idx);
 361   }
 362
 363   /// getRetAttributes - The attributes for the ret value are
 364   /// returned.
 365   Attributes getRetAttributes() const {
 366     return getAttributes(0);
 367   }
 368
 369   /// getFnAttributes - The function attributes are returned.
 370   Attributes getFnAttributes() const {
 371     return getAttributes(~0U);
 372   }
 373
 374   /// paramHasAttr - Return true if the specified parameter index has the
 375   /// specified attribute set.
 376   bool paramHasAttr(unsigned Idx, Attributes Attr) const {
 377     return getAttributes(Idx).hasAttributes(Attr);
 378   }
 379
 380   /// getParamAlignment - Return the alignment for the specified function
 381   /// parameter.
 382   unsigned getParamAlignment(unsigned Idx) const {
 383     return getAttributes(Idx).getAlignment();
 384   }
 385
 386   /// hasAttrSomewhere - Return true if the specified attribute is set for at
 387   /// least one parameter or for the return value.
 388   bool hasAttrSomewhere(Attributes::AttrVal Attr) const;
 389
 390   unsigned getNumAttrs() const;
 391   Attributes &getAttributesAtIndex(unsigned i) const;
 392
 393   /// operator==/!= - Provide equality predicates.
 394   bool operator==(const AttrListPtr &RHS) const
 395   { return AttrList == RHS.AttrList; }
 396   bool operator!=(const AttrListPtr &RHS) const
 397   { return AttrList != RHS.AttrList; }
 398
 399   void dump() const;
 400
 401   //===--------------------------------------------------------------------===//
 402   // Attribute List Introspection
 403   //===--------------------------------------------------------------------===//
 404
 405   /// getRawPointer - Return a raw pointer that uniquely identifies this
 406   /// attribute list.
 407   void *getRawPointer() const {
 408     return AttrList;
 409   }
 410
 411   // Attributes are stored as a dense set of slots, where there is one
 412   // slot for each argument that has an attribute.  This allows walking over the
 413   // dense set instead of walking the sparse list of attributes.
 414
 415   /// isEmpty - Return true if there are no attributes.
 416   ///
 417   bool isEmpty() const {
 418     return AttrList == 0;
 419   }
 420
 421   /// getNumSlots - Return the number of slots used in this attribute list.
 422   /// This is the number of arguments that have an attribute set on them
 423   /// (including the function itself).
 424   unsigned getNumSlots() const;
 425
 426   /// getSlot - Return the AttributeWithIndex at the specified slot.  This
 427   /// holds a index number plus a set of attributes.
 428   const AttributeWithIndex &getSlot(unsigned Slot) const;
 429
 430 private:
 431   explicit AttrListPtr(AttributeListImpl *L);
 432
 433   /// getAttributes - The attributes for the specified index are
 434   /// returned.  Attributes for the result are denoted with Idx = 0.
 435   Attributes getAttributes(unsigned Idx) const;
 436 };
 437
 438 } // End llvm namespace
 439
 440 #endif