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