1 //===-- llvm/Attributes.h - Container for Attributes ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief This file contains the simple types necessary to represent the
12 /// attributes associated with functions and their calls.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_IR_ATTRIBUTES_H
17 #define LLVM_IR_ATTRIBUTES_H
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/DenseSet.h"
21 #include "llvm/Support/MathExtras.h"
33 //===----------------------------------------------------------------------===//
35 /// \brief Functions, function parameters, and return types can have attributes
36 /// to indicate how they should be treated by optimizations and code
37 /// generation. This class represents one of those attributes. It's light-weight
38 /// and should be passed around by-value.
41 /// This enumeration lists the attributes that can be associated with
42 /// parameters, function results or the function itself.
44 /// Note: uwtable is about the ABI or the user mandating an entry in the
45 /// unwind table. The nounwind attribute is about an exception passing by the
48 /// In a theoretical system that uses tables for profiling and sjlj for
49 /// exceptions, they would be fully independent. In a normal system that uses
50 /// tables for both, the semantics are:
52 /// nil = Needs an entry because an exception might pass by.
53 /// nounwind = No need for an entry
54 /// uwtable = Needs an entry because the ABI says so and because
55 /// an exception might pass by.
56 /// uwtable + nounwind = Needs an entry because the ABI says so.
59 // IR-Level Attributes
60 None, ///< No attributes have been set
61 AddressSafety, ///< Address safety checking is on.
62 Alignment, ///< Alignment of parameter (5 bits)
63 ///< stored as log2 of alignment with +1 bias
64 ///< 0 means unaligned (different from align(1))
65 AlwaysInline, ///< inline=always
66 ByVal, ///< Pass structure by value
67 InlineHint, ///< Source said inlining was desirable
68 InReg, ///< Force argument to be passed in register
69 MinSize, ///< Function must be optimized for size first
70 Naked, ///< Naked function
71 Nest, ///< Nested function static chain
72 NoAlias, ///< Considered to not alias after call
73 NoCapture, ///< Function creates no aliases of pointer
74 NoDuplicate, ///< Call cannot be duplicated
75 NoImplicitFloat, ///< Disable implicit floating point insts
76 NoInline, ///< inline=never
77 NonLazyBind, ///< Function is called early and/or
78 ///< often, so lazy binding isn't worthwhile
79 NoRedZone, ///< Disable redzone
80 NoReturn, ///< Mark the function as not returning
81 NoUnwind, ///< Function doesn't unwind stack
82 OptimizeForSize, ///< opt_size
83 ReadNone, ///< Function does not access memory
84 ReadOnly, ///< Function only reads from memory
85 ReturnsTwice, ///< Function can return twice
86 SExt, ///< Sign extended before/after call
87 StackAlignment, ///< Alignment of stack for function (3 bits)
88 ///< stored as log2 of alignment with +1 bias 0
89 ///< means unaligned (different from
91 StackProtect, ///< Stack protection.
92 StackProtectReq, ///< Stack protection required.
93 StructRet, ///< Hidden pointer to structure to return
94 UWTable, ///< Function must be in a unwind table
95 ZExt, ///< Zero extended before/after call
97 EndAttrKinds, ///< Sentinal value useful for loops
99 AttrKindEmptyKey, ///< Empty key value for DenseMapInfo
100 AttrKindTombstoneKey ///< Tombstone key value for DenseMapInfo
103 AttributeImpl *pImpl;
104 Attribute(AttributeImpl *A) : pImpl(A) {}
106 Attribute() : pImpl(0) {}
108 /// \brief Return a uniquified Attribute object. This takes the uniquified
109 /// value from the Builder and wraps it in the Attribute class.
110 static Attribute get(LLVMContext &Context, ArrayRef<AttrKind> Vals);
111 static Attribute get(LLVMContext &Context, AttrBuilder &B);
113 /// \brief Return true if the attribute is present.
114 bool hasAttribute(AttrKind Val) const;
116 /// \brief Return true if attributes exist
117 bool hasAttributes() const;
119 /// \brief Returns the alignment field of an attribute as a byte alignment
121 unsigned getAlignment() const;
123 /// \brief Set the alignment field of an attribute.
124 void setAlignment(unsigned Align);
126 /// \brief Returns the stack alignment field of an attribute as a byte
128 unsigned getStackAlignment() const;
130 /// \brief Set the stack alignment field of an attribute.
131 void setStackAlignment(unsigned Align);
133 /// \brief Equality and non-equality query methods.
134 bool operator==(AttrKind K) const;
135 bool operator!=(AttrKind K) const;
137 // FIXME: Remove these 'operator' methods.
138 bool operator==(const Attribute &A) const {
139 return pImpl == A.pImpl;
141 bool operator!=(const Attribute &A) const {
142 return pImpl != A.pImpl;
145 uint64_t Raw() const;
147 /// \brief Which attributes cannot be applied to a type.
148 static Attribute typeIncompatible(Type *Ty);
150 /// \brief This returns an integer containing an encoding of all the LLVM
151 /// attributes found in the given attribute bitset. Any change to this
152 /// encoding is a breaking change to bitcode compatibility.
153 static uint64_t encodeLLVMAttributesForBitcode(Attribute Attrs);
155 /// \brief This returns an attribute bitset containing the LLVM attributes
156 /// that have been decoded from the given integer. This function must stay in
157 /// sync with 'encodeLLVMAttributesForBitcode'.
158 static Attribute decodeLLVMAttributesForBitcode(LLVMContext &C,
159 uint64_t EncodedAttrs);
161 /// \brief The Attribute is converted to a string of equivalent mnemonic. This
162 /// is, presumably, for writing out the mnemonics for the assembly writer.
163 std::string getAsString() const;
166 //===----------------------------------------------------------------------===//
168 /// \brief Provide DenseMapInfo for Attribute::AttrKinds. This is used by
170 template<> struct DenseMapInfo<Attribute::AttrKind> {
171 static inline Attribute::AttrKind getEmptyKey() {
172 return Attribute::AttrKindEmptyKey;
174 static inline Attribute::AttrKind getTombstoneKey() {
175 return Attribute::AttrKindTombstoneKey;
177 static unsigned getHashValue(const Attribute::AttrKind &Val) {
180 static bool isEqual(const Attribute::AttrKind &LHS,
181 const Attribute::AttrKind &RHS) {
186 //===----------------------------------------------------------------------===//
188 /// \brief This is just a pair of values to associate a set of attributes with
190 struct AttributeWithIndex {
191 Attribute Attrs; ///< The attributes that are set, or'd together.
192 Constant *Val; ///< Value attached to attribute, e.g. alignment.
193 unsigned Index; ///< Index of the parameter for which the attributes apply.
194 ///< Index 0 is used for return value attributes.
195 ///< Index ~0U is used for function attributes.
197 static AttributeWithIndex get(LLVMContext &C, unsigned Idx,
198 ArrayRef<Attribute::AttrKind> Attrs) {
199 return get(Idx, Attribute::get(C, Attrs));
201 static AttributeWithIndex get(unsigned Idx, Attribute Attrs) {
202 AttributeWithIndex P;
208 static AttributeWithIndex get(unsigned Idx, Attribute Attrs, Constant *Val) {
209 AttributeWithIndex P;
217 //===----------------------------------------------------------------------===//
218 // AttributeSet Smart Pointer
219 //===----------------------------------------------------------------------===//
222 class AttributeSetImpl;
224 //===----------------------------------------------------------------------===//
226 /// \brief This class manages the ref count for the opaque AttributeSetImpl
227 /// object and provides accessors for it.
235 friend class AttrBuilder;
237 /// \brief The attributes that we are managing. This can be null to represent
238 /// the empty attributes list.
239 AttributeSetImpl *AttrList;
241 /// \brief The attributes for the specified index are returned. Attributes
242 /// for the result are denoted with Idx = 0.
243 Attribute getAttributes(unsigned Idx) const;
245 explicit AttributeSet(AttributeSetImpl *LI) : AttrList(LI) {}
247 AttributeSet() : AttrList(0) {}
248 AttributeSet(const AttributeSet &P) : AttrList(P.AttrList) {}
249 const AttributeSet &operator=(const AttributeSet &RHS);
251 //===--------------------------------------------------------------------===//
252 // Attribute List Construction and Mutation
253 //===--------------------------------------------------------------------===//
255 /// \brief Return an AttributeSet with the specified parameters in it.
256 static AttributeSet get(LLVMContext &C, ArrayRef<AttributeWithIndex> Attrs);
257 static AttributeSet get(LLVMContext &C, unsigned Idx, AttrBuilder &B);
259 /// \brief Add the specified attribute at the specified index to this
260 /// attribute list. Since attribute lists are immutable, this returns the new
262 AttributeSet addAttr(LLVMContext &C, unsigned Idx, Attribute Attrs) const;
264 /// \brief Add return attributes to this attribute set. Since attribute sets
265 /// are immutable, this returns a new set.
266 AttributeSet addRetAttributes(LLVMContext &C, AttributeSet Attrs) const;
268 /// \brief Add function attributes to this attribute set. Since attribute sets
269 /// are immutable, this returns a new set.
270 AttributeSet addFnAttributes(LLVMContext &C, AttributeSet Attrs) const;
272 /// \brief Remove the specified attribute at the specified index from this
273 /// attribute list. Since attribute lists are immutable, this returns the new
275 AttributeSet removeAttr(LLVMContext &C, unsigned Idx, Attribute Attrs) const;
277 //===--------------------------------------------------------------------===//
278 // Attribute List Accessors
279 //===--------------------------------------------------------------------===//
281 /// \brief The attributes for the specified index are returned.
282 Attribute getParamAttributes(unsigned Idx) const {
283 return getAttributes(Idx);
286 /// \brief The attributes for the ret value are returned.
287 Attribute getRetAttributes() const {
288 return getAttributes(ReturnIndex);
291 /// \brief The function attributes are returned.
292 Attribute getFnAttributes() const {
293 return getAttributes(FunctionIndex);
296 /// \brief Return the alignment for the specified function parameter.
297 unsigned getParamAlignment(unsigned Idx) const;
299 /// \brief Return true if the attribute exists at the given index.
300 bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const;
302 /// \brief Return true if attribute exists at the given index.
303 bool hasAttributes(unsigned Index) const;
305 /// \brief Get the stack alignment.
306 unsigned getStackAlignment(unsigned Index) const;
308 /// \brief Return the attributes at the index as a string.
309 std::string getAsString(unsigned Index) const;
311 uint64_t Raw(unsigned Index) const;
313 /// \brief Return true if the specified attribute is set for at least one
314 /// parameter or for the return value.
315 bool hasAttrSomewhere(Attribute::AttrKind Attr) const;
317 /// operator==/!= - Provide equality predicates.
318 bool operator==(const AttributeSet &RHS) const {
319 return AttrList == RHS.AttrList;
321 bool operator!=(const AttributeSet &RHS) const {
322 return AttrList != RHS.AttrList;
325 //===--------------------------------------------------------------------===//
326 // Attribute List Introspection
327 //===--------------------------------------------------------------------===//
329 /// \brief Return a raw pointer that uniquely identifies this attribute list.
330 void *getRawPointer() const {
334 // Attributes are stored as a dense set of slots, where there is one slot for
335 // each argument that has an attribute. This allows walking over the dense
336 // set instead of walking the sparse list of attributes.
338 /// \brief Return true if there are no attributes.
339 bool isEmpty() const {
340 return AttrList == 0;
343 /// \brief Return the number of slots used in this attribute list. This is
344 /// the number of arguments that have an attribute set on them (including the
345 /// function itself).
346 unsigned getNumSlots() const;
348 /// \brief Return the AttributeWithIndex at the specified slot. This holds a
349 /// index number plus a set of attributes.
350 const AttributeWithIndex &getSlot(unsigned Slot) const;
355 //===----------------------------------------------------------------------===//
357 /// \brief This class is used in conjunction with the Attribute::get method to
358 /// create an Attribute object. The object itself is uniquified. The Builder's
359 /// value, however, is not. So this can be used as a quick way to test for
360 /// equality, presence of attributes, etc.
362 DenseSet<Attribute::AttrKind> Attrs;
364 uint64_t StackAlignment;
366 AttrBuilder() : Alignment(0), StackAlignment(0) {}
367 explicit AttrBuilder(uint64_t B) : Alignment(0), StackAlignment(0) {
370 AttrBuilder(const Attribute &A) : Alignment(0), StackAlignment(0) {
373 AttrBuilder(AttributeSet AS, unsigned Idx);
377 /// \brief Add an attribute to the builder.
378 AttrBuilder &addAttribute(Attribute::AttrKind Val);
380 /// \brief Remove an attribute from the builder.
381 AttrBuilder &removeAttribute(Attribute::AttrKind Val);
383 /// \brief Add the attributes from A to the builder.
384 AttrBuilder &addAttributes(const Attribute &A);
386 /// \brief Remove the attributes from A from the builder.
387 AttrBuilder &removeAttributes(const Attribute &A);
389 /// \brief Return true if the builder has the specified attribute.
390 bool contains(Attribute::AttrKind A) const;
392 /// \brief Return true if the builder has IR-level attributes.
393 bool hasAttributes() const;
395 /// \brief Return true if the builder has any attribute that's in the
396 /// specified attribute.
397 bool hasAttributes(const Attribute &A) const;
399 /// \brief Return true if the builder has an alignment attribute.
400 bool hasAlignmentAttr() const;
402 /// \brief Retrieve the alignment attribute, if it exists.
403 uint64_t getAlignment() const { return Alignment; }
405 /// \brief Retrieve the stack alignment attribute, if it exists.
406 uint64_t getStackAlignment() const { return StackAlignment; }
408 /// \brief This turns an int alignment (which must be a power of 2) into the
409 /// form used internally in Attribute.
410 AttrBuilder &addAlignmentAttr(unsigned Align);
412 /// \brief This turns an int stack alignment (which must be a power of 2) into
413 /// the form used internally in Attribute.
414 AttrBuilder &addStackAlignmentAttr(unsigned Align);
416 typedef DenseSet<Attribute::AttrKind>::iterator iterator;
417 typedef DenseSet<Attribute::AttrKind>::const_iterator const_iterator;
419 iterator begin() { return Attrs.begin(); }
420 iterator end() { return Attrs.end(); }
422 const_iterator begin() const { return Attrs.begin(); }
423 const_iterator end() const { return Attrs.end(); }
425 /// \brief Add the raw value to the internal representation.
427 /// N.B. This should be used ONLY for decoding LLVM bitcode!
428 AttrBuilder &addRawValue(uint64_t Val);
430 /// \brief Remove attributes that are used on functions only.
431 void removeFunctionOnlyAttrs() {
432 removeAttribute(Attribute::NoReturn)
433 .removeAttribute(Attribute::NoUnwind)
434 .removeAttribute(Attribute::ReadNone)
435 .removeAttribute(Attribute::ReadOnly)
436 .removeAttribute(Attribute::NoInline)
437 .removeAttribute(Attribute::AlwaysInline)
438 .removeAttribute(Attribute::OptimizeForSize)
439 .removeAttribute(Attribute::StackProtect)
440 .removeAttribute(Attribute::StackProtectReq)
441 .removeAttribute(Attribute::NoRedZone)
442 .removeAttribute(Attribute::NoImplicitFloat)
443 .removeAttribute(Attribute::Naked)
444 .removeAttribute(Attribute::InlineHint)
445 .removeAttribute(Attribute::StackAlignment)
446 .removeAttribute(Attribute::UWTable)
447 .removeAttribute(Attribute::NonLazyBind)
448 .removeAttribute(Attribute::ReturnsTwice)
449 .removeAttribute(Attribute::AddressSafety)
450 .removeAttribute(Attribute::MinSize)
451 .removeAttribute(Attribute::NoDuplicate);
454 uint64_t Raw() const;
456 bool operator==(const AttrBuilder &B);
457 bool operator!=(const AttrBuilder &B) {
458 return !(*this == B);
462 } // end llvm namespace