contrib/llvm/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/FoldingSet.h"
  21 #include "llvm/ADT/iterator_range.h"
  22 #include "llvm/ADT/Optional.h"
  23 #include "llvm/ADT/StringRef.h"
  24 #include "llvm/Support/PointerLikeTypeTraits.h"
  25 #include "llvm-c/Types.h"
  26 #include <bitset>
  27 #include <cassert>
  28 #include <cstdint>
  29 #include <map>
  30 #include <string>
  31 #include <utility>
  32
  33 namespace llvm {
  34
  35 class AttrBuilder;
  36 class AttributeImpl;
  37 class AttributeListImpl;
  38 class AttributeSetNode;
  39 template<typename T> struct DenseMapInfo;
  40 class Function;
  41 class LLVMContext;
  42 class Type;
  43
  44 //===----------------------------------------------------------------------===//
  45 /// \class
  46 /// \brief Functions, function parameters, and return types can have attributes
  47 /// to indicate how they should be treated by optimizations and code
  48 /// generation. This class represents one of those attributes. It's light-weight
  49 /// and should be passed around by-value.
  50 class Attribute {
  51 public:
  52   /// This enumeration lists the attributes that can be associated with
  53   /// parameters, function results, or the function itself.
  54   ///
  55   /// Note: The `uwtable' attribute is about the ABI or the user mandating an
  56   /// entry in the unwind table. The `nounwind' attribute is about an exception
  57   /// passing by the function.
  58   ///
  59   /// In a theoretical system that uses tables for profiling and SjLj for
  60   /// exceptions, they would be fully independent. In a normal system that uses
  61   /// tables for both, the semantics are:
  62   ///
  63   /// nil                = Needs an entry because an exception might pass by.
  64   /// nounwind           = No need for an entry
  65   /// uwtable            = Needs an entry because the ABI says so and because
  66   ///                      an exception might pass by.
  67   /// uwtable + nounwind = Needs an entry because the ABI says so.
  68
  69   enum AttrKind {
  70     // IR-Level Attributes
  71     None,                  ///< No attributes have been set
  72     #define GET_ATTR_ENUM
  73     #include "llvm/IR/Attributes.gen"
  74     EndAttrKinds           ///< Sentinal value useful for loops
  75   };
  76
  77 private:
  78   AttributeImpl *pImpl = nullptr;
  79
  80   Attribute(AttributeImpl *A) : pImpl(A) {}
  81
  82 public:
  83   Attribute() = default;
  84
  85   //===--------------------------------------------------------------------===//
  86   // Attribute Construction
  87   //===--------------------------------------------------------------------===//
  88
  89   /// \brief Return a uniquified Attribute object.
  90   static Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val = 0);
  91   static Attribute get(LLVMContext &Context, StringRef Kind,
  92                        StringRef Val = StringRef());
  93
  94   /// \brief Return a uniquified Attribute object that has the specific
  95   /// alignment set.
  96   static Attribute getWithAlignment(LLVMContext &Context, uint64_t Align);
  97   static Attribute getWithStackAlignment(LLVMContext &Context, uint64_t Align);
  98   static Attribute getWithDereferenceableBytes(LLVMContext &Context,
  99                                               uint64_t Bytes);
 100   static Attribute getWithDereferenceableOrNullBytes(LLVMContext &Context,
 101                                                      uint64_t Bytes);
 102   static Attribute getWithAllocSizeArgs(LLVMContext &Context,
 103                                         unsigned ElemSizeArg,
 104                                         const Optional<unsigned> &NumElemsArg);
 105
 106   //===--------------------------------------------------------------------===//
 107   // Attribute Accessors
 108   //===--------------------------------------------------------------------===//
 109
 110   /// \brief Return true if the attribute is an Attribute::AttrKind type.
 111   bool isEnumAttribute() const;
 112
 113   /// \brief Return true if the attribute is an integer attribute.
 114   bool isIntAttribute() const;
 115
 116   /// \brief Return true if the attribute is a string (target-dependent)
 117   /// attribute.
 118   bool isStringAttribute() const;
 119
 120   /// \brief Return true if the attribute is present.
 121   bool hasAttribute(AttrKind Val) const;
 122
 123   /// \brief Return true if the target-dependent attribute is present.
 124   bool hasAttribute(StringRef Val) const;
 125
 126   /// \brief Return the attribute's kind as an enum (Attribute::AttrKind). This
 127   /// requires the attribute to be an enum or integer attribute.
 128   Attribute::AttrKind getKindAsEnum() const;
 129
 130   /// \brief Return the attribute's value as an integer. This requires that the
 131   /// attribute be an integer attribute.
 132   uint64_t getValueAsInt() const;
 133
 134   /// \brief Return the attribute's kind as a string. This requires the
 135   /// attribute to be a string attribute.
 136   StringRef getKindAsString() const;
 137
 138   /// \brief Return the attribute's value as a string. This requires the
 139   /// attribute to be a string attribute.
 140   StringRef getValueAsString() const;
 141
 142   /// \brief Returns the alignment field of an attribute as a byte alignment
 143   /// value.
 144   unsigned getAlignment() const;
 145
 146   /// \brief Returns the stack alignment field of an attribute as a byte
 147   /// alignment value.
 148   unsigned getStackAlignment() const;
 149
 150   /// \brief Returns the number of dereferenceable bytes from the
 151   /// dereferenceable attribute.
 152   uint64_t getDereferenceableBytes() const;
 153
 154   /// \brief Returns the number of dereferenceable_or_null bytes from the
 155   /// dereferenceable_or_null attribute.
 156   uint64_t getDereferenceableOrNullBytes() const;
 157
 158   /// Returns the argument numbers for the allocsize attribute (or pair(0, 0)
 159   /// if not known).
 160   std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() const;
 161
 162   /// \brief The Attribute is converted to a string of equivalent mnemonic. This
 163   /// is, presumably, for writing out the mnemonics for the assembly writer.
 164   std::string getAsString(bool InAttrGrp = false) const;
 165
 166   /// \brief Equality and non-equality operators.
 167   bool operator==(Attribute A) const { return pImpl == A.pImpl; }
 168   bool operator!=(Attribute A) const { return pImpl != A.pImpl; }
 169
 170   /// \brief Less-than operator. Useful for sorting the attributes list.
 171   bool operator<(Attribute A) const;
 172
 173   void Profile(FoldingSetNodeID &ID) const {
 174     ID.AddPointer(pImpl);
 175   }
 176
 177   /// \brief Return a raw pointer that uniquely identifies this attribute.
 178   void *getRawPointer() const {
 179     return pImpl;
 180   }
 181
 182   /// \brief Get an attribute from a raw pointer created by getRawPointer.
 183   static Attribute fromRawPointer(void *RawPtr) {
 184     return Attribute(reinterpret_cast<AttributeImpl*>(RawPtr));
 185   }
 186 };
 187
 188 // Specialized opaque value conversions.
 189 inline LLVMAttributeRef wrap(Attribute Attr) {
 190   return reinterpret_cast<LLVMAttributeRef>(Attr.getRawPointer());
 191 }
 192
 193 // Specialized opaque value conversions.
 194 inline Attribute unwrap(LLVMAttributeRef Attr) {
 195   return Attribute::fromRawPointer(Attr);
 196 }
 197
 198 //===----------------------------------------------------------------------===//
 199 /// \class
 200 /// This class holds the attributes for a particular argument, parameter,
 201 /// function, or return value. It is an immutable value type that is cheap to
 202 /// copy. Adding and removing enum attributes is intended to be fast, but adding
 203 /// and removing string or integer attributes involves a FoldingSet lookup.
 204 class AttributeSet {
 205   // TODO: Extract AvailableAttrs from AttributeSetNode and store them here.
 206   // This will allow an efficient implementation of addAttribute and
 207   // removeAttribute for enum attrs.
 208
 209   /// Private implementation pointer.
 210   AttributeSetNode *SetNode = nullptr;
 211
 212   friend AttributeListImpl;
 213   template <typename Ty> friend struct DenseMapInfo;
 214
 215 private:
 216   explicit AttributeSet(AttributeSetNode *ASN) : SetNode(ASN) {}
 217
 218 public:
 219   /// AttributeSet is a trivially copyable value type.
 220   AttributeSet() = default;
 221   AttributeSet(const AttributeSet &) = default;
 222   ~AttributeSet() = default;
 223
 224   static AttributeSet get(LLVMContext &C, const AttrBuilder &B);
 225   static AttributeSet get(LLVMContext &C, ArrayRef<Attribute> Attrs);
 226
 227   bool operator==(const AttributeSet &O) { return SetNode == O.SetNode; }
 228   bool operator!=(const AttributeSet &O) { return !(*this == O); }
 229
 230   unsigned getNumAttributes() const;
 231
 232   bool hasAttributes() const { return SetNode != nullptr; }
 233
 234   bool hasAttribute(Attribute::AttrKind Kind) const;
 235   bool hasAttribute(StringRef Kind) const;
 236
 237   Attribute getAttribute(Attribute::AttrKind Kind) const;
 238   Attribute getAttribute(StringRef Kind) const;
 239
 240   unsigned getAlignment() const;
 241   unsigned getStackAlignment() const;
 242   uint64_t getDereferenceableBytes() const;
 243   uint64_t getDereferenceableOrNullBytes() const;
 244   std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() const;
 245   std::string getAsString(bool InAttrGrp = false) const;
 246
 247   typedef const Attribute *iterator;
 248   iterator begin() const;
 249   iterator end() const;
 250 };
 251
 252 //===----------------------------------------------------------------------===//
 253 /// \class
 254 /// \brief Provide DenseMapInfo for AttributeSet.
 255 template <> struct DenseMapInfo<AttributeSet> {
 256   static inline AttributeSet getEmptyKey() {
 257     uintptr_t Val = static_cast<uintptr_t>(-1);
 258     Val <<= PointerLikeTypeTraits<void *>::NumLowBitsAvailable;
 259     return AttributeSet(reinterpret_cast<AttributeSetNode *>(Val));
 260   }
 261
 262   static inline AttributeSet getTombstoneKey() {
 263     uintptr_t Val = static_cast<uintptr_t>(-2);
 264     Val <<= PointerLikeTypeTraits<void *>::NumLowBitsAvailable;
 265     return AttributeSet(reinterpret_cast<AttributeSetNode *>(Val));
 266   }
 267
 268   static unsigned getHashValue(AttributeSet AS) {
 269     return (unsigned((uintptr_t)AS.SetNode) >> 4) ^
 270            (unsigned((uintptr_t)AS.SetNode) >> 9);
 271   }
 272
 273   static bool isEqual(AttributeSet LHS, AttributeSet RHS) { return LHS == RHS; }
 274 };
 275
 276 //===----------------------------------------------------------------------===//
 277 /// \class
 278 /// \brief This class holds the attributes for a function, its return value, and
 279 /// its parameters. You access the attributes for each of them via an index into
 280 /// the AttributeList object. The function attributes are at index
 281 /// `AttributeList::FunctionIndex', the return value is at index
 282 /// `AttributeList::ReturnIndex', and the attributes for the parameters start at
 283 /// index `1'.
 284 class AttributeList {
 285 public:
 286   enum AttrIndex : unsigned {
 287     ReturnIndex = 0U,
 288     FunctionIndex = ~0U
 289   };
 290
 291 private:
 292   friend class AttrBuilder;
 293   friend class AttributeListImpl;
 294   friend class AttributeSet;
 295   friend class AttributeSetNode;
 296
 297   template <typename Ty> friend struct DenseMapInfo;
 298
 299   /// \brief The attributes that we are managing. This can be null to represent
 300   /// the empty attributes list.
 301   AttributeListImpl *pImpl = nullptr;
 302
 303 public:
 304   /// \brief Create an AttributeList with the specified parameters in it.
 305   static AttributeList get(LLVMContext &C,
 306                            ArrayRef<std::pair<unsigned, Attribute>> Attrs);
 307   static AttributeList
 308   get(LLVMContext &C, ArrayRef<std::pair<unsigned, AttributeSet>> Attrs);
 309
 310   /// \brief Create an AttributeList from attribute sets for a function, its
 311   /// return value, and all of its arguments.
 312   static AttributeList get(LLVMContext &C, AttributeSet FnAttrs,
 313                            AttributeSet RetAttrs,
 314                            ArrayRef<AttributeSet> ArgAttrs);
 315
 316   static AttributeList
 317   getImpl(LLVMContext &C,
 318           ArrayRef<std::pair<unsigned, AttributeSet>> Attrs);
 319
 320 private:
 321   explicit AttributeList(AttributeListImpl *LI) : pImpl(LI) {}
 322
 323 public:
 324   AttributeList() = default;
 325
 326   //===--------------------------------------------------------------------===//
 327   // AttributeList Construction and Mutation
 328   //===--------------------------------------------------------------------===//
 329
 330   /// \brief Return an AttributeList with the specified parameters in it.
 331   static AttributeList get(LLVMContext &C, ArrayRef<AttributeList> Attrs);
 332   static AttributeList get(LLVMContext &C, unsigned Index,
 333                            ArrayRef<Attribute::AttrKind> Kinds);
 334   static AttributeList get(LLVMContext &C, unsigned Index,
 335                            ArrayRef<StringRef> Kind);
 336   static AttributeList get(LLVMContext &C, unsigned Index,
 337                            const AttrBuilder &B);
 338
 339   /// \brief Add an attribute to the attribute set at the given index. Because
 340   /// attribute sets are immutable, this returns a new set.
 341   AttributeList addAttribute(LLVMContext &C, unsigned Index,
 342                              Attribute::AttrKind Kind) const;
 343
 344   /// \brief Add an attribute to the attribute set at the given index. Because
 345   /// attribute sets are immutable, this returns a new set.
 346   AttributeList addAttribute(LLVMContext &C, unsigned Index, StringRef Kind,
 347                              StringRef Value = StringRef()) const;
 348
 349   /// Add an attribute to the attribute set at the given indices. Because
 350   /// attribute sets are immutable, this returns a new set.
 351   AttributeList addAttribute(LLVMContext &C, ArrayRef<unsigned> Indices,
 352                              Attribute A) const;
 353
 354   /// \brief Add attributes to the attribute set at the given index. Because
 355   /// attribute sets are immutable, this returns a new set.
 356   AttributeList addAttributes(LLVMContext &C, unsigned Index,
 357                               AttributeList Attrs) const;
 358
 359   AttributeList addAttributes(LLVMContext &C, unsigned Index,
 360                               const AttrBuilder &B) const;
 361
 362   /// \brief Remove the specified attribute at the specified index from this
 363   /// attribute list. Because attribute lists are immutable, this returns the
 364   /// new list.
 365   AttributeList removeAttribute(LLVMContext &C, unsigned Index,
 366                                 Attribute::AttrKind Kind) const;
 367
 368   /// \brief Remove the specified attribute at the specified index from this
 369   /// attribute list. Because attribute lists are immutable, this returns the
 370   /// new list.
 371   AttributeList removeAttribute(LLVMContext &C, unsigned Index,
 372                                 StringRef Kind) const;
 373
 374   /// \brief Remove the specified attributes at the specified index from this
 375   /// attribute list. Because attribute lists are immutable, this returns the
 376   /// new list.
 377   AttributeList removeAttributes(LLVMContext &C, unsigned Index,
 378                                  AttributeList Attrs) const;
 379
 380   /// \brief Remove the specified attributes at the specified index from this
 381   /// attribute list. Because attribute lists are immutable, this returns the
 382   /// new list.
 383   AttributeList removeAttributes(LLVMContext &C, unsigned Index,
 384                                  const AttrBuilder &Attrs) const;
 385
 386   /// \brief Remove all attributes at the specified index from this
 387   /// attribute list. Because attribute lists are immutable, this returns the
 388   /// new list.
 389   AttributeList removeAttributes(LLVMContext &C, unsigned Index) const;
 390
 391   /// \brief Add the dereferenceable attribute to the attribute set at the given
 392   /// index. Because attribute sets are immutable, this returns a new set.
 393   AttributeList addDereferenceableAttr(LLVMContext &C, unsigned Index,
 394                                        uint64_t Bytes) const;
 395
 396   /// \brief Add the dereferenceable_or_null attribute to the attribute set at
 397   /// the given index. Because attribute sets are immutable, this returns a new
 398   /// set.
 399   AttributeList addDereferenceableOrNullAttr(LLVMContext &C, unsigned Index,
 400                                              uint64_t Bytes) const;
 401
 402   /// Add the allocsize attribute to the attribute set at the given index.
 403   /// Because attribute sets are immutable, this returns a new set.
 404   AttributeList addAllocSizeAttr(LLVMContext &C, unsigned Index,
 405                                  unsigned ElemSizeArg,
 406                                  const Optional<unsigned> &NumElemsArg);
 407
 408   //===--------------------------------------------------------------------===//
 409   // AttributeList Accessors
 410   //===--------------------------------------------------------------------===//
 411
 412   /// \brief Retrieve the LLVM context.
 413   LLVMContext &getContext() const;
 414
 415   /// \brief The attributes for the specified index are returned.
 416   AttributeSet getAttributes(unsigned Index) const;
 417
 418   /// \brief The attributes for the argument or parameter at the given index are
 419   /// returned.
 420   AttributeSet getParamAttributes(unsigned ArgNo) const;
 421
 422   /// \brief The attributes for the ret value are returned.
 423   AttributeSet getRetAttributes() const;
 424
 425   /// \brief The function attributes are returned.
 426   AttributeSet getFnAttributes() const;
 427
 428   /// \brief Return true if the attribute exists at the given index.
 429   bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const;
 430
 431   /// \brief Return true if the attribute exists at the given index.
 432   bool hasAttribute(unsigned Index, StringRef Kind) const;
 433
 434   /// \brief Return true if attribute exists at the given index.
 435   bool hasAttributes(unsigned Index) const;
 436
 437   /// \brief Equivalent to hasAttribute(AttributeList::FunctionIndex, Kind) but
 438   /// may be faster.
 439   bool hasFnAttribute(Attribute::AttrKind Kind) const;
 440
 441   /// \brief Equivalent to hasAttribute(AttributeList::FunctionIndex, Kind) but
 442   /// may be faster.
 443   bool hasFnAttribute(StringRef Kind) const;
 444
 445   /// \brief Equivalent to hasAttribute(ArgNo + 1, Kind).
 446   bool hasParamAttribute(unsigned ArgNo, Attribute::AttrKind Kind) const;
 447
 448   /// \brief Return true if the specified attribute is set for at least one
 449   /// parameter or for the return value. If Index is not nullptr, the index
 450   /// of a parameter with the specified attribute is provided.
 451   bool hasAttrSomewhere(Attribute::AttrKind Kind,
 452                         unsigned *Index = nullptr) const;
 453
 454   /// \brief Return the attribute object that exists at the given index.
 455   Attribute getAttribute(unsigned Index, Attribute::AttrKind Kind) const;
 456
 457   /// \brief Return the attribute object that exists at the given index.
 458   Attribute getAttribute(unsigned Index, StringRef Kind) const;
 459
 460   /// \brief Return the alignment for the specified function parameter.
 461   unsigned getParamAlignment(unsigned Index) const;
 462
 463   /// \brief Get the stack alignment.
 464   unsigned getStackAlignment(unsigned Index) const;
 465
 466   /// \brief Get the number of dereferenceable bytes (or zero if unknown).
 467   uint64_t getDereferenceableBytes(unsigned Index) const;
 468
 469   /// \brief Get the number of dereferenceable_or_null bytes (or zero if
 470   /// unknown).
 471   uint64_t getDereferenceableOrNullBytes(unsigned Index) const;
 472
 473   /// Get the allocsize argument numbers (or pair(0, 0) if unknown).
 474   std::pair<unsigned, Optional<unsigned>>
 475   getAllocSizeArgs(unsigned Index) const;
 476
 477   /// \brief Return the attributes at the index as a string.
 478   std::string getAsString(unsigned Index, bool InAttrGrp = false) const;
 479
 480   typedef ArrayRef<Attribute>::iterator iterator;
 481
 482   iterator begin(unsigned Slot) const;
 483   iterator end(unsigned Slot) const;
 484
 485   /// operator==/!= - Provide equality predicates.
 486   bool operator==(const AttributeList &RHS) const { return pImpl == RHS.pImpl; }
 487   bool operator!=(const AttributeList &RHS) const { return pImpl != RHS.pImpl; }
 488
 489   //===--------------------------------------------------------------------===//
 490   // AttributeList Introspection
 491   //===--------------------------------------------------------------------===//
 492
 493   /// \brief Return a raw pointer that uniquely identifies this attribute list.
 494   void *getRawPointer() const {
 495     return pImpl;
 496   }
 497
 498   /// \brief Return true if there are no attributes.
 499   bool isEmpty() const {
 500     return getNumSlots() == 0;
 501   }
 502
 503   /// \brief Return the number of slots used in this attribute list.  This is
 504   /// the number of arguments that have an attribute set on them (including the
 505   /// function itself).
 506   unsigned getNumSlots() const;
 507
 508   /// \brief Return the index for the given slot.
 509   unsigned getSlotIndex(unsigned Slot) const;
 510
 511   /// \brief Return the attributes at the given slot.
 512   AttributeSet getSlotAttributes(unsigned Slot) const;
 513
 514   void dump() const;
 515 };
 516
 517 //===----------------------------------------------------------------------===//
 518 /// \class
 519 /// \brief Provide DenseMapInfo for AttributeList.
 520 template <> struct DenseMapInfo<AttributeList> {
 521   static inline AttributeList getEmptyKey() {
 522     uintptr_t Val = static_cast<uintptr_t>(-1);
 523     Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable;
 524     return AttributeList(reinterpret_cast<AttributeListImpl *>(Val));
 525   }
 526
 527   static inline AttributeList getTombstoneKey() {
 528     uintptr_t Val = static_cast<uintptr_t>(-2);
 529     Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable;
 530     return AttributeList(reinterpret_cast<AttributeListImpl *>(Val));
 531   }
 532
 533   static unsigned getHashValue(AttributeList AS) {
 534     return (unsigned((uintptr_t)AS.pImpl) >> 4) ^
 535            (unsigned((uintptr_t)AS.pImpl) >> 9);
 536   }
 537
 538   static bool isEqual(AttributeList LHS, AttributeList RHS) {
 539     return LHS == RHS;
 540   }
 541 };
 542
 543 //===----------------------------------------------------------------------===//
 544 /// \class
 545 /// \brief This class is used in conjunction with the Attribute::get method to
 546 /// create an Attribute object. The object itself is uniquified. The Builder's
 547 /// value, however, is not. So this can be used as a quick way to test for
 548 /// equality, presence of attributes, etc.
 549 class AttrBuilder {
 550   std::bitset<Attribute::EndAttrKinds> Attrs;
 551   std::map<std::string, std::string> TargetDepAttrs;
 552   uint64_t Alignment = 0;
 553   uint64_t StackAlignment = 0;
 554   uint64_t DerefBytes = 0;
 555   uint64_t DerefOrNullBytes = 0;
 556   uint64_t AllocSizeArgs = 0;
 557
 558 public:
 559   AttrBuilder() = default;
 560   AttrBuilder(const Attribute &A) {
 561     addAttribute(A);
 562   }
 563   AttrBuilder(AttributeList AS, unsigned Idx);
 564   AttrBuilder(AttributeSet AS);
 565
 566   void clear();
 567
 568   /// \brief Add an attribute to the builder.
 569   AttrBuilder &addAttribute(Attribute::AttrKind Val);
 570
 571   /// \brief Add the Attribute object to the builder.
 572   AttrBuilder &addAttribute(Attribute A);
 573
 574   /// \brief Add the target-dependent attribute to the builder.
 575   AttrBuilder &addAttribute(StringRef A, StringRef V = StringRef());
 576
 577   /// \brief Remove an attribute from the builder.
 578   AttrBuilder &removeAttribute(Attribute::AttrKind Val);
 579
 580   /// \brief Remove the attributes from the builder.
 581   AttrBuilder &removeAttributes(AttributeList A, uint64_t WithoutIndex);
 582
 583   /// \brief Remove the target-dependent attribute to the builder.
 584   AttrBuilder &removeAttribute(StringRef A);
 585
 586   /// \brief Add the attributes from the builder.
 587   AttrBuilder &merge(const AttrBuilder &B);
 588
 589   /// \brief Remove the attributes from the builder.
 590   AttrBuilder &remove(const AttrBuilder &B);
 591
 592   /// \brief Return true if the builder has any attribute that's in the
 593   /// specified builder.
 594   bool overlaps(const AttrBuilder &B) const;
 595
 596   /// \brief Return true if the builder has the specified attribute.
 597   bool contains(Attribute::AttrKind A) const {
 598     assert((unsigned)A < Attribute::EndAttrKinds && "Attribute out of range!");
 599     return Attrs[A];
 600   }
 601
 602   /// \brief Return true if the builder has the specified target-dependent
 603   /// attribute.
 604   bool contains(StringRef A) const;
 605
 606   /// \brief Return true if the builder has IR-level attributes.
 607   bool hasAttributes() const;
 608
 609   /// \brief Return true if the builder has any attribute that's in the
 610   /// specified attribute.
 611   bool hasAttributes(AttributeList A, uint64_t Index) const;
 612
 613   /// \brief Return true if the builder has an alignment attribute.
 614   bool hasAlignmentAttr() const;
 615
 616   /// \brief Retrieve the alignment attribute, if it exists.
 617   uint64_t getAlignment() const { return Alignment; }
 618
 619   /// \brief Retrieve the stack alignment attribute, if it exists.
 620   uint64_t getStackAlignment() const { return StackAlignment; }
 621
 622   /// \brief Retrieve the number of dereferenceable bytes, if the
 623   /// dereferenceable attribute exists (zero is returned otherwise).
 624   uint64_t getDereferenceableBytes() const { return DerefBytes; }
 625
 626   /// \brief Retrieve the number of dereferenceable_or_null bytes, if the
 627   /// dereferenceable_or_null attribute exists (zero is returned otherwise).
 628   uint64_t getDereferenceableOrNullBytes() const { return DerefOrNullBytes; }
 629
 630   /// Retrieve the allocsize args, if the allocsize attribute exists.  If it
 631   /// doesn't exist, pair(0, 0) is returned.
 632   std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() const;
 633
 634   /// \brief This turns an int alignment (which must be a power of 2) into the
 635   /// form used internally in Attribute.
 636   AttrBuilder &addAlignmentAttr(unsigned Align);
 637
 638   /// \brief This turns an int stack alignment (which must be a power of 2) into
 639   /// the form used internally in Attribute.
 640   AttrBuilder &addStackAlignmentAttr(unsigned Align);
 641
 642   /// \brief This turns the number of dereferenceable bytes into the form used
 643   /// internally in Attribute.
 644   AttrBuilder &addDereferenceableAttr(uint64_t Bytes);
 645
 646   /// \brief This turns the number of dereferenceable_or_null bytes into the
 647   /// form used internally in Attribute.
 648   AttrBuilder &addDereferenceableOrNullAttr(uint64_t Bytes);
 649
 650   /// This turns one (or two) ints into the form used internally in Attribute.
 651   AttrBuilder &addAllocSizeAttr(unsigned ElemSizeArg,
 652                                 const Optional<unsigned> &NumElemsArg);
 653
 654   /// Add an allocsize attribute, using the representation returned by
 655   /// Attribute.getIntValue().
 656   AttrBuilder &addAllocSizeAttrFromRawRepr(uint64_t RawAllocSizeRepr);
 657
 658   /// \brief Return true if the builder contains no target-independent
 659   /// attributes.
 660   bool empty() const { return Attrs.none(); }
 661
 662   // Iterators for target-dependent attributes.
 663   typedef std::pair<std::string, std::string>                td_type;
 664   typedef std::map<std::string, std::string>::iterator       td_iterator;
 665   typedef std::map<std::string, std::string>::const_iterator td_const_iterator;
 666   typedef iterator_range<td_iterator>                        td_range;
 667   typedef iterator_range<td_const_iterator>                  td_const_range;
 668
 669   td_iterator td_begin()             { return TargetDepAttrs.begin(); }
 670   td_iterator td_end()               { return TargetDepAttrs.end(); }
 671
 672   td_const_iterator td_begin() const { return TargetDepAttrs.begin(); }
 673   td_const_iterator td_end() const   { return TargetDepAttrs.end(); }
 674
 675   td_range td_attrs() { return td_range(td_begin(), td_end()); }
 676   td_const_range td_attrs() const {
 677     return td_const_range(td_begin(), td_end());
 678   }
 679
 680   bool td_empty() const              { return TargetDepAttrs.empty(); }
 681
 682   bool operator==(const AttrBuilder &B);
 683   bool operator!=(const AttrBuilder &B) {
 684     return !(*this == B);
 685   }
 686 };
 687
 688 namespace AttributeFuncs {
 689
 690 /// \brief Which attributes cannot be applied to a type.
 691 AttrBuilder typeIncompatible(Type *Ty);
 692
 693 /// \returns Return true if the two functions have compatible target-independent
 694 /// attributes for inlining purposes.
 695 bool areInlineCompatible(const Function &Caller, const Function &Callee);
 696
 697 /// \brief Merge caller's and callee's attributes.
 698 void mergeAttributesForInlining(Function &Caller, const Function &Callee);
 699
 700 } // end AttributeFuncs namespace
 701
 702 } // end llvm namespace
 703
 704 #endif // LLVM_IR_ATTRIBUTES_H