lib/Analysis/DataStructure/Steensgaard.cpp

   1 //===- Steensgaard.cpp - Context Insensitive Alias Analysis ---------------===//
   2 //
   3 // This pass uses the data structure graphs to implement a simple context
   4 // insensitive alias analysis.  It does this by computing the local analysis
   5 // graphs for all of the functions, then merging them together into a single big
   6 // graph without cloning.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/Analysis/DataStructure.h"
  11 #include "llvm/Analysis/DSGraph.h"
  12 #include "llvm/Analysis/AliasAnalysis.h"
  13 #include "llvm/Module.h"
  14 #include "Support/Statistic.h"
  15
  16 namespace {
  17   class Steens : public Pass, public AliasAnalysis {
  18     DSGraph *ResultGraph;
  19     DSGraph *GlobalsGraph;  // FIXME: Eliminate globals graph stuff from DNE
  20   public:
  21     Steens() : ResultGraph(0) {}
  22     ~Steens() { assert(ResultGraph == 0 && "releaseMemory not called?"); }
  23
  24     //------------------------------------------------
  25     // Implement the Pass API
  26     //
  27
  28     // run - Build up the result graph, representing the pointer graph for the
  29     // program.
  30     //
  31     bool run(Module &M);
  32
  33     virtual void releaseMemory() { delete ResultGraph; ResultGraph = 0; }
  34
  35     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  36       AU.setPreservesAll();                    // Does not transform code...
  37       AU.addRequired<LocalDataStructures>();   // Uses local dsgraph
  38       AU.addRequired<AliasAnalysis>();         // Chains to another AA impl...
  39     }
  40
  41     // print - Implement the Pass::print method...
  42     void print(std::ostream &O, const Module *M) const {
  43       assert(ResultGraph && "Result graph has not yet been computed!");
  44       ResultGraph->writeGraphToFile(O, "steensgaards");
  45     }
  46
  47     //------------------------------------------------
  48     // Implement the AliasAnalysis API
  49     //
  50
  51     // alias - This is the only method here that does anything interesting...
  52     Result alias(const Value *V1, const Value *V2);
  53
  54     /// canCallModify - Not implemented yet: FIXME
  55     ///
  56     Result canCallModify(const CallInst &CI, const Value *Ptr) {
  57       return MayAlias;
  58     }
  59
  60     /// canInvokeModify - Not implemented yet: FIXME
  61     ///
  62     Result canInvokeModify(const InvokeInst &I, const Value *Ptr) {
  63       return MayAlias;
  64     }
  65
  66   private:
  67     void ResolveFunctionCall(Function *F, const DSCallSite &Call,
  68                              DSNodeHandle &RetVal);
  69   };
  70
  71   // Register the pass...
  72   RegisterOpt<Steens> X("steens-aa",
  73                         "Steensgaard's alias analysis (DSGraph based)");
  74
  75   // Register as an implementation of AliasAnalysis
  76   RegisterAnalysisGroup<AliasAnalysis, Steens> Y;
  77 }
  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   hash_map<Value*, DSNodeHandle> &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     hash_map<Value*, DSNodeHandle>::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   assert(ResultGraph == 0 && "Result graph already allocated!");
 109   LocalDataStructures &LDS = getAnalysis<LocalDataStructures>();
 110
 111   // Create a new, empty, graph...
 112   ResultGraph = new DSGraph();
 113   GlobalsGraph = new DSGraph();
 114   ResultGraph->setGlobalsGraph(GlobalsGraph);
 115   ResultGraph->setPrintAuxCalls();
 116
 117   // RetValMap - Keep track of the return values for all functions that return
 118   // valid pointers.
 119   //
 120   hash_map<Function*, DSNodeHandle> RetValMap;
 121
 122   // Loop over the rest of the module, merging graphs for non-external functions
 123   // into this graph.
 124   //
 125   unsigned Count = 0;
 126   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 127     if (!I->isExternal()) {
 128       hash_map<Value*, DSNodeHandle> ValMap;
 129       {  // Scope to free NodeMap memory ASAP
 130         hash_map<const DSNode*, DSNodeHandle> NodeMap;
 131         const DSGraph &FDSG = LDS.getDSGraph(*I);
 132         DSNodeHandle RetNode = ResultGraph->cloneInto(FDSG, ValMap, NodeMap);
 133
 134         // Keep track of the return node of the function's graph if it returns a
 135         // value...
 136         //
 137         if (RetNode.getNode())
 138           RetValMap[I] = RetNode;
 139       }
 140
 141       // Incorporate the inlined Function's ScalarMap into the global
 142       // ScalarMap...
 143       hash_map<Value*, DSNodeHandle> &GVM = ResultGraph->getScalarMap();
 144       for (hash_map<Value*, DSNodeHandle>::iterator I = ValMap.begin(),
 145              E = ValMap.end(); I != E; ++I)
 146         GVM[I->first].mergeWith(I->second);
 147
 148       if ((++Count & 1) == 0)   // Prune nodes out every other time...
 149         ResultGraph->removeTriviallyDeadNodes();
 150     }
 151
 152   // FIXME: Must recalculate and use the Incomplete markers!!
 153
 154   // Now that we have all of the graphs inlined, we can go about eliminating
 155   // call nodes...
 156   //
 157   std::vector<DSCallSite> &Calls =
 158     ResultGraph->getAuxFunctionCalls();
 159   assert(Calls.empty() && "Aux call list is already in use??");
 160
 161   // Start with a copy of the original call sites...
 162   Calls = ResultGraph->getFunctionCalls();
 163
 164   for (unsigned i = 0; i != Calls.size(); ) {
 165     DSCallSite &CurCall = Calls[i];
 166
 167     // Loop over the called functions, eliminating as many as possible...
 168     std::vector<GlobalValue*> CallTargets;
 169     if (CurCall.isDirectCall())
 170       CallTargets.push_back(CurCall.getCalleeFunc());
 171     else
 172       CallTargets = CurCall.getCalleeNode()->getGlobals();
 173
 174     for (unsigned c = 0; c != CallTargets.size(); ) {
 175       // If we can eliminate this function call, do so!
 176       bool Eliminated = false;
 177       if (Function *F = dyn_cast<Function>(CallTargets[c]))
 178         if (!F->isExternal()) {
 179           ResolveFunctionCall(F, CurCall, RetValMap[F]);
 180           Eliminated = true;
 181         }
 182       if (Eliminated) {
 183         CallTargets[c] = CallTargets.back();
 184         CallTargets.pop_back();
 185       } else
 186         ++c;  // Cannot eliminate this call, skip over it...
 187     }
 188
 189     if (CallTargets.empty()) {        // Eliminated all calls?
 190       CurCall = Calls.back();         // Remove entry
 191       Calls.pop_back();
 192     } else
 193       ++i;                            // Skip this call site...
 194   }
 195
 196   // Update the "incomplete" markers on the nodes, ignoring unknownness due to
 197   // incoming arguments...
 198   ResultGraph->maskIncompleteMarkers();
 199   ResultGraph->markIncompleteNodes(DSGraph::IgnoreFormalArgs);
 200
 201   // Remove any nodes that are dead after all of the merging we have done...
 202   // FIXME: We should be able to disable the globals graph for steens!
 203   ResultGraph->removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 204
 205   DEBUG(print(std::cerr, &M));
 206   return false;
 207 }
 208
 209 // alias - This is the only method here that does anything interesting...
 210 AliasAnalysis::Result Steens::alias(const Value *V1, const Value *V2) {
 211   assert(ResultGraph && "Result graph has not been computed yet!");
 212
 213   hash_map<Value*, DSNodeHandle> &GSM = ResultGraph->getScalarMap();
 214
 215   hash_map<Value*, DSNodeHandle>::iterator I = GSM.find(const_cast<Value*>(V1));
 216   if (I != GSM.end() && I->second.getNode()) {
 217     DSNodeHandle &V1H = I->second;
 218     hash_map<Value*, DSNodeHandle>::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 getAnalysis<AliasAnalysis>().alias(V1, V2);
 238 }