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