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/FoldingSet.h"
21 #include "llvm/Support/PointerLikeTypeTraits.h"
31 class AttributeSetImpl;
32 class AttributeSetNode;
34 template<typename T> struct DenseMapInfo;
38 //===----------------------------------------------------------------------===//
40 /// \brief Functions, function parameters, and return types can have attributes
41 /// to indicate how they should be treated by optimizations and code
42 /// generation. This class represents one of those attributes. It's light-weight
43 /// and should be passed around by-value.
46 /// This enumeration lists the attributes that can be associated with
47 /// parameters, function results, or the function itself.
49 /// Note: The `uwtable' attribute is about the ABI or the user mandating an
50 /// entry in the unwind table. The `nounwind' attribute is about an exception
51 /// passing by the function.
53 /// In a theoretical system that uses tables for profiling and SjLj for
54 /// exceptions, they would be fully independent. In a normal system that uses
55 /// tables for both, the semantics are:
57 /// nil = Needs an entry because an exception might pass by.
58 /// nounwind = No need for an entry
59 /// uwtable = Needs an entry because the ABI says so and because
60 /// an exception might pass by.
61 /// uwtable + nounwind = Needs an entry because the ABI says so.
64 // IR-Level Attributes
65 None, ///< No attributes have been set
66 Alignment, ///< Alignment of parameter (5 bits)
67 ///< stored as log2 of alignment with +1 bias
68 ///< 0 means unaligned (different from align(1))
69 AlwaysInline, ///< inline=always
70 ByVal, ///< Pass structure by value
71 InlineHint, ///< Source said inlining was desirable
72 InReg, ///< Force argument to be passed in register
73 MinSize, ///< Function must be optimized for size first
74 Naked, ///< Naked function
75 Nest, ///< Nested function static chain
76 NoAlias, ///< Considered to not alias after call
77 NoBuiltin, ///< Callee isn't recognized as a builtin
78 NoCapture, ///< Function creates no aliases of pointer
79 NoDuplicate, ///< Call cannot be duplicated
80 NoImplicitFloat, ///< Disable implicit floating point insts
81 NoInline, ///< inline=never
82 NonLazyBind, ///< Function is called early and/or
83 ///< often, so lazy binding isn't worthwhile
84 NoRedZone, ///< Disable redzone
85 NoReturn, ///< Mark the function as not returning
86 NoUnwind, ///< Function doesn't unwind stack
87 OptimizeForSize, ///< opt_size
88 ReadNone, ///< Function does not access memory
89 ReadOnly, ///< Function only reads from memory
90 ReturnsTwice, ///< Function can return twice
91 SExt, ///< Sign extended before/after call
92 StackAlignment, ///< Alignment of stack for function (3 bits)
93 ///< stored as log2 of alignment with +1 bias 0
94 ///< means unaligned (different from
96 StackProtect, ///< Stack protection.
97 StackProtectReq, ///< Stack protection required.
98 StackProtectStrong, ///< Strong Stack protection.
99 StructRet, ///< Hidden pointer to structure to return
100 SanitizeAddress, ///< AddressSanitizer is on.
101 SanitizeThread, ///< ThreadSanitizer is on.
102 SanitizeMemory, ///< MemorySanitizer is on.
103 UWTable, ///< Function must be in a unwind table
104 ZExt, ///< Zero extended before/after call
106 EndAttrKinds ///< Sentinal value useful for loops
109 AttributeImpl *pImpl;
110 Attribute(AttributeImpl *A) : pImpl(A) {}
112 Attribute() : pImpl(0) {}
114 //===--------------------------------------------------------------------===//
115 // Attribute Construction
116 //===--------------------------------------------------------------------===//
118 /// \brief Return a uniquified Attribute object.
119 static Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val = 0);
120 static Attribute get(LLVMContext &Context, StringRef Kind,
121 StringRef Val = StringRef());
123 /// \brief Return a uniquified Attribute object that has the specific
125 static Attribute getWithAlignment(LLVMContext &Context, uint64_t Align);
126 static Attribute getWithStackAlignment(LLVMContext &Context, uint64_t Align);
128 //===--------------------------------------------------------------------===//
129 // Attribute Accessors
130 //===--------------------------------------------------------------------===//
132 /// \brief Return true if the attribute is an Attribute::AttrKind type.
133 bool isEnumAttribute() const;
135 /// \brief Return true if the attribute is an alignment attribute.
136 bool isAlignAttribute() const;
138 /// \brief Return true if the attribute is a string (target-dependent)
140 bool isStringAttribute() const;
142 /// \brief Return true if the attribute is present.
143 bool hasAttribute(AttrKind Val) const;
145 /// \brief Return true if the target-dependent attribute is present.
146 bool hasAttribute(StringRef Val) const;
148 /// \brief Return the attribute's kind as an enum (Attribute::AttrKind). This
149 /// requires the attribute to be an enum or alignment attribute.
150 Attribute::AttrKind getKindAsEnum() const;
152 /// \brief Return the attribute's value as an integer. This requires that the
153 /// attribute be an alignment attribute.
154 uint64_t getValueAsInt() const;
156 /// \brief Return the attribute's kind as a string. This requires the
157 /// attribute to be a string attribute.
158 StringRef getKindAsString() const;
160 /// \brief Return the attribute's value as a string. This requires the
161 /// attribute to be a string attribute.
162 StringRef getValueAsString() const;
164 /// \brief Returns the alignment field of an attribute as a byte alignment
166 unsigned getAlignment() const;
168 /// \brief Returns the stack alignment field of an attribute as a byte
170 unsigned getStackAlignment() const;
172 /// \brief The Attribute is converted to a string of equivalent mnemonic. This
173 /// is, presumably, for writing out the mnemonics for the assembly writer.
174 std::string getAsString(bool InAttrGrp = false) const;
176 /// \brief Equality and non-equality operators.
177 bool operator==(Attribute A) const { return pImpl == A.pImpl; }
178 bool operator!=(Attribute A) const { return pImpl != A.pImpl; }
180 /// \brief Less-than operator. Useful for sorting the attributes list.
181 bool operator<(Attribute A) const;
183 void Profile(FoldingSetNodeID &ID) const {
184 ID.AddPointer(pImpl);
188 //===----------------------------------------------------------------------===//
190 /// \brief This class holds the attributes for a function, its return value, and
191 /// its parameters. You access the attributes for each of them via an index into
192 /// the AttributeSet object. The function attributes are at index
193 /// `AttributeSet::FunctionIndex', the return value is at index
194 /// `AttributeSet::ReturnIndex', and the attributes for the parameters start at
203 friend class AttrBuilder;
204 friend class AttributeSetImpl;
205 template <typename Ty> friend struct DenseMapInfo;
207 /// \brief The attributes that we are managing. This can be null to represent
208 /// the empty attributes list.
209 AttributeSetImpl *pImpl;
211 /// \brief The attributes for the specified index are returned.
212 AttributeSetNode *getAttributes(unsigned Idx) const;
214 /// \brief Create an AttributeSet with the specified parameters in it.
215 static AttributeSet get(LLVMContext &C,
216 ArrayRef<std::pair<unsigned, Attribute> > Attrs);
217 static AttributeSet get(LLVMContext &C,
218 ArrayRef<std::pair<unsigned,
219 AttributeSetNode*> > Attrs);
221 static AttributeSet getImpl(LLVMContext &C,
222 ArrayRef<std::pair<unsigned,
223 AttributeSetNode*> > Attrs);
226 explicit AttributeSet(AttributeSetImpl *LI) : pImpl(LI) {}
228 AttributeSet() : pImpl(0) {}
229 AttributeSet(const AttributeSet &P) : pImpl(P.pImpl) {}
230 const AttributeSet &operator=(const AttributeSet &RHS) {
235 //===--------------------------------------------------------------------===//
236 // AttributeSet Construction and Mutation
237 //===--------------------------------------------------------------------===//
239 /// \brief Return an AttributeSet with the specified parameters in it.
240 static AttributeSet get(LLVMContext &C, ArrayRef<AttributeSet> Attrs);
241 static AttributeSet get(LLVMContext &C, unsigned Idx,
242 ArrayRef<Attribute::AttrKind> Kind);
243 static AttributeSet get(LLVMContext &C, unsigned Idx, AttrBuilder &B);
245 /// \brief Add an attribute to the attribute set at the given index. Since
246 /// attribute sets are immutable, this returns a new set.
247 AttributeSet addAttribute(LLVMContext &C, unsigned Idx,
248 Attribute::AttrKind Attr) const;
250 /// \brief Add an attribute to the attribute set at the given index. Since
251 /// attribute sets are immutable, this returns a new set.
252 AttributeSet addAttribute(LLVMContext &C, unsigned Idx,
253 StringRef Kind) const;
255 /// \brief Add attributes to the attribute set at the given index. Since
256 /// attribute sets are immutable, this returns a new set.
257 AttributeSet addAttributes(LLVMContext &C, unsigned Idx,
258 AttributeSet Attrs) const;
260 /// \brief Remove the specified attribute at the specified index from this
261 /// attribute list. Since attribute lists are immutable, this returns the new
263 AttributeSet removeAttribute(LLVMContext &C, unsigned Idx,
264 Attribute::AttrKind Attr) const;
266 /// \brief Remove the specified attributes at the specified index from this
267 /// attribute list. Since attribute lists are immutable, this returns the new
269 AttributeSet removeAttributes(LLVMContext &C, unsigned Idx,
270 AttributeSet Attrs) const;
272 //===--------------------------------------------------------------------===//
273 // AttributeSet Accessors
274 //===--------------------------------------------------------------------===//
276 /// \brief Retrieve the LLVM context.
277 LLVMContext &getContext() const;
279 /// \brief The attributes for the specified index are returned.
280 AttributeSet getParamAttributes(unsigned Idx) const;
282 /// \brief The attributes for the ret value are returned.
283 AttributeSet getRetAttributes() const;
285 /// \brief The function attributes are returned.
286 AttributeSet getFnAttributes() const;
288 /// \brief Return true if the attribute exists at the given index.
289 bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const;
291 /// \brief Return true if the attribute exists at the given index.
292 bool hasAttribute(unsigned Index, StringRef Kind) const;
294 /// \brief Return true if attribute exists at the given index.
295 bool hasAttributes(unsigned Index) const;
297 /// \brief Return true if the specified attribute is set for at least one
298 /// parameter or for the return value.
299 bool hasAttrSomewhere(Attribute::AttrKind Attr) const;
301 /// \brief Return the attribute object that exists at the given index.
302 Attribute getAttribute(unsigned Index, Attribute::AttrKind Kind) const;
304 /// \brief Return the attribute object that exists at the given index.
305 Attribute getAttribute(unsigned Index, StringRef Kind) const;
307 /// \brief Return the alignment for the specified function parameter.
308 unsigned getParamAlignment(unsigned Idx) const;
310 /// \brief Get the stack alignment.
311 unsigned getStackAlignment(unsigned Index) const;
313 /// \brief Return the attributes at the index as a string.
314 std::string getAsString(unsigned Index, bool InAttrGrp = false) const;
316 typedef ArrayRef<Attribute>::iterator iterator;
318 iterator begin(unsigned Idx) const;
319 iterator end(unsigned Idx) const;
321 /// operator==/!= - Provide equality predicates.
322 bool operator==(const AttributeSet &RHS) const {
323 return pImpl == RHS.pImpl;
325 bool operator!=(const AttributeSet &RHS) const {
326 return pImpl != RHS.pImpl;
329 //===--------------------------------------------------------------------===//
330 // AttributeSet Introspection
331 //===--------------------------------------------------------------------===//
333 // FIXME: Remove this.
334 uint64_t Raw(unsigned Index) const;
336 /// \brief Return a raw pointer that uniquely identifies this attribute list.
337 void *getRawPointer() const {
341 /// \brief Return true if there are no attributes.
342 bool isEmpty() const {
343 return getNumSlots() == 0;
346 /// \brief Return the number of slots used in this attribute list. This is
347 /// the number of arguments that have an attribute set on them (including the
348 /// function itself).
349 unsigned getNumSlots() const;
351 /// \brief Return the index for the given slot.
352 uint64_t getSlotIndex(unsigned Slot) const;
354 /// \brief Return the attributes at the given slot.
355 AttributeSet getSlotAttributes(unsigned Slot) const;
360 //===----------------------------------------------------------------------===//
362 /// \brief Provide DenseMapInfo for AttributeSet.
363 template<> struct DenseMapInfo<AttributeSet> {
364 static inline AttributeSet getEmptyKey() {
365 uintptr_t Val = static_cast<uintptr_t>(-1);
366 Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable;
367 return AttributeSet(reinterpret_cast<AttributeSetImpl*>(Val));
369 static inline AttributeSet getTombstoneKey() {
370 uintptr_t Val = static_cast<uintptr_t>(-2);
371 Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable;
372 return AttributeSet(reinterpret_cast<AttributeSetImpl*>(Val));
374 static unsigned getHashValue(AttributeSet AS) {
375 return (unsigned((uintptr_t)AS.pImpl) >> 4) ^
376 (unsigned((uintptr_t)AS.pImpl) >> 9);
378 static bool isEqual(AttributeSet LHS, AttributeSet RHS) { return LHS == RHS; }
381 //===----------------------------------------------------------------------===//
383 /// \brief This class is used in conjunction with the Attribute::get method to
384 /// create an Attribute object. The object itself is uniquified. The Builder's
385 /// value, however, is not. So this can be used as a quick way to test for
386 /// equality, presence of attributes, etc.
388 std::bitset<Attribute::EndAttrKinds> Attrs;
389 std::map<std::string, std::string> TargetDepAttrs;
391 uint64_t StackAlignment;
393 AttrBuilder() : Attrs(0), Alignment(0), StackAlignment(0) {}
394 explicit AttrBuilder(uint64_t Val)
395 : Attrs(0), Alignment(0), StackAlignment(0) {
398 AttrBuilder(const Attribute &A) : Attrs(0), Alignment(0), StackAlignment(0) {
401 AttrBuilder(AttributeSet AS, unsigned Idx);
402 AttrBuilder(const AttrBuilder &B)
404 TargetDepAttrs(B.TargetDepAttrs.begin(), B.TargetDepAttrs.end()),
405 Alignment(B.Alignment), StackAlignment(B.StackAlignment) {}
409 /// \brief Add an attribute to the builder.
410 AttrBuilder &addAttribute(Attribute::AttrKind Val);
412 /// \brief Add the Attribute object to the builder.
413 AttrBuilder &addAttribute(Attribute A);
415 /// \brief Add the target-dependent attribute to the builder.
416 AttrBuilder &addAttribute(StringRef A, StringRef V = StringRef());
418 /// \brief Remove an attribute from the builder.
419 AttrBuilder &removeAttribute(Attribute::AttrKind Val);
421 /// \brief Remove the attributes from the builder.
422 AttrBuilder &removeAttributes(AttributeSet A, uint64_t Index);
424 /// \brief Remove the target-dependent attribute to the builder.
425 AttrBuilder &removeAttribute(StringRef A);
427 /// \brief Add the attributes from the builder.
428 AttrBuilder &merge(const AttrBuilder &B);
430 /// \brief Return true if the builder has the specified attribute.
431 bool contains(Attribute::AttrKind A) const {
432 assert((unsigned)A < Attribute::EndAttrKinds && "Attribute out of range!");
436 /// \brief Return true if the builder has the specified target-dependent
438 bool contains(StringRef A) const;
440 /// \brief Return true if the builder has IR-level attributes.
441 bool hasAttributes() const;
443 /// \brief Return true if the builder has any attribute that's in the
444 /// specified attribute.
445 bool hasAttributes(AttributeSet A, uint64_t Index) const;
447 /// \brief Return true if the builder has an alignment attribute.
448 bool hasAlignmentAttr() const;
450 /// \brief Retrieve the alignment attribute, if it exists.
451 uint64_t getAlignment() const { return Alignment; }
453 /// \brief Retrieve the stack alignment attribute, if it exists.
454 uint64_t getStackAlignment() const { return StackAlignment; }
456 /// \brief This turns an int alignment (which must be a power of 2) into the
457 /// form used internally in Attribute.
458 AttrBuilder &addAlignmentAttr(unsigned Align);
460 /// \brief This turns an int stack alignment (which must be a power of 2) into
461 /// the form used internally in Attribute.
462 AttrBuilder &addStackAlignmentAttr(unsigned Align);
464 /// \brief Return true if the builder contains no target-independent
466 bool empty() const { return Attrs.none(); }
468 // Iterators for target-dependent attributes.
469 typedef std::pair<std::string, std::string> td_type;
470 typedef std::map<std::string, std::string>::iterator td_iterator;
471 typedef std::map<std::string, std::string>::const_iterator td_const_iterator;
473 td_iterator td_begin() { return TargetDepAttrs.begin(); }
474 td_iterator td_end() { return TargetDepAttrs.end(); }
476 td_const_iterator td_begin() const { return TargetDepAttrs.begin(); }
477 td_const_iterator td_end() const { return TargetDepAttrs.end(); }
479 bool td_empty() const { return TargetDepAttrs.empty(); }
481 /// \brief Remove attributes that are used on functions only.
482 void removeFunctionOnlyAttrs();
484 bool operator==(const AttrBuilder &B);
485 bool operator!=(const AttrBuilder &B) {
486 return !(*this == B);
489 // FIXME: Remove this in 4.0.
491 /// \brief Add the raw value to the internal representation.
492 AttrBuilder &addRawValue(uint64_t Val);
495 namespace AttributeFuncs {
497 /// \brief Which attributes cannot be applied to a type.
498 AttributeSet typeIncompatible(Type *Ty, uint64_t Index);
500 } // end AttributeFuncs namespace
502 } // end llvm namespace