123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990 |
- #pragma once
- #ifdef __GNUC__
- #pragma GCC diagnostic push
- #pragma GCC diagnostic ignored "-Wunused-parameter"
- #endif
- //===- 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/Optional.h"
- #include "llvm/ADT/StringRef.h"
- #include "llvm/ADT/iterator_range.h"
- #include "llvm/Config/llvm-config.h"
- #include "llvm/Support/Alignment.h"
- #include "llvm/Support/PointerLikeTypeTraits.h"
- #include <bitset>
- #include <cassert>
- #include <cstdint>
- #include <map>
- #include <string>
- #include <utility>
- namespace llvm {
- class AttrBuilder;
- class AttributeImpl;
- class AttributeListImpl;
- class AttributeSetNode;
- template<typename T> struct DenseMapInfo;
- class FoldingSetNodeID;
- class Function;
- class LLVMContext;
- class Type;
- //===----------------------------------------------------------------------===//
- /// \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_NAMES
- #define ATTRIBUTE_ENUM(ENUM_NAME, OTHER) ENUM_NAME,
- #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
- };
- 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 Optional<unsigned> &NumElemsArg);
- 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);
- /// 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 and only if the attribute has an Argument.
- static bool doesAttrKindHaveArgument(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 or integer 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 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 (or pair(0, 0)
- /// if not known).
- std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() 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;
- /// 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> 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.
- LLVM_NODISCARD AttributeSet addAttribute(LLVMContext &C,
- Attribute::AttrKind Kind) const;
- /// Add a target-dependent attribute. Returns a new set because attribute sets
- /// are immutable.
- LLVM_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.
- LLVM_NODISCARD AttributeSet addAttributes(LLVMContext &C,
- AttributeSet AS) const;
- /// Remove the specified attribute from this set. Returns a new set because
- /// attribute sets are immutable.
- LLVM_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.
- LLVM_NODISCARD AttributeSet removeAttribute(LLVMContext &C,
- StringRef Kind) const;
- /// Remove the specified attributes from this set. Returns a new set because
- /// attribute sets are immutable.
- LLVM_NODISCARD AttributeSet
- removeAttributes(LLVMContext &C, const AttrBuilder &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;
- std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() const;
- std::string getAsString(bool InAttrGrp = false) 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> {
- 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> 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 setAttributes(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,
- const AttrBuilder &B);
- /// Add an attribute to the attribute set at the given index.
- /// Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList addAttribute(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.
- LLVM_NODISCARD AttributeList
- addAttribute(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.
- LLVM_NODISCARD AttributeList addAttribute(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.
- LLVM_NODISCARD AttributeList addAttributes(LLVMContext &C, unsigned Index,
- const AttrBuilder &B) const;
- /// Add an argument attribute to the list. Returns a new list because
- /// attribute lists are immutable.
- LLVM_NODISCARD AttributeList addParamAttribute(
- LLVMContext &C, unsigned ArgNo, Attribute::AttrKind Kind) const {
- return addAttribute(C, ArgNo + FirstArgIndex, Kind);
- }
- /// Add an argument attribute to the list. Returns a new list because
- /// attribute lists are immutable.
- LLVM_NODISCARD AttributeList
- addParamAttribute(LLVMContext &C, unsigned ArgNo, StringRef Kind,
- StringRef Value = StringRef()) const {
- return addAttribute(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.
- LLVM_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.
- LLVM_NODISCARD AttributeList addParamAttributes(LLVMContext &C,
- unsigned ArgNo,
- const AttrBuilder &B) const {
- return addAttributes(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.
- LLVM_NODISCARD AttributeList removeAttribute(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.
- LLVM_NODISCARD AttributeList removeAttribute(LLVMContext &C, unsigned Index,
- StringRef Kind) const;
- /// Remove the specified attributes at the specified index from this
- /// attribute list. Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList removeAttributes(
- LLVMContext &C, unsigned Index, const AttrBuilder &AttrsToRemove) const;
- /// Remove all attributes at the specified index from this
- /// attribute list. Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList removeAttributes(LLVMContext &C,
- unsigned Index) const;
- /// Remove the specified attribute at the specified arg index from this
- /// attribute list. Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList removeParamAttribute(
- LLVMContext &C, unsigned ArgNo, Attribute::AttrKind Kind) const {
- return removeAttribute(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.
- LLVM_NODISCARD AttributeList removeParamAttribute(LLVMContext &C,
- unsigned ArgNo,
- StringRef Kind) const {
- return removeAttribute(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.
- LLVM_NODISCARD AttributeList removeParamAttributes(
- LLVMContext &C, unsigned ArgNo, const AttrBuilder &AttrsToRemove) const {
- return removeAttributes(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.
- LLVM_NODISCARD AttributeList removeParamAttributes(LLVMContext &C,
- unsigned ArgNo) const {
- return removeAttributes(C, ArgNo + FirstArgIndex);
- }
- /// Replace the type contained by attribute \p AttrKind at index \p ArgNo wih
- /// \p ReplacementTy, preserving all other attributes.
- LLVM_NODISCARD AttributeList replaceAttributeType(LLVMContext &C,
- unsigned ArgNo,
- Attribute::AttrKind Kind,
- Type *ReplacementTy) const {
- Attribute Attr = getAttribute(ArgNo, Kind);
- auto Attrs = removeAttribute(C, ArgNo, Kind);
- return Attrs.addAttribute(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.
- LLVM_NODISCARD AttributeList addDereferenceableAttr(LLVMContext &C,
- unsigned Index,
- 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.
- LLVM_NODISCARD AttributeList addDereferenceableParamAttr(
- LLVMContext &C, unsigned ArgNo, uint64_t Bytes) const {
- return addDereferenceableAttr(C, ArgNo + FirstArgIndex, Bytes);
- }
- /// Add the dereferenceable_or_null attribute to the attribute set at
- /// the given index. Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList addDereferenceableOrNullAttr(
- LLVMContext &C, unsigned Index, 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.
- LLVM_NODISCARD AttributeList addDereferenceableOrNullParamAttr(
- LLVMContext &C, unsigned ArgNo, uint64_t Bytes) const {
- return addDereferenceableOrNullAttr(C, ArgNo + FirstArgIndex, Bytes);
- }
- /// Add the allocsize attribute to the attribute set at the given index.
- /// Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList
- addAllocSizeAttr(LLVMContext &C, unsigned Index, unsigned ElemSizeArg,
- const Optional<unsigned> &NumElemsArg);
- /// Add the allocsize attribute to the attribute set at the given arg index.
- /// Returns a new list because attribute lists are immutable.
- LLVM_NODISCARD AttributeList
- addAllocSizeParamAttr(LLVMContext &C, unsigned ArgNo, unsigned ElemSizeArg,
- const Optional<unsigned> &NumElemsArg) {
- return addAllocSizeAttr(C, ArgNo + FirstArgIndex, ElemSizeArg, 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 getParamAttributes(unsigned ArgNo) const;
- /// The attributes for the ret value are returned.
- AttributeSet getRetAttributes() const;
- /// The function attributes are returned.
- AttributeSet getFnAttributes() const;
- /// Return true if the attribute exists at the given index.
- bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const;
- /// Return true if the attribute exists at the given index.
- bool hasAttribute(unsigned Index, StringRef Kind) const;
- /// Return true if attribute exists at the given index.
- bool hasAttributes(unsigned Index) const;
- /// Return true if the attribute exists for the given argument
- bool hasParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) const {
- return hasAttribute(ArgNo + FirstArgIndex, Kind);
- }
- /// Return true if the attribute exists for the given argument
- bool hasParamAttr(unsigned ArgNo, StringRef Kind) const {
- return hasAttribute(ArgNo + FirstArgIndex, Kind);
- }
- /// Return true if attributes exists for the given argument
- bool hasParamAttrs(unsigned ArgNo) const {
- return hasAttributes(ArgNo + FirstArgIndex);
- }
- /// Equivalent to hasAttribute(AttributeList::FunctionIndex, Kind) but
- /// may be faster.
- bool hasFnAttribute(Attribute::AttrKind Kind) const;
- /// Equivalent to hasAttribute(AttributeList::FunctionIndex, Kind) but
- /// may be faster.
- bool hasFnAttribute(StringRef Kind) const;
- /// Equivalent to hasAttribute(ArgNo + FirstArgIndex, Kind).
- bool hasParamAttribute(unsigned ArgNo, Attribute::AttrKind Kind) const;
- /// 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 getAttribute(unsigned Index, Attribute::AttrKind Kind) const;
- /// Return the attribute object that exists at the given index.
- Attribute getAttribute(unsigned Index, StringRef Kind) const;
- /// Return the attribute object that exists at the arg index.
- Attribute getParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) const {
- return getAttribute(ArgNo + FirstArgIndex, Kind);
- }
- /// Return the attribute object that exists at the given index.
- Attribute getParamAttr(unsigned ArgNo, StringRef Kind) const {
- return getAttribute(ArgNo + FirstArgIndex, Kind);
- }
- /// Return the alignment of the return value.
- MaybeAlign getRetAlignment() const;
- /// Return the alignment for the specified function parameter.
- MaybeAlign getParamAlignment(unsigned ArgNo) const;
- /// Return the byval type for the specified function parameter.
- Type *getParamByValType(unsigned ArgNo) const;
- /// Return the sret type for the specified function parameter.
- Type *getParamStructRetType(unsigned ArgNo) const;
- /// Return the byref type for the specified function parameter.
- Type *getParamByRefType(unsigned ArgNo) const;
- /// Return the preallocated type for the specified function parameter.
- Type *getParamPreallocatedType(unsigned ArgNo) const;
- /// Get the stack alignment.
- MaybeAlign getStackAlignment(unsigned Index) const;
- /// Get the number of dereferenceable bytes (or zero if unknown).
- uint64_t getDereferenceableBytes(unsigned Index) const;
- /// Get the number of dereferenceable bytes (or zero if unknown) of an
- /// arg.
- uint64_t getParamDereferenceableBytes(unsigned ArgNo) const {
- return getDereferenceableBytes(ArgNo + FirstArgIndex);
- }
- /// Get the number of dereferenceable_or_null bytes (or zero if
- /// unknown).
- uint64_t getDereferenceableOrNullBytes(unsigned Index) const;
- /// Get the number of dereferenceable_or_null bytes (or zero if
- /// unknown) of an arg.
- uint64_t getParamDereferenceableOrNullBytes(unsigned ArgNo) const {
- return getDereferenceableOrNullBytes(ArgNo + FirstArgIndex);
- }
- /// Get the allocsize argument numbers (or pair(0, 0) if unknown).
- std::pair<unsigned, Optional<unsigned>>
- getAllocSizeArgs(unsigned Index) const;
- /// Return the attributes at the index as a string.
- std::string getAsString(unsigned Index, bool InAttrGrp = false) const;
- //===--------------------------------------------------------------------===//
- // AttributeList Introspection
- //===--------------------------------------------------------------------===//
- using iterator = const AttributeSet *;
- iterator begin() const;
- iterator end() const;
- unsigned getNumAttrSets() const;
- /// Use these to iterate over the valid attribute indices.
- unsigned index_begin() const { return AttributeList::FunctionIndex; }
- unsigned index_end() const { return getNumAttrSets() - 1; }
- /// operator==/!= - Provide equality predicates.
- bool operator==(const AttributeList &RHS) const { return pImpl == RHS.pImpl; }
- bool operator!=(const AttributeList &RHS) const { return pImpl != RHS.pImpl; }
- /// Return a raw pointer that uniquely identifies this attribute list.
- void *getRawPointer() const {
- return pImpl;
- }
- /// Return true if there are no attributes.
- bool isEmpty() const { return pImpl == nullptr; }
- void dump() const;
- };
- //===----------------------------------------------------------------------===//
- /// \class
- /// Provide DenseMapInfo for AttributeList.
- template <> struct DenseMapInfo<AttributeList> {
- static AttributeList getEmptyKey() {
- auto Val = static_cast<uintptr_t>(-1);
- Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable;
- return AttributeList(reinterpret_cast<AttributeListImpl *>(Val));
- }
- static AttributeList getTombstoneKey() {
- auto Val = static_cast<uintptr_t>(-2);
- Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable;
- return AttributeList(reinterpret_cast<AttributeListImpl *>(Val));
- }
- static unsigned getHashValue(AttributeList AS) {
- return (unsigned((uintptr_t)AS.pImpl) >> 4) ^
- (unsigned((uintptr_t)AS.pImpl) >> 9);
- }
- static bool isEqual(AttributeList LHS, AttributeList RHS) {
- return LHS == RHS;
- }
- };
- //===----------------------------------------------------------------------===//
- /// \class
- /// This class is used in conjunction with the Attribute::get method to
- /// create an Attribute object. The object itself is uniquified. The Builder's
- /// value, however, is not. So this can be used as a quick way to test for
- /// equality, presence of attributes, etc.
- class AttrBuilder {
- std::bitset<Attribute::EndAttrKinds> Attrs;
- std::map<std::string, std::string, std::less<>> TargetDepAttrs;
- MaybeAlign Alignment;
- MaybeAlign StackAlignment;
- uint64_t DerefBytes = 0;
- uint64_t DerefOrNullBytes = 0;
- uint64_t AllocSizeArgs = 0;
- Type *ByValType = nullptr;
- Type *StructRetType = nullptr;
- Type *ByRefType = nullptr;
- Type *PreallocatedType = nullptr;
- public:
- AttrBuilder() = default;
- AttrBuilder(const Attribute &A) {
- addAttribute(A);
- }
- AttrBuilder(AttributeList AS, unsigned Idx);
- AttrBuilder(AttributeSet AS);
- void clear();
- /// Add an attribute to the builder.
- AttrBuilder &addAttribute(Attribute::AttrKind Val) {
- assert((unsigned)Val < Attribute::EndAttrKinds &&
- "Attribute out of range!");
- assert(!Attribute::doesAttrKindHaveArgument(Val) &&
- "Adding integer attribute without adding a value!");
- Attrs[Val] = true;
- return *this;
- }
- /// Add the Attribute object to the builder.
- AttrBuilder &addAttribute(Attribute A);
- /// Add the target-dependent attribute to the builder.
- AttrBuilder &addAttribute(StringRef A, StringRef V = StringRef());
- /// Remove an attribute from the builder.
- AttrBuilder &removeAttribute(Attribute::AttrKind Val);
- /// Remove the attributes from the builder.
- AttrBuilder &removeAttributes(AttributeList A, uint64_t WithoutIndex);
- /// Remove the target-dependent attribute to the builder.
- AttrBuilder &removeAttribute(StringRef A);
- /// Add the attributes from the builder.
- AttrBuilder &merge(const AttrBuilder &B);
- /// Remove the attributes from the builder.
- AttrBuilder &remove(const AttrBuilder &B);
- /// Return true if the builder has any attribute that's in the
- /// specified builder.
- bool overlaps(const AttrBuilder &B) const;
- /// Return true if the builder has the specified attribute.
- bool contains(Attribute::AttrKind A) const {
- assert((unsigned)A < Attribute::EndAttrKinds && "Attribute out of range!");
- return Attrs[A];
- }
- /// Return true if the builder has the specified target-dependent
- /// attribute.
- bool contains(StringRef A) const;
- /// Return true if the builder has IR-level attributes.
- bool hasAttributes() const;
- /// Return true if the builder has any attribute that's in the
- /// specified attribute.
- bool hasAttributes(AttributeList A, uint64_t Index) const;
- /// Return true if the builder has an alignment attribute.
- bool hasAlignmentAttr() const;
- /// Retrieve the alignment attribute, if it exists.
- MaybeAlign getAlignment() const { return Alignment; }
- /// Retrieve the stack alignment attribute, if it exists.
- MaybeAlign getStackAlignment() const { return StackAlignment; }
- /// Retrieve the number of dereferenceable bytes, if the
- /// dereferenceable attribute exists (zero is returned otherwise).
- uint64_t getDereferenceableBytes() const { return DerefBytes; }
- /// Retrieve the number of dereferenceable_or_null bytes, if the
- /// dereferenceable_or_null attribute exists (zero is returned otherwise).
- uint64_t getDereferenceableOrNullBytes() const { return DerefOrNullBytes; }
- /// Retrieve the byval type.
- Type *getByValType() const { return ByValType; }
- /// Retrieve the sret type.
- Type *getStructRetType() const { return StructRetType; }
- /// Retrieve the byref type.
- Type *getByRefType() const { return ByRefType; }
- /// Retrieve the preallocated type.
- Type *getPreallocatedType() const { return PreallocatedType; }
- /// Retrieve the allocsize args, if the allocsize attribute exists. If it
- /// doesn't exist, pair(0, 0) is returned.
- std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() const;
- /// This turns an alignment into the form used internally in Attribute.
- /// This call has no effect if Align is not set.
- AttrBuilder &addAlignmentAttr(MaybeAlign Align);
- /// This turns an int alignment (which must be a power of 2) into the
- /// form used internally in Attribute.
- /// This call has no effect if Align is 0.
- /// Deprecated, use the version using a MaybeAlign.
- inline AttrBuilder &addAlignmentAttr(unsigned Align) {
- return addAlignmentAttr(MaybeAlign(Align));
- }
- /// This turns a stack alignment into the form used internally in Attribute.
- /// This call has no effect if Align is not set.
- AttrBuilder &addStackAlignmentAttr(MaybeAlign Align);
- /// This turns an int stack alignment (which must be a power of 2) into
- /// the form used internally in Attribute.
- /// This call has no effect if Align is 0.
- /// Deprecated, use the version using a MaybeAlign.
- inline AttrBuilder &addStackAlignmentAttr(unsigned Align) {
- return addStackAlignmentAttr(MaybeAlign(Align));
- }
- /// This turns the number of dereferenceable bytes into the form used
- /// internally in Attribute.
- AttrBuilder &addDereferenceableAttr(uint64_t Bytes);
- /// This turns the number of dereferenceable_or_null bytes into the
- /// form used internally in Attribute.
- AttrBuilder &addDereferenceableOrNullAttr(uint64_t Bytes);
- /// This turns one (or two) ints into the form used internally in Attribute.
- AttrBuilder &addAllocSizeAttr(unsigned ElemSizeArg,
- const Optional<unsigned> &NumElemsArg);
- /// This turns a byval type into the form used internally in Attribute.
- AttrBuilder &addByValAttr(Type *Ty);
- /// This turns a sret type into the form used internally in Attribute.
- AttrBuilder &addStructRetAttr(Type *Ty);
- /// This turns a byref type into the form used internally in Attribute.
- AttrBuilder &addByRefAttr(Type *Ty);
- /// This turns a preallocated type into the form used internally in Attribute.
- AttrBuilder &addPreallocatedAttr(Type *Ty);
- /// Add an allocsize attribute, using the representation returned by
- /// Attribute.getIntValue().
- AttrBuilder &addAllocSizeAttrFromRawRepr(uint64_t RawAllocSizeRepr);
- /// Return true if the builder contains no target-independent
- /// attributes.
- bool empty() const { return Attrs.none(); }
- // Iterators for target-dependent attributes.
- using td_type = std::pair<std::string, std::string>;
- using td_iterator = decltype(TargetDepAttrs)::iterator;
- using td_const_iterator = decltype(TargetDepAttrs)::const_iterator;
- using td_range = iterator_range<td_iterator>;
- using td_const_range = iterator_range<td_const_iterator>;
- td_iterator td_begin() { return TargetDepAttrs.begin(); }
- td_iterator td_end() { return TargetDepAttrs.end(); }
- td_const_iterator td_begin() const { return TargetDepAttrs.begin(); }
- td_const_iterator td_end() const { return TargetDepAttrs.end(); }
- td_range td_attrs() { return td_range(td_begin(), td_end()); }
- td_const_range td_attrs() const {
- return td_const_range(td_begin(), td_end());
- }
- bool td_empty() const { return TargetDepAttrs.empty(); }
- bool operator==(const AttrBuilder &B) const;
- bool operator!=(const AttrBuilder &B) const { return !(*this == B); }
- };
- namespace AttributeFuncs {
- /// Which attributes cannot be applied to a type.
- AttrBuilder typeIncompatible(Type *Ty);
- /// \returns Return true if the two functions have compatible target-independent
- /// attributes for inlining purposes.
- bool areInlineCompatible(const Function &Caller, const Function &Callee);
- /// Checks if there are any incompatible function attributes between
- /// \p A and \p B.
- ///
- /// \param [in] A - The first function to be compared with.
- /// \param [in] B - The second function to be compared with.
- /// \returns true if the functions have compatible attributes.
- bool areOutlineCompatible(const Function &A, const Function &B);
- /// Merge caller's and callee's attributes.
- void mergeAttributesForInlining(Function &Caller, const Function &Callee);
- /// Merges the functions attributes from \p ToMerge into function \p Base.
- ///
- /// \param [in,out] Base - The function being merged into.
- /// \param [in] ToMerge - The function to merge attributes from.
- void mergeAttributesForOutlining(Function &Base, const Function &ToMerge);
- } // end namespace AttributeFuncs
- } // end namespace llvm
- #endif // LLVM_IR_ATTRIBUTES_H
- #ifdef __GNUC__
- #pragma GCC diagnostic pop
- #endif
|