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