[PM/AA] Hoist the AA counter pass into a header to match the analysis
[oota-llvm.git] / include / llvm / Analysis / AliasAnalysisCounter.h
1 //===- AliasAnalysisCounter.h - Alias Analysis Query Counter ----*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 /// \file
10 /// This declares an alias analysis which counts and prints queries made
11 /// through it. By inserting this between other AAs you can track when specific
12 /// layers of LLVM's AA get queried.
13 ///
14 //===----------------------------------------------------------------------===//
15
16 #ifndef LLVM_ANALYSIS_ALIASANALYSISCOUNTER_H
17 #define LLVM_ANALYSIS_ALIASANALYSISCOUNTER_H
18
19 #include "llvm/Analysis/AliasAnalysis.h"
20 #include "llvm/IR/Module.h"
21 #include "llvm/Pass.h"
22 #include "llvm/Support/raw_ostream.h"
23
24 namespace llvm {
25
26   class AliasAnalysisCounter : public ModulePass, public AliasAnalysis {
27     unsigned No, May, Partial, Must;
28     unsigned NoMR, JustRef, JustMod, MR;
29     Module *M;
30   public:
31     static char ID; // Class identification, replacement for typeinfo
32     AliasAnalysisCounter() : ModulePass(ID) {
33       initializeAliasAnalysisCounterPass(*PassRegistry::getPassRegistry());
34       No = May = Partial = Must = 0;
35       NoMR = JustRef = JustMod = MR = 0;
36     }
37
38     void printLine(const char *Desc, unsigned Val, unsigned Sum) {
39       errs() <<  "  " << Val << " " << Desc << " responses ("
40              << Val*100/Sum << "%)\n";
41     }
42     ~AliasAnalysisCounter() override {
43       unsigned AASum = No+May+Partial+Must;
44       unsigned MRSum = NoMR+JustRef+JustMod+MR;
45       if (AASum + MRSum) { // Print a report if any counted queries occurred...
46         errs() << "\n===== Alias Analysis Counter Report =====\n"
47                << "  Analysis counted:\n"
48                << "  " << AASum << " Total Alias Queries Performed\n";
49         if (AASum) {
50           printLine("no alias",     No, AASum);
51           printLine("may alias",   May, AASum);
52           printLine("partial alias", Partial, AASum);
53           printLine("must alias", Must, AASum);
54           errs() << "  Alias Analysis Counter Summary: " << No*100/AASum << "%/"
55                  << May*100/AASum << "%/"
56                  << Partial*100/AASum << "%/"
57                  << Must*100/AASum<<"%\n\n";
58         }
59
60         errs() << "  " << MRSum << " Total MRI_Mod/MRI_Ref Queries Performed\n";
61         if (MRSum) {
62           printLine("no mod/ref",    NoMR, MRSum);
63           printLine("ref",        JustRef, MRSum);
64           printLine("mod",        JustMod, MRSum);
65           printLine("mod/ref",         MR, MRSum);
66           errs() << "  MRI_Mod/MRI_Ref Analysis Counter Summary: "
67                  << NoMR * 100 / MRSum << "%/" << JustRef * 100 / MRSum << "%/"
68                  << JustMod * 100 / MRSum << "%/" << MR * 100 / MRSum
69                  << "%\n\n";
70         }
71       }
72     }
73
74     bool runOnModule(Module &M) override {
75       this->M = &M;
76       InitializeAliasAnalysis(this, &M.getDataLayout());
77       return false;
78     }
79
80     void getAnalysisUsage(AnalysisUsage &AU) const override {
81       AliasAnalysis::getAnalysisUsage(AU);
82       AU.addRequired<AliasAnalysis>();
83       AU.setPreservesAll();
84     }
85
86     /// getAdjustedAnalysisPointer - This method is used when a pass implements
87     /// an analysis interface through multiple inheritance.  If needed, it
88     /// should override this to adjust the this pointer as needed for the
89     /// specified pass info.
90     void *getAdjustedAnalysisPointer(AnalysisID PI) override {
91       if (PI == &AliasAnalysis::ID)
92         return (AliasAnalysis*)this;
93       return this;
94     }
95     
96     // FIXME: We could count these too...
97     bool pointsToConstantMemory(const MemoryLocation &Loc,
98                                 bool OrLocal) override {
99       return getAnalysis<AliasAnalysis>().pointsToConstantMemory(Loc, OrLocal);
100     }
101
102     // Forwarding functions: just delegate to a real AA implementation, counting
103     // the number of responses...
104     AliasResult alias(const MemoryLocation &LocA,
105                       const MemoryLocation &LocB) override;
106
107     ModRefInfo getModRefInfo(ImmutableCallSite CS,
108                              const MemoryLocation &Loc) override;
109     ModRefInfo getModRefInfo(ImmutableCallSite CS1,
110                              ImmutableCallSite CS2) override {
111       return AliasAnalysis::getModRefInfo(CS1,CS2);
112     }
113   };
114
115   //===--------------------------------------------------------------------===//
116   //
117   // createAliasAnalysisCounterPass - This pass counts alias queries and how the
118   // alias analysis implementation responds.
119   //
120   ModulePass *createAliasAnalysisCounterPass();
121
122 }
123
124 #endif