1 //===-- Attributes.cpp - Implement AttributesList -------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 // \brief This file implements the Attribute, AttributeImpl, AttrBuilder,
12 // AttributeSetImpl, and AttributeSet classes.
14 //===----------------------------------------------------------------------===//
16 #include "llvm/IR/Attributes.h"
17 #include "AttributeImpl.h"
18 #include "LLVMContextImpl.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/IR/Type.h"
22 #include "llvm/Support/Atomic.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/ManagedStatic.h"
25 #include "llvm/Support/Mutex.h"
26 #include "llvm/Support/raw_ostream.h"
30 //===----------------------------------------------------------------------===//
31 // Attribute Construction Methods
32 //===----------------------------------------------------------------------===//
34 Attribute Attribute::get(LLVMContext &Context, Attribute::AttrKind Kind,
36 LLVMContextImpl *pImpl = Context.pImpl;
39 if (Val) ID.AddInteger(Val);
42 AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
45 // If we didn't find any existing attributes of the same shape then create a
46 // new one and insert it.
48 PA = new EnumAttributeImpl(Kind);
50 PA = new IntAttributeImpl(Kind, Val);
51 pImpl->AttrsSet.InsertNode(PA, InsertPoint);
54 // Return the Attribute that we found or created.
58 Attribute Attribute::get(LLVMContext &Context, StringRef Kind, StringRef Val) {
59 LLVMContextImpl *pImpl = Context.pImpl;
62 if (!Val.empty()) ID.AddString(Val);
65 AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
68 // If we didn't find any existing attributes of the same shape then create a
69 // new one and insert it.
70 PA = new StringAttributeImpl(Kind, Val);
71 pImpl->AttrsSet.InsertNode(PA, InsertPoint);
74 // Return the Attribute that we found or created.
78 Attribute Attribute::getWithAlignment(LLVMContext &Context, uint64_t Align) {
79 assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
80 assert(Align <= 0x40000000 && "Alignment too large.");
81 return get(Context, Alignment, Align);
84 Attribute Attribute::getWithStackAlignment(LLVMContext &Context,
86 assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
87 assert(Align <= 0x100 && "Alignment too large.");
88 return get(Context, StackAlignment, Align);
91 Attribute Attribute::getWithDereferenceableBytes(LLVMContext &Context,
93 assert(Bytes && "Bytes must be non-zero.");
94 return get(Context, Dereferenceable, Bytes);
97 Attribute Attribute::getWithDereferenceableOrNullBytes(LLVMContext &Context,
99 assert(Bytes && "Bytes must be non-zero.");
100 return get(Context, DereferenceableOrNull, Bytes);
103 //===----------------------------------------------------------------------===//
104 // Attribute Accessor Methods
105 //===----------------------------------------------------------------------===//
107 bool Attribute::isEnumAttribute() const {
108 return pImpl && pImpl->isEnumAttribute();
111 bool Attribute::isIntAttribute() const {
112 return pImpl && pImpl->isIntAttribute();
115 bool Attribute::isStringAttribute() const {
116 return pImpl && pImpl->isStringAttribute();
119 Attribute::AttrKind Attribute::getKindAsEnum() const {
120 if (!pImpl) return None;
121 assert((isEnumAttribute() || isIntAttribute()) &&
122 "Invalid attribute type to get the kind as an enum!");
123 return pImpl ? pImpl->getKindAsEnum() : None;
126 uint64_t Attribute::getValueAsInt() const {
127 if (!pImpl) return 0;
128 assert(isIntAttribute() &&
129 "Expected the attribute to be an integer attribute!");
130 return pImpl ? pImpl->getValueAsInt() : 0;
133 StringRef Attribute::getKindAsString() const {
134 if (!pImpl) return StringRef();
135 assert(isStringAttribute() &&
136 "Invalid attribute type to get the kind as a string!");
137 return pImpl ? pImpl->getKindAsString() : StringRef();
140 StringRef Attribute::getValueAsString() const {
141 if (!pImpl) return StringRef();
142 assert(isStringAttribute() &&
143 "Invalid attribute type to get the value as a string!");
144 return pImpl ? pImpl->getValueAsString() : StringRef();
147 bool Attribute::hasAttribute(AttrKind Kind) const {
148 return (pImpl && pImpl->hasAttribute(Kind)) || (!pImpl && Kind == None);
151 bool Attribute::hasAttribute(StringRef Kind) const {
152 if (!isStringAttribute()) return false;
153 return pImpl && pImpl->hasAttribute(Kind);
156 /// This returns the alignment field of an attribute as a byte alignment value.
157 unsigned Attribute::getAlignment() const {
158 assert(hasAttribute(Attribute::Alignment) &&
159 "Trying to get alignment from non-alignment attribute!");
160 return pImpl->getValueAsInt();
163 /// This returns the stack alignment field of an attribute as a byte alignment
165 unsigned Attribute::getStackAlignment() const {
166 assert(hasAttribute(Attribute::StackAlignment) &&
167 "Trying to get alignment from non-alignment attribute!");
168 return pImpl->getValueAsInt();
171 /// This returns the number of dereferenceable bytes.
172 uint64_t Attribute::getDereferenceableBytes() const {
173 assert(hasAttribute(Attribute::Dereferenceable) &&
174 "Trying to get dereferenceable bytes from "
175 "non-dereferenceable attribute!");
176 return pImpl->getValueAsInt();
179 uint64_t Attribute::getDereferenceableOrNullBytes() const {
180 assert(hasAttribute(Attribute::DereferenceableOrNull) &&
181 "Trying to get dereferenceable bytes from "
182 "non-dereferenceable attribute!");
183 return pImpl->getValueAsInt();
186 std::string Attribute::getAsString(bool InAttrGrp) const {
187 if (!pImpl) return "";
189 if (hasAttribute(Attribute::SanitizeAddress))
190 return "sanitize_address";
191 if (hasAttribute(Attribute::AlwaysInline))
192 return "alwaysinline";
193 if (hasAttribute(Attribute::ArgMemOnly))
195 if (hasAttribute(Attribute::Builtin))
197 if (hasAttribute(Attribute::ByVal))
199 if (hasAttribute(Attribute::Convergent))
201 if (hasAttribute(Attribute::InAlloca))
203 if (hasAttribute(Attribute::InlineHint))
205 if (hasAttribute(Attribute::InReg))
207 if (hasAttribute(Attribute::JumpTable))
209 if (hasAttribute(Attribute::MinSize))
211 if (hasAttribute(Attribute::Naked))
213 if (hasAttribute(Attribute::Nest))
215 if (hasAttribute(Attribute::NoAlias))
217 if (hasAttribute(Attribute::NoBuiltin))
219 if (hasAttribute(Attribute::NoCapture))
221 if (hasAttribute(Attribute::NoDuplicate))
222 return "noduplicate";
223 if (hasAttribute(Attribute::NoImplicitFloat))
224 return "noimplicitfloat";
225 if (hasAttribute(Attribute::NoInline))
227 if (hasAttribute(Attribute::NonLazyBind))
228 return "nonlazybind";
229 if (hasAttribute(Attribute::NonNull))
231 if (hasAttribute(Attribute::NoRedZone))
233 if (hasAttribute(Attribute::NoReturn))
235 if (hasAttribute(Attribute::NoUnwind))
237 if (hasAttribute(Attribute::OptimizeNone))
239 if (hasAttribute(Attribute::OptimizeForSize))
241 if (hasAttribute(Attribute::ReadNone))
243 if (hasAttribute(Attribute::ReadOnly))
245 if (hasAttribute(Attribute::Returned))
247 if (hasAttribute(Attribute::ReturnsTwice))
248 return "returns_twice";
249 if (hasAttribute(Attribute::SExt))
251 if (hasAttribute(Attribute::StackProtect))
253 if (hasAttribute(Attribute::StackProtectReq))
255 if (hasAttribute(Attribute::StackProtectStrong))
257 if (hasAttribute(Attribute::SafeStack))
259 if (hasAttribute(Attribute::StructRet))
261 if (hasAttribute(Attribute::SanitizeThread))
262 return "sanitize_thread";
263 if (hasAttribute(Attribute::SanitizeMemory))
264 return "sanitize_memory";
265 if (hasAttribute(Attribute::UWTable))
267 if (hasAttribute(Attribute::ZExt))
269 if (hasAttribute(Attribute::Cold))
272 // FIXME: These should be output like this:
277 if (hasAttribute(Attribute::Alignment)) {
280 Result += (InAttrGrp) ? "=" : " ";
281 Result += utostr(getValueAsInt());
285 auto AttrWithBytesToString = [&](const char *Name) {
290 Result += utostr(getValueAsInt());
293 Result += utostr(getValueAsInt());
299 if (hasAttribute(Attribute::StackAlignment))
300 return AttrWithBytesToString("alignstack");
302 if (hasAttribute(Attribute::Dereferenceable))
303 return AttrWithBytesToString("dereferenceable");
305 if (hasAttribute(Attribute::DereferenceableOrNull))
306 return AttrWithBytesToString("dereferenceable_or_null");
308 // Convert target-dependent attributes to strings of the form:
313 if (isStringAttribute()) {
315 Result += (Twine('"') + getKindAsString() + Twine('"')).str();
317 StringRef Val = pImpl->getValueAsString();
318 if (Val.empty()) return Result;
320 Result += ("=\"" + Val + Twine('"')).str();
324 llvm_unreachable("Unknown attribute");
327 bool Attribute::operator<(Attribute A) const {
328 if (!pImpl && !A.pImpl) return false;
329 if (!pImpl) return true;
330 if (!A.pImpl) return false;
331 return *pImpl < *A.pImpl;
334 //===----------------------------------------------------------------------===//
335 // AttributeImpl Definition
336 //===----------------------------------------------------------------------===//
338 // Pin the vtables to this file.
339 AttributeImpl::~AttributeImpl() {}
340 void EnumAttributeImpl::anchor() {}
341 void IntAttributeImpl::anchor() {}
342 void StringAttributeImpl::anchor() {}
344 bool AttributeImpl::hasAttribute(Attribute::AttrKind A) const {
345 if (isStringAttribute()) return false;
346 return getKindAsEnum() == A;
349 bool AttributeImpl::hasAttribute(StringRef Kind) const {
350 if (!isStringAttribute()) return false;
351 return getKindAsString() == Kind;
354 Attribute::AttrKind AttributeImpl::getKindAsEnum() const {
355 assert(isEnumAttribute() || isIntAttribute());
356 return static_cast<const EnumAttributeImpl *>(this)->getEnumKind();
359 uint64_t AttributeImpl::getValueAsInt() const {
360 assert(isIntAttribute());
361 return static_cast<const IntAttributeImpl *>(this)->getValue();
364 StringRef AttributeImpl::getKindAsString() const {
365 assert(isStringAttribute());
366 return static_cast<const StringAttributeImpl *>(this)->getStringKind();
369 StringRef AttributeImpl::getValueAsString() const {
370 assert(isStringAttribute());
371 return static_cast<const StringAttributeImpl *>(this)->getStringValue();
374 bool AttributeImpl::operator<(const AttributeImpl &AI) const {
375 // This sorts the attributes with Attribute::AttrKinds coming first (sorted
376 // relative to their enum value) and then strings.
377 if (isEnumAttribute()) {
378 if (AI.isEnumAttribute()) return getKindAsEnum() < AI.getKindAsEnum();
379 if (AI.isIntAttribute()) return true;
380 if (AI.isStringAttribute()) return true;
383 if (isIntAttribute()) {
384 if (AI.isEnumAttribute()) return false;
385 if (AI.isIntAttribute()) return getValueAsInt() < AI.getValueAsInt();
386 if (AI.isStringAttribute()) return true;
389 if (AI.isEnumAttribute()) return false;
390 if (AI.isIntAttribute()) return false;
391 if (getKindAsString() == AI.getKindAsString())
392 return getValueAsString() < AI.getValueAsString();
393 return getKindAsString() < AI.getKindAsString();
396 uint64_t AttributeImpl::getAttrMask(Attribute::AttrKind Val) {
397 // FIXME: Remove this.
399 case Attribute::EndAttrKinds:
400 llvm_unreachable("Synthetic enumerators which should never get here");
402 case Attribute::None: return 0;
403 case Attribute::ZExt: return 1 << 0;
404 case Attribute::SExt: return 1 << 1;
405 case Attribute::NoReturn: return 1 << 2;
406 case Attribute::InReg: return 1 << 3;
407 case Attribute::StructRet: return 1 << 4;
408 case Attribute::NoUnwind: return 1 << 5;
409 case Attribute::NoAlias: return 1 << 6;
410 case Attribute::ByVal: return 1 << 7;
411 case Attribute::Nest: return 1 << 8;
412 case Attribute::ReadNone: return 1 << 9;
413 case Attribute::ReadOnly: return 1 << 10;
414 case Attribute::NoInline: return 1 << 11;
415 case Attribute::AlwaysInline: return 1 << 12;
416 case Attribute::OptimizeForSize: return 1 << 13;
417 case Attribute::StackProtect: return 1 << 14;
418 case Attribute::StackProtectReq: return 1 << 15;
419 case Attribute::Alignment: return 31 << 16;
420 case Attribute::NoCapture: return 1 << 21;
421 case Attribute::NoRedZone: return 1 << 22;
422 case Attribute::NoImplicitFloat: return 1 << 23;
423 case Attribute::Naked: return 1 << 24;
424 case Attribute::InlineHint: return 1 << 25;
425 case Attribute::StackAlignment: return 7 << 26;
426 case Attribute::ReturnsTwice: return 1 << 29;
427 case Attribute::UWTable: return 1 << 30;
428 case Attribute::NonLazyBind: return 1U << 31;
429 case Attribute::SanitizeAddress: return 1ULL << 32;
430 case Attribute::MinSize: return 1ULL << 33;
431 case Attribute::NoDuplicate: return 1ULL << 34;
432 case Attribute::StackProtectStrong: return 1ULL << 35;
433 case Attribute::SanitizeThread: return 1ULL << 36;
434 case Attribute::SanitizeMemory: return 1ULL << 37;
435 case Attribute::NoBuiltin: return 1ULL << 38;
436 case Attribute::Returned: return 1ULL << 39;
437 case Attribute::Cold: return 1ULL << 40;
438 case Attribute::Builtin: return 1ULL << 41;
439 case Attribute::OptimizeNone: return 1ULL << 42;
440 case Attribute::InAlloca: return 1ULL << 43;
441 case Attribute::NonNull: return 1ULL << 44;
442 case Attribute::JumpTable: return 1ULL << 45;
443 case Attribute::Convergent: return 1ULL << 46;
444 case Attribute::SafeStack: return 1ULL << 47;
445 case Attribute::Dereferenceable:
446 llvm_unreachable("dereferenceable attribute not supported in raw format");
448 case Attribute::DereferenceableOrNull:
449 llvm_unreachable("dereferenceable_or_null attribute not supported in raw "
452 case Attribute::ArgMemOnly:
453 llvm_unreachable("argmemonly attribute not supported in raw format");
456 llvm_unreachable("Unsupported attribute type");
459 //===----------------------------------------------------------------------===//
460 // AttributeSetNode Definition
461 //===----------------------------------------------------------------------===//
463 AttributeSetNode *AttributeSetNode::get(LLVMContext &C,
464 ArrayRef<Attribute> Attrs) {
468 // Otherwise, build a key to look up the existing attributes.
469 LLVMContextImpl *pImpl = C.pImpl;
472 SmallVector<Attribute, 8> SortedAttrs(Attrs.begin(), Attrs.end());
473 array_pod_sort(SortedAttrs.begin(), SortedAttrs.end());
475 for (SmallVectorImpl<Attribute>::iterator I = SortedAttrs.begin(),
476 E = SortedAttrs.end(); I != E; ++I)
480 AttributeSetNode *PA =
481 pImpl->AttrsSetNodes.FindNodeOrInsertPos(ID, InsertPoint);
483 // If we didn't find any existing attributes of the same shape then create a
484 // new one and insert it.
486 // Coallocate entries after the AttributeSetNode itself.
487 void *Mem = ::operator new(totalSizeToAlloc<Attribute>(SortedAttrs.size()));
488 PA = new (Mem) AttributeSetNode(SortedAttrs);
489 pImpl->AttrsSetNodes.InsertNode(PA, InsertPoint);
492 // Return the AttributesListNode that we found or created.
496 bool AttributeSetNode::hasAttribute(Attribute::AttrKind Kind) const {
497 for (iterator I = begin(), E = end(); I != E; ++I)
498 if (I->hasAttribute(Kind))
503 bool AttributeSetNode::hasAttribute(StringRef Kind) const {
504 for (iterator I = begin(), E = end(); I != E; ++I)
505 if (I->hasAttribute(Kind))
510 Attribute AttributeSetNode::getAttribute(Attribute::AttrKind Kind) const {
511 for (iterator I = begin(), E = end(); I != E; ++I)
512 if (I->hasAttribute(Kind))
517 Attribute AttributeSetNode::getAttribute(StringRef Kind) const {
518 for (iterator I = begin(), E = end(); I != E; ++I)
519 if (I->hasAttribute(Kind))
524 unsigned AttributeSetNode::getAlignment() const {
525 for (iterator I = begin(), E = end(); I != E; ++I)
526 if (I->hasAttribute(Attribute::Alignment))
527 return I->getAlignment();
531 unsigned AttributeSetNode::getStackAlignment() const {
532 for (iterator I = begin(), E = end(); I != E; ++I)
533 if (I->hasAttribute(Attribute::StackAlignment))
534 return I->getStackAlignment();
538 uint64_t AttributeSetNode::getDereferenceableBytes() const {
539 for (iterator I = begin(), E = end(); I != E; ++I)
540 if (I->hasAttribute(Attribute::Dereferenceable))
541 return I->getDereferenceableBytes();
545 uint64_t AttributeSetNode::getDereferenceableOrNullBytes() const {
546 for (iterator I = begin(), E = end(); I != E; ++I)
547 if (I->hasAttribute(Attribute::DereferenceableOrNull))
548 return I->getDereferenceableOrNullBytes();
552 std::string AttributeSetNode::getAsString(bool InAttrGrp) const {
554 for (iterator I = begin(), E = end(); I != E; ++I) {
557 Str += I->getAsString(InAttrGrp);
562 //===----------------------------------------------------------------------===//
563 // AttributeSetImpl Definition
564 //===----------------------------------------------------------------------===//
566 uint64_t AttributeSetImpl::Raw(unsigned Index) const {
567 for (unsigned I = 0, E = getNumAttributes(); I != E; ++I) {
568 if (getSlotIndex(I) != Index) continue;
569 const AttributeSetNode *ASN = getSlotNode(I);
572 for (AttributeSetNode::iterator II = ASN->begin(),
573 IE = ASN->end(); II != IE; ++II) {
574 Attribute Attr = *II;
576 // This cannot handle string attributes.
577 if (Attr.isStringAttribute()) continue;
579 Attribute::AttrKind Kind = Attr.getKindAsEnum();
581 if (Kind == Attribute::Alignment)
582 Mask |= (Log2_32(ASN->getAlignment()) + 1) << 16;
583 else if (Kind == Attribute::StackAlignment)
584 Mask |= (Log2_32(ASN->getStackAlignment()) + 1) << 26;
585 else if (Kind == Attribute::Dereferenceable)
586 llvm_unreachable("dereferenceable not supported in bit mask");
588 Mask |= AttributeImpl::getAttrMask(Kind);
597 void AttributeSetImpl::dump() const {
598 AttributeSet(const_cast<AttributeSetImpl *>(this)).dump();
601 //===----------------------------------------------------------------------===//
602 // AttributeSet Construction and Mutation Methods
603 //===----------------------------------------------------------------------===//
606 AttributeSet::getImpl(LLVMContext &C,
607 ArrayRef<std::pair<unsigned, AttributeSetNode*> > Attrs) {
608 LLVMContextImpl *pImpl = C.pImpl;
610 AttributeSetImpl::Profile(ID, Attrs);
613 AttributeSetImpl *PA = pImpl->AttrsLists.FindNodeOrInsertPos(ID, InsertPoint);
615 // If we didn't find any existing attributes of the same shape then
616 // create a new one and insert it.
618 // Coallocate entries after the AttributeSetImpl itself.
619 void *Mem = ::operator new(
620 AttributeSetImpl::totalSizeToAlloc<IndexAttrPair>(Attrs.size()));
621 PA = new (Mem) AttributeSetImpl(C, Attrs);
622 pImpl->AttrsLists.InsertNode(PA, InsertPoint);
625 // Return the AttributesList that we found or created.
626 return AttributeSet(PA);
629 AttributeSet AttributeSet::get(LLVMContext &C,
630 ArrayRef<std::pair<unsigned, Attribute> > Attrs){
631 // If there are no attributes then return a null AttributesList pointer.
633 return AttributeSet();
636 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
637 assert((!i || Attrs[i-1].first <= Attrs[i].first) &&
638 "Misordered Attributes list!");
639 assert(!Attrs[i].second.hasAttribute(Attribute::None) &&
640 "Pointless attribute!");
644 // Create a vector if (unsigned, AttributeSetNode*) pairs from the attributes
646 SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrPairVec;
647 for (ArrayRef<std::pair<unsigned, Attribute> >::iterator I = Attrs.begin(),
648 E = Attrs.end(); I != E; ) {
649 unsigned Index = I->first;
650 SmallVector<Attribute, 4> AttrVec;
651 while (I != E && I->first == Index) {
652 AttrVec.push_back(I->second);
656 AttrPairVec.push_back(std::make_pair(Index,
657 AttributeSetNode::get(C, AttrVec)));
660 return getImpl(C, AttrPairVec);
663 AttributeSet AttributeSet::get(LLVMContext &C,
664 ArrayRef<std::pair<unsigned,
665 AttributeSetNode*> > Attrs) {
666 // If there are no attributes then return a null AttributesList pointer.
668 return AttributeSet();
670 return getImpl(C, Attrs);
673 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
674 const AttrBuilder &B) {
675 if (!B.hasAttributes())
676 return AttributeSet();
678 // Add target-independent attributes.
679 SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
680 for (Attribute::AttrKind Kind = Attribute::None;
681 Kind != Attribute::EndAttrKinds; Kind = Attribute::AttrKind(Kind + 1)) {
682 if (!B.contains(Kind))
685 if (Kind == Attribute::Alignment)
686 Attrs.push_back(std::make_pair(Index, Attribute::
687 getWithAlignment(C, B.getAlignment())));
688 else if (Kind == Attribute::StackAlignment)
689 Attrs.push_back(std::make_pair(Index, Attribute::
690 getWithStackAlignment(C, B.getStackAlignment())));
691 else if (Kind == Attribute::Dereferenceable)
692 Attrs.push_back(std::make_pair(Index,
693 Attribute::getWithDereferenceableBytes(C,
694 B.getDereferenceableBytes())));
695 else if (Kind == Attribute::DereferenceableOrNull)
697 std::make_pair(Index, Attribute::getWithDereferenceableOrNullBytes(
698 C, B.getDereferenceableOrNullBytes())));
700 Attrs.push_back(std::make_pair(Index, Attribute::get(C, Kind)));
703 // Add target-dependent (string) attributes.
704 for (const AttrBuilder::td_type &TDA : B.td_attrs())
706 std::make_pair(Index, Attribute::get(C, TDA.first, TDA.second)));
708 return get(C, Attrs);
711 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
712 ArrayRef<Attribute::AttrKind> Kind) {
713 SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
714 for (ArrayRef<Attribute::AttrKind>::iterator I = Kind.begin(),
715 E = Kind.end(); I != E; ++I)
716 Attrs.push_back(std::make_pair(Index, Attribute::get(C, *I)));
717 return get(C, Attrs);
720 AttributeSet AttributeSet::get(LLVMContext &C, ArrayRef<AttributeSet> Attrs) {
721 if (Attrs.empty()) return AttributeSet();
722 if (Attrs.size() == 1) return Attrs[0];
724 SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrNodeVec;
725 AttributeSetImpl *A0 = Attrs[0].pImpl;
727 AttrNodeVec.append(A0->getNode(0), A0->getNode(A0->getNumAttributes()));
728 // Copy all attributes from Attrs into AttrNodeVec while keeping AttrNodeVec
729 // ordered by index. Because we know that each list in Attrs is ordered by
730 // index we only need to merge each successive list in rather than doing a
732 for (unsigned I = 1, E = Attrs.size(); I != E; ++I) {
733 AttributeSetImpl *AS = Attrs[I].pImpl;
735 SmallVector<std::pair<unsigned, AttributeSetNode *>, 8>::iterator
736 ANVI = AttrNodeVec.begin(), ANVE;
737 for (const IndexAttrPair *AI = AS->getNode(0),
738 *AE = AS->getNode(AS->getNumAttributes());
740 ANVE = AttrNodeVec.end();
741 while (ANVI != ANVE && ANVI->first <= AI->first)
743 ANVI = AttrNodeVec.insert(ANVI, *AI) + 1;
747 return getImpl(C, AttrNodeVec);
750 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
751 Attribute::AttrKind Attr) const {
752 if (hasAttribute(Index, Attr)) return *this;
753 return addAttributes(C, Index, AttributeSet::get(C, Index, Attr));
756 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
757 StringRef Kind) const {
759 B.addAttribute(Kind);
760 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
763 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
764 StringRef Kind, StringRef Value) const {
766 B.addAttribute(Kind, Value);
767 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
770 AttributeSet AttributeSet::addAttributes(LLVMContext &C, unsigned Index,
771 AttributeSet Attrs) const {
772 if (!pImpl) return Attrs;
773 if (!Attrs.pImpl) return *this;
776 // FIXME it is not obvious how this should work for alignment. For now, say
777 // we can't change a known alignment.
778 unsigned OldAlign = getParamAlignment(Index);
779 unsigned NewAlign = Attrs.getParamAlignment(Index);
780 assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
781 "Attempt to change alignment!");
784 // Add the attribute slots before the one we're trying to add.
785 SmallVector<AttributeSet, 4> AttrSet;
786 uint64_t NumAttrs = pImpl->getNumAttributes();
788 uint64_t LastIndex = 0;
789 for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
790 if (getSlotIndex(I) >= Index) {
791 if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
795 AttrSet.push_back(getSlotAttributes(I));
798 // Now add the attribute into the correct slot. There may already be an
799 // AttributeSet there.
800 AttrBuilder B(AS, Index);
802 for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
803 if (Attrs.getSlotIndex(I) == Index) {
804 for (AttributeSetImpl::iterator II = Attrs.pImpl->begin(I),
805 IE = Attrs.pImpl->end(I); II != IE; ++II)
810 AttrSet.push_back(AttributeSet::get(C, Index, B));
812 // Add the remaining attribute slots.
813 for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
814 AttrSet.push_back(getSlotAttributes(I));
816 return get(C, AttrSet);
819 AttributeSet AttributeSet::removeAttribute(LLVMContext &C, unsigned Index,
820 Attribute::AttrKind Attr) const {
821 if (!hasAttribute(Index, Attr)) return *this;
822 return removeAttributes(C, Index, AttributeSet::get(C, Index, Attr));
825 AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
826 AttributeSet Attrs) const {
827 if (!pImpl) return AttributeSet();
828 if (!Attrs.pImpl) return *this;
830 // FIXME it is not obvious how this should work for alignment.
831 // For now, say we can't pass in alignment, which no current use does.
832 assert(!Attrs.hasAttribute(Index, Attribute::Alignment) &&
833 "Attempt to change alignment!");
835 // Add the attribute slots before the one we're trying to add.
836 SmallVector<AttributeSet, 4> AttrSet;
837 uint64_t NumAttrs = pImpl->getNumAttributes();
839 uint64_t LastIndex = 0;
840 for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
841 if (getSlotIndex(I) >= Index) {
842 if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
846 AttrSet.push_back(getSlotAttributes(I));
849 // Now remove the attribute from the correct slot. There may already be an
850 // AttributeSet there.
851 AttrBuilder B(AS, Index);
853 for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
854 if (Attrs.getSlotIndex(I) == Index) {
855 B.removeAttributes(Attrs.pImpl->getSlotAttributes(I), Index);
859 AttrSet.push_back(AttributeSet::get(C, Index, B));
861 // Add the remaining attribute slots.
862 for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
863 AttrSet.push_back(getSlotAttributes(I));
865 return get(C, AttrSet);
868 AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
869 const AttrBuilder &Attrs) const {
870 if (!pImpl) return AttributeSet();
872 // FIXME it is not obvious how this should work for alignment.
873 // For now, say we can't pass in alignment, which no current use does.
874 assert(!Attrs.hasAlignmentAttr() && "Attempt to change alignment!");
876 // Add the attribute slots before the one we're trying to add.
877 SmallVector<AttributeSet, 4> AttrSet;
878 uint64_t NumAttrs = pImpl->getNumAttributes();
880 uint64_t LastIndex = 0;
881 for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
882 if (getSlotIndex(I) >= Index) {
883 if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
887 AttrSet.push_back(getSlotAttributes(I));
890 // Now remove the attribute from the correct slot. There may already be an
891 // AttributeSet there.
892 AttrBuilder B(AS, Index);
895 AttrSet.push_back(AttributeSet::get(C, Index, B));
897 // Add the remaining attribute slots.
898 for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
899 AttrSet.push_back(getSlotAttributes(I));
901 return get(C, AttrSet);
904 AttributeSet AttributeSet::addDereferenceableAttr(LLVMContext &C, unsigned Index,
905 uint64_t Bytes) const {
907 B.addDereferenceableAttr(Bytes);
908 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
911 AttributeSet AttributeSet::addDereferenceableOrNullAttr(LLVMContext &C,
913 uint64_t Bytes) const {
915 B.addDereferenceableOrNullAttr(Bytes);
916 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
919 //===----------------------------------------------------------------------===//
920 // AttributeSet Accessor Methods
921 //===----------------------------------------------------------------------===//
923 LLVMContext &AttributeSet::getContext() const {
924 return pImpl->getContext();
927 AttributeSet AttributeSet::getParamAttributes(unsigned Index) const {
928 return pImpl && hasAttributes(Index) ?
929 AttributeSet::get(pImpl->getContext(),
930 ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
931 std::make_pair(Index, getAttributes(Index)))) :
935 AttributeSet AttributeSet::getRetAttributes() const {
936 return pImpl && hasAttributes(ReturnIndex) ?
937 AttributeSet::get(pImpl->getContext(),
938 ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
939 std::make_pair(ReturnIndex,
940 getAttributes(ReturnIndex)))) :
944 AttributeSet AttributeSet::getFnAttributes() const {
945 return pImpl && hasAttributes(FunctionIndex) ?
946 AttributeSet::get(pImpl->getContext(),
947 ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
948 std::make_pair(FunctionIndex,
949 getAttributes(FunctionIndex)))) :
953 bool AttributeSet::hasAttribute(unsigned Index, Attribute::AttrKind Kind) const{
954 AttributeSetNode *ASN = getAttributes(Index);
955 return ASN ? ASN->hasAttribute(Kind) : false;
958 bool AttributeSet::hasAttribute(unsigned Index, StringRef Kind) const {
959 AttributeSetNode *ASN = getAttributes(Index);
960 return ASN ? ASN->hasAttribute(Kind) : false;
963 bool AttributeSet::hasAttributes(unsigned Index) const {
964 AttributeSetNode *ASN = getAttributes(Index);
965 return ASN ? ASN->hasAttributes() : false;
968 /// \brief Return true if the specified attribute is set for at least one
969 /// parameter or for the return value.
970 bool AttributeSet::hasAttrSomewhere(Attribute::AttrKind Attr) const {
971 if (!pImpl) return false;
973 for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
974 for (AttributeSetImpl::iterator II = pImpl->begin(I),
975 IE = pImpl->end(I); II != IE; ++II)
976 if (II->hasAttribute(Attr))
982 Attribute AttributeSet::getAttribute(unsigned Index,
983 Attribute::AttrKind Kind) const {
984 AttributeSetNode *ASN = getAttributes(Index);
985 return ASN ? ASN->getAttribute(Kind) : Attribute();
988 Attribute AttributeSet::getAttribute(unsigned Index,
989 StringRef Kind) const {
990 AttributeSetNode *ASN = getAttributes(Index);
991 return ASN ? ASN->getAttribute(Kind) : Attribute();
994 unsigned AttributeSet::getParamAlignment(unsigned Index) const {
995 AttributeSetNode *ASN = getAttributes(Index);
996 return ASN ? ASN->getAlignment() : 0;
999 unsigned AttributeSet::getStackAlignment(unsigned Index) const {
1000 AttributeSetNode *ASN = getAttributes(Index);
1001 return ASN ? ASN->getStackAlignment() : 0;
1004 uint64_t AttributeSet::getDereferenceableBytes(unsigned Index) const {
1005 AttributeSetNode *ASN = getAttributes(Index);
1006 return ASN ? ASN->getDereferenceableBytes() : 0;
1009 uint64_t AttributeSet::getDereferenceableOrNullBytes(unsigned Index) const {
1010 AttributeSetNode *ASN = getAttributes(Index);
1011 return ASN ? ASN->getDereferenceableOrNullBytes() : 0;
1014 std::string AttributeSet::getAsString(unsigned Index,
1015 bool InAttrGrp) const {
1016 AttributeSetNode *ASN = getAttributes(Index);
1017 return ASN ? ASN->getAsString(InAttrGrp) : std::string("");
1020 /// \brief The attributes for the specified index are returned.
1021 AttributeSetNode *AttributeSet::getAttributes(unsigned Index) const {
1022 if (!pImpl) return nullptr;
1024 // Loop through to find the attribute node we want.
1025 for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
1026 if (pImpl->getSlotIndex(I) == Index)
1027 return pImpl->getSlotNode(I);
1032 AttributeSet::iterator AttributeSet::begin(unsigned Slot) const {
1034 return ArrayRef<Attribute>().begin();
1035 return pImpl->begin(Slot);
1038 AttributeSet::iterator AttributeSet::end(unsigned Slot) const {
1040 return ArrayRef<Attribute>().end();
1041 return pImpl->end(Slot);
1044 //===----------------------------------------------------------------------===//
1045 // AttributeSet Introspection Methods
1046 //===----------------------------------------------------------------------===//
1048 /// \brief Return the number of slots used in this attribute list. This is the
1049 /// number of arguments that have an attribute set on them (including the
1050 /// function itself).
1051 unsigned AttributeSet::getNumSlots() const {
1052 return pImpl ? pImpl->getNumAttributes() : 0;
1055 unsigned AttributeSet::getSlotIndex(unsigned Slot) const {
1056 assert(pImpl && Slot < pImpl->getNumAttributes() &&
1057 "Slot # out of range!");
1058 return pImpl->getSlotIndex(Slot);
1061 AttributeSet AttributeSet::getSlotAttributes(unsigned Slot) const {
1062 assert(pImpl && Slot < pImpl->getNumAttributes() &&
1063 "Slot # out of range!");
1064 return pImpl->getSlotAttributes(Slot);
1067 uint64_t AttributeSet::Raw(unsigned Index) const {
1068 // FIXME: Remove this.
1069 return pImpl ? pImpl->Raw(Index) : 0;
1072 void AttributeSet::dump() const {
1075 for (unsigned i = 0, e = getNumSlots(); i < e; ++i) {
1076 uint64_t Index = getSlotIndex(i);
1082 dbgs() << " => " << getAsString(Index) << " }\n";
1088 //===----------------------------------------------------------------------===//
1089 // AttrBuilder Method Implementations
1090 //===----------------------------------------------------------------------===//
1092 AttrBuilder::AttrBuilder(AttributeSet AS, unsigned Index)
1093 : Attrs(0), Alignment(0), StackAlignment(0), DerefBytes(0),
1094 DerefOrNullBytes(0) {
1095 AttributeSetImpl *pImpl = AS.pImpl;
1098 for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I) {
1099 if (pImpl->getSlotIndex(I) != Index) continue;
1101 for (AttributeSetImpl::iterator II = pImpl->begin(I),
1102 IE = pImpl->end(I); II != IE; ++II)
1109 void AttrBuilder::clear() {
1111 TargetDepAttrs.clear();
1112 Alignment = StackAlignment = DerefBytes = DerefOrNullBytes = 0;
1115 AttrBuilder &AttrBuilder::addAttribute(Attribute::AttrKind Val) {
1116 assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1117 assert(Val != Attribute::Alignment && Val != Attribute::StackAlignment &&
1118 Val != Attribute::Dereferenceable &&
1119 "Adding integer attribute without adding a value!");
1124 AttrBuilder &AttrBuilder::addAttribute(Attribute Attr) {
1125 if (Attr.isStringAttribute()) {
1126 addAttribute(Attr.getKindAsString(), Attr.getValueAsString());
1130 Attribute::AttrKind Kind = Attr.getKindAsEnum();
1133 if (Kind == Attribute::Alignment)
1134 Alignment = Attr.getAlignment();
1135 else if (Kind == Attribute::StackAlignment)
1136 StackAlignment = Attr.getStackAlignment();
1137 else if (Kind == Attribute::Dereferenceable)
1138 DerefBytes = Attr.getDereferenceableBytes();
1139 else if (Kind == Attribute::DereferenceableOrNull)
1140 DerefOrNullBytes = Attr.getDereferenceableOrNullBytes();
1144 AttrBuilder &AttrBuilder::addAttribute(StringRef A, StringRef V) {
1145 TargetDepAttrs[A] = V;
1149 AttrBuilder &AttrBuilder::removeAttribute(Attribute::AttrKind Val) {
1150 assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1153 if (Val == Attribute::Alignment)
1155 else if (Val == Attribute::StackAlignment)
1157 else if (Val == Attribute::Dereferenceable)
1159 else if (Val == Attribute::DereferenceableOrNull)
1160 DerefOrNullBytes = 0;
1165 AttrBuilder &AttrBuilder::removeAttributes(AttributeSet A, uint64_t Index) {
1166 unsigned Slot = ~0U;
1167 for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1168 if (A.getSlotIndex(I) == Index) {
1173 assert(Slot != ~0U && "Couldn't find index in AttributeSet!");
1175 for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot); I != E; ++I) {
1176 Attribute Attr = *I;
1177 if (Attr.isEnumAttribute() || Attr.isIntAttribute()) {
1178 Attribute::AttrKind Kind = I->getKindAsEnum();
1179 Attrs[Kind] = false;
1181 if (Kind == Attribute::Alignment)
1183 else if (Kind == Attribute::StackAlignment)
1185 else if (Kind == Attribute::Dereferenceable)
1187 else if (Kind == Attribute::DereferenceableOrNull)
1188 DerefOrNullBytes = 0;
1190 assert(Attr.isStringAttribute() && "Invalid attribute type!");
1191 std::map<std::string, std::string>::iterator
1192 Iter = TargetDepAttrs.find(Attr.getKindAsString());
1193 if (Iter != TargetDepAttrs.end())
1194 TargetDepAttrs.erase(Iter);
1201 AttrBuilder &AttrBuilder::removeAttribute(StringRef A) {
1202 std::map<std::string, std::string>::iterator I = TargetDepAttrs.find(A);
1203 if (I != TargetDepAttrs.end())
1204 TargetDepAttrs.erase(I);
1208 AttrBuilder &AttrBuilder::addAlignmentAttr(unsigned Align) {
1209 if (Align == 0) return *this;
1211 assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1212 assert(Align <= 0x40000000 && "Alignment too large.");
1214 Attrs[Attribute::Alignment] = true;
1219 AttrBuilder &AttrBuilder::addStackAlignmentAttr(unsigned Align) {
1220 // Default alignment, allow the target to define how to align it.
1221 if (Align == 0) return *this;
1223 assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1224 assert(Align <= 0x100 && "Alignment too large.");
1226 Attrs[Attribute::StackAlignment] = true;
1227 StackAlignment = Align;
1231 AttrBuilder &AttrBuilder::addDereferenceableAttr(uint64_t Bytes) {
1232 if (Bytes == 0) return *this;
1234 Attrs[Attribute::Dereferenceable] = true;
1239 AttrBuilder &AttrBuilder::addDereferenceableOrNullAttr(uint64_t Bytes) {
1243 Attrs[Attribute::DereferenceableOrNull] = true;
1244 DerefOrNullBytes = Bytes;
1248 AttrBuilder &AttrBuilder::merge(const AttrBuilder &B) {
1249 // FIXME: What if both have alignments, but they don't match?!
1251 Alignment = B.Alignment;
1253 if (!StackAlignment)
1254 StackAlignment = B.StackAlignment;
1257 DerefBytes = B.DerefBytes;
1259 if (!DerefOrNullBytes)
1260 DerefOrNullBytes = B.DerefOrNullBytes;
1264 for (auto I : B.td_attrs())
1265 TargetDepAttrs[I.first] = I.second;
1270 AttrBuilder &AttrBuilder::remove(const AttrBuilder &B) {
1271 // FIXME: What if both have alignments, but they don't match?!
1275 if (B.StackAlignment)
1281 if (B.DerefOrNullBytes)
1282 DerefOrNullBytes = 0;
1286 for (auto I : B.td_attrs())
1287 TargetDepAttrs.erase(I.first);
1292 bool AttrBuilder::overlaps(const AttrBuilder &B) const {
1293 // First check if any of the target independent attributes overlap.
1294 if ((Attrs & B.Attrs).any())
1297 // Then check if any target dependent ones do.
1298 for (auto I : td_attrs())
1299 if (B.contains(I.first))
1305 bool AttrBuilder::contains(StringRef A) const {
1306 return TargetDepAttrs.find(A) != TargetDepAttrs.end();
1309 bool AttrBuilder::hasAttributes() const {
1310 return !Attrs.none() || !TargetDepAttrs.empty();
1313 bool AttrBuilder::hasAttributes(AttributeSet A, uint64_t Index) const {
1314 unsigned Slot = ~0U;
1315 for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1316 if (A.getSlotIndex(I) == Index) {
1321 assert(Slot != ~0U && "Couldn't find the index!");
1323 for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot);
1325 Attribute Attr = *I;
1326 if (Attr.isEnumAttribute() || Attr.isIntAttribute()) {
1327 if (Attrs[I->getKindAsEnum()])
1330 assert(Attr.isStringAttribute() && "Invalid attribute kind!");
1331 return TargetDepAttrs.find(Attr.getKindAsString())!=TargetDepAttrs.end();
1338 bool AttrBuilder::hasAlignmentAttr() const {
1339 return Alignment != 0;
1342 bool AttrBuilder::operator==(const AttrBuilder &B) {
1343 if (Attrs != B.Attrs)
1346 for (td_const_iterator I = TargetDepAttrs.begin(),
1347 E = TargetDepAttrs.end(); I != E; ++I)
1348 if (B.TargetDepAttrs.find(I->first) == B.TargetDepAttrs.end())
1351 return Alignment == B.Alignment && StackAlignment == B.StackAlignment &&
1352 DerefBytes == B.DerefBytes;
1355 AttrBuilder &AttrBuilder::addRawValue(uint64_t Val) {
1356 // FIXME: Remove this in 4.0.
1357 if (!Val) return *this;
1359 for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1360 I = Attribute::AttrKind(I + 1)) {
1361 if (I == Attribute::Dereferenceable ||
1362 I == Attribute::DereferenceableOrNull ||
1363 I == Attribute::ArgMemOnly)
1365 if (uint64_t A = (Val & AttributeImpl::getAttrMask(I))) {
1368 if (I == Attribute::Alignment)
1369 Alignment = 1ULL << ((A >> 16) - 1);
1370 else if (I == Attribute::StackAlignment)
1371 StackAlignment = 1ULL << ((A >> 26)-1);
1378 //===----------------------------------------------------------------------===//
1379 // AttributeFuncs Function Defintions
1380 //===----------------------------------------------------------------------===//
1382 /// \brief Which attributes cannot be applied to a type.
1383 AttrBuilder AttributeFuncs::typeIncompatible(Type *Ty) {
1384 AttrBuilder Incompatible;
1386 if (!Ty->isIntegerTy())
1387 // Attribute that only apply to integers.
1388 Incompatible.addAttribute(Attribute::SExt)
1389 .addAttribute(Attribute::ZExt);
1391 if (!Ty->isPointerTy())
1392 // Attribute that only apply to pointers.
1393 Incompatible.addAttribute(Attribute::ByVal)
1394 .addAttribute(Attribute::Nest)
1395 .addAttribute(Attribute::NoAlias)
1396 .addAttribute(Attribute::NoCapture)
1397 .addAttribute(Attribute::NonNull)
1398 .addDereferenceableAttr(1) // the int here is ignored
1399 .addDereferenceableOrNullAttr(1) // the int here is ignored
1400 .addAttribute(Attribute::ReadNone)
1401 .addAttribute(Attribute::ReadOnly)
1402 .addAttribute(Attribute::StructRet)
1403 .addAttribute(Attribute::InAlloca);
1405 return Incompatible;