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/AliasAnalysis.h"
  16 #include "llvm/Pass.h"
  17 #include <iostream>
  18
  19 namespace llvm {
  20
  21 namespace {
  22   class AliasAnalysisCounter : public Pass, public AliasAnalysis {
  23     unsigned No, May, Must;
  24     unsigned NoMR, JustRef, JustMod, MR;
  25     const char *Name;
  26   public:
  27     AliasAnalysisCounter() {
  28       No = May = Must = 0;
  29       NoMR = JustRef = JustMod = MR = 0;
  30     }
  31
  32     void printLine(const char *Desc, unsigned Val, unsigned Sum) {
  33       std::cerr <<  "  " << Val << " " << Desc << " responses ("
  34                 << Val*100/Sum << "%)\n";
  35     }
  36     ~AliasAnalysisCounter() {
  37       unsigned AASum = No+May+Must;
  38       unsigned MRSum = NoMR+JustRef+JustMod+MR;
  39       if (AASum + MRSum) { // Print a report if any counted queries occurred...
  40         std::cerr
  41           << "\n===== Alias Analysis Counter Report =====\n"
  42           << "  Analysis counted: " << Name << "\n"
  43           << "  " << AASum << " Total Alias Queries Performed\n";
  44         if (AASum) {
  45           printLine("no alias",     No, AASum);
  46           printLine("may alias",   May, AASum);
  47           printLine("must alias", Must, AASum);
  48           std::cerr
  49             << "  Alias Analysis Counter Summary: " << No*100/AASum << "%/"
  50             << May*100/AASum << "%/" << Must*100/AASum<<"%\n\n";
  51         }
  52
  53         std::cerr
  54           << "  " << MRSum    << " Total Mod/Ref Queries Performed\n";
  55         if (MRSum) {
  56           printLine("no mod/ref",    NoMR, MRSum);
  57           printLine("ref",        JustRef, MRSum);
  58           printLine("mod",        JustMod, MRSum);
  59           printLine("mod/ref",         MR, MRSum);
  60           std::cerr
  61             << "  Mod/Ref Analysis Counter Summary: " << NoMR*100/MRSum<< "%/"
  62             << JustRef*100/MRSum << "%/" << JustMod*100/MRSum << "%/"
  63             << MR*100/MRSum <<"%\n\n";
  64         }
  65       }
  66     }
  67
  68     bool run(Module &M) {
  69       InitializeAliasAnalysis(this);
  70       Name = dynamic_cast<Pass*>(&getAnalysis<AliasAnalysis>())->getPassName();
  71       return false;
  72     }
  73
  74     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  75       AliasAnalysis::getAnalysisUsage(AU);
  76       AU.addRequired<AliasAnalysis>();
  77       AU.setPreservesAll();
  78     }
  79
  80     AliasResult count(AliasResult R) {
  81       switch (R) {
  82       default: assert(0 && "Unknown alias type!");
  83       case NoAlias:   No++; return NoAlias;
  84       case MayAlias:  May++; return MayAlias;
  85       case MustAlias: Must++; return MustAlias;
  86       }
  87     }
  88     ModRefResult count(ModRefResult R) {
  89       switch (R) {
  90       default:       assert(0 && "Unknown mod/ref type!");
  91       case NoModRef: NoMR++;     return NoModRef;
  92       case Ref:      JustRef++;  return Ref;
  93       case Mod:      JustMod++;  return Mod;
  94       case ModRef:   MR++;       return ModRef;
  95       }
  96     }
  97
  98     // Forwarding functions: just delegate to a real AA implementation, counting
  99     // the number of responses...
 100     AliasResult alias(const Value *V1, unsigned V1Size,
 101                       const Value *V2, unsigned V2Size) {
 102       return count(getAnalysis<AliasAnalysis>().alias(V1, V1Size, V2, V2Size));
 103     }
 104     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 105       return count(getAnalysis<AliasAnalysis>().getModRefInfo(CS, P, Size));
 106     }
 107   };
 108
 109   RegisterOpt<AliasAnalysisCounter>
 110   X("count-aa", "Count Alias Analysis Query Responses");
 111   RegisterAnalysisGroup<AliasAnalysis, AliasAnalysisCounter> Y;
 112 }
 113
 114 } // End llvm namespace