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