270 lines
9.0 KiB
C++
270 lines
9.0 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/FoldingSet.h"
|
|
#include "llvm/ADT/Optional.h"
|
|
#include "llvm/IR/Attributes.h"
|
|
#include "AttributeSetNode.h"
|
|
#include "llvm/Support/DataTypes.h"
|
|
#include <climits>
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
|
|
class Constant;
|
|
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
|
|
|
|
// AttributesImpl is uniqued, these should not be publicly available.
|
|
void operator=(const AttributeImpl &) = delete;
|
|
AttributeImpl(const AttributeImpl &) = delete;
|
|
|
|
protected:
|
|
enum AttrEntryKind {
|
|
EnumAttrEntry,
|
|
IntAttrEntry,
|
|
StringAttrEntry
|
|
};
|
|
|
|
AttributeImpl(AttrEntryKind KindID) : KindID(KindID) {}
|
|
|
|
public:
|
|
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);
|
|
}
|
|
|
|
// FIXME: Remove this!
|
|
static uint64_t getAttrMask(Attribute::AttrKind Val);
|
|
};
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// \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 {
|
|
void anchor() override;
|
|
uint64_t Val;
|
|
|
|
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; }
|
|
};
|
|
|
|
typedef std::pair<unsigned, AttributeSetNode *> IndexAttrPair;
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// \class
|
|
/// \brief This class represents a set of attributes that apply to the function,
|
|
/// return type, and parameters.
|
|
class AttributeSetImpl final
|
|
: public FoldingSetNode,
|
|
private TrailingObjects<AttributeSetImpl, IndexAttrPair> {
|
|
friend class AttributeSet;
|
|
friend TrailingObjects;
|
|
|
|
private:
|
|
LLVMContext &Context;
|
|
unsigned NumSlots; ///< Number of entries in this set.
|
|
/// Bitset with a bit for each available attribute Attribute::AttrKind.
|
|
uint64_t AvailableFunctionAttrs;
|
|
|
|
// Helper fn for TrailingObjects class.
|
|
size_t numTrailingObjects(OverloadToken<IndexAttrPair>) { return NumSlots; }
|
|
|
|
/// \brief Return a pointer to the IndexAttrPair for the specified slot.
|
|
const IndexAttrPair *getNode(unsigned Slot) const {
|
|
return getTrailingObjects<IndexAttrPair>() + Slot;
|
|
}
|
|
|
|
// AttributesSet is uniqued, these should not be publicly available.
|
|
void operator=(const AttributeSetImpl &) = delete;
|
|
AttributeSetImpl(const AttributeSetImpl &) = delete;
|
|
public:
|
|
AttributeSetImpl(LLVMContext &C,
|
|
ArrayRef<std::pair<unsigned, AttributeSetNode *> > Slots)
|
|
: Context(C), NumSlots(Slots.size()), AvailableFunctionAttrs(0) {
|
|
static_assert(Attribute::EndAttrKinds <=
|
|
sizeof(AvailableFunctionAttrs) * CHAR_BIT,
|
|
"Too many attributes");
|
|
|
|
#ifndef NDEBUG
|
|
if (Slots.size() >= 2) {
|
|
for (const std::pair<unsigned, AttributeSetNode *> *i = Slots.begin() + 1,
|
|
*e = Slots.end();
|
|
i != e; ++i) {
|
|
assert((i-1)->first <= i->first && "Attribute set not ordered!");
|
|
}
|
|
}
|
|
#endif
|
|
// There's memory after the node where we can store the entries in.
|
|
std::copy(Slots.begin(), Slots.end(), getTrailingObjects<IndexAttrPair>());
|
|
|
|
// Initialize AvailableFunctionAttrs summary bitset.
|
|
if (NumSlots > 0) {
|
|
static_assert(AttributeSet::FunctionIndex == ~0u,
|
|
"FunctionIndex should be biggest possible index");
|
|
const std::pair<unsigned, AttributeSetNode *> &Last = Slots.back();
|
|
if (Last.first == AttributeSet::FunctionIndex) {
|
|
const AttributeSetNode *Node = Last.second;
|
|
for (Attribute I : *Node) {
|
|
if (!I.isStringAttribute())
|
|
AvailableFunctionAttrs |= ((uint64_t)1) << I.getKindAsEnum();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void operator delete(void *p) { ::operator delete(p); }
|
|
|
|
/// \brief Get the context that created this AttributeSetImpl.
|
|
LLVMContext &getContext() { return Context; }
|
|
|
|
/// \brief Return the number of slots used in this attribute list. This is
|
|
/// the number of arguments that have an attribute set on them (including the
|
|
/// function itself).
|
|
unsigned getNumSlots() const { return NumSlots; }
|
|
|
|
/// \brief Get the index of the given "slot" in the AttrNodes list. This index
|
|
/// is the index of the return, parameter, or function object that the
|
|
/// attributes are applied to, not the index into the AttrNodes list where the
|
|
/// attributes reside.
|
|
unsigned getSlotIndex(unsigned Slot) const {
|
|
return getNode(Slot)->first;
|
|
}
|
|
|
|
/// \brief Retrieve the attributes for the given "slot" in the AttrNode list.
|
|
/// \p Slot is an index into the AttrNodes list, not the index of the return /
|
|
/// parameter/ function which the attributes apply to.
|
|
AttributeSet getSlotAttributes(unsigned Slot) const {
|
|
return AttributeSet::get(Context, *getNode(Slot));
|
|
}
|
|
|
|
/// \brief Retrieve the attribute set node for the given "slot" in the
|
|
/// AttrNode list.
|
|
AttributeSetNode *getSlotNode(unsigned Slot) const {
|
|
return getNode(Slot)->second;
|
|
}
|
|
|
|
/// \brief Return true if the AttributeSetNode for the FunctionIndex has an
|
|
/// enum attribute of the given kind.
|
|
bool hasFnAttribute(Attribute::AttrKind Kind) const {
|
|
return AvailableFunctionAttrs & ((uint64_t)1) << Kind;
|
|
}
|
|
|
|
typedef AttributeSetNode::iterator iterator;
|
|
iterator begin(unsigned Slot) const { return getSlotNode(Slot)->begin(); }
|
|
iterator end(unsigned Slot) const { return getSlotNode(Slot)->end(); }
|
|
|
|
void Profile(FoldingSetNodeID &ID) const {
|
|
Profile(ID, makeArrayRef(getNode(0), getNumSlots()));
|
|
}
|
|
static void Profile(FoldingSetNodeID &ID,
|
|
ArrayRef<std::pair<unsigned, AttributeSetNode*> > Nodes) {
|
|
for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
|
|
ID.AddInteger(Nodes[i].first);
|
|
ID.AddPointer(Nodes[i].second);
|
|
}
|
|
}
|
|
|
|
// FIXME: This atrocity is temporary.
|
|
uint64_t Raw(unsigned Index) const;
|
|
|
|
void dump() const;
|
|
};
|
|
|
|
} // end llvm namespace
|
|
|
|
#endif
|