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 using namespace llvm;
  24
  25 /// mergeSetIn - Merge the specified alias set into this alias set...
  26 ///
  27 void AliasSet::mergeSetIn(AliasSet &AS) {
  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 (CallSites.empty()) {            // Merge call sites...
  36     if (!AS.CallSites.empty())
  37       std::swap(CallSites, AS.CallSites);
  38   } else if (!AS.CallSites.empty()) {
  39     CallSites.insert(CallSites.end(), AS.CallSites.begin(), AS.CallSites.end());
  40     AS.CallSites.clear();
  41   }
  42
  43   // FIXME: If AS's refcount is zero, nuke it now...
  44   assert(RefCount != 0);
  45
  46   AS.Forward = this;  // Forward across AS now...
  47   RefCount++;         // AS is now pointing to us...
  48
  49   // Merge the list of constituent pointers...
  50   PtrListTail->second.setTail(AS.PtrListHead);
  51   PtrListTail = AS.PtrListTail;
  52   AS.PtrListHead = AS.PtrListTail = 0;
  53 }
  54
  55 void AliasSetTracker::removeAliasSet(AliasSet *AS) {
  56   AliasSets.erase(AS);
  57 }
  58
  59 void AliasSet::removeFromTracker(AliasSetTracker &AST) {
  60   assert(RefCount == 0 && "Cannot remove non-dead alias set from tracker!");
  61   AST.removeAliasSet(this);
  62 }
  63
  64 void AliasSet::addPointer(AliasSetTracker &AST, HashNodePair &Entry,
  65                           unsigned Size) {
  66   assert(!Entry.second.hasAliasSet() && "Entry already in set!");
  67
  68   AliasAnalysis &AA = AST.getAliasAnalysis();
  69
  70   if (isMustAlias())    // Check to see if we have to downgrade to _may_ alias
  71     if (HashNodePair *P = getSomePointer()) {
  72       AliasAnalysis::AliasResult Result =
  73         AA.alias(P->first, P->second.getSize(), Entry.first, Size);
  74       if (Result == AliasAnalysis::MayAlias)
  75         AliasTy = MayAlias;
  76       else                  // First entry of must alias must have maximum size!
  77         P->second.updateSize(Size);
  78       assert(Result != AliasAnalysis::NoAlias && "Cannot be part of must set!");
  79     }
  80
  81   Entry.second.setAliasSet(this);
  82   Entry.second.updateSize(Size);
  83
  84   // Add it to the end of the list...
  85   if (PtrListTail)
  86     PtrListTail->second.setTail(&Entry);
  87   else
  88     PtrListHead = &Entry;
  89   PtrListTail = &Entry;
  90   RefCount++;               // Entry points to alias set...
  91 }
  92
  93 void AliasSet::addCallSite(CallSite CS) {
  94   CallSites.push_back(CS);
  95   AliasTy = MayAlias;         // FIXME: Too conservative?
  96   AccessTy = ModRef;
  97 }
  98
  99 /// aliasesPointer - Return true if the specified pointer "may" (or must)
 100 /// alias one of the members in the set.
 101 ///
 102 bool AliasSet::aliasesPointer(const Value *Ptr, unsigned Size,
 103                               AliasAnalysis &AA) const {
 104   if (AliasTy == MustAlias) {
 105     assert(CallSites.empty() && "Illegal must alias set!");
 106
 107     // If this is a set of MustAliases, only check to see if the pointer aliases
 108     // SOME value in the set...
 109     HashNodePair *SomePtr = getSomePointer();
 110     assert(SomePtr && "Empty must-alias set??");
 111     return AA.alias(SomePtr->first, SomePtr->second.getSize(), Ptr, Size);
 112   }
 113
 114   // If this is a may-alias set, we have to check all of the pointers in the set
 115   // to be sure it doesn't alias the set...
 116   for (iterator I = begin(), E = end(); I != E; ++I)
 117     if (AA.alias(Ptr, Size, I->first, I->second.getSize()))
 118       return true;
 119
 120   // Check the call sites list and invoke list...
 121   if (!CallSites.empty())
 122     // FIXME: this is pessimistic!
 123     return true;
 124
 125   return false;
 126 }
 127
 128 bool AliasSet::aliasesCallSite(CallSite CS, AliasAnalysis &AA) const {
 129   // FIXME: Too conservative!
 130   return true;
 131 }
 132
 133
 134 /// findAliasSetForPointer - Given a pointer, find the one alias set to put the
 135 /// instruction referring to the pointer into.  If there are multiple alias sets
 136 /// that may alias the pointer, merge them together and return the unified set.
 137 ///
 138 AliasSet *AliasSetTracker::findAliasSetForPointer(const Value *Ptr,
 139                                                   unsigned Size) {
 140   AliasSet *FoundSet = 0;
 141   for (iterator I = begin(), E = end(); I != E; ++I)
 142     if (!I->Forward && I->aliasesPointer(Ptr, Size, AA)) {
 143       if (FoundSet == 0) {  // If this is the first alias set ptr can go into...
 144         FoundSet = I;       // Remember it.
 145       } else {              // Otherwise, we must merge the sets...
 146         FoundSet->mergeSetIn(*I);     // Merge in contents...
 147       }
 148     }
 149
 150   return FoundSet;
 151 }
 152
 153 AliasSet *AliasSetTracker::findAliasSetForCallSite(CallSite CS) {
 154   AliasSet *FoundSet = 0;
 155   for (iterator I = begin(), E = end(); I != E; ++I)
 156     if (!I->Forward && I->aliasesCallSite(CS, AA)) {
 157       if (FoundSet == 0) {  // If this is the first alias set ptr can go into...
 158         FoundSet = I;       // Remember it.
 159       } else if (!I->Forward) {     // Otherwise, we must merge the sets...
 160         FoundSet->mergeSetIn(*I);     // Merge in contents...
 161       }
 162     }
 163
 164   return FoundSet;
 165 }
 166
 167
 168
 169
 170 /// getAliasSetForPointer - Return the alias set that the specified pointer
 171 /// lives in...
 172 AliasSet &AliasSetTracker::getAliasSetForPointer(Value *Pointer, unsigned Size){
 173   AliasSet::HashNodePair &Entry = getEntryFor(Pointer);
 174
 175   // Check to see if the pointer is already known...
 176   if (Entry.second.hasAliasSet() && Size <= Entry.second.getSize()) {
 177     // Return the set!
 178     return *Entry.second.getAliasSet(*this)->getForwardedTarget(*this);
 179   } else if (AliasSet *AS = findAliasSetForPointer(Pointer, Size)) {
 180     // Add it to the alias set it aliases...
 181     AS->addPointer(*this, Entry, Size);
 182     return *AS;
 183   } else {
 184     // Otherwise create a new alias set to hold the loaded pointer...
 185     AliasSets.push_back(AliasSet());
 186     AliasSets.back().addPointer(*this, Entry, Size);
 187     return AliasSets.back();
 188   }
 189 }
 190
 191 void AliasSetTracker::add(LoadInst *LI) {
 192   AliasSet &AS =
 193     addPointer(LI->getOperand(0),
 194                AA.getTargetData().getTypeSize(LI->getType()), AliasSet::Refs);
 195   if (LI->isVolatile()) AS.setVolatile();
 196 }
 197
 198 void AliasSetTracker::add(StoreInst *SI) {
 199   AliasSet &AS =
 200     addPointer(SI->getOperand(1),
 201                AA.getTargetData().getTypeSize(SI->getOperand(0)->getType()),
 202                AliasSet::Mods);
 203   if (SI->isVolatile()) AS.setVolatile();
 204 }
 205
 206
 207 void AliasSetTracker::add(CallSite CS) {
 208   AliasSet *AS = findAliasSetForCallSite(CS);
 209   if (!AS) {
 210     AliasSets.push_back(AliasSet());
 211     AS = &AliasSets.back();
 212   }
 213   AS->addCallSite(CS);
 214 }
 215
 216 void AliasSetTracker::add(Instruction *I) {
 217   // Dispatch to one of the other add methods...
 218   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 219     add(LI);
 220   else if (StoreInst *SI = dyn_cast<StoreInst>(I))
 221     add(SI);
 222   else if (CallInst *CI = dyn_cast<CallInst>(I))
 223     add(CI);
 224   else if (InvokeInst *II = dyn_cast<InvokeInst>(I))
 225     add(II);
 226 }
 227
 228 void AliasSetTracker::add(BasicBlock &BB) {
 229   for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
 230     add(I);
 231 }
 232
 233 void AliasSetTracker::add(const AliasSetTracker &AST) {
 234   assert(&AA == &AST.AA &&
 235          "Merging AliasSetTracker objects with different Alias Analyses!");
 236
 237   // Loop over all of the alias sets in AST, adding the pointers contained
 238   // therein into the current alias sets.  This can cause alias sets to be
 239   // merged together in the current AST.
 240   for (const_iterator I = AST.begin(), E = AST.end(); I != E; ++I)
 241     if (!I->Forward) {   // Ignore forwarding alias sets
 242       AliasSet &AS = const_cast<AliasSet&>(*I);
 243
 244       // If there are any call sites in the alias set, add them to this AST.
 245       for (unsigned i = 0, e = AS.CallSites.size(); i != e; ++i)
 246         add(AS.CallSites[i]);
 247
 248       // Loop over all of the pointers in this alias set...
 249       AliasSet::iterator I = AS.begin(), E = AS.end();
 250       for (; I != E; ++I)
 251         addPointer(I->first, I->second.getSize(),
 252                    (AliasSet::AccessType)AS.AccessTy);
 253     }
 254 }
 255
 256 //===----------------------------------------------------------------------===//
 257 //               AliasSet/AliasSetTracker Printing Support
 258 //===----------------------------------------------------------------------===//
 259
 260 void AliasSet::print(std::ostream &OS) const {
 261   OS << "  AliasSet[" << (void*)this << "," << RefCount << "] ";
 262   OS << (AliasTy == MustAlias ? "must" : "may ") << " alias, ";
 263   switch (AccessTy) {
 264   case NoModRef: OS << "No access "; break;
 265   case Refs    : OS << "Ref       "; break;
 266   case Mods    : OS << "Mod       "; break;
 267   case ModRef  : OS << "Mod/Ref   "; break;
 268   default: assert(0 && "Bad value for AccessTy!");
 269   }
 270   if (isVolatile()) OS << "[volatile] ";
 271   if (Forward)
 272     OS << " forwarding to " << (void*)Forward;
 273
 274
 275   if (begin() != end()) {
 276     OS << "Pointers: ";
 277     for (iterator I = begin(), E = end(); I != E; ++I) {
 278       if (I != begin()) OS << ", ";
 279       WriteAsOperand(OS << "(", I->first);
 280       OS << ", " << I->second.getSize() << ")";
 281     }
 282   }
 283   if (!CallSites.empty()) {
 284     OS << "\n    " << CallSites.size() << " Call Sites: ";
 285     for (unsigned i = 0, e = CallSites.size(); i != e; ++i) {
 286       if (i) OS << ", ";
 287       WriteAsOperand(OS, CallSites[i].getCalledValue());
 288     }
 289   }
 290   OS << "\n";
 291 }
 292
 293 void AliasSetTracker::print(std::ostream &OS) const {
 294   OS << "Alias Set Tracker: " << AliasSets.size() << " alias sets for "
 295      << PointerMap.size() << " pointer values.\n";
 296   for (const_iterator I = begin(), E = end(); I != E; ++I)
 297     I->print(OS);
 298   OS << "\n";
 299 }
 300
 301 void AliasSet::dump() const { print (std::cerr); }
 302 void AliasSetTracker::dump() const { print(std::cerr); }
 303
 304 //===----------------------------------------------------------------------===//
 305 //                            AliasSetPrinter Pass
 306 //===----------------------------------------------------------------------===//
 307
 308 namespace {
 309   class AliasSetPrinter : public FunctionPass {
 310     AliasSetTracker *Tracker;
 311   public:
 312     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 313       AU.setPreservesAll();
 314       AU.addRequired<AliasAnalysis>();
 315     }
 316
 317     virtual bool runOnFunction(Function &F) {
 318       Tracker = new AliasSetTracker(getAnalysis<AliasAnalysis>());
 319
 320       for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
 321         Tracker->add(*I);
 322       return false;
 323     }
 324
 325     /// print - Convert to human readable form
 326     virtual void print(std::ostream &OS) const {
 327       Tracker->print(OS);
 328     }
 329
 330     virtual void releaseMemory() {
 331       delete Tracker;
 332     }
 333   };
 334   RegisterPass<AliasSetPrinter> X("print-alias-sets", "Alias Set Printer",
 335                                   PassInfo::Analysis | PassInfo::Optimization);
 336 }