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 "llvm/IR/Function.h"
18 #include "AttributeImpl.h"
19 #include "LLVMContextImpl.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/IR/Type.h"
23 #include "llvm/Support/Atomic.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/ManagedStatic.h"
26 #include "llvm/Support/Mutex.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include <algorithm>
29 using namespace llvm;
30 
31 //===----------------------------------------------------------------------===//
32 // Attribute Construction Methods
33 //===----------------------------------------------------------------------===//
34 
35 // allocsize has two integer arguments, but because they're both 32 bits, we can
36 // pack them into one 64-bit value, at the cost of making said value
37 // nonsensical.
38 //
39 // In order to do this, we need to reserve one value of the second (optional)
40 // allocsize argument to signify "not present."
41 LLVM_CONSTEXPR static unsigned AllocSizeNumElemsNotPresent = -1;
42 
43 static uint64_t packAllocSizeArgs(unsigned ElemSizeArg,
44                                   const Optional<unsigned> &NumElemsArg) {
45   assert((!NumElemsArg.hasValue() ||
46           *NumElemsArg != AllocSizeNumElemsNotPresent) &&
47          "Attempting to pack a reserved value");
48 
49   return uint64_t(ElemSizeArg) << 32 |
50          NumElemsArg.getValueOr(AllocSizeNumElemsNotPresent);
51 }
52 
53 static std::pair<unsigned, Optional<unsigned>>
54 unpackAllocSizeArgs(uint64_t Num) {
55   unsigned NumElems = Num & std::numeric_limits<unsigned>::max();
56   unsigned ElemSizeArg = Num >> 32;
57 
58   Optional<unsigned> NumElemsArg;
59   if (NumElems != AllocSizeNumElemsNotPresent)
60     NumElemsArg = NumElems;
61   return std::make_pair(ElemSizeArg, NumElemsArg);
62 }
63 
64 Attribute Attribute::get(LLVMContext &Context, Attribute::AttrKind Kind,
65                          uint64_t Val) {
66   LLVMContextImpl *pImpl = Context.pImpl;
67   FoldingSetNodeID ID;
68   ID.AddInteger(Kind);
69   if (Val) ID.AddInteger(Val);
70 
71   void *InsertPoint;
72   AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
73 
74   if (!PA) {
75     // If we didn't find any existing attributes of the same shape then create a
76     // new one and insert it.
77     if (!Val)
78       PA = new EnumAttributeImpl(Kind);
79     else
80       PA = new IntAttributeImpl(Kind, Val);
81     pImpl->AttrsSet.InsertNode(PA, InsertPoint);
82   }
83 
84   // Return the Attribute that we found or created.
85   return Attribute(PA);
86 }
87 
88 Attribute Attribute::get(LLVMContext &Context, StringRef Kind, StringRef Val) {
89   LLVMContextImpl *pImpl = Context.pImpl;
90   FoldingSetNodeID ID;
91   ID.AddString(Kind);
92   if (!Val.empty()) ID.AddString(Val);
93 
94   void *InsertPoint;
95   AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
96 
97   if (!PA) {
98     // If we didn't find any existing attributes of the same shape then create a
99     // new one and insert it.
100     PA = new StringAttributeImpl(Kind, Val);
101     pImpl->AttrsSet.InsertNode(PA, InsertPoint);
102   }
103 
104   // Return the Attribute that we found or created.
105   return Attribute(PA);
106 }
107 
108 Attribute Attribute::getWithAlignment(LLVMContext &Context, uint64_t Align) {
109   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
110   assert(Align <= 0x40000000 && "Alignment too large.");
111   return get(Context, Alignment, Align);
112 }
113 
114 Attribute Attribute::getWithStackAlignment(LLVMContext &Context,
115                                            uint64_t Align) {
116   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
117   assert(Align <= 0x100 && "Alignment too large.");
118   return get(Context, StackAlignment, Align);
119 }
120 
121 Attribute Attribute::getWithDereferenceableBytes(LLVMContext &Context,
122                                                 uint64_t Bytes) {
123   assert(Bytes && "Bytes must be non-zero.");
124   return get(Context, Dereferenceable, Bytes);
125 }
126 
127 Attribute Attribute::getWithDereferenceableOrNullBytes(LLVMContext &Context,
128                                                        uint64_t Bytes) {
129   assert(Bytes && "Bytes must be non-zero.");
130   return get(Context, DereferenceableOrNull, Bytes);
131 }
132 
133 Attribute
134 Attribute::getWithAllocSizeArgs(LLVMContext &Context, unsigned ElemSizeArg,
135                                 const Optional<unsigned> &NumElemsArg) {
136   assert(!(ElemSizeArg == 0 && NumElemsArg && *NumElemsArg == 0) &&
137          "Invalid allocsize arguments -- given allocsize(0, 0)");
138   return get(Context, AllocSize, packAllocSizeArgs(ElemSizeArg, NumElemsArg));
139 }
140 
141 //===----------------------------------------------------------------------===//
142 // Attribute Accessor Methods
143 //===----------------------------------------------------------------------===//
144 
145 bool Attribute::isEnumAttribute() const {
146   return pImpl && pImpl->isEnumAttribute();
147 }
148 
149 bool Attribute::isIntAttribute() const {
150   return pImpl && pImpl->isIntAttribute();
151 }
152 
153 bool Attribute::isStringAttribute() const {
154   return pImpl && pImpl->isStringAttribute();
155 }
156 
157 Attribute::AttrKind Attribute::getKindAsEnum() const {
158   if (!pImpl) return None;
159   assert((isEnumAttribute() || isIntAttribute()) &&
160          "Invalid attribute type to get the kind as an enum!");
161   return pImpl->getKindAsEnum();
162 }
163 
164 uint64_t Attribute::getValueAsInt() const {
165   if (!pImpl) return 0;
166   assert(isIntAttribute() &&
167          "Expected the attribute to be an integer attribute!");
168   return pImpl->getValueAsInt();
169 }
170 
171 StringRef Attribute::getKindAsString() const {
172   if (!pImpl) return StringRef();
173   assert(isStringAttribute() &&
174          "Invalid attribute type to get the kind as a string!");
175   return pImpl->getKindAsString();
176 }
177 
178 StringRef Attribute::getValueAsString() const {
179   if (!pImpl) return StringRef();
180   assert(isStringAttribute() &&
181          "Invalid attribute type to get the value as a string!");
182   return pImpl->getValueAsString();
183 }
184 
185 bool Attribute::hasAttribute(AttrKind Kind) const {
186   return (pImpl && pImpl->hasAttribute(Kind)) || (!pImpl && Kind == None);
187 }
188 
189 bool Attribute::hasAttribute(StringRef Kind) const {
190   if (!isStringAttribute()) return false;
191   return pImpl && pImpl->hasAttribute(Kind);
192 }
193 
194 unsigned Attribute::getAlignment() const {
195   assert(hasAttribute(Attribute::Alignment) &&
196          "Trying to get alignment from non-alignment attribute!");
197   return pImpl->getValueAsInt();
198 }
199 
200 unsigned Attribute::getStackAlignment() const {
201   assert(hasAttribute(Attribute::StackAlignment) &&
202          "Trying to get alignment from non-alignment attribute!");
203   return pImpl->getValueAsInt();
204 }
205 
206 uint64_t Attribute::getDereferenceableBytes() const {
207   assert(hasAttribute(Attribute::Dereferenceable) &&
208          "Trying to get dereferenceable bytes from "
209          "non-dereferenceable attribute!");
210   return pImpl->getValueAsInt();
211 }
212 
213 uint64_t Attribute::getDereferenceableOrNullBytes() const {
214   assert(hasAttribute(Attribute::DereferenceableOrNull) &&
215          "Trying to get dereferenceable bytes from "
216          "non-dereferenceable attribute!");
217   return pImpl->getValueAsInt();
218 }
219 
220 std::pair<unsigned, Optional<unsigned>> Attribute::getAllocSizeArgs() const {
221   assert(hasAttribute(Attribute::AllocSize) &&
222          "Trying to get allocsize args from non-allocsize attribute");
223   return unpackAllocSizeArgs(pImpl->getValueAsInt());
224 }
225 
226 std::string Attribute::getAsString(bool InAttrGrp) const {
227   if (!pImpl) return "";
228 
229   if (hasAttribute(Attribute::SanitizeAddress))
230     return "sanitize_address";
231   if (hasAttribute(Attribute::AlwaysInline))
232     return "alwaysinline";
233   if (hasAttribute(Attribute::ArgMemOnly))
234     return "argmemonly";
235   if (hasAttribute(Attribute::Builtin))
236     return "builtin";
237   if (hasAttribute(Attribute::ByVal))
238     return "byval";
239   if (hasAttribute(Attribute::Convergent))
240     return "convergent";
241   if (hasAttribute(Attribute::SwiftError))
242     return "swifterror";
243   if (hasAttribute(Attribute::SwiftSelf))
244     return "swiftself";
245   if (hasAttribute(Attribute::InaccessibleMemOnly))
246     return "inaccessiblememonly";
247   if (hasAttribute(Attribute::InaccessibleMemOrArgMemOnly))
248     return "inaccessiblemem_or_argmemonly";
249   if (hasAttribute(Attribute::InAlloca))
250     return "inalloca";
251   if (hasAttribute(Attribute::InlineHint))
252     return "inlinehint";
253   if (hasAttribute(Attribute::InReg))
254     return "inreg";
255   if (hasAttribute(Attribute::JumpTable))
256     return "jumptable";
257   if (hasAttribute(Attribute::MinSize))
258     return "minsize";
259   if (hasAttribute(Attribute::Naked))
260     return "naked";
261   if (hasAttribute(Attribute::Nest))
262     return "nest";
263   if (hasAttribute(Attribute::NoAlias))
264     return "noalias";
265   if (hasAttribute(Attribute::NoBuiltin))
266     return "nobuiltin";
267   if (hasAttribute(Attribute::NoCapture))
268     return "nocapture";
269   if (hasAttribute(Attribute::NoDuplicate))
270     return "noduplicate";
271   if (hasAttribute(Attribute::NoImplicitFloat))
272     return "noimplicitfloat";
273   if (hasAttribute(Attribute::NoInline))
274     return "noinline";
275   if (hasAttribute(Attribute::NonLazyBind))
276     return "nonlazybind";
277   if (hasAttribute(Attribute::NonNull))
278     return "nonnull";
279   if (hasAttribute(Attribute::NoRedZone))
280     return "noredzone";
281   if (hasAttribute(Attribute::NoReturn))
282     return "noreturn";
283   if (hasAttribute(Attribute::NoRecurse))
284     return "norecurse";
285   if (hasAttribute(Attribute::NoUnwind))
286     return "nounwind";
287   if (hasAttribute(Attribute::OptimizeNone))
288     return "optnone";
289   if (hasAttribute(Attribute::OptimizeForSize))
290     return "optsize";
291   if (hasAttribute(Attribute::ReadNone))
292     return "readnone";
293   if (hasAttribute(Attribute::ReadOnly))
294     return "readonly";
295   if (hasAttribute(Attribute::Returned))
296     return "returned";
297   if (hasAttribute(Attribute::ReturnsTwice))
298     return "returns_twice";
299   if (hasAttribute(Attribute::SExt))
300     return "signext";
301   if (hasAttribute(Attribute::StackProtect))
302     return "ssp";
303   if (hasAttribute(Attribute::StackProtectReq))
304     return "sspreq";
305   if (hasAttribute(Attribute::StackProtectStrong))
306     return "sspstrong";
307   if (hasAttribute(Attribute::SafeStack))
308     return "safestack";
309   if (hasAttribute(Attribute::StructRet))
310     return "sret";
311   if (hasAttribute(Attribute::SanitizeThread))
312     return "sanitize_thread";
313   if (hasAttribute(Attribute::SanitizeMemory))
314     return "sanitize_memory";
315   if (hasAttribute(Attribute::UWTable))
316     return "uwtable";
317   if (hasAttribute(Attribute::ZExt))
318     return "zeroext";
319   if (hasAttribute(Attribute::Cold))
320     return "cold";
321 
322   // FIXME: These should be output like this:
323   //
324   //   align=4
325   //   alignstack=8
326   //
327   if (hasAttribute(Attribute::Alignment)) {
328     std::string Result;
329     Result += "align";
330     Result += (InAttrGrp) ? "=" : " ";
331     Result += utostr(getValueAsInt());
332     return Result;
333   }
334 
335   auto AttrWithBytesToString = [&](const char *Name) {
336     std::string Result;
337     Result += Name;
338     if (InAttrGrp) {
339       Result += "=";
340       Result += utostr(getValueAsInt());
341     } else {
342       Result += "(";
343       Result += utostr(getValueAsInt());
344       Result += ")";
345     }
346     return Result;
347   };
348 
349   if (hasAttribute(Attribute::StackAlignment))
350     return AttrWithBytesToString("alignstack");
351 
352   if (hasAttribute(Attribute::Dereferenceable))
353     return AttrWithBytesToString("dereferenceable");
354 
355   if (hasAttribute(Attribute::DereferenceableOrNull))
356     return AttrWithBytesToString("dereferenceable_or_null");
357 
358   if (hasAttribute(Attribute::AllocSize)) {
359     unsigned ElemSize;
360     Optional<unsigned> NumElems;
361     std::tie(ElemSize, NumElems) = getAllocSizeArgs();
362 
363     std::string Result = "allocsize(";
364     Result += utostr(ElemSize);
365     if (NumElems.hasValue()) {
366       Result += ',';
367       Result += utostr(*NumElems);
368     }
369     Result += ')';
370     return Result;
371   }
372 
373   // Convert target-dependent attributes to strings of the form:
374   //
375   //   "kind"
376   //   "kind" = "value"
377   //
378   if (isStringAttribute()) {
379     std::string Result;
380     Result += (Twine('"') + getKindAsString() + Twine('"')).str();
381 
382     StringRef Val = pImpl->getValueAsString();
383     if (Val.empty()) return Result;
384 
385     Result += ("=\"" + Val + Twine('"')).str();
386     return Result;
387   }
388 
389   llvm_unreachable("Unknown attribute");
390 }
391 
392 bool Attribute::operator<(Attribute A) const {
393   if (!pImpl && !A.pImpl) return false;
394   if (!pImpl) return true;
395   if (!A.pImpl) return false;
396   return *pImpl < *A.pImpl;
397 }
398 
399 //===----------------------------------------------------------------------===//
400 // AttributeImpl Definition
401 //===----------------------------------------------------------------------===//
402 
403 // Pin the vtables to this file.
404 AttributeImpl::~AttributeImpl() {}
405 void EnumAttributeImpl::anchor() {}
406 void IntAttributeImpl::anchor() {}
407 void StringAttributeImpl::anchor() {}
408 
409 bool AttributeImpl::hasAttribute(Attribute::AttrKind A) const {
410   if (isStringAttribute()) return false;
411   return getKindAsEnum() == A;
412 }
413 
414 bool AttributeImpl::hasAttribute(StringRef Kind) const {
415   if (!isStringAttribute()) return false;
416   return getKindAsString() == Kind;
417 }
418 
419 Attribute::AttrKind AttributeImpl::getKindAsEnum() const {
420   assert(isEnumAttribute() || isIntAttribute());
421   return static_cast<const EnumAttributeImpl *>(this)->getEnumKind();
422 }
423 
424 uint64_t AttributeImpl::getValueAsInt() const {
425   assert(isIntAttribute());
426   return static_cast<const IntAttributeImpl *>(this)->getValue();
427 }
428 
429 StringRef AttributeImpl::getKindAsString() const {
430   assert(isStringAttribute());
431   return static_cast<const StringAttributeImpl *>(this)->getStringKind();
432 }
433 
434 StringRef AttributeImpl::getValueAsString() const {
435   assert(isStringAttribute());
436   return static_cast<const StringAttributeImpl *>(this)->getStringValue();
437 }
438 
439 bool AttributeImpl::operator<(const AttributeImpl &AI) const {
440   // This sorts the attributes with Attribute::AttrKinds coming first (sorted
441   // relative to their enum value) and then strings.
442   if (isEnumAttribute()) {
443     if (AI.isEnumAttribute()) return getKindAsEnum() < AI.getKindAsEnum();
444     if (AI.isIntAttribute()) return true;
445     if (AI.isStringAttribute()) return true;
446   }
447 
448   if (isIntAttribute()) {
449     if (AI.isEnumAttribute()) return false;
450     if (AI.isIntAttribute()) {
451       if (getKindAsEnum() == AI.getKindAsEnum())
452         return getValueAsInt() < AI.getValueAsInt();
453       return getKindAsEnum() < AI.getKindAsEnum();
454     }
455     if (AI.isStringAttribute()) return true;
456   }
457 
458   if (AI.isEnumAttribute()) return false;
459   if (AI.isIntAttribute()) return false;
460   if (getKindAsString() == AI.getKindAsString())
461     return getValueAsString() < AI.getValueAsString();
462   return getKindAsString() < AI.getKindAsString();
463 }
464 
465 uint64_t AttributeImpl::getAttrMask(Attribute::AttrKind Val) {
466   // FIXME: Remove this.
467   switch (Val) {
468   case Attribute::EndAttrKinds:
469     llvm_unreachable("Synthetic enumerators which should never get here");
470 
471   case Attribute::None:            return 0;
472   case Attribute::ZExt:            return 1 << 0;
473   case Attribute::SExt:            return 1 << 1;
474   case Attribute::NoReturn:        return 1 << 2;
475   case Attribute::InReg:           return 1 << 3;
476   case Attribute::StructRet:       return 1 << 4;
477   case Attribute::NoUnwind:        return 1 << 5;
478   case Attribute::NoAlias:         return 1 << 6;
479   case Attribute::ByVal:           return 1 << 7;
480   case Attribute::Nest:            return 1 << 8;
481   case Attribute::ReadNone:        return 1 << 9;
482   case Attribute::ReadOnly:        return 1 << 10;
483   case Attribute::NoInline:        return 1 << 11;
484   case Attribute::AlwaysInline:    return 1 << 12;
485   case Attribute::OptimizeForSize: return 1 << 13;
486   case Attribute::StackProtect:    return 1 << 14;
487   case Attribute::StackProtectReq: return 1 << 15;
488   case Attribute::Alignment:       return 31 << 16;
489   case Attribute::NoCapture:       return 1 << 21;
490   case Attribute::NoRedZone:       return 1 << 22;
491   case Attribute::NoImplicitFloat: return 1 << 23;
492   case Attribute::Naked:           return 1 << 24;
493   case Attribute::InlineHint:      return 1 << 25;
494   case Attribute::StackAlignment:  return 7 << 26;
495   case Attribute::ReturnsTwice:    return 1 << 29;
496   case Attribute::UWTable:         return 1 << 30;
497   case Attribute::NonLazyBind:     return 1U << 31;
498   case Attribute::SanitizeAddress: return 1ULL << 32;
499   case Attribute::MinSize:         return 1ULL << 33;
500   case Attribute::NoDuplicate:     return 1ULL << 34;
501   case Attribute::StackProtectStrong: return 1ULL << 35;
502   case Attribute::SanitizeThread:  return 1ULL << 36;
503   case Attribute::SanitizeMemory:  return 1ULL << 37;
504   case Attribute::NoBuiltin:       return 1ULL << 38;
505   case Attribute::Returned:        return 1ULL << 39;
506   case Attribute::Cold:            return 1ULL << 40;
507   case Attribute::Builtin:         return 1ULL << 41;
508   case Attribute::OptimizeNone:    return 1ULL << 42;
509   case Attribute::InAlloca:        return 1ULL << 43;
510   case Attribute::NonNull:         return 1ULL << 44;
511   case Attribute::JumpTable:       return 1ULL << 45;
512   case Attribute::Convergent:      return 1ULL << 46;
513   case Attribute::SafeStack:       return 1ULL << 47;
514   case Attribute::NoRecurse:       return 1ULL << 48;
515   case Attribute::InaccessibleMemOnly:         return 1ULL << 49;
516   case Attribute::InaccessibleMemOrArgMemOnly: return 1ULL << 50;
517   case Attribute::SwiftSelf:       return 1ULL << 51;
518   case Attribute::SwiftError:      return 1ULL << 52;
519   case Attribute::Dereferenceable:
520     llvm_unreachable("dereferenceable attribute not supported in raw format");
521     break;
522   case Attribute::DereferenceableOrNull:
523     llvm_unreachable("dereferenceable_or_null attribute not supported in raw "
524                      "format");
525     break;
526   case Attribute::ArgMemOnly:
527     llvm_unreachable("argmemonly attribute not supported in raw format");
528     break;
529   case Attribute::AllocSize:
530     llvm_unreachable("allocsize not supported in raw format");
531     break;
532   }
533   llvm_unreachable("Unsupported attribute type");
534 }
535 
536 //===----------------------------------------------------------------------===//
537 // AttributeSetNode Definition
538 //===----------------------------------------------------------------------===//
539 
540 AttributeSetNode *AttributeSetNode::get(LLVMContext &C,
541                                         ArrayRef<Attribute> Attrs) {
542   if (Attrs.empty())
543     return nullptr;
544 
545   // Otherwise, build a key to look up the existing attributes.
546   LLVMContextImpl *pImpl = C.pImpl;
547   FoldingSetNodeID ID;
548 
549   SmallVector<Attribute, 8> SortedAttrs(Attrs.begin(), Attrs.end());
550   std::sort(SortedAttrs.begin(), SortedAttrs.end());
551 
552   for (Attribute Attr : SortedAttrs)
553     Attr.Profile(ID);
554 
555   void *InsertPoint;
556   AttributeSetNode *PA =
557     pImpl->AttrsSetNodes.FindNodeOrInsertPos(ID, InsertPoint);
558 
559   // If we didn't find any existing attributes of the same shape then create a
560   // new one and insert it.
561   if (!PA) {
562     // Coallocate entries after the AttributeSetNode itself.
563     void *Mem = ::operator new(totalSizeToAlloc<Attribute>(SortedAttrs.size()));
564     PA = new (Mem) AttributeSetNode(SortedAttrs);
565     pImpl->AttrsSetNodes.InsertNode(PA, InsertPoint);
566   }
567 
568   // Return the AttributesListNode that we found or created.
569   return PA;
570 }
571 
572 bool AttributeSetNode::hasAttribute(StringRef Kind) const {
573   for (iterator I = begin(), E = end(); I != E; ++I)
574     if (I->hasAttribute(Kind))
575       return true;
576   return false;
577 }
578 
579 Attribute AttributeSetNode::getAttribute(Attribute::AttrKind Kind) const {
580   if (hasAttribute(Kind)) {
581     for (iterator I = begin(), E = end(); I != E; ++I)
582       if (I->hasAttribute(Kind))
583         return *I;
584   }
585   return Attribute();
586 }
587 
588 Attribute AttributeSetNode::getAttribute(StringRef Kind) const {
589   for (iterator I = begin(), E = end(); I != E; ++I)
590     if (I->hasAttribute(Kind))
591       return *I;
592   return Attribute();
593 }
594 
595 unsigned AttributeSetNode::getAlignment() const {
596   for (iterator I = begin(), E = end(); I != E; ++I)
597     if (I->hasAttribute(Attribute::Alignment))
598       return I->getAlignment();
599   return 0;
600 }
601 
602 unsigned AttributeSetNode::getStackAlignment() const {
603   for (iterator I = begin(), E = end(); I != E; ++I)
604     if (I->hasAttribute(Attribute::StackAlignment))
605       return I->getStackAlignment();
606   return 0;
607 }
608 
609 uint64_t AttributeSetNode::getDereferenceableBytes() const {
610   for (iterator I = begin(), E = end(); I != E; ++I)
611     if (I->hasAttribute(Attribute::Dereferenceable))
612       return I->getDereferenceableBytes();
613   return 0;
614 }
615 
616 uint64_t AttributeSetNode::getDereferenceableOrNullBytes() const {
617   for (iterator I = begin(), E = end(); I != E; ++I)
618     if (I->hasAttribute(Attribute::DereferenceableOrNull))
619       return I->getDereferenceableOrNullBytes();
620   return 0;
621 }
622 
623 std::pair<unsigned, Optional<unsigned>>
624 AttributeSetNode::getAllocSizeArgs() const {
625   for (iterator I = begin(), E = end(); I != E; ++I)
626     if (I->hasAttribute(Attribute::AllocSize))
627       return I->getAllocSizeArgs();
628   return std::make_pair(0, 0);
629 }
630 
631 std::string AttributeSetNode::getAsString(bool InAttrGrp) const {
632   std::string Str;
633   for (iterator I = begin(), E = end(); I != E; ++I) {
634     if (I != begin())
635       Str += ' ';
636     Str += I->getAsString(InAttrGrp);
637   }
638   return Str;
639 }
640 
641 //===----------------------------------------------------------------------===//
642 // AttributeSetImpl Definition
643 //===----------------------------------------------------------------------===//
644 
645 uint64_t AttributeSetImpl::Raw(unsigned Index) const {
646   for (unsigned I = 0, E = getNumAttributes(); I != E; ++I) {
647     if (getSlotIndex(I) != Index) continue;
648     const AttributeSetNode *ASN = getSlotNode(I);
649     uint64_t Mask = 0;
650 
651     for (AttributeSetNode::iterator II = ASN->begin(),
652            IE = ASN->end(); II != IE; ++II) {
653       Attribute Attr = *II;
654 
655       // This cannot handle string attributes.
656       if (Attr.isStringAttribute()) continue;
657 
658       Attribute::AttrKind Kind = Attr.getKindAsEnum();
659 
660       if (Kind == Attribute::Alignment)
661         Mask |= (Log2_32(ASN->getAlignment()) + 1) << 16;
662       else if (Kind == Attribute::StackAlignment)
663         Mask |= (Log2_32(ASN->getStackAlignment()) + 1) << 26;
664       else if (Kind == Attribute::Dereferenceable)
665         llvm_unreachable("dereferenceable not supported in bit mask");
666       else if (Kind == Attribute::AllocSize)
667         llvm_unreachable("allocsize not supported in bit mask");
668       else
669         Mask |= AttributeImpl::getAttrMask(Kind);
670     }
671 
672     return Mask;
673   }
674 
675   return 0;
676 }
677 
678 LLVM_DUMP_METHOD void AttributeSetImpl::dump() const {
679   AttributeSet(const_cast<AttributeSetImpl *>(this)).dump();
680 }
681 
682 //===----------------------------------------------------------------------===//
683 // AttributeSet Construction and Mutation Methods
684 //===----------------------------------------------------------------------===//
685 
686 AttributeSet
687 AttributeSet::getImpl(LLVMContext &C,
688                       ArrayRef<std::pair<unsigned, AttributeSetNode*> > Attrs) {
689   LLVMContextImpl *pImpl = C.pImpl;
690   FoldingSetNodeID ID;
691   AttributeSetImpl::Profile(ID, Attrs);
692 
693   void *InsertPoint;
694   AttributeSetImpl *PA = pImpl->AttrsLists.FindNodeOrInsertPos(ID, InsertPoint);
695 
696   // If we didn't find any existing attributes of the same shape then
697   // create a new one and insert it.
698   if (!PA) {
699     // Coallocate entries after the AttributeSetImpl itself.
700     void *Mem = ::operator new(
701         AttributeSetImpl::totalSizeToAlloc<IndexAttrPair>(Attrs.size()));
702     PA = new (Mem) AttributeSetImpl(C, Attrs);
703     pImpl->AttrsLists.InsertNode(PA, InsertPoint);
704   }
705 
706   // Return the AttributesList that we found or created.
707   return AttributeSet(PA);
708 }
709 
710 AttributeSet AttributeSet::get(LLVMContext &C,
711                                ArrayRef<std::pair<unsigned, Attribute> > Attrs){
712   // If there are no attributes then return a null AttributesList pointer.
713   if (Attrs.empty())
714     return AttributeSet();
715 
716   assert(std::is_sorted(Attrs.begin(), Attrs.end(),
717                         [](const std::pair<unsigned, Attribute> &LHS,
718                            const std::pair<unsigned, Attribute> &RHS) {
719                           return LHS.first < RHS.first;
720                         }) && "Misordered Attributes list!");
721   assert(std::none_of(Attrs.begin(), Attrs.end(),
722                       [](const std::pair<unsigned, Attribute> &Pair) {
723                         return Pair.second.hasAttribute(Attribute::None);
724                       }) && "Pointless attribute!");
725 
726   // Create a vector if (unsigned, AttributeSetNode*) pairs from the attributes
727   // list.
728   SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrPairVec;
729   for (ArrayRef<std::pair<unsigned, Attribute> >::iterator I = Attrs.begin(),
730          E = Attrs.end(); I != E; ) {
731     unsigned Index = I->first;
732     SmallVector<Attribute, 4> AttrVec;
733     while (I != E && I->first == Index) {
734       AttrVec.push_back(I->second);
735       ++I;
736     }
737 
738     AttrPairVec.push_back(std::make_pair(Index,
739                                          AttributeSetNode::get(C, AttrVec)));
740   }
741 
742   return getImpl(C, AttrPairVec);
743 }
744 
745 AttributeSet AttributeSet::get(LLVMContext &C,
746                                ArrayRef<std::pair<unsigned,
747                                                   AttributeSetNode*> > Attrs) {
748   // If there are no attributes then return a null AttributesList pointer.
749   if (Attrs.empty())
750     return AttributeSet();
751 
752   return getImpl(C, Attrs);
753 }
754 
755 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
756                                const AttrBuilder &B) {
757   if (!B.hasAttributes())
758     return AttributeSet();
759 
760   // Add target-independent attributes.
761   SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
762   for (Attribute::AttrKind Kind = Attribute::None;
763        Kind != Attribute::EndAttrKinds; Kind = Attribute::AttrKind(Kind + 1)) {
764     if (!B.contains(Kind))
765       continue;
766 
767     Attribute Attr;
768     switch (Kind) {
769     case Attribute::Alignment:
770       Attr = Attribute::getWithAlignment(C, B.getAlignment());
771       break;
772     case Attribute::StackAlignment:
773       Attr = Attribute::getWithStackAlignment(C, B.getStackAlignment());
774       break;
775     case Attribute::Dereferenceable:
776       Attr = Attribute::getWithDereferenceableBytes(
777           C, B.getDereferenceableBytes());
778       break;
779     case Attribute::DereferenceableOrNull:
780       Attr = Attribute::getWithDereferenceableOrNullBytes(
781           C, B.getDereferenceableOrNullBytes());
782       break;
783     case Attribute::AllocSize: {
784       auto A = B.getAllocSizeArgs();
785       Attr = Attribute::getWithAllocSizeArgs(C, A.first, A.second);
786       break;
787     }
788     default:
789       Attr = Attribute::get(C, Kind);
790     }
791     Attrs.push_back(std::make_pair(Index, Attr));
792   }
793 
794   // Add target-dependent (string) attributes.
795   for (const AttrBuilder::td_type &TDA : B.td_attrs())
796     Attrs.push_back(
797         std::make_pair(Index, Attribute::get(C, TDA.first, TDA.second)));
798 
799   return get(C, Attrs);
800 }
801 
802 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
803                                ArrayRef<Attribute::AttrKind> Kind) {
804   SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
805   for (Attribute::AttrKind K : Kind)
806     Attrs.push_back(std::make_pair(Index, Attribute::get(C, K)));
807   return get(C, Attrs);
808 }
809 
810 AttributeSet AttributeSet::get(LLVMContext &C, ArrayRef<AttributeSet> Attrs) {
811   if (Attrs.empty()) return AttributeSet();
812   if (Attrs.size() == 1) return Attrs[0];
813 
814   SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrNodeVec;
815   AttributeSetImpl *A0 = Attrs[0].pImpl;
816   if (A0)
817     AttrNodeVec.append(A0->getNode(0), A0->getNode(A0->getNumAttributes()));
818   // Copy all attributes from Attrs into AttrNodeVec while keeping AttrNodeVec
819   // ordered by index.  Because we know that each list in Attrs is ordered by
820   // index we only need to merge each successive list in rather than doing a
821   // full sort.
822   for (unsigned I = 1, E = Attrs.size(); I != E; ++I) {
823     AttributeSetImpl *AS = Attrs[I].pImpl;
824     if (!AS) continue;
825     SmallVector<std::pair<unsigned, AttributeSetNode *>, 8>::iterator
826       ANVI = AttrNodeVec.begin(), ANVE;
827     for (const IndexAttrPair *AI = AS->getNode(0),
828                              *AE = AS->getNode(AS->getNumAttributes());
829          AI != AE; ++AI) {
830       ANVE = AttrNodeVec.end();
831       while (ANVI != ANVE && ANVI->first <= AI->first)
832         ++ANVI;
833       ANVI = AttrNodeVec.insert(ANVI, *AI) + 1;
834     }
835   }
836 
837   return getImpl(C, AttrNodeVec);
838 }
839 
840 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
841                                         Attribute::AttrKind Attr) const {
842   if (hasAttribute(Index, Attr)) return *this;
843   return addAttributes(C, Index, AttributeSet::get(C, Index, Attr));
844 }
845 
846 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
847                                         StringRef Kind) const {
848   llvm::AttrBuilder B;
849   B.addAttribute(Kind);
850   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
851 }
852 
853 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
854                                         StringRef Kind, StringRef Value) const {
855   llvm::AttrBuilder B;
856   B.addAttribute(Kind, Value);
857   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
858 }
859 
860 AttributeSet AttributeSet::addAttribute(LLVMContext &C,
861                                         ArrayRef<unsigned> Indices,
862                                         Attribute A) const {
863   unsigned I = 0, E = pImpl ? pImpl->getNumAttributes() : 0;
864   auto IdxI = Indices.begin(), IdxE = Indices.end();
865   SmallVector<AttributeSet, 4> AttrSet;
866 
867   while (I != E && IdxI != IdxE) {
868     if (getSlotIndex(I) < *IdxI)
869       AttrSet.emplace_back(getSlotAttributes(I++));
870     else if (getSlotIndex(I) > *IdxI)
871       AttrSet.emplace_back(AttributeSet::get(C, std::make_pair(*IdxI++, A)));
872     else {
873       AttrBuilder B(getSlotAttributes(I), *IdxI);
874       B.addAttribute(A);
875       AttrSet.emplace_back(AttributeSet::get(C, *IdxI, B));
876       ++I;
877       ++IdxI;
878     }
879   }
880 
881   while (I != E)
882     AttrSet.emplace_back(getSlotAttributes(I++));
883 
884   while (IdxI != IdxE)
885     AttrSet.emplace_back(AttributeSet::get(C, std::make_pair(*IdxI++, A)));
886 
887   return get(C, AttrSet);
888 }
889 
890 AttributeSet AttributeSet::addAttributes(LLVMContext &C, unsigned Index,
891                                          AttributeSet Attrs) const {
892   if (!pImpl) return Attrs;
893   if (!Attrs.pImpl) return *this;
894 
895 #ifndef NDEBUG
896   // FIXME it is not obvious how this should work for alignment. For now, say
897   // we can't change a known alignment.
898   unsigned OldAlign = getParamAlignment(Index);
899   unsigned NewAlign = Attrs.getParamAlignment(Index);
900   assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
901          "Attempt to change alignment!");
902 #endif
903 
904   // Add the attribute slots before the one we're trying to add.
905   SmallVector<AttributeSet, 4> AttrSet;
906   uint64_t NumAttrs = pImpl->getNumAttributes();
907   AttributeSet AS;
908   uint64_t LastIndex = 0;
909   for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
910     if (getSlotIndex(I) >= Index) {
911       if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
912       break;
913     }
914     LastIndex = I + 1;
915     AttrSet.push_back(getSlotAttributes(I));
916   }
917 
918   // Now add the attribute into the correct slot. There may already be an
919   // AttributeSet there.
920   AttrBuilder B(AS, Index);
921 
922   for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
923     if (Attrs.getSlotIndex(I) == Index) {
924       for (AttributeSetImpl::iterator II = Attrs.pImpl->begin(I),
925              IE = Attrs.pImpl->end(I); II != IE; ++II)
926         B.addAttribute(*II);
927       break;
928     }
929 
930   AttrSet.push_back(AttributeSet::get(C, Index, B));
931 
932   // Add the remaining attribute slots.
933   for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
934     AttrSet.push_back(getSlotAttributes(I));
935 
936   return get(C, AttrSet);
937 }
938 
939 AttributeSet AttributeSet::removeAttribute(LLVMContext &C, unsigned Index,
940                                            Attribute::AttrKind Attr) const {
941   if (!hasAttribute(Index, Attr)) return *this;
942   return removeAttributes(C, Index, AttributeSet::get(C, Index, Attr));
943 }
944 
945 AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
946                                             AttributeSet Attrs) const {
947   if (!pImpl) return AttributeSet();
948   if (!Attrs.pImpl) return *this;
949 
950   // FIXME it is not obvious how this should work for alignment.
951   // For now, say we can't pass in alignment, which no current use does.
952   assert(!Attrs.hasAttribute(Index, Attribute::Alignment) &&
953          "Attempt to change alignment!");
954 
955   // Add the attribute slots before the one we're trying to add.
956   SmallVector<AttributeSet, 4> AttrSet;
957   uint64_t NumAttrs = pImpl->getNumAttributes();
958   AttributeSet AS;
959   uint64_t LastIndex = 0;
960   for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
961     if (getSlotIndex(I) >= Index) {
962       if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
963       break;
964     }
965     LastIndex = I + 1;
966     AttrSet.push_back(getSlotAttributes(I));
967   }
968 
969   // Now remove the attribute from the correct slot. There may already be an
970   // AttributeSet there.
971   AttrBuilder B(AS, Index);
972 
973   for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
974     if (Attrs.getSlotIndex(I) == Index) {
975       B.removeAttributes(Attrs.pImpl->getSlotAttributes(I), Index);
976       break;
977     }
978 
979   AttrSet.push_back(AttributeSet::get(C, Index, B));
980 
981   // Add the remaining attribute slots.
982   for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
983     AttrSet.push_back(getSlotAttributes(I));
984 
985   return get(C, AttrSet);
986 }
987 
988 AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
989                                             const AttrBuilder &Attrs) const {
990   if (!pImpl) return AttributeSet();
991 
992   // FIXME it is not obvious how this should work for alignment.
993   // For now, say we can't pass in alignment, which no current use does.
994   assert(!Attrs.hasAlignmentAttr() && "Attempt to change alignment!");
995 
996   // Add the attribute slots before the one we're trying to add.
997   SmallVector<AttributeSet, 4> AttrSet;
998   uint64_t NumAttrs = pImpl->getNumAttributes();
999   AttributeSet AS;
1000   uint64_t LastIndex = 0;
1001   for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
1002     if (getSlotIndex(I) >= Index) {
1003       if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
1004       break;
1005     }
1006     LastIndex = I + 1;
1007     AttrSet.push_back(getSlotAttributes(I));
1008   }
1009 
1010   // Now remove the attribute from the correct slot. There may already be an
1011   // AttributeSet there.
1012   AttrBuilder B(AS, Index);
1013   B.remove(Attrs);
1014 
1015   AttrSet.push_back(AttributeSet::get(C, Index, B));
1016 
1017   // Add the remaining attribute slots.
1018   for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
1019     AttrSet.push_back(getSlotAttributes(I));
1020 
1021   return get(C, AttrSet);
1022 }
1023 
1024 AttributeSet AttributeSet::addDereferenceableAttr(LLVMContext &C, unsigned Index,
1025                                                   uint64_t Bytes) const {
1026   llvm::AttrBuilder B;
1027   B.addDereferenceableAttr(Bytes);
1028   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
1029 }
1030 
1031 AttributeSet AttributeSet::addDereferenceableOrNullAttr(LLVMContext &C,
1032                                                         unsigned Index,
1033                                                         uint64_t Bytes) const {
1034   llvm::AttrBuilder B;
1035   B.addDereferenceableOrNullAttr(Bytes);
1036   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
1037 }
1038 
1039 AttributeSet
1040 AttributeSet::addAllocSizeAttr(LLVMContext &C, unsigned Index,
1041                                unsigned ElemSizeArg,
1042                                const Optional<unsigned> &NumElemsArg) {
1043   llvm::AttrBuilder B;
1044   B.addAllocSizeAttr(ElemSizeArg, NumElemsArg);
1045   return addAttributes(C, Index, AttributeSet::get(C, Index, B));
1046 }
1047 
1048 //===----------------------------------------------------------------------===//
1049 // AttributeSet Accessor Methods
1050 //===----------------------------------------------------------------------===//
1051 
1052 LLVMContext &AttributeSet::getContext() const {
1053   return pImpl->getContext();
1054 }
1055 
1056 AttributeSet AttributeSet::getParamAttributes(unsigned Index) const {
1057   return pImpl && hasAttributes(Index) ?
1058     AttributeSet::get(pImpl->getContext(),
1059                       ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
1060                         std::make_pair(Index, getAttributes(Index)))) :
1061     AttributeSet();
1062 }
1063 
1064 AttributeSet AttributeSet::getRetAttributes() const {
1065   return pImpl && hasAttributes(ReturnIndex) ?
1066     AttributeSet::get(pImpl->getContext(),
1067                       ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
1068                         std::make_pair(ReturnIndex,
1069                                        getAttributes(ReturnIndex)))) :
1070     AttributeSet();
1071 }
1072 
1073 AttributeSet AttributeSet::getFnAttributes() const {
1074   return pImpl && hasAttributes(FunctionIndex) ?
1075     AttributeSet::get(pImpl->getContext(),
1076                       ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
1077                         std::make_pair(FunctionIndex,
1078                                        getAttributes(FunctionIndex)))) :
1079     AttributeSet();
1080 }
1081 
1082 bool AttributeSet::hasAttribute(unsigned Index, Attribute::AttrKind Kind) const{
1083   AttributeSetNode *ASN = getAttributes(Index);
1084   return ASN && ASN->hasAttribute(Kind);
1085 }
1086 
1087 bool AttributeSet::hasAttribute(unsigned Index, StringRef Kind) const {
1088   AttributeSetNode *ASN = getAttributes(Index);
1089   return ASN && ASN->hasAttribute(Kind);
1090 }
1091 
1092 bool AttributeSet::hasAttributes(unsigned Index) const {
1093   AttributeSetNode *ASN = getAttributes(Index);
1094   return ASN && ASN->hasAttributes();
1095 }
1096 
1097 bool AttributeSet::hasFnAttribute(Attribute::AttrKind Kind) const {
1098   return pImpl && pImpl->hasFnAttribute(Kind);
1099 }
1100 
1101 bool AttributeSet::hasAttrSomewhere(Attribute::AttrKind Attr) const {
1102   if (!pImpl) return false;
1103 
1104   for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
1105     for (AttributeSetImpl::iterator II = pImpl->begin(I),
1106            IE = pImpl->end(I); II != IE; ++II)
1107       if (II->hasAttribute(Attr))
1108         return true;
1109 
1110   return false;
1111 }
1112 
1113 Attribute AttributeSet::getAttribute(unsigned Index,
1114                                      Attribute::AttrKind Kind) const {
1115   AttributeSetNode *ASN = getAttributes(Index);
1116   return ASN ? ASN->getAttribute(Kind) : Attribute();
1117 }
1118 
1119 Attribute AttributeSet::getAttribute(unsigned Index,
1120                                      StringRef Kind) const {
1121   AttributeSetNode *ASN = getAttributes(Index);
1122   return ASN ? ASN->getAttribute(Kind) : Attribute();
1123 }
1124 
1125 unsigned AttributeSet::getParamAlignment(unsigned Index) const {
1126   AttributeSetNode *ASN = getAttributes(Index);
1127   return ASN ? ASN->getAlignment() : 0;
1128 }
1129 
1130 unsigned AttributeSet::getStackAlignment(unsigned Index) const {
1131   AttributeSetNode *ASN = getAttributes(Index);
1132   return ASN ? ASN->getStackAlignment() : 0;
1133 }
1134 
1135 uint64_t AttributeSet::getDereferenceableBytes(unsigned Index) const {
1136   AttributeSetNode *ASN = getAttributes(Index);
1137   return ASN ? ASN->getDereferenceableBytes() : 0;
1138 }
1139 
1140 uint64_t AttributeSet::getDereferenceableOrNullBytes(unsigned Index) const {
1141   AttributeSetNode *ASN = getAttributes(Index);
1142   return ASN ? ASN->getDereferenceableOrNullBytes() : 0;
1143 }
1144 
1145 std::pair<unsigned, Optional<unsigned>>
1146 AttributeSet::getAllocSizeArgs(unsigned Index) const {
1147   AttributeSetNode *ASN = getAttributes(Index);
1148   return ASN ? ASN->getAllocSizeArgs() : std::make_pair(0, 0);
1149 }
1150 
1151 std::string AttributeSet::getAsString(unsigned Index, bool InAttrGrp) const {
1152   AttributeSetNode *ASN = getAttributes(Index);
1153   return ASN ? ASN->getAsString(InAttrGrp) : std::string("");
1154 }
1155 
1156 AttributeSetNode *AttributeSet::getAttributes(unsigned Index) const {
1157   if (!pImpl) return nullptr;
1158 
1159   // Loop through to find the attribute node we want.
1160   for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
1161     if (pImpl->getSlotIndex(I) == Index)
1162       return pImpl->getSlotNode(I);
1163 
1164   return nullptr;
1165 }
1166 
1167 AttributeSet::iterator AttributeSet::begin(unsigned Slot) const {
1168   if (!pImpl)
1169     return ArrayRef<Attribute>().begin();
1170   return pImpl->begin(Slot);
1171 }
1172 
1173 AttributeSet::iterator AttributeSet::end(unsigned Slot) const {
1174   if (!pImpl)
1175     return ArrayRef<Attribute>().end();
1176   return pImpl->end(Slot);
1177 }
1178 
1179 //===----------------------------------------------------------------------===//
1180 // AttributeSet Introspection Methods
1181 //===----------------------------------------------------------------------===//
1182 
1183 unsigned AttributeSet::getNumSlots() const {
1184   return pImpl ? pImpl->getNumAttributes() : 0;
1185 }
1186 
1187 unsigned AttributeSet::getSlotIndex(unsigned Slot) const {
1188   assert(pImpl && Slot < pImpl->getNumAttributes() &&
1189          "Slot # out of range!");
1190   return pImpl->getSlotIndex(Slot);
1191 }
1192 
1193 AttributeSet AttributeSet::getSlotAttributes(unsigned Slot) const {
1194   assert(pImpl && Slot < pImpl->getNumAttributes() &&
1195          "Slot # out of range!");
1196   return pImpl->getSlotAttributes(Slot);
1197 }
1198 
1199 uint64_t AttributeSet::Raw(unsigned Index) const {
1200   // FIXME: Remove this.
1201   return pImpl ? pImpl->Raw(Index) : 0;
1202 }
1203 
1204 LLVM_DUMP_METHOD void AttributeSet::dump() const {
1205   dbgs() << "PAL[\n";
1206 
1207   for (unsigned i = 0, e = getNumSlots(); i < e; ++i) {
1208     uint64_t Index = getSlotIndex(i);
1209     dbgs() << "  { ";
1210     if (Index == ~0U)
1211       dbgs() << "~0U";
1212     else
1213       dbgs() << Index;
1214     dbgs() << " => " << getAsString(Index) << " }\n";
1215   }
1216 
1217   dbgs() << "]\n";
1218 }
1219 
1220 //===----------------------------------------------------------------------===//
1221 // AttrBuilder Method Implementations
1222 //===----------------------------------------------------------------------===//
1223 
1224 AttrBuilder::AttrBuilder(AttributeSet AS, unsigned Index)
1225     : Attrs(0), Alignment(0), StackAlignment(0), DerefBytes(0),
1226       DerefOrNullBytes(0), AllocSizeArgs(0) {
1227   AttributeSetImpl *pImpl = AS.pImpl;
1228   if (!pImpl) return;
1229 
1230   for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I) {
1231     if (pImpl->getSlotIndex(I) != Index) continue;
1232 
1233     for (AttributeSetImpl::iterator II = pImpl->begin(I),
1234            IE = pImpl->end(I); II != IE; ++II)
1235       addAttribute(*II);
1236 
1237     break;
1238   }
1239 }
1240 
1241 void AttrBuilder::clear() {
1242   Attrs.reset();
1243   TargetDepAttrs.clear();
1244   Alignment = StackAlignment = DerefBytes = DerefOrNullBytes = 0;
1245   AllocSizeArgs = 0;
1246 }
1247 
1248 AttrBuilder &AttrBuilder::addAttribute(Attribute::AttrKind Val) {
1249   assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1250   assert(Val != Attribute::Alignment && Val != Attribute::StackAlignment &&
1251          Val != Attribute::Dereferenceable && Val != Attribute::AllocSize &&
1252          "Adding integer attribute without adding a value!");
1253   Attrs[Val] = true;
1254   return *this;
1255 }
1256 
1257 AttrBuilder &AttrBuilder::addAttribute(Attribute Attr) {
1258   if (Attr.isStringAttribute()) {
1259     addAttribute(Attr.getKindAsString(), Attr.getValueAsString());
1260     return *this;
1261   }
1262 
1263   Attribute::AttrKind Kind = Attr.getKindAsEnum();
1264   Attrs[Kind] = true;
1265 
1266   if (Kind == Attribute::Alignment)
1267     Alignment = Attr.getAlignment();
1268   else if (Kind == Attribute::StackAlignment)
1269     StackAlignment = Attr.getStackAlignment();
1270   else if (Kind == Attribute::Dereferenceable)
1271     DerefBytes = Attr.getDereferenceableBytes();
1272   else if (Kind == Attribute::DereferenceableOrNull)
1273     DerefOrNullBytes = Attr.getDereferenceableOrNullBytes();
1274   else if (Kind == Attribute::AllocSize)
1275     AllocSizeArgs = Attr.getValueAsInt();
1276   return *this;
1277 }
1278 
1279 AttrBuilder &AttrBuilder::addAttribute(StringRef A, StringRef V) {
1280   TargetDepAttrs[A] = V;
1281   return *this;
1282 }
1283 
1284 AttrBuilder &AttrBuilder::removeAttribute(Attribute::AttrKind Val) {
1285   assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1286   Attrs[Val] = false;
1287 
1288   if (Val == Attribute::Alignment)
1289     Alignment = 0;
1290   else if (Val == Attribute::StackAlignment)
1291     StackAlignment = 0;
1292   else if (Val == Attribute::Dereferenceable)
1293     DerefBytes = 0;
1294   else if (Val == Attribute::DereferenceableOrNull)
1295     DerefOrNullBytes = 0;
1296   else if (Val == Attribute::AllocSize)
1297     AllocSizeArgs = 0;
1298 
1299   return *this;
1300 }
1301 
1302 AttrBuilder &AttrBuilder::removeAttributes(AttributeSet A, uint64_t Index) {
1303   unsigned Slot = ~0U;
1304   for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1305     if (A.getSlotIndex(I) == Index) {
1306       Slot = I;
1307       break;
1308     }
1309 
1310   assert(Slot != ~0U && "Couldn't find index in AttributeSet!");
1311 
1312   for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot); I != E; ++I) {
1313     Attribute Attr = *I;
1314     if (Attr.isEnumAttribute() || Attr.isIntAttribute()) {
1315       removeAttribute(Attr.getKindAsEnum());
1316     } else {
1317       assert(Attr.isStringAttribute() && "Invalid attribute type!");
1318       removeAttribute(Attr.getKindAsString());
1319     }
1320   }
1321 
1322   return *this;
1323 }
1324 
1325 AttrBuilder &AttrBuilder::removeAttribute(StringRef A) {
1326   std::map<std::string, std::string>::iterator I = TargetDepAttrs.find(A);
1327   if (I != TargetDepAttrs.end())
1328     TargetDepAttrs.erase(I);
1329   return *this;
1330 }
1331 
1332 std::pair<unsigned, Optional<unsigned>> AttrBuilder::getAllocSizeArgs() const {
1333   return unpackAllocSizeArgs(AllocSizeArgs);
1334 }
1335 
1336 AttrBuilder &AttrBuilder::addAlignmentAttr(unsigned Align) {
1337   if (Align == 0) return *this;
1338 
1339   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1340   assert(Align <= 0x40000000 && "Alignment too large.");
1341 
1342   Attrs[Attribute::Alignment] = true;
1343   Alignment = Align;
1344   return *this;
1345 }
1346 
1347 AttrBuilder &AttrBuilder::addStackAlignmentAttr(unsigned Align) {
1348   // Default alignment, allow the target to define how to align it.
1349   if (Align == 0) return *this;
1350 
1351   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1352   assert(Align <= 0x100 && "Alignment too large.");
1353 
1354   Attrs[Attribute::StackAlignment] = true;
1355   StackAlignment = Align;
1356   return *this;
1357 }
1358 
1359 AttrBuilder &AttrBuilder::addDereferenceableAttr(uint64_t Bytes) {
1360   if (Bytes == 0) return *this;
1361 
1362   Attrs[Attribute::Dereferenceable] = true;
1363   DerefBytes = Bytes;
1364   return *this;
1365 }
1366 
1367 AttrBuilder &AttrBuilder::addDereferenceableOrNullAttr(uint64_t Bytes) {
1368   if (Bytes == 0)
1369     return *this;
1370 
1371   Attrs[Attribute::DereferenceableOrNull] = true;
1372   DerefOrNullBytes = Bytes;
1373   return *this;
1374 }
1375 
1376 AttrBuilder &AttrBuilder::addAllocSizeAttr(unsigned ElemSize,
1377                                            const Optional<unsigned> &NumElems) {
1378   return addAllocSizeAttrFromRawRepr(packAllocSizeArgs(ElemSize, NumElems));
1379 }
1380 
1381 AttrBuilder &AttrBuilder::addAllocSizeAttrFromRawRepr(uint64_t RawArgs) {
1382   // (0, 0) is our "not present" value, so we need to check for it here.
1383   assert(RawArgs && "Invalid allocsize arguments -- given allocsize(0, 0)");
1384 
1385   Attrs[Attribute::AllocSize] = true;
1386   // Reuse existing machinery to store this as a single 64-bit integer so we can
1387   // save a few bytes over using a pair<unsigned, Optional<unsigned>>.
1388   AllocSizeArgs = RawArgs;
1389   return *this;
1390 }
1391 
1392 AttrBuilder &AttrBuilder::merge(const AttrBuilder &B) {
1393   // FIXME: What if both have alignments, but they don't match?!
1394   if (!Alignment)
1395     Alignment = B.Alignment;
1396 
1397   if (!StackAlignment)
1398     StackAlignment = B.StackAlignment;
1399 
1400   if (!DerefBytes)
1401     DerefBytes = B.DerefBytes;
1402 
1403   if (!DerefOrNullBytes)
1404     DerefOrNullBytes = B.DerefOrNullBytes;
1405 
1406   if (!AllocSizeArgs)
1407     AllocSizeArgs = B.AllocSizeArgs;
1408 
1409   Attrs |= B.Attrs;
1410 
1411   for (auto I : B.td_attrs())
1412     TargetDepAttrs[I.first] = I.second;
1413 
1414   return *this;
1415 }
1416 
1417 AttrBuilder &AttrBuilder::remove(const AttrBuilder &B) {
1418   // FIXME: What if both have alignments, but they don't match?!
1419   if (B.Alignment)
1420     Alignment = 0;
1421 
1422   if (B.StackAlignment)
1423     StackAlignment = 0;
1424 
1425   if (B.DerefBytes)
1426     DerefBytes = 0;
1427 
1428   if (B.DerefOrNullBytes)
1429     DerefOrNullBytes = 0;
1430 
1431   if (B.AllocSizeArgs)
1432     AllocSizeArgs = 0;
1433 
1434   Attrs &= ~B.Attrs;
1435 
1436   for (auto I : B.td_attrs())
1437     TargetDepAttrs.erase(I.first);
1438 
1439   return *this;
1440 }
1441 
1442 bool AttrBuilder::overlaps(const AttrBuilder &B) const {
1443   // First check if any of the target independent attributes overlap.
1444   if ((Attrs & B.Attrs).any())
1445     return true;
1446 
1447   // Then check if any target dependent ones do.
1448   for (auto I : td_attrs())
1449     if (B.contains(I.first))
1450       return true;
1451 
1452   return false;
1453 }
1454 
1455 bool AttrBuilder::contains(StringRef A) const {
1456   return TargetDepAttrs.find(A) != TargetDepAttrs.end();
1457 }
1458 
1459 bool AttrBuilder::hasAttributes() const {
1460   return !Attrs.none() || !TargetDepAttrs.empty();
1461 }
1462 
1463 bool AttrBuilder::hasAttributes(AttributeSet A, uint64_t Index) const {
1464   unsigned Slot = ~0U;
1465   for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1466     if (A.getSlotIndex(I) == Index) {
1467       Slot = I;
1468       break;
1469     }
1470 
1471   assert(Slot != ~0U && "Couldn't find the index!");
1472 
1473   for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot); I != E; ++I) {
1474     Attribute Attr = *I;
1475     if (Attr.isEnumAttribute() || Attr.isIntAttribute()) {
1476       if (Attrs[I->getKindAsEnum()])
1477         return true;
1478     } else {
1479       assert(Attr.isStringAttribute() && "Invalid attribute kind!");
1480       return TargetDepAttrs.find(Attr.getKindAsString())!=TargetDepAttrs.end();
1481     }
1482   }
1483 
1484   return false;
1485 }
1486 
1487 bool AttrBuilder::hasAlignmentAttr() const {
1488   return Alignment != 0;
1489 }
1490 
1491 bool AttrBuilder::operator==(const AttrBuilder &B) {
1492   if (Attrs != B.Attrs)
1493     return false;
1494 
1495   for (td_const_iterator I = TargetDepAttrs.begin(),
1496          E = TargetDepAttrs.end(); I != E; ++I)
1497     if (B.TargetDepAttrs.find(I->first) == B.TargetDepAttrs.end())
1498       return false;
1499 
1500   return Alignment == B.Alignment && StackAlignment == B.StackAlignment &&
1501          DerefBytes == B.DerefBytes;
1502 }
1503 
1504 AttrBuilder &AttrBuilder::addRawValue(uint64_t Val) {
1505   // FIXME: Remove this in 4.0.
1506   if (!Val) return *this;
1507 
1508   for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1509        I = Attribute::AttrKind(I + 1)) {
1510     if (I == Attribute::Dereferenceable ||
1511         I == Attribute::DereferenceableOrNull ||
1512         I == Attribute::ArgMemOnly ||
1513         I == Attribute::AllocSize)
1514       continue;
1515     if (uint64_t A = (Val & AttributeImpl::getAttrMask(I))) {
1516       Attrs[I] = true;
1517 
1518       if (I == Attribute::Alignment)
1519         Alignment = 1ULL << ((A >> 16) - 1);
1520       else if (I == Attribute::StackAlignment)
1521         StackAlignment = 1ULL << ((A >> 26)-1);
1522     }
1523   }
1524 
1525   return *this;
1526 }
1527 
1528 //===----------------------------------------------------------------------===//
1529 // AttributeFuncs Function Defintions
1530 //===----------------------------------------------------------------------===//
1531 
1532 /// \brief Which attributes cannot be applied to a type.
1533 AttrBuilder AttributeFuncs::typeIncompatible(Type *Ty) {
1534   AttrBuilder Incompatible;
1535 
1536   if (!Ty->isIntegerTy())
1537     // Attribute that only apply to integers.
1538     Incompatible.addAttribute(Attribute::SExt)
1539       .addAttribute(Attribute::ZExt);
1540 
1541   if (!Ty->isPointerTy())
1542     // Attribute that only apply to pointers.
1543     Incompatible.addAttribute(Attribute::ByVal)
1544       .addAttribute(Attribute::Nest)
1545       .addAttribute(Attribute::NoAlias)
1546       .addAttribute(Attribute::NoCapture)
1547       .addAttribute(Attribute::NonNull)
1548       .addDereferenceableAttr(1) // the int here is ignored
1549       .addDereferenceableOrNullAttr(1) // the int here is ignored
1550       .addAttribute(Attribute::ReadNone)
1551       .addAttribute(Attribute::ReadOnly)
1552       .addAttribute(Attribute::StructRet)
1553       .addAttribute(Attribute::InAlloca);
1554 
1555   return Incompatible;
1556 }
1557 
1558 template<typename AttrClass>
1559 static bool isEqual(const Function &Caller, const Function &Callee) {
1560   return Caller.getFnAttribute(AttrClass::getKind()) ==
1561          Callee.getFnAttribute(AttrClass::getKind());
1562 }
1563 
1564 /// \brief Compute the logical AND of the attributes of the caller and the
1565 /// callee.
1566 ///
1567 /// This function sets the caller's attribute to false if the callee's attribute
1568 /// is false.
1569 template<typename AttrClass>
1570 static void setAND(Function &Caller, const Function &Callee) {
1571   if (AttrClass::isSet(Caller, AttrClass::getKind()) &&
1572       !AttrClass::isSet(Callee, AttrClass::getKind()))
1573     AttrClass::set(Caller, AttrClass::getKind(), false);
1574 }
1575 
1576 /// \brief Compute the logical OR of the attributes of the caller and the
1577 /// callee.
1578 ///
1579 /// This function sets the caller's attribute to true if the callee's attribute
1580 /// is true.
1581 template<typename AttrClass>
1582 static void setOR(Function &Caller, const Function &Callee) {
1583   if (!AttrClass::isSet(Caller, AttrClass::getKind()) &&
1584       AttrClass::isSet(Callee, AttrClass::getKind()))
1585     AttrClass::set(Caller, AttrClass::getKind(), true);
1586 }
1587 
1588 /// \brief If the inlined function had a higher stack protection level than the
1589 /// calling function, then bump up the caller's stack protection level.
1590 static void adjustCallerSSPLevel(Function &Caller, const Function &Callee) {
1591   // If upgrading the SSP attribute, clear out the old SSP Attributes first.
1592   // Having multiple SSP attributes doesn't actually hurt, but it adds useless
1593   // clutter to the IR.
1594   AttrBuilder B;
1595   B.addAttribute(Attribute::StackProtect)
1596     .addAttribute(Attribute::StackProtectStrong)
1597     .addAttribute(Attribute::StackProtectReq);
1598   AttributeSet OldSSPAttr = AttributeSet::get(Caller.getContext(),
1599                                               AttributeSet::FunctionIndex,
1600                                               B);
1601 
1602   if (Callee.hasFnAttribute(Attribute::StackProtectReq)) {
1603     Caller.removeAttributes(AttributeSet::FunctionIndex, OldSSPAttr);
1604     Caller.addFnAttr(Attribute::StackProtectReq);
1605   } else if (Callee.hasFnAttribute(Attribute::StackProtectStrong) &&
1606              !Caller.hasFnAttribute(Attribute::StackProtectReq)) {
1607     Caller.removeAttributes(AttributeSet::FunctionIndex, OldSSPAttr);
1608     Caller.addFnAttr(Attribute::StackProtectStrong);
1609   } else if (Callee.hasFnAttribute(Attribute::StackProtect) &&
1610              !Caller.hasFnAttribute(Attribute::StackProtectReq) &&
1611              !Caller.hasFnAttribute(Attribute::StackProtectStrong))
1612     Caller.addFnAttr(Attribute::StackProtect);
1613 }
1614 
1615 #define GET_ATTR_COMPAT_FUNC
1616 #include "AttributesCompatFunc.inc"
1617 
1618 bool AttributeFuncs::areInlineCompatible(const Function &Caller,
1619                                          const Function &Callee) {
1620   return hasCompatibleFnAttrs(Caller, Callee);
1621 }
1622 
1623 
1624 void AttributeFuncs::mergeAttributesForInlining(Function &Caller,
1625                                                 const Function &Callee) {
1626   mergeFnAttrs(Caller, Callee);
1627 }
1628