lib/VMCore/Attributes.cpp

   1 //===-- Attribute.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 // This file implements the Attribute, AttributeImpl, AttrBuilder,
  11 // AttributeSetImpl, and AttributeSet classes.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Attributes.h"
  16 #include "AttributeImpl.h"
  17 #include "LLVMContextImpl.h"
  18 #include "llvm/ADT/FoldingSet.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/Support/Atomic.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/ManagedStatic.h"
  23 #include "llvm/Support/Mutex.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include "llvm/Type.h"
  26 using namespace llvm;
  27
  28 //===----------------------------------------------------------------------===//
  29 // Attribute Implementation
  30 //===----------------------------------------------------------------------===//
  31
  32 Attribute Attribute::get(LLVMContext &Context, ArrayRef<AttrVal> Vals) {
  33   AttrBuilder B;
  34   for (ArrayRef<AttrVal>::iterator I = Vals.begin(), E = Vals.end();
  35        I != E; ++I)
  36     B.addAttribute(*I);
  37   return Attribute::get(Context, B);
  38 }
  39
  40 Attribute Attribute::get(LLVMContext &Context, AttrBuilder &B) {
  41   // If there are no attributes, return an empty Attribute class.
  42   if (!B.hasAttributes())
  43     return Attribute();
  44
  45   // Otherwise, build a key to look up the existing attributes.
  46   LLVMContextImpl *pImpl = Context.pImpl;
  47   FoldingSetNodeID ID;
  48   ID.AddInteger(B.Raw());
  49
  50   void *InsertPoint;
  51   AttributeImpl *PA = pImpl->AttrsSet.FindNodeOrInsertPos(ID, InsertPoint);
  52
  53   if (!PA) {
  54     // If we didn't find any existing attributes of the same shape then create a
  55     // new one and insert it.
  56     PA = new AttributeImpl(B.Raw());
  57     pImpl->AttrsSet.InsertNode(PA, InsertPoint);
  58   }
  59
  60   // Return the AttributesList that we found or created.
  61   return Attribute(PA);
  62 }
  63
  64 bool Attribute::hasAttribute(AttrVal Val) const {
  65   return pImpl && pImpl->hasAttribute(Val);
  66 }
  67
  68 bool Attribute::hasAttributes() const {
  69   return pImpl && pImpl->hasAttributes();
  70 }
  71
  72 bool Attribute::hasAttributes(const Attribute &A) const {
  73   return pImpl && pImpl->hasAttributes(A);
  74 }
  75
  76 /// This returns the alignment field of an attribute as a byte alignment value.
  77 unsigned Attribute::getAlignment() const {
  78   if (!hasAttribute(Attribute::Alignment))
  79     return 0;
  80   return 1U << ((pImpl->getAlignment() >> 16) - 1);
  81 }
  82
  83 /// This returns the stack alignment field of an attribute as a byte alignment
  84 /// value.
  85 unsigned Attribute::getStackAlignment() const {
  86   if (!hasAttribute(Attribute::StackAlignment))
  87     return 0;
  88   return 1U << ((pImpl->getStackAlignment() >> 26) - 1);
  89 }
  90
  91 uint64_t Attribute::Raw() const {
  92   return pImpl ? pImpl->Raw() : 0;
  93 }
  94
  95 Attribute Attribute::typeIncompatible(Type *Ty) {
  96   AttrBuilder Incompatible;
  97
  98   if (!Ty->isIntegerTy())
  99     // Attribute that only apply to integers.
 100     Incompatible.addAttribute(Attribute::SExt)
 101       .addAttribute(Attribute::ZExt);
 102
 103   if (!Ty->isPointerTy())
 104     // Attribute that only apply to pointers.
 105     Incompatible.addAttribute(Attribute::ByVal)
 106       .addAttribute(Attribute::Nest)
 107       .addAttribute(Attribute::NoAlias)
 108       .addAttribute(Attribute::NoCapture)
 109       .addAttribute(Attribute::StructRet);
 110
 111   return Attribute::get(Ty->getContext(), Incompatible);
 112 }
 113
 114 /// encodeLLVMAttributesForBitcode - This returns an integer containing an
 115 /// encoding of all the LLVM attributes found in the given attribute bitset.
 116 /// Any change to this encoding is a breaking change to bitcode compatibility.
 117 uint64_t Attribute::encodeLLVMAttributesForBitcode(Attribute Attrs) {
 118   // FIXME: It doesn't make sense to store the alignment information as an
 119   // expanded out value, we should store it as a log2 value.  However, we can't
 120   // just change that here without breaking bitcode compatibility.  If this ever
 121   // becomes a problem in practice, we should introduce new tag numbers in the
 122   // bitcode file and have those tags use a more efficiently encoded alignment
 123   // field.
 124
 125   // Store the alignment in the bitcode as a 16-bit raw value instead of a 5-bit
 126   // log2 encoded value. Shift the bits above the alignment up by 11 bits.
 127   uint64_t EncodedAttrs = Attrs.Raw() & 0xffff;
 128   if (Attrs.hasAttribute(Attribute::Alignment))
 129     EncodedAttrs |= Attrs.getAlignment() << 16;
 130   EncodedAttrs |= (Attrs.Raw() & (0xffffULL << 21)) << 11;
 131   return EncodedAttrs;
 132 }
 133
 134 /// decodeLLVMAttributesForBitcode - This returns an attribute bitset containing
 135 /// the LLVM attributes that have been decoded from the given integer.  This
 136 /// function must stay in sync with 'encodeLLVMAttributesForBitcode'.
 137 Attribute Attribute::decodeLLVMAttributesForBitcode(LLVMContext &C,
 138                                                       uint64_t EncodedAttrs) {
 139   // The alignment is stored as a 16-bit raw value from bits 31--16.  We shift
 140   // the bits above 31 down by 11 bits.
 141   unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
 142   assert((!Alignment || isPowerOf2_32(Alignment)) &&
 143          "Alignment must be a power of two.");
 144
 145   AttrBuilder B(EncodedAttrs & 0xffff);
 146   if (Alignment)
 147     B.addAlignmentAttr(Alignment);
 148   B.addRawValue((EncodedAttrs & (0xffffULL << 32)) >> 11);
 149   return Attribute::get(C, B);
 150 }
 151
 152 std::string Attribute::getAsString() const {
 153   std::string Result;
 154   if (hasAttribute(Attribute::ZExt))
 155     Result += "zeroext ";
 156   if (hasAttribute(Attribute::SExt))
 157     Result += "signext ";
 158   if (hasAttribute(Attribute::NoReturn))
 159     Result += "noreturn ";
 160   if (hasAttribute(Attribute::NoUnwind))
 161     Result += "nounwind ";
 162   if (hasAttribute(Attribute::UWTable))
 163     Result += "uwtable ";
 164   if (hasAttribute(Attribute::ReturnsTwice))
 165     Result += "returns_twice ";
 166   if (hasAttribute(Attribute::InReg))
 167     Result += "inreg ";
 168   if (hasAttribute(Attribute::NoAlias))
 169     Result += "noalias ";
 170   if (hasAttribute(Attribute::NoCapture))
 171     Result += "nocapture ";
 172   if (hasAttribute(Attribute::StructRet))
 173     Result += "sret ";
 174   if (hasAttribute(Attribute::ByVal))
 175     Result += "byval ";
 176   if (hasAttribute(Attribute::Nest))
 177     Result += "nest ";
 178   if (hasAttribute(Attribute::ReadNone))
 179     Result += "readnone ";
 180   if (hasAttribute(Attribute::ReadOnly))
 181     Result += "readonly ";
 182   if (hasAttribute(Attribute::OptimizeForSize))
 183     Result += "optsize ";
 184   if (hasAttribute(Attribute::NoInline))
 185     Result += "noinline ";
 186   if (hasAttribute(Attribute::InlineHint))
 187     Result += "inlinehint ";
 188   if (hasAttribute(Attribute::AlwaysInline))
 189     Result += "alwaysinline ";
 190   if (hasAttribute(Attribute::StackProtect))
 191     Result += "ssp ";
 192   if (hasAttribute(Attribute::StackProtectReq))
 193     Result += "sspreq ";
 194   if (hasAttribute(Attribute::NoRedZone))
 195     Result += "noredzone ";
 196   if (hasAttribute(Attribute::NoImplicitFloat))
 197     Result += "noimplicitfloat ";
 198   if (hasAttribute(Attribute::Naked))
 199     Result += "naked ";
 200   if (hasAttribute(Attribute::NonLazyBind))
 201     Result += "nonlazybind ";
 202   if (hasAttribute(Attribute::AddressSafety))
 203     Result += "address_safety ";
 204   if (hasAttribute(Attribute::MinSize))
 205     Result += "minsize ";
 206   if (hasAttribute(Attribute::StackAlignment)) {
 207     Result += "alignstack(";
 208     Result += utostr(getStackAlignment());
 209     Result += ") ";
 210   }
 211   if (hasAttribute(Attribute::Alignment)) {
 212     Result += "align ";
 213     Result += utostr(getAlignment());
 214     Result += " ";
 215   }
 216   if (hasAttribute(Attribute::NoDuplicate))
 217     Result += "noduplicate ";
 218   // Trim the trailing space.
 219   assert(!Result.empty() && "Unknown attribute!");
 220   Result.erase(Result.end()-1);
 221   return Result;
 222 }
 223
 224 //===----------------------------------------------------------------------===//
 225 // AttrBuilder Implementation
 226 //===----------------------------------------------------------------------===//
 227
 228 AttrBuilder &AttrBuilder::addAttribute(Attribute::AttrVal Val){
 229   Bits |= AttributeImpl::getAttrMask(Val);
 230   return *this;
 231 }
 232
 233 AttrBuilder &AttrBuilder::addRawValue(uint64_t Val) {
 234   Bits |= Val;
 235   return *this;
 236 }
 237
 238 AttrBuilder &AttrBuilder::addAlignmentAttr(unsigned Align) {
 239   if (Align == 0) return *this;
 240   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
 241   assert(Align <= 0x40000000 && "Alignment too large.");
 242   Bits |= (Log2_32(Align) + 1) << 16;
 243   return *this;
 244 }
 245 AttrBuilder &AttrBuilder::addStackAlignmentAttr(unsigned Align){
 246   // Default alignment, allow the target to define how to align it.
 247   if (Align == 0) return *this;
 248   assert(isPowerOf2_32(Align) && "Alignment must be a power of two.");
 249   assert(Align <= 0x100 && "Alignment too large.");
 250   Bits |= (Log2_32(Align) + 1) << 26;
 251   return *this;
 252 }
 253
 254 AttrBuilder &AttrBuilder::removeAttribute(Attribute::AttrVal Val) {
 255   Bits &= ~AttributeImpl::getAttrMask(Val);
 256   return *this;
 257 }
 258
 259 AttrBuilder &AttrBuilder::addAttributes(const Attribute &A) {
 260   Bits |= A.Raw();
 261   return *this;
 262 }
 263
 264 AttrBuilder &AttrBuilder::removeAttributes(const Attribute &A){
 265   Bits &= ~A.Raw();
 266   return *this;
 267 }
 268
 269 bool AttrBuilder::hasAttribute(Attribute::AttrVal A) const {
 270   return Bits & AttributeImpl::getAttrMask(A);
 271 }
 272
 273 bool AttrBuilder::hasAttributes() const {
 274   return Bits != 0;
 275 }
 276 bool AttrBuilder::hasAttributes(const Attribute &A) const {
 277   return Bits & A.Raw();
 278 }
 279 bool AttrBuilder::hasAlignmentAttr() const {
 280   return Bits & AttributeImpl::getAttrMask(Attribute::Alignment);
 281 }
 282
 283 uint64_t AttrBuilder::getAlignment() const {
 284   if (!hasAlignmentAttr())
 285     return 0;
 286   return 1ULL <<
 287     (((Bits & AttributeImpl::getAttrMask(Attribute::Alignment)) >> 16) - 1);
 288 }
 289
 290 uint64_t AttrBuilder::getStackAlignment() const {
 291   if (!hasAlignmentAttr())
 292     return 0;
 293   return 1ULL <<
 294     (((Bits & AttributeImpl::getAttrMask(Attribute::StackAlignment))>>26)-1);
 295 }
 296
 297 //===----------------------------------------------------------------------===//
 298 // AttributeImpl Definition
 299 //===----------------------------------------------------------------------===//
 300
 301 uint64_t AttributeImpl::getAttrMask(uint64_t Val) {
 302   switch (Val) {
 303   case Attribute::None:            return 0;
 304   case Attribute::ZExt:            return 1 << 0;
 305   case Attribute::SExt:            return 1 << 1;
 306   case Attribute::NoReturn:        return 1 << 2;
 307   case Attribute::InReg:           return 1 << 3;
 308   case Attribute::StructRet:       return 1 << 4;
 309   case Attribute::NoUnwind:        return 1 << 5;
 310   case Attribute::NoAlias:         return 1 << 6;
 311   case Attribute::ByVal:           return 1 << 7;
 312   case Attribute::Nest:            return 1 << 8;
 313   case Attribute::ReadNone:        return 1 << 9;
 314   case Attribute::ReadOnly:        return 1 << 10;
 315   case Attribute::NoInline:        return 1 << 11;
 316   case Attribute::AlwaysInline:    return 1 << 12;
 317   case Attribute::OptimizeForSize: return 1 << 13;
 318   case Attribute::StackProtect:    return 1 << 14;
 319   case Attribute::StackProtectReq: return 1 << 15;
 320   case Attribute::Alignment:       return 31 << 16;
 321   case Attribute::NoCapture:       return 1 << 21;
 322   case Attribute::NoRedZone:       return 1 << 22;
 323   case Attribute::NoImplicitFloat: return 1 << 23;
 324   case Attribute::Naked:           return 1 << 24;
 325   case Attribute::InlineHint:      return 1 << 25;
 326   case Attribute::StackAlignment:  return 7 << 26;
 327   case Attribute::ReturnsTwice:    return 1 << 29;
 328   case Attribute::UWTable:         return 1 << 30;
 329   case Attribute::NonLazyBind:     return 1U << 31;
 330   case Attribute::AddressSafety:   return 1ULL << 32;
 331   case Attribute::MinSize:         return 1ULL << 33;
 332   case Attribute::NoDuplicate:     return 1ULL << 34;
 333   }
 334   llvm_unreachable("Unsupported attribute type");
 335 }
 336
 337 bool AttributeImpl::hasAttribute(uint64_t A) const {
 338   return (Bits & getAttrMask(A)) != 0;
 339 }
 340
 341 bool AttributeImpl::hasAttributes() const {
 342   return Bits != 0;
 343 }
 344
 345 bool AttributeImpl::hasAttributes(const Attribute &A) const {
 346   return Bits & A.Raw();        // FIXME: Raw() won't work here in the future.
 347 }
 348
 349 uint64_t AttributeImpl::getAlignment() const {
 350   return Bits & getAttrMask(Attribute::Alignment);
 351 }
 352
 353 uint64_t AttributeImpl::getStackAlignment() const {
 354   return Bits & getAttrMask(Attribute::StackAlignment);
 355 }
 356
 357 //===----------------------------------------------------------------------===//
 358 // AttributeSetImpl Definition
 359 //===----------------------------------------------------------------------===//
 360
 361 AttributeSet AttributeSet::get(LLVMContext &C,
 362                                ArrayRef<AttributeWithIndex> Attrs) {
 363   // If there are no attributes then return a null AttributesList pointer.
 364   if (Attrs.empty())
 365     return AttributeSet();
 366
 367 #ifndef NDEBUG
 368   for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
 369     assert(Attrs[i].Attrs.hasAttributes() &&
 370            "Pointless attribute!");
 371     assert((!i || Attrs[i-1].Index < Attrs[i].Index) &&
 372            "Misordered AttributesList!");
 373   }
 374 #endif
 375
 376   // Otherwise, build a key to look up the existing attributes.
 377   LLVMContextImpl *pImpl = C.pImpl;
 378   FoldingSetNodeID ID;
 379   AttributeSetImpl::Profile(ID, Attrs);
 380
 381   void *InsertPoint;
 382   AttributeSetImpl *PA = pImpl->AttrsLists.FindNodeOrInsertPos(ID,
 383                                                                 InsertPoint);
 384
 385   // If we didn't find any existing attributes of the same shape then
 386   // create a new one and insert it.
 387   if (!PA) {
 388     PA = new AttributeSetImpl(C, Attrs);
 389     pImpl->AttrsLists.InsertNode(PA, InsertPoint);
 390   }
 391
 392   // Return the AttributesList that we found or created.
 393   return AttributeSet(PA);
 394 }
 395
 396 //===----------------------------------------------------------------------===//
 397 // AttributeSet Method Implementations
 398 //===----------------------------------------------------------------------===//
 399
 400 const AttributeSet &AttributeSet::operator=(const AttributeSet &RHS) {
 401   AttrList = RHS.AttrList;
 402   return *this;
 403 }
 404
 405 /// getNumSlots - Return the number of slots used in this attribute list.
 406 /// This is the number of arguments that have an attribute set on them
 407 /// (including the function itself).
 408 unsigned AttributeSet::getNumSlots() const {
 409   return AttrList ? AttrList->Attrs.size() : 0;
 410 }
 411
 412 /// getSlot - Return the AttributeWithIndex at the specified slot.  This
 413 /// holds a number plus a set of attributes.
 414 const AttributeWithIndex &AttributeSet::getSlot(unsigned Slot) const {
 415   assert(AttrList && Slot < AttrList->Attrs.size() && "Slot # out of range!");
 416   return AttrList->Attrs[Slot];
 417 }
 418
 419 /// getAttributes - The attributes for the specified index are returned.
 420 /// Attribute for the result are denoted with Idx = 0.  Function notes are
 421 /// denoted with idx = ~0.
 422 Attribute AttributeSet::getAttributes(unsigned Idx) const {
 423   if (AttrList == 0) return Attribute();
 424
 425   const SmallVector<AttributeWithIndex, 4> &Attrs = AttrList->Attrs;
 426   for (unsigned i = 0, e = Attrs.size(); i != e && Attrs[i].Index <= Idx; ++i)
 427     if (Attrs[i].Index == Idx)
 428       return Attrs[i].Attrs;
 429
 430   return Attribute();
 431 }
 432
 433 /// hasAttrSomewhere - Return true if the specified attribute is set for at
 434 /// least one parameter or for the return value.
 435 bool AttributeSet::hasAttrSomewhere(Attribute::AttrVal Attr) const {
 436   if (AttrList == 0) return false;
 437
 438   const SmallVector<AttributeWithIndex, 4> &Attrs = AttrList->Attrs;
 439   for (unsigned i = 0, e = Attrs.size(); i != e; ++i)
 440     if (Attrs[i].Attrs.hasAttribute(Attr))
 441       return true;
 442
 443   return false;
 444 }
 445
 446 unsigned AttributeSet::getNumAttrs() const {
 447   return AttrList ? AttrList->Attrs.size() : 0;
 448 }
 449
 450 Attribute &AttributeSet::getAttributesAtIndex(unsigned i) const {
 451   assert(AttrList && "Trying to get an attribute from an empty list!");
 452   assert(i < AttrList->Attrs.size() && "Index out of range!");
 453   return AttrList->Attrs[i].Attrs;
 454 }
 455
 456 AttributeSet AttributeSet::addAttr(LLVMContext &C, unsigned Idx,
 457                                  Attribute Attrs) const {
 458   Attribute OldAttrs = getAttributes(Idx);
 459 #ifndef NDEBUG
 460   // FIXME it is not obvious how this should work for alignment.
 461   // For now, say we can't change a known alignment.
 462   unsigned OldAlign = OldAttrs.getAlignment();
 463   unsigned NewAlign = Attrs.getAlignment();
 464   assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
 465          "Attempt to change alignment!");
 466 #endif
 467
 468   AttrBuilder NewAttrs =
 469     AttrBuilder(OldAttrs).addAttributes(Attrs);
 470   if (NewAttrs == AttrBuilder(OldAttrs))
 471     return *this;
 472
 473   SmallVector<AttributeWithIndex, 8> NewAttrList;
 474   if (AttrList == 0)
 475     NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
 476   else {
 477     const SmallVector<AttributeWithIndex, 4> &OldAttrList = AttrList->Attrs;
 478     unsigned i = 0, e = OldAttrList.size();
 479     // Copy attributes for arguments before this one.
 480     for (; i != e && OldAttrList[i].Index < Idx; ++i)
 481       NewAttrList.push_back(OldAttrList[i]);
 482
 483     // If there are attributes already at this index, merge them in.
 484     if (i != e && OldAttrList[i].Index == Idx) {
 485       Attrs =
 486         Attribute::get(C, AttrBuilder(Attrs).
 487                         addAttributes(OldAttrList[i].Attrs));
 488       ++i;
 489     }
 490
 491     NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
 492
 493     // Copy attributes for arguments after this one.
 494     NewAttrList.insert(NewAttrList.end(),
 495                        OldAttrList.begin()+i, OldAttrList.end());
 496   }
 497
 498   return get(C, NewAttrList);
 499 }
 500
 501 AttributeSet AttributeSet::removeAttr(LLVMContext &C, unsigned Idx,
 502                                     Attribute Attrs) const {
 503 #ifndef NDEBUG
 504   // FIXME it is not obvious how this should work for alignment.
 505   // For now, say we can't pass in alignment, which no current use does.
 506   assert(!Attrs.hasAttribute(Attribute::Alignment) &&
 507          "Attempt to exclude alignment!");
 508 #endif
 509   if (AttrList == 0) return AttributeSet();
 510
 511   Attribute OldAttrs = getAttributes(Idx);
 512   AttrBuilder NewAttrs =
 513     AttrBuilder(OldAttrs).removeAttributes(Attrs);
 514   if (NewAttrs == AttrBuilder(OldAttrs))
 515     return *this;
 516
 517   SmallVector<AttributeWithIndex, 8> NewAttrList;
 518   const SmallVector<AttributeWithIndex, 4> &OldAttrList = AttrList->Attrs;
 519   unsigned i = 0, e = OldAttrList.size();
 520
 521   // Copy attributes for arguments before this one.
 522   for (; i != e && OldAttrList[i].Index < Idx; ++i)
 523     NewAttrList.push_back(OldAttrList[i]);
 524
 525   // If there are attributes already at this index, merge them in.
 526   assert(OldAttrList[i].Index == Idx && "Attribute isn't set?");
 527   Attrs = Attribute::get(C, AttrBuilder(OldAttrList[i].Attrs).
 528                           removeAttributes(Attrs));
 529   ++i;
 530   if (Attrs.hasAttributes()) // If any attributes left for this param, add them.
 531     NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
 532
 533   // Copy attributes for arguments after this one.
 534   NewAttrList.insert(NewAttrList.end(),
 535                      OldAttrList.begin()+i, OldAttrList.end());
 536
 537   return get(C, NewAttrList);
 538 }
 539
 540 void AttributeSet::dump() const {
 541   dbgs() << "PAL[ ";
 542   for (unsigned i = 0; i < getNumSlots(); ++i) {
 543     const AttributeWithIndex &PAWI = getSlot(i);
 544     dbgs() << "{" << PAWI.Index << "," << PAWI.Attrs.getAsString() << "} ";
 545   }
 546
 547   dbgs() << "]\n";
 548 }