include/llvm/IR/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 /// \file
  11 /// \brief This file contains the simple types necessary to represent the
  12 /// attributes associated with functions and their calls.
  13 ///
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_IR_ATTRIBUTES_H
  17 #define LLVM_IR_ATTRIBUTES_H
  18
  19 #include "llvm/ADT/ArrayRef.h"
  20 #include "llvm/ADT/DenseSet.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22 #include <cassert>
  23 #include <string>
  24
  25 namespace llvm {
  26
  27 class AttrBuilder;
  28 class AttributeImpl;
  29 class AttributeSetImpl;
  30 class AttributeSetNode;
  31 class Constant;
  32 class LLVMContext;
  33 class Type;
  34
  35 //===----------------------------------------------------------------------===//
  36 /// \class
  37 /// \brief Functions, function parameters, and return types can have attributes
  38 /// to indicate how they should be treated by optimizations and code
  39 /// generation. This class represents one of those attributes. It's light-weight
  40 /// and should be passed around by-value.
  41 class Attribute {
  42 public:
  43   /// This enumeration lists the attributes that can be associated with
  44   /// parameters, function results, or the function itself.
  45   ///
  46   /// Note: The `uwtable' attribute is about the ABI or the user mandating an
  47   /// entry in the unwind table. The `nounwind' attribute is about an exception
  48   /// passing by the function.
  49   ///
  50   /// In a theoretical system that uses tables for profiling and SjLj for
  51   /// exceptions, they would be fully independent. In a normal system that uses
  52   /// tables for both, the semantics are:
  53   ///
  54   /// nil                = Needs an entry because an exception might pass by.
  55   /// nounwind           = No need for an entry
  56   /// uwtable            = Needs an entry because the ABI says so and because
  57   ///                      an exception might pass by.
  58   /// uwtable + nounwind = Needs an entry because the ABI says so.
  59
  60   enum AttrKind {
  61     // IR-Level Attributes
  62     None,                  ///< No attributes have been set
  63     AddressSafety,         ///< Address safety checking is on.
  64     Alignment,             ///< Alignment of parameter (5 bits)
  65                            ///< stored as log2 of alignment with +1 bias
  66                            ///< 0 means unaligned (different from align(1))
  67     AlwaysInline,          ///< inline=always
  68     ByVal,                 ///< Pass structure by value
  69     InlineHint,            ///< Source said inlining was desirable
  70     InReg,                 ///< Force argument to be passed in register
  71     MinSize,               ///< Function must be optimized for size first
  72     Naked,                 ///< Naked function
  73     Nest,                  ///< Nested function static chain
  74     NoAlias,               ///< Considered to not alias after call
  75     NoCapture,             ///< Function creates no aliases of pointer
  76     NoDuplicate,           ///< Call cannot be duplicated
  77     NoImplicitFloat,       ///< Disable implicit floating point insts
  78     NoInline,              ///< inline=never
  79     NonLazyBind,           ///< Function is called early and/or
  80                            ///< often, so lazy binding isn't worthwhile
  81     NoRedZone,             ///< Disable redzone
  82     NoReturn,              ///< Mark the function as not returning
  83     NoUnwind,              ///< Function doesn't unwind stack
  84     OptimizeForSize,       ///< opt_size
  85     ReadNone,              ///< Function does not access memory
  86     ReadOnly,              ///< Function only reads from memory
  87     ReturnsTwice,          ///< Function can return twice
  88     SExt,                  ///< Sign extended before/after call
  89     StackAlignment,        ///< Alignment of stack for function (3 bits)
  90                            ///< stored as log2 of alignment with +1 bias 0
  91                            ///< means unaligned (different from
  92                            ///< alignstack=(1))
  93     StackProtect,          ///< Stack protection.
  94     StackProtectReq,       ///< Stack protection required.
  95     StackProtectStrong,    ///< Strong Stack protection.
  96     StructRet,             ///< Hidden pointer to structure to return
  97     UWTable,               ///< Function must be in a unwind table
  98     ZExt,                  ///< Zero extended before/after call
  99
 100     EndAttrKinds,          ///< Sentinal value useful for loops
 101
 102     AttrKindEmptyKey,      ///< Empty key value for DenseMapInfo
 103     AttrKindTombstoneKey   ///< Tombstone key value for DenseMapInfo
 104   };
 105 private:
 106   AttributeImpl *pImpl;
 107   Attribute(AttributeImpl *A) : pImpl(A) {}
 108 public:
 109   Attribute() : pImpl(0) {}
 110
 111   //===--------------------------------------------------------------------===//
 112   // Attribute Construction
 113   //===--------------------------------------------------------------------===//
 114
 115   /// \brief Return a uniquified Attribute object.
 116   static Attribute get(LLVMContext &Context, AttrKind Kind);
 117   static Attribute get(LLVMContext &Context, AttrBuilder &B);
 118
 119   /// \brief Return a uniquified Attribute object that has the specific
 120   /// alignment set.
 121   static Attribute getWithAlignment(LLVMContext &Context, uint64_t Align);
 122   static Attribute getWithStackAlignment(LLVMContext &Context, uint64_t Align);
 123
 124   //===--------------------------------------------------------------------===//
 125   // Attribute Accessors
 126   //===--------------------------------------------------------------------===//
 127
 128   /// \brief Return true if the attribute is present.
 129   bool hasAttribute(AttrKind Val) const;
 130
 131   /// \brief Return true if attributes exist
 132   bool hasAttributes() const;
 133
 134   /// \brief Return the kind of this attribute.
 135   Constant *getAttributeKind() const;
 136
 137   /// \brief Return the value (if present) of the non-target-specific attribute.
 138   ArrayRef<Constant*> getAttributeValues() const;
 139
 140   /// \brief Returns the alignment field of an attribute as a byte alignment
 141   /// value.
 142   unsigned getAlignment() const;
 143
 144   /// \brief Returns the stack alignment field of an attribute as a byte
 145   /// alignment value.
 146   unsigned getStackAlignment() const;
 147
 148   /// \brief The Attribute is converted to a string of equivalent mnemonic. This
 149   /// is, presumably, for writing out the mnemonics for the assembly writer.
 150   std::string getAsString() const;
 151
 152   /// \brief Equality and non-equality query methods.
 153   bool operator==(AttrKind K) const;
 154   bool operator!=(AttrKind K) const;
 155
 156   bool operator==(Attribute A) const { return pImpl == A.pImpl; }
 157   bool operator!=(Attribute A) const { return pImpl != A.pImpl; }
 158
 159   /// \brief Less-than operator. Useful for sorting the attributes list.
 160   bool operator<(Attribute A) const;
 161
 162   void Profile(FoldingSetNodeID &ID) const {
 163     ID.AddPointer(pImpl);
 164   }
 165
 166   // FIXME: Remove this.
 167   uint64_t Raw() const;
 168 };
 169
 170 //===----------------------------------------------------------------------===//
 171 /// \class
 172 /// \brief This class manages the ref count for the opaque AttributeSetImpl
 173 /// object and provides accessors for it.
 174 class AttributeSet {
 175 public:
 176   enum AttrIndex {
 177     ReturnIndex = 0U,
 178     FunctionIndex = ~0U
 179   };
 180 private:
 181   friend class AttrBuilder;
 182   friend class AttributeSetImpl;
 183
 184   /// \brief The attributes that we are managing. This can be null to represent
 185   /// the empty attributes list.
 186   AttributeSetImpl *pImpl;
 187
 188   /// \brief The attributes for the specified index are returned.
 189   AttributeSetNode *getAttributes(unsigned Idx) const;
 190
 191   /// \brief Create an AttributeSet with the specified parameters in it.
 192   static AttributeSet get(LLVMContext &C,
 193                           ArrayRef<std::pair<unsigned, Attribute> > Attrs);
 194   static AttributeSet get(LLVMContext &C,
 195                           ArrayRef<std::pair<unsigned,
 196                                              AttributeSetNode*> > Attrs);
 197
 198   static AttributeSet getImpl(LLVMContext &C,
 199                               ArrayRef<std::pair<unsigned,
 200                                                  AttributeSetNode*> > Attrs);
 201
 202
 203   explicit AttributeSet(AttributeSetImpl *LI) : pImpl(LI) {}
 204 public:
 205   AttributeSet() : pImpl(0) {}
 206   AttributeSet(const AttributeSet &P) : pImpl(P.pImpl) {}
 207   const AttributeSet &operator=(const AttributeSet &RHS) {
 208     pImpl = RHS.pImpl;
 209     return *this;
 210   }
 211
 212   //===--------------------------------------------------------------------===//
 213   // AttributeSet Construction and Mutation
 214   //===--------------------------------------------------------------------===//
 215
 216   /// \brief Return an AttributeSet with the specified parameters in it.
 217   static AttributeSet get(LLVMContext &C, ArrayRef<AttributeSet> Attrs);
 218   static AttributeSet get(LLVMContext &C, unsigned Idx,
 219                           ArrayRef<Attribute::AttrKind> Kind);
 220   static AttributeSet get(LLVMContext &C, unsigned Idx, AttrBuilder &B);
 221
 222   /// \brief Add an attribute to the attribute set at the given index. Since
 223   /// attribute sets are immutable, this returns a new set.
 224   AttributeSet addAttribute(LLVMContext &C, unsigned Idx,
 225                             Attribute::AttrKind Attr) const;
 226
 227   /// \brief Add attributes to the attribute set at the given index. Since
 228   /// attribute sets are immutable, this returns a new set.
 229   AttributeSet addAttributes(LLVMContext &C, unsigned Idx,
 230                              AttributeSet Attrs) const;
 231
 232   /// \brief Remove the specified attribute at the specified index from this
 233   /// attribute list. Since attribute lists are immutable, this returns the new
 234   /// list.
 235   AttributeSet removeAttribute(LLVMContext &C, unsigned Idx,
 236                                Attribute::AttrKind Attr) const;
 237
 238   /// \brief Remove the specified attributes at the specified index from this
 239   /// attribute list. Since attribute lists are immutable, this returns the new
 240   /// list.
 241   AttributeSet removeAttributes(LLVMContext &C, unsigned Idx,
 242                                 AttributeSet Attrs) const;
 243
 244   //===--------------------------------------------------------------------===//
 245   // AttributeSet Accessors
 246   //===--------------------------------------------------------------------===//
 247
 248   /// \brief The attributes for the specified index are returned.
 249   AttributeSet getParamAttributes(unsigned Idx) const;
 250
 251   /// \brief The attributes for the ret value are returned.
 252   AttributeSet getRetAttributes() const;
 253
 254   /// \brief The function attributes are returned.
 255   AttributeSet getFnAttributes() const;
 256
 257   /// \brief Return true if the attribute exists at the given index.
 258   bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const;
 259
 260   /// \brief Return true if attribute exists at the given index.
 261   bool hasAttributes(unsigned Index) const;
 262
 263   /// \brief Return true if the specified attribute is set for at least one
 264   /// parameter or for the return value.
 265   bool hasAttrSomewhere(Attribute::AttrKind Attr) const;
 266
 267   /// \brief Return the alignment for the specified function parameter.
 268   unsigned getParamAlignment(unsigned Idx) const;
 269
 270   /// \brief Get the stack alignment.
 271   unsigned getStackAlignment(unsigned Index) const;
 272
 273   /// \brief Return the attributes at the index as a string.
 274   std::string getAsString(unsigned Index) const;
 275
 276   /// operator==/!= - Provide equality predicates.
 277   bool operator==(const AttributeSet &RHS) const {
 278     return pImpl == RHS.pImpl;
 279   }
 280   bool operator!=(const AttributeSet &RHS) const {
 281     return pImpl != RHS.pImpl;
 282   }
 283
 284   //===--------------------------------------------------------------------===//
 285   // AttributeSet Introspection
 286   //===--------------------------------------------------------------------===//
 287
 288   // FIXME: Remove this.
 289   uint64_t Raw(unsigned Index) const;
 290
 291   /// \brief Return a raw pointer that uniquely identifies this attribute list.
 292   void *getRawPointer() const {
 293     return pImpl;
 294   }
 295
 296   /// \brief Return true if there are no attributes.
 297   bool isEmpty() const {
 298     return getNumSlots() == 0;
 299   }
 300
 301   /// \brief Return the number of slots used in this attribute list.  This is
 302   /// the number of arguments that have an attribute set on them (including the
 303   /// function itself).
 304   unsigned getNumSlots() const;
 305
 306   /// \brief Return the index for the given slot.
 307   uint64_t getSlotIndex(unsigned Slot) const;
 308
 309   /// \brief Return the attributes at the given slot.
 310   AttributeSet getSlotAttributes(unsigned Slot) const;
 311
 312   void dump() const;
 313 };
 314
 315 //===----------------------------------------------------------------------===//
 316 /// \class
 317 /// \brief Provide DenseMapInfo for Attribute::AttrKinds. This is used by
 318 /// AttrBuilder.
 319 template<> struct DenseMapInfo<Attribute::AttrKind> {
 320   static inline Attribute::AttrKind getEmptyKey() {
 321     return Attribute::AttrKindEmptyKey;
 322   }
 323   static inline Attribute::AttrKind getTombstoneKey() {
 324     return Attribute::AttrKindTombstoneKey;
 325   }
 326   static unsigned getHashValue(const Attribute::AttrKind &Val) {
 327     return Val * 37U;
 328   }
 329   static bool isEqual(const Attribute::AttrKind &LHS,
 330                       const Attribute::AttrKind &RHS) {
 331     return LHS == RHS;
 332   }
 333 };
 334
 335 //===----------------------------------------------------------------------===//
 336 /// \class
 337 /// \brief This class is used in conjunction with the Attribute::get method to
 338 /// create an Attribute object. The object itself is uniquified. The Builder's
 339 /// value, however, is not. So this can be used as a quick way to test for
 340 /// equality, presence of attributes, etc.
 341 class AttrBuilder {
 342   DenseSet<Attribute::AttrKind> Attrs;
 343   uint64_t Alignment;
 344   uint64_t StackAlignment;
 345 public:
 346   AttrBuilder() : Alignment(0), StackAlignment(0) {}
 347   explicit AttrBuilder(uint64_t B) : Alignment(0), StackAlignment(0) {
 348     addRawValue(B);
 349   }
 350   AttrBuilder(const Attribute &A) : Alignment(0), StackAlignment(0) {
 351     addAttributes(A);
 352   }
 353   AttrBuilder(AttributeSet AS, unsigned Idx);
 354
 355   void clear();
 356
 357   /// \brief Add an attribute to the builder.
 358   AttrBuilder &addAttribute(Attribute::AttrKind Val);
 359
 360   /// \brief Remove an attribute from the builder.
 361   AttrBuilder &removeAttribute(Attribute::AttrKind Val);
 362
 363   /// \brief Add the attributes to the builder.
 364   AttrBuilder &addAttributes(Attribute A);
 365
 366   /// \brief Remove the attributes from the builder.
 367   AttrBuilder &removeAttributes(AttributeSet A, uint64_t Index);
 368
 369   /// \brief Return true if the builder has the specified attribute.
 370   bool contains(Attribute::AttrKind A) const;
 371
 372   /// \brief Return true if the builder has IR-level attributes.
 373   bool hasAttributes() const;
 374
 375   /// \brief Return true if the builder has any attribute that's in the
 376   /// specified attribute.
 377   bool hasAttributes(AttributeSet A, uint64_t Index) const;
 378
 379   /// \brief Return true if the builder has an alignment attribute.
 380   bool hasAlignmentAttr() const;
 381
 382   /// \brief Retrieve the alignment attribute, if it exists.
 383   uint64_t getAlignment() const { return Alignment; }
 384
 385   /// \brief Retrieve the stack alignment attribute, if it exists.
 386   uint64_t getStackAlignment() const { return StackAlignment; }
 387
 388   /// \brief This turns an int alignment (which must be a power of 2) into the
 389   /// form used internally in Attribute.
 390   AttrBuilder &addAlignmentAttr(unsigned Align);
 391
 392   /// \brief This turns an int stack alignment (which must be a power of 2) into
 393   /// the form used internally in Attribute.
 394   AttrBuilder &addStackAlignmentAttr(unsigned Align);
 395
 396   typedef DenseSet<Attribute::AttrKind>::iterator       iterator;
 397   typedef DenseSet<Attribute::AttrKind>::const_iterator const_iterator;
 398
 399   iterator begin()             { return Attrs.begin(); }
 400   iterator end()               { return Attrs.end(); }
 401
 402   const_iterator begin() const { return Attrs.begin(); }
 403   const_iterator end() const   { return Attrs.end(); }
 404
 405   /// \brief Remove attributes that are used on functions only.
 406   void removeFunctionOnlyAttrs() {
 407     removeAttribute(Attribute::NoReturn)
 408       .removeAttribute(Attribute::NoUnwind)
 409       .removeAttribute(Attribute::ReadNone)
 410       .removeAttribute(Attribute::ReadOnly)
 411       .removeAttribute(Attribute::NoInline)
 412       .removeAttribute(Attribute::AlwaysInline)
 413       .removeAttribute(Attribute::OptimizeForSize)
 414       .removeAttribute(Attribute::StackProtect)
 415       .removeAttribute(Attribute::StackProtectReq)
 416       .removeAttribute(Attribute::StackProtectStrong)
 417       .removeAttribute(Attribute::NoRedZone)
 418       .removeAttribute(Attribute::NoImplicitFloat)
 419       .removeAttribute(Attribute::Naked)
 420       .removeAttribute(Attribute::InlineHint)
 421       .removeAttribute(Attribute::StackAlignment)
 422       .removeAttribute(Attribute::UWTable)
 423       .removeAttribute(Attribute::NonLazyBind)
 424       .removeAttribute(Attribute::ReturnsTwice)
 425       .removeAttribute(Attribute::AddressSafety)
 426       .removeAttribute(Attribute::MinSize)
 427       .removeAttribute(Attribute::NoDuplicate);
 428   }
 429
 430   bool operator==(const AttrBuilder &B);
 431   bool operator!=(const AttrBuilder &B) {
 432     return !(*this == B);
 433   }
 434
 435   // FIXME: Remove these.
 436
 437   /// \brief Add the raw value to the internal representation.
 438   ///
 439   /// N.B. This should be used ONLY for decoding LLVM bitcode!
 440   AttrBuilder &addRawValue(uint64_t Val);
 441
 442   uint64_t Raw() const;
 443 };
 444
 445 namespace AttributeFuncs {
 446
 447 /// \brief Which attributes cannot be applied to a type.
 448 AttributeSet typeIncompatible(Type *Ty, uint64_t Index);
 449
 450 /// \brief This returns an integer containing an encoding of all the LLVM
 451 /// attributes found in the given attribute bitset.  Any change to this encoding
 452 /// is a breaking change to bitcode compatibility.
 453 uint64_t encodeLLVMAttributesForBitcode(AttributeSet Attrs, unsigned Index);
 454
 455 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
 456 /// been decoded from the given integer. This function must stay in sync with
 457 /// 'encodeLLVMAttributesForBitcode'.
 458 /// N.B. This should be used only by the bitcode reader!
 459 void decodeLLVMAttributesForBitcode(LLVMContext &C, AttrBuilder &B,
 460                                     uint64_t EncodedAttrs);
 461
 462 } // end AttributeFuncs namespace
 463
 464 } // end llvm namespace
 465
 466 #endif