1 //===-- Attributes.cpp - Implement AttributesList -------------------------===//
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 implements the AttributesList class and Attribute utilities.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Attributes.h"
15 #include "llvm/Type.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/ADT/FoldingSet.h"
18 #include "llvm/System/Atomic.h"
19 #include "llvm/System/Mutex.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/ManagedStatic.h"
22 #include "llvm/Support/raw_ostream.h"
25 //===----------------------------------------------------------------------===//
26 // Attribute Function Definitions
27 //===----------------------------------------------------------------------===//
29 std::string Attribute::getAsString(Attributes Attrs) {
31 if (Attrs & Attribute::ZExt)
33 if (Attrs & Attribute::SExt)
35 if (Attrs & Attribute::NoReturn)
36 Result += "noreturn ";
37 if (Attrs & Attribute::NoUnwind)
38 Result += "nounwind ";
39 if (Attrs & Attribute::InReg)
41 if (Attrs & Attribute::NoAlias)
43 if (Attrs & Attribute::NoCapture)
44 Result += "nocapture ";
45 if (Attrs & Attribute::StructRet)
47 if (Attrs & Attribute::ByVal)
49 if (Attrs & Attribute::Nest)
51 if (Attrs & Attribute::ReadNone)
52 Result += "readnone ";
53 if (Attrs & Attribute::ReadOnly)
54 Result += "readonly ";
55 if (Attrs & Attribute::OptimizeForSize)
57 if (Attrs & Attribute::NoInline)
58 Result += "noinline ";
59 if (Attrs & Attribute::InlineHint)
60 Result += "inlinehint ";
61 if (Attrs & Attribute::AlwaysInline)
62 Result += "alwaysinline ";
63 if (Attrs & Attribute::StackProtect)
65 if (Attrs & Attribute::StackProtectReq)
67 if (Attrs & Attribute::NoRedZone)
68 Result += "noredzone ";
69 if (Attrs & Attribute::NoImplicitFloat)
70 Result += "noimplicitfloat ";
71 if (Attrs & Attribute::Naked)
73 if (Attrs & Attribute::Hotpatch)
74 Result += "hotpatch ";
75 if (Attrs & Attribute::StackAlignment) {
76 Result += "alignstack(";
77 Result += utostr(Attribute::getStackAlignmentFromAttrs(Attrs));
80 if (Attrs & Attribute::Alignment) {
82 Result += utostr(Attribute::getAlignmentFromAttrs(Attrs));
85 // Trim the trailing space.
86 assert(!Result.empty() && "Unknown attribute!");
87 Result.erase(Result.end()-1);
91 Attributes Attribute::typeIncompatible(const Type *Ty) {
92 Attributes Incompatible = None;
94 if (!Ty->isIntegerTy())
95 // Attributes that only apply to integers.
96 Incompatible |= SExt | ZExt;
98 if (!Ty->isPointerTy())
99 // Attributes that only apply to pointers.
100 Incompatible |= ByVal | Nest | NoAlias | StructRet | NoCapture;
105 //===----------------------------------------------------------------------===//
106 // AttributeListImpl Definition
107 //===----------------------------------------------------------------------===//
111 static ManagedStatic<sys::SmartMutex<true> > ALMutex;
113 class AttributeListImpl : public FoldingSetNode {
114 sys::cas_flag RefCount;
116 // AttributesList is uniqued, these should not be publicly available.
117 void operator=(const AttributeListImpl &); // Do not implement
118 AttributeListImpl(const AttributeListImpl &); // Do not implement
119 ~AttributeListImpl(); // Private implementation
121 SmallVector<AttributeWithIndex, 4> Attrs;
123 AttributeListImpl(const AttributeWithIndex *Attr, unsigned NumAttrs)
124 : Attrs(Attr, Attr+NumAttrs) {
129 sys::SmartScopedLock<true> Lock(*ALMutex);
133 sys::SmartScopedLock<true> Lock(*ALMutex);
134 sys::cas_flag new_val = --RefCount;
139 void Profile(FoldingSetNodeID &ID) const {
140 Profile(ID, Attrs.data(), Attrs.size());
142 static void Profile(FoldingSetNodeID &ID, const AttributeWithIndex *Attr,
144 for (unsigned i = 0; i != NumAttrs; ++i)
145 ID.AddInteger(uint64_t(Attr[i].Attrs) << 32 | unsigned(Attr[i].Index));
150 static ManagedStatic<FoldingSet<AttributeListImpl> > AttributesLists;
152 AttributeListImpl::~AttributeListImpl() {
153 // NOTE: Lock must be acquired by caller.
154 AttributesLists->RemoveNode(this);
158 AttrListPtr AttrListPtr::get(const AttributeWithIndex *Attrs, unsigned NumAttrs) {
159 // If there are no attributes then return a null AttributesList pointer.
161 return AttrListPtr();
164 for (unsigned i = 0; i != NumAttrs; ++i) {
165 assert(Attrs[i].Attrs != Attribute::None &&
166 "Pointless attribute!");
167 assert((!i || Attrs[i-1].Index < Attrs[i].Index) &&
168 "Misordered AttributesList!");
172 // Otherwise, build a key to look up the existing attributes.
174 AttributeListImpl::Profile(ID, Attrs, NumAttrs);
177 sys::SmartScopedLock<true> Lock(*ALMutex);
179 AttributeListImpl *PAL =
180 AttributesLists->FindNodeOrInsertPos(ID, InsertPos);
182 // If we didn't find any existing attributes of the same shape then
183 // create a new one and insert it.
185 PAL = new AttributeListImpl(Attrs, NumAttrs);
186 AttributesLists->InsertNode(PAL, InsertPos);
189 // Return the AttributesList that we found or created.
190 return AttrListPtr(PAL);
194 //===----------------------------------------------------------------------===//
195 // AttrListPtr Method Implementations
196 //===----------------------------------------------------------------------===//
198 AttrListPtr::AttrListPtr(AttributeListImpl *LI) : AttrList(LI) {
199 if (LI) LI->AddRef();
202 AttrListPtr::AttrListPtr(const AttrListPtr &P) : AttrList(P.AttrList) {
203 if (AttrList) AttrList->AddRef();
206 const AttrListPtr &AttrListPtr::operator=(const AttrListPtr &RHS) {
207 sys::SmartScopedLock<true> Lock(*ALMutex);
208 if (AttrList == RHS.AttrList) return *this;
209 if (AttrList) AttrList->DropRef();
210 AttrList = RHS.AttrList;
211 if (AttrList) AttrList->AddRef();
215 AttrListPtr::~AttrListPtr() {
216 if (AttrList) AttrList->DropRef();
219 /// getNumSlots - Return the number of slots used in this attribute list.
220 /// This is the number of arguments that have an attribute set on them
221 /// (including the function itself).
222 unsigned AttrListPtr::getNumSlots() const {
223 return AttrList ? AttrList->Attrs.size() : 0;
226 /// getSlot - Return the AttributeWithIndex at the specified slot. This
227 /// holds a number plus a set of attributes.
228 const AttributeWithIndex &AttrListPtr::getSlot(unsigned Slot) const {
229 assert(AttrList && Slot < AttrList->Attrs.size() && "Slot # out of range!");
230 return AttrList->Attrs[Slot];
234 /// getAttributes - The attributes for the specified index are
235 /// returned. Attributes for the result are denoted with Idx = 0.
236 /// Function notes are denoted with idx = ~0.
237 Attributes AttrListPtr::getAttributes(unsigned Idx) const {
238 if (AttrList == 0) return Attribute::None;
240 const SmallVector<AttributeWithIndex, 4> &Attrs = AttrList->Attrs;
241 for (unsigned i = 0, e = Attrs.size(); i != e && Attrs[i].Index <= Idx; ++i)
242 if (Attrs[i].Index == Idx)
243 return Attrs[i].Attrs;
244 return Attribute::None;
247 /// hasAttrSomewhere - Return true if the specified attribute is set for at
248 /// least one parameter or for the return value.
249 bool AttrListPtr::hasAttrSomewhere(Attributes Attr) const {
250 if (AttrList == 0) return false;
252 const SmallVector<AttributeWithIndex, 4> &Attrs = AttrList->Attrs;
253 for (unsigned i = 0, e = Attrs.size(); i != e; ++i)
254 if (Attrs[i].Attrs & Attr)
260 AttrListPtr AttrListPtr::addAttr(unsigned Idx, Attributes Attrs) const {
261 Attributes OldAttrs = getAttributes(Idx);
263 // FIXME it is not obvious how this should work for alignment.
264 // For now, say we can't change a known alignment.
265 Attributes OldAlign = OldAttrs & Attribute::Alignment;
266 Attributes NewAlign = Attrs & Attribute::Alignment;
267 assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
268 "Attempt to change alignment!");
271 Attributes NewAttrs = OldAttrs | Attrs;
272 if (NewAttrs == OldAttrs)
275 SmallVector<AttributeWithIndex, 8> NewAttrList;
277 NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
279 const SmallVector<AttributeWithIndex, 4> &OldAttrList = AttrList->Attrs;
280 unsigned i = 0, e = OldAttrList.size();
281 // Copy attributes for arguments before this one.
282 for (; i != e && OldAttrList[i].Index < Idx; ++i)
283 NewAttrList.push_back(OldAttrList[i]);
285 // If there are attributes already at this index, merge them in.
286 if (i != e && OldAttrList[i].Index == Idx) {
287 Attrs |= OldAttrList[i].Attrs;
291 NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
293 // Copy attributes for arguments after this one.
294 NewAttrList.insert(NewAttrList.end(),
295 OldAttrList.begin()+i, OldAttrList.end());
298 return get(NewAttrList.data(), NewAttrList.size());
301 AttrListPtr AttrListPtr::removeAttr(unsigned Idx, Attributes Attrs) const {
303 // FIXME it is not obvious how this should work for alignment.
304 // For now, say we can't pass in alignment, which no current use does.
305 assert(!(Attrs & Attribute::Alignment) && "Attempt to exclude alignment!");
307 if (AttrList == 0) return AttrListPtr();
309 Attributes OldAttrs = getAttributes(Idx);
310 Attributes NewAttrs = OldAttrs & ~Attrs;
311 if (NewAttrs == OldAttrs)
314 SmallVector<AttributeWithIndex, 8> NewAttrList;
315 const SmallVector<AttributeWithIndex, 4> &OldAttrList = AttrList->Attrs;
316 unsigned i = 0, e = OldAttrList.size();
318 // Copy attributes for arguments before this one.
319 for (; i != e && OldAttrList[i].Index < Idx; ++i)
320 NewAttrList.push_back(OldAttrList[i]);
322 // If there are attributes already at this index, merge them in.
323 assert(OldAttrList[i].Index == Idx && "Attribute isn't set?");
324 Attrs = OldAttrList[i].Attrs & ~Attrs;
326 if (Attrs) // If any attributes left for this parameter, add them.
327 NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
329 // Copy attributes for arguments after this one.
330 NewAttrList.insert(NewAttrList.end(),
331 OldAttrList.begin()+i, OldAttrList.end());
333 return get(NewAttrList.data(), NewAttrList.size());
336 void AttrListPtr::dump() const {
338 for (unsigned i = 0; i < getNumSlots(); ++i) {
339 const AttributeWithIndex &PAWI = getSlot(i);
340 dbgs() << "{" << PAWI.Index << "," << PAWI.Attrs << "} ";