lib/Analysis/DataStructure/DataStructureAA.cpp

   1 //===- DataStructureAA.cpp - Data Structure Based Alias Analysis ----------===//
   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 pass uses the top-down data structure graphs to implement a simple
  11 // context sensitive alias analysis.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Constants.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Analysis/AliasAnalysis.h"
  19 #include "llvm/Analysis/Passes.h"
  20 #include "llvm/Analysis/DataStructure/DataStructure.h"
  21 #include "llvm/Analysis/DataStructure/DSGraph.h"
  22 using namespace llvm;
  23
  24 namespace {
  25   class DSAA : public ModulePass, public AliasAnalysis {
  26     TDDataStructures *TD;
  27     BUDataStructures *BU;
  28   public:
  29     DSAA() : TD(0) {}
  30
  31     //------------------------------------------------
  32     // Implement the Pass API
  33     //
  34
  35     // run - Build up the result graph, representing the pointer graph for the
  36     // program.
  37     //
  38     bool runOnModule(Module &M) {
  39       InitializeAliasAnalysis(this);
  40       TD = &getAnalysis<TDDataStructures>();
  41       BU = &getAnalysis<BUDataStructures>();
  42       return false;
  43     }
  44
  45     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  46       AliasAnalysis::getAnalysisUsage(AU);
  47       AU.setPreservesAll();                         // Does not transform code
  48       AU.addRequiredTransitive<TDDataStructures>(); // Uses TD Datastructures
  49       AU.addRequiredTransitive<BUDataStructures>(); // Uses BU Datastructures
  50     }
  51
  52     //------------------------------------------------
  53     // Implement the AliasAnalysis API
  54     //
  55
  56     AliasResult alias(const Value *V1, unsigned V1Size,
  57                       const Value *V2, unsigned V2Size);
  58
  59     void getMustAliases(Value *P, std::vector<Value*> &RetVals);
  60
  61     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
  62     ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
  63       return AliasAnalysis::getModRefInfo(CS1,CS2);
  64     }
  65
  66     virtual void deleteValue(Value *V) {
  67       BU->deleteValue(V);
  68       TD->deleteValue(V);
  69     }
  70
  71     virtual void copyValue(Value *From, Value *To) {
  72       if (From == To) return;
  73       BU->copyValue(From, To);
  74       TD->copyValue(From, To);
  75     }
  76
  77   private:
  78     DSGraph *getGraphForValue(const Value *V);
  79   };
  80
  81   // Register the pass...
  82   RegisterOpt<DSAA> X("ds-aa", "Data Structure Graph Based Alias Analysis");
  83
  84   // Register as an implementation of AliasAnalysis
  85   RegisterAnalysisGroup<AliasAnalysis, DSAA> Y;
  86 }
  87
  88 ModulePass *llvm::createDSAAPass() { return new DSAA(); }
  89
  90 // getGraphForValue - Return the DSGraph to use for queries about the specified
  91 // value...
  92 //
  93 DSGraph *DSAA::getGraphForValue(const Value *V) {
  94   if (const Instruction *I = dyn_cast<Instruction>(V))
  95     return &TD->getDSGraph(*I->getParent()->getParent());
  96   else if (const Argument *A = dyn_cast<Argument>(V))
  97     return &TD->getDSGraph(*A->getParent());
  98   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
  99     return &TD->getDSGraph(*BB->getParent());
 100   return 0;
 101 }
 102
 103 #if 0
 104 // isSinglePhysicalObject - For now, the only case that we know that there is
 105 // only one memory object in the node is when there is a single global in the
 106 // node, and the only composition bit set is Global.
 107 //
 108 static bool isSinglePhysicalObject(DSNode *N) {
 109   assert(N->isComplete() && "Can only tell if this is a complete object!");
 110   return N->isGlobalNode() && N->getGlobals().size() == 1 &&
 111          !N->isHeapNode() && !N->isAllocaNode() && !N->isUnknownNode();
 112 }
 113 #endif
 114
 115 // alias - This is the only method here that does anything interesting...
 116 AliasAnalysis::AliasResult DSAA::alias(const Value *V1, unsigned V1Size,
 117                                        const Value *V2, unsigned V2Size) {
 118   if (V1 == V2) return MustAlias;
 119
 120   DSGraph *G1 = getGraphForValue(V1);
 121   DSGraph *G2 = getGraphForValue(V2);
 122   assert((!G1 || !G2 || G1 == G2) && "Alias query for 2 different functions?");
 123
 124   // Get the graph to use...
 125   DSGraph &G = *(G1 ? G1 : (G2 ? G2 : &TD->getGlobalsGraph()));
 126
 127   const DSGraph::ScalarMapTy &GSM = G.getScalarMap();
 128   DSGraph::ScalarMapTy::const_iterator I = GSM.find((Value*)V1);
 129   if (I == GSM.end()) return NoAlias;
 130
 131   DSGraph::ScalarMapTy::const_iterator J = GSM.find((Value*)V2);
 132   if (J == GSM.end()) return NoAlias;
 133
 134   DSNode  *N1 = I->second.getNode(),  *N2 = J->second.getNode();
 135   unsigned O1 = I->second.getOffset(), O2 = J->second.getOffset();
 136   if (N1 == 0 || N2 == 0)
 137     return MayAlias;  // Can't tell whether anything aliases null.
 138
 139   // We can only make a judgment of one of the nodes is complete...
 140   if (N1->isComplete() || N2->isComplete()) {
 141     if (N1 != N2)
 142       return NoAlias;   // Completely different nodes.
 143
 144 #if 0  // This does not correctly handle arrays!
 145     // Both point to the same node and same offset, and there is only one
 146     // physical memory object represented in the node, return must alias.
 147     //
 148     // FIXME: This isn't correct because we do not handle array indexing
 149     // correctly.
 150
 151     if (O1 == O2 && isSinglePhysicalObject(N1))
 152       return MustAlias; // Exactly the same object & offset
 153 #endif
 154
 155     // See if they point to different offsets...  if so, we may be able to
 156     // determine that they do not alias...
 157     if (O1 != O2) {
 158       if (O2 < O1) {    // Ensure that O1 <= O2
 159         std::swap(V1, V2);
 160         std::swap(O1, O2);
 161         std::swap(V1Size, V2Size);
 162       }
 163
 164       if (O1+V1Size <= O2)
 165         return NoAlias;
 166     }
 167   }
 168
 169   // FIXME: we could improve on this by checking the globals graph for aliased
 170   // global queries...
 171   return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
 172 }
 173
 174 /// getModRefInfo - does a callsite modify or reference a value?
 175 ///
 176 AliasAnalysis::ModRefResult
 177 DSAA::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 178   AliasAnalysis::ModRefResult Result =AliasAnalysis::getModRefInfo(CS, P, Size);
 179   Function *F = CS.getCalledFunction();
 180
 181   if (!F || Result == NoModRef)
 182     return Result;
 183
 184   if (F->isExternal()) {
 185     // If we are calling an external function, and if this global doesn't escape
 186     // the portion of the program we have analyzed, we can draw conclusions
 187     // based on whether the global escapes the program.
 188     Function *Caller = CS.getInstruction()->getParent()->getParent();
 189     DSGraph *G = &TD->getDSGraph(*Caller);
 190     DSScalarMap::iterator NI = G->getScalarMap().find(P);
 191     if (NI == G->getScalarMap().end()) {
 192       // If it wasn't in the local function graph, check the global graph.  This
 193       // can occur for globals who are locally reference but hoisted out to the
 194       // globals graph despite that.
 195       G = G->getGlobalsGraph();
 196       NI = G->getScalarMap().find(P);
 197       if (NI == G->getScalarMap().end())
 198         return Result;
 199     }
 200
 201     // If we found a node and it's complete, it cannot be passed out to the
 202     // called function.
 203     if (NI->second.getNode()->isComplete())
 204       return NoModRef;
 205     return Result;
 206   }
 207
 208   // Get the graphs for the callee and caller.  Note that we want the BU graph
 209   // for the callee because we don't want all caller's effects incorporated!
 210   const Function *Caller = CS.getInstruction()->getParent()->getParent();
 211   DSGraph &CallerTDGraph = TD->getDSGraph(*Caller);
 212   DSGraph &CalleeBUGraph = BU->getDSGraph(*F);
 213
 214   // Figure out which node in the TD graph this pointer corresponds to.
 215   DSScalarMap &CallerSM = CallerTDGraph.getScalarMap();
 216   DSScalarMap::iterator NI = CallerSM.find(P);
 217   if (NI == CallerSM.end()) {
 218     if (isa<ConstantPointerNull>(P) || isa<UndefValue>(P))
 219       Result = NoModRef;                 // null is never modified :)
 220     else {
 221       assert(isa<GlobalVariable>(P) &&
 222     cast<GlobalVariable>(P)->getType()->getElementType()->isFirstClassType() &&
 223              "This isn't a global that DSA inconsiderately dropped "
 224              "from the graph?");
 225     }
 226     return Result;
 227   }
 228
 229   const DSNode *N = NI->second.getNode();
 230   assert(N && "Null pointer in scalar map??");
 231
 232   // Compute the mapping from nodes in the callee graph to the nodes in the
 233   // caller graph for this call site.
 234   DSGraph::NodeMapTy CalleeCallerMap;
 235   DSCallSite DSCS = CallerTDGraph.getDSCallSiteForCallSite(CS);
 236   CallerTDGraph.computeCalleeCallerMapping(DSCS, *F, CalleeBUGraph,
 237                                            CalleeCallerMap);
 238
 239   // Loop over all of the nodes in the callee that correspond to "N", keeping
 240   // track of aggregate mod/ref info.
 241   bool NeverReads = true, NeverWrites = true;
 242   for (DSGraph::NodeMapTy::iterator I = CalleeCallerMap.begin(),
 243          E = CalleeCallerMap.end(); I != E; ++I)
 244     if (I->second.getNode() == N) {
 245       if (I->first->isModified())
 246         NeverWrites = false;
 247       if (I->first->isRead())
 248         NeverReads = false;
 249       if (NeverReads == false && NeverWrites == false)
 250         return Result;
 251     }
 252
 253   if (NeverWrites)      // We proved it was not modified.
 254     Result = ModRefResult(Result & ~Mod);
 255   if (NeverReads)       // We proved it was not read.
 256     Result = ModRefResult(Result & ~Ref);
 257
 258   return Result;
 259 }
 260
 261
 262 /// getMustAliases - If there are any pointers known that must alias this
 263 /// pointer, return them now.  This allows alias-set based alias analyses to
 264 /// perform a form a value numbering (which is exposed by load-vn).  If an alias
 265 /// analysis supports this, it should ADD any must aliased pointers to the
 266 /// specified vector.
 267 ///
 268 void DSAA::getMustAliases(Value *P, std::vector<Value*> &RetVals) {
 269 #if 0    // This does not correctly handle arrays!
 270   // Currently the only must alias information we can provide is to say that
 271   // something is equal to a global value. If we already have a global value,
 272   // don't get worked up about it.
 273   if (!isa<GlobalValue>(P)) {
 274     DSGraph *G = getGraphForValue(P);
 275     if (!G) G = &TD->getGlobalsGraph();
 276
 277     // The only must alias information we can currently determine occurs when
 278     // the node for P is a global node with only one entry.
 279     DSGraph::ScalarMapTy::const_iterator I = G->getScalarMap().find(P);
 280     if (I != G->getScalarMap().end()) {
 281       DSNode *N = I->second.getNode();
 282       if (N->isComplete() && isSinglePhysicalObject(N))
 283         RetVals.push_back(N->getGlobals()[0]);
 284     }
 285   }
 286 #endif
 287   return AliasAnalysis::getMustAliases(P, RetVals);
 288 }
 289