1 //===- AliasAnalysisEvaluator.cpp - Alias Analysis Accuracy Evaluator -----===//
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 simple N^2 alias analysis accuracy evaluator.
11 // Basically, for each function in the program, it simply queries to see how the
12 // alias analysis implementation answers alias queries between each pair of
13 // pointers in the function.
15 // This is inspired and adapted from code by: Naveen Neelakantam, Francesco
16 // Spadini, and Wojciech Stryjewski.
18 //===----------------------------------------------------------------------===//
20 #include "llvm/Constants.h"
21 #include "llvm/DerivedTypes.h"
22 #include "llvm/Function.h"
23 #include "llvm/Instructions.h"
24 #include "llvm/Pass.h"
25 #include "llvm/Analysis/Passes.h"
26 #include "llvm/Analysis/AliasAnalysis.h"
27 #include "llvm/Assembly/Writer.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/InstIterator.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include "llvm/ADT/SetVector.h"
35 static cl::opt<bool> PrintAll("print-all-alias-modref-info", cl::ReallyHidden);
37 static cl::opt<bool> PrintNoAlias("print-no-aliases", cl::ReallyHidden);
38 static cl::opt<bool> PrintMayAlias("print-may-aliases", cl::ReallyHidden);
39 static cl::opt<bool> PrintMustAlias("print-must-aliases", cl::ReallyHidden);
41 static cl::opt<bool> PrintNoModRef("print-no-modref", cl::ReallyHidden);
42 static cl::opt<bool> PrintMod("print-mod", cl::ReallyHidden);
43 static cl::opt<bool> PrintRef("print-ref", cl::ReallyHidden);
44 static cl::opt<bool> PrintModRef("print-modref", cl::ReallyHidden);
47 class AAEval : public FunctionPass {
48 unsigned NoAlias, MayAlias, MustAlias;
49 unsigned NoModRef, Mod, Ref, ModRef;
52 static char ID; // Pass identification, replacement for typeid
53 AAEval() : FunctionPass(ID) {}
55 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
56 AU.addRequired<AliasAnalysis>();
60 bool doInitialization(Module &M) {
61 NoAlias = MayAlias = MustAlias = 0;
62 NoModRef = Mod = Ref = ModRef = 0;
65 PrintNoAlias = PrintMayAlias = PrintMustAlias = true;
66 PrintNoModRef = PrintMod = PrintRef = PrintModRef = true;
71 bool runOnFunction(Function &F);
72 bool doFinalization(Module &M);
77 INITIALIZE_PASS_BEGIN(AAEval, "aa-eval",
78 "Exhaustive Alias Analysis Precision Evaluator", false, true)
79 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
80 INITIALIZE_PASS_END(AAEval, "aa-eval",
81 "Exhaustive Alias Analysis Precision Evaluator", false, true)
83 FunctionPass *llvm::createAAEvalPass() { return new AAEval(); }
85 static void PrintResults(const char *Msg, bool P, const Value *V1,
86 const Value *V2, const Module *M) {
90 raw_string_ostream os1(o1), os2(o2);
91 WriteAsOperand(os1, V1, true, M);
92 WriteAsOperand(os2, V2, true, M);
97 errs() << " " << Msg << ":\t"
104 PrintModRefResults(const char *Msg, bool P, Instruction *I, Value *Ptr,
107 errs() << " " << Msg << ": Ptr: ";
108 WriteAsOperand(errs(), Ptr, true, M);
109 errs() << "\t<->" << *I << '\n';
114 PrintModRefResults(const char *Msg, bool P, CallSite CSA, CallSite CSB,
117 errs() << " " << Msg << ": " << *CSA.getInstruction()
118 << " <-> " << *CSB.getInstruction() << '\n';
122 static inline bool isInterestingPointer(Value *V) {
123 return V->getType()->isPointerTy()
124 && !isa<ConstantPointerNull>(V);
127 bool AAEval::runOnFunction(Function &F) {
128 AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
130 SetVector<Value *> Pointers;
131 SetVector<CallSite> CallSites;
133 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
134 if (I->getType()->isPointerTy()) // Add all pointer arguments.
137 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
138 if (I->getType()->isPointerTy()) // Add all pointer instructions.
139 Pointers.insert(&*I);
140 Instruction &Inst = *I;
141 if (CallSite CS = cast<Value>(&Inst)) {
142 Value *Callee = CS.getCalledValue();
143 // Skip actual functions for direct function calls.
144 if (!isa<Function>(Callee) && isInterestingPointer(Callee))
145 Pointers.insert(Callee);
147 for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
149 if (isInterestingPointer(*AI))
150 Pointers.insert(*AI);
151 CallSites.insert(CS);
153 // Consider all operands.
154 for (Instruction::op_iterator OI = Inst.op_begin(), OE = Inst.op_end();
156 if (isInterestingPointer(*OI))
157 Pointers.insert(*OI);
161 if (PrintNoAlias || PrintMayAlias || PrintMustAlias ||
162 PrintNoModRef || PrintMod || PrintRef || PrintModRef)
163 errs() << "Function: " << F.getName() << ": " << Pointers.size()
164 << " pointers, " << CallSites.size() << " call sites\n";
166 // iterate over the worklist, and run the full (n^2)/2 disambiguations
167 for (SetVector<Value *>::iterator I1 = Pointers.begin(), E = Pointers.end();
169 unsigned I1Size = ~0u;
170 const Type *I1ElTy = cast<PointerType>((*I1)->getType())->getElementType();
171 if (I1ElTy->isSized()) I1Size = AA.getTypeStoreSize(I1ElTy);
173 for (SetVector<Value *>::iterator I2 = Pointers.begin(); I2 != I1; ++I2) {
174 unsigned I2Size = ~0u;
175 const Type *I2ElTy =cast<PointerType>((*I2)->getType())->getElementType();
176 if (I2ElTy->isSized()) I2Size = AA.getTypeStoreSize(I2ElTy);
178 switch (AA.alias(*I1, I1Size, *I2, I2Size)) {
179 case AliasAnalysis::NoAlias:
180 PrintResults("NoAlias", PrintNoAlias, *I1, *I2, F.getParent());
182 case AliasAnalysis::MayAlias:
183 PrintResults("MayAlias", PrintMayAlias, *I1, *I2, F.getParent());
185 case AliasAnalysis::MustAlias:
186 PrintResults("MustAlias", PrintMustAlias, *I1, *I2, F.getParent());
189 errs() << "Unknown alias query result!\n";
194 // Mod/ref alias analysis: compare all pairs of calls and values
195 for (SetVector<CallSite>::iterator C = CallSites.begin(),
196 Ce = CallSites.end(); C != Ce; ++C) {
197 Instruction *I = C->getInstruction();
199 for (SetVector<Value *>::iterator V = Pointers.begin(), Ve = Pointers.end();
202 const Type *ElTy = cast<PointerType>((*V)->getType())->getElementType();
203 if (ElTy->isSized()) Size = AA.getTypeStoreSize(ElTy);
205 switch (AA.getModRefInfo(*C, *V, Size)) {
206 case AliasAnalysis::NoModRef:
207 PrintModRefResults("NoModRef", PrintNoModRef, I, *V, F.getParent());
209 case AliasAnalysis::Mod:
210 PrintModRefResults("Just Mod", PrintMod, I, *V, F.getParent());
212 case AliasAnalysis::Ref:
213 PrintModRefResults("Just Ref", PrintRef, I, *V, F.getParent());
215 case AliasAnalysis::ModRef:
216 PrintModRefResults("Both ModRef", PrintModRef, I, *V, F.getParent());
219 errs() << "Unknown alias query result!\n";
224 // Mod/ref alias analysis: compare all pairs of calls
225 for (SetVector<CallSite>::iterator C = CallSites.begin(),
226 Ce = CallSites.end(); C != Ce; ++C) {
227 for (SetVector<CallSite>::iterator D = CallSites.begin(); D != Ce; ++D) {
230 switch (AA.getModRefInfo(*C, *D)) {
231 case AliasAnalysis::NoModRef:
232 PrintModRefResults("NoModRef", PrintNoModRef, *C, *D, F.getParent());
234 case AliasAnalysis::Mod:
235 PrintModRefResults("Just Mod", PrintMod, *C, *D, F.getParent());
237 case AliasAnalysis::Ref:
238 PrintModRefResults("Just Ref", PrintRef, *C, *D, F.getParent());
240 case AliasAnalysis::ModRef:
241 PrintModRefResults("Both ModRef", PrintModRef, *C, *D, F.getParent());
250 static void PrintPercent(unsigned Num, unsigned Sum) {
251 errs() << "(" << Num*100ULL/Sum << "."
252 << ((Num*1000ULL/Sum) % 10) << "%)\n";
255 bool AAEval::doFinalization(Module &M) {
256 unsigned AliasSum = NoAlias + MayAlias + MustAlias;
257 errs() << "===== Alias Analysis Evaluator Report =====\n";
259 errs() << " Alias Analysis Evaluator Summary: No pointers!\n";
261 errs() << " " << AliasSum << " Total Alias Queries Performed\n";
262 errs() << " " << NoAlias << " no alias responses ";
263 PrintPercent(NoAlias, AliasSum);
264 errs() << " " << MayAlias << " may alias responses ";
265 PrintPercent(MayAlias, AliasSum);
266 errs() << " " << MustAlias << " must alias responses ";
267 PrintPercent(MustAlias, AliasSum);
268 errs() << " Alias Analysis Evaluator Pointer Alias Summary: "
269 << NoAlias*100/AliasSum << "%/" << MayAlias*100/AliasSum << "%/"
270 << MustAlias*100/AliasSum << "%\n";
273 // Display the summary for mod/ref analysis
274 unsigned ModRefSum = NoModRef + Mod + Ref + ModRef;
275 if (ModRefSum == 0) {
276 errs() << " Alias Analysis Mod/Ref Evaluator Summary: no mod/ref!\n";
278 errs() << " " << ModRefSum << " Total ModRef Queries Performed\n";
279 errs() << " " << NoModRef << " no mod/ref responses ";
280 PrintPercent(NoModRef, ModRefSum);
281 errs() << " " << Mod << " mod responses ";
282 PrintPercent(Mod, ModRefSum);
283 errs() << " " << Ref << " ref responses ";
284 PrintPercent(Ref, ModRefSum);
285 errs() << " " << ModRef << " mod & ref responses ";
286 PrintPercent(ModRef, ModRefSum);
287 errs() << " Alias Analysis Evaluator Mod/Ref Summary: "
288 << NoModRef*100/ModRefSum << "%/" << Mod*100/ModRefSum << "%/"
289 << Ref*100/ModRefSum << "%/" << ModRef*100/ModRefSum << "%\n";