lib/Analysis/AliasSetTracker.cpp

   1 //===- AliasSetTracker.cpp - Alias Sets Tracker implementation-------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the AliasSetTracker and AliasSet classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/AliasSetTracker.h"
  15 #include "llvm/Analysis/AliasAnalysis.h"
  16 #include "llvm/iMemory.h"
  17 #include "llvm/iOther.h"
  18 #include "llvm/iTerminators.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/Target/TargetData.h"
  21 #include "llvm/Assembly/Writer.h"
  22 #include "llvm/Support/InstIterator.h"
  23 #include <iostream>
  24 using namespace llvm;
  25
  26 /// mergeSetIn - Merge the specified alias set into this alias set...
  27 ///
  28 void AliasSet::mergeSetIn(AliasSet &AS) {
  29   assert(!AS.Forward && "Alias set is already forwarding!");
  30   assert(!Forward && "This set is a forwarding set!!");
  31
  32   // Update the alias and access types of this set...
  33   AccessTy |= AS.AccessTy;
  34   AliasTy  |= AS.AliasTy;
  35
  36   if (CallSites.empty()) {            // Merge call sites...
  37     if (!AS.CallSites.empty())
  38       std::swap(CallSites, AS.CallSites);
  39   } else if (!AS.CallSites.empty()) {
  40     CallSites.insert(CallSites.end(), AS.CallSites.begin(), AS.CallSites.end());
  41     AS.CallSites.clear();
  42   }
  43
  44   // FIXME: If AS's refcount is zero, nuke it now...
  45   assert(RefCount != 0);
  46
  47   AS.Forward = this;  // Forward across AS now...
  48   addRef();           // AS is now pointing to us...
  49
  50   // Merge the list of constituent pointers...
  51   if (AS.PtrList) {
  52     *PtrListEnd = AS.PtrList;
  53     AS.PtrList->second.setPrevInList(PtrListEnd);
  54     PtrListEnd = AS.PtrListEnd;
  55
  56     AS.PtrList = 0;
  57     AS.PtrListEnd = &AS.PtrList;
  58   }
  59 }
  60
  61 void AliasSetTracker::removeAliasSet(AliasSet *AS) {
  62   if (AliasSet *Fwd = AS->Forward) {
  63     Fwd->dropRef(*this);
  64     AS->Forward = 0;
  65   }
  66   AliasSets.erase(AS);
  67 }
  68
  69 void AliasSet::removeFromTracker(AliasSetTracker &AST) {
  70   assert(RefCount == 0 && "Cannot remove non-dead alias set from tracker!");
  71   AST.removeAliasSet(this);
  72 }
  73
  74 void AliasSet::addPointer(AliasSetTracker &AST, HashNodePair &Entry,
  75                           unsigned Size) {
  76   assert(!Entry.second.hasAliasSet() && "Entry already in set!");
  77
  78   AliasAnalysis &AA = AST.getAliasAnalysis();
  79
  80   if (isMustAlias())    // Check to see if we have to downgrade to _may_ alias
  81     if (HashNodePair *P = getSomePointer()) {
  82       AliasAnalysis::AliasResult Result =
  83         AA.alias(P->first, P->second.getSize(), Entry.first, Size);
  84       if (Result == AliasAnalysis::MayAlias)
  85         AliasTy = MayAlias;
  86       else                  // First entry of must alias must have maximum size!
  87         P->second.updateSize(Size);
  88       assert(Result != AliasAnalysis::NoAlias && "Cannot be part of must set!");
  89     }
  90
  91   Entry.second.setAliasSet(this);
  92   Entry.second.updateSize(Size);
  93
  94   // Add it to the end of the list...
  95   assert(*PtrListEnd == 0 && "End of list is not null?");
  96   *PtrListEnd = &Entry;
  97   PtrListEnd = Entry.second.setPrevInList(PtrListEnd);
  98   addRef();               // Entry points to alias set...
  99 }
 100
 101 void AliasSet::addCallSite(CallSite CS, AliasAnalysis &AA) {
 102   CallSites.push_back(CS);
 103
 104   if (Function *F = CS.getCalledFunction()) {
 105     if (AA.doesNotAccessMemory(F))
 106       return;
 107     else if (AA.onlyReadsMemory(F)) {
 108       AliasTy = MayAlias;
 109       AccessTy |= Refs;
 110       return;
 111     }
 112   }
 113
 114   // FIXME: This should use mod/ref information to make this not suck so bad
 115   AliasTy = MayAlias;
 116   AccessTy = ModRef;
 117 }
 118
 119 /// aliasesPointer - Return true if the specified pointer "may" (or must)
 120 /// alias one of the members in the set.
 121 ///
 122 bool AliasSet::aliasesPointer(const Value *Ptr, unsigned Size,
 123                               AliasAnalysis &AA) const {
 124   if (AliasTy == MustAlias) {
 125     assert(CallSites.empty() && "Illegal must alias set!");
 126
 127     // If this is a set of MustAliases, only check to see if the pointer aliases
 128     // SOME value in the set...
 129     HashNodePair *SomePtr = getSomePointer();
 130     assert(SomePtr && "Empty must-alias set??");
 131     return AA.alias(SomePtr->first, SomePtr->second.getSize(), Ptr, Size);
 132   }
 133
 134   // If this is a may-alias set, we have to check all of the pointers in the set
 135   // to be sure it doesn't alias the set...
 136   for (iterator I = begin(), E = end(); I != E; ++I)
 137     if (AA.alias(Ptr, Size, I.getPointer(), I.getSize()))
 138       return true;
 139
 140   // Check the call sites list and invoke list...
 141   if (!CallSites.empty())
 142     // FIXME: this is pessimistic!
 143     return true;
 144
 145   return false;
 146 }
 147
 148 bool AliasSet::aliasesCallSite(CallSite CS, AliasAnalysis &AA) const {
 149   // FIXME: Use mod/ref information to prune this better!
 150   if (Function *F = CS.getCalledFunction())
 151     if (AA.doesNotAccessMemory(F))
 152       return false;
 153
 154   return true;
 155 }
 156
 157
 158 /// findAliasSetForPointer - Given a pointer, find the one alias set to put the
 159 /// instruction referring to the pointer into.  If there are multiple alias sets
 160 /// that may alias the pointer, merge them together and return the unified set.
 161 ///
 162 AliasSet *AliasSetTracker::findAliasSetForPointer(const Value *Ptr,
 163                                                   unsigned Size) {
 164   AliasSet *FoundSet = 0;
 165   for (iterator I = begin(), E = end(); I != E; ++I)
 166     if (!I->Forward && I->aliasesPointer(Ptr, Size, AA)) {
 167       if (FoundSet == 0) {  // If this is the first alias set ptr can go into...
 168         FoundSet = I;       // Remember it.
 169       } else {              // Otherwise, we must merge the sets...
 170         FoundSet->mergeSetIn(*I);     // Merge in contents...
 171       }
 172     }
 173
 174   return FoundSet;
 175 }
 176
 177 AliasSet *AliasSetTracker::findAliasSetForCallSite(CallSite CS) {
 178   AliasSet *FoundSet = 0;
 179   for (iterator I = begin(), E = end(); I != E; ++I)
 180     if (!I->Forward && I->aliasesCallSite(CS, AA)) {
 181       if (FoundSet == 0) {  // If this is the first alias set ptr can go into...
 182         FoundSet = I;       // Remember it.
 183       } else if (!I->Forward) {     // Otherwise, we must merge the sets...
 184         FoundSet->mergeSetIn(*I);     // Merge in contents...
 185       }
 186     }
 187
 188   return FoundSet;
 189 }
 190
 191
 192
 193
 194 /// getAliasSetForPointer - Return the alias set that the specified pointer
 195 /// lives in...
 196 AliasSet &AliasSetTracker::getAliasSetForPointer(Value *Pointer, unsigned Size,
 197                                                  bool *New) {
 198   AliasSet::HashNodePair &Entry = getEntryFor(Pointer);
 199
 200   // Check to see if the pointer is already known...
 201   if (Entry.second.hasAliasSet() && Size <= Entry.second.getSize()) {
 202     // Return the set!
 203     return *Entry.second.getAliasSet(*this)->getForwardedTarget(*this);
 204   } else if (AliasSet *AS = findAliasSetForPointer(Pointer, Size)) {
 205     // Add it to the alias set it aliases...
 206     AS->addPointer(*this, Entry, Size);
 207     return *AS;
 208   } else {
 209     if (New) *New = true;
 210     // Otherwise create a new alias set to hold the loaded pointer...
 211     AliasSets.push_back(new AliasSet());
 212     AliasSets.back().addPointer(*this, Entry, Size);
 213     return AliasSets.back();
 214   }
 215 }
 216
 217 bool AliasSetTracker::add(LoadInst *LI) {
 218   bool NewPtr;
 219   AliasSet &AS = addPointer(LI->getOperand(0),
 220                             AA.getTargetData().getTypeSize(LI->getType()),
 221                             AliasSet::Refs, NewPtr);
 222   if (LI->isVolatile()) AS.setVolatile();
 223   return NewPtr;
 224 }
 225
 226 bool AliasSetTracker::add(StoreInst *SI) {
 227   bool NewPtr;
 228   Value *Val = SI->getOperand(0);
 229   AliasSet &AS = addPointer(SI->getOperand(1),
 230                             AA.getTargetData().getTypeSize(Val->getType()),
 231                             AliasSet::Mods, NewPtr);
 232   if (SI->isVolatile()) AS.setVolatile();
 233   return NewPtr;
 234 }
 235
 236 bool AliasSetTracker::add(FreeInst *FI) {
 237   bool NewPtr;
 238   AliasSet &AS = addPointer(FI->getOperand(0), ~0,
 239                             AliasSet::Mods, NewPtr);
 240   return NewPtr;
 241 }
 242
 243
 244 bool AliasSetTracker::add(CallSite CS) {
 245   bool NewPtr;
 246   if (Function *F = CS.getCalledFunction())
 247     if (AA.doesNotAccessMemory(F))
 248       return true; // doesn't alias anything
 249
 250   AliasSet *AS = findAliasSetForCallSite(CS);
 251   if (!AS) {
 252     AliasSets.push_back(new AliasSet());
 253     AS = &AliasSets.back();
 254     AS->addCallSite(CS, AA);
 255     return true;
 256   } else {
 257     AS->addCallSite(CS, AA);
 258     return false;
 259   }
 260 }
 261
 262 bool AliasSetTracker::add(Instruction *I) {
 263   // Dispatch to one of the other add methods...
 264   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 265     return add(LI);
 266   else if (StoreInst *SI = dyn_cast<StoreInst>(I))
 267     return add(SI);
 268   else if (CallInst *CI = dyn_cast<CallInst>(I))
 269     return add(CI);
 270   else if (InvokeInst *II = dyn_cast<InvokeInst>(I))
 271     return add(II);
 272   else if (FreeInst *FI = dyn_cast<FreeInst>(I))
 273     return add(FI);
 274   return true;
 275 }
 276
 277 void AliasSetTracker::add(BasicBlock &BB) {
 278   for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
 279     add(I);
 280 }
 281
 282 void AliasSetTracker::add(const AliasSetTracker &AST) {
 283   assert(&AA == &AST.AA &&
 284          "Merging AliasSetTracker objects with different Alias Analyses!");
 285
 286   // Loop over all of the alias sets in AST, adding the pointers contained
 287   // therein into the current alias sets.  This can cause alias sets to be
 288   // merged together in the current AST.
 289   for (const_iterator I = AST.begin(), E = AST.end(); I != E; ++I)
 290     if (!I->Forward) {   // Ignore forwarding alias sets
 291       AliasSet &AS = const_cast<AliasSet&>(*I);
 292
 293       // If there are any call sites in the alias set, add them to this AST.
 294       for (unsigned i = 0, e = AS.CallSites.size(); i != e; ++i)
 295         add(AS.CallSites[i]);
 296
 297       // Loop over all of the pointers in this alias set...
 298       AliasSet::iterator I = AS.begin(), E = AS.end();
 299       bool X;
 300       for (; I != E; ++I)
 301         addPointer(I.getPointer(), I.getSize(),
 302                    (AliasSet::AccessType)AS.AccessTy, X);
 303     }
 304 }
 305
 306 /// remove - Remove the specified (potentially non-empty) alias set from the
 307 /// tracker.
 308 void AliasSetTracker::remove(AliasSet &AS) {
 309   bool SetDead;
 310   do {
 311     AliasSet::iterator I = AS.begin();
 312     Value *Ptr = I.getPointer(); ++I;
 313
 314     // deleteValue will delete the set automatically when the last pointer
 315     // reference is destroyed.  "Predict" when this will happen.
 316     SetDead = I == AS.end();
 317     deleteValue(Ptr);  // Delete all of the pointers from the set
 318   } while (!SetDead);
 319 }
 320
 321
 322 bool AliasSetTracker::remove(LoadInst *LI) {
 323   unsigned Size = AA.getTargetData().getTypeSize(LI->getType());
 324   AliasSet *AS = findAliasSetForPointer(LI->getOperand(0), Size);
 325   if (!AS) return false;
 326   remove(*AS);
 327   return true;
 328 }
 329
 330 bool AliasSetTracker::remove(StoreInst *SI) {
 331   unsigned Size = AA.getTargetData().getTypeSize(SI->getOperand(0)->getType());
 332   AliasSet *AS = findAliasSetForPointer(SI->getOperand(1), Size);
 333   if (!AS) return false;
 334   remove(*AS);
 335   return true;
 336 }
 337
 338 bool AliasSetTracker::remove(FreeInst *FI) {
 339   AliasSet *AS = findAliasSetForPointer(FI->getOperand(0), ~0);
 340   if (!AS) return false;
 341   remove(*AS);
 342   return true;
 343 }
 344
 345 bool AliasSetTracker::remove(CallSite CS) {
 346   if (Function *F = CS.getCalledFunction())
 347     if (AA.doesNotAccessMemory(F))
 348       return false; // doesn't alias anything
 349
 350   AliasSet *AS = findAliasSetForCallSite(CS);
 351   if (!AS) return false;
 352   remove(*AS);
 353   return true;
 354 }
 355
 356 bool AliasSetTracker::remove(Instruction *I) {
 357   // Dispatch to one of the other remove methods...
 358   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 359     return remove(LI);
 360   else if (StoreInst *SI = dyn_cast<StoreInst>(I))
 361     return remove(SI);
 362   else if (CallInst *CI = dyn_cast<CallInst>(I))
 363     return remove(CI);
 364   else if (FreeInst *FI = dyn_cast<FreeInst>(I))
 365     return remove(FI);
 366   return true;
 367 }
 368
 369
 370 // deleteValue method - This method is used to remove a pointer value from the
 371 // AliasSetTracker entirely.  It should be used when an instruction is deleted
 372 // from the program to update the AST.  If you don't use this, you would have
 373 // dangling pointers to deleted instructions.
 374 //
 375 void AliasSetTracker::deleteValue(Value *PtrVal) {
 376   // First, look up the PointerRec for this pointer...
 377   hash_map<Value*, AliasSet::PointerRec>::iterator I = PointerMap.find(PtrVal);
 378   if (I == PointerMap.end()) return;  // Noop
 379
 380   // If we found one, remove the pointer from the alias set it is in.
 381   AliasSet::HashNodePair &PtrValEnt = *I;
 382   AliasSet *AS = PtrValEnt.second.getAliasSet(*this);
 383
 384   // Unlink from the list of values...
 385   PtrValEnt.second.removeFromList();
 386   // Stop using the alias set
 387   AS->dropRef(*this);
 388   PointerMap.erase(I);
 389 }
 390
 391
 392 //===----------------------------------------------------------------------===//
 393 //               AliasSet/AliasSetTracker Printing Support
 394 //===----------------------------------------------------------------------===//
 395
 396 void AliasSet::print(std::ostream &OS) const {
 397   OS << "  AliasSet[" << (void*)this << "," << RefCount << "] ";
 398   OS << (AliasTy == MustAlias ? "must" : "may ") << " alias, ";
 399   switch (AccessTy) {
 400   case NoModRef: OS << "No access "; break;
 401   case Refs    : OS << "Ref       "; break;
 402   case Mods    : OS << "Mod       "; break;
 403   case ModRef  : OS << "Mod/Ref   "; break;
 404   default: assert(0 && "Bad value for AccessTy!");
 405   }
 406   if (isVolatile()) OS << "[volatile] ";
 407   if (Forward)
 408     OS << " forwarding to " << (void*)Forward;
 409
 410
 411   if (begin() != end()) {
 412     OS << "Pointers: ";
 413     for (iterator I = begin(), E = end(); I != E; ++I) {
 414       if (I != begin()) OS << ", ";
 415       WriteAsOperand(OS << "(", I.getPointer());
 416       OS << ", " << I.getSize() << ")";
 417     }
 418   }
 419   if (!CallSites.empty()) {
 420     OS << "\n    " << CallSites.size() << " Call Sites: ";
 421     for (unsigned i = 0, e = CallSites.size(); i != e; ++i) {
 422       if (i) OS << ", ";
 423       WriteAsOperand(OS, CallSites[i].getCalledValue());
 424     }
 425   }
 426   OS << "\n";
 427 }
 428
 429 void AliasSetTracker::print(std::ostream &OS) const {
 430   OS << "Alias Set Tracker: " << AliasSets.size() << " alias sets for "
 431      << PointerMap.size() << " pointer values.\n";
 432   for (const_iterator I = begin(), E = end(); I != E; ++I)
 433     I->print(OS);
 434   OS << "\n";
 435 }
 436
 437 void AliasSet::dump() const { print (std::cerr); }
 438 void AliasSetTracker::dump() const { print(std::cerr); }
 439
 440 //===----------------------------------------------------------------------===//
 441 //                            AliasSetPrinter Pass
 442 //===----------------------------------------------------------------------===//
 443
 444 namespace {
 445   class AliasSetPrinter : public FunctionPass {
 446     AliasSetTracker *Tracker;
 447   public:
 448     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 449       AU.setPreservesAll();
 450       AU.addRequired<AliasAnalysis>();
 451     }
 452
 453     virtual bool runOnFunction(Function &F) {
 454       Tracker = new AliasSetTracker(getAnalysis<AliasAnalysis>());
 455
 456       for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
 457         Tracker->add(&*I);
 458       return false;
 459     }
 460
 461     /// print - Convert to human readable form
 462     virtual void print(std::ostream &OS) const {
 463       Tracker->print(OS);
 464     }
 465
 466     virtual void releaseMemory() {
 467       delete Tracker;
 468     }
 469   };
 470   RegisterPass<AliasSetPrinter> X("print-alias-sets", "Alias Set Printer",
 471                                   PassInfo::Analysis | PassInfo::Optimization);
 472 }