lib/Analysis/AliasSetTracker.cpp

   1 //===- AliasSetTracker.cpp - Alias Sets Tracker implementation-------------===//
   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 AliasSetTracker and AliasSet classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/AliasSetTracker.h"
  15 #include "llvm/Analysis/AliasAnalysis.h"
  16 #include "llvm/Instructions.h"
  17 #include "llvm/Pass.h"
  18 #include "llvm/Type.h"
  19 #include "llvm/Target/TargetData.h"
  20 #include "llvm/Assembly/Writer.h"
  21 #include "llvm/Support/Compiler.h"
  22 #include "llvm/Support/InstIterator.h"
  23 #include "llvm/Support/Streams.h"
  24 using namespace llvm;
  25
  26 /// mergeSetIn - Merge the specified alias set into this alias set.
  27 ///
  28 void AliasSet::mergeSetIn(AliasSet &AS, AliasSetTracker &AST) {
  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 (AliasTy == MustAlias) {
  37     // Check that these two merged sets really are must aliases.  Since both
  38     // used to be must-alias sets, we can just check any pointer from each set
  39     // for aliasing.
  40     AliasAnalysis &AA = AST.getAliasAnalysis();
  41     HashNodePair *L = getSomePointer();
  42     HashNodePair *R = AS.getSomePointer();
  43
  44     // If the pointers are not a must-alias pair, this set becomes a may alias.
  45     if (AA.alias(L->first, L->second.getSize(), R->first, R->second.getSize())
  46         != AliasAnalysis::MustAlias)
  47       AliasTy = MayAlias;
  48   }
  49
  50   if (CallSites.empty()) {            // Merge call sites...
  51     if (!AS.CallSites.empty())
  52       std::swap(CallSites, AS.CallSites);
  53   } else if (!AS.CallSites.empty()) {
  54     CallSites.insert(CallSites.end(), AS.CallSites.begin(), AS.CallSites.end());
  55     AS.CallSites.clear();
  56   }
  57
  58   AS.Forward = this;  // Forward across AS now...
  59   addRef();           // AS is now pointing to us...
  60
  61   // Merge the list of constituent pointers...
  62   if (AS.PtrList) {
  63     *PtrListEnd = AS.PtrList;
  64     AS.PtrList->second.setPrevInList(PtrListEnd);
  65     PtrListEnd = AS.PtrListEnd;
  66
  67     AS.PtrList = 0;
  68     AS.PtrListEnd = &AS.PtrList;
  69     assert(*AS.PtrListEnd == 0 && "End of list is not null?");
  70   }
  71 }
  72
  73 void AliasSetTracker::removeAliasSet(AliasSet *AS) {
  74   if (AliasSet *Fwd = AS->Forward) {
  75     Fwd->dropRef(*this);
  76     AS->Forward = 0;
  77   }
  78   AliasSets.erase(AS);
  79 }
  80
  81 void AliasSet::removeFromTracker(AliasSetTracker &AST) {
  82   assert(RefCount == 0 && "Cannot remove non-dead alias set from tracker!");
  83   AST.removeAliasSet(this);
  84 }
  85
  86 void AliasSet::addPointer(AliasSetTracker &AST, HashNodePair &Entry,
  87                           unsigned Size, bool KnownMustAlias) {
  88   assert(!Entry.second.hasAliasSet() && "Entry already in set!");
  89
  90   // Check to see if we have to downgrade to _may_ alias.
  91   if (isMustAlias() && !KnownMustAlias)
  92     if (HashNodePair *P = getSomePointer()) {
  93       AliasAnalysis &AA = AST.getAliasAnalysis();
  94       AliasAnalysis::AliasResult Result =
  95         AA.alias(P->first, P->second.getSize(), Entry.first, Size);
  96       if (Result == AliasAnalysis::MayAlias)
  97         AliasTy = MayAlias;
  98       else                  // First entry of must alias must have maximum size!
  99         P->second.updateSize(Size);
 100       assert(Result != AliasAnalysis::NoAlias && "Cannot be part of must set!");
 101     }
 102
 103   Entry.second.setAliasSet(this);
 104   Entry.second.updateSize(Size);
 105
 106   // Add it to the end of the list...
 107   assert(*PtrListEnd == 0 && "End of list is not null?");
 108   *PtrListEnd = &Entry;
 109   PtrListEnd = Entry.second.setPrevInList(PtrListEnd);
 110   assert(*PtrListEnd == 0 && "End of list is not null?");
 111   addRef();               // Entry points to alias set...
 112 }
 113
 114 void AliasSet::addCallSite(CallSite CS, AliasAnalysis &AA) {
 115   CallSites.push_back(CS);
 116
 117   AliasAnalysis::ModRefBehavior Behavior = AA.getModRefBehavior(CS);
 118   if (Behavior == AliasAnalysis::DoesNotAccessMemory)
 119     return;
 120   else if (Behavior == AliasAnalysis::OnlyReadsMemory) {
 121     AliasTy = MayAlias;
 122     AccessTy |= Refs;
 123     return;
 124   }
 125
 126   // FIXME: This should use mod/ref information to make this not suck so bad
 127   AliasTy = MayAlias;
 128   AccessTy = ModRef;
 129 }
 130
 131 /// aliasesPointer - Return true if the specified pointer "may" (or must)
 132 /// alias one of the members in the set.
 133 ///
 134 bool AliasSet::aliasesPointer(const Value *Ptr, unsigned Size,
 135                               AliasAnalysis &AA) const {
 136   if (AliasTy == MustAlias) {
 137     assert(CallSites.empty() && "Illegal must alias set!");
 138
 139     // If this is a set of MustAliases, only check to see if the pointer aliases
 140     // SOME value in the set...
 141     HashNodePair *SomePtr = getSomePointer();
 142     assert(SomePtr && "Empty must-alias set??");
 143     return AA.alias(SomePtr->first, SomePtr->second.getSize(), Ptr, Size);
 144   }
 145
 146   // If this is a may-alias set, we have to check all of the pointers in the set
 147   // to be sure it doesn't alias the set...
 148   for (iterator I = begin(), E = end(); I != E; ++I)
 149     if (AA.alias(Ptr, Size, I.getPointer(), I.getSize()))
 150       return true;
 151
 152   // Check the call sites list and invoke list...
 153   if (!CallSites.empty()) {
 154     if (AA.hasNoModRefInfoForCalls())
 155       return true;
 156
 157     for (unsigned i = 0, e = CallSites.size(); i != e; ++i)
 158       if (AA.getModRefInfo(CallSites[i], const_cast<Value*>(Ptr), Size)
 159                    != AliasAnalysis::NoModRef)
 160         return true;
 161   }
 162
 163   return false;
 164 }
 165
 166 bool AliasSet::aliasesCallSite(CallSite CS, AliasAnalysis &AA) const {
 167   if (AA.doesNotAccessMemory(CS))
 168     return false;
 169
 170   if (AA.hasNoModRefInfoForCalls())
 171     return true;
 172
 173   for (unsigned i = 0, e = CallSites.size(); i != e; ++i)
 174     if (AA.getModRefInfo(CallSites[i], CS) != AliasAnalysis::NoModRef ||
 175         AA.getModRefInfo(CS, CallSites[i]) != AliasAnalysis::NoModRef)
 176       return true;
 177
 178   for (iterator I = begin(), E = end(); I != E; ++I)
 179     if (AA.getModRefInfo(CS, I.getPointer(), I.getSize()) !=
 180            AliasAnalysis::NoModRef)
 181       return true;
 182
 183   return false;
 184 }
 185
 186
 187 /// findAliasSetForPointer - Given a pointer, find the one alias set to put the
 188 /// instruction referring to the pointer into.  If there are multiple alias sets
 189 /// that may alias the pointer, merge them together and return the unified set.
 190 ///
 191 AliasSet *AliasSetTracker::findAliasSetForPointer(const Value *Ptr,
 192                                                   unsigned Size) {
 193   AliasSet *FoundSet = 0;
 194   for (iterator I = begin(), E = end(); I != E; ++I)
 195     if (!I->Forward && I->aliasesPointer(Ptr, Size, AA)) {
 196       if (FoundSet == 0) {  // If this is the first alias set ptr can go into.
 197         FoundSet = I;       // Remember it.
 198       } else {              // Otherwise, we must merge the sets.
 199         FoundSet->mergeSetIn(*I, *this);     // Merge in contents.
 200       }
 201     }
 202
 203   return FoundSet;
 204 }
 205
 206 /// containsPointer - Return true if the specified location is represented by
 207 /// this alias set, false otherwise.  This does not modify the AST object or
 208 /// alias sets.
 209 bool AliasSetTracker::containsPointer(Value *Ptr, unsigned Size) const {
 210   for (const_iterator I = begin(), E = end(); I != E; ++I)
 211     if (!I->Forward && I->aliasesPointer(Ptr, Size, AA))
 212       return true;
 213   return false;
 214 }
 215
 216
 217
 218 AliasSet *AliasSetTracker::findAliasSetForCallSite(CallSite CS) {
 219   AliasSet *FoundSet = 0;
 220   for (iterator I = begin(), E = end(); I != E; ++I)
 221     if (!I->Forward && I->aliasesCallSite(CS, AA)) {
 222       if (FoundSet == 0) {  // If this is the first alias set ptr can go into.
 223         FoundSet = I;       // Remember it.
 224       } else if (!I->Forward) {     // Otherwise, we must merge the sets.
 225         FoundSet->mergeSetIn(*I, *this);     // Merge in contents.
 226       }
 227     }
 228
 229   return FoundSet;
 230 }
 231
 232
 233
 234
 235 /// getAliasSetForPointer - Return the alias set that the specified pointer
 236 /// lives in...
 237 AliasSet &AliasSetTracker::getAliasSetForPointer(Value *Pointer, unsigned Size,
 238                                                  bool *New) {
 239   AliasSet::HashNodePair &Entry = getEntryFor(Pointer);
 240
 241   // Check to see if the pointer is already known...
 242   if (Entry.second.hasAliasSet()) {
 243     Entry.second.updateSize(Size);
 244     // Return the set!
 245     return *Entry.second.getAliasSet(*this)->getForwardedTarget(*this);
 246   } else if (AliasSet *AS = findAliasSetForPointer(Pointer, Size)) {
 247     // Add it to the alias set it aliases...
 248     AS->addPointer(*this, Entry, Size);
 249     return *AS;
 250   } else {
 251     if (New) *New = true;
 252     // Otherwise create a new alias set to hold the loaded pointer...
 253     AliasSets.push_back(new AliasSet());
 254     AliasSets.back().addPointer(*this, Entry, Size);
 255     return AliasSets.back();
 256   }
 257 }
 258
 259 bool AliasSetTracker::add(Value *Ptr, unsigned Size) {
 260   bool NewPtr;
 261   addPointer(Ptr, Size, AliasSet::NoModRef, NewPtr);
 262   return NewPtr;
 263 }
 264
 265
 266 bool AliasSetTracker::add(LoadInst *LI) {
 267   bool NewPtr;
 268   AliasSet &AS = addPointer(LI->getOperand(0),
 269                             AA.getTargetData().getTypeStoreSize(LI->getType()),
 270                             AliasSet::Refs, NewPtr);
 271   if (LI->isVolatile()) AS.setVolatile();
 272   return NewPtr;
 273 }
 274
 275 bool AliasSetTracker::add(StoreInst *SI) {
 276   bool NewPtr;
 277   Value *Val = SI->getOperand(0);
 278   AliasSet &AS = addPointer(SI->getOperand(1),
 279                             AA.getTargetData().getTypeStoreSize(Val->getType()),
 280                             AliasSet::Mods, NewPtr);
 281   if (SI->isVolatile()) AS.setVolatile();
 282   return NewPtr;
 283 }
 284
 285 bool AliasSetTracker::add(FreeInst *FI) {
 286   bool NewPtr;
 287   addPointer(FI->getOperand(0), ~0, AliasSet::Mods, NewPtr);
 288   return NewPtr;
 289 }
 290
 291 bool AliasSetTracker::add(VAArgInst *VAAI) {
 292   bool NewPtr;
 293   addPointer(VAAI->getOperand(0), ~0, AliasSet::ModRef, NewPtr);
 294   return NewPtr;
 295 }
 296
 297
 298 bool AliasSetTracker::add(CallSite CS) {
 299   if (AA.doesNotAccessMemory(CS))
 300     return true; // doesn't alias anything
 301
 302   AliasSet *AS = findAliasSetForCallSite(CS);
 303   if (!AS) {
 304     AliasSets.push_back(new AliasSet());
 305     AS = &AliasSets.back();
 306     AS->addCallSite(CS, AA);
 307     return true;
 308   } else {
 309     AS->addCallSite(CS, AA);
 310     return false;
 311   }
 312 }
 313
 314 bool AliasSetTracker::add(Instruction *I) {
 315   // Dispatch to one of the other add methods...
 316   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 317     return add(LI);
 318   else if (StoreInst *SI = dyn_cast<StoreInst>(I))
 319     return add(SI);
 320   else if (CallInst *CI = dyn_cast<CallInst>(I))
 321     return add(CI);
 322   else if (InvokeInst *II = dyn_cast<InvokeInst>(I))
 323     return add(II);
 324   else if (FreeInst *FI = dyn_cast<FreeInst>(I))
 325     return add(FI);
 326   else if (VAArgInst *VAAI = dyn_cast<VAArgInst>(I))
 327     return add(VAAI);
 328   return true;
 329 }
 330
 331 void AliasSetTracker::add(BasicBlock &BB) {
 332   for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
 333     add(I);
 334 }
 335
 336 void AliasSetTracker::add(const AliasSetTracker &AST) {
 337   assert(&AA == &AST.AA &&
 338          "Merging AliasSetTracker objects with different Alias Analyses!");
 339
 340   // Loop over all of the alias sets in AST, adding the pointers contained
 341   // therein into the current alias sets.  This can cause alias sets to be
 342   // merged together in the current AST.
 343   for (const_iterator I = AST.begin(), E = AST.end(); I != E; ++I)
 344     if (!I->Forward) {   // Ignore forwarding alias sets
 345       AliasSet &AS = const_cast<AliasSet&>(*I);
 346
 347       // If there are any call sites in the alias set, add them to this AST.
 348       for (unsigned i = 0, e = AS.CallSites.size(); i != e; ++i)
 349         add(AS.CallSites[i]);
 350
 351       // Loop over all of the pointers in this alias set...
 352       AliasSet::iterator I = AS.begin(), E = AS.end();
 353       bool X;
 354       for (; I != E; ++I) {
 355         AliasSet &NewAS = addPointer(I.getPointer(), I.getSize(),
 356                                      (AliasSet::AccessType)AS.AccessTy, X);
 357         if (AS.isVolatile()) NewAS.setVolatile();
 358       }
 359     }
 360 }
 361
 362 /// remove - Remove the specified (potentially non-empty) alias set from the
 363 /// tracker.
 364 void AliasSetTracker::remove(AliasSet &AS) {
 365   // Drop all call sites.
 366   AS.CallSites.clear();
 367
 368   // Clear the alias set.
 369   unsigned NumRefs = 0;
 370   while (!AS.empty()) {
 371     AliasSet::HashNodePair *P = AS.PtrList;
 372
 373     // Unlink from the list of values.
 374     P->second.removeFromList();
 375
 376     // Remember how many references need to be dropped.
 377     ++NumRefs;
 378
 379     // Finally, remove the entry.
 380     Value *Remove = P->first;   // Take a copy because it is invalid to pass
 381     PointerMap.erase(Remove);   // a reference to the data being erased.
 382   }
 383
 384   // Stop using the alias set, removing it.
 385   AS.RefCount -= NumRefs;
 386   if (AS.RefCount == 0)
 387     AS.removeFromTracker(*this);
 388 }
 389
 390 bool AliasSetTracker::remove(Value *Ptr, unsigned Size) {
 391   AliasSet *AS = findAliasSetForPointer(Ptr, Size);
 392   if (!AS) return false;
 393   remove(*AS);
 394   return true;
 395 }
 396
 397 bool AliasSetTracker::remove(LoadInst *LI) {
 398   unsigned Size = AA.getTargetData().getTypeStoreSize(LI->getType());
 399   AliasSet *AS = findAliasSetForPointer(LI->getOperand(0), Size);
 400   if (!AS) return false;
 401   remove(*AS);
 402   return true;
 403 }
 404
 405 bool AliasSetTracker::remove(StoreInst *SI) {
 406   unsigned Size =
 407     AA.getTargetData().getTypeStoreSize(SI->getOperand(0)->getType());
 408   AliasSet *AS = findAliasSetForPointer(SI->getOperand(1), Size);
 409   if (!AS) return false;
 410   remove(*AS);
 411   return true;
 412 }
 413
 414 bool AliasSetTracker::remove(FreeInst *FI) {
 415   AliasSet *AS = findAliasSetForPointer(FI->getOperand(0), ~0);
 416   if (!AS) return false;
 417   remove(*AS);
 418   return true;
 419 }
 420
 421 bool AliasSetTracker::remove(VAArgInst *VAAI) {
 422   AliasSet *AS = findAliasSetForPointer(VAAI->getOperand(0), ~0);
 423   if (!AS) return false;
 424   remove(*AS);
 425   return true;
 426 }
 427
 428 bool AliasSetTracker::remove(CallSite CS) {
 429   if (AA.doesNotAccessMemory(CS))
 430     return false; // doesn't alias anything
 431
 432   AliasSet *AS = findAliasSetForCallSite(CS);
 433   if (!AS) return false;
 434   remove(*AS);
 435   return true;
 436 }
 437
 438 bool AliasSetTracker::remove(Instruction *I) {
 439   // Dispatch to one of the other remove methods...
 440   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 441     return remove(LI);
 442   else if (StoreInst *SI = dyn_cast<StoreInst>(I))
 443     return remove(SI);
 444   else if (CallInst *CI = dyn_cast<CallInst>(I))
 445     return remove(CI);
 446   else if (FreeInst *FI = dyn_cast<FreeInst>(I))
 447     return remove(FI);
 448   else if (VAArgInst *VAAI = dyn_cast<VAArgInst>(I))
 449     return remove(VAAI);
 450   return true;
 451 }
 452
 453
 454 // deleteValue method - This method is used to remove a pointer value from the
 455 // AliasSetTracker entirely.  It should be used when an instruction is deleted
 456 // from the program to update the AST.  If you don't use this, you would have
 457 // dangling pointers to deleted instructions.
 458 //
 459 void AliasSetTracker::deleteValue(Value *PtrVal) {
 460   // Notify the alias analysis implementation that this value is gone.
 461   AA.deleteValue(PtrVal);
 462
 463   // If this is a call instruction, remove the callsite from the appropriate
 464   // AliasSet.
 465   CallSite CS = CallSite::get(PtrVal);
 466   if (CS.getInstruction())
 467     if (!AA.doesNotAccessMemory(CS))
 468       if (AliasSet *AS = findAliasSetForCallSite(CS))
 469         AS->removeCallSite(CS);
 470
 471   // First, look up the PointerRec for this pointer.
 472   hash_map<Value*, AliasSet::PointerRec>::iterator I = PointerMap.find(PtrVal);
 473   if (I == PointerMap.end()) return;  // Noop
 474
 475   // If we found one, remove the pointer from the alias set it is in.
 476   AliasSet::HashNodePair &PtrValEnt = *I;
 477   AliasSet *AS = PtrValEnt.second.getAliasSet(*this);
 478
 479   // Unlink from the list of values...
 480   PtrValEnt.second.removeFromList();
 481   // Stop using the alias set
 482   AS->dropRef(*this);
 483   PointerMap.erase(I);
 484 }
 485
 486 // copyValue - This method should be used whenever a preexisting value in the
 487 // program is copied or cloned, introducing a new value.  Note that it is ok for
 488 // clients that use this method to introduce the same value multiple times: if
 489 // the tracker already knows about a value, it will ignore the request.
 490 //
 491 void AliasSetTracker::copyValue(Value *From, Value *To) {
 492   // Notify the alias analysis implementation that this value is copied.
 493   AA.copyValue(From, To);
 494
 495   // First, look up the PointerRec for this pointer.
 496   hash_map<Value*, AliasSet::PointerRec>::iterator I = PointerMap.find(From);
 497   if (I == PointerMap.end() || !I->second.hasAliasSet())
 498     return;  // Noop
 499
 500   AliasSet::HashNodePair &Entry = getEntryFor(To);
 501   if (Entry.second.hasAliasSet()) return;    // Already in the tracker!
 502
 503   // Add it to the alias set it aliases...
 504   AliasSet *AS = I->second.getAliasSet(*this);
 505   AS->addPointer(*this, Entry, I->second.getSize(), true);
 506 }
 507
 508
 509
 510 //===----------------------------------------------------------------------===//
 511 //               AliasSet/AliasSetTracker Printing Support
 512 //===----------------------------------------------------------------------===//
 513
 514 void AliasSet::print(std::ostream &OS) const {
 515   OS << "  AliasSet[" << (void*)this << "," << RefCount << "] ";
 516   OS << (AliasTy == MustAlias ? "must" : "may") << " alias, ";
 517   switch (AccessTy) {
 518   case NoModRef: OS << "No access "; break;
 519   case Refs    : OS << "Ref       "; break;
 520   case Mods    : OS << "Mod       "; break;
 521   case ModRef  : OS << "Mod/Ref   "; break;
 522   default: assert(0 && "Bad value for AccessTy!");
 523   }
 524   if (isVolatile()) OS << "[volatile] ";
 525   if (Forward)
 526     OS << " forwarding to " << (void*)Forward;
 527
 528
 529   if (!empty()) {
 530     OS << "Pointers: ";
 531     for (iterator I = begin(), E = end(); I != E; ++I) {
 532       if (I != begin()) OS << ", ";
 533       WriteAsOperand(OS << "(", I.getPointer());
 534       OS << ", " << I.getSize() << ")";
 535     }
 536   }
 537   if (!CallSites.empty()) {
 538     OS << "\n    " << CallSites.size() << " Call Sites: ";
 539     for (unsigned i = 0, e = CallSites.size(); i != e; ++i) {
 540       if (i) OS << ", ";
 541       WriteAsOperand(OS, CallSites[i].getCalledValue());
 542     }
 543   }
 544   OS << "\n";
 545 }
 546
 547 void AliasSetTracker::print(std::ostream &OS) const {
 548   OS << "Alias Set Tracker: " << AliasSets.size() << " alias sets for "
 549      << PointerMap.size() << " pointer values.\n";
 550   for (const_iterator I = begin(), E = end(); I != E; ++I)
 551     I->print(OS);
 552   OS << "\n";
 553 }
 554
 555 void AliasSet::dump() const { print (cerr); }
 556 void AliasSetTracker::dump() const { print(cerr); }
 557
 558 //===----------------------------------------------------------------------===//
 559 //                            AliasSetPrinter Pass
 560 //===----------------------------------------------------------------------===//
 561
 562 namespace {
 563   class VISIBILITY_HIDDEN AliasSetPrinter : public FunctionPass {
 564     AliasSetTracker *Tracker;
 565   public:
 566     static char ID; // Pass identification, replacement for typeid
 567     AliasSetPrinter() : FunctionPass((intptr_t)&ID) {}
 568
 569     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 570       AU.setPreservesAll();
 571       AU.addRequired<AliasAnalysis>();
 572     }
 573
 574     virtual bool runOnFunction(Function &F) {
 575       Tracker = new AliasSetTracker(getAnalysis<AliasAnalysis>());
 576
 577       for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
 578         Tracker->add(&*I);
 579       Tracker->print(cerr);
 580       delete Tracker;
 581       return false;
 582     }
 583   };
 584 }
 585
 586 char AliasSetPrinter::ID = 0;
 587 static RegisterPass<AliasSetPrinter>
 588 X("print-alias-sets", "Alias Set Printer", false, true);