1 //===- AliasAnalysisCounter.cpp - Alias Analysis Query Counter ------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
13 //===----------------------------------------------------------------------===//
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/Streams.h"
26 PrintAll("count-aa-print-all-queries", cl::ReallyHidden);
28 PrintAllFailures("count-aa-print-all-failed-queries", cl::ReallyHidden);
30 class AliasAnalysisCounter : public ModulePass, public AliasAnalysis {
31 unsigned No, May, Must;
32 unsigned NoMR, JustRef, JustMod, MR;
36 AliasAnalysisCounter() {
38 NoMR = JustRef = JustMod = MR = 0;
41 void printLine(const char *Desc, unsigned Val, unsigned Sum) {
42 llvm_cerr << " " << Val << " " << Desc << " responses ("
43 << Val*100/Sum << "%)\n";
45 ~AliasAnalysisCounter() {
46 unsigned AASum = No+May+Must;
47 unsigned MRSum = NoMR+JustRef+JustMod+MR;
48 if (AASum + MRSum) { // Print a report if any counted queries occurred...
50 << "\n===== Alias Analysis Counter Report =====\n"
51 << " Analysis counted: " << Name << "\n"
52 << " " << AASum << " Total Alias Queries Performed\n";
54 printLine("no alias", No, AASum);
55 printLine("may alias", May, AASum);
56 printLine("must alias", Must, AASum);
58 << " Alias Analysis Counter Summary: " << No*100/AASum << "%/"
59 << May*100/AASum << "%/" << Must*100/AASum<<"%\n\n";
63 << " " << MRSum << " Total Mod/Ref Queries Performed\n";
65 printLine("no mod/ref", NoMR, MRSum);
66 printLine("ref", JustRef, MRSum);
67 printLine("mod", JustMod, MRSum);
68 printLine("mod/ref", MR, MRSum);
70 << " Mod/Ref Analysis Counter Summary: " << NoMR*100/MRSum<< "%/"
71 << JustRef*100/MRSum << "%/" << JustMod*100/MRSum << "%/"
72 << MR*100/MRSum <<"%\n\n";
77 bool runOnModule(Module &M) {
79 InitializeAliasAnalysis(this);
80 Name = dynamic_cast<Pass*>(&getAnalysis<AliasAnalysis>())->getPassName();
84 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
85 AliasAnalysis::getAnalysisUsage(AU);
86 AU.addRequired<AliasAnalysis>();
90 // FIXME: We could count these too...
91 bool pointsToConstantMemory(const Value *P) {
92 return getAnalysis<AliasAnalysis>().pointsToConstantMemory(P);
94 bool doesNotAccessMemory(Function *F) {
95 return getAnalysis<AliasAnalysis>().doesNotAccessMemory(F);
97 bool onlyReadsMemory(Function *F) {
98 return getAnalysis<AliasAnalysis>().onlyReadsMemory(F);
102 // Forwarding functions: just delegate to a real AA implementation, counting
103 // the number of responses...
104 AliasResult alias(const Value *V1, unsigned V1Size,
105 const Value *V2, unsigned V2Size);
107 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
108 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
109 return AliasAnalysis::getModRefInfo(CS1,CS2);
113 RegisterPass<AliasAnalysisCounter>
114 X("count-aa", "Count Alias Analysis Query Responses");
115 RegisterAnalysisGroup<AliasAnalysis> Y(X);
118 ModulePass *llvm::createAliasAnalysisCounterPass() {
119 return new AliasAnalysisCounter();
122 AliasAnalysis::AliasResult
123 AliasAnalysisCounter::alias(const Value *V1, unsigned V1Size,
124 const Value *V2, unsigned V2Size) {
125 AliasResult R = getAnalysis<AliasAnalysis>().alias(V1, V1Size, V2, V2Size);
127 const char *AliasString;
129 default: assert(0 && "Unknown alias type!");
130 case NoAlias: No++; AliasString = "No alias"; break;
131 case MayAlias: May++; AliasString = "May alias"; break;
132 case MustAlias: Must++; AliasString = "Must alias"; break;
135 if (PrintAll || (PrintAllFailures && R == MayAlias)) {
136 llvm_cerr << AliasString << ":\t";
137 llvm_cerr << "[" << V1Size << "B] ";
138 WriteAsOperand(std::cerr, V1, true, true, M) << ", ";
139 llvm_cerr << "[" << V2Size << "B] ";
140 WriteAsOperand(std::cerr, V2, true, true, M) << "\n";
146 AliasAnalysis::ModRefResult
147 AliasAnalysisCounter::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
148 ModRefResult R = getAnalysis<AliasAnalysis>().getModRefInfo(CS, P, Size);
150 const char *MRString;
152 default: assert(0 && "Unknown mod/ref type!");
153 case NoModRef: NoMR++; MRString = "NoModRef"; break;
154 case Ref: JustRef++; MRString = "JustRef"; break;
155 case Mod: JustMod++; MRString = "JustMod"; break;
156 case ModRef: MR++; MRString = "ModRef"; break;
159 if (PrintAll || (PrintAllFailures && R == ModRef)) {
160 llvm_cerr << MRString << ": Ptr: ";
161 llvm_cerr << "[" << Size << "B] ";
162 WriteAsOperand(std::cerr, P, true, true, M);
163 llvm_cerr << "\t<->" << *CS.getInstruction();