lib/Analysis/AliasSetTracker.cpp

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