Bill Wendling | f667072 | 2012-12-20 01:36:59 +0000 | [diff] [blame] | 1 | //===-- AttributeImpl.h - Attribute Internals -------------------*- C++ -*-===// |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 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 | //===----------------------------------------------------------------------===// |
Bill Wendling | 27107f6 | 2012-12-20 21:28:43 +0000 | [diff] [blame] | 9 | /// |
| 10 | /// \file |
| 11 | /// \brief This file defines various helper methods and classes used by |
| 12 | /// LLVMContextImpl for creating and managing attributes. |
| 13 | /// |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 14 | //===----------------------------------------------------------------------===// |
| 15 | |
| 16 | #ifndef LLVM_ATTRIBUTESIMPL_H |
| 17 | #define LLVM_ATTRIBUTESIMPL_H |
| 18 | |
| 19 | #include "llvm/ADT/FoldingSet.h" |
Chandler Carruth | 0b8c9a8 | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 20 | #include "llvm/IR/Attributes.h" |
Bill Wendling | 606c8e3 | 2013-01-29 03:20:31 +0000 | [diff] [blame] | 21 | #include <string> |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 22 | |
| 23 | namespace llvm { |
| 24 | |
Bill Wendling | 7c1683d | 2012-12-29 12:29:38 +0000 | [diff] [blame] | 25 | class Constant; |
Bill Wendling | 5f93e2b | 2012-12-19 23:55:43 +0000 | [diff] [blame] | 26 | class LLVMContext; |
| 27 | |
Bill Wendling | 27107f6 | 2012-12-20 21:28:43 +0000 | [diff] [blame] | 28 | //===----------------------------------------------------------------------===// |
| 29 | /// \class |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 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 |
Bill Wendling | 27107f6 | 2012-12-20 21:28:43 +0000 | [diff] [blame] | 100 | /// \brief This class represents a single, uniqued attribute. That attribute |
Bill Wendling | 979aff6 | 2012-12-30 02:22:16 +0000 | [diff] [blame] | 101 | /// could be a single enum, a tuple, or a string. |
Bill Wendling | f667072 | 2012-12-20 01:36:59 +0000 | [diff] [blame] | 102 | class AttributeImpl : public FoldingSetNode { |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 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 |
Bill Wendling | 1cc0d5a | 2013-01-27 21:38:03 +0000 | [diff] [blame] | 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; |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 111 | public: |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 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(); |
Bill Wendling | 979aff6 | 2012-12-30 02:22:16 +0000 | [diff] [blame] | 116 | |
Bill Wendling | 14292a6 | 2013-01-31 20:59:05 +0000 | [diff] [blame] | 117 | LLVMContext &getContext() { return Context; } |
| 118 | |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 119 | bool isEnumAttribute() const; |
| 120 | bool isAlignAttribute() const; |
| 121 | bool isStringAttribute() const; |
| 122 | |
Bill Wendling | 60507d5 | 2013-01-04 20:54:35 +0000 | [diff] [blame] | 123 | bool hasAttribute(Attribute::AttrKind A) const; |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 124 | bool hasAttribute(StringRef Kind) const; |
Bill Wendling | 8e635db | 2012-10-08 21:47:17 +0000 | [diff] [blame] | 125 | |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 126 | Attribute::AttrKind getKindAsEnum() const; |
| 127 | uint64_t getValueAsInt() const; |
Bill Wendling | 9f175f8 | 2013-01-29 20:37:10 +0000 | [diff] [blame] | 128 | |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 129 | StringRef getKindAsString() const; |
| 130 | StringRef getValueAsString() const; |
Bill Wendling | 529ec71 | 2012-12-30 01:38:39 +0000 | [diff] [blame] | 131 | |
Bill Wendling | 14292a6 | 2013-01-31 20:59:05 +0000 | [diff] [blame] | 132 | /// \brief Used when sorting the attributes. |
Bill Wendling | 3467e30 | 2013-01-24 00:06:56 +0000 | [diff] [blame] | 133 | bool operator<(const AttributeImpl &AI) const; |
| 134 | |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 135 | void Profile(FoldingSetNodeID &ID) const { |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 136 | if (isEnumAttribute()) |
| 137 | Profile(ID, getKindAsEnum(), 0); |
| 138 | else if (isAlignAttribute()) |
| 139 | Profile(ID, getKindAsEnum(), getValueAsInt()); |
| 140 | else |
| 141 | Profile(ID, getKindAsString(), getValueAsString()); |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 142 | } |
Bill Wendling | 8c74ecf | 2013-02-05 22:37:24 +0000 | [diff] [blame^] | 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); |
Bill Wendling | c22f4aa | 2013-01-29 00:34:06 +0000 | [diff] [blame] | 151 | } |
| 152 | |
Bill Wendling | f715dbd | 2013-02-01 00:48:14 +0000 | [diff] [blame] | 153 | // FIXME: Remove this! |
Bill Wendling | c22f4aa | 2013-01-29 00:34:06 +0000 | [diff] [blame] | 154 | static uint64_t getAttrMask(Attribute::AttrKind Val); |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 155 | }; |
| 156 | |
Bill Wendling | 27107f6 | 2012-12-20 21:28:43 +0000 | [diff] [blame] | 157 | //===----------------------------------------------------------------------===// |
| 158 | /// \class |
Bill Wendling | 3467e30 | 2013-01-24 00:06:56 +0000 | [diff] [blame] | 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()) {} |
Bill Wendling | 1cc0d5a | 2013-01-27 21:38:03 +0000 | [diff] [blame] | 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; |
Bill Wendling | 3467e30 | 2013-01-24 00:06:56 +0000 | [diff] [blame] | 170 | public: |
| 171 | static AttributeSetNode *get(LLVMContext &C, ArrayRef<Attribute> Attrs); |
| 172 | |
Bill Wendling | 606c8e3 | 2013-01-29 03:20:31 +0000 | [diff] [blame] | 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 | |
Bill Wendling | 3467e30 | 2013-01-24 00:06:56 +0000 | [diff] [blame] | 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. |
Bill Wendling | 18e7211 | 2012-12-19 22:42:22 +0000 | [diff] [blame] | 202 | class AttributeSetImpl : public FoldingSetNode { |
Bill Wendling | 8e47daf | 2013-01-25 23:09:36 +0000 | [diff] [blame] | 203 | friend class AttributeSet; |
| 204 | |
Bill Wendling | 60507d5 | 2013-01-04 20:54:35 +0000 | [diff] [blame] | 205 | LLVMContext &Context; |
Bill Wendling | 60507d5 | 2013-01-04 20:54:35 +0000 | [diff] [blame] | 206 | |
Bill Wendling | 6bdbf06 | 2013-01-28 22:33:39 +0000 | [diff] [blame] | 207 | typedef std::pair<unsigned, AttributeSetNode*> IndexAttrPair; |
Bill Wendling | 73bc452 | 2013-01-28 00:21:34 +0000 | [diff] [blame] | 208 | SmallVector<IndexAttrPair, 4> AttrNodes; |
Bill Wendling | bb08593 | 2013-01-24 01:01:34 +0000 | [diff] [blame] | 209 | |
Bill Wendling | 831737d | 2012-12-30 10:32:01 +0000 | [diff] [blame] | 210 | // AttributesSet is uniqued, these should not be publicly available. |
Bill Wendling | 18e7211 | 2012-12-19 22:42:22 +0000 | [diff] [blame] | 211 | void operator=(const AttributeSetImpl &) LLVM_DELETED_FUNCTION; |
| 212 | AttributeSetImpl(const AttributeSetImpl &) LLVM_DELETED_FUNCTION; |
Bill Wendling | 0976e00 | 2012-11-20 05:09:20 +0000 | [diff] [blame] | 213 | public: |
Bill Wendling | 87e10df | 2013-01-28 21:55:20 +0000 | [diff] [blame] | 214 | AttributeSetImpl(LLVMContext &C, |
Bill Wendling | 6bdbf06 | 2013-01-28 22:33:39 +0000 | [diff] [blame] | 215 | ArrayRef<std::pair<unsigned, AttributeSetNode*> > attrs) |
Bill Wendling | 87e10df | 2013-01-28 21:55:20 +0000 | [diff] [blame] | 216 | : Context(C), AttrNodes(attrs.begin(), attrs.end()) {} |
Bill Wendling | 60507d5 | 2013-01-04 20:54:35 +0000 | [diff] [blame] | 217 | |
Bill Wendling | 893eac1 | 2013-01-27 21:32:11 +0000 | [diff] [blame] | 218 | /// \brief Get the context that created this AttributeSetImpl. |
Bill Wendling | 60507d5 | 2013-01-04 20:54:35 +0000 | [diff] [blame] | 219 | LLVMContext &getContext() { return Context; } |
Bill Wendling | 893eac1 | 2013-01-27 21:32:11 +0000 | [diff] [blame] | 220 | |
Bill Wendling | 893eac1 | 2013-01-27 21:32:11 +0000 | [diff] [blame] | 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. |
Bill Wendling | 73bc452 | 2013-01-28 00:21:34 +0000 | [diff] [blame] | 228 | uint64_t getSlotIndex(unsigned Slot) const { |
| 229 | return AttrNodes[Slot].first; |
| 230 | } |
Bill Wendling | 893eac1 | 2013-01-27 21:32:11 +0000 | [diff] [blame] | 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. |
Bill Wendling | 8e47daf | 2013-01-25 23:09:36 +0000 | [diff] [blame] | 235 | AttributeSet getSlotAttributes(unsigned Slot) const { |
Bill Wendling | 87e10df | 2013-01-28 21:55:20 +0000 | [diff] [blame] | 236 | return AttributeSet::get(Context, AttrNodes[Slot]); |
Bill Wendling | 8e47daf | 2013-01-25 23:09:36 +0000 | [diff] [blame] | 237 | } |
Bill Wendling | 0976e00 | 2012-11-20 05:09:20 +0000 | [diff] [blame] | 238 | |
Bill Wendling | 606c8e3 | 2013-01-29 03:20:31 +0000 | [diff] [blame] | 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 | |
Bill Wendling | 73bc452 | 2013-01-28 00:21:34 +0000 | [diff] [blame] | 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 | |
Bill Wendling | 0976e00 | 2012-11-20 05:09:20 +0000 | [diff] [blame] | 258 | void Profile(FoldingSetNodeID &ID) const { |
Bill Wendling | 87e10df | 2013-01-28 21:55:20 +0000 | [diff] [blame] | 259 | Profile(ID, AttrNodes); |
Bill Wendling | 0976e00 | 2012-11-20 05:09:20 +0000 | [diff] [blame] | 260 | } |
Bill Wendling | 60507d5 | 2013-01-04 20:54:35 +0000 | [diff] [blame] | 261 | static void Profile(FoldingSetNodeID &ID, |
Bill Wendling | 6bdbf06 | 2013-01-28 22:33:39 +0000 | [diff] [blame] | 262 | ArrayRef<std::pair<unsigned, AttributeSetNode*> > Nodes) { |
Bill Wendling | bb08593 | 2013-01-24 01:01:34 +0000 | [diff] [blame] | 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 | } |
Bill Wendling | d05204a | 2013-01-27 23:41:29 +0000 | [diff] [blame] | 268 | |
| 269 | // FIXME: This atrocity is temporary. |
| 270 | uint64_t Raw(uint64_t Index) const; |
Bill Wendling | 0976e00 | 2012-11-20 05:09:20 +0000 | [diff] [blame] | 271 | }; |
| 272 | |
Bill Wendling | 2c79ecb | 2012-09-26 21:07:29 +0000 | [diff] [blame] | 273 | } // end llvm namespace |
| 274 | |
| 275 | #endif |