lib/Analysis/AliasAnalysisCounter.cpp

   1 //===- AliasAnalysisCounter.cpp - Alias Analysis Query Counter ------------===//
   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 file implements a pass which can be used to count how many alias queries
  11 // are being made and how the alias analysis implementation being used responds.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/Passes.h"
  16 #include "llvm/Pass.h"
  17 #include "llvm/Analysis/AliasAnalysis.h"
  18 #include "llvm/Assembly/Writer.h"
  19 #include "llvm/Support/CommandLine.h"
  20 #include "llvm/Support/Compiler.h"
  21 #include "llvm/Support/Streams.h"
  22 using namespace llvm;
  23
  24 namespace {
  25   cl::opt<bool>
  26   PrintAll("count-aa-print-all-queries", cl::ReallyHidden);
  27   cl::opt<bool>
  28   PrintAllFailures("count-aa-print-all-failed-queries", cl::ReallyHidden);
  29
  30   class VISIBILITY_HIDDEN AliasAnalysisCounter
  31       : public ModulePass, public AliasAnalysis {
  32     unsigned No, May, Must;
  33     unsigned NoMR, JustRef, JustMod, MR;
  34     const char *Name;
  35     Module *M;
  36   public:
  37     AliasAnalysisCounter() {
  38       No = May = Must = 0;
  39       NoMR = JustRef = JustMod = MR = 0;
  40     }
  41
  42     void printLine(const char *Desc, unsigned Val, unsigned Sum) {
  43       cerr <<  "  " << Val << " " << Desc << " responses ("
  44            << Val*100/Sum << "%)\n";
  45     }
  46     ~AliasAnalysisCounter() {
  47       unsigned AASum = No+May+Must;
  48       unsigned MRSum = NoMR+JustRef+JustMod+MR;
  49       if (AASum + MRSum) { // Print a report if any counted queries occurred...
  50         cerr << "\n===== Alias Analysis Counter Report =====\n"
  51              << "  Analysis counted: " << Name << "\n"
  52              << "  " << AASum << " Total Alias Queries Performed\n";
  53         if (AASum) {
  54           printLine("no alias",     No, AASum);
  55           printLine("may alias",   May, AASum);
  56           printLine("must alias", Must, AASum);
  57           cerr << "  Alias Analysis Counter Summary: " << No*100/AASum << "%/"
  58                << May*100/AASum << "%/" << Must*100/AASum<<"%\n\n";
  59         }
  60
  61         cerr << "  " << MRSum    << " Total Mod/Ref Queries Performed\n";
  62         if (MRSum) {
  63           printLine("no mod/ref",    NoMR, MRSum);
  64           printLine("ref",        JustRef, MRSum);
  65           printLine("mod",        JustMod, MRSum);
  66           printLine("mod/ref",         MR, MRSum);
  67           cerr << "  Mod/Ref Analysis Counter Summary: " <<NoMR*100/MRSum<< "%/"
  68                << JustRef*100/MRSum << "%/" << JustMod*100/MRSum << "%/"
  69                << MR*100/MRSum <<"%\n\n";
  70         }
  71       }
  72     }
  73
  74     bool runOnModule(Module &M) {
  75       this->M = &M;
  76       InitializeAliasAnalysis(this);
  77       Name = dynamic_cast<Pass*>(&getAnalysis<AliasAnalysis>())->getPassName();
  78       return false;
  79     }
  80
  81     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  82       AliasAnalysis::getAnalysisUsage(AU);
  83       AU.addRequired<AliasAnalysis>();
  84       AU.setPreservesAll();
  85     }
  86
  87     // FIXME: We could count these too...
  88     bool pointsToConstantMemory(const Value *P) {
  89       return getAnalysis<AliasAnalysis>().pointsToConstantMemory(P);
  90     }
  91     bool doesNotAccessMemory(Function *F) {
  92       return getAnalysis<AliasAnalysis>().doesNotAccessMemory(F);
  93     }
  94     bool onlyReadsMemory(Function *F) {
  95       return getAnalysis<AliasAnalysis>().onlyReadsMemory(F);
  96     }
  97
  98
  99     // Forwarding functions: just delegate to a real AA implementation, counting
 100     // the number of responses...
 101     AliasResult alias(const Value *V1, unsigned V1Size,
 102                       const Value *V2, unsigned V2Size);
 103
 104     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
 105     ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
 106       return AliasAnalysis::getModRefInfo(CS1,CS2);
 107     }
 108   };
 109
 110   RegisterPass<AliasAnalysisCounter>
 111   X("count-aa", "Count Alias Analysis Query Responses");
 112   RegisterAnalysisGroup<AliasAnalysis> Y(X);
 113 }
 114
 115 ModulePass *llvm::createAliasAnalysisCounterPass() {
 116   return new AliasAnalysisCounter();
 117 }
 118
 119 AliasAnalysis::AliasResult
 120 AliasAnalysisCounter::alias(const Value *V1, unsigned V1Size,
 121                             const Value *V2, unsigned V2Size) {
 122   AliasResult R = getAnalysis<AliasAnalysis>().alias(V1, V1Size, V2, V2Size);
 123
 124   const char *AliasString;
 125   switch (R) {
 126   default: assert(0 && "Unknown alias type!");
 127   case NoAlias:   No++;   AliasString = "No alias"; break;
 128   case MayAlias:  May++;  AliasString = "May alias"; break;
 129   case MustAlias: Must++; AliasString = "Must alias"; break;
 130   }
 131
 132   if (PrintAll || (PrintAllFailures && R == MayAlias)) {
 133     cerr << AliasString << ":\t";
 134     cerr << "[" << V1Size << "B] ";
 135     WriteAsOperand(*cerr.stream(), V1, true, M) << ", ";
 136     cerr << "[" << V2Size << "B] ";
 137     WriteAsOperand(*cerr.stream(), V2, true, M) << "\n";
 138   }
 139
 140   return R;
 141 }
 142
 143 AliasAnalysis::ModRefResult
 144 AliasAnalysisCounter::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 145   ModRefResult R = getAnalysis<AliasAnalysis>().getModRefInfo(CS, P, Size);
 146
 147   const char *MRString;
 148   switch (R) {
 149   default:       assert(0 && "Unknown mod/ref type!");
 150   case NoModRef: NoMR++;     MRString = "NoModRef"; break;
 151   case Ref:      JustRef++;  MRString = "JustRef"; break;
 152   case Mod:      JustMod++;  MRString = "JustMod"; break;
 153   case ModRef:   MR++;       MRString = "ModRef"; break;
 154   }
 155
 156   if (PrintAll || (PrintAllFailures && R == ModRef)) {
 157     cerr << MRString << ":  Ptr: ";
 158     cerr << "[" << Size << "B] ";
 159     WriteAsOperand(*cerr.stream(), P, true, M);
 160     cerr << "\t<->" << *CS.getInstruction();
 161   }
 162   return R;
 163 }