Subversion Repositories QNX 8.QNX8 LLVM/Clang compiler suite

//===- llvm/Attributes.h - Container for Attributes -------------*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

//

/// \file

/// This file contains the simple types necessary to represent the

/// attributes associated with functions and their calls.

//

//===----------------------------------------------------------------------===//

#ifndef LLVM_IR_ATTRIBUTES_H

#define LLVM_IR_ATTRIBUTES_H

#include "llvm-c/Types.h"

#include "llvm/ADT/ArrayRef.h"

#include "llvm/ADT/BitmaskEnum.h"

#include "llvm/ADT/SmallString.h"

#include "llvm/ADT/StringRef.h"

#include "llvm/Config/llvm-config.h"

#include "llvm/Support/Alignment.h"

#include "llvm/Support/CodeGen.h"

#include "llvm/Support/PointerLikeTypeTraits.h"

#include <bitset>

#include <cassert>

#include <cstdint>

#include <optional>

#include <set>

#include <string>

#include <utility>

namespace llvm {

class AttrBuilder;

class AttributeMask;

class AttributeImpl;

class AttributeListImpl;

class AttributeSetNode;

class FoldingSetNodeID;

class Function;

class LLVMContext;

class MemoryEffects;

class Type;

class raw_ostream;

enum class AllocFnKind : uint64_t {

  Unknown = 0,

  Alloc = 1 << 0,         // Allocator function returns a new allocation

  Realloc = 1 << 1,       // Allocator function resizes the `allocptr` argument

  Free = 1 << 2,          // Allocator function frees the `allocptr` argument

  Uninitialized = 1 << 3, // Allocator function returns uninitialized memory

  Zeroed = 1 << 4,        // Allocator function returns zeroed memory

  Aligned = 1 << 5,       // Allocator function aligns allocations per the

                          // `allocalign` argument

  LLVM_MARK_AS_BITMASK_ENUM(/* LargestValue = */ Aligned)

};

//===----------------------------------------------------------------------===//

/// \class

/// Functions, function parameters, and return types can have attributes

/// to indicate how they should be treated by optimizations and code

/// generation. This class represents one of those attributes. It's light-weight

/// and should be passed around by-value.

class Attribute {

public:

  /// This enumeration lists the attributes that can be associated with

  /// parameters, function results, or the function itself.

  ///

  /// Note: The `uwtable' attribute is about the ABI or the user mandating an

  /// entry in the unwind table. The `nounwind' attribute is about an exception

  /// passing by the function.

  ///

  /// In a theoretical system that uses tables for profiling and SjLj for

  /// exceptions, they would be fully independent. In a normal system that uses

  /// tables for both, the semantics are:

  ///

  /// nil                = Needs an entry because an exception might pass by.

  /// nounwind           = No need for an entry

  /// uwtable            = Needs an entry because the ABI says so and because

  ///                      an exception might pass by.

  /// uwtable + nounwind = Needs an entry because the ABI says so.

  enum AttrKind {

    // IR-Level Attributes

    None,                  ///< No attributes have been set

    #define GET_ATTR_ENUM

    #include "llvm/IR/Attributes.inc"

    EndAttrKinds,          ///< Sentinal value useful for loops

    EmptyKey,              ///< Use as Empty key for DenseMap of AttrKind

    TombstoneKey,          ///< Use as Tombstone key for DenseMap of AttrKind

  };

  static const unsigned NumIntAttrKinds = LastIntAttr - FirstIntAttr + 1;

  static const unsigned NumTypeAttrKinds = LastTypeAttr - FirstTypeAttr + 1;

  static bool isEnumAttrKind(AttrKind Kind) {

    return Kind >= FirstEnumAttr && Kind <= LastEnumAttr;

  }

  static bool isIntAttrKind(AttrKind Kind) {

    return Kind >= FirstIntAttr && Kind <= LastIntAttr;

  }

  static bool isTypeAttrKind(AttrKind Kind) {

    return Kind >= FirstTypeAttr && Kind <= LastTypeAttr;

  }

  static bool canUseAsFnAttr(AttrKind Kind);

  static bool canUseAsParamAttr(AttrKind Kind);

  static bool canUseAsRetAttr(AttrKind Kind);

private:

  AttributeImpl *pImpl = nullptr;

  Attribute(AttributeImpl *A) : pImpl(A) {}

public:

  Attribute() = default;

  //===--------------------------------------------------------------------===//

  // Attribute Construction

  //===--------------------------------------------------------------------===//

  /// Return a uniquified Attribute object.

  static Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val = 0);

  static Attribute get(LLVMContext &Context, StringRef Kind,

                       StringRef Val = StringRef());

  static Attribute get(LLVMContext &Context, AttrKind Kind, Type *Ty);

  /// Return a uniquified Attribute object that has the specific

  /// alignment set.

  static Attribute getWithAlignment(LLVMContext &Context, Align Alignment);

  static Attribute getWithStackAlignment(LLVMContext &Context, Align Alignment);

  static Attribute getWithDereferenceableBytes(LLVMContext &Context,

                                              uint64_t Bytes);

  static Attribute getWithDereferenceableOrNullBytes(LLVMContext &Context,

                                                     uint64_t Bytes);

  static Attribute getWithAllocSizeArgs(

      LLVMContext &Context, unsigned ElemSizeArg,

      const std::optional<unsigned> &NumElemsArg);

  static Attribute getWithVScaleRangeArgs(LLVMContext &Context,

                                          unsigned MinValue, unsigned MaxValue);

  static Attribute getWithByValType(LLVMContext &Context, Type *Ty);

  static Attribute getWithStructRetType(LLVMContext &Context, Type *Ty);

  static Attribute getWithByRefType(LLVMContext &Context, Type *Ty);

  static Attribute getWithPreallocatedType(LLVMContext &Context, Type *Ty);

  static Attribute getWithInAllocaType(LLVMContext &Context, Type *Ty);

  static Attribute getWithUWTableKind(LLVMContext &Context, UWTableKind Kind);

  static Attribute getWithMemoryEffects(LLVMContext &Context, MemoryEffects ME);

  /// For a typed attribute, return the equivalent attribute with the type

  /// changed to \p ReplacementTy.

  Attribute getWithNewType(LLVMContext &Context, Type *ReplacementTy) {

    assert(isTypeAttribute() && "this requires a typed attribute");

    return get(Context, getKindAsEnum(), ReplacementTy);

  }

  static Attribute::AttrKind getAttrKindFromName(StringRef AttrName);

  static StringRef getNameFromAttrKind(Attribute::AttrKind AttrKind);

  /// Return true if the provided string matches the IR name of an attribute.

  /// example: "noalias" return true but not "NoAlias"

  static bool isExistingAttribute(StringRef Name);

  //===--------------------------------------------------------------------===//

  // Attribute Accessors

  //===--------------------------------------------------------------------===//

  /// Return true if the attribute is an Attribute::AttrKind type.

  bool isEnumAttribute() const;

  /// Return true if the attribute is an integer attribute.

  bool isIntAttribute() const;

  /// Return true if the attribute is a string (target-dependent)

  /// attribute.

  bool isStringAttribute() const;

  /// Return true if the attribute is a type attribute.

  bool isTypeAttribute() const;

  /// Return true if the attribute is any kind of attribute.

  bool isValid() const { return pImpl; }

  /// Return true if the attribute is present.

  bool hasAttribute(AttrKind Val) const;

  /// Return true if the target-dependent attribute is present.

  bool hasAttribute(StringRef Val) const;

  /// Return the attribute's kind as an enum (Attribute::AttrKind). This

  /// requires the attribute to be an enum, integer, or type attribute.

  Attribute::AttrKind getKindAsEnum() const;

  /// Return the attribute's value as an integer. This requires that the

  /// attribute be an integer attribute.

  uint64_t getValueAsInt() const;

  /// Return the attribute's value as a boolean. This requires that the

  /// attribute be a string attribute.

  bool getValueAsBool() const;

  /// Return the attribute's kind as a string. This requires the

  /// attribute to be a string attribute.

  StringRef getKindAsString() const;

  /// Return the attribute's value as a string. This requires the

  /// attribute to be a string attribute.

  StringRef getValueAsString() const;

  /// Return the attribute's value as a Type. This requires the attribute to be

  /// a type attribute.

  Type *getValueAsType() const;

  /// Returns the alignment field of an attribute as a byte alignment

  /// value.

  MaybeAlign getAlignment() const;

  /// Returns the stack alignment field of an attribute as a byte

  /// alignment value.

  MaybeAlign getStackAlignment() const;

  /// Returns the number of dereferenceable bytes from the

  /// dereferenceable attribute.

  uint64_t getDereferenceableBytes() const;

  /// Returns the number of dereferenceable_or_null bytes from the

  /// dereferenceable_or_null attribute.

  uint64_t getDereferenceableOrNullBytes() const;

  /// Returns the argument numbers for the allocsize attribute.

  std::pair<unsigned, std::optional<unsigned>> getAllocSizeArgs() const;

  /// Returns the minimum value for the vscale_range attribute.

  unsigned getVScaleRangeMin() const;

  /// Returns the maximum value for the vscale_range attribute or std::nullopt

  /// when unknown.

  std::optional<unsigned> getVScaleRangeMax() const;

  // Returns the unwind table kind.

  UWTableKind getUWTableKind() const;

  // Returns the allocator function kind.

  AllocFnKind getAllocKind() const;

  /// Returns memory effects.

  MemoryEffects getMemoryEffects() const;

  /// The Attribute is converted to a string of equivalent mnemonic. This

  /// is, presumably, for writing out the mnemonics for the assembly writer.

  std::string getAsString(bool InAttrGrp = false) const;

  /// Return true if this attribute belongs to the LLVMContext.

  bool hasParentContext(LLVMContext &C) const;

  /// Equality and non-equality operators.

  bool operator==(Attribute A) const { return pImpl == A.pImpl; }

  bool operator!=(Attribute A) const { return pImpl != A.pImpl; }

  /// Less-than operator. Useful for sorting the attributes list.

  bool operator<(Attribute A) const;

  void Profile(FoldingSetNodeID &ID) const;

  /// Return a raw pointer that uniquely identifies this attribute.

  void *getRawPointer() const {

    return pImpl;

  }

  /// Get an attribute from a raw pointer created by getRawPointer.

  static Attribute fromRawPointer(void *RawPtr) {

    return Attribute(reinterpret_cast<AttributeImpl*>(RawPtr));

  }

};

// Specialized opaque value conversions.

inline LLVMAttributeRef wrap(Attribute Attr) {

  return reinterpret_cast<LLVMAttributeRef>(Attr.getRawPointer());

}

// Specialized opaque value conversions.

inline Attribute unwrap(LLVMAttributeRef Attr) {

  return Attribute::fromRawPointer(Attr);

}

//===----------------------------------------------------------------------===//

/// \class

/// This class holds the attributes for a particular argument, parameter,

/// function, or return value. It is an immutable value type that is cheap to

/// copy. Adding and removing enum attributes is intended to be fast, but adding

/// and removing string or integer attributes involves a FoldingSet lookup.

class AttributeSet {

  friend AttributeListImpl;

  template <typename Ty, typename Enable> friend struct DenseMapInfo;

  // TODO: Extract AvailableAttrs from AttributeSetNode and store them here.

  // This will allow an efficient implementation of addAttribute and

  // removeAttribute for enum attrs.

  /// Private implementation pointer.

  AttributeSetNode *SetNode = nullptr;

private:

  explicit AttributeSet(AttributeSetNode *ASN) : SetNode(ASN) {}

public:

  /// AttributeSet is a trivially copyable value type.

  AttributeSet() = default;

  AttributeSet(const AttributeSet &) = default;

  ~AttributeSet() = default;

  static AttributeSet get(LLVMContext &C, const AttrBuilder &B);

  static AttributeSet get(LLVMContext &C, ArrayRef<Attribute> Attrs);

  bool operator==(const AttributeSet &O) const { return SetNode == O.SetNode; }

  bool operator!=(const AttributeSet &O) const { return !(*this == O); }

  /// Add an argument attribute. Returns a new set because attribute sets are

  /// immutable.

  [[nodiscard]] AttributeSet addAttribute(LLVMContext &C,

                                          Attribute::AttrKind Kind) const;

  /// Add a target-dependent attribute. Returns a new set because attribute sets

  /// are immutable.

  [[nodiscard]] AttributeSet addAttribute(LLVMContext &C, StringRef Kind,

                                          StringRef Value = StringRef()) const;

  /// Add attributes to the attribute set. Returns a new set because attribute

  /// sets are immutable.

  [[nodiscard]] AttributeSet addAttributes(LLVMContext &C,

                                           AttributeSet AS) const;

  /// Remove the specified attribute from this set. Returns a new set because

  /// attribute sets are immutable.

  [[nodiscard]] AttributeSet removeAttribute(LLVMContext &C,

                                             Attribute::AttrKind Kind) const;

  /// Remove the specified attribute from this set. Returns a new set because

  /// attribute sets are immutable.

  [[nodiscard]] AttributeSet removeAttribute(LLVMContext &C,

                                             StringRef Kind) const;

  /// Remove the specified attributes from this set. Returns a new set because

  /// attribute sets are immutable.

  [[nodiscard]] AttributeSet

  removeAttributes(LLVMContext &C, const AttributeMask &AttrsToRemove) const;

  /// Return the number of attributes in this set.

  unsigned getNumAttributes() const;

  /// Return true if attributes exists in this set.

  bool hasAttributes() const { return SetNode != nullptr; }

  /// Return true if the attribute exists in this set.

  bool hasAttribute(Attribute::AttrKind Kind) const;

  /// Return true if the attribute exists in this set.

  bool hasAttribute(StringRef Kind) const;

  /// Return the attribute object.

  Attribute getAttribute(Attribute::AttrKind Kind) const;

  /// Return the target-dependent attribute object.

  Attribute getAttribute(StringRef Kind) const;

  MaybeAlign getAlignment() const;

  MaybeAlign getStackAlignment() const;

  uint64_t getDereferenceableBytes() const;

  uint64_t getDereferenceableOrNullBytes() const;

  Type *getByValType() const;

  Type *getStructRetType() const;

  Type *getByRefType() const;

  Type *getPreallocatedType() const;

  Type *getInAllocaType() const;

  Type *getElementType() const;

  std::optional<std::pair<unsigned, std::optional<unsigned>>> getAllocSizeArgs()

      const;

  unsigned getVScaleRangeMin() const;

  std::optional<unsigned> getVScaleRangeMax() const;

  UWTableKind getUWTableKind() const;

  AllocFnKind getAllocKind() const;

  MemoryEffects getMemoryEffects() const;

  std::string getAsString(bool InAttrGrp = false) const;

  /// Return true if this attribute set belongs to the LLVMContext.

  bool hasParentContext(LLVMContext &C) const;

  using iterator = const Attribute *;

  iterator begin() const;

  iterator end() const;

#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)

  void dump() const;

#endif

};

//===----------------------------------------------------------------------===//

/// \class

/// Provide DenseMapInfo for AttributeSet.

template <> struct DenseMapInfo<AttributeSet, void> {

  static AttributeSet getEmptyKey() {

    auto Val = static_cast<uintptr_t>(-1);

    Val <<= PointerLikeTypeTraits<void *>::NumLowBitsAvailable;

    return AttributeSet(reinterpret_cast<AttributeSetNode *>(Val));

  }

  static AttributeSet getTombstoneKey() {

    auto Val = static_cast<uintptr_t>(-2);

    Val <<= PointerLikeTypeTraits<void *>::NumLowBitsAvailable;

    return AttributeSet(reinterpret_cast<AttributeSetNode *>(Val));

  }

  static unsigned getHashValue(AttributeSet AS) {

    return (unsigned((uintptr_t)AS.SetNode) >> 4) ^

           (unsigned((uintptr_t)AS.SetNode) >> 9);

  }

  static bool isEqual(AttributeSet LHS, AttributeSet RHS) { return LHS == RHS; }

};

//===----------------------------------------------------------------------===//

/// \class

/// This class holds the attributes for a function, its return value, and

/// its parameters. You access the attributes for each of them via an index into

/// the AttributeList object. The function attributes are at index

/// `AttributeList::FunctionIndex', the return value is at index

/// `AttributeList::ReturnIndex', and the attributes for the parameters start at

/// index `AttributeList::FirstArgIndex'.

class AttributeList {

public:

  enum AttrIndex : unsigned {

    ReturnIndex = 0U,

    FunctionIndex = ~0U,

    FirstArgIndex = 1,

  };

private:

  friend class AttrBuilder;

  friend class AttributeListImpl;

  friend class AttributeSet;

  friend class AttributeSetNode;

  template <typename Ty, typename Enable> friend struct DenseMapInfo;

  /// The attributes that we are managing. This can be null to represent

  /// the empty attributes list.

  AttributeListImpl *pImpl = nullptr;

public:

  /// Create an AttributeList with the specified parameters in it.

  static AttributeList get(LLVMContext &C,

                           ArrayRef<std::pair<unsigned, Attribute>> Attrs);

  static AttributeList get(LLVMContext &C,

                           ArrayRef<std::pair<unsigned, AttributeSet>> Attrs);

  /// Create an AttributeList from attribute sets for a function, its

  /// return value, and all of its arguments.

  static AttributeList get(LLVMContext &C, AttributeSet FnAttrs,

                           AttributeSet RetAttrs,

                           ArrayRef<AttributeSet> ArgAttrs);

private:

  explicit AttributeList(AttributeListImpl *LI) : pImpl(LI) {}

  static AttributeList getImpl(LLVMContext &C, ArrayRef<AttributeSet> AttrSets);

  AttributeList setAttributesAtIndex(LLVMContext &C, unsigned Index,

                                     AttributeSet Attrs) const;

public:

  AttributeList() = default;

  //===--------------------------------------------------------------------===//

  // AttributeList Construction and Mutation

  //===--------------------------------------------------------------------===//

  /// Return an AttributeList with the specified parameters in it.

  static AttributeList get(LLVMContext &C, ArrayRef<AttributeList> Attrs);

  static AttributeList get(LLVMContext &C, unsigned Index,

                           ArrayRef<Attribute::AttrKind> Kinds);

  static AttributeList get(LLVMContext &C, unsigned Index,

                           ArrayRef<Attribute::AttrKind> Kinds,

                           ArrayRef<uint64_t> Values);

  static AttributeList get(LLVMContext &C, unsigned Index,

                           ArrayRef<StringRef> Kind);

  static AttributeList get(LLVMContext &C, unsigned Index,

                           AttributeSet Attrs);

  static AttributeList get(LLVMContext &C, unsigned Index,

                           const AttrBuilder &B);

  // TODO: remove non-AtIndex versions of these methods.

  /// Add an attribute to the attribute set at the given index.

  /// Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  addAttributeAtIndex(LLVMContext &C, unsigned Index,

                      Attribute::AttrKind Kind) const;

  /// Add an attribute to the attribute set at the given index.

  /// Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  addAttributeAtIndex(LLVMContext &C, unsigned Index, StringRef Kind,

                      StringRef Value = StringRef()) const;

  /// Add an attribute to the attribute set at the given index.

  /// Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  addAttributeAtIndex(LLVMContext &C, unsigned Index, Attribute A) const;

  /// Add attributes to the attribute set at the given index.

  /// Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList addAttributesAtIndex(LLVMContext &C,

                                                   unsigned Index,

                                                   const AttrBuilder &B) const;

  /// Add a function attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addFnAttribute(LLVMContext &C,

                                             Attribute::AttrKind Kind) const {

    return addAttributeAtIndex(C, FunctionIndex, Kind);

  }

  /// Add a function attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addFnAttribute(LLVMContext &C,

                                             Attribute Attr) const {

    return addAttributeAtIndex(C, FunctionIndex, Attr);

  }

  /// Add a function attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList

  addFnAttribute(LLVMContext &C, StringRef Kind,

                 StringRef Value = StringRef()) const {

    return addAttributeAtIndex(C, FunctionIndex, Kind, Value);

  }

  /// Add function attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addFnAttributes(LLVMContext &C,

                                              const AttrBuilder &B) const {

    return addAttributesAtIndex(C, FunctionIndex, B);

  }

  /// Add a return value attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addRetAttribute(LLVMContext &C,

                                              Attribute::AttrKind Kind) const {

    return addAttributeAtIndex(C, ReturnIndex, Kind);

  }

  /// Add a return value attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addRetAttribute(LLVMContext &C,

                                              Attribute Attr) const {

    return addAttributeAtIndex(C, ReturnIndex, Attr);

  }

  /// Add a return value attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addRetAttributes(LLVMContext &C,

                                               const AttrBuilder &B) const {

    return addAttributesAtIndex(C, ReturnIndex, B);

  }

  /// Add an argument attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList

  addParamAttribute(LLVMContext &C, unsigned ArgNo,

                    Attribute::AttrKind Kind) const {

    return addAttributeAtIndex(C, ArgNo + FirstArgIndex, Kind);

  }

  /// Add an argument attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList

  addParamAttribute(LLVMContext &C, unsigned ArgNo, StringRef Kind,

                    StringRef Value = StringRef()) const {

    return addAttributeAtIndex(C, ArgNo + FirstArgIndex, Kind, Value);

  }

  /// Add an attribute to the attribute list at the given arg indices. Returns a

  /// new list because attribute lists are immutable.

  [[nodiscard]] AttributeList addParamAttribute(LLVMContext &C,

                                                ArrayRef<unsigned> ArgNos,

                                                Attribute A) const;

  /// Add an argument attribute to the list. Returns a new list because

  /// attribute lists are immutable.

  [[nodiscard]] AttributeList addParamAttributes(LLVMContext &C, unsigned ArgNo,

                                                 const AttrBuilder &B) const {

    return addAttributesAtIndex(C, ArgNo + FirstArgIndex, B);

  }

  /// Remove the specified attribute at the specified index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeAttributeAtIndex(LLVMContext &C, unsigned Index,

                         Attribute::AttrKind Kind) const;

  /// Remove the specified attribute at the specified index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeAttributeAtIndex(LLVMContext &C, unsigned Index, StringRef Kind) const;

  [[nodiscard]] AttributeList removeAttribute(LLVMContext &C, unsigned Index,

                                              StringRef Kind) const {

    return removeAttributeAtIndex(C, Index, Kind);

  }

  /// Remove the specified attributes at the specified index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeAttributesAtIndex(LLVMContext &C, unsigned Index,

                          const AttributeMask &AttrsToRemove) const;

  /// Remove all attributes at the specified index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList removeAttributesAtIndex(LLVMContext &C,

                                                      unsigned Index) const;

  /// Remove the specified attribute at the function index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeFnAttribute(LLVMContext &C, Attribute::AttrKind Kind) const {

    return removeAttributeAtIndex(C, FunctionIndex, Kind);

  }

  /// Remove the specified attribute at the function index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList removeFnAttribute(LLVMContext &C,

                                                StringRef Kind) const {

    return removeAttributeAtIndex(C, FunctionIndex, Kind);

  }

  /// Remove the specified attribute at the function index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeFnAttributes(LLVMContext &C, const AttributeMask &AttrsToRemove) const {

    return removeAttributesAtIndex(C, FunctionIndex, AttrsToRemove);

  }

  /// Remove the attributes at the function index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList removeFnAttributes(LLVMContext &C) const {

    return removeAttributesAtIndex(C, FunctionIndex);

  }

  /// Remove the specified attribute at the return value index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeRetAttribute(LLVMContext &C, Attribute::AttrKind Kind) const {

    return removeAttributeAtIndex(C, ReturnIndex, Kind);

  }

  /// Remove the specified attribute at the return value index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList removeRetAttribute(LLVMContext &C,

                                                 StringRef Kind) const {

    return removeAttributeAtIndex(C, ReturnIndex, Kind);

  }

  /// Remove the specified attribute at the return value index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeRetAttributes(LLVMContext &C,

                      const AttributeMask &AttrsToRemove) const {

    return removeAttributesAtIndex(C, ReturnIndex, AttrsToRemove);

  }

  /// Remove the specified attribute at the specified arg index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeParamAttribute(LLVMContext &C, unsigned ArgNo,

                       Attribute::AttrKind Kind) const {

    return removeAttributeAtIndex(C, ArgNo + FirstArgIndex, Kind);

  }

  /// Remove the specified attribute at the specified arg index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeParamAttribute(LLVMContext &C, unsigned ArgNo, StringRef Kind) const {

    return removeAttributeAtIndex(C, ArgNo + FirstArgIndex, Kind);

  }

  /// Remove the specified attribute at the specified arg index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  removeParamAttributes(LLVMContext &C, unsigned ArgNo,

                        const AttributeMask &AttrsToRemove) const {

    return removeAttributesAtIndex(C, ArgNo + FirstArgIndex, AttrsToRemove);

  }

  /// Remove all attributes at the specified arg index from this

  /// attribute list. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList removeParamAttributes(LLVMContext &C,

                                                    unsigned ArgNo) const {

    return removeAttributesAtIndex(C, ArgNo + FirstArgIndex);

  }

  /// Replace the type contained by attribute \p AttrKind at index \p ArgNo wih

  /// \p ReplacementTy, preserving all other attributes.

  [[nodiscard]] AttributeList

  replaceAttributeTypeAtIndex(LLVMContext &C, unsigned ArgNo,

                              Attribute::AttrKind Kind,

                              Type *ReplacementTy) const {

    Attribute Attr = getAttributeAtIndex(ArgNo, Kind);

    auto Attrs = removeAttributeAtIndex(C, ArgNo, Kind);

    return Attrs.addAttributeAtIndex(C, ArgNo,

                                     Attr.getWithNewType(C, ReplacementTy));

  }

  /// \brief Add the dereferenceable attribute to the attribute set at the given

  /// index. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList addDereferenceableRetAttr(LLVMContext &C,

                                                        uint64_t Bytes) const;

  /// \brief Add the dereferenceable attribute to the attribute set at the given

  /// arg index. Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList addDereferenceableParamAttr(LLVMContext &C,

                                                          unsigned ArgNo,

                                                          uint64_t Bytes) const;

  /// Add the dereferenceable_or_null attribute to the attribute set at

  /// the given arg index. Returns a new list because attribute lists are

  /// immutable.

  [[nodiscard]] AttributeList

  addDereferenceableOrNullParamAttr(LLVMContext &C, unsigned ArgNo,

                                    uint64_t Bytes) const;

  /// Add the allocsize attribute to the attribute set at the given arg index.

  /// Returns a new list because attribute lists are immutable.

  [[nodiscard]] AttributeList

  addAllocSizeParamAttr(LLVMContext &C, unsigned ArgNo, unsigned ElemSizeArg,

                        const std::optional<unsigned> &NumElemsArg);

  //===--------------------------------------------------------------------===//

  // AttributeList Accessors

  //===--------------------------------------------------------------------===//

  /// The attributes for the specified index are returned.

  AttributeSet getAttributes(unsigned Index) const;

  /// The attributes for the argument or parameter at the given index are

  /// returned.

  AttributeSet getParamAttrs(unsigned ArgNo) const;

  /// The attributes for the ret value are returned.

  AttributeSet getRetAttrs() const;

  /// The function attributes are returned.

  AttributeSet getFnAttrs() const;

  /// Return true if the attribute exists at the given index.

  bool hasAttributeAtIndex(unsigned Index, Attribute::AttrKind Kind) const;

  /// Return true if the attribute exists at the given index.

  bool hasAttributeAtIndex(unsigned Index, StringRef Kind) const;

  /// Return true if attribute exists at the given index.

  bool hasAttributesAtIndex(unsigned Index) const;

  /// Return true if the attribute exists for the given argument

  bool hasParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) const {

    return hasAttributeAtIndex(ArgNo + FirstArgIndex, Kind);

  }

  /// Return true if the attribute exists for the given argument

  bool hasParamAttr(unsigned ArgNo, StringRef Kind) const {

    return hasAttributeAtIndex(ArgNo + FirstArgIndex, Kind);

  }

  /// Return true if attributes exists for the given argument

  bool hasParamAttrs(unsigned ArgNo) const {

    return hasAttributesAtIndex(ArgNo + FirstArgIndex);

  }

  /// Return true if the attribute exists for the return value.

  bool hasRetAttr(Attribute::AttrKind Kind) const {

    return hasAttributeAtIndex(ReturnIndex, Kind);

  }

  /// Return true if the attribute exists for the return value.

  bool hasRetAttr(StringRef Kind) const {

    return hasAttributeAtIndex(ReturnIndex, Kind);

  }

  /// Return true if attributes exist for the return value.

  bool hasRetAttrs() const { return hasAttributesAtIndex(ReturnIndex); }

  /// Return true if the attribute exists for the function.

  bool hasFnAttr(Attribute::AttrKind Kind) const;

  /// Return true if the attribute exists for the function.

  bool hasFnAttr(StringRef Kind) const;

  /// Return true the attributes exist for the function.

  bool hasFnAttrs() const { return hasAttributesAtIndex(FunctionIndex); }

  /// Return true if the specified attribute is set for at least one

  /// parameter or for the return value. If Index is not nullptr, the index

  /// of a parameter with the specified attribute is provided.

  bool hasAttrSomewhere(Attribute::AttrKind Kind,

                        unsigned *Index = nullptr) const;

  /// Return the attribute object that exists at the given index.

  Attribute getAttributeAtIndex(unsigned Index, Attribute::AttrKind Kind) const;

  /// Return the attribute object that exists at the given index.

  Attribute getAttributeAtIndex(unsigned Index, StringRef Kind) const;

  /// Return the attribute object that exists at the arg index.

  Attribute getParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) const {

    return getAttributeAtIndex(ArgNo + FirstArgIndex, Kind);

  }

  /// Return the attribute object that exists at the given index.

  Attribute getParamAttr(unsigned ArgNo, StringRef Kind) const {

    return getAttributeAtIndex(ArgNo + FirstArgIndex, Kind);

  }

  /// Return the attribute object that exists for the function.

  Attribute getFnAttr(Attribute::AttrKind Kind) const {

    return getAttributeAtIndex(FunctionIndex, Kind);

  }

  /// Return the attribute object that exists for the function.

  Attribute getFnAttr(StringRef Kind) const {

    return getAttributeAtIndex(FunctionIndex, Kind);