1 //===- AliasAnalysisCounter.h - Alias Analysis Query Counter ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_ANALYSIS_ALIASANALYSISCOUNTER_H
17 #define LLVM_ANALYSIS_ALIASANALYSISCOUNTER_H
19 #include "llvm/Analysis/AliasAnalysis.h"
20 #include "llvm/IR/Module.h"
21 #include "llvm/Pass.h"
22 #include "llvm/Support/raw_ostream.h"
26 class AliasAnalysisCounter : public ModulePass, public AliasAnalysis {
27 unsigned No, May, Partial, Must;
28 unsigned NoMR, JustRef, JustMod, MR;
32 static char ID; // Class identification, replacement for typeinfo
33 AliasAnalysisCounter() : ModulePass(ID) {
34 initializeAliasAnalysisCounterPass(*PassRegistry::getPassRegistry());
35 No = May = Partial = Must = 0;
36 NoMR = JustRef = JustMod = MR = 0;
39 void printLine(const char *Desc, unsigned Val, unsigned Sum) {
40 errs() << " " << Val << " " << Desc << " responses (" << Val * 100 / Sum
43 ~AliasAnalysisCounter() override {
44 unsigned AASum = No + May + Partial + Must;
45 unsigned MRSum = NoMR + JustRef + JustMod + MR;
46 if (AASum + MRSum) { // Print a report if any counted queries occurred...
47 errs() << "\n===== Alias Analysis Counter Report =====\n"
48 << " Analysis counted:\n"
49 << " " << AASum << " Total Alias Queries Performed\n";
51 printLine("no alias", No, AASum);
52 printLine("may alias", May, AASum);
53 printLine("partial alias", Partial, AASum);
54 printLine("must alias", Must, AASum);
55 errs() << " Alias Analysis Counter Summary: " << No * 100 / AASum
56 << "%/" << May * 100 / AASum << "%/" << Partial * 100 / AASum
57 << "%/" << Must * 100 / AASum << "%\n\n";
60 errs() << " " << MRSum << " Total MRI_Mod/MRI_Ref Queries Performed\n";
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 << "%\n\n";
73 bool runOnModule(Module &M) override {
75 InitializeAliasAnalysis(this, &M.getDataLayout());
79 void getAnalysisUsage(AnalysisUsage &AU) const override {
80 AliasAnalysis::getAnalysisUsage(AU);
81 AU.addRequired<AliasAnalysis>();
85 /// getAdjustedAnalysisPointer - This method is used when a pass implements
86 /// an analysis interface through multiple inheritance. If needed, it
87 /// should override this to adjust the this pointer as needed for the
88 /// specified pass info.
89 void *getAdjustedAnalysisPointer(AnalysisID PI) override {
90 if (PI == &AliasAnalysis::ID)
91 return (AliasAnalysis *)this;
95 // FIXME: We could count these too...
96 bool pointsToConstantMemory(const MemoryLocation &Loc,
97 bool OrLocal) override {
98 return getAnalysis<AliasAnalysis>().pointsToConstantMemory(Loc, OrLocal);
101 // Forwarding functions: just delegate to a real AA implementation, counting
102 // the number of responses...
103 AliasResult alias(const MemoryLocation &LocA,
104 const MemoryLocation &LocB) override;
106 ModRefInfo getModRefInfo(ImmutableCallSite CS,
107 const MemoryLocation &Loc) override;
108 ModRefInfo getModRefInfo(ImmutableCallSite CS1,
109 ImmutableCallSite CS2) override {
110 return AliasAnalysis::getModRefInfo(CS1, CS2);
114 //===--------------------------------------------------------------------===//
116 // createAliasAnalysisCounterPass - This pass counts alias queries and how the
117 // alias analysis implementation responds.
119 ModulePass *createAliasAnalysisCounterPass();