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 //===----------------------------------------------------------------------===//
10 // This file contains the simple types necessary to represent the
11 // attributes associated with functions and their calls.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_ATTRIBUTES_H
16 #define LLVM_ATTRIBUTES_H
18 #include "llvm/AttributesImpl.h"
19 #include "llvm/Support/MathExtras.h"
20 #include "llvm/ADT/ArrayRef.h"
31 /// AttrConst - We use this proxy POD type to allow constructing Attributes
32 /// constants using initializer lists. Do not use this class directly.
35 AttrConst operator | (const AttrConst Attrs) const {
36 AttrConst Res = {v | Attrs.v};
39 AttrConst operator ~ () const {
45 /// Function parameters and results can have attributes to indicate how they
46 /// should be treated by optimizations and code generation. This enumeration
47 /// lists the attributes that can be associated with parameters, function
48 /// results or the function itself.
49 /// @brief Function attributes.
51 /// We declare AttrConst objects that will be used throughout the code and also
52 /// raw uint64_t objects with _i suffix to be used below for other constant
53 /// declarations. This is done to avoid static CTORs and at the same time to
54 /// keep type-safety of Attributes.
55 #define DECLARE_LLVM_ATTRIBUTE(name, value) \
56 const uint64_t name##_i = value; \
57 const AttrConst name = {value};
59 DECLARE_LLVM_ATTRIBUTE(None,0) ///< No attributes have been set
60 DECLARE_LLVM_ATTRIBUTE(ZExt,1<<0) ///< Zero extended before/after call
61 DECLARE_LLVM_ATTRIBUTE(SExt,1<<1) ///< Sign extended before/after call
62 DECLARE_LLVM_ATTRIBUTE(NoReturn,1<<2) ///< Mark the function as not returning
63 DECLARE_LLVM_ATTRIBUTE(InReg,1<<3) ///< Force argument to be passed in register
64 DECLARE_LLVM_ATTRIBUTE(StructRet,1<<4) ///< Hidden pointer to structure to return
65 DECLARE_LLVM_ATTRIBUTE(NoUnwind,1<<5) ///< Function doesn't unwind stack
66 DECLARE_LLVM_ATTRIBUTE(NoAlias,1<<6) ///< Considered to not alias after call
67 DECLARE_LLVM_ATTRIBUTE(ByVal,1<<7) ///< Pass structure by value
68 DECLARE_LLVM_ATTRIBUTE(Nest,1<<8) ///< Nested function static chain
69 DECLARE_LLVM_ATTRIBUTE(ReadNone,1<<9) ///< Function does not access memory
70 DECLARE_LLVM_ATTRIBUTE(ReadOnly,1<<10) ///< Function only reads from memory
71 DECLARE_LLVM_ATTRIBUTE(NoInline,1<<11) ///< inline=never
72 DECLARE_LLVM_ATTRIBUTE(AlwaysInline,1<<12) ///< inline=always
73 DECLARE_LLVM_ATTRIBUTE(OptimizeForSize,1<<13) ///< opt_size
74 DECLARE_LLVM_ATTRIBUTE(StackProtect,1<<14) ///< Stack protection.
75 DECLARE_LLVM_ATTRIBUTE(StackProtectReq,1<<15) ///< Stack protection required.
76 DECLARE_LLVM_ATTRIBUTE(Alignment,31<<16) ///< Alignment of parameter (5 bits)
77 // stored as log2 of alignment with +1 bias
78 // 0 means unaligned different from align 1
79 DECLARE_LLVM_ATTRIBUTE(NoCapture,1<<21) ///< Function creates no aliases of pointer
80 DECLARE_LLVM_ATTRIBUTE(NoRedZone,1<<22) /// disable redzone
81 DECLARE_LLVM_ATTRIBUTE(NoImplicitFloat,1<<23) /// disable implicit floating point
83 DECLARE_LLVM_ATTRIBUTE(Naked,1<<24) ///< Naked function
84 DECLARE_LLVM_ATTRIBUTE(InlineHint,1<<25) ///< source said inlining was
86 DECLARE_LLVM_ATTRIBUTE(StackAlignment,7<<26) ///< Alignment of stack for
87 ///function (3 bits) stored as log2
88 ///of alignment with +1 bias
89 ///0 means unaligned (different from
91 DECLARE_LLVM_ATTRIBUTE(ReturnsTwice,1<<29) ///< Function can return twice
92 DECLARE_LLVM_ATTRIBUTE(UWTable,1<<30) ///< Function must be in a unwind
94 DECLARE_LLVM_ATTRIBUTE(NonLazyBind,1U<<31) ///< Function is called early and/or
95 /// often, so lazy binding isn't
97 DECLARE_LLVM_ATTRIBUTE(AddressSafety,1ULL<<32) ///< Address safety checking is on.
99 #undef DECLARE_LLVM_ATTRIBUTE
101 /// Note that uwtable is about the ABI or the user mandating an entry in the
102 /// unwind table. The nounwind attribute is about an exception passing by the
104 /// In a theoretical system that uses tables for profiling and sjlj for
105 /// exceptions, they would be fully independent. In a normal system that
106 /// uses tables for both, the semantics are:
107 /// nil = Needs an entry because an exception might pass by.
108 /// nounwind = No need for an entry
109 /// uwtable = Needs an entry because the ABI says so and because
110 /// an exception might pass by.
111 /// uwtable + nounwind = Needs an entry because the ABI says so.
113 /// @brief Attributes that only apply to function parameters.
114 const AttrConst ParameterOnly = {ByVal_i | Nest_i |
115 StructRet_i | NoCapture_i};
117 /// @brief Attributes that may be applied to the function itself. These cannot
118 /// be used on return values or function parameters.
119 const AttrConst FunctionOnly = {NoReturn_i | NoUnwind_i | ReadNone_i |
120 ReadOnly_i | NoInline_i | AlwaysInline_i | OptimizeForSize_i |
121 StackProtect_i | StackProtectReq_i | NoRedZone_i | NoImplicitFloat_i |
122 Naked_i | InlineHint_i | StackAlignment_i |
123 UWTable_i | NonLazyBind_i | ReturnsTwice_i | AddressSafety_i};
125 /// @brief Parameter attributes that do not apply to vararg call arguments.
126 const AttrConst VarArgsIncompatible = {StructRet_i};
128 /// @brief Attributes that are mutually incompatible.
129 const AttrConst MutuallyIncompatible[5] = {
130 {ByVal_i | Nest_i | StructRet_i},
131 {ByVal_i | Nest_i | InReg_i },
133 {ReadNone_i | ReadOnly_i},
134 {NoInline_i | AlwaysInline_i}
137 } // namespace Attribute
139 /// AttributeImpl - The internal representation of the Attributes class. This is
141 class AttributesImpl;
143 /// Attributes - A bitset of attributes.
147 None = 0, ///< No attributes have been set
148 ZExt = 1, ///< Zero extended before/after call
149 SExt = 2, ///< Sign extended before/after call
150 NoReturn = 3, ///< Mark the function as not returning
151 InReg = 4, ///< Force argument to be passed in register
152 StructRet = 5, ///< Hidden pointer to structure to return
153 NoUnwind = 6, ///< Function doesn't unwind stack
154 NoAlias = 7, ///< Considered to not alias after call
155 ByVal = 8, ///< Pass structure by value
156 Nest = 9, ///< Nested function static chain
157 ReadNone = 10, ///< Function does not access memory
158 ReadOnly = 11, ///< Function only reads from memory
159 NoInline = 12, ///< inline=never
160 AlwaysInline = 13, ///< inline=always
161 OptimizeForSize = 14, ///< opt_size
162 StackProtect = 15, ///< Stack protection.
163 StackProtectReq = 16, ///< Stack protection required.
164 Alignment = 17, ///< Alignment of parameter (5 bits)
165 ///< stored as log2 of alignment with +1 bias
166 ///< 0 means unaligned different from align 1
167 NoCapture = 18, ///< Function creates no aliases of pointer
168 NoRedZone = 19, ///< Disable redzone
169 NoImplicitFloat = 20, ///< Disable implicit floating point insts
170 Naked = 21, ///< Naked function
171 InlineHint = 22, ///< Source said inlining was desirable
172 StackAlignment = 23, ///< Alignment of stack for function (3 bits)
173 ///< stored as log2 of alignment with +1 bias 0
174 ///< means unaligned (different from
176 ReturnsTwice = 24, ///< Function can return twice
177 UWTable = 25, ///< Function must be in a unwind table
178 NonLazyBind = 26, ///< Function is called early and/or
179 ///< often, so lazy binding isn't worthwhile
180 AddressSafety = 27 ///< Address safety checking is on.
183 // Currently, we need less than 64 bits.
184 AttributesImpl Attrs;
186 explicit Attributes(AttributesImpl *A);
188 Attributes() : Attrs(0) {}
189 explicit Attributes(uint64_t Val);
190 /*implicit*/ Attributes(Attribute::AttrConst Val);
191 Attributes(const Attributes &A);
194 friend class Attributes;
197 Builder() : Bits(0) {}
198 Builder(const Attributes &A) : Bits(A.Raw()) {}
200 void clear() { Bits = 0; }
202 bool hasAttributes() const;
203 bool hasAttributes(const Attributes &A) const;
204 bool hasAlignmentAttr() const;
206 uint64_t getAlignment() const;
208 void addAddressSafetyAttr();
209 void addAlwaysInlineAttr();
211 void addInlineHintAttr();
215 void addNoAliasAttr();
216 void addNoCaptureAttr();
217 void addNoImplicitFloatAttr();
218 void addNoInlineAttr();
219 void addNonLazyBindAttr();
220 void addNoRedZoneAttr();
221 void addNoReturnAttr();
222 void addNoUnwindAttr();
223 void addOptimizeForSizeAttr();
224 void addReadNoneAttr();
225 void addReadOnlyAttr();
226 void addReturnsTwiceAttr();
228 void addStackProtectAttr();
229 void addStackProtectReqAttr();
230 void addStructRetAttr();
231 void addUWTableAttr();
234 void addAlignmentAttr(unsigned Align);
235 void addStackAlignmentAttr(unsigned Align);
237 void removeAttributes(const Attributes &A);
239 void removeAddressSafetyAttr();
240 void removeAlwaysInlineAttr();
241 void removeByValAttr();
242 void removeInlineHintAttr();
243 void removeInRegAttr();
244 void removeNakedAttr();
245 void removeNestAttr();
246 void removeNoAliasAttr();
247 void removeNoCaptureAttr();
248 void removeNoImplicitFloatAttr();
249 void removeNoInlineAttr();
250 void removeNonLazyBindAttr();
251 void removeNoRedZoneAttr();
252 void removeNoReturnAttr();
253 void removeNoUnwindAttr();
254 void removeOptimizeForSizeAttr();
255 void removeReadNoneAttr();
256 void removeReadOnlyAttr();
257 void removeReturnsTwiceAttr();
258 void removeSExtAttr();
259 void removeStackProtectAttr();
260 void removeStackProtectReqAttr();
261 void removeStructRetAttr();
262 void removeUWTableAttr();
263 void removeZExtAttr();
265 void removeAlignmentAttr();
266 void removeStackAlignmentAttr();
269 /// get - Return a uniquified Attributes object. This takes the uniquified
270 /// value from the Builder and wraps it in the Attributes class.
271 static Attributes get(Builder &B);
272 static Attributes get(LLVMContext &Context, Builder &B);
274 /// @brief Parameter attributes that do not apply to vararg call arguments.
275 bool hasIncompatibleWithVarArgsAttrs() const {
276 return hasAttribute(Attributes::StructRet);
279 // Attribute query methods.
280 // FIXME: StackAlignment & Alignment attributes have no predicate methods.
281 bool hasAttributes() const {
282 return Attrs.hasAttributes();
284 bool hasAttributes(const Attributes &A) const;
285 bool hasAttribute(AttrVal Val) const;
287 /// This returns the alignment field of an attribute as a byte alignment
289 unsigned getAlignment() const;
291 /// This returns the stack alignment field of an attribute as a byte alignment
293 unsigned getStackAlignment() const;
295 bool isEmptyOrSingleton() const;
297 // This is a "safe bool() operator".
298 operator const void *() const { return Attrs.Bits ? this : 0; }
299 bool operator == (const Attributes &A) const {
300 return Attrs.Bits == A.Attrs.Bits;
302 bool operator != (const Attributes &A) const {
303 return Attrs.Bits != A.Attrs.Bits;
306 Attributes operator | (const Attributes &A) const;
307 Attributes operator & (const Attributes &A) const;
308 Attributes operator ^ (const Attributes &A) const;
309 Attributes &operator |= (const Attributes &A);
310 Attributes &operator &= (const Attributes &A);
311 Attributes operator ~ () const;
313 uint64_t Raw() const;
315 /// constructAlignmentFromInt - This turns an int alignment (a power of 2,
316 /// normally) into the form used internally in Attributes.
317 static Attributes constructAlignmentFromInt(unsigned i) {
318 // Default alignment, allow the target to define how to align it.
320 return Attribute::None;
322 assert(isPowerOf2_32(i) && "Alignment must be a power of two.");
323 assert(i <= 0x40000000 && "Alignment too large.");
324 return Attributes((Log2_32(i)+1) << 16);
327 /// constructStackAlignmentFromInt - This turns an int stack alignment (which
328 /// must be a power of 2) into the form used internally in Attributes.
329 static Attributes constructStackAlignmentFromInt(unsigned i) {
330 // Default alignment, allow the target to define how to align it.
332 return Attribute::None;
334 assert(isPowerOf2_32(i) && "Alignment must be a power of two.");
335 assert(i <= 0x100 && "Alignment too large.");
336 return Attributes((Log2_32(i)+1) << 26);
339 /// @brief Which attributes cannot be applied to a type.
340 static Attributes typeIncompatible(Type *Ty);
342 /// encodeLLVMAttributesForBitcode - This returns an integer containing an
343 /// encoding of all the LLVM attributes found in the given attribute bitset.
344 /// Any change to this encoding is a breaking change to bitcode compatibility.
345 static uint64_t encodeLLVMAttributesForBitcode(Attributes Attrs) {
346 // FIXME: It doesn't make sense to store the alignment information as an
347 // expanded out value, we should store it as a log2 value. However, we
348 // can't just change that here without breaking bitcode compatibility. If
349 // this ever becomes a problem in practice, we should introduce new tag
350 // numbers in the bitcode file and have those tags use a more efficiently
351 // encoded alignment field.
353 // Store the alignment in the bitcode as a 16-bit raw value instead of a
354 // 5-bit log2 encoded value. Shift the bits above the alignment up by 11
356 uint64_t EncodedAttrs = Attrs.Raw() & 0xffff;
357 if (Attrs.hasAttribute(Attributes::Alignment))
358 EncodedAttrs |= (1ULL << 16) <<
359 (((Attrs.Raw() & Attribute::Alignment_i) - 1) >> 16);
360 EncodedAttrs |= (Attrs.Raw() & (0xfffULL << 21)) << 11;
364 /// decodeLLVMAttributesForBitcode - This returns an attribute bitset
365 /// containing the LLVM attributes that have been decoded from the given
366 /// integer. This function must stay in sync with
367 /// 'encodeLLVMAttributesForBitcode'.
368 static Attributes decodeLLVMAttributesForBitcode(uint64_t EncodedAttrs) {
369 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
370 // the bits above 31 down by 11 bits.
371 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
372 assert((!Alignment || isPowerOf2_32(Alignment)) &&
373 "Alignment must be a power of two.");
375 Attributes Attrs(EncodedAttrs & 0xffff);
377 Attrs |= Attributes::constructAlignmentFromInt(Alignment);
378 Attrs |= Attributes((EncodedAttrs & (0xfffULL << 32)) >> 11);
382 /// getAsString - The set of Attributes set in Attributes is converted to a
383 /// string of equivalent mnemonics. This is, presumably, for writing out the
384 /// mnemonics for the assembly writer.
385 /// @brief Convert attribute bits to text
386 std::string getAsString() const;
389 //===----------------------------------------------------------------------===//
390 // AttributeWithIndex
391 //===----------------------------------------------------------------------===//
393 /// AttributeWithIndex - This is just a pair of values to associate a set of
394 /// attributes with an index.
395 struct AttributeWithIndex {
396 Attributes Attrs; ///< The attributes that are set, or'd together.
397 unsigned Index; ///< Index of the parameter for which the attributes apply.
398 ///< Index 0 is used for return value attributes.
399 ///< Index ~0U is used for function attributes.
401 static AttributeWithIndex get(unsigned Idx, Attributes Attrs) {
402 AttributeWithIndex P;
409 //===----------------------------------------------------------------------===//
410 // AttrListPtr Smart Pointer
411 //===----------------------------------------------------------------------===//
413 class AttributeListImpl;
415 /// AttrListPtr - This class manages the ref count for the opaque
416 /// AttributeListImpl object and provides accessors for it.
418 /// AttrList - The attributes that we are managing. This can be null
419 /// to represent the empty attributes list.
420 AttributeListImpl *AttrList;
422 AttrListPtr() : AttrList(0) {}
423 AttrListPtr(const AttrListPtr &P);
424 const AttrListPtr &operator=(const AttrListPtr &RHS);
427 //===--------------------------------------------------------------------===//
428 // Attribute List Construction and Mutation
429 //===--------------------------------------------------------------------===//
431 /// get - Return a Attributes list with the specified parameters in it.
432 static AttrListPtr get(ArrayRef<AttributeWithIndex> Attrs);
434 /// addAttr - Add the specified attribute at the specified index to this
435 /// attribute list. Since attribute lists are immutable, this
436 /// returns the new list.
437 AttrListPtr addAttr(unsigned Idx, Attributes Attrs) const;
439 /// removeAttr - Remove the specified attribute at the specified index from
440 /// this attribute list. Since attribute lists are immutable, this
441 /// returns the new list.
442 AttrListPtr removeAttr(unsigned Idx, Attributes Attrs) const;
444 //===--------------------------------------------------------------------===//
445 // Attribute List Accessors
446 //===--------------------------------------------------------------------===//
447 /// getParamAttributes - The attributes for the specified index are
449 Attributes getParamAttributes(unsigned Idx) const {
450 return getAttributes(Idx);
453 /// getRetAttributes - The attributes for the ret value are
455 Attributes getRetAttributes() const {
456 return getAttributes(0);
459 /// getFnAttributes - The function attributes are returned.
460 Attributes getFnAttributes() const {
461 return getAttributes(~0U);
464 /// paramHasAttr - Return true if the specified parameter index has the
465 /// specified attribute set.
466 bool paramHasAttr(unsigned Idx, Attributes Attr) const {
467 return getAttributes(Idx).hasAttributes(Attr);
470 /// getParamAlignment - Return the alignment for the specified function
472 unsigned getParamAlignment(unsigned Idx) const {
473 return getAttributes(Idx).getAlignment();
476 /// hasAttrSomewhere - Return true if the specified attribute is set for at
477 /// least one parameter or for the return value.
478 bool hasAttrSomewhere(Attributes Attr) const;
480 unsigned getNumAttrs() const;
481 Attributes &getAttributesAtIndex(unsigned i) const;
483 /// operator==/!= - Provide equality predicates.
484 bool operator==(const AttrListPtr &RHS) const
485 { return AttrList == RHS.AttrList; }
486 bool operator!=(const AttrListPtr &RHS) const
487 { return AttrList != RHS.AttrList; }
491 //===--------------------------------------------------------------------===//
492 // Attribute List Introspection
493 //===--------------------------------------------------------------------===//
495 /// getRawPointer - Return a raw pointer that uniquely identifies this
497 void *getRawPointer() const {
501 // Attributes are stored as a dense set of slots, where there is one
502 // slot for each argument that has an attribute. This allows walking over the
503 // dense set instead of walking the sparse list of attributes.
505 /// isEmpty - Return true if there are no attributes.
507 bool isEmpty() const {
508 return AttrList == 0;
511 /// getNumSlots - Return the number of slots used in this attribute list.
512 /// This is the number of arguments that have an attribute set on them
513 /// (including the function itself).
514 unsigned getNumSlots() const;
516 /// getSlot - Return the AttributeWithIndex at the specified slot. This
517 /// holds a index number plus a set of attributes.
518 const AttributeWithIndex &getSlot(unsigned Slot) const;
521 explicit AttrListPtr(AttributeListImpl *L);
523 /// getAttributes - The attributes for the specified index are
524 /// returned. Attributes for the result are denoted with Idx = 0.
525 Attributes getAttributes(unsigned Idx) const;
528 } // End llvm namespace