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