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::Builtin))
195 if (hasAttribute(Attribute::ByVal))
197 if (hasAttribute(Attribute::InAlloca))
199 if (hasAttribute(Attribute::InlineHint))
201 if (hasAttribute(Attribute::InReg))
203 if (hasAttribute(Attribute::JumpTable))
205 if (hasAttribute(Attribute::MinSize))
207 if (hasAttribute(Attribute::Naked))
209 if (hasAttribute(Attribute::Nest))
211 if (hasAttribute(Attribute::NoAlias))
213 if (hasAttribute(Attribute::NoBuiltin))
215 if (hasAttribute(Attribute::NoCapture))
217 if (hasAttribute(Attribute::NoDuplicate))
218 return "noduplicate";
219 if (hasAttribute(Attribute::NoImplicitFloat))
220 return "noimplicitfloat";
221 if (hasAttribute(Attribute::NoInline))
223 if (hasAttribute(Attribute::NonLazyBind))
224 return "nonlazybind";
225 if (hasAttribute(Attribute::NonNull))
227 if (hasAttribute(Attribute::NoRedZone))
229 if (hasAttribute(Attribute::NoReturn))
231 if (hasAttribute(Attribute::NoUnwind))
233 if (hasAttribute(Attribute::OptimizeNone))
235 if (hasAttribute(Attribute::OptimizeForSize))
237 if (hasAttribute(Attribute::ReadNone))
239 if (hasAttribute(Attribute::ReadOnly))
241 if (hasAttribute(Attribute::Returned))
243 if (hasAttribute(Attribute::ReturnsTwice))
244 return "returns_twice";
245 if (hasAttribute(Attribute::SExt))
247 if (hasAttribute(Attribute::StackProtect))
249 if (hasAttribute(Attribute::StackProtectReq))
251 if (hasAttribute(Attribute::StackProtectStrong))
253 if (hasAttribute(Attribute::StructRet))
255 if (hasAttribute(Attribute::SanitizeThread))
256 return "sanitize_thread";
257 if (hasAttribute(Attribute::SanitizeMemory))
258 return "sanitize_memory";
259 if (hasAttribute(Attribute::UWTable))
261 if (hasAttribute(Attribute::ZExt))
263 if (hasAttribute(Attribute::Cold))
266 // FIXME: These should be output like this:
271 if (hasAttribute(Attribute::Alignment)) {
274 Result += (InAttrGrp) ? "=" : " ";
275 Result += utostr(getValueAsInt());
279 auto AttrWithBytesToString = [&](const char *Name) {
284 Result += utostr(getValueAsInt());
287 Result += utostr(getValueAsInt());
293 if (hasAttribute(Attribute::StackAlignment))
294 return AttrWithBytesToString("alignstack");
296 if (hasAttribute(Attribute::Dereferenceable))
297 return AttrWithBytesToString("dereferenceable");
299 if (hasAttribute(Attribute::DereferenceableOrNull))
300 return AttrWithBytesToString("dereferenceable_or_null");
302 // Convert target-dependent attributes to strings of the form:
307 if (isStringAttribute()) {
309 Result += (Twine('"') + getKindAsString() + Twine('"')).str();
311 StringRef Val = pImpl->getValueAsString();
312 if (Val.empty()) return Result;
314 Result += ("=\"" + Val + Twine('"')).str();
318 llvm_unreachable("Unknown attribute");
321 bool Attribute::operator<(Attribute A) const {
322 if (!pImpl && !A.pImpl) return false;
323 if (!pImpl) return true;
324 if (!A.pImpl) return false;
325 return *pImpl < *A.pImpl;
328 //===----------------------------------------------------------------------===//
329 // AttributeImpl Definition
330 //===----------------------------------------------------------------------===//
332 // Pin the vtables to this file.
333 AttributeImpl::~AttributeImpl() {}
334 void EnumAttributeImpl::anchor() {}
335 void IntAttributeImpl::anchor() {}
336 void StringAttributeImpl::anchor() {}
338 bool AttributeImpl::hasAttribute(Attribute::AttrKind A) const {
339 if (isStringAttribute()) return false;
340 return getKindAsEnum() == A;
343 bool AttributeImpl::hasAttribute(StringRef Kind) const {
344 if (!isStringAttribute()) return false;
345 return getKindAsString() == Kind;
348 Attribute::AttrKind AttributeImpl::getKindAsEnum() const {
349 assert(isEnumAttribute() || isIntAttribute());
350 return static_cast<const EnumAttributeImpl *>(this)->getEnumKind();
353 uint64_t AttributeImpl::getValueAsInt() const {
354 assert(isIntAttribute());
355 return static_cast<const IntAttributeImpl *>(this)->getValue();
358 StringRef AttributeImpl::getKindAsString() const {
359 assert(isStringAttribute());
360 return static_cast<const StringAttributeImpl *>(this)->getStringKind();
363 StringRef AttributeImpl::getValueAsString() const {
364 assert(isStringAttribute());
365 return static_cast<const StringAttributeImpl *>(this)->getStringValue();
368 bool AttributeImpl::operator<(const AttributeImpl &AI) const {
369 // This sorts the attributes with Attribute::AttrKinds coming first (sorted
370 // relative to their enum value) and then strings.
371 if (isEnumAttribute()) {
372 if (AI.isEnumAttribute()) return getKindAsEnum() < AI.getKindAsEnum();
373 if (AI.isIntAttribute()) return true;
374 if (AI.isStringAttribute()) return true;
377 if (isIntAttribute()) {
378 if (AI.isEnumAttribute()) return false;
379 if (AI.isIntAttribute()) return getValueAsInt() < AI.getValueAsInt();
380 if (AI.isStringAttribute()) return true;
383 if (AI.isEnumAttribute()) return false;
384 if (AI.isIntAttribute()) return false;
385 if (getKindAsString() == AI.getKindAsString())
386 return getValueAsString() < AI.getValueAsString();
387 return getKindAsString() < AI.getKindAsString();
390 uint64_t AttributeImpl::getAttrMask(Attribute::AttrKind Val) {
391 // FIXME: Remove this.
393 case Attribute::EndAttrKinds:
394 llvm_unreachable("Synthetic enumerators which should never get here");
396 case Attribute::None: return 0;
397 case Attribute::ZExt: return 1 << 0;
398 case Attribute::SExt: return 1 << 1;
399 case Attribute::NoReturn: return 1 << 2;
400 case Attribute::InReg: return 1 << 3;
401 case Attribute::StructRet: return 1 << 4;
402 case Attribute::NoUnwind: return 1 << 5;
403 case Attribute::NoAlias: return 1 << 6;
404 case Attribute::ByVal: return 1 << 7;
405 case Attribute::Nest: return 1 << 8;
406 case Attribute::ReadNone: return 1 << 9;
407 case Attribute::ReadOnly: return 1 << 10;
408 case Attribute::NoInline: return 1 << 11;
409 case Attribute::AlwaysInline: return 1 << 12;
410 case Attribute::OptimizeForSize: return 1 << 13;
411 case Attribute::StackProtect: return 1 << 14;
412 case Attribute::StackProtectReq: return 1 << 15;
413 case Attribute::Alignment: return 31 << 16;
414 case Attribute::NoCapture: return 1 << 21;
415 case Attribute::NoRedZone: return 1 << 22;
416 case Attribute::NoImplicitFloat: return 1 << 23;
417 case Attribute::Naked: return 1 << 24;
418 case Attribute::InlineHint: return 1 << 25;
419 case Attribute::StackAlignment: return 7 << 26;
420 case Attribute::ReturnsTwice: return 1 << 29;
421 case Attribute::UWTable: return 1 << 30;
422 case Attribute::NonLazyBind: return 1U << 31;
423 case Attribute::SanitizeAddress: return 1ULL << 32;
424 case Attribute::MinSize: return 1ULL << 33;
425 case Attribute::NoDuplicate: return 1ULL << 34;
426 case Attribute::StackProtectStrong: return 1ULL << 35;
427 case Attribute::SanitizeThread: return 1ULL << 36;
428 case Attribute::SanitizeMemory: return 1ULL << 37;
429 case Attribute::NoBuiltin: return 1ULL << 38;
430 case Attribute::Returned: return 1ULL << 39;
431 case Attribute::Cold: return 1ULL << 40;
432 case Attribute::Builtin: return 1ULL << 41;
433 case Attribute::OptimizeNone: return 1ULL << 42;
434 case Attribute::InAlloca: return 1ULL << 43;
435 case Attribute::NonNull: return 1ULL << 44;
436 case Attribute::JumpTable: return 1ULL << 45;
437 case Attribute::Dereferenceable:
438 llvm_unreachable("dereferenceable attribute not supported in raw format");
440 case Attribute::DereferenceableOrNull:
441 llvm_unreachable("dereferenceable_or_null attribute not supported in raw "
445 llvm_unreachable("Unsupported attribute type");
448 //===----------------------------------------------------------------------===//
449 // AttributeSetNode Definition
450 //===----------------------------------------------------------------------===//
452 AttributeSetNode *AttributeSetNode::get(LLVMContext &C,
453 ArrayRef<Attribute> Attrs) {
457 // Otherwise, build a key to look up the existing attributes.
458 LLVMContextImpl *pImpl = C.pImpl;
461 SmallVector<Attribute, 8> SortedAttrs(Attrs.begin(), Attrs.end());
462 array_pod_sort(SortedAttrs.begin(), SortedAttrs.end());
464 for (SmallVectorImpl<Attribute>::iterator I = SortedAttrs.begin(),
465 E = SortedAttrs.end(); I != E; ++I)
469 AttributeSetNode *PA =
470 pImpl->AttrsSetNodes.FindNodeOrInsertPos(ID, InsertPoint);
472 // If we didn't find any existing attributes of the same shape then create a
473 // new one and insert it.
475 // Coallocate entries after the AttributeSetNode itself.
476 void *Mem = ::operator new(sizeof(AttributeSetNode) +
477 sizeof(Attribute) * SortedAttrs.size());
478 PA = new (Mem) AttributeSetNode(SortedAttrs);
479 pImpl->AttrsSetNodes.InsertNode(PA, InsertPoint);
482 // Return the AttributesListNode that we found or created.
486 bool AttributeSetNode::hasAttribute(Attribute::AttrKind Kind) const {
487 for (iterator I = begin(), E = end(); I != E; ++I)
488 if (I->hasAttribute(Kind))
493 bool AttributeSetNode::hasAttribute(StringRef Kind) const {
494 for (iterator I = begin(), E = end(); I != E; ++I)
495 if (I->hasAttribute(Kind))
500 Attribute AttributeSetNode::getAttribute(Attribute::AttrKind Kind) const {
501 for (iterator I = begin(), E = end(); I != E; ++I)
502 if (I->hasAttribute(Kind))
507 Attribute AttributeSetNode::getAttribute(StringRef Kind) const {
508 for (iterator I = begin(), E = end(); I != E; ++I)
509 if (I->hasAttribute(Kind))
514 unsigned AttributeSetNode::getAlignment() const {
515 for (iterator I = begin(), E = end(); I != E; ++I)
516 if (I->hasAttribute(Attribute::Alignment))
517 return I->getAlignment();
521 unsigned AttributeSetNode::getStackAlignment() const {
522 for (iterator I = begin(), E = end(); I != E; ++I)
523 if (I->hasAttribute(Attribute::StackAlignment))
524 return I->getStackAlignment();
528 uint64_t AttributeSetNode::getDereferenceableBytes() const {
529 for (iterator I = begin(), E = end(); I != E; ++I)
530 if (I->hasAttribute(Attribute::Dereferenceable))
531 return I->getDereferenceableBytes();
535 uint64_t AttributeSetNode::getDereferenceableOrNullBytes() const {
536 for (iterator I = begin(), E = end(); I != E; ++I)
537 if (I->hasAttribute(Attribute::DereferenceableOrNull))
538 return I->getDereferenceableOrNullBytes();
542 std::string AttributeSetNode::getAsString(bool InAttrGrp) const {
544 for (iterator I = begin(), E = end(); I != E; ++I) {
547 Str += I->getAsString(InAttrGrp);
552 //===----------------------------------------------------------------------===//
553 // AttributeSetImpl Definition
554 //===----------------------------------------------------------------------===//
556 uint64_t AttributeSetImpl::Raw(unsigned Index) const {
557 for (unsigned I = 0, E = getNumAttributes(); I != E; ++I) {
558 if (getSlotIndex(I) != Index) continue;
559 const AttributeSetNode *ASN = getSlotNode(I);
562 for (AttributeSetNode::iterator II = ASN->begin(),
563 IE = ASN->end(); II != IE; ++II) {
564 Attribute Attr = *II;
566 // This cannot handle string attributes.
567 if (Attr.isStringAttribute()) continue;
569 Attribute::AttrKind Kind = Attr.getKindAsEnum();
571 if (Kind == Attribute::Alignment)
572 Mask |= (Log2_32(ASN->getAlignment()) + 1) << 16;
573 else if (Kind == Attribute::StackAlignment)
574 Mask |= (Log2_32(ASN->getStackAlignment()) + 1) << 26;
575 else if (Kind == Attribute::Dereferenceable)
576 llvm_unreachable("dereferenceable not supported in bit mask");
578 Mask |= AttributeImpl::getAttrMask(Kind);
587 void AttributeSetImpl::dump() const {
588 AttributeSet(const_cast<AttributeSetImpl *>(this)).dump();
591 //===----------------------------------------------------------------------===//
592 // AttributeSet Construction and Mutation Methods
593 //===----------------------------------------------------------------------===//
596 AttributeSet::getImpl(LLVMContext &C,
597 ArrayRef<std::pair<unsigned, AttributeSetNode*> > Attrs) {
598 LLVMContextImpl *pImpl = C.pImpl;
600 AttributeSetImpl::Profile(ID, Attrs);
603 AttributeSetImpl *PA = pImpl->AttrsLists.FindNodeOrInsertPos(ID, InsertPoint);
605 // If we didn't find any existing attributes of the same shape then
606 // create a new one and insert it.
608 // Coallocate entries after the AttributeSetImpl itself.
609 void *Mem = ::operator new(sizeof(AttributeSetImpl) +
610 sizeof(std::pair<unsigned, AttributeSetNode *>) *
612 PA = new (Mem) AttributeSetImpl(C, Attrs);
613 pImpl->AttrsLists.InsertNode(PA, InsertPoint);
616 // Return the AttributesList that we found or created.
617 return AttributeSet(PA);
620 AttributeSet AttributeSet::get(LLVMContext &C,
621 ArrayRef<std::pair<unsigned, Attribute> > Attrs){
622 // If there are no attributes then return a null AttributesList pointer.
624 return AttributeSet();
627 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
628 assert((!i || Attrs[i-1].first <= Attrs[i].first) &&
629 "Misordered Attributes list!");
630 assert(!Attrs[i].second.hasAttribute(Attribute::None) &&
631 "Pointless attribute!");
635 // Create a vector if (unsigned, AttributeSetNode*) pairs from the attributes
637 SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrPairVec;
638 for (ArrayRef<std::pair<unsigned, Attribute> >::iterator I = Attrs.begin(),
639 E = Attrs.end(); I != E; ) {
640 unsigned Index = I->first;
641 SmallVector<Attribute, 4> AttrVec;
642 while (I != E && I->first == Index) {
643 AttrVec.push_back(I->second);
647 AttrPairVec.push_back(std::make_pair(Index,
648 AttributeSetNode::get(C, AttrVec)));
651 return getImpl(C, AttrPairVec);
654 AttributeSet AttributeSet::get(LLVMContext &C,
655 ArrayRef<std::pair<unsigned,
656 AttributeSetNode*> > Attrs) {
657 // If there are no attributes then return a null AttributesList pointer.
659 return AttributeSet();
661 return getImpl(C, Attrs);
664 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
665 const AttrBuilder &B) {
666 if (!B.hasAttributes())
667 return AttributeSet();
669 // Add target-independent attributes.
670 SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
671 for (Attribute::AttrKind Kind = Attribute::None;
672 Kind != Attribute::EndAttrKinds; Kind = Attribute::AttrKind(Kind + 1)) {
673 if (!B.contains(Kind))
676 if (Kind == Attribute::Alignment)
677 Attrs.push_back(std::make_pair(Index, Attribute::
678 getWithAlignment(C, B.getAlignment())));
679 else if (Kind == Attribute::StackAlignment)
680 Attrs.push_back(std::make_pair(Index, Attribute::
681 getWithStackAlignment(C, B.getStackAlignment())));
682 else if (Kind == Attribute::Dereferenceable)
683 Attrs.push_back(std::make_pair(Index,
684 Attribute::getWithDereferenceableBytes(C,
685 B.getDereferenceableBytes())));
686 else if (Kind == Attribute::DereferenceableOrNull)
688 std::make_pair(Index, Attribute::getWithDereferenceableOrNullBytes(
689 C, B.getDereferenceableOrNullBytes())));
691 Attrs.push_back(std::make_pair(Index, Attribute::get(C, Kind)));
694 // Add target-dependent (string) attributes.
695 for (const AttrBuilder::td_type &TDA : B.td_attrs())
697 std::make_pair(Index, Attribute::get(C, TDA.first, TDA.second)));
699 return get(C, Attrs);
702 AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
703 ArrayRef<Attribute::AttrKind> Kind) {
704 SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
705 for (ArrayRef<Attribute::AttrKind>::iterator I = Kind.begin(),
706 E = Kind.end(); I != E; ++I)
707 Attrs.push_back(std::make_pair(Index, Attribute::get(C, *I)));
708 return get(C, Attrs);
711 AttributeSet AttributeSet::get(LLVMContext &C, ArrayRef<AttributeSet> Attrs) {
712 if (Attrs.empty()) return AttributeSet();
713 if (Attrs.size() == 1) return Attrs[0];
715 SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrNodeVec;
716 AttributeSetImpl *A0 = Attrs[0].pImpl;
718 AttrNodeVec.append(A0->getNode(0), A0->getNode(A0->getNumAttributes()));
719 // Copy all attributes from Attrs into AttrNodeVec while keeping AttrNodeVec
720 // ordered by index. Because we know that each list in Attrs is ordered by
721 // index we only need to merge each successive list in rather than doing a
723 for (unsigned I = 1, E = Attrs.size(); I != E; ++I) {
724 AttributeSetImpl *AS = Attrs[I].pImpl;
726 SmallVector<std::pair<unsigned, AttributeSetNode *>, 8>::iterator
727 ANVI = AttrNodeVec.begin(), ANVE;
728 for (const AttributeSetImpl::IndexAttrPair
729 *AI = AS->getNode(0),
730 *AE = AS->getNode(AS->getNumAttributes());
732 ANVE = AttrNodeVec.end();
733 while (ANVI != ANVE && ANVI->first <= AI->first)
735 ANVI = AttrNodeVec.insert(ANVI, *AI) + 1;
739 return getImpl(C, AttrNodeVec);
742 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
743 Attribute::AttrKind Attr) const {
744 if (hasAttribute(Index, Attr)) return *this;
745 return addAttributes(C, Index, AttributeSet::get(C, Index, Attr));
748 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
749 StringRef Kind) const {
751 B.addAttribute(Kind);
752 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
755 AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
756 StringRef Kind, StringRef Value) const {
758 B.addAttribute(Kind, Value);
759 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
762 AttributeSet AttributeSet::addAttributes(LLVMContext &C, unsigned Index,
763 AttributeSet Attrs) const {
764 if (!pImpl) return Attrs;
765 if (!Attrs.pImpl) return *this;
768 // FIXME it is not obvious how this should work for alignment. For now, say
769 // we can't change a known alignment.
770 unsigned OldAlign = getParamAlignment(Index);
771 unsigned NewAlign = Attrs.getParamAlignment(Index);
772 assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
773 "Attempt to change alignment!");
776 // Add the attribute slots before the one we're trying to add.
777 SmallVector<AttributeSet, 4> AttrSet;
778 uint64_t NumAttrs = pImpl->getNumAttributes();
780 uint64_t LastIndex = 0;
781 for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
782 if (getSlotIndex(I) >= Index) {
783 if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
787 AttrSet.push_back(getSlotAttributes(I));
790 // Now add the attribute into the correct slot. There may already be an
791 // AttributeSet there.
792 AttrBuilder B(AS, Index);
794 for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
795 if (Attrs.getSlotIndex(I) == Index) {
796 for (AttributeSetImpl::iterator II = Attrs.pImpl->begin(I),
797 IE = Attrs.pImpl->end(I); II != IE; ++II)
802 AttrSet.push_back(AttributeSet::get(C, Index, B));
804 // Add the remaining attribute slots.
805 for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
806 AttrSet.push_back(getSlotAttributes(I));
808 return get(C, AttrSet);
811 AttributeSet AttributeSet::removeAttribute(LLVMContext &C, unsigned Index,
812 Attribute::AttrKind Attr) const {
813 if (!hasAttribute(Index, Attr)) return *this;
814 return removeAttributes(C, Index, AttributeSet::get(C, Index, Attr));
817 AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
818 AttributeSet Attrs) const {
819 if (!pImpl) return AttributeSet();
820 if (!Attrs.pImpl) return *this;
823 // FIXME it is not obvious how this should work for alignment.
824 // For now, say we can't pass in alignment, which no current use does.
825 assert(!Attrs.hasAttribute(Index, Attribute::Alignment) &&
826 "Attempt to change alignment!");
829 // Add the attribute slots before the one we're trying to add.
830 SmallVector<AttributeSet, 4> AttrSet;
831 uint64_t NumAttrs = pImpl->getNumAttributes();
833 uint64_t LastIndex = 0;
834 for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
835 if (getSlotIndex(I) >= Index) {
836 if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
840 AttrSet.push_back(getSlotAttributes(I));
843 // Now remove the attribute from the correct slot. There may already be an
844 // AttributeSet there.
845 AttrBuilder B(AS, Index);
847 for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
848 if (Attrs.getSlotIndex(I) == Index) {
849 B.removeAttributes(Attrs.pImpl->getSlotAttributes(I), Index);
853 AttrSet.push_back(AttributeSet::get(C, Index, B));
855 // Add the remaining attribute slots.
856 for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
857 AttrSet.push_back(getSlotAttributes(I));
859 return get(C, AttrSet);
862 AttributeSet AttributeSet::addDereferenceableAttr(LLVMContext &C, unsigned Index,
863 uint64_t Bytes) const {
865 B.addDereferenceableAttr(Bytes);
866 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
869 AttributeSet AttributeSet::addDereferenceableOrNullAttr(LLVMContext &C,
871 uint64_t Bytes) const {
873 B.addDereferenceableOrNullAttr(Bytes);
874 return addAttributes(C, Index, AttributeSet::get(C, Index, B));
877 //===----------------------------------------------------------------------===//
878 // AttributeSet Accessor Methods
879 //===----------------------------------------------------------------------===//
881 LLVMContext &AttributeSet::getContext() const {
882 return pImpl->getContext();
885 AttributeSet AttributeSet::getParamAttributes(unsigned Index) const {
886 return pImpl && hasAttributes(Index) ?
887 AttributeSet::get(pImpl->getContext(),
888 ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
889 std::make_pair(Index, getAttributes(Index)))) :
893 AttributeSet AttributeSet::getRetAttributes() const {
894 return pImpl && hasAttributes(ReturnIndex) ?
895 AttributeSet::get(pImpl->getContext(),
896 ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
897 std::make_pair(ReturnIndex,
898 getAttributes(ReturnIndex)))) :
902 AttributeSet AttributeSet::getFnAttributes() const {
903 return pImpl && hasAttributes(FunctionIndex) ?
904 AttributeSet::get(pImpl->getContext(),
905 ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
906 std::make_pair(FunctionIndex,
907 getAttributes(FunctionIndex)))) :
911 bool AttributeSet::hasAttribute(unsigned Index, Attribute::AttrKind Kind) const{
912 AttributeSetNode *ASN = getAttributes(Index);
913 return ASN ? ASN->hasAttribute(Kind) : false;
916 bool AttributeSet::hasAttribute(unsigned Index, StringRef Kind) const {
917 AttributeSetNode *ASN = getAttributes(Index);
918 return ASN ? ASN->hasAttribute(Kind) : false;
921 bool AttributeSet::hasAttributes(unsigned Index) const {
922 AttributeSetNode *ASN = getAttributes(Index);
923 return ASN ? ASN->hasAttributes() : false;
926 /// \brief Return true if the specified attribute is set for at least one
927 /// parameter or for the return value.
928 bool AttributeSet::hasAttrSomewhere(Attribute::AttrKind Attr) const {
929 if (!pImpl) return false;
931 for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
932 for (AttributeSetImpl::iterator II = pImpl->begin(I),
933 IE = pImpl->end(I); II != IE; ++II)
934 if (II->hasAttribute(Attr))
940 Attribute AttributeSet::getAttribute(unsigned Index,
941 Attribute::AttrKind Kind) const {
942 AttributeSetNode *ASN = getAttributes(Index);
943 return ASN ? ASN->getAttribute(Kind) : Attribute();
946 Attribute AttributeSet::getAttribute(unsigned Index,
947 StringRef Kind) const {
948 AttributeSetNode *ASN = getAttributes(Index);
949 return ASN ? ASN->getAttribute(Kind) : Attribute();
952 unsigned AttributeSet::getParamAlignment(unsigned Index) const {
953 AttributeSetNode *ASN = getAttributes(Index);
954 return ASN ? ASN->getAlignment() : 0;
957 unsigned AttributeSet::getStackAlignment(unsigned Index) const {
958 AttributeSetNode *ASN = getAttributes(Index);
959 return ASN ? ASN->getStackAlignment() : 0;
962 uint64_t AttributeSet::getDereferenceableBytes(unsigned Index) const {
963 AttributeSetNode *ASN = getAttributes(Index);
964 return ASN ? ASN->getDereferenceableBytes() : 0;
967 uint64_t AttributeSet::getDereferenceableOrNullBytes(unsigned Index) const {
968 AttributeSetNode *ASN = getAttributes(Index);
969 return ASN ? ASN->getDereferenceableOrNullBytes() : 0;
972 std::string AttributeSet::getAsString(unsigned Index,
973 bool InAttrGrp) const {
974 AttributeSetNode *ASN = getAttributes(Index);
975 return ASN ? ASN->getAsString(InAttrGrp) : std::string("");
978 /// \brief The attributes for the specified index are returned.
979 AttributeSetNode *AttributeSet::getAttributes(unsigned Index) const {
980 if (!pImpl) return nullptr;
982 // Loop through to find the attribute node we want.
983 for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
984 if (pImpl->getSlotIndex(I) == Index)
985 return pImpl->getSlotNode(I);
990 AttributeSet::iterator AttributeSet::begin(unsigned Slot) const {
992 return ArrayRef<Attribute>().begin();
993 return pImpl->begin(Slot);
996 AttributeSet::iterator AttributeSet::end(unsigned Slot) const {
998 return ArrayRef<Attribute>().end();
999 return pImpl->end(Slot);
1002 //===----------------------------------------------------------------------===//
1003 // AttributeSet Introspection Methods
1004 //===----------------------------------------------------------------------===//
1006 /// \brief Return the number of slots used in this attribute list. This is the
1007 /// number of arguments that have an attribute set on them (including the
1008 /// function itself).
1009 unsigned AttributeSet::getNumSlots() const {
1010 return pImpl ? pImpl->getNumAttributes() : 0;
1013 unsigned AttributeSet::getSlotIndex(unsigned Slot) const {
1014 assert(pImpl && Slot < pImpl->getNumAttributes() &&
1015 "Slot # out of range!");
1016 return pImpl->getSlotIndex(Slot);
1019 AttributeSet AttributeSet::getSlotAttributes(unsigned Slot) const {
1020 assert(pImpl && Slot < pImpl->getNumAttributes() &&
1021 "Slot # out of range!");
1022 return pImpl->getSlotAttributes(Slot);
1025 uint64_t AttributeSet::Raw(unsigned Index) const {
1026 // FIXME: Remove this.
1027 return pImpl ? pImpl->Raw(Index) : 0;
1030 void AttributeSet::dump() const {
1033 for (unsigned i = 0, e = getNumSlots(); i < e; ++i) {
1034 uint64_t Index = getSlotIndex(i);
1040 dbgs() << " => " << getAsString(Index) << " }\n";
1046 //===----------------------------------------------------------------------===//
1047 // AttrBuilder Method Implementations
1048 //===----------------------------------------------------------------------===//
1050 AttrBuilder::AttrBuilder(AttributeSet AS, unsigned Index)
1051 : Attrs(0), Alignment(0), StackAlignment(0), DerefBytes(0),
1052 DerefOrNullBytes(0) {
1053 AttributeSetImpl *pImpl = AS.pImpl;
1056 for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I) {
1057 if (pImpl->getSlotIndex(I) != Index) continue;
1059 for (AttributeSetImpl::iterator II = pImpl->begin(I),
1060 IE = pImpl->end(I); II != IE; ++II)
1067 void AttrBuilder::clear() {
1069 Alignment = StackAlignment = DerefBytes = DerefOrNullBytes = 0;
1072 AttrBuilder &AttrBuilder::addAttribute(Attribute::AttrKind Val) {
1073 assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1074 assert(Val != Attribute::Alignment && Val != Attribute::StackAlignment &&
1075 Val != Attribute::Dereferenceable &&
1076 "Adding integer attribute without adding a value!");
1081 AttrBuilder &AttrBuilder::addAttribute(Attribute Attr) {
1082 if (Attr.isStringAttribute()) {
1083 addAttribute(Attr.getKindAsString(), Attr.getValueAsString());
1087 Attribute::AttrKind Kind = Attr.getKindAsEnum();
1090 if (Kind == Attribute::Alignment)
1091 Alignment = Attr.getAlignment();
1092 else if (Kind == Attribute::StackAlignment)
1093 StackAlignment = Attr.getStackAlignment();
1094 else if (Kind == Attribute::Dereferenceable)
1095 DerefBytes = Attr.getDereferenceableBytes();
1096 else if (Kind == Attribute::DereferenceableOrNull)
1097 DerefOrNullBytes = Attr.getDereferenceableOrNullBytes();
1101 AttrBuilder &AttrBuilder::addAttribute(StringRef A, StringRef V) {
1102 TargetDepAttrs[A] = V;
1106 AttrBuilder &AttrBuilder::removeAttribute(Attribute::AttrKind Val) {
1107 assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1110 if (Val == Attribute::Alignment)
1112 else if (Val == Attribute::StackAlignment)
1114 else if (Val == Attribute::Dereferenceable)
1116 else if (Val == Attribute::DereferenceableOrNull)
1117 DerefOrNullBytes = 0;
1122 AttrBuilder &AttrBuilder::removeAttributes(AttributeSet A, uint64_t Index) {
1123 unsigned Slot = ~0U;
1124 for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1125 if (A.getSlotIndex(I) == Index) {
1130 assert(Slot != ~0U && "Couldn't find index in AttributeSet!");
1132 for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot); I != E; ++I) {
1133 Attribute Attr = *I;
1134 if (Attr.isEnumAttribute() || Attr.isIntAttribute()) {
1135 Attribute::AttrKind Kind = I->getKindAsEnum();
1136 Attrs[Kind] = false;
1138 if (Kind == Attribute::Alignment)
1140 else if (Kind == Attribute::StackAlignment)
1142 else if (Kind == Attribute::Dereferenceable)
1144 else if (Kind == Attribute::DereferenceableOrNull)
1145 DerefOrNullBytes = 0;
1147 assert(Attr.isStringAttribute() && "Invalid attribute type!");
1148 std::map<std::string, std::string>::iterator
1149 Iter = TargetDepAttrs.find(Attr.getKindAsString());
1150 if (Iter != TargetDepAttrs.end())
1151 TargetDepAttrs.erase(Iter);
1158 AttrBuilder &AttrBuilder::removeAttribute(StringRef A) {
1159 std::map<std::string, std::string>::iterator I = TargetDepAttrs.find(A);
1160 if (I != TargetDepAttrs.end())
1161 TargetDepAttrs.erase(I);
1165 AttrBuilder &AttrBuilder::addAlignmentAttr(unsigned Align) {
1166 if (Align == 0) return *this;
1168 assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1169 assert(Align <= 0x40000000 && "Alignment too large.");
1171 Attrs[Attribute::Alignment] = true;
1176 AttrBuilder &AttrBuilder::addStackAlignmentAttr(unsigned Align) {
1177 // Default alignment, allow the target to define how to align it.
1178 if (Align == 0) return *this;
1180 assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1181 assert(Align <= 0x100 && "Alignment too large.");
1183 Attrs[Attribute::StackAlignment] = true;
1184 StackAlignment = Align;
1188 AttrBuilder &AttrBuilder::addDereferenceableAttr(uint64_t Bytes) {
1189 if (Bytes == 0) return *this;
1191 Attrs[Attribute::Dereferenceable] = true;
1196 AttrBuilder &AttrBuilder::addDereferenceableOrNullAttr(uint64_t Bytes) {
1200 Attrs[Attribute::DereferenceableOrNull] = true;
1201 DerefOrNullBytes = Bytes;
1205 AttrBuilder &AttrBuilder::merge(const AttrBuilder &B) {
1206 // FIXME: What if both have alignments, but they don't match?!
1208 Alignment = B.Alignment;
1210 if (!StackAlignment)
1211 StackAlignment = B.StackAlignment;
1214 DerefBytes = B.DerefBytes;
1218 for (td_const_iterator I = B.TargetDepAttrs.begin(),
1219 E = B.TargetDepAttrs.end(); I != E; ++I)
1220 TargetDepAttrs[I->first] = I->second;
1225 bool AttrBuilder::contains(StringRef A) const {
1226 return TargetDepAttrs.find(A) != TargetDepAttrs.end();
1229 bool AttrBuilder::hasAttributes() const {
1230 return !Attrs.none() || !TargetDepAttrs.empty();
1233 bool AttrBuilder::hasAttributes(AttributeSet A, uint64_t Index) const {
1234 unsigned Slot = ~0U;
1235 for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1236 if (A.getSlotIndex(I) == Index) {
1241 assert(Slot != ~0U && "Couldn't find the index!");
1243 for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot);
1245 Attribute Attr = *I;
1246 if (Attr.isEnumAttribute() || Attr.isIntAttribute()) {
1247 if (Attrs[I->getKindAsEnum()])
1250 assert(Attr.isStringAttribute() && "Invalid attribute kind!");
1251 return TargetDepAttrs.find(Attr.getKindAsString())!=TargetDepAttrs.end();
1258 bool AttrBuilder::hasAlignmentAttr() const {
1259 return Alignment != 0;
1262 bool AttrBuilder::operator==(const AttrBuilder &B) {
1263 if (Attrs != B.Attrs)
1266 for (td_const_iterator I = TargetDepAttrs.begin(),
1267 E = TargetDepAttrs.end(); I != E; ++I)
1268 if (B.TargetDepAttrs.find(I->first) == B.TargetDepAttrs.end())
1271 return Alignment == B.Alignment && StackAlignment == B.StackAlignment &&
1272 DerefBytes == B.DerefBytes;
1275 AttrBuilder &AttrBuilder::addRawValue(uint64_t Val) {
1276 // FIXME: Remove this in 4.0.
1277 if (!Val) return *this;
1279 for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1280 I = Attribute::AttrKind(I + 1)) {
1281 if (I == Attribute::Dereferenceable ||
1282 I == Attribute::DereferenceableOrNull)
1284 if (uint64_t A = (Val & AttributeImpl::getAttrMask(I))) {
1287 if (I == Attribute::Alignment)
1288 Alignment = 1ULL << ((A >> 16) - 1);
1289 else if (I == Attribute::StackAlignment)
1290 StackAlignment = 1ULL << ((A >> 26)-1);
1297 //===----------------------------------------------------------------------===//
1298 // AttributeFuncs Function Defintions
1299 //===----------------------------------------------------------------------===//
1301 /// \brief Which attributes cannot be applied to a type.
1302 AttributeSet AttributeFuncs::typeIncompatible(Type *Ty, uint64_t Index) {
1303 AttrBuilder Incompatible;
1305 if (!Ty->isIntegerTy())
1306 // Attribute that only apply to integers.
1307 Incompatible.addAttribute(Attribute::SExt)
1308 .addAttribute(Attribute::ZExt);
1310 if (!Ty->isPointerTy())
1311 // Attribute that only apply to pointers.
1312 Incompatible.addAttribute(Attribute::ByVal)
1313 .addAttribute(Attribute::Nest)
1314 .addAttribute(Attribute::NoAlias)
1315 .addAttribute(Attribute::NoCapture)
1316 .addAttribute(Attribute::NonNull)
1317 .addDereferenceableAttr(1) // the int here is ignored
1318 .addDereferenceableOrNullAttr(1) // the int here is ignored
1319 .addAttribute(Attribute::ReadNone)
1320 .addAttribute(Attribute::ReadOnly)
1321 .addAttribute(Attribute::StructRet)
1322 .addAttribute(Attribute::InAlloca);
1324 return AttributeSet::get(Ty->getContext(), Index, Incompatible);