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
24 /// Attributes - A bitset of attributes.
25 typedef unsigned Attributes;
29 /// Function parameters and results can have attributes to indicate how they
30 /// should be treated by optimizations and code generation. This enumeration
31 /// lists the attributes that can be associated with parameters, function
32 /// results or the function itself.
33 /// @brief Function attributes.
35 const Attributes None = 0; ///< No attributes have been set
36 const Attributes ZExt = 1<<0; ///< Zero extended before/after call
37 const Attributes SExt = 1<<1; ///< Sign extended before/after call
38 const Attributes NoReturn = 1<<2; ///< Mark the function as not returning
39 const Attributes InReg = 1<<3; ///< Force argument to be passed in register
40 const Attributes StructRet = 1<<4; ///< Hidden pointer to structure to return
41 const Attributes NoUnwind = 1<<5; ///< Function doesn't unwind stack
42 const Attributes NoAlias = 1<<6; ///< Considered to not alias after call
43 const Attributes ByVal = 1<<7; ///< Pass structure by value
44 const Attributes Nest = 1<<8; ///< Nested function static chain
45 const Attributes ReadNone = 1<<9; ///< Function does not access memory
46 const Attributes ReadOnly = 1<<10; ///< Function only reads from memory
47 const Attributes NoInline = 1<<11; // inline=never
48 const Attributes AlwaysInline = 1<<12; // inline=always
49 const Attributes OptimizeForSize = 1<<13; // opt_size
50 const Attributes StackProtect = 1<<14; // Stack protection.
51 const Attributes StackProtectReq = 1<<15; // Stack protection required.
52 const Attributes Alignment = 0xffff<<16; ///< Alignment of parameter (16 bits)
53 // 0 = unknown, else in clear (not log)
55 /// @brief Attributes that only apply to function parameters.
56 const Attributes ParameterOnly = ByVal | Nest | StructRet;
58 /// @brief Attributes that only apply to function.
59 const Attributes FunctionOnly = NoReturn | NoUnwind | ReadNone | ReadOnly |
60 NoInline | AlwaysInline | OptimizeForSize | StackProtect | StackProtectReq;
62 /// @brief Parameter attributes that do not apply to vararg call arguments.
63 const Attributes VarArgsIncompatible = StructRet;
65 /// @brief Attributes that are mutually incompatible.
66 const Attributes MutuallyIncompatible[4] = {
67 ByVal | InReg | Nest | StructRet,
70 NoInline | AlwaysInline
73 /// @brief Which attributes cannot be applied to a type.
74 Attributes typeIncompatible(const Type *Ty);
76 /// This turns an int alignment (a power of 2, normally) into the
77 /// form used internally in Attributes.
78 inline Attributes constructAlignmentFromInt(unsigned i) {
82 /// The set of Attributes set in Attributes is converted to a
83 /// string of equivalent mnemonics. This is, presumably, for writing out
84 /// the mnemonics for the assembly writer.
85 /// @brief Convert attribute bits to text
86 std::string getAsString(Attributes Attrs);
87 } // end namespace Attribute
89 /// This is just a pair of values to associate a set of attributes
91 struct AttributeWithIndex {
92 Attributes Attrs; ///< The attributes that are set, or'd together.
93 unsigned Index; ///< Index of the parameter for which the attributes apply.
94 ///< Index 0 is used for return value attributes.
95 ///< Index ~0U is used for function attributes.
97 static AttributeWithIndex get(unsigned Idx, Attributes Attrs) {
105 //===----------------------------------------------------------------------===//
106 // AttrListPtr Smart Pointer
107 //===----------------------------------------------------------------------===//
109 class AttributeListImpl;
111 /// AttrListPtr - This class manages the ref count for the opaque
112 /// AttributeListImpl object and provides accessors for it.
114 /// AttrList - The attributes that we are managing. This can be null
115 /// to represent the empty attributes list.
116 AttributeListImpl *AttrList;
118 AttrListPtr() : AttrList(0) {}
119 AttrListPtr(const AttrListPtr &P);
120 const AttrListPtr &operator=(const AttrListPtr &RHS);
123 //===--------------------------------------------------------------------===//
124 // Attribute List Construction and Mutation
125 //===--------------------------------------------------------------------===//
127 /// get - Return a Attributes list with the specified parameter in it.
128 static AttrListPtr get(const AttributeWithIndex *Attr, unsigned NumAttrs);
130 /// get - Return a Attribute list with the parameters specified by the
131 /// consecutive random access iterator range.
132 template <typename Iter>
133 static AttrListPtr get(const Iter &I, const Iter &E) {
134 if (I == E) return AttrListPtr(); // Empty list.
135 return get(&*I, static_cast<unsigned>(E-I));
138 /// addAttr - Add the specified attribute at the specified index to this
139 /// attribute list. Since attribute lists are immutable, this
140 /// returns the new list.
141 AttrListPtr addAttr(unsigned Idx, Attributes Attrs) const;
143 /// removeAttr - Remove the specified attribute at the specified index from
144 /// this attribute list. Since attribute lists are immutable, this
145 /// returns the new list.
146 AttrListPtr removeAttr(unsigned Idx, Attributes Attrs) const;
148 //===--------------------------------------------------------------------===//
149 // Attribute List Accessors
150 //===--------------------------------------------------------------------===//
151 /// getParamAttributes - The attributes for the specified index are
153 Attributes getParamAttributes(unsigned Idx) const {
154 assert (Idx && Idx != ~0U && "Invalid parameter index!");
155 return getAttributes(Idx);
158 /// getRetAttributes - The attributes for the ret value are
160 Attributes getRetAttributes() const {
161 return getAttributes(0);
164 /// getFnAttributes - The function attributes are returned.
165 Attributes getFnAttributes() const {
166 return getAttributes(~0);
169 /// paramHasAttr - Return true if the specified parameter index has the
170 /// specified attribute set.
171 bool paramHasAttr(unsigned Idx, Attributes Attr) const {
172 return getAttributes(Idx) & Attr;
175 /// getParamAlignment - Return the alignment for the specified function
177 unsigned getParamAlignment(unsigned Idx) const {
178 return (getAttributes(Idx) & Attribute::Alignment) >> 16;
181 /// hasAttrSomewhere - Return true if the specified attribute is set for at
182 /// least one parameter or for the return value.
183 bool hasAttrSomewhere(Attributes Attr) const;
185 /// operator==/!= - Provide equality predicates.
186 bool operator==(const AttrListPtr &RHS) const { return AttrList == RHS.AttrList; }
187 bool operator!=(const AttrListPtr &RHS) const { return AttrList != RHS.AttrList; }
191 //===--------------------------------------------------------------------===//
192 // Attribute List Introspection
193 //===--------------------------------------------------------------------===//
195 /// getRawPointer - Return a raw pointer that uniquely identifies this
197 void *getRawPointer() const {
201 // Attributes are stored as a dense set of slots, where there is one
202 // slot for each argument that has an attribute. This allows walking over the
203 // dense set instead of walking the sparse list of attributes.
205 /// isEmpty - Return true if there are no attributes.
207 bool isEmpty() const {
208 return AttrList == 0;
211 /// getNumSlots - Return the number of slots used in this attribute list.
212 /// This is the number of arguments that have an attribute set on them
213 /// (including the function itself).
214 unsigned getNumSlots() const;
216 /// getSlot - Return the AttributeWithIndex at the specified slot. This
217 /// holds a index number plus a set of attributes.
218 const AttributeWithIndex &getSlot(unsigned Slot) const;
221 explicit AttrListPtr(AttributeListImpl *L);
223 /// getAttributes - The attributes for the specified index are
224 /// returned. Attributes for the result are denoted with Idx = 0.
225 Attributes getAttributes(unsigned Idx) const;
229 } // End llvm namespace