259 lines
8.2 KiB
C++
259 lines
8.2 KiB
C++
//===- AttributeImpl.h - Attribute Internals --------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
///
|
|
/// \file
|
|
/// \brief This file defines various helper methods and classes used by
|
|
/// LLVMContextImpl for creating and managing attributes.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_LIB_IR_ATTRIBUTEIMPL_H
|
|
#define LLVM_LIB_IR_ATTRIBUTEIMPL_H
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/FoldingSet.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/IR/Attributes.h"
|
|
#include "llvm/Support/TrailingObjects.h"
|
|
#include <cassert>
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
#include <string>
|
|
#include <utility>
|
|
|
|
namespace llvm {
|
|
|
|
class LLVMContext;
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// \class
|
|
/// \brief This class represents a single, uniqued attribute. That attribute
|
|
/// could be a single enum, a tuple, or a string.
|
|
class AttributeImpl : public FoldingSetNode {
|
|
unsigned char KindID; ///< Holds the AttrEntryKind of the attribute
|
|
|
|
protected:
|
|
enum AttrEntryKind {
|
|
EnumAttrEntry,
|
|
IntAttrEntry,
|
|
StringAttrEntry
|
|
};
|
|
|
|
AttributeImpl(AttrEntryKind KindID) : KindID(KindID) {}
|
|
|
|
public:
|
|
// AttributesImpl is uniqued, these should not be available.
|
|
AttributeImpl(const AttributeImpl &) = delete;
|
|
AttributeImpl &operator=(const AttributeImpl &) = delete;
|
|
|
|
virtual ~AttributeImpl();
|
|
|
|
bool isEnumAttribute() const { return KindID == EnumAttrEntry; }
|
|
bool isIntAttribute() const { return KindID == IntAttrEntry; }
|
|
bool isStringAttribute() const { return KindID == StringAttrEntry; }
|
|
|
|
bool hasAttribute(Attribute::AttrKind A) const;
|
|
bool hasAttribute(StringRef Kind) const;
|
|
|
|
Attribute::AttrKind getKindAsEnum() const;
|
|
uint64_t getValueAsInt() const;
|
|
|
|
StringRef getKindAsString() const;
|
|
StringRef getValueAsString() const;
|
|
|
|
/// \brief Used when sorting the attributes.
|
|
bool operator<(const AttributeImpl &AI) const;
|
|
|
|
void Profile(FoldingSetNodeID &ID) const {
|
|
if (isEnumAttribute())
|
|
Profile(ID, getKindAsEnum(), 0);
|
|
else if (isIntAttribute())
|
|
Profile(ID, getKindAsEnum(), getValueAsInt());
|
|
else
|
|
Profile(ID, getKindAsString(), getValueAsString());
|
|
}
|
|
|
|
static void Profile(FoldingSetNodeID &ID, Attribute::AttrKind Kind,
|
|
uint64_t Val) {
|
|
ID.AddInteger(Kind);
|
|
if (Val) ID.AddInteger(Val);
|
|
}
|
|
|
|
static void Profile(FoldingSetNodeID &ID, StringRef Kind, StringRef Values) {
|
|
ID.AddString(Kind);
|
|
if (!Values.empty()) ID.AddString(Values);
|
|
}
|
|
};
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// \class
|
|
/// \brief A set of classes that contain the value of the
|
|
/// attribute object. There are three main categories: enum attribute entries,
|
|
/// represented by Attribute::AttrKind; alignment attribute entries; and string
|
|
/// attribute enties, which are for target-dependent attributes.
|
|
|
|
class EnumAttributeImpl : public AttributeImpl {
|
|
virtual void anchor();
|
|
Attribute::AttrKind Kind;
|
|
|
|
protected:
|
|
EnumAttributeImpl(AttrEntryKind ID, Attribute::AttrKind Kind)
|
|
: AttributeImpl(ID), Kind(Kind) {}
|
|
|
|
public:
|
|
EnumAttributeImpl(Attribute::AttrKind Kind)
|
|
: AttributeImpl(EnumAttrEntry), Kind(Kind) {}
|
|
|
|
Attribute::AttrKind getEnumKind() const { return Kind; }
|
|
};
|
|
|
|
class IntAttributeImpl : public EnumAttributeImpl {
|
|
uint64_t Val;
|
|
|
|
void anchor() override;
|
|
|
|
public:
|
|
IntAttributeImpl(Attribute::AttrKind Kind, uint64_t Val)
|
|
: EnumAttributeImpl(IntAttrEntry, Kind), Val(Val) {
|
|
assert((Kind == Attribute::Alignment || Kind == Attribute::StackAlignment ||
|
|
Kind == Attribute::Dereferenceable ||
|
|
Kind == Attribute::DereferenceableOrNull ||
|
|
Kind == Attribute::AllocSize) &&
|
|
"Wrong kind for int attribute!");
|
|
}
|
|
|
|
uint64_t getValue() const { return Val; }
|
|
};
|
|
|
|
class StringAttributeImpl : public AttributeImpl {
|
|
virtual void anchor();
|
|
std::string Kind;
|
|
std::string Val;
|
|
|
|
public:
|
|
StringAttributeImpl(StringRef Kind, StringRef Val = StringRef())
|
|
: AttributeImpl(StringAttrEntry), Kind(Kind), Val(Val) {}
|
|
|
|
StringRef getStringKind() const { return Kind; }
|
|
StringRef getStringValue() const { return Val; }
|
|
};
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// \class
|
|
/// \brief This class represents a group of attributes that apply to one
|
|
/// element: function, return type, or parameter.
|
|
class AttributeSetNode final
|
|
: public FoldingSetNode,
|
|
private TrailingObjects<AttributeSetNode, Attribute> {
|
|
friend TrailingObjects;
|
|
|
|
/// Bitset with a bit for each available attribute Attribute::AttrKind.
|
|
uint64_t AvailableAttrs;
|
|
unsigned NumAttrs; ///< Number of attributes in this node.
|
|
|
|
AttributeSetNode(ArrayRef<Attribute> Attrs);
|
|
|
|
public:
|
|
// AttributesSetNode is uniqued, these should not be available.
|
|
AttributeSetNode(const AttributeSetNode &) = delete;
|
|
AttributeSetNode &operator=(const AttributeSetNode &) = delete;
|
|
|
|
void operator delete(void *p) { ::operator delete(p); }
|
|
|
|
static AttributeSetNode *get(LLVMContext &C, const AttrBuilder &B);
|
|
|
|
static AttributeSetNode *get(LLVMContext &C, ArrayRef<Attribute> Attrs);
|
|
|
|
/// \brief Return the number of attributes this AttributeList contains.
|
|
unsigned getNumAttributes() const { return NumAttrs; }
|
|
|
|
bool hasAttribute(Attribute::AttrKind Kind) const {
|
|
return AvailableAttrs & ((uint64_t)1) << Kind;
|
|
}
|
|
bool hasAttribute(StringRef Kind) const;
|
|
bool hasAttributes() const { return NumAttrs != 0; }
|
|
|
|
Attribute getAttribute(Attribute::AttrKind Kind) const;
|
|
Attribute getAttribute(StringRef Kind) const;
|
|
|
|
unsigned getAlignment() const;
|
|
unsigned getStackAlignment() const;
|
|
uint64_t getDereferenceableBytes() const;
|
|
uint64_t getDereferenceableOrNullBytes() const;
|
|
std::pair<unsigned, Optional<unsigned>> getAllocSizeArgs() const;
|
|
std::string getAsString(bool InAttrGrp) const;
|
|
|
|
using iterator = const Attribute *;
|
|
|
|
iterator begin() const { return getTrailingObjects<Attribute>(); }
|
|
iterator end() const { return begin() + NumAttrs; }
|
|
|
|
void Profile(FoldingSetNodeID &ID) const {
|
|
Profile(ID, makeArrayRef(begin(), end()));
|
|
}
|
|
|
|
static void Profile(FoldingSetNodeID &ID, ArrayRef<Attribute> AttrList) {
|
|
for (const auto &Attr : AttrList)
|
|
Attr.Profile(ID);
|
|
}
|
|
};
|
|
|
|
using IndexAttrPair = std::pair<unsigned, AttributeSet>;
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// \class
|
|
/// \brief This class represents a set of attributes that apply to the function,
|
|
/// return type, and parameters.
|
|
class AttributeListImpl final
|
|
: public FoldingSetNode,
|
|
private TrailingObjects<AttributeListImpl, AttributeSet> {
|
|
friend class AttributeList;
|
|
friend TrailingObjects;
|
|
|
|
private:
|
|
/// Bitset with a bit for each available attribute Attribute::AttrKind.
|
|
uint64_t AvailableFunctionAttrs;
|
|
LLVMContext &Context;
|
|
unsigned NumAttrSets; ///< Number of entries in this set.
|
|
|
|
// Helper fn for TrailingObjects class.
|
|
size_t numTrailingObjects(OverloadToken<AttributeSet>) { return NumAttrSets; }
|
|
|
|
public:
|
|
AttributeListImpl(LLVMContext &C, ArrayRef<AttributeSet> Sets);
|
|
|
|
// AttributesSetImpt is uniqued, these should not be available.
|
|
AttributeListImpl(const AttributeListImpl &) = delete;
|
|
AttributeListImpl &operator=(const AttributeListImpl &) = delete;
|
|
|
|
void operator delete(void *p) { ::operator delete(p); }
|
|
|
|
/// \brief Get the context that created this AttributeListImpl.
|
|
LLVMContext &getContext() { return Context; }
|
|
|
|
/// \brief Return true if the AttributeSet or the FunctionIndex has an
|
|
/// enum attribute of the given kind.
|
|
bool hasFnAttribute(Attribute::AttrKind Kind) const {
|
|
return AvailableFunctionAttrs & ((uint64_t)1) << Kind;
|
|
}
|
|
|
|
typedef const AttributeSet *iterator;
|
|
iterator begin() const { return getTrailingObjects<AttributeSet>(); }
|
|
iterator end() const { return begin() + NumAttrSets; }
|
|
|
|
void Profile(FoldingSetNodeID &ID) const;
|
|
static void Profile(FoldingSetNodeID &ID, ArrayRef<AttributeSet> Nodes);
|
|
|
|
void dump() const;
|
|
};
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_LIB_IR_ATTRIBUTEIMPL_H
|