lib/Analysis/IPA/GlobalsModRef.cpp

   1 //===- GlobalsModRef.cpp - Simple Mod/Ref Analysis for Globals ------------===//
   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 simple pass provides alias and mod/ref information for global values
  11 // that do not have their address taken, and keeps track of whether functions
  12 // read or write memory (are "pure").  For this simple (but very common) case,
  13 // we can provide pretty accurate and useful information.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/Passes.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/Constants.h"
  22 #include "llvm/Analysis/AliasAnalysis.h"
  23 #include "llvm/Analysis/CallGraph.h"
  24 #include "llvm/Support/InstIterator.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/ADT/SCCIterator.h"
  28 #include <set>
  29 using namespace llvm;
  30
  31 namespace {
  32   Statistic<>
  33   NumNonAddrTakenGlobalVars("globalsmodref-aa",
  34                             "Number of global vars without address taken");
  35   Statistic<>
  36   NumNonAddrTakenFunctions("globalsmodref-aa",
  37                            "Number of functions without address taken");
  38   Statistic<>
  39   NumNoMemFunctions("globalsmodref-aa",
  40                     "Number of functions that do not access memory");
  41   Statistic<>
  42   NumReadMemFunctions("globalsmodref-aa",
  43                       "Number of functions that only read memory");
  44
  45   /// FunctionRecord - One instance of this structure is stored for every
  46   /// function in the program.  Later, the entries for these functions are
  47   /// removed if the function is found to call an external function (in which
  48   /// case we know nothing about it.
  49   struct FunctionRecord {
  50     /// GlobalInfo - Maintain mod/ref info for all of the globals without
  51     /// addresses taken that are read or written (transitively) by this
  52     /// function.
  53     std::map<GlobalValue*, unsigned> GlobalInfo;
  54
  55     unsigned getInfoForGlobal(GlobalValue *GV) const {
  56       std::map<GlobalValue*, unsigned>::const_iterator I = GlobalInfo.find(GV);
  57       if (I != GlobalInfo.end())
  58         return I->second;
  59       return 0;
  60     }
  61
  62     /// FunctionEffect - Capture whether or not this function reads or writes to
  63     /// ANY memory.  If not, we can do a lot of aggressive analysis on it.
  64     unsigned FunctionEffect;
  65
  66     FunctionRecord() : FunctionEffect(0) {}
  67   };
  68
  69   /// GlobalsModRef - The actual analysis pass.
  70   class GlobalsModRef : public ModulePass, public AliasAnalysis {
  71     /// NonAddressTakenGlobals - The globals that do not have their addresses
  72     /// taken.
  73     std::set<GlobalValue*> NonAddressTakenGlobals;
  74
  75     /// FunctionInfo - For each function, keep track of what globals are
  76     /// modified or read.
  77     std::map<Function*, FunctionRecord> FunctionInfo;
  78
  79   public:
  80     bool runOnModule(Module &M) {
  81       InitializeAliasAnalysis(this);                 // set up super class
  82       AnalyzeGlobals(M);                          // find non-addr taken globals
  83       AnalyzeCallGraph(getAnalysis<CallGraph>(), M); // Propagate on CG
  84       return false;
  85     }
  86
  87     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  88       AliasAnalysis::getAnalysisUsage(AU);
  89       AU.addRequired<CallGraph>();
  90       AU.setPreservesAll();                         // Does not transform code
  91     }
  92
  93     //------------------------------------------------
  94     // Implement the AliasAnalysis API
  95     //
  96     AliasResult alias(const Value *V1, unsigned V1Size,
  97                       const Value *V2, unsigned V2Size);
  98     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
  99     ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
 100       return AliasAnalysis::getModRefInfo(CS1,CS2);
 101     }
 102     bool hasNoModRefInfoForCalls() const { return false; }
 103
 104     /// getModRefBehavior - Return the behavior of the specified function if
 105     /// called from the specified call site.  The call site may be null in which
 106     /// case the most generic behavior of this function should be returned.
 107     virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
 108                                          std::vector<PointerAccessInfo> *Info) {
 109       if (FunctionRecord *FR = getFunctionInfo(F))
 110         if (FR->FunctionEffect == 0)
 111           return DoesNotAccessMemory;
 112         else if ((FR->FunctionEffect & Mod) == 0)
 113           return OnlyReadsMemory;
 114       return AliasAnalysis::getModRefBehavior(F, CS, Info);
 115     }
 116
 117     virtual void deleteValue(Value *V);
 118     virtual void copyValue(Value *From, Value *To);
 119
 120   private:
 121     /// getFunctionInfo - Return the function info for the function, or null if
 122     /// the function calls an external function (in which case we don't have
 123     /// anything useful to say about it).
 124     FunctionRecord *getFunctionInfo(Function *F) {
 125       std::map<Function*, FunctionRecord>::iterator I = FunctionInfo.find(F);
 126       if (I != FunctionInfo.end())
 127         return &I->second;
 128       return 0;
 129     }
 130
 131     void AnalyzeGlobals(Module &M);
 132     void AnalyzeCallGraph(CallGraph &CG, Module &M);
 133     void AnalyzeSCC(std::vector<CallGraphNode *> &SCC);
 134     bool AnalyzeUsesOfGlobal(Value *V, std::vector<Function*> &Readers,
 135                              std::vector<Function*> &Writers);
 136   };
 137
 138   RegisterOpt<GlobalsModRef> X("globalsmodref-aa",
 139                                "Simple mod/ref analysis for globals");
 140   RegisterAnalysisGroup<AliasAnalysis, GlobalsModRef> Y;
 141 }
 142
 143 Pass *llvm::createGlobalsModRefPass() { return new GlobalsModRef(); }
 144
 145
 146 /// AnalyzeGlobalUses - Scan through the users of all of the internal
 147 /// GlobalValue's in the program.  If none of them have their "Address taken"
 148 /// (really, their address passed to something nontrivial), record this fact,
 149 /// and record the functions that they are used directly in.
 150 void GlobalsModRef::AnalyzeGlobals(Module &M) {
 151   std::vector<Function*> Readers, Writers;
 152   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 153     if (I->hasInternalLinkage()) {
 154       if (!AnalyzeUsesOfGlobal(I, Readers, Writers)) {
 155         // Remember that we are tracking this global.
 156         NonAddressTakenGlobals.insert(I);
 157         ++NumNonAddrTakenFunctions;
 158       }
 159       Readers.clear(); Writers.clear();
 160     }
 161
 162   for (Module::global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
 163     if (I->hasInternalLinkage()) {
 164       if (!AnalyzeUsesOfGlobal(I, Readers, Writers)) {
 165         // Remember that we are tracking this global, and the mod/ref fns
 166         NonAddressTakenGlobals.insert(I);
 167         for (unsigned i = 0, e = Readers.size(); i != e; ++i)
 168           FunctionInfo[Readers[i]].GlobalInfo[I] |= Ref;
 169
 170         if (!I->isConstant())  // No need to keep track of writers to constants
 171           for (unsigned i = 0, e = Writers.size(); i != e; ++i)
 172             FunctionInfo[Writers[i]].GlobalInfo[I] |= Mod;
 173         ++NumNonAddrTakenGlobalVars;
 174       }
 175       Readers.clear(); Writers.clear();
 176     }
 177 }
 178
 179 /// AnalyzeUsesOfGlobal - Look at all of the users of the specified global value
 180 /// derived pointer.  If this is used by anything complex (i.e., the address
 181 /// escapes), return true.  Also, while we are at it, keep track of those
 182 /// functions that read and write to the value.
 183 bool GlobalsModRef::AnalyzeUsesOfGlobal(Value *V,
 184                                         std::vector<Function*> &Readers,
 185                                         std::vector<Function*> &Writers) {
 186   if (!isa<PointerType>(V->getType())) return true;
 187
 188   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
 189     if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
 190       Readers.push_back(LI->getParent()->getParent());
 191     } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
 192       if (V == SI->getOperand(0)) return true;  // Storing the pointer
 193       Writers.push_back(SI->getParent()->getParent());
 194     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(*UI)) {
 195       if (AnalyzeUsesOfGlobal(GEP, Readers, Writers)) return true;
 196     } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
 197       // Make sure that this is just the function being called, not that it is
 198       // passing into the function.
 199       for (unsigned i = 1, e = CI->getNumOperands(); i != e; ++i)
 200         if (CI->getOperand(i) == V) return true;
 201     } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
 202       // Make sure that this is just the function being called, not that it is
 203       // passing into the function.
 204       for (unsigned i = 3, e = II->getNumOperands(); i != e; ++i)
 205         if (II->getOperand(i) == V) return true;
 206     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
 207       if (CE->getOpcode() == Instruction::GetElementPtr ||
 208           CE->getOpcode() == Instruction::Cast) {
 209         if (AnalyzeUsesOfGlobal(CE, Readers, Writers))
 210           return true;
 211       } else {
 212         return true;
 213       }
 214     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(*UI)) {
 215       if (AnalyzeUsesOfGlobal(GV, Readers, Writers)) return true;
 216     } else {
 217       return true;
 218     }
 219   return false;
 220 }
 221
 222 /// AnalyzeCallGraph - At this point, we know the functions where globals are
 223 /// immediately stored to and read from.  Propagate this information up the call
 224 /// graph to all callers and compute the mod/ref info for all memory for each
 225 /// function.
 226 void GlobalsModRef::AnalyzeCallGraph(CallGraph &CG, Module &M) {
 227   // We do a bottom-up SCC traversal of the call graph.  In other words, we
 228   // visit all callees before callers (leaf-first).
 229   for (scc_iterator<CallGraph*> I = scc_begin(&CG), E = scc_end(&CG); I!=E; ++I)
 230     if ((*I).size() != 1) {
 231       AnalyzeSCC(*I);
 232     } else if (Function *F = (*I)[0]->getFunction()) {
 233       if (!F->isExternal()) {
 234         // Nonexternal function.
 235         AnalyzeSCC(*I);
 236       } else {
 237         // Otherwise external function.  Handle intrinsics and other special
 238         // cases here.
 239         if (getAnalysis<AliasAnalysis>().doesNotAccessMemory(F))
 240           // If it does not access memory, process the function, causing us to
 241           // realize it doesn't do anything (the body is empty).
 242           AnalyzeSCC(*I);
 243         else {
 244           // Otherwise, don't process it.  This will cause us to conservatively
 245           // assume the worst.
 246         }
 247       }
 248     } else {
 249       // Do not process the external node, assume the worst.
 250     }
 251 }
 252
 253 void GlobalsModRef::AnalyzeSCC(std::vector<CallGraphNode *> &SCC) {
 254   assert(!SCC.empty() && "SCC with no functions?");
 255   FunctionRecord &FR = FunctionInfo[SCC[0]->getFunction()];
 256
 257   bool CallsExternal = false;
 258   unsigned FunctionEffect = 0;
 259
 260   // Collect the mod/ref properties due to called functions.  We only compute
 261   // one mod-ref set
 262   for (unsigned i = 0, e = SCC.size(); i != e && !CallsExternal; ++i)
 263     for (CallGraphNode::iterator CI = SCC[i]->begin(), E = SCC[i]->end();
 264          CI != E; ++CI)
 265       if (Function *Callee = (*CI)->getFunction()) {
 266         if (FunctionRecord *CalleeFR = getFunctionInfo(Callee)) {
 267           // Propagate function effect up.
 268           FunctionEffect |= CalleeFR->FunctionEffect;
 269
 270           // Incorporate callee's effects on globals into our info.
 271           for (std::map<GlobalValue*, unsigned>::iterator GI =
 272                  CalleeFR->GlobalInfo.begin(), E = CalleeFR->GlobalInfo.end();
 273                GI != E; ++GI)
 274             FR.GlobalInfo[GI->first] |= GI->second;
 275
 276         } else {
 277           // Okay, if we can't say anything about it, maybe some other alias
 278           // analysis can.
 279           ModRefBehavior MRB =
 280             AliasAnalysis::getModRefBehavior(Callee, CallSite());
 281           if (MRB != DoesNotAccessMemory) {
 282             if (MRB == OnlyReadsMemory) {
 283               // This reads memory, but we don't know what, just say that it
 284               // reads all globals.
 285               for (std::map<GlobalValue*, unsigned>::iterator
 286                      GI = CalleeFR->GlobalInfo.begin(),
 287                      E = CalleeFR->GlobalInfo.end();
 288                    GI != E; ++GI)
 289                 FR.GlobalInfo[GI->first] |= Ref;
 290
 291             } else {
 292               CallsExternal = true;
 293               break;
 294             }
 295           }
 296         }
 297       } else {
 298         CallsExternal = true;
 299         break;
 300       }
 301
 302   // If this SCC calls an external function, we can't say anything about it, so
 303   // remove all SCC functions from the FunctionInfo map.
 304   if (CallsExternal) {
 305     for (unsigned i = 0, e = SCC.size(); i != e; ++i)
 306       FunctionInfo.erase(SCC[i]->getFunction());
 307     return;
 308   }
 309
 310   // Otherwise, unless we already know that this function mod/refs memory, scan
 311   // the function bodies to see if there are any explicit loads or stores.
 312   if (FunctionEffect != ModRef) {
 313     for (unsigned i = 0, e = SCC.size(); i != e && FunctionEffect != ModRef;++i)
 314       for (inst_iterator II = inst_begin(SCC[i]->getFunction()),
 315              E = inst_end(SCC[i]->getFunction());
 316            II != E && FunctionEffect != ModRef; ++II)
 317         if (isa<LoadInst>(*II))
 318           FunctionEffect |= Ref;
 319         else if (isa<StoreInst>(*II))
 320           FunctionEffect |= Mod;
 321   }
 322
 323   if ((FunctionEffect & Mod) == 0)
 324     ++NumReadMemFunctions;
 325   if (FunctionEffect == 0)
 326     ++NumNoMemFunctions;
 327   FR.FunctionEffect = FunctionEffect;
 328
 329   // Finally, now that we know the full effect on this SCC, clone the
 330   // information to each function in the SCC.
 331   for (unsigned i = 1, e = SCC.size(); i != e; ++i)
 332     FunctionInfo[SCC[i]->getFunction()] = FR;
 333 }
 334
 335
 336
 337 /// getUnderlyingObject - This traverses the use chain to figure out what object
 338 /// the specified value points to.  If the value points to, or is derived from,
 339 /// a global object, return it.
 340 static const GlobalValue *getUnderlyingObject(const Value *V) {
 341   if (!isa<PointerType>(V->getType())) return 0;
 342
 343   // If we are at some type of object... return it.
 344   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) return GV;
 345
 346   // Traverse through different addressing mechanisms...
 347   if (const Instruction *I = dyn_cast<Instruction>(V)) {
 348     if (isa<CastInst>(I) || isa<GetElementPtrInst>(I))
 349       return getUnderlyingObject(I->getOperand(0));
 350   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
 351     if (CE->getOpcode() == Instruction::Cast ||
 352         CE->getOpcode() == Instruction::GetElementPtr)
 353       return getUnderlyingObject(CE->getOperand(0));
 354   }
 355   return 0;
 356 }
 357
 358 /// alias - If one of the pointers is to a global that we are tracking, and the
 359 /// other is some random pointer, we know there cannot be an alias, because the
 360 /// address of the global isn't taken.
 361 AliasAnalysis::AliasResult
 362 GlobalsModRef::alias(const Value *V1, unsigned V1Size,
 363                      const Value *V2, unsigned V2Size) {
 364   GlobalValue *GV1 = const_cast<GlobalValue*>(getUnderlyingObject(V1));
 365   GlobalValue *GV2 = const_cast<GlobalValue*>(getUnderlyingObject(V2));
 366
 367   // If the global's address is taken, pretend we don't know it's a pointer to
 368   // the global.
 369   if (GV1 && !NonAddressTakenGlobals.count(GV1)) GV1 = 0;
 370   if (GV2 && !NonAddressTakenGlobals.count(GV2)) GV2 = 0;
 371
 372   if ((GV1 || GV2) && GV1 != GV2)
 373     return NoAlias;
 374
 375   return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
 376 }
 377
 378 AliasAnalysis::ModRefResult
 379 GlobalsModRef::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 380   unsigned Known = ModRef;
 381
 382   // If we are asking for mod/ref info of a direct call with a pointer to a
 383   // global we are tracking, return information if we have it.
 384   if (GlobalValue *GV = const_cast<GlobalValue*>(getUnderlyingObject(P)))
 385     if (GV->hasInternalLinkage())
 386       if (Function *F = CS.getCalledFunction())
 387         if (NonAddressTakenGlobals.count(GV))
 388           if (FunctionRecord *FR = getFunctionInfo(F))
 389             Known = FR->getInfoForGlobal(GV);
 390
 391   if (Known == NoModRef)
 392     return NoModRef; // No need to query other mod/ref analyses
 393   return ModRefResult(Known & AliasAnalysis::getModRefInfo(CS, P, Size));
 394 }
 395
 396
 397 //===----------------------------------------------------------------------===//
 398 // Methods to update the analysis as a result of the client transformation.
 399 //
 400 void GlobalsModRef::deleteValue(Value *V) {
 401   if (GlobalValue *GV = dyn_cast<GlobalValue>(V))
 402     NonAddressTakenGlobals.erase(GV);
 403 }
 404
 405 void GlobalsModRef::copyValue(Value *From, Value *To) {
 406 }