lib/Analysis/DataStructure/Steensgaard.cpp

   1 //===- Steensgaard.cpp - Context Insensitive 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 data structure graphs to implement a simple context
  11 // insensitive alias analysis.  It does this by computing the local analysis
  12 // graphs for all of the functions, then merging them together into a single big
  13 // graph without cloning.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/DataStructure/DataStructure.h"
  18 #include "llvm/Analysis/DataStructure/DSGraph.h"
  19 #include "llvm/Analysis/AliasAnalysis.h"
  20 #include "llvm/Module.h"
  21 #include "Support/Debug.h"
  22 #include <iostream>
  23 using namespace llvm;
  24
  25 namespace {
  26   class Steens : public Pass, public AliasAnalysis {
  27     DSGraph *ResultGraph;
  28     DSGraph *GlobalsGraph;  // FIXME: Eliminate globals graph stuff from DNE
  29   public:
  30     Steens() : ResultGraph(0), GlobalsGraph(0) {}
  31     ~Steens() {
  32       releaseMyMemory();
  33       assert(ResultGraph == 0 && "releaseMemory not called?");
  34     }
  35
  36     //------------------------------------------------
  37     // Implement the Pass API
  38     //
  39
  40     // run - Build up the result graph, representing the pointer graph for the
  41     // program.
  42     //
  43     bool run(Module &M);
  44
  45     virtual void releaseMyMemory() { delete ResultGraph; ResultGraph = 0; }
  46
  47     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  48       AliasAnalysis::getAnalysisUsage(AU);
  49       AU.setPreservesAll();                    // Does not transform code...
  50       AU.addRequired<LocalDataStructures>();   // Uses local dsgraph
  51     }
  52
  53     // print - Implement the Pass::print method...
  54     void print(std::ostream &O, const Module *M) const {
  55       assert(ResultGraph && "Result graph has not yet been computed!");
  56       ResultGraph->writeGraphToFile(O, "steensgaards");
  57     }
  58
  59     //------------------------------------------------
  60     // Implement the AliasAnalysis API
  61     //
  62
  63     // alias - This is the only method here that does anything interesting...
  64     AliasResult alias(const Value *V1, unsigned V1Size,
  65                       const Value *V2, unsigned V2Size);
  66
  67   private:
  68     void ResolveFunctionCall(Function *F, const DSCallSite &Call,
  69                              DSNodeHandle &RetVal);
  70   };
  71
  72   // Register the pass...
  73   RegisterOpt<Steens> X("steens-aa",
  74                         "Steensgaard's alias analysis (DSGraph based)");
  75
  76   // Register as an implementation of AliasAnalysis
  77   RegisterAnalysisGroup<AliasAnalysis, Steens> Y;
  78 }
  79
  80 /// ResolveFunctionCall - Resolve the actual arguments of a call to function F
  81 /// with the specified call site descriptor.  This function links the arguments
  82 /// and the return value for the call site context-insensitively.
  83 ///
  84 void Steens::ResolveFunctionCall(Function *F, const DSCallSite &Call,
  85                                  DSNodeHandle &RetVal) {
  86   assert(ResultGraph != 0 && "Result graph not allocated!");
  87   DSGraph::ScalarMapTy &ValMap = ResultGraph->getScalarMap();
  88
  89   // Handle the return value of the function...
  90   if (Call.getRetVal().getNode() && RetVal.getNode())
  91     RetVal.mergeWith(Call.getRetVal());
  92
  93   // Loop over all pointer arguments, resolving them to their provided pointers
  94   unsigned PtrArgIdx = 0;
  95   for (Function::aiterator AI = F->abegin(), AE = F->aend();
  96        AI != AE && PtrArgIdx < Call.getNumPtrArgs(); ++AI) {
  97     DSGraph::ScalarMapTy::iterator I = ValMap.find(AI);
  98     if (I != ValMap.end())    // If its a pointer argument...
  99       I->second.mergeWith(Call.getPtrArg(PtrArgIdx++));
 100   }
 101 }
 102
 103
 104 /// run - Build up the result graph, representing the pointer graph for the
 105 /// program.
 106 ///
 107 bool Steens::run(Module &M) {
 108   InitializeAliasAnalysis(this);
 109   assert(ResultGraph == 0 && "Result graph already allocated!");
 110   LocalDataStructures &LDS = getAnalysis<LocalDataStructures>();
 111
 112   // Create a new, empty, graph...
 113   ResultGraph = new DSGraph(getTargetData());
 114   GlobalsGraph = new DSGraph(getTargetData());
 115   ResultGraph->setGlobalsGraph(GlobalsGraph);
 116   ResultGraph->setPrintAuxCalls();
 117
 118   // RetValMap - Keep track of the return values for all functions that return
 119   // valid pointers.
 120   //
 121   DSGraph::ReturnNodesTy RetValMap;
 122
 123   // Loop over the rest of the module, merging graphs for non-external functions
 124   // into this graph.
 125   //
 126   unsigned Count = 0;
 127   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 128     if (!I->isExternal()) {
 129       DSGraph::ScalarMapTy ValMap;
 130       {  // Scope to free NodeMap memory ASAP
 131         DSGraph::NodeMapTy NodeMap;
 132         const DSGraph &FDSG = LDS.getDSGraph(*I);
 133         ResultGraph->cloneInto(FDSG, ValMap, RetValMap, NodeMap,
 134                                DSGraph::UpdateInlinedGlobals);
 135       }
 136
 137       // Incorporate the inlined Function's ScalarMap into the global
 138       // ScalarMap...
 139       DSGraph::ScalarMapTy &GVM = ResultGraph->getScalarMap();
 140       for (DSGraph::ScalarMapTy::iterator I = ValMap.begin(),
 141              E = ValMap.end(); I != E; ++I)
 142         GVM[I->first].mergeWith(I->second);
 143
 144       if ((++Count & 1) == 0)   // Prune nodes out every other time...
 145         ResultGraph->removeTriviallyDeadNodes();
 146     }
 147
 148   // FIXME: Must recalculate and use the Incomplete markers!!
 149
 150   // Now that we have all of the graphs inlined, we can go about eliminating
 151   // call nodes...
 152   //
 153   std::vector<DSCallSite> &Calls =
 154     ResultGraph->getAuxFunctionCalls();
 155   assert(Calls.empty() && "Aux call list is already in use??");
 156
 157   // Start with a copy of the original call sites...
 158   Calls = ResultGraph->getFunctionCalls();
 159
 160   for (unsigned i = 0; i != Calls.size(); ) {
 161     DSCallSite &CurCall = Calls[i];
 162
 163     // Loop over the called functions, eliminating as many as possible...
 164     std::vector<GlobalValue*> CallTargets;
 165     if (CurCall.isDirectCall())
 166       CallTargets.push_back(CurCall.getCalleeFunc());
 167     else
 168       CallTargets = CurCall.getCalleeNode()->getGlobals();
 169
 170     for (unsigned c = 0; c != CallTargets.size(); ) {
 171       // If we can eliminate this function call, do so!
 172       bool Eliminated = false;
 173       if (Function *F = dyn_cast<Function>(CallTargets[c]))
 174         if (!F->isExternal()) {
 175           ResolveFunctionCall(F, CurCall, RetValMap[F]);
 176           Eliminated = true;
 177         }
 178       if (Eliminated) {
 179         CallTargets[c] = CallTargets.back();
 180         CallTargets.pop_back();
 181       } else
 182         ++c;  // Cannot eliminate this call, skip over it...
 183     }
 184
 185     if (CallTargets.empty()) {        // Eliminated all calls?
 186       CurCall = Calls.back();         // Remove entry
 187       Calls.pop_back();
 188     } else
 189       ++i;                            // Skip this call site...
 190   }
 191
 192   RetValMap.clear();
 193
 194   // Update the "incomplete" markers on the nodes, ignoring unknownness due to
 195   // incoming arguments...
 196   ResultGraph->maskIncompleteMarkers();
 197   ResultGraph->markIncompleteNodes(DSGraph::IgnoreFormalArgs);
 198
 199   // Remove any nodes that are dead after all of the merging we have done...
 200   // FIXME: We should be able to disable the globals graph for steens!
 201   ResultGraph->removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 202
 203   DEBUG(print(std::cerr, &M));
 204   return false;
 205 }
 206
 207 // alias - This is the only method here that does anything interesting...
 208 AliasAnalysis::AliasResult Steens::alias(const Value *V1, unsigned V1Size,
 209                                          const Value *V2, unsigned V2Size) {
 210   // FIXME: HANDLE Size argument!
 211   assert(ResultGraph && "Result graph has not been computed yet!");
 212
 213   DSGraph::ScalarMapTy &GSM = ResultGraph->getScalarMap();
 214
 215   DSGraph::ScalarMapTy::iterator I = GSM.find(const_cast<Value*>(V1));
 216   if (I != GSM.end() && I->second.getNode()) {
 217     DSNodeHandle &V1H = I->second;
 218     DSGraph::ScalarMapTy::iterator J=GSM.find(const_cast<Value*>(V2));
 219     if (J != GSM.end() && J->second.getNode()) {
 220       DSNodeHandle &V2H = J->second;
 221       // If the two pointers point to different data structure graph nodes, they
 222       // cannot alias!
 223       if (V1H.getNode() != V2H.getNode())    // FIXME: Handle incompleteness!
 224         return NoAlias;
 225
 226       // FIXME: If the two pointers point to the same node, and the offsets are
 227       // different, and the LinkIndex vector doesn't alias the section, then the
 228       // two pointers do not alias.  We need access size information for the two
 229       // accesses though!
 230       //
 231     }
 232   }
 233
 234   // If we cannot determine alias properties based on our graph, fall back on
 235   // some other AA implementation.
 236   //
 237   return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
 238 }