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