lib/IR/AttributeImpl.h

   1 //===-- AttributeImpl.h - Attribute Internals -------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 /// \brief This file defines various helper methods and classes used by
  12 /// LLVMContextImpl for creating and managing attributes.
  13 ///
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_ATTRIBUTESIMPL_H
  17 #define LLVM_ATTRIBUTESIMPL_H
  18
  19 #include "llvm/ADT/FoldingSet.h"
  20 #include "llvm/IR/Attributes.h"
  21 #include <string>
  22
  23 namespace llvm {
  24
  25 class Constant;
  26 class LLVMContext;
  27
  28 //===----------------------------------------------------------------------===//
  29 /// \class
  30 /// \brief A set of classes that contain the kind and (optional) value of the
  31 /// attribute object. There are three main categories: enum attribute entries,
  32 /// represented by Attribute::AttrKind; alignment attribute entries; and string
  33 /// attribute enties, which are for target-dependent attributes.
  34 class AttributeEntry {
  35   unsigned char KindID;
  36 protected:
  37   enum AttrEntryKind {
  38     EnumAttrEntry,
  39     AlignAttrEntry,
  40     StringAttrEntry
  41   };
  42 public:
  43   AttributeEntry(AttrEntryKind Kind)
  44     : KindID(Kind) {}
  45   virtual ~AttributeEntry() {}
  46
  47   unsigned getKindID() const { return KindID; }
  48
  49   static inline bool classof(const AttributeEntry *) { return true; }
  50 };
  51
  52 class EnumAttributeEntry : public AttributeEntry {
  53   Attribute::AttrKind Kind;
  54 public:
  55   EnumAttributeEntry(Attribute::AttrKind Kind)
  56     : AttributeEntry(EnumAttrEntry), Kind(Kind) {}
  57
  58   Attribute::AttrKind getEnumKind() const { return Kind; }
  59
  60   static inline bool classof(const AttributeEntry *AE) {
  61     return AE->getKindID() == EnumAttrEntry;
  62   }
  63   static inline bool classof(const EnumAttributeEntry *) { return true; }
  64 };
  65
  66 class AlignAttributeEntry : public AttributeEntry {
  67   Attribute::AttrKind Kind;
  68   unsigned Align;
  69 public:
  70   AlignAttributeEntry(Attribute::AttrKind Kind, unsigned Align)
  71     : AttributeEntry(AlignAttrEntry), Kind(Kind), Align(Align) {}
  72
  73   Attribute::AttrKind getEnumKind() const { return Kind; }
  74   unsigned getAlignment() const { return Align; }
  75
  76   static inline bool classof(const AttributeEntry *AE) {
  77     return AE->getKindID() == AlignAttrEntry;
  78   }
  79   static inline bool classof(const AlignAttributeEntry *) { return true; }
  80 };
  81
  82 class StringAttributeEntry : public AttributeEntry {
  83   std::string Kind;
  84   std::string Val;
  85 public:
  86   StringAttributeEntry(StringRef Kind, StringRef Val = StringRef())
  87     : AttributeEntry(StringAttrEntry), Kind(Kind), Val(Val) {}
  88
  89   StringRef getStringKind() const { return Kind; }
  90   StringRef getStringValue() const { return Val; }
  91
  92   static inline bool classof(const AttributeEntry *AE) {
  93     return AE->getKindID() == StringAttrEntry;
  94   }
  95   static inline bool classof(const StringAttributeEntry *) { return true; }
  96 };
  97
  98 //===----------------------------------------------------------------------===//
  99 /// \class
 100 /// \brief This class represents a single, uniqued attribute. That attribute
 101 /// could be a single enum, a tuple, or a string.
 102 class AttributeImpl : public FoldingSetNode {
 103   LLVMContext &Context;  ///< Global context for uniquing objects
 104   Constant *Kind;        ///< Kind of attribute: enum or string
 105
 106   AttributeEntry *Entry; ///< Holds the kind and value of the attribute
 107
 108   // AttributesImpl is uniqued, these should not be publicly available.
 109   void operator=(const AttributeImpl &) LLVM_DELETED_FUNCTION;
 110   AttributeImpl(const AttributeImpl &) LLVM_DELETED_FUNCTION;
 111 public:
 112   AttributeImpl(LLVMContext &C, Attribute::AttrKind Kind);
 113   AttributeImpl(LLVMContext &C, Attribute::AttrKind Kind, unsigned Align);
 114   AttributeImpl(LLVMContext &C, StringRef Kind, StringRef Val = StringRef());
 115   ~AttributeImpl();
 116
 117   LLVMContext &getContext() { return Context; }
 118
 119   bool isEnumAttribute() const;
 120   bool isAlignAttribute() const;
 121   bool isStringAttribute() const;
 122
 123   bool hasAttribute(Attribute::AttrKind A) const;
 124   bool hasAttribute(StringRef Kind) const;
 125
 126   Attribute::AttrKind getKindAsEnum() const;
 127   uint64_t getValueAsInt() const;
 128
 129   StringRef getKindAsString() const;
 130   StringRef getValueAsString() const;
 131
 132   /// \brief Used when sorting the attributes.
 133   bool operator<(const AttributeImpl &AI) const;
 134
 135   void Profile(FoldingSetNodeID &ID) const {
 136     if (isEnumAttribute())
 137       Profile(ID, getKindAsEnum(), 0);
 138     else if (isAlignAttribute())
 139       Profile(ID, getKindAsEnum(), getValueAsInt());
 140     else
 141       Profile(ID, getKindAsString(), getValueAsString());
 142   }
 143   static void Profile(FoldingSetNodeID &ID, Attribute::AttrKind Kind,
 144                       uint64_t Val) {
 145     ID.AddInteger(Kind);
 146     if (Val) ID.AddInteger(Val);
 147   }
 148   static void Profile(FoldingSetNodeID &ID, StringRef Kind, StringRef Values) {
 149     ID.AddString(Kind);
 150     ID.AddString(Values);
 151   }
 152
 153   // FIXME: Remove this!
 154   static uint64_t getAttrMask(Attribute::AttrKind Val);
 155 };
 156
 157 //===----------------------------------------------------------------------===//
 158 /// \class
 159 /// \brief This class represents a group of attributes that apply to one
 160 /// element: function, return type, or parameter.
 161 class AttributeSetNode : public FoldingSetNode {
 162   SmallVector<Attribute, 4> AttrList;
 163
 164   AttributeSetNode(ArrayRef<Attribute> Attrs)
 165     : AttrList(Attrs.begin(), Attrs.end()) {}
 166
 167   // AttributesSetNode is uniqued, these should not be publicly available.
 168   void operator=(const AttributeSetNode &) LLVM_DELETED_FUNCTION;
 169   AttributeSetNode(const AttributeSetNode &) LLVM_DELETED_FUNCTION;
 170 public:
 171   static AttributeSetNode *get(LLVMContext &C, ArrayRef<Attribute> Attrs);
 172
 173   bool hasAttribute(Attribute::AttrKind Kind) const;
 174   bool hasAttributes() const { return !AttrList.empty(); }
 175
 176   unsigned getAlignment() const;
 177   unsigned getStackAlignment() const;
 178   std::string getAsString() const;
 179
 180   typedef SmallVectorImpl<Attribute>::iterator       iterator;
 181   typedef SmallVectorImpl<Attribute>::const_iterator const_iterator;
 182
 183   iterator begin() { return AttrList.begin(); }
 184   iterator end()   { return AttrList.end(); }
 185
 186   const_iterator begin() const { return AttrList.begin(); }
 187   const_iterator end() const   { return AttrList.end(); }
 188
 189   void Profile(FoldingSetNodeID &ID) const {
 190     Profile(ID, AttrList);
 191   }
 192   static void Profile(FoldingSetNodeID &ID, ArrayRef<Attribute> AttrList) {
 193     for (unsigned I = 0, E = AttrList.size(); I != E; ++I)
 194       AttrList[I].Profile(ID);
 195   }
 196 };
 197
 198 //===----------------------------------------------------------------------===//
 199 /// \class
 200 /// \brief This class represents a set of attributes that apply to the function,
 201 /// return type, and parameters.
 202 class AttributeSetImpl : public FoldingSetNode {
 203   friend class AttributeSet;
 204
 205   LLVMContext &Context;
 206
 207   typedef std::pair<unsigned, AttributeSetNode*> IndexAttrPair;
 208   SmallVector<IndexAttrPair, 4> AttrNodes;
 209
 210   // AttributesSet is uniqued, these should not be publicly available.
 211   void operator=(const AttributeSetImpl &) LLVM_DELETED_FUNCTION;
 212   AttributeSetImpl(const AttributeSetImpl &) LLVM_DELETED_FUNCTION;
 213 public:
 214   AttributeSetImpl(LLVMContext &C,
 215                    ArrayRef<std::pair<unsigned, AttributeSetNode*> > attrs)
 216     : Context(C), AttrNodes(attrs.begin(), attrs.end()) {}
 217
 218   /// \brief Get the context that created this AttributeSetImpl.
 219   LLVMContext &getContext() { return Context; }
 220
 221   /// \brief Return the number of attributes this AttributeSet contains.
 222   unsigned getNumAttributes() const { return AttrNodes.size(); }
 223
 224   /// \brief Get the index of the given "slot" in the AttrNodes list. This index
 225   /// is the index of the return, parameter, or function object that the
 226   /// attributes are applied to, not the index into the AttrNodes list where the
 227   /// attributes reside.
 228   uint64_t getSlotIndex(unsigned Slot) const {
 229     return AttrNodes[Slot].first;
 230   }
 231
 232   /// \brief Retrieve the attributes for the given "slot" in the AttrNode list.
 233   /// \p Slot is an index into the AttrNodes list, not the index of the return /
 234   /// parameter/ function which the attributes apply to.
 235   AttributeSet getSlotAttributes(unsigned Slot) const {
 236     return AttributeSet::get(Context, AttrNodes[Slot]);
 237   }
 238
 239   /// \brief Retrieve the attribute set node for the given "slot" in the
 240   /// AttrNode list.
 241   AttributeSetNode *getSlotNode(unsigned Slot) const {
 242     return AttrNodes[Slot].second;
 243   }
 244
 245   typedef AttributeSetNode::iterator       iterator;
 246   typedef AttributeSetNode::const_iterator const_iterator;
 247
 248   iterator begin(unsigned Idx)
 249     { return AttrNodes[Idx].second->begin(); }
 250   iterator end(unsigned Idx)
 251     { return AttrNodes[Idx].second->end(); }
 252
 253   const_iterator begin(unsigned Idx) const
 254     { return AttrNodes[Idx].second->begin(); }
 255   const_iterator end(unsigned Idx) const
 256     { return AttrNodes[Idx].second->end(); }
 257
 258   void Profile(FoldingSetNodeID &ID) const {
 259     Profile(ID, AttrNodes);
 260   }
 261   static void Profile(FoldingSetNodeID &ID,
 262                       ArrayRef<std::pair<unsigned, AttributeSetNode*> > Nodes) {
 263     for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
 264       ID.AddInteger(Nodes[i].first);
 265       ID.AddPointer(Nodes[i].second);
 266     }
 267   }
 268
 269   // FIXME: This atrocity is temporary.
 270   uint64_t Raw(uint64_t Index) const;
 271 };
 272
 273 } // end llvm namespace
 274
 275 #endif