1//===-- Attributes.cpp - Implement AttributesList -------------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// \file
11// \brief This file implements the Attribute, AttributeImpl, AttrBuilder,
12// AttributeSetImpl, and AttributeSet classes.
13//
14//===----------------------------------------------------------------------===//
15
16#include "llvm/IR/Attributes.h"
17#include "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"
27#include <algorithm>
28using namespace llvm;
29
30//===----------------------------------------------------------------------===//
31// Attribute Construction Methods
32//===----------------------------------------------------------------------===//
33
34Attribute Attribute::get(LLVMContext &Context, Attribute::AttrKind Kind,
35                         uint64_t Val) {
36  LLVMContextImpl *pImpl = Context.pImpl;
37  FoldingSetNodeID ID;
38  ID.AddInteger(Kind);
39  if (Val) ID.AddInteger(Val);
40
41  void *InsertPoint;
42  AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
43
44  if (!PA) {
45    // If we didn't find any existing attributes of the same shape then create a
46    // new one and insert it.
47    if (!Val)
48      PA = new EnumAttributeImpl(Kind);
49    else
50      PA = new AlignAttributeImpl(Kind, Val);
51    pImpl->AttrsSet.InsertNode(PA, InsertPoint);
52  }
53
54  // Return the Attribute that we found or created.
55  return Attribute(PA);
56}
57
58Attribute Attribute::get(LLVMContext &Context, StringRef Kind, StringRef Val) {
59  LLVMContextImpl *pImpl = Context.pImpl;
60  FoldingSetNodeID ID;
61  ID.AddString(Kind);
62  if (!Val.empty()) ID.AddString(Val);
63
64  void *InsertPoint;
65  AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
66
67  if (!PA) {
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);
72  }
73
74  // Return the Attribute that we found or created.
75  return Attribute(PA);
76}
77
78Attribute 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);
82}
83
84Attribute Attribute::getWithStackAlignment(LLVMContext &Context,
85                                           uint64_t Align) {
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);
89}
90
91//===----------------------------------------------------------------------===//
92// Attribute Accessor Methods
93//===----------------------------------------------------------------------===//
94
95bool Attribute::isEnumAttribute() const {
96  return pImpl && pImpl->isEnumAttribute();
97}
98
99bool Attribute::isAlignAttribute() const {
100  return pImpl && pImpl->isAlignAttribute();
101}
102
103bool Attribute::isStringAttribute() const {
104  return pImpl && pImpl->isStringAttribute();
105}
106
107Attribute::AttrKind Attribute::getKindAsEnum() const {
108  if (!pImpl) return None;
109  assert((isEnumAttribute() || isAlignAttribute()) &&
110         "Invalid attribute type to get the kind as an enum!");
111  return pImpl ? pImpl->getKindAsEnum() : None;
112}
113
114uint64_t Attribute::getValueAsInt() const {
115  if (!pImpl) return 0;
116  assert(isAlignAttribute() &&
117         "Expected the attribute to be an alignment attribute!");
118  return pImpl ? pImpl->getValueAsInt() : 0;
119}
120
121StringRef Attribute::getKindAsString() const {
122  if (!pImpl) return StringRef();
123  assert(isStringAttribute() &&
124         "Invalid attribute type to get the kind as a string!");
125  return pImpl ? pImpl->getKindAsString() : StringRef();
126}
127
128StringRef Attribute::getValueAsString() const {
129  if (!pImpl) return StringRef();
130  assert(isStringAttribute() &&
131         "Invalid attribute type to get the value as a string!");
132  return pImpl ? pImpl->getValueAsString() : StringRef();
133}
134
135bool Attribute::hasAttribute(AttrKind Kind) const {
136  return (pImpl && pImpl->hasAttribute(Kind)) || (!pImpl && Kind == None);
137}
138
139bool Attribute::hasAttribute(StringRef Kind) const {
140  if (!isStringAttribute()) return false;
141  return pImpl && pImpl->hasAttribute(Kind);
142}
143
144/// This returns the alignment field of an attribute as a byte alignment value.
145unsigned Attribute::getAlignment() const {
146  assert(hasAttribute(Attribute::Alignment) &&
147         "Trying to get alignment from non-alignment attribute!");
148  return pImpl->getValueAsInt();
149}
150
151/// This returns the stack alignment field of an attribute as a byte alignment
152/// value.
153unsigned Attribute::getStackAlignment() const {
154  assert(hasAttribute(Attribute::StackAlignment) &&
155         "Trying to get alignment from non-alignment attribute!");
156  return pImpl->getValueAsInt();
157}
158
159std::string Attribute::getAsString(bool InAttrGrp) const {
160  if (!pImpl) return "";
161
162  if (hasAttribute(Attribute::SanitizeAddress))
163    return "sanitize_address";
164  if (hasAttribute(Attribute::AlwaysInline))
165    return "alwaysinline";
166  if (hasAttribute(Attribute::Builtin))
167    return "builtin";
168  if (hasAttribute(Attribute::ByVal))
169    return "byval";
170  if (hasAttribute(Attribute::InAlloca))
171    return "inalloca";
172  if (hasAttribute(Attribute::InlineHint))
173    return "inlinehint";
174  if (hasAttribute(Attribute::InReg))
175    return "inreg";
176  if (hasAttribute(Attribute::JumpTable))
177    return "jumptable";
178  if (hasAttribute(Attribute::MinSize))
179    return "minsize";
180  if (hasAttribute(Attribute::Naked))
181    return "naked";
182  if (hasAttribute(Attribute::Nest))
183    return "nest";
184  if (hasAttribute(Attribute::NoAlias))
185    return "noalias";
186  if (hasAttribute(Attribute::NoBuiltin))
187    return "nobuiltin";
188  if (hasAttribute(Attribute::NoCapture))
189    return "nocapture";
190  if (hasAttribute(Attribute::NoDuplicate))
191    return "noduplicate";
192  if (hasAttribute(Attribute::NoImplicitFloat))
193    return "noimplicitfloat";
194  if (hasAttribute(Attribute::NoInline))
195    return "noinline";
196  if (hasAttribute(Attribute::NonLazyBind))
197    return "nonlazybind";
198  if (hasAttribute(Attribute::NonNull))
199    return "nonnull";
200  if (hasAttribute(Attribute::NoRedZone))
201    return "noredzone";
202  if (hasAttribute(Attribute::NoReturn))
203    return "noreturn";
204  if (hasAttribute(Attribute::NoUnwind))
205    return "nounwind";
206  if (hasAttribute(Attribute::OptimizeNone))
207    return "optnone";
208  if (hasAttribute(Attribute::OptimizeForSize))
209    return "optsize";
210  if (hasAttribute(Attribute::ReadNone))
211    return "readnone";
212  if (hasAttribute(Attribute::ReadOnly))
213    return "readonly";
214  if (hasAttribute(Attribute::Returned))
215    return "returned";
216  if (hasAttribute(Attribute::ReturnsTwice))
217    return "returns_twice";
218  if (hasAttribute(Attribute::SExt))
219    return "signext";
220  if (hasAttribute(Attribute::StackProtect))
221    return "ssp";
222  if (hasAttribute(Attribute::StackProtectReq))
223    return "sspreq";
224  if (hasAttribute(Attribute::StackProtectStrong))
225    return "sspstrong";
226  if (hasAttribute(Attribute::StructRet))
227    return "sret";
228  if (hasAttribute(Attribute::SanitizeThread))
229    return "sanitize_thread";
230  if (hasAttribute(Attribute::SanitizeMemory))
231    return "sanitize_memory";
232  if (hasAttribute(Attribute::UWTable))
233    return "uwtable";
234  if (hasAttribute(Attribute::ZExt))
235    return "zeroext";
236  if (hasAttribute(Attribute::Cold))
237    return "cold";
238
239  // FIXME: These should be output like this:
240  //
241  //   align=4
242  //   alignstack=8
243  //
244  if (hasAttribute(Attribute::Alignment)) {
245    std::string Result;
246    Result += "align";
247    Result += (InAttrGrp) ? "=" : " ";
248    Result += utostr(getValueAsInt());
249    return Result;
250  }
251
252  if (hasAttribute(Attribute::StackAlignment)) {
253    std::string Result;
254    Result += "alignstack";
255    if (InAttrGrp) {
256      Result += "=";
257      Result += utostr(getValueAsInt());
258    } else {
259      Result += "(";
260      Result += utostr(getValueAsInt());
261      Result += ")";
262    }
263    return Result;
264  }
265
266  // Convert target-dependent attributes to strings of the form:
267  //
268  //   "kind"
269  //   "kind" = "value"
270  //
271  if (isStringAttribute()) {
272    std::string Result;
273    Result += '\"' + getKindAsString().str() + '"';
274
275    StringRef Val = pImpl->getValueAsString();
276    if (Val.empty()) return Result;
277
278    Result += "=\"" + Val.str() + '"';
279    return Result;
280  }
281
282  llvm_unreachable("Unknown attribute");
283}
284
285bool Attribute::operator<(Attribute A) const {
286  if (!pImpl && !A.pImpl) return false;
287  if (!pImpl) return true;
288  if (!A.pImpl) return false;
289  return *pImpl < *A.pImpl;
290}
291
292//===----------------------------------------------------------------------===//
293// AttributeImpl Definition
294//===----------------------------------------------------------------------===//
295
296// Pin the vtables to this file.
297AttributeImpl::~AttributeImpl() {}
298void EnumAttributeImpl::anchor() {}
299void AlignAttributeImpl::anchor() {}
300void StringAttributeImpl::anchor() {}
301
302bool AttributeImpl::hasAttribute(Attribute::AttrKind A) const {
303  if (isStringAttribute()) return false;
304  return getKindAsEnum() == A;
305}
306
307bool AttributeImpl::hasAttribute(StringRef Kind) const {
308  if (!isStringAttribute()) return false;
309  return getKindAsString() == Kind;
310}
311
312Attribute::AttrKind AttributeImpl::getKindAsEnum() const {
313  assert(isEnumAttribute() || isAlignAttribute());
314  return static_cast<const EnumAttributeImpl *>(this)->getEnumKind();
315}
316
317uint64_t AttributeImpl::getValueAsInt() const {
318  assert(isAlignAttribute());
319  return static_cast<const AlignAttributeImpl *>(this)->getAlignment();
320}
321
322StringRef AttributeImpl::getKindAsString() const {
323  assert(isStringAttribute());
324  return static_cast<const StringAttributeImpl *>(this)->getStringKind();
325}
326
327StringRef AttributeImpl::getValueAsString() const {
328  assert(isStringAttribute());
329  return static_cast<const StringAttributeImpl *>(this)->getStringValue();
330}
331
332bool AttributeImpl::operator<(const AttributeImpl &AI) const {
333  // This sorts the attributes with Attribute::AttrKinds coming first (sorted
334  // relative to their enum value) and then strings.
335  if (isEnumAttribute()) {
336    if (AI.isEnumAttribute()) return getKindAsEnum() < AI.getKindAsEnum();
337    if (AI.isAlignAttribute()) return true;
338    if (AI.isStringAttribute()) return true;
339  }
340
341  if (isAlignAttribute()) {
342    if (AI.isEnumAttribute()) return false;
343    if (AI.isAlignAttribute()) return getValueAsInt() < AI.getValueAsInt();
344    if (AI.isStringAttribute()) return true;
345  }
346
347  if (AI.isEnumAttribute()) return false;
348  if (AI.isAlignAttribute()) return false;
349  if (getKindAsString() == AI.getKindAsString())
350    return getValueAsString() < AI.getValueAsString();
351  return getKindAsString() < AI.getKindAsString();
352}
353
354uint64_t AttributeImpl::getAttrMask(Attribute::AttrKind Val) {
355  // FIXME: Remove this.
356  switch (Val) {
357  case Attribute::EndAttrKinds:
358    llvm_unreachable("Synthetic enumerators which should never get here");
359
360  case Attribute::None:            return 0;
361  case Attribute::ZExt:            return 1 << 0;
362  case Attribute::SExt:            return 1 << 1;
363  case Attribute::NoReturn:        return 1 << 2;
364  case Attribute::InReg:           return 1 << 3;
365  case Attribute::StructRet:       return 1 << 4;
366  case Attribute::NoUnwind:        return 1 << 5;
367  case Attribute::NoAlias:         return 1 << 6;
368  case Attribute::ByVal:           return 1 << 7;
369  case Attribute::Nest:            return 1 << 8;
370  case Attribute::ReadNone:        return 1 << 9;
371  case Attribute::ReadOnly:        return 1 << 10;
372  case Attribute::NoInline:        return 1 << 11;
373  case Attribute::AlwaysInline:    return 1 << 12;
374  case Attribute::OptimizeForSize: return 1 << 13;
375  case Attribute::StackProtect:    return 1 << 14;
376  case Attribute::StackProtectReq: return 1 << 15;
377  case Attribute::Alignment:       return 31 << 16;
378  case Attribute::NoCapture:       return 1 << 21;
379  case Attribute::NoRedZone:       return 1 << 22;
380  case Attribute::NoImplicitFloat: return 1 << 23;
381  case Attribute::Naked:           return 1 << 24;
382  case Attribute::InlineHint:      return 1 << 25;
383  case Attribute::StackAlignment:  return 7 << 26;
384  case Attribute::ReturnsTwice:    return 1 << 29;
385  case Attribute::UWTable:         return 1 << 30;
386  case Attribute::NonLazyBind:     return 1U << 31;
387  case Attribute::SanitizeAddress: return 1ULL << 32;
388  case Attribute::MinSize:         return 1ULL << 33;
389  case Attribute::NoDuplicate:     return 1ULL << 34;
390  case Attribute::StackProtectStrong: return 1ULL << 35;
391  case Attribute::SanitizeThread:  return 1ULL << 36;
392  case Attribute::SanitizeMemory:  return 1ULL << 37;
393  case Attribute::NoBuiltin:       return 1ULL << 38;
394  case Attribute::Returned:        return 1ULL << 39;
395  case Attribute::Cold:            return 1ULL << 40;
396  case Attribute::Builtin:         return 1ULL << 41;
397  case Attribute::OptimizeNone:    return 1ULL << 42;
398  case Attribute::InAlloca:        return 1ULL << 43;
399  case Attribute::NonNull:         return 1ULL << 44;
400  case Attribute::JumpTable:       return 1ULL << 45;
401  }
402  llvm_unreachable("Unsupported attribute type");
403}
404
405//===----------------------------------------------------------------------===//
406// AttributeSetNode Definition
407//===----------------------------------------------------------------------===//
408
409AttributeSetNode *AttributeSetNode::get(LLVMContext &C,
410                                        ArrayRef<Attribute> Attrs) {
411  if (Attrs.empty())
412    return nullptr;
413
414  // Otherwise, build a key to look up the existing attributes.
415  LLVMContextImpl *pImpl = C.pImpl;
416  FoldingSetNodeID ID;
417
418  SmallVector<Attribute, 8> SortedAttrs(Attrs.begin(), Attrs.end());
419  array_pod_sort(SortedAttrs.begin(), SortedAttrs.end());
420
421  for (SmallVectorImpl<Attribute>::iterator I = SortedAttrs.begin(),
422         E = SortedAttrs.end(); I != E; ++I)
423    I->Profile(ID);
424
425  void *InsertPoint;
426  AttributeSetNode *PA =
427    pImpl->AttrsSetNodes.FindNodeOrInsertPos(ID, InsertPoint);
428
429  // If we didn't find any existing attributes of the same shape then create a
430  // new one and insert it.
431  if (!PA) {
432    // Coallocate entries after the AttributeSetNode itself.
433    void *Mem = ::operator new(sizeof(AttributeSetNode) +
434                               sizeof(Attribute) * SortedAttrs.size());
435    PA = new (Mem) AttributeSetNode(SortedAttrs);
436    pImpl->AttrsSetNodes.InsertNode(PA, InsertPoint);
437  }
438
439  // Return the AttributesListNode that we found or created.
440  return PA;
441}
442
443bool AttributeSetNode::hasAttribute(Attribute::AttrKind Kind) const {
444  for (iterator I = begin(), E = end(); I != E; ++I)
445    if (I->hasAttribute(Kind))
446      return true;
447  return false;
448}
449
450bool AttributeSetNode::hasAttribute(StringRef Kind) const {
451  for (iterator I = begin(), E = end(); I != E; ++I)
452    if (I->hasAttribute(Kind))
453      return true;
454  return false;
455}
456
457Attribute AttributeSetNode::getAttribute(Attribute::AttrKind Kind) const {
458  for (iterator I = begin(), E = end(); I != E; ++I)
459    if (I->hasAttribute(Kind))
460      return *I;
461  return Attribute();
462}
463
464Attribute AttributeSetNode::getAttribute(StringRef Kind) const {
465  for (iterator I = begin(), E = end(); I != E; ++I)
466    if (I->hasAttribute(Kind))
467      return *I;
468  return Attribute();
469}
470
471unsigned AttributeSetNode::getAlignment() const {
472  for (iterator I = begin(), E = end(); I != E; ++I)
473    if (I->hasAttribute(Attribute::Alignment))
474      return I->getAlignment();
475  return 0;
476}
477
478unsigned AttributeSetNode::getStackAlignment() const {
479  for (iterator I = begin(), E = end(); I != E; ++I)
480    if (I->hasAttribute(Attribute::StackAlignment))
481      return I->getStackAlignment();
482  return 0;
483}
484
485std::string AttributeSetNode::getAsString(bool InAttrGrp) const {
486  std::string Str;
487  for (iterator I = begin(), E = end(); I != E; ++I) {
488    if (I != begin())
489      Str += ' ';
490    Str += I->getAsString(InAttrGrp);
491  }
492  return Str;
493}
494
495//===----------------------------------------------------------------------===//
496// AttributeSetImpl Definition
497//===----------------------------------------------------------------------===//
498
499uint64_t AttributeSetImpl::Raw(unsigned Index) const {
500  for (unsigned I = 0, E = getNumAttributes(); I != E; ++I) {
501    if (getSlotIndex(I) != Index) continue;
502    const AttributeSetNode *ASN = getSlotNode(I);
503    uint64_t Mask = 0;
504
505    for (AttributeSetNode::iterator II = ASN->begin(),
506           IE = ASN->end(); II != IE; ++II) {
507      Attribute Attr = *II;
508
509      // This cannot handle string attributes.
510      if (Attr.isStringAttribute()) continue;
511
512      Attribute::AttrKind Kind = Attr.getKindAsEnum();
513
514      if (Kind == Attribute::Alignment)
515        Mask |= (Log2_32(ASN->getAlignment()) + 1) << 16;
516      else if (Kind == Attribute::StackAlignment)
517        Mask |= (Log2_32(ASN->getStackAlignment()) + 1) << 26;
518      else
519        Mask |= AttributeImpl::getAttrMask(Kind);
520    }
521
522    return Mask;
523  }
524
525  return 0;
526}
527
528void AttributeSetImpl::dump() const {
529  AttributeSet(const_cast<AttributeSetImpl *>(this)).dump();
530}
531
532//===----------------------------------------------------------------------===//
533// AttributeSet Construction and Mutation Methods
534//===----------------------------------------------------------------------===//
535
536AttributeSet
537AttributeSet::getImpl(LLVMContext &C,
538                      ArrayRef<std::pair<unsigned, AttributeSetNode*> > Attrs) {
539  LLVMContextImpl *pImpl = C.pImpl;
540  FoldingSetNodeID ID;
541  AttributeSetImpl::Profile(ID, Attrs);
542
543  void *InsertPoint;
544  AttributeSetImpl *PA = pImpl->AttrsLists.FindNodeOrInsertPos(ID, InsertPoint);
545
546  // If we didn't find any existing attributes of the same shape then
547  // create a new one and insert it.
548  if (!PA) {
549    // Coallocate entries after the AttributeSetImpl itself.
550    void *Mem = ::operator new(sizeof(AttributeSetImpl) +
551                               sizeof(std::pair<unsigned, AttributeSetNode *>) *
552                                   Attrs.size());
553    PA = new (Mem) AttributeSetImpl(C, Attrs);
554    pImpl->AttrsLists.InsertNode(PA, InsertPoint);
555  }
556
557  // Return the AttributesList that we found or created.
558  return AttributeSet(PA);
559}
560
561AttributeSet AttributeSet::get(LLVMContext &C,
562                               ArrayRef<std::pair<unsigned, Attribute> > Attrs){
563  // If there are no attributes then return a null AttributesList pointer.
564  if (Attrs.empty())
565    return AttributeSet();
566
567#ifndef NDEBUG
568  for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
569    assert((!i || Attrs[i-1].first <= Attrs[i].first) &&
570           "Misordered Attributes list!");
571    assert(!Attrs[i].second.hasAttribute(Attribute::None) &&
572           "Pointless attribute!");
573  }
574#endif
575
576  // Create a vector if (unsigned, AttributeSetNode*) pairs from the attributes
577  // list.
578  SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrPairVec;
579  for (ArrayRef<std::pair<unsigned, Attribute> >::iterator I = Attrs.begin(),
580         E = Attrs.end(); I != E; ) {
581    unsigned Index = I->first;
582    SmallVector<Attribute, 4> AttrVec;
583    while (I != E && I->first == Index) {
584      AttrVec.push_back(I->second);
585      ++I;
586    }
587
588    AttrPairVec.push_back(std::make_pair(Index,
589                                         AttributeSetNode::get(C, AttrVec)));
590  }
591
592  return getImpl(C, AttrPairVec);
593}
594
595AttributeSet AttributeSet::get(LLVMContext &C,
596                               ArrayRef<std::pair<unsigned,
597                                                  AttributeSetNode*> > Attrs) {
598  // If there are no attributes then return a null AttributesList pointer.
599  if (Attrs.empty())
600    return AttributeSet();
601
602  return getImpl(C, Attrs);
603}
604
605AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
606                               const AttrBuilder &B) {
607  if (!B.hasAttributes())
608    return AttributeSet();
609
610  // Add target-independent attributes.
611  SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
612  for (Attribute::AttrKind Kind = Attribute::None;
613       Kind != Attribute::EndAttrKinds; Kind = Attribute::AttrKind(Kind + 1)) {
614    if (!B.contains(Kind))
615      continue;
616
617    if (Kind == Attribute::Alignment)
618      Attrs.push_back(std::make_pair(Index, Attribute::
619                                     getWithAlignment(C, B.getAlignment())));
620    else if (Kind == Attribute::StackAlignment)
621      Attrs.push_back(std::make_pair(Index, Attribute::
622                              getWithStackAlignment(C, B.getStackAlignment())));
623    else
624      Attrs.push_back(std::make_pair(Index, Attribute::get(C, Kind)));
625  }
626
627  // Add target-dependent (string) attributes.
628  for (const AttrBuilder::td_type &TDA : B.td_attrs())
629    Attrs.push_back(
630        std::make_pair(Index, Attribute::get(C, TDA.first, TDA.second)));
631
632  return get(C, Attrs);
633}
634
635AttributeSet AttributeSet::get(LLVMContext &C, unsigned Index,
636                               ArrayRef<Attribute::AttrKind> Kind) {
637  SmallVector<std::pair<unsigned, Attribute>, 8> Attrs;
638  for (ArrayRef<Attribute::AttrKind>::iterator I = Kind.begin(),
639         E = Kind.end(); I != E; ++I)
640    Attrs.push_back(std::make_pair(Index, Attribute::get(C, *I)));
641  return get(C, Attrs);
642}
643
644AttributeSet AttributeSet::get(LLVMContext &C, ArrayRef<AttributeSet> Attrs) {
645  if (Attrs.empty()) return AttributeSet();
646  if (Attrs.size() == 1) return Attrs[0];
647
648  SmallVector<std::pair<unsigned, AttributeSetNode*>, 8> AttrNodeVec;
649  AttributeSetImpl *A0 = Attrs[0].pImpl;
650  if (A0)
651    AttrNodeVec.append(A0->getNode(0), A0->getNode(A0->getNumAttributes()));
652  // Copy all attributes from Attrs into AttrNodeVec while keeping AttrNodeVec
653  // ordered by index.  Because we know that each list in Attrs is ordered by
654  // index we only need to merge each successive list in rather than doing a
655  // full sort.
656  for (unsigned I = 1, E = Attrs.size(); I != E; ++I) {
657    AttributeSetImpl *AS = Attrs[I].pImpl;
658    if (!AS) continue;
659    SmallVector<std::pair<unsigned, AttributeSetNode *>, 8>::iterator
660      ANVI = AttrNodeVec.begin(), ANVE;
661    for (const AttributeSetImpl::IndexAttrPair
662             *AI = AS->getNode(0),
663             *AE = AS->getNode(AS->getNumAttributes());
664         AI != AE; ++AI) {
665      ANVE = AttrNodeVec.end();
666      while (ANVI != ANVE && ANVI->first <= AI->first)
667        ++ANVI;
668      ANVI = AttrNodeVec.insert(ANVI, *AI) + 1;
669    }
670  }
671
672  return getImpl(C, AttrNodeVec);
673}
674
675AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
676                                        Attribute::AttrKind Attr) const {
677  if (hasAttribute(Index, Attr)) return *this;
678  return addAttributes(C, Index, AttributeSet::get(C, Index, Attr));
679}
680
681AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
682                                        StringRef Kind) const {
683  llvm::AttrBuilder B;
684  B.addAttribute(Kind);
685  return addAttributes(C, Index, AttributeSet::get(C, Index, B));
686}
687
688AttributeSet AttributeSet::addAttribute(LLVMContext &C, unsigned Index,
689                                        StringRef Kind, StringRef Value) const {
690  llvm::AttrBuilder B;
691  B.addAttribute(Kind, Value);
692  return addAttributes(C, Index, AttributeSet::get(C, Index, B));
693}
694
695AttributeSet AttributeSet::addAttributes(LLVMContext &C, unsigned Index,
696                                         AttributeSet Attrs) const {
697  if (!pImpl) return Attrs;
698  if (!Attrs.pImpl) return *this;
699
700#ifndef NDEBUG
701  // FIXME it is not obvious how this should work for alignment. For now, say
702  // we can't change a known alignment.
703  unsigned OldAlign = getParamAlignment(Index);
704  unsigned NewAlign = Attrs.getParamAlignment(Index);
705  assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
706         "Attempt to change alignment!");
707#endif
708
709  // Add the attribute slots before the one we're trying to add.
710  SmallVector<AttributeSet, 4> AttrSet;
711  uint64_t NumAttrs = pImpl->getNumAttributes();
712  AttributeSet AS;
713  uint64_t LastIndex = 0;
714  for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
715    if (getSlotIndex(I) >= Index) {
716      if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
717      break;
718    }
719    LastIndex = I + 1;
720    AttrSet.push_back(getSlotAttributes(I));
721  }
722
723  // Now add the attribute into the correct slot. There may already be an
724  // AttributeSet there.
725  AttrBuilder B(AS, Index);
726
727  for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
728    if (Attrs.getSlotIndex(I) == Index) {
729      for (AttributeSetImpl::iterator II = Attrs.pImpl->begin(I),
730             IE = Attrs.pImpl->end(I); II != IE; ++II)
731        B.addAttribute(*II);
732      break;
733    }
734
735  AttrSet.push_back(AttributeSet::get(C, Index, B));
736
737  // Add the remaining attribute slots.
738  for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
739    AttrSet.push_back(getSlotAttributes(I));
740
741  return get(C, AttrSet);
742}
743
744AttributeSet AttributeSet::removeAttribute(LLVMContext &C, unsigned Index,
745                                           Attribute::AttrKind Attr) const {
746  if (!hasAttribute(Index, Attr)) return *this;
747  return removeAttributes(C, Index, AttributeSet::get(C, Index, Attr));
748}
749
750AttributeSet AttributeSet::removeAttributes(LLVMContext &C, unsigned Index,
751                                            AttributeSet Attrs) const {
752  if (!pImpl) return AttributeSet();
753  if (!Attrs.pImpl) return *this;
754
755#ifndef NDEBUG
756  // FIXME it is not obvious how this should work for alignment.
757  // For now, say we can't pass in alignment, which no current use does.
758  assert(!Attrs.hasAttribute(Index, Attribute::Alignment) &&
759         "Attempt to change alignment!");
760#endif
761
762  // Add the attribute slots before the one we're trying to add.
763  SmallVector<AttributeSet, 4> AttrSet;
764  uint64_t NumAttrs = pImpl->getNumAttributes();
765  AttributeSet AS;
766  uint64_t LastIndex = 0;
767  for (unsigned I = 0, E = NumAttrs; I != E; ++I) {
768    if (getSlotIndex(I) >= Index) {
769      if (getSlotIndex(I) == Index) AS = getSlotAttributes(LastIndex++);
770      break;
771    }
772    LastIndex = I + 1;
773    AttrSet.push_back(getSlotAttributes(I));
774  }
775
776  // Now remove the attribute from the correct slot. There may already be an
777  // AttributeSet there.
778  AttrBuilder B(AS, Index);
779
780  for (unsigned I = 0, E = Attrs.pImpl->getNumAttributes(); I != E; ++I)
781    if (Attrs.getSlotIndex(I) == Index) {
782      B.removeAttributes(Attrs.pImpl->getSlotAttributes(I), Index);
783      break;
784    }
785
786  AttrSet.push_back(AttributeSet::get(C, Index, B));
787
788  // Add the remaining attribute slots.
789  for (unsigned I = LastIndex, E = NumAttrs; I < E; ++I)
790    AttrSet.push_back(getSlotAttributes(I));
791
792  return get(C, AttrSet);
793}
794
795//===----------------------------------------------------------------------===//
796// AttributeSet Accessor Methods
797//===----------------------------------------------------------------------===//
798
799LLVMContext &AttributeSet::getContext() const {
800  return pImpl->getContext();
801}
802
803AttributeSet AttributeSet::getParamAttributes(unsigned Index) const {
804  return pImpl && hasAttributes(Index) ?
805    AttributeSet::get(pImpl->getContext(),
806                      ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
807                        std::make_pair(Index, getAttributes(Index)))) :
808    AttributeSet();
809}
810
811AttributeSet AttributeSet::getRetAttributes() const {
812  return pImpl && hasAttributes(ReturnIndex) ?
813    AttributeSet::get(pImpl->getContext(),
814                      ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
815                        std::make_pair(ReturnIndex,
816                                       getAttributes(ReturnIndex)))) :
817    AttributeSet();
818}
819
820AttributeSet AttributeSet::getFnAttributes() const {
821  return pImpl && hasAttributes(FunctionIndex) ?
822    AttributeSet::get(pImpl->getContext(),
823                      ArrayRef<std::pair<unsigned, AttributeSetNode*> >(
824                        std::make_pair(FunctionIndex,
825                                       getAttributes(FunctionIndex)))) :
826    AttributeSet();
827}
828
829bool AttributeSet::hasAttribute(unsigned Index, Attribute::AttrKind Kind) const{
830  AttributeSetNode *ASN = getAttributes(Index);
831  return ASN ? ASN->hasAttribute(Kind) : false;
832}
833
834bool AttributeSet::hasAttribute(unsigned Index, StringRef Kind) const {
835  AttributeSetNode *ASN = getAttributes(Index);
836  return ASN ? ASN->hasAttribute(Kind) : false;
837}
838
839bool AttributeSet::hasAttributes(unsigned Index) const {
840  AttributeSetNode *ASN = getAttributes(Index);
841  return ASN ? ASN->hasAttributes() : false;
842}
843
844/// \brief Return true if the specified attribute is set for at least one
845/// parameter or for the return value.
846bool AttributeSet::hasAttrSomewhere(Attribute::AttrKind Attr) const {
847  if (!pImpl) return false;
848
849  for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
850    for (AttributeSetImpl::iterator II = pImpl->begin(I),
851           IE = pImpl->end(I); II != IE; ++II)
852      if (II->hasAttribute(Attr))
853        return true;
854
855  return false;
856}
857
858Attribute AttributeSet::getAttribute(unsigned Index,
859                                     Attribute::AttrKind Kind) const {
860  AttributeSetNode *ASN = getAttributes(Index);
861  return ASN ? ASN->getAttribute(Kind) : Attribute();
862}
863
864Attribute AttributeSet::getAttribute(unsigned Index,
865                                     StringRef Kind) const {
866  AttributeSetNode *ASN = getAttributes(Index);
867  return ASN ? ASN->getAttribute(Kind) : Attribute();
868}
869
870unsigned AttributeSet::getParamAlignment(unsigned Index) const {
871  AttributeSetNode *ASN = getAttributes(Index);
872  return ASN ? ASN->getAlignment() : 0;
873}
874
875unsigned AttributeSet::getStackAlignment(unsigned Index) const {
876  AttributeSetNode *ASN = getAttributes(Index);
877  return ASN ? ASN->getStackAlignment() : 0;
878}
879
880std::string AttributeSet::getAsString(unsigned Index,
881                                      bool InAttrGrp) const {
882  AttributeSetNode *ASN = getAttributes(Index);
883  return ASN ? ASN->getAsString(InAttrGrp) : std::string("");
884}
885
886/// \brief The attributes for the specified index are returned.
887AttributeSetNode *AttributeSet::getAttributes(unsigned Index) const {
888  if (!pImpl) return nullptr;
889
890  // Loop through to find the attribute node we want.
891  for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I)
892    if (pImpl->getSlotIndex(I) == Index)
893      return pImpl->getSlotNode(I);
894
895  return nullptr;
896}
897
898AttributeSet::iterator AttributeSet::begin(unsigned Slot) const {
899  if (!pImpl)
900    return ArrayRef<Attribute>().begin();
901  return pImpl->begin(Slot);
902}
903
904AttributeSet::iterator AttributeSet::end(unsigned Slot) const {
905  if (!pImpl)
906    return ArrayRef<Attribute>().end();
907  return pImpl->end(Slot);
908}
909
910//===----------------------------------------------------------------------===//
911// AttributeSet Introspection Methods
912//===----------------------------------------------------------------------===//
913
914/// \brief Return the number of slots used in this attribute list.  This is the
915/// number of arguments that have an attribute set on them (including the
916/// function itself).
917unsigned AttributeSet::getNumSlots() const {
918  return pImpl ? pImpl->getNumAttributes() : 0;
919}
920
921unsigned AttributeSet::getSlotIndex(unsigned Slot) const {
922  assert(pImpl && Slot < pImpl->getNumAttributes() &&
923         "Slot # out of range!");
924  return pImpl->getSlotIndex(Slot);
925}
926
927AttributeSet AttributeSet::getSlotAttributes(unsigned Slot) const {
928  assert(pImpl && Slot < pImpl->getNumAttributes() &&
929         "Slot # out of range!");
930  return pImpl->getSlotAttributes(Slot);
931}
932
933uint64_t AttributeSet::Raw(unsigned Index) const {
934  // FIXME: Remove this.
935  return pImpl ? pImpl->Raw(Index) : 0;
936}
937
938void AttributeSet::dump() const {
939  dbgs() << "PAL[\n";
940
941  for (unsigned i = 0, e = getNumSlots(); i < e; ++i) {
942    uint64_t Index = getSlotIndex(i);
943    dbgs() << "  { ";
944    if (Index == ~0U)
945      dbgs() << "~0U";
946    else
947      dbgs() << Index;
948    dbgs() << " => " << getAsString(Index) << " }\n";
949  }
950
951  dbgs() << "]\n";
952}
953
954//===----------------------------------------------------------------------===//
955// AttrBuilder Method Implementations
956//===----------------------------------------------------------------------===//
957
958AttrBuilder::AttrBuilder(AttributeSet AS, unsigned Index)
959  : Attrs(0), Alignment(0), StackAlignment(0) {
960  AttributeSetImpl *pImpl = AS.pImpl;
961  if (!pImpl) return;
962
963  for (unsigned I = 0, E = pImpl->getNumAttributes(); I != E; ++I) {
964    if (pImpl->getSlotIndex(I) != Index) continue;
965
966    for (AttributeSetImpl::iterator II = pImpl->begin(I),
967           IE = pImpl->end(I); II != IE; ++II)
968      addAttribute(*II);
969
970    break;
971  }
972}
973
974void AttrBuilder::clear() {
975  Attrs.reset();
976  Alignment = StackAlignment = 0;
977}
978
979AttrBuilder &AttrBuilder::addAttribute(Attribute::AttrKind Val) {
980  assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
981  assert(Val != Attribute::Alignment && Val != Attribute::StackAlignment &&
982         "Adding alignment attribute without adding alignment value!");
983  Attrs[Val] = true;
984  return *this;
985}
986
987AttrBuilder &AttrBuilder::addAttribute(Attribute Attr) {
988  if (Attr.isStringAttribute()) {
989    addAttribute(Attr.getKindAsString(), Attr.getValueAsString());
990    return *this;
991  }
992
993  Attribute::AttrKind Kind = Attr.getKindAsEnum();
994  Attrs[Kind] = true;
995
996  if (Kind == Attribute::Alignment)
997    Alignment = Attr.getAlignment();
998  else if (Kind == Attribute::StackAlignment)
999    StackAlignment = Attr.getStackAlignment();
1000  return *this;
1001}
1002
1003AttrBuilder &AttrBuilder::addAttribute(StringRef A, StringRef V) {
1004  TargetDepAttrs[A] = V;
1005  return *this;
1006}
1007
1008AttrBuilder &AttrBuilder::removeAttribute(Attribute::AttrKind Val) {
1009  assert((unsigned)Val < Attribute::EndAttrKinds && "Attribute out of range!");
1010  Attrs[Val] = false;
1011
1012  if (Val == Attribute::Alignment)
1013    Alignment = 0;
1014  else if (Val == Attribute::StackAlignment)
1015    StackAlignment = 0;
1016
1017  return *this;
1018}
1019
1020AttrBuilder &AttrBuilder::removeAttributes(AttributeSet A, uint64_t Index) {
1021  unsigned Slot = ~0U;
1022  for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1023    if (A.getSlotIndex(I) == Index) {
1024      Slot = I;
1025      break;
1026    }
1027
1028  assert(Slot != ~0U && "Couldn't find index in AttributeSet!");
1029
1030  for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot); I != E; ++I) {
1031    Attribute Attr = *I;
1032    if (Attr.isEnumAttribute() || Attr.isAlignAttribute()) {
1033      Attribute::AttrKind Kind = I->getKindAsEnum();
1034      Attrs[Kind] = false;
1035
1036      if (Kind == Attribute::Alignment)
1037        Alignment = 0;
1038      else if (Kind == Attribute::StackAlignment)
1039        StackAlignment = 0;
1040    } else {
1041      assert(Attr.isStringAttribute() && "Invalid attribute type!");
1042      std::map<std::string, std::string>::iterator
1043        Iter = TargetDepAttrs.find(Attr.getKindAsString());
1044      if (Iter != TargetDepAttrs.end())
1045        TargetDepAttrs.erase(Iter);
1046    }
1047  }
1048
1049  return *this;
1050}
1051
1052AttrBuilder &AttrBuilder::removeAttribute(StringRef A) {
1053  std::map<std::string, std::string>::iterator I = TargetDepAttrs.find(A);
1054  if (I != TargetDepAttrs.end())
1055    TargetDepAttrs.erase(I);
1056  return *this;
1057}
1058
1059AttrBuilder &AttrBuilder::addAlignmentAttr(unsigned Align) {
1060  if (Align == 0) return *this;
1061
1062  assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1063  assert(Align <= 0x40000000 && "Alignment too large.");
1064
1065  Attrs[Attribute::Alignment] = true;
1066  Alignment = Align;
1067  return *this;
1068}
1069
1070AttrBuilder &AttrBuilder::addStackAlignmentAttr(unsigned Align) {
1071  // Default alignment, allow the target to define how to align it.
1072  if (Align == 0) return *this;
1073
1074  assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
1075  assert(Align <= 0x100 && "Alignment too large.");
1076
1077  Attrs[Attribute::StackAlignment] = true;
1078  StackAlignment = Align;
1079  return *this;
1080}
1081
1082AttrBuilder &AttrBuilder::merge(const AttrBuilder &B) {
1083  // FIXME: What if both have alignments, but they don't match?!
1084  if (!Alignment)
1085    Alignment = B.Alignment;
1086
1087  if (!StackAlignment)
1088    StackAlignment = B.StackAlignment;
1089
1090  Attrs |= B.Attrs;
1091
1092  for (td_const_iterator I = B.TargetDepAttrs.begin(),
1093         E = B.TargetDepAttrs.end(); I != E; ++I)
1094    TargetDepAttrs[I->first] = I->second;
1095
1096  return *this;
1097}
1098
1099bool AttrBuilder::contains(StringRef A) const {
1100  return TargetDepAttrs.find(A) != TargetDepAttrs.end();
1101}
1102
1103bool AttrBuilder::hasAttributes() const {
1104  return !Attrs.none() || !TargetDepAttrs.empty();
1105}
1106
1107bool AttrBuilder::hasAttributes(AttributeSet A, uint64_t Index) const {
1108  unsigned Slot = ~0U;
1109  for (unsigned I = 0, E = A.getNumSlots(); I != E; ++I)
1110    if (A.getSlotIndex(I) == Index) {
1111      Slot = I;
1112      break;
1113    }
1114
1115  assert(Slot != ~0U && "Couldn't find the index!");
1116
1117  for (AttributeSet::iterator I = A.begin(Slot), E = A.end(Slot);
1118       I != E; ++I) {
1119    Attribute Attr = *I;
1120    if (Attr.isEnumAttribute() || Attr.isAlignAttribute()) {
1121      if (Attrs[I->getKindAsEnum()])
1122        return true;
1123    } else {
1124      assert(Attr.isStringAttribute() && "Invalid attribute kind!");
1125      return TargetDepAttrs.find(Attr.getKindAsString())!=TargetDepAttrs.end();
1126    }
1127  }
1128
1129  return false;
1130}
1131
1132bool AttrBuilder::hasAlignmentAttr() const {
1133  return Alignment != 0;
1134}
1135
1136bool AttrBuilder::operator==(const AttrBuilder &B) {
1137  if (Attrs != B.Attrs)
1138    return false;
1139
1140  for (td_const_iterator I = TargetDepAttrs.begin(),
1141         E = TargetDepAttrs.end(); I != E; ++I)
1142    if (B.TargetDepAttrs.find(I->first) == B.TargetDepAttrs.end())
1143      return false;
1144
1145  return Alignment == B.Alignment && StackAlignment == B.StackAlignment;
1146}
1147
1148AttrBuilder &AttrBuilder::addRawValue(uint64_t Val) {
1149  // FIXME: Remove this in 4.0.
1150  if (!Val) return *this;
1151
1152  for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1153       I = Attribute::AttrKind(I + 1)) {
1154    if (uint64_t A = (Val & AttributeImpl::getAttrMask(I))) {
1155      Attrs[I] = true;
1156
1157      if (I == Attribute::Alignment)
1158        Alignment = 1ULL << ((A >> 16) - 1);
1159      else if (I == Attribute::StackAlignment)
1160        StackAlignment = 1ULL << ((A >> 26)-1);
1161    }
1162  }
1163
1164  return *this;
1165}
1166
1167//===----------------------------------------------------------------------===//
1168// AttributeFuncs Function Defintions
1169//===----------------------------------------------------------------------===//
1170
1171/// \brief Which attributes cannot be applied to a type.
1172AttributeSet AttributeFuncs::typeIncompatible(Type *Ty, uint64_t Index) {
1173  AttrBuilder Incompatible;
1174
1175  if (!Ty->isIntegerTy())
1176    // Attribute that only apply to integers.
1177    Incompatible.addAttribute(Attribute::SExt)
1178      .addAttribute(Attribute::ZExt);
1179
1180  if (!Ty->isPointerTy())
1181    // Attribute that only apply to pointers.
1182    Incompatible.addAttribute(Attribute::ByVal)
1183      .addAttribute(Attribute::Nest)
1184      .addAttribute(Attribute::NoAlias)
1185      .addAttribute(Attribute::NoCapture)
1186      .addAttribute(Attribute::NonNull)
1187      .addAttribute(Attribute::ReadNone)
1188      .addAttribute(Attribute::ReadOnly)
1189      .addAttribute(Attribute::StructRet)
1190      .addAttribute(Attribute::InAlloca);
1191
1192  return AttributeSet::get(Ty->getContext(), Index, Incompatible);
1193}
1194