Make one of the AttributeSet ctors maintain the invariant that the
[oota-llvm.git] / lib / IR / Attributes.cpp
1 //===-- Attributes.cpp - Implement AttributesList -------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // \file
11 // \brief This file implements the Attribute, AttributeImpl, AttrBuilder,
12 // AttributeSetImpl, and AttributeSet classes.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #include "llvm/IR/Attributes.h"
17 #include "AttributeImpl.h"
18 #include "LLVMContextImpl.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/IR/Type.h"
21 #include "llvm/Support/Atomic.h"
22 #include "llvm/Support/Debug.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/Mutex.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include <algorithm>
27 using namespace llvm;
28
29 //===----------------------------------------------------------------------===//
30 // Attribute Construction Methods
31 //===----------------------------------------------------------------------===//
32
33 Attribute Attribute::get(LLVMContext &Context, Attribute::AttrKind Kind,
34                          uint64_t Val) {
35   LLVMContextImpl *pImpl = Context.pImpl;
36   FoldingSetNodeID ID;
37   ID.AddInteger(Kind);
38   if (Val) ID.AddInteger(Val);
39
40   void *InsertPoint;
41   AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
42
43   if (!PA) {
44     // If we didn't find any existing attributes of the same shape then create a
45     // new one and insert it.
46     if (!Val)
47       PA = new EnumAttributeImpl(Kind);
48     else
49       PA = new AlignAttributeImpl(Kind, Val);
50     pImpl->AttrsSet.InsertNode(PA, InsertPoint);
51   }
52
53   // Return the Attribute that we found or created.
54   return Attribute(PA);
55 }
56
57 Attribute Attribute::get(LLVMContext &Context, StringRef Kind, StringRef Val) {
58   LLVMContextImpl *pImpl = Context.pImpl;
59   FoldingSetNodeID ID;
60   ID.AddString(Kind);
61   if (!Val.empty()) ID.AddString(Val);
62
63   void *InsertPoint;
64   AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
65
66   if (!PA) {
67     // If we didn't find any existing attributes of the same shape then create a
68     // new one and insert it.
69     PA = new StringAttributeImpl(Kind, Val);
70     pImpl->AttrsSet.InsertNode(PA, InsertPoint);
71   }
72
73   // Return the Attribute that we found or created.
74   return Attribute(PA);
75 }
76
77 Attribute Attribute::getWithAlignment(LLVMContext &Context, uint64_t Align) {
78   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
79   assert(Align <= 0x40000000 && "Alignment too large.");
80   return get(Context, Alignment, Align);
81 }
82
83 Attribute Attribute::getWithStackAlignment(LLVMContext &Context,
84                                            uint64_t Align) {
85   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
86   assert(Align <= 0x100 && "Alignment too large.");
87   return get(Context, StackAlignment, Align);
88 }
89
90 //===----------------------------------------------------------------------===//
91 // Attribute Accessor Methods
92 //===----------------------------------------------------------------------===//
93
94 bool Attribute::isEnumAttribute() const {
95   return pImpl && pImpl->isEnumAttribute();
96 }
97
98 bool Attribute::isAlignAttribute() const {
99   return pImpl && pImpl->isAlignAttribute();
100 }
101
102 bool Attribute::isStringAttribute() const {
103   return pImpl && pImpl->isStringAttribute();
104 }
105
106 Attribute::AttrKind Attribute::getKindAsEnum() const {
107   if (!pImpl) return None;
108   assert((isEnumAttribute() || isAlignAttribute()) &&
109          "Invalid attribute type to get the kind as an enum!");
110   return pImpl ? pImpl->getKindAsEnum() : None;
111 }
112
113 uint64_t Attribute::getValueAsInt() const {
114   if (!pImpl) return 0;
115   assert(isAlignAttribute() &&
116          "Expected the attribute to be an alignment attribute!");
117   return pImpl ? pImpl->getValueAsInt() : 0;
118 }
119
120 StringRef Attribute::getKindAsString() const {
121   if (!pImpl) return StringRef();
122   assert(isStringAttribute() &&
123          "Invalid attribute type to get the kind as a string!");
124   return pImpl ? pImpl->getKindAsString() : StringRef();
125 }
126
127 StringRef Attribute::getValueAsString() const {
128   if (!pImpl) return StringRef();
129   assert(isStringAttribute() &&
130          "Invalid attribute type to get the value as a string!");
131   return pImpl ? pImpl->getValueAsString() : StringRef();
132 }
133
134 bool Attribute::hasAttribute(AttrKind Kind) const {
135   return (pImpl && pImpl->hasAttribute(Kind)) || (!pImpl && Kind == None);
136 }
137
138 bool Attribute::hasAttribute(StringRef Kind) const {
139   if (!isStringAttribute()) return false;
140   return pImpl && pImpl->hasAttribute(Kind);
141 }
142
143 /// This returns the alignment field of an attribute as a byte alignment value.
144 unsigned Attribute::getAlignment() const {
145   assert(hasAttribute(Attribute::Alignment) &&
146          "Trying to get alignment from non-alignment attribute!");
147   return pImpl->getValueAsInt();
148 }
149
150 /// This returns the stack alignment field of an attribute as a byte alignment
151 /// value.
152 unsigned Attribute::getStackAlignment() const {
153   assert(hasAttribute(Attribute::StackAlignment) &&
154          "Trying to get alignment from non-alignment attribute!");
155   return pImpl->getValueAsInt();
156 }
157
158 std::string Attribute::getAsString(bool InAttrGrp) const {
159   if (!pImpl) return "";
160
161   if (hasAttribute(Attribute::SanitizeAddress))
162     return "sanitize_address";
163   if (hasAttribute(Attribute::AlwaysInline))
164     return "alwaysinline";
165   if (hasAttribute(Attribute::Builtin))
166     return "builtin";
167   if (hasAttribute(Attribute::ByVal))
168     return "byval";
169   if (hasAttribute(Attribute::InlineHint))
170     return "inlinehint";
171   if (hasAttribute(Attribute::InReg))
172     return "inreg";
173   if (hasAttribute(Attribute::MinSize))
174     return "minsize";
175   if (hasAttribute(Attribute::Naked))
176     return "naked";
177   if (hasAttribute(Attribute::Nest))
178     return "nest";
179   if (hasAttribute(Attribute::NoAlias))
180     return "noalias";
181   if (hasAttribute(Attribute::NoBuiltin))
182     return "nobuiltin";
183   if (hasAttribute(Attribute::NoCapture))
184     return "nocapture";
185   if (hasAttribute(Attribute::NoDuplicate))
186     return "noduplicate";
187   if (hasAttribute(Attribute::NoImplicitFloat))
188     return "noimplicitfloat";
189   if (hasAttribute(Attribute::NoInline))
190     return "noinline";
191   if (hasAttribute(Attribute::NonLazyBind))
192     return "nonlazybind";
193   if (hasAttribute(Attribute::NoRedZone))
194     return "noredzone";
195   if (hasAttribute(Attribute::NoReturn))
196     return "noreturn";
197   if (hasAttribute(Attribute::NoUnwind))
198     return "nounwind";
199   if (hasAttribute(Attribute::OptimizeForSize))
200     return "optsize";
201   if (hasAttribute(Attribute::ReadNone))
202     return "readnone";
203   if (hasAttribute(Attribute::ReadOnly))
204     return "readonly";
205   if (hasAttribute(Attribute::Returned))
206     return "returned";
207   if (hasAttribute(Attribute::ReturnsTwice))
208     return "returns_twice";
209   if (hasAttribute(Attribute::SExt))
210     return "signext";
211   if (hasAttribute(Attribute::StackProtect))
212     return "ssp";
213   if (hasAttribute(Attribute::StackProtectReq))
214     return "sspreq";
215   if (hasAttribute(Attribute::StackProtectStrong))
216     return "sspstrong";
217   if (hasAttribute(Attribute::StructRet))
218     return "sret";
219   if (hasAttribute(Attribute::SanitizeThread))
220     return "sanitize_thread";
221   if (hasAttribute(Attribute::SanitizeMemory))
222     return "sanitize_memory";
223   if (hasAttribute(Attribute::UWTable))
224     return "uwtable";
225   if (hasAttribute(Attribute::ZExt))
226     return "zeroext";
227   if (hasAttribute(Attribute::Cold))
228     return "cold";
229
230   // FIXME: These should be output like this:
231   //
232   //   align=4
233   //   alignstack=8
234   //
235   if (hasAttribute(Attribute::Alignment)) {
236     std::string Result;
237     Result += "align";
238     Result += (InAttrGrp) ? "=" : " ";
239     Result += utostr(getValueAsInt());
240     return Result;
241   }
242
243   if (hasAttribute(Attribute::StackAlignment)) {
244     std::string Result;
245     Result += "alignstack";
246     if (InAttrGrp) {
247       Result += "=";
248       Result += utostr(getValueAsInt());
249     } else {
250       Result += "(";
251       Result += utostr(getValueAsInt());
252       Result += ")";
253     }
254     return Result;
255   }
256
257   // Convert target-dependent attributes to strings of the form:
258   //
259   //   "kind"
260   //   "kind" = "value"
261   //
262   if (isStringAttribute()) {
263     std::string Result;
264     Result += '\"' + getKindAsString().str() + '"';
265
266     StringRef Val = pImpl->getValueAsString();
267     if (Val.empty()) return Result;
268
269     Result += "=\"" + Val.str() + '"';
270     return Result;
271   }
272
273   llvm_unreachable("Unknown attribute");
274 }
275
276 bool Attribute::operator<(Attribute A) const {
277   if (!pImpl && !A.pImpl) return false;
278   if (!pImpl) return true;
279   if (!A.pImpl) return false;
280   return *pImpl < *A.pImpl;
281 }
282
283 //===----------------------------------------------------------------------===//
284 // AttributeImpl Definition
285 //===----------------------------------------------------------------------===//
286
287 AttributeImpl::~AttributeImpl() {}
288
289 bool AttributeImpl::hasAttribute(Attribute::AttrKind A) const {
290   if (isStringAttribute()) return false;
291   return getKindAsEnum() == A;
292 }
293
294 bool AttributeImpl::hasAttribute(StringRef Kind) const {
295   if (!isStringAttribute()) return false;
296   return getKindAsString() == Kind;
297 }
298
299 Attribute::AttrKind AttributeImpl::getKindAsEnum() const {
300   assert(isEnumAttribute() || isAlignAttribute());
301   return static_cast<const EnumAttributeImpl *>(this)->getEnumKind();
302 }
303
304 uint64_t AttributeImpl::getValueAsInt() const {
305   assert(isAlignAttribute());
306   return static_cast<const AlignAttributeImpl *>(this)->getAlignment();
307 }
308
309 StringRef AttributeImpl::getKindAsString() const {
310   assert(isStringAttribute());
311   return static_cast<const StringAttributeImpl *>(this)->getStringKind();
312 }
313
314 StringRef AttributeImpl::getValueAsString() const {
315   assert(isStringAttribute());
316   return static_cast<const StringAttributeImpl *>(this)->getStringValue();
317 }
318
319 bool AttributeImpl::operator<(const AttributeImpl &AI) const {
320   // This sorts the attributes with Attribute::AttrKinds coming first (sorted
321   // relative to their enum value) and then strings.
322   if (isEnumAttribute()) {
323     if (AI.isEnumAttribute()) return getKindAsEnum() < AI.getKindAsEnum();
324     if (AI.isAlignAttribute()) return true;
325     if (AI.isStringAttribute()) return true;
326   }
327
328   if (isAlignAttribute()) {
329     if (AI.isEnumAttribute()) return false;
330     if (AI.isAlignAttribute()) return getValueAsInt() < AI.getValueAsInt();
331     if (AI.isStringAttribute()) return true;
332   }
333
334   if (AI.isEnumAttribute()) return false;
335   if (AI.isAlignAttribute()) return false;
336   if (getKindAsString() == AI.getKindAsString())
337     return getValueAsString() < AI.getValueAsString();
338   return getKindAsString() < AI.getKindAsString();
339 }
340
341 uint64_t AttributeImpl::getAttrMask(Attribute::AttrKind Val) {
342   // FIXME: Remove this.
343   switch (Val) {
344   case Attribute::EndAttrKinds:
345     llvm_unreachable("Synthetic enumerators which should never get here");
346
347   case Attribute::None:            return 0;
348   case Attribute::ZExt:            return 1 << 0;
349   case Attribute::SExt:            return 1 << 1;
350   case Attribute::NoReturn:        return 1 << 2;
351   case Attribute::InReg:           return 1 << 3;
352   case Attribute::StructRet:       return 1 << 4;
353   case Attribute::NoUnwind:        return 1 << 5;
354   case Attribute::NoAlias:         return 1 << 6;
355   case Attribute::ByVal:           return 1 << 7;
356   case Attribute::Nest:            return 1 << 8;
357   case Attribute::ReadNone:        return 1 << 9;
358   case Attribute::ReadOnly:        return 1 << 10;
359   case Attribute::NoInline:        return 1 << 11;
360   case Attribute::AlwaysInline:    return 1 << 12;
361   case Attribute::OptimizeForSize: return 1 << 13;
362   case Attribute::StackProtect:    return 1 << 14;
363   case Attribute::StackProtectReq: return 1 << 15;
364   case Attribute::Alignment:       return 31 << 16;
365   case Attribute::NoCapture:       return 1 << 21;
366   case Attribute::NoRedZone:       return 1 << 22;
367   case Attribute::NoImplicitFloat: return 1 << 23;
368   case Attribute::Naked:           return 1 << 24;
369   case Attribute::InlineHint:      return 1 << 25;
370   case Attribute::StackAlignment:  return 7 << 26;
371   case Attribute::ReturnsTwice:    return 1 << 29;
372   case Attribute::UWTable:         return 1 << 30;
373   case Attribute::NonLazyBind:     return 1U << 31;
374   case Attribute::SanitizeAddress: return 1ULL << 32;
375   case Attribute::MinSize:         return 1ULL << 33;
376   case Attribute::NoDuplicate:     return 1ULL << 34;
377   case Attribute::StackProtectStrong: return 1ULL << 35;
378   case Attribute::SanitizeThread:  return 1ULL << 36;
379   case Attribute::SanitizeMemory:  return 1ULL << 37;
380   case Attribute::NoBuiltin:       return 1ULL << 38;
381   case Attribute::Returned:        return 1ULL << 39;
382   case Attribute::Cold:            return 1ULL << 40;
383   case Attribute::Builtin:         return 1ULL << 41;
384   }
385   llvm_unreachable("Unsupported attribute type");
386 }
387
388 //===----------------------------------------------------------------------===//
389 // AttributeSetNode Definition
390 //===----------------------------------------------------------------------===//
391
392 AttributeSetNode *AttributeSetNode::get(LLVMContext &C,
393                                         ArrayRef<Attribute> Attrs) {
394   if (Attrs.empty())
395     return 0;
396
397   // Otherwise, build a key to look up the existing attributes.
398   LLVMContextImpl *pImpl = C.pImpl;
399   FoldingSetNodeID ID;
400
401   SmallVector<Attribute, 8> SortedAttrs(Attrs.begin(), Attrs.end());
402   array_pod_sort(SortedAttrs.begin(), SortedAttrs.end());
403
404   for (SmallVectorImpl<Attribute>::iterator I = SortedAttrs.begin(),
405          E = SortedAttrs.end(); I != E; ++I)
406     I->Profile(ID);
407
408   void *InsertPoint;
409   AttributeSetNode *PA =
410     pImpl->AttrsSetNodes.FindNodeOrInsertPos(ID, InsertPoint);
411
412   // If we didn't find any existing attributes of the same shape then create a
413   // new one and insert it.
414   if (!PA) {
415     // Coallocate entries after the AttributeSetNode itself.
416     void *Mem = ::operator new(sizeof(AttributeSetNode) +
417                                sizeof(Attribute) * SortedAttrs.size());
418     PA = new (Mem) AttributeSetNode(SortedAttrs);
419     pImpl->AttrsSetNodes.InsertNode(PA, InsertPoint);
420   }
421
422   // Return the AttributesListNode that we found or created.
423   return PA;
424 }
425
426 bool AttributeSetNode::hasAttribute(Attribute::AttrKind Kind) const {
427   for (iterator I = begin(), E = end(); I != E; ++I)
428     if (I->hasAttribute(Kind))
429       return true;
430   return false;
431 }
432
433 bool AttributeSetNode::hasAttribute(StringRef Kind) const {
434   for (iterator I = begin(), E = end(); I != E; ++I)
435     if (I->hasAttribute(Kind))
436       return true;
437   return false;
438 }
439
440 Attribute AttributeSetNode::getAttribute(Attribute::AttrKind Kind) const {
441   for (iterator I = begin(), E = end(); I != E; ++I)
442     if (I->hasAttribute(Kind))
443       return *I;
444   return Attribute();
445 }
446
447 Attribute AttributeSetNode::getAttribute(StringRef Kind) const {
448   for (iterator I = begin(), E = end(); I != E; ++I)
449     if (I->hasAttribute(Kind))
450       return *I;
451   return Attribute();
452 }
453
454 unsigned AttributeSetNode::getAlignment() const {
455   for (iterator I = begin(), E = end(); I != E; ++I)
456     if (I->hasAttribute(Attribute::Alignment))
457       return I->getAlignment();
458   return 0;
459 }
460
461 unsigned AttributeSetNode::getStackAlignment() const {
462   for (iterator I = begin(), E = end(); I != E; ++I)
463     if (I->hasAttribute(Attribute::StackAlignment))
464       return I->getStackAlignment();
465   return 0;
466 }
467
468 std::string AttributeSetNode::getAsString(bool InAttrGrp) const {
469   std::string Str;
470   for (iterator I = begin(), E = end(); I != E; ++I) {
471     if (I != begin())
472       Str += ' ';
473     Str += I->getAsString(InAttrGrp);
474   }
475   return Str;
476 }
477
478 //===----------------------------------------------------------------------===//
479 // AttributeSetImpl Definition
480 //===----------------------------------------------------------------------===//
481
482 uint64_t AttributeSetImpl::Raw(unsigned Index) const {
483   for (unsigned I = 0, E = getNumAttributes(); I != E; ++I) {
484     if (getSlotIndex(I) != Index) continue;
485     const AttributeSetNode *ASN = getSlotNode(I);
486     uint64_t Mask = 0;
487
488     for (AttributeSetNode::iterator II = ASN->begin(),
489            IE = ASN->end(); II != IE; ++II) {
490       Attribute Attr = *II;
491
492       // This cannot handle string attributes.
493       if (Attr.isStringAttribute()) continue;
494
495       Attribute::AttrKind Kind = Attr.getKindAsEnum();
496
497       if (Kind == Attribute::Alignment)
498         Mask |= (Log2_32(ASN->getAlignment()) + 1) << 16;
499       else if (Kind == Attribute::StackAlignment)
500         Mask |= (Log2_32(ASN->getStackAlignment()) + 1) << 26;
501       else
502         Mask |= AttributeImpl::getAttrMask(Kind);
503     }
504
505     return Mask;
506   }
507
508   return 0;
509 }
510
511 //===----------------------------------------------------------------------===//
512 // AttributeSet Construction and Mutation Methods
513 //===----------------------------------------------------------------------===//
514
515 AttributeSet
516 AttributeSet::getImpl(LLVMContext &C,
517                       ArrayRef<std::pair<unsigned, AttributeSetNode*> > Attrs) {
518   LLVMContextImpl *pImpl = C.pImpl;
519   FoldingSetNodeID ID;
520   AttributeSetImpl::Profile(ID, Attrs);
521
522   void *InsertPoint;
523   AttributeSetImpl *PA = pImpl->AttrsLists.FindNodeOrInsertPos(ID, InsertPoint);
524
525   // If we didn't find any existing attributes of the same shape then
526   // create a new one and insert it.
527   if (!PA) {
528     // Coallocate entries after the AttributeSetImpl itself.
529     void *Mem = ::operator new(sizeof(AttributeSetImpl) +
530                                sizeof(std::pair<unsigned, AttributeSetNode *>) *
531                                    Attrs.size());
532     PA = new (Mem) AttributeSetImpl(C, Attrs);
533     pImpl->AttrsLists.InsertNode(PA, InsertPoint);
534   }
535
536   // Return the AttributesList that we found or created.
537   return AttributeSet(PA);
538 }
539
540 AttributeSet AttributeSet::get(LLVMContext &C,
541                                ArrayRef<std::pair<unsigned, Attribute> > Attrs){
542   // If there are no attributes then return a null AttributesList pointer.
543   if (Attrs.empty())
544     return AttributeSet();
545
546 #ifndef NDEBUG
547   for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
548     assert((!i || Attrs[i-1].first <= Attrs[i].first) &&
549            "Misordered Attributes list!");
550     assert(!Attrs[i].second.hasAttribute(Attribute::None) &&
551            "Pointless attribute!");
552   }
553 #endif
554
555   // Create a vector if (unsigned, AttributeSetNode*) pairs from the attributes
556   // list.
557   SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrPairVec;
558   for (ArrayRef<std::pair<unsigned, Attribute> >::iterator I = Attrs.begin(),
559          E = Attrs.end(); I != E; ) {
560     unsigned Index = I->first;
561     SmallVector<Attribute, 4> AttrVec;
562     while (I != E && I->first == Index) {
563       AttrVec.push_back(I->second);
564       ++I;
565     }
566
567     AttrPairVec.push_back(std::make_pair(Index,
568                                          AttributeSetNode::get(C, AttrVec)));
569   }
570
571   return getImpl(C, AttrPairVec);
572 }
573
574 AttributeSet AttributeSet::get(LLVMContext &C,
575                                ArrayRef<std::pair<unsigned,
576                                                   AttributeSetNode*> > Attrs) {
577   // If there are no attributes then return a null AttributesList pointer.
578   if (Attrs.empty())
579     return AttributeSet();
580
581   return getImpl(C, Attrs);
582 }
583
584 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index, AttrBuilder &B) {
585   if (!B.hasAttributes())
586     return AttributeSet();
587
588   // Add target-independent attributes.
589   SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
590   for (Attribute::AttrKind Kind = Attribute::None;
591        Kind != Attribute::EndAttrKinds; Kind = Attribute::AttrKind(Kind + 1)) {
592     if (!B.contains(Kind))
593       continue;
594
595     if (Kind == Attribute::Alignment)
596       Attrs.push_back(std::make_pair(Index, Attribute::
597                                      getWithAlignment(C, B.getAlignment())));
598     else if (Kind == Attribute::StackAlignment)
599       Attrs.push_back(std::make_pair(Index, Attribute::
600                               getWithStackAlignment(C, B.getStackAlignment())));
601     else
602       Attrs.push_back(std::make_pair(Index, Attribute::get(C, Kind)));
603   }
604
605   // Add target-dependent (string) attributes.
606   for (AttrBuilder::td_iterator I = B.td_begin(), E = B.td_end();
607        I != E; ++I)
608     Attrs.push_back(std::make_pair(Index, Attribute::get(C, I->first,I->second)));
609
610   return get(C, Attrs);
611 }
612
613 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
614                                ArrayRef<Attribute::AttrKind> Kind) {
615   SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
616   for (ArrayRef<Attribute::AttrKind>::iterator I = Kind.begin(),
617          E = Kind.end(); I != E; ++I)
618     Attrs.push_back(std::make_pair(Index, Attribute::get(C, *I)));
619   return get(C, Attrs);
620 }
621
622 AttributeSet AttributeSet::get(LLVMContext &C, ArrayRef<AttributeSet> Attrs) {
623   if (Attrs.empty()) return AttributeSet();
624   if (Attrs.size() == 1) return Attrs[0];
625
626   SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrNodeVec;
627   AttributeSetImpl *A0 = Attrs[0].pImpl;
628   if (A0)
629     AttrNodeVec.append(A0->getNode(0), A0->getNode(A0->getNumAttributes()));
630   // Copy all attributes from Attrs into AttrNodeVec while keeping AttrNodeVec
631   // ordered by index.  Because we know that each list in Attrs is ordered by
632   // index we only need to merge each successive list in rather than doing a
633   // full sort.
634   for (unsigned I = 1, E = Attrs.size(); I != E; ++I) {
635     AttributeSetImpl *AS = Attrs[I].pImpl;
636     if (!AS) continue;
637     SmallVector<std::pair<unsigned, AttributeSetNode *>, 8>::iterator
638       ANVI = AttrNodeVec.begin(), ANVE;
639     for (const AttributeSetImpl::IndexAttrPair
640              *AI = AS->getNode(0),
641              *AE = AS->getNode(AS->getNumAttributes());
642          AI != AE; ++AI) {
643       ANVE = AttrNodeVec.end();
644       while (ANVI != ANVE && ANVI->first <= AI->first)
645         ++ANVI;
646       ANVI = AttrNodeVec.insert(ANVI, *AI) + 1;
647     }
648   }
649
650   return getImpl(C, AttrNodeVec);
651 }
652
653 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
654                                         Attribute::AttrKind Attr) const {
655   if (hasAttribute(Index, Attr)) return *this;
656   return addAttributes(C, Index, AttributeSet::get(C, Index, Attr));
657 }
658
659 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
660                                         StringRef Kind) const {
661   llvm::AttrBuilder B;
662   B.addAttribute(Kind);
663   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
664 }
665
666 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
667                                         StringRef Kind, StringRef Value) const {
668   llvm::AttrBuilder B;
669   B.addAttribute(Kind, Value);
670   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
671 }
672
673 AttributeSet AttributeSet::addAttributes(LLVMContext &C, unsigned Index,
674                                          AttributeSet Attrs) const {
675   if (!pImpl) return Attrs;
676   if (!Attrs.pImpl) return *this;
677
678 #ifndef NDEBUG
679   // FIXME it is not obvious how this should work for alignment. For now, say
680   // we can't change a known alignment.
681   unsigned OldAlign = getParamAlignment(Index);
682   unsigned NewAlign = Attrs.getParamAlignment(Index);
683   assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
684          "Attempt to change alignment!");
685 #endif
686
687   // Add the attribute slots before the one we're trying to add.
688   SmallVector<AttributeSet, 4> AttrSet;
689   uint64_t NumAttrs = pImpl->getNumAttributes();
690   AttributeSet AS;
691   uint64_t LastIndex = 0;
692   for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
693     if (getSlotIndex(I) >= Index) {
694       if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
695       break;
696     }
697     LastIndex = I + 1;
698     AttrSet.push_back(getSlotAttributes(I));
699   }
700
701   // Now add the attribute into the correct slot. There may already be an
702   // AttributeSet there.
703   AttrBuilder B(AS, Index);
704
705   for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
706     if (Attrs.getSlotIndex(I) == Index) {
707       for (AttributeSetImpl::iterator II = Attrs.pImpl->begin(I),
708              IE = Attrs.pImpl->end(I); II != IE; ++II)
709         B.addAttribute(*II);
710       break;
711     }
712
713   AttrSet.push_back(AttributeSet::get(C, Index, B));
714
715   // Add the remaining attribute slots.
716   for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
717     AttrSet.push_back(getSlotAttributes(I));
718
719   return get(C, AttrSet);
720 }
721
722 AttributeSet AttributeSet::removeAttribute(LLVMContext &C, unsigned Index,
723                                            Attribute::AttrKind Attr) const {
724   if (!hasAttribute(Index, Attr)) return *this;
725   return removeAttributes(C, Index, AttributeSet::get(C, Index, Attr));
726 }
727
728 AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
729                                             AttributeSet Attrs) const {
730   if (!pImpl) return AttributeSet();
731   if (!Attrs.pImpl) return *this;
732
733 #ifndef NDEBUG
734   // FIXME it is not obvious how this should work for alignment.
735   // For now, say we can't pass in alignment, which no current use does.
736   assert(!Attrs.hasAttribute(Index, Attribute::Alignment) &&
737          "Attempt to change alignment!");
738 #endif
739
740   // Add the attribute slots before the one we're trying to add.
741   SmallVector<AttributeSet, 4> AttrSet;
742   uint64_t NumAttrs = pImpl->getNumAttributes();
743   AttributeSet AS;
744   uint64_t LastIndex = 0;
745   for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
746     if (getSlotIndex(I) >= Index) {
747       if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
748       break;
749     }
750     LastIndex = I + 1;
751     AttrSet.push_back(getSlotAttributes(I));
752   }
753
754   // Now remove the attribute from the correct slot. There may already be an
755   // AttributeSet there.
756   AttrBuilder B(AS, Index);
757
758   for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
759     if (Attrs.getSlotIndex(I) == Index) {
760       B.removeAttributes(Attrs.pImpl->getSlotAttributes(I), Index);
761       break;
762     }
763
764   AttrSet.push_back(AttributeSet::get(C, Index, B));
765
766   // Add the remaining attribute slots.
767   for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
768     AttrSet.push_back(getSlotAttributes(I));
769
770   return get(C, AttrSet);
771 }
772
773 //===----------------------------------------------------------------------===//
774 // AttributeSet Accessor Methods
775 //===----------------------------------------------------------------------===//
776
777 LLVMContext &AttributeSet::getContext() const {
778   return pImpl->getContext();
779 }
780
781 AttributeSet AttributeSet::getParamAttributes(unsigned Index) const {
782   return pImpl && hasAttributes(Index) ?
783     AttributeSet::get(pImpl->getContext(),
784                       ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
785                         std::make_pair(Index, getAttributes(Index)))) :
786     AttributeSet();
787 }
788
789 AttributeSet AttributeSet::getRetAttributes() const {
790   return pImpl && hasAttributes(ReturnIndex) ?
791     AttributeSet::get(pImpl->getContext(),
792                       ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
793                         std::make_pair(ReturnIndex,
794                                        getAttributes(ReturnIndex)))) :
795     AttributeSet();
796 }
797
798 AttributeSet AttributeSet::getFnAttributes() const {
799   return pImpl && hasAttributes(FunctionIndex) ?
800     AttributeSet::get(pImpl->getContext(),
801                       ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
802                         std::make_pair(FunctionIndex,
803                                        getAttributes(FunctionIndex)))) :
804     AttributeSet();
805 }
806
807 bool AttributeSet::hasAttribute(unsigned Index, Attribute::AttrKind Kind) const{
808   AttributeSetNode *ASN = getAttributes(Index);
809   return ASN ? ASN->hasAttribute(Kind) : false;
810 }
811
812 bool AttributeSet::hasAttribute(unsigned Index, StringRef Kind) const {
813   AttributeSetNode *ASN = getAttributes(Index);
814   return ASN ? ASN->hasAttribute(Kind) : false;
815 }
816
817 bool AttributeSet::hasAttributes(unsigned Index) const {
818   AttributeSetNode *ASN = getAttributes(Index);
819   return ASN ? ASN->hasAttributes() : false;
820 }
821
822 /// \brief Return true if the specified attribute is set for at least one
823 /// parameter or for the return value.
824 bool AttributeSet::hasAttrSomewhere(Attribute::AttrKind Attr) const {
825   if (pImpl == 0) return false;
826
827   for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
828     for (AttributeSetImpl::iterator II = pImpl->begin(I),
829            IE = pImpl->end(I); II != IE; ++II)
830       if (II->hasAttribute(Attr))
831         return true;
832
833   return false;
834 }
835
836 Attribute AttributeSet::getAttribute(unsigned Index,
837                                      Attribute::AttrKind Kind) const {
838   AttributeSetNode *ASN = getAttributes(Index);
839   return ASN ? ASN->getAttribute(Kind) : Attribute();
840 }
841
842 Attribute AttributeSet::getAttribute(unsigned Index,
843                                      StringRef Kind) const {
844   AttributeSetNode *ASN = getAttributes(Index);
845   return ASN ? ASN->getAttribute(Kind) : Attribute();
846 }
847
848 unsigned AttributeSet::getParamAlignment(unsigned Index) const {
849   AttributeSetNode *ASN = getAttributes(Index);
850   return ASN ? ASN->getAlignment() : 0;
851 }
852
853 unsigned AttributeSet::getStackAlignment(unsigned Index) const {
854   AttributeSetNode *ASN = getAttributes(Index);
855   return ASN ? ASN->getStackAlignment() : 0;
856 }
857
858 std::string AttributeSet::getAsString(unsigned Index,
859                                       bool InAttrGrp) const {
860   AttributeSetNode *ASN = getAttributes(Index);
861   return ASN ? ASN->getAsString(InAttrGrp) : std::string("");
862 }
863
864 /// \brief The attributes for the specified index are returned.
865 AttributeSetNode *AttributeSet::getAttributes(unsigned Index) const {
866   if (!pImpl) return 0;
867
868   // Loop through to find the attribute node we want.
869   for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
870     if (pImpl->getSlotIndex(I) == Index)
871       return pImpl->getSlotNode(I);
872
873   return 0;
874 }
875
876 AttributeSet::iterator AttributeSet::begin(unsigned Slot) const {
877   if (!pImpl)
878     return ArrayRef<Attribute>().begin();
879   return pImpl->begin(Slot);
880 }
881
882 AttributeSet::iterator AttributeSet::end(unsigned Slot) const {
883   if (!pImpl)
884     return ArrayRef<Attribute>().end();
885   return pImpl->end(Slot);
886 }
887
888 //===----------------------------------------------------------------------===//
889 // AttributeSet Introspection Methods
890 //===----------------------------------------------------------------------===//
891
892 /// \brief Return the number of slots used in this attribute list.  This is the
893 /// number of arguments that have an attribute set on them (including the
894 /// function itself).
895 unsigned AttributeSet::getNumSlots() const {
896   return pImpl ? pImpl->getNumAttributes() : 0;
897 }
898
899 unsigned AttributeSet::getSlotIndex(unsigned Slot) const {
900   assert(pImpl && Slot < pImpl->getNumAttributes() &&
901          "Slot # out of range!");
902   return pImpl->getSlotIndex(Slot);
903 }
904
905 AttributeSet AttributeSet::getSlotAttributes(unsigned Slot) const {
906   assert(pImpl && Slot < pImpl->getNumAttributes() &&
907          "Slot # out of range!");
908   return pImpl->getSlotAttributes(Slot);
909 }
910
911 uint64_t AttributeSet::Raw(unsigned Index) const {
912   // FIXME: Remove this.
913   return pImpl ? pImpl->Raw(Index) : 0;
914 }
915
916 void AttributeSet::dump() const {
917   dbgs() << "PAL[\n";
918
919   for (unsigned i = 0, e = getNumSlots(); i < e; ++i) {
920     uint64_t Index = getSlotIndex(i);
921     dbgs() << "  { ";
922     if (Index == ~0U)
923       dbgs() << "~0U";
924     else
925       dbgs() << Index;
926     dbgs() << " => " << getAsString(Index) << " }\n";
927   }
928
929   dbgs() << "]\n";
930 }
931
932 //===----------------------------------------------------------------------===//
933 // AttrBuilder Method Implementations
934 //===----------------------------------------------------------------------===//
935
936 AttrBuilder::AttrBuilder(AttributeSet AS, unsigned Index)
937   : Attrs(0), Alignment(0), StackAlignment(0) {
938   AttributeSetImpl *pImpl = AS.pImpl;
939   if (!pImpl) return;
940
941   for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I) {
942     if (pImpl->getSlotIndex(I) != Index) continue;
943
944     for (AttributeSetImpl::iterator II = pImpl->begin(I),
945            IE = pImpl->end(I); II != IE; ++II)
946       addAttribute(*II);
947
948     break;
949   }
950 }
951
952 void AttrBuilder::clear() {
953   Attrs.reset();
954   Alignment = StackAlignment = 0;
955 }
956
957 AttrBuilder &AttrBuilder::addAttribute(Attribute::AttrKind Val) {
958   assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
959   assert(Val != Attribute::Alignment && Val != Attribute::StackAlignment &&
960          "Adding alignment attribute without adding alignment value!");
961   Attrs[Val] = true;
962   return *this;
963 }
964
965 AttrBuilder &AttrBuilder::addAttribute(Attribute Attr) {
966   if (Attr.isStringAttribute()) {
967     addAttribute(Attr.getKindAsString(), Attr.getValueAsString());
968     return *this;
969   }
970
971   Attribute::AttrKind Kind = Attr.getKindAsEnum();
972   Attrs[Kind] = true;
973
974   if (Kind == Attribute::Alignment)
975     Alignment = Attr.getAlignment();
976   else if (Kind == Attribute::StackAlignment)
977     StackAlignment = Attr.getStackAlignment();
978   return *this;
979 }
980
981 AttrBuilder &AttrBuilder::addAttribute(StringRef A, StringRef V) {
982   TargetDepAttrs[A] = V;
983   return *this;
984 }
985
986 AttrBuilder &AttrBuilder::removeAttribute(Attribute::AttrKind Val) {
987   assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
988   Attrs[Val] = false;
989
990   if (Val == Attribute::Alignment)
991     Alignment = 0;
992   else if (Val == Attribute::StackAlignment)
993     StackAlignment = 0;
994
995   return *this;
996 }
997
998 AttrBuilder &AttrBuilder::removeAttributes(AttributeSet A, uint64_t Index) {
999   unsigned Slot = ~0U;
1000   for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1001     if (A.getSlotIndex(I) == Index) {
1002       Slot = I;
1003       break;
1004     }
1005
1006   assert(Slot != ~0U && "Couldn't find index in AttributeSet!");
1007
1008   for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot); I != E; ++I) {
1009     Attribute Attr = *I;
1010     if (Attr.isEnumAttribute() || Attr.isAlignAttribute()) {
1011       Attribute::AttrKind Kind = I->getKindAsEnum();
1012       Attrs[Kind] = false;
1013
1014       if (Kind == Attribute::Alignment)
1015         Alignment = 0;
1016       else if (Kind == Attribute::StackAlignment)
1017         StackAlignment = 0;
1018     } else {
1019       assert(Attr.isStringAttribute() && "Invalid attribute type!");
1020       std::map<std::string, std::string>::iterator
1021         Iter = TargetDepAttrs.find(Attr.getKindAsString());
1022       if (Iter != TargetDepAttrs.end())
1023         TargetDepAttrs.erase(Iter);
1024     }
1025   }
1026
1027   return *this;
1028 }
1029
1030 AttrBuilder &AttrBuilder::removeAttribute(StringRef A) {
1031   std::map<std::string, std::string>::iterator I = TargetDepAttrs.find(A);
1032   if (I != TargetDepAttrs.end())
1033     TargetDepAttrs.erase(I);
1034   return *this;
1035 }
1036
1037 AttrBuilder &AttrBuilder::addAlignmentAttr(unsigned Align) {
1038   if (Align == 0) return *this;
1039
1040   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1041   assert(Align <= 0x40000000 && "Alignment too large.");
1042
1043   Attrs[Attribute::Alignment] = true;
1044   Alignment = Align;
1045   return *this;
1046 }
1047
1048 AttrBuilder &AttrBuilder::addStackAlignmentAttr(unsigned Align) {
1049   // Default alignment, allow the target to define how to align it.
1050   if (Align == 0) return *this;
1051
1052   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1053   assert(Align <= 0x100 && "Alignment too large.");
1054
1055   Attrs[Attribute::StackAlignment] = true;
1056   StackAlignment = Align;
1057   return *this;
1058 }
1059
1060 AttrBuilder &AttrBuilder::merge(const AttrBuilder &B) {
1061   // FIXME: What if both have alignments, but they don't match?!
1062   if (!Alignment)
1063     Alignment = B.Alignment;
1064
1065   if (!StackAlignment)
1066     StackAlignment = B.StackAlignment;
1067
1068   Attrs |= B.Attrs;
1069
1070   for (td_const_iterator I = B.TargetDepAttrs.begin(),
1071          E = B.TargetDepAttrs.end(); I != E; ++I)
1072     TargetDepAttrs[I->first] = I->second;
1073
1074   return *this;
1075 }
1076
1077 bool AttrBuilder::contains(StringRef A) const {
1078   return TargetDepAttrs.find(A) != TargetDepAttrs.end();
1079 }
1080
1081 bool AttrBuilder::hasAttributes() const {
1082   return !Attrs.none() || !TargetDepAttrs.empty();
1083 }
1084
1085 bool AttrBuilder::hasAttributes(AttributeSet A, uint64_t Index) const {
1086   unsigned Slot = ~0U;
1087   for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1088     if (A.getSlotIndex(I) == Index) {
1089       Slot = I;
1090       break;
1091     }
1092
1093   assert(Slot != ~0U && "Couldn't find the index!");
1094
1095   for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot);
1096        I != E; ++I) {
1097     Attribute Attr = *I;
1098     if (Attr.isEnumAttribute() || Attr.isAlignAttribute()) {
1099       if (Attrs[I->getKindAsEnum()])
1100         return true;
1101     } else {
1102       assert(Attr.isStringAttribute() && "Invalid attribute kind!");
1103       return TargetDepAttrs.find(Attr.getKindAsString())!=TargetDepAttrs.end();
1104     }
1105   }
1106
1107   return false;
1108 }
1109
1110 bool AttrBuilder::hasAlignmentAttr() const {
1111   return Alignment != 0;
1112 }
1113
1114 bool AttrBuilder::operator==(const AttrBuilder &B) {
1115   if (Attrs != B.Attrs)
1116     return false;
1117
1118   for (td_const_iterator I = TargetDepAttrs.begin(),
1119          E = TargetDepAttrs.end(); I != E; ++I)
1120     if (B.TargetDepAttrs.find(I->first) == B.TargetDepAttrs.end())
1121       return false;
1122
1123   return Alignment == B.Alignment && StackAlignment == B.StackAlignment;
1124 }
1125
1126 AttrBuilder &AttrBuilder::addRawValue(uint64_t Val) {
1127   // FIXME: Remove this in 4.0.
1128   if (!Val) return *this;
1129
1130   for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1131        I = Attribute::AttrKind(I + 1)) {
1132     if (uint64_t A = (Val & AttributeImpl::getAttrMask(I))) {
1133       Attrs[I] = true;
1134  
1135       if (I == Attribute::Alignment)
1136         Alignment = 1ULL << ((A >> 16) - 1);
1137       else if (I == Attribute::StackAlignment)
1138         StackAlignment = 1ULL << ((A >> 26)-1);
1139     }
1140   }
1141  
1142   return *this;
1143 }
1144
1145 //===----------------------------------------------------------------------===//
1146 // AttributeFuncs Function Defintions
1147 //===----------------------------------------------------------------------===//
1148
1149 /// \brief Which attributes cannot be applied to a type.
1150 AttributeSet AttributeFuncs::typeIncompatible(Type *Ty, uint64_t Index) {
1151   AttrBuilder Incompatible;
1152
1153   if (!Ty->isIntegerTy())
1154     // Attribute that only apply to integers.
1155     Incompatible.addAttribute(Attribute::SExt)
1156       .addAttribute(Attribute::ZExt);
1157
1158   if (!Ty->isPointerTy())
1159     // Attribute that only apply to pointers.
1160     Incompatible.addAttribute(Attribute::ByVal)
1161       .addAttribute(Attribute::Nest)
1162       .addAttribute(Attribute::NoAlias)
1163       .addAttribute(Attribute::NoCapture)
1164       .addAttribute(Attribute::ReadNone)
1165       .addAttribute(Attribute::ReadOnly)
1166       .addAttribute(Attribute::StructRet);
1167
1168   return AttributeSet::get(Ty->getContext(), Index, Incompatible);
1169 }