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