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