lib/VMCore/Attributes.cpp

   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 // This file implements the AttributesList class and Attribute utilities.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Attributes.h"
  15 #include "llvm/Type.h"
  16 #include "llvm/ADT/StringExtras.h"
  17 #include "llvm/ADT/FoldingSet.h"
  18 #include "llvm/Support/Atomic.h"
  19 #include "llvm/Support/Mutex.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Support/ManagedStatic.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 using namespace llvm;
  24
  25 //===----------------------------------------------------------------------===//
  26 // Attribute Function Definitions
  27 //===----------------------------------------------------------------------===//
  28
  29 std::string Attributes::getAsString() const {
  30   std::string Result;
  31   if (hasZExtAttr())
  32     Result += "zeroext ";
  33   if (hasSExtAttr())
  34     Result += "signext ";
  35   if (hasNoReturnAttr())
  36     Result += "noreturn ";
  37   if (hasNoUnwindAttr())
  38     Result += "nounwind ";
  39   if (hasUWTableAttr())
  40     Result += "uwtable ";
  41   if (hasReturnsTwiceAttr())
  42     Result += "returns_twice ";
  43   if (hasInRegAttr())
  44     Result += "inreg ";
  45   if (hasNoAliasAttr())
  46     Result += "noalias ";
  47   if (hasNoCaptureAttr())
  48     Result += "nocapture ";
  49   if (hasStructRetAttr())
  50     Result += "sret ";
  51   if (hasByValAttr())
  52     Result += "byval ";
  53   if (hasNestAttr())
  54     Result += "nest ";
  55   if (hasReadNoneAttr())
  56     Result += "readnone ";
  57   if (hasReadOnlyAttr())
  58     Result += "readonly ";
  59   if (hasOptimizeForSizeAttr())
  60     Result += "optsize ";
  61   if (hasNoInlineAttr())
  62     Result += "noinline ";
  63   if (hasInlineHintAttr())
  64     Result += "inlinehint ";
  65   if (hasAlwaysInlineAttr())
  66     Result += "alwaysinline ";
  67   if (hasStackProtectAttr())
  68     Result += "ssp ";
  69   if (hasStackProtectReqAttr())
  70     Result += "sspreq ";
  71   if (hasNoRedZoneAttr())
  72     Result += "noredzone ";
  73   if (hasNoImplicitFloatAttr())
  74     Result += "noimplicitfloat ";
  75   if (hasNakedAttr())
  76     Result += "naked ";
  77   if (hasNonLazyBindAttr())
  78     Result += "nonlazybind ";
  79   if (hasAddressSafetyAttr())
  80     Result += "address_safety ";
  81   if (hasStackAlignmentAttr()) {
  82     Result += "alignstack(";
  83     Result += utostr(getStackAlignment());
  84     Result += ") ";
  85   }
  86   if (hasAlignmentAttr()) {
  87     Result += "align ";
  88     Result += utostr(getAlignment());
  89     Result += " ";
  90   }
  91   // Trim the trailing space.
  92   assert(!Result.empty() && "Unknown attribute!");
  93   Result.erase(Result.end()-1);
  94   return Result;
  95 }
  96
  97 Attributes Attribute::typeIncompatible(Type *Ty) {
  98   Attributes Incompatible = None;
  99
 100   if (!Ty->isIntegerTy())
 101     // Attributes that only apply to integers.
 102     Incompatible |= SExt | ZExt;
 103
 104   if (!Ty->isPointerTy())
 105     // Attributes that only apply to pointers.
 106     Incompatible |= ByVal | Nest | NoAlias | StructRet | NoCapture;
 107
 108   return Incompatible;
 109 }
 110
 111 //===----------------------------------------------------------------------===//
 112 // AttributeListImpl Definition
 113 //===----------------------------------------------------------------------===//
 114
 115 namespace llvm {
 116   class AttributeListImpl;
 117 }
 118
 119 static ManagedStatic<FoldingSet<AttributeListImpl> > AttributesLists;
 120
 121 namespace llvm {
 122 static ManagedStatic<sys::SmartMutex<true> > ALMutex;
 123
 124 class AttributeListImpl : public FoldingSetNode {
 125   sys::cas_flag RefCount;
 126
 127   // AttributesList is uniqued, these should not be publicly available.
 128   void operator=(const AttributeListImpl &) LLVM_DELETED_FUNCTION;
 129   AttributeListImpl(const AttributeListImpl &) LLVM_DELETED_FUNCTION;
 130   ~AttributeListImpl();                        // Private implementation
 131 public:
 132   SmallVector<AttributeWithIndex, 4> Attrs;
 133
 134   AttributeListImpl(ArrayRef<AttributeWithIndex> attrs)
 135     : Attrs(attrs.begin(), attrs.end()) {
 136     RefCount = 0;
 137   }
 138
 139   void AddRef() {
 140     sys::SmartScopedLock<true> Lock(*ALMutex);
 141     ++RefCount;
 142   }
 143   void DropRef() {
 144     sys::SmartScopedLock<true> Lock(*ALMutex);
 145     if (!AttributesLists.isConstructed())
 146       return;
 147     sys::cas_flag new_val = --RefCount;
 148     if (new_val == 0)
 149       delete this;
 150   }
 151
 152   void Profile(FoldingSetNodeID &ID) const {
 153     Profile(ID, Attrs);
 154   }
 155   static void Profile(FoldingSetNodeID &ID, ArrayRef<AttributeWithIndex> Attrs){
 156     for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
 157       ID.AddInteger(Attrs[i].Attrs.Raw());
 158       ID.AddInteger(Attrs[i].Index);
 159     }
 160   }
 161 };
 162 }
 163
 164 AttributeListImpl::~AttributeListImpl() {
 165   // NOTE: Lock must be acquired by caller.
 166   AttributesLists->RemoveNode(this);
 167 }
 168
 169
 170 AttrListPtr AttrListPtr::get(ArrayRef<AttributeWithIndex> Attrs) {
 171   // If there are no attributes then return a null AttributesList pointer.
 172   if (Attrs.empty())
 173     return AttrListPtr();
 174
 175 #ifndef NDEBUG
 176   for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
 177     assert(Attrs[i].Attrs.hasAttributes() &&
 178            "Pointless attribute!");
 179     assert((!i || Attrs[i-1].Index < Attrs[i].Index) &&
 180            "Misordered AttributesList!");
 181   }
 182 #endif
 183
 184   // Otherwise, build a key to look up the existing attributes.
 185   FoldingSetNodeID ID;
 186   AttributeListImpl::Profile(ID, Attrs);
 187   void *InsertPos;
 188
 189   sys::SmartScopedLock<true> Lock(*ALMutex);
 190
 191   AttributeListImpl *PAL =
 192     AttributesLists->FindNodeOrInsertPos(ID, InsertPos);
 193
 194   // If we didn't find any existing attributes of the same shape then
 195   // create a new one and insert it.
 196   if (!PAL) {
 197     PAL = new AttributeListImpl(Attrs);
 198     AttributesLists->InsertNode(PAL, InsertPos);
 199   }
 200
 201   // Return the AttributesList that we found or created.
 202   return AttrListPtr(PAL);
 203 }
 204
 205
 206 //===----------------------------------------------------------------------===//
 207 // AttrListPtr Method Implementations
 208 //===----------------------------------------------------------------------===//
 209
 210 AttrListPtr::AttrListPtr(AttributeListImpl *LI) : AttrList(LI) {
 211   if (LI) LI->AddRef();
 212 }
 213
 214 AttrListPtr::AttrListPtr(const AttrListPtr &P) : AttrList(P.AttrList) {
 215   if (AttrList) AttrList->AddRef();
 216 }
 217
 218 const AttrListPtr &AttrListPtr::operator=(const AttrListPtr &RHS) {
 219   sys::SmartScopedLock<true> Lock(*ALMutex);
 220   if (AttrList == RHS.AttrList) return *this;
 221   if (AttrList) AttrList->DropRef();
 222   AttrList = RHS.AttrList;
 223   if (AttrList) AttrList->AddRef();
 224   return *this;
 225 }
 226
 227 AttrListPtr::~AttrListPtr() {
 228   if (AttrList) AttrList->DropRef();
 229 }
 230
 231 /// getNumSlots - Return the number of slots used in this attribute list.
 232 /// This is the number of arguments that have an attribute set on them
 233 /// (including the function itself).
 234 unsigned AttrListPtr::getNumSlots() const {
 235   return AttrList ? AttrList->Attrs.size() : 0;
 236 }
 237
 238 /// getSlot - Return the AttributeWithIndex at the specified slot.  This
 239 /// holds a number plus a set of attributes.
 240 const AttributeWithIndex &AttrListPtr::getSlot(unsigned Slot) const {
 241   assert(AttrList && Slot < AttrList->Attrs.size() && "Slot # out of range!");
 242   return AttrList->Attrs[Slot];
 243 }
 244
 245
 246 /// getAttributes - The attributes for the specified index are
 247 /// returned.  Attributes for the result are denoted with Idx = 0.
 248 /// Function notes are denoted with idx = ~0.
 249 Attributes AttrListPtr::getAttributes(unsigned Idx) const {
 250   if (AttrList == 0) return Attributes();
 251
 252   const SmallVector<AttributeWithIndex, 4> &Attrs = AttrList->Attrs;
 253   for (unsigned i = 0, e = Attrs.size(); i != e && Attrs[i].Index <= Idx; ++i)
 254     if (Attrs[i].Index == Idx)
 255       return Attrs[i].Attrs;
 256
 257   return Attributes();
 258 }
 259
 260 /// hasAttrSomewhere - Return true if the specified attribute is set for at
 261 /// least one parameter or for the return value.
 262 bool AttrListPtr::hasAttrSomewhere(Attributes Attr) const {
 263   if (AttrList == 0) return false;
 264
 265   const SmallVector<AttributeWithIndex, 4> &Attrs = AttrList->Attrs;
 266   for (unsigned i = 0, e = Attrs.size(); i != e; ++i)
 267     if (Attrs[i].Attrs.hasAttributes(Attr))
 268       return true;
 269   return false;
 270 }
 271
 272
 273 AttrListPtr AttrListPtr::addAttr(unsigned Idx, Attributes Attrs) const {
 274   Attributes OldAttrs = getAttributes(Idx);
 275 #ifndef NDEBUG
 276   // FIXME it is not obvious how this should work for alignment.
 277   // For now, say we can't change a known alignment.
 278   unsigned OldAlign = OldAttrs.getAlignment();
 279   unsigned NewAlign = Attrs.getAlignment();
 280   assert((!OldAlign || !NewAlign || OldAlign == NewAlign) &&
 281          "Attempt to change alignment!");
 282 #endif
 283
 284   Attributes NewAttrs = OldAttrs | Attrs;
 285   if (NewAttrs == OldAttrs)
 286     return *this;
 287
 288   SmallVector<AttributeWithIndex, 8> NewAttrList;
 289   if (AttrList == 0)
 290     NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
 291   else {
 292     const SmallVector<AttributeWithIndex, 4> &OldAttrList = AttrList->Attrs;
 293     unsigned i = 0, e = OldAttrList.size();
 294     // Copy attributes for arguments before this one.
 295     for (; i != e && OldAttrList[i].Index < Idx; ++i)
 296       NewAttrList.push_back(OldAttrList[i]);
 297
 298     // If there are attributes already at this index, merge them in.
 299     if (i != e && OldAttrList[i].Index == Idx) {
 300       Attrs |= OldAttrList[i].Attrs;
 301       ++i;
 302     }
 303
 304     NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
 305
 306     // Copy attributes for arguments after this one.
 307     NewAttrList.insert(NewAttrList.end(),
 308                        OldAttrList.begin()+i, OldAttrList.end());
 309   }
 310
 311   return get(NewAttrList);
 312 }
 313
 314 AttrListPtr AttrListPtr::removeAttr(unsigned Idx, Attributes Attrs) const {
 315 #ifndef NDEBUG
 316   // FIXME it is not obvious how this should work for alignment.
 317   // For now, say we can't pass in alignment, which no current use does.
 318   assert(!Attrs.hasAlignmentAttr() && "Attempt to exclude alignment!");
 319 #endif
 320   if (AttrList == 0) return AttrListPtr();
 321
 322   Attributes OldAttrs = getAttributes(Idx);
 323   Attributes NewAttrs = OldAttrs & ~Attrs;
 324   if (NewAttrs == OldAttrs)
 325     return *this;
 326
 327   SmallVector<AttributeWithIndex, 8> NewAttrList;
 328   const SmallVector<AttributeWithIndex, 4> &OldAttrList = AttrList->Attrs;
 329   unsigned i = 0, e = OldAttrList.size();
 330
 331   // Copy attributes for arguments before this one.
 332   for (; i != e && OldAttrList[i].Index < Idx; ++i)
 333     NewAttrList.push_back(OldAttrList[i]);
 334
 335   // If there are attributes already at this index, merge them in.
 336   assert(OldAttrList[i].Index == Idx && "Attribute isn't set?");
 337   Attrs = OldAttrList[i].Attrs & ~Attrs;
 338   ++i;
 339   if (Attrs)  // If any attributes left for this parameter, add them.
 340     NewAttrList.push_back(AttributeWithIndex::get(Idx, Attrs));
 341
 342   // Copy attributes for arguments after this one.
 343   NewAttrList.insert(NewAttrList.end(),
 344                      OldAttrList.begin()+i, OldAttrList.end());
 345
 346   return get(NewAttrList);
 347 }
 348
 349 void AttrListPtr::dump() const {
 350   dbgs() << "PAL[ ";
 351   for (unsigned i = 0; i < getNumSlots(); ++i) {
 352     const AttributeWithIndex &PAWI = getSlot(i);
 353     dbgs() << "{" << PAWI.Index << "," << PAWI.Attrs << "} ";
 354   }
 355
 356   dbgs() << "]\n";
 357 }