1 //===- AliasAnalysisCounter.cpp - Alias Analysis Query Counter ------------===//
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 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/AliasAnalysisCounter.h"
16 #include "llvm/Analysis/AliasAnalysis.h"
17 #include "llvm/IR/Module.h"
18 #include "llvm/Pass.h"
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/raw_ostream.h"
25 static cl::opt<bool> PrintAll("count-aa-print-all-queries", cl::ReallyHidden,
27 static cl::opt<bool> PrintAllFailures("count-aa-print-all-failed-queries",
30 char AliasAnalysisCounter::ID = 0;
31 INITIALIZE_AG_PASS(AliasAnalysisCounter, AliasAnalysis, "count-aa",
32 "Count Alias Analysis Query Responses", false, true, false)
34 ModulePass *llvm::createAliasAnalysisCounterPass() {
35 return new AliasAnalysisCounter();
38 AliasAnalysisCounter::AliasAnalysisCounter() : ModulePass(ID) {
39 initializeAliasAnalysisCounterPass(*PassRegistry::getPassRegistry());
40 No = May = Partial = Must = 0;
41 NoMR = JustRef = JustMod = MR = 0;
44 static void printLine(const char *Desc, unsigned Val, unsigned Sum) {
45 errs() << " " << Val << " " << Desc << " responses (" << Val * 100 / Sum
49 AliasAnalysisCounter::~AliasAnalysisCounter() {
50 unsigned AASum = No + May + Partial + Must;
51 unsigned MRSum = NoMR + JustRef + JustMod + MR;
52 if (AASum + MRSum) { // Print a report if any counted queries occurred...
53 errs() << "\n===== Alias Analysis Counter Report =====\n"
54 << " Analysis counted:\n"
55 << " " << AASum << " Total Alias Queries Performed\n";
57 printLine("no alias", No, AASum);
58 printLine("may alias", May, AASum);
59 printLine("partial alias", Partial, AASum);
60 printLine("must alias", Must, AASum);
61 errs() << " Alias Analysis Counter Summary: " << No * 100 / AASum << "%/"
62 << May * 100 / AASum << "%/" << Partial * 100 / AASum << "%/"
63 << Must * 100 / AASum << "%\n\n";
66 errs() << " " << MRSum << " Total MRI_Mod/MRI_Ref Queries Performed\n";
68 printLine("no mod/ref", NoMR, MRSum);
69 printLine("ref", JustRef, MRSum);
70 printLine("mod", JustMod, MRSum);
71 printLine("mod/ref", MR, MRSum);
72 errs() << " MRI_Mod/MRI_Ref Analysis Counter Summary: "
73 << NoMR * 100 / MRSum << "%/" << JustRef * 100 / MRSum << "%/"
74 << JustMod * 100 / MRSum << "%/" << MR * 100 / MRSum << "%\n\n";
79 bool AliasAnalysisCounter::runOnModule(Module &M) {
81 InitializeAliasAnalysis(this, &M.getDataLayout());
85 void AliasAnalysisCounter::getAnalysisUsage(AnalysisUsage &AU) const {
86 AliasAnalysis::getAnalysisUsage(AU);
87 AU.addRequired<AliasAnalysis>();
91 void *AliasAnalysisCounter::getAdjustedAnalysisPointer(AnalysisID PI) {
92 if (PI == &AliasAnalysis::ID)
93 return (AliasAnalysis *)this;
97 AliasResult AliasAnalysisCounter::alias(const MemoryLocation &LocA,
98 const MemoryLocation &LocB) {
99 AliasResult R = getAnalysis<AliasAnalysis>().alias(LocA, LocB);
101 const char *AliasString = nullptr;
105 AliasString = "No alias";
109 AliasString = "May alias";
113 AliasString = "Partial alias";
117 AliasString = "Must alias";
121 if (PrintAll || (PrintAllFailures && R == MayAlias)) {
122 errs() << AliasString << ":\t";
123 errs() << "[" << LocA.Size << "B] ";
124 LocA.Ptr->printAsOperand(errs(), true, M);
126 errs() << "[" << LocB.Size << "B] ";
127 LocB.Ptr->printAsOperand(errs(), true, M);
134 ModRefInfo AliasAnalysisCounter::getModRefInfo(ImmutableCallSite CS,
135 const MemoryLocation &Loc) {
136 ModRefInfo R = getAnalysis<AliasAnalysis>().getModRefInfo(CS, Loc);
138 const char *MRString = nullptr;
142 MRString = "MRI_NoModRef";
146 MRString = "JustRef";
150 MRString = "JustMod";
154 MRString = "MRI_ModRef";
158 if (PrintAll || (PrintAllFailures && R == MRI_ModRef)) {
159 errs() << MRString << ": Ptr: ";
160 errs() << "[" << Loc.Size << "B] ";
161 Loc.Ptr->printAsOperand(errs(), true, M);
162 errs() << "\t<->" << *CS.getInstruction() << '\n';