lib/Analysis/AliasAnalysisEvaluator.cpp

   1 //===- AliasAnalysisEvaluator.cpp - Alias Analysis Accuracy Evaluator -----===//
   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 //
  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.
  14 //
  15 // This is inspired and adapted from code by: Naveen Neelakantam, Francesco
  16 // Spadini, and Wojciech Stryjewski.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #include "llvm/Constants.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/Function.h"
  23 #include "llvm/Instructions.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/Analysis/Passes.h"
  27 #include "llvm/Analysis/AliasAnalysis.h"
  28 #include "llvm/Assembly/Writer.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/Support/InstIterator.h"
  31 #include "llvm/Support/CommandLine.h"
  32 #include "llvm/Support/raw_ostream.h"
  33 #include "llvm/ADT/SetVector.h"
  34 using namespace llvm;
  35
  36 static cl::opt<bool> PrintAll("print-all-alias-modref-info", cl::ReallyHidden);
  37
  38 static cl::opt<bool> PrintNoAlias("print-no-aliases", cl::ReallyHidden);
  39 static cl::opt<bool> PrintMayAlias("print-may-aliases", cl::ReallyHidden);
  40 static cl::opt<bool> PrintMustAlias("print-must-aliases", cl::ReallyHidden);
  41
  42 static cl::opt<bool> PrintNoModRef("print-no-modref", cl::ReallyHidden);
  43 static cl::opt<bool> PrintMod("print-mod", cl::ReallyHidden);
  44 static cl::opt<bool> PrintRef("print-ref", cl::ReallyHidden);
  45 static cl::opt<bool> PrintModRef("print-modref", cl::ReallyHidden);
  46
  47 namespace {
  48   /// AAEval - Base class for exhaustive alias analysis evaluators.
  49   class AAEval {
  50   protected:
  51     unsigned NoAlias, MayAlias, MustAlias;
  52     unsigned NoModRef, Mod, Ref, ModRef;
  53
  54     SetVector<Value *> Pointers;
  55     SetVector<CallSite> CallSites;
  56
  57     void getAnalysisUsage(AnalysisUsage &AU) const {
  58       AU.addRequired<AliasAnalysis>();
  59       AU.setPreservesAll();
  60     }
  61
  62     void doInitialization(Module &M) {
  63       NoAlias = MayAlias = MustAlias = 0;
  64       NoModRef = Mod = Ref = ModRef = 0;
  65
  66       if (PrintAll) {
  67         PrintNoAlias = PrintMayAlias = PrintMustAlias = true;
  68         PrintNoModRef = PrintMod = PrintRef = PrintModRef = true;
  69       }
  70     }
  71
  72     void runOnFunction(Function &F);
  73     void evaluate(AliasAnalysis *AA, Module *M);
  74     void doFinalization(Module &M);
  75   };
  76
  77   class FunctionAAEval : public FunctionPass, AAEval {
  78   public:
  79     static char ID; // Pass identification, replacement for typeid
  80     FunctionAAEval() : FunctionPass(&ID) {}
  81
  82     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  83       return AAEval::getAnalysisUsage(AU);
  84     }
  85
  86     virtual bool doInitialization(Module &M) {
  87       AAEval::doInitialization(M);
  88       return false;
  89     }
  90
  91     virtual bool runOnFunction(Function &F) {
  92       AAEval::runOnFunction(F);
  93
  94       if (PrintNoAlias || PrintMayAlias || PrintMustAlias ||
  95           PrintNoModRef || PrintMod || PrintRef || PrintModRef)
  96         errs() << "Function: " << F.getName() << ": " << Pointers.size()
  97                << " pointers, " << CallSites.size() << " call sites\n";
  98
  99       AAEval::evaluate(&getAnalysis<AliasAnalysis>(), F.getParent());
 100       return false;
 101     }
 102
 103     virtual bool doFinalization(Module &M) {
 104       AAEval::doFinalization(M);
 105       return false;
 106     }
 107   };
 108
 109   class InterproceduralAAEval : public ModulePass, AAEval {
 110   public:
 111     static char ID; // Pass identification, replacement for typeid
 112     InterproceduralAAEval() : ModulePass(&ID) {}
 113
 114     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 115       return AAEval::getAnalysisUsage(AU);
 116     }
 117
 118     virtual bool runOnModule(Module &M) {
 119       AAEval::doInitialization(M);
 120       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 121         AAEval::runOnFunction(*I);
 122
 123       if (PrintNoAlias || PrintMayAlias || PrintMustAlias ||
 124           PrintNoModRef || PrintMod || PrintRef || PrintModRef)
 125         errs() << "Module: " << Pointers.size()
 126                << " pointers, " << CallSites.size() << " call sites\n";
 127
 128       AAEval::evaluate(&getAnalysis<AliasAnalysis>(), &M);
 129       AAEval::doFinalization(M);
 130       return false;
 131     }
 132   };
 133 }
 134
 135 char FunctionAAEval::ID = 0;
 136 static RegisterPass<FunctionAAEval>
 137 X("aa-eval", "Exhaustive Alias Analysis Precision Evaluator", false, true);
 138
 139 FunctionPass *llvm::createAAEvalPass() { return new FunctionAAEval(); }
 140
 141 char InterproceduralAAEval::ID = 0;
 142 static RegisterPass<InterproceduralAAEval>
 143 Y("interprocedural-aa-eval",
 144   "Exhaustive Interprocedural Alias Analysis Precision Evaluator", false, true);
 145
 146 Pass *llvm::createInterproceduralAAEvalPass() {
 147   return new InterproceduralAAEval();
 148 }
 149
 150 static void PrintResults(const char *Msg, bool P, const Value *V1,
 151                          const Value *V2, const Module *M) {
 152   if (P) {
 153     std::string o1, o2;
 154     {
 155       raw_string_ostream os1(o1), os2(o2);
 156       WriteAsOperand(os1, V1, true, M);
 157       WriteAsOperand(os2, V2, true, M);
 158     }
 159
 160     if (o2 < o1)
 161       std::swap(o1, o2);
 162     errs() << "  " << Msg << ":\t"
 163            << o1 << ", "
 164            << o2 << "\n";
 165   }
 166 }
 167
 168 static inline void
 169 PrintModRefResults(const char *Msg, bool P, Instruction *I, Value *Ptr,
 170                    Module *M) {
 171   if (P) {
 172     errs() << "  " << Msg << ":  Ptr: ";
 173     WriteAsOperand(errs(), Ptr, true, M);
 174     errs() << "\t<->" << *I << '\n';
 175   }
 176 }
 177
 178 static inline bool isInterestingPointer(Value *V) {
 179   return V->getType()->isPointerTy()
 180       && !isa<ConstantPointerNull>(V);
 181 }
 182
 183 void AAEval::runOnFunction(Function &F) {
 184   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
 185     if (I->getType()->isPointerTy())    // Add all pointer arguments.
 186       Pointers.insert(I);
 187
 188   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
 189     if (I->getType()->isPointerTy()) // Add all pointer instructions.
 190       Pointers.insert(&*I);
 191     Instruction &Inst = *I;
 192     CallSite CS = CallSite::get(&Inst);
 193     if (CS) {
 194       Value *Callee = CS.getCalledValue();
 195       // Skip actual functions for direct function calls.
 196       if (!isa<Function>(Callee) && isInterestingPointer(Callee))
 197         Pointers.insert(Callee);
 198       // Consider formals.
 199       for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 200            AI != AE; ++AI)
 201         if (isInterestingPointer(*AI))
 202           Pointers.insert(*AI);
 203     } else {
 204       // Consider all operands.
 205       for (Instruction::op_iterator OI = Inst.op_begin(), OE = Inst.op_end();
 206            OI != OE; ++OI)
 207         if (isInterestingPointer(*OI))
 208           Pointers.insert(*OI);
 209     }
 210
 211     if (CS.getInstruction()) CallSites.insert(CS);
 212   }
 213 }
 214
 215 void AAEval::evaluate(AliasAnalysis *AA, Module *M) {
 216
 217   // iterate over the worklist, and run the full (n^2)/2 disambiguations
 218   for (SetVector<Value *>::iterator I1 = Pointers.begin(), E = Pointers.end();
 219        I1 != E; ++I1) {
 220     unsigned I1Size = ~0u;
 221     const Type *I1ElTy = cast<PointerType>((*I1)->getType())->getElementType();
 222     if (I1ElTy->isSized()) I1Size = AA->getTypeStoreSize(I1ElTy);
 223
 224     for (SetVector<Value *>::iterator I2 = Pointers.begin(); I2 != I1; ++I2) {
 225       unsigned I2Size = ~0u;
 226       const Type *I2ElTy =cast<PointerType>((*I2)->getType())->getElementType();
 227       if (I2ElTy->isSized()) I2Size = AA->getTypeStoreSize(I2ElTy);
 228
 229       switch (AA->alias(*I1, I1Size, *I2, I2Size)) {
 230       case AliasAnalysis::NoAlias:
 231         PrintResults("NoAlias", PrintNoAlias, *I1, *I2, M);
 232         ++NoAlias; break;
 233       case AliasAnalysis::MayAlias:
 234         PrintResults("MayAlias", PrintMayAlias, *I1, *I2, M);
 235         ++MayAlias; break;
 236       case AliasAnalysis::MustAlias:
 237         PrintResults("MustAlias", PrintMustAlias, *I1, *I2, M);
 238         ++MustAlias; break;
 239       default:
 240         errs() << "Unknown alias query result!\n";
 241       }
 242     }
 243   }
 244
 245   // Mod/ref alias analysis: compare all pairs of calls and values
 246   for (SetVector<CallSite>::iterator C = CallSites.begin(),
 247          Ce = CallSites.end(); C != Ce; ++C) {
 248     Instruction *I = C->getInstruction();
 249
 250     for (SetVector<Value *>::iterator V = Pointers.begin(), Ve = Pointers.end();
 251          V != Ve; ++V) {
 252       unsigned Size = ~0u;
 253       const Type *ElTy = cast<PointerType>((*V)->getType())->getElementType();
 254       if (ElTy->isSized()) Size = AA->getTypeStoreSize(ElTy);
 255
 256       switch (AA->getModRefInfo(*C, *V, Size)) {
 257       case AliasAnalysis::NoModRef:
 258         PrintModRefResults("NoModRef", PrintNoModRef, I, *V, M);
 259         ++NoModRef; break;
 260       case AliasAnalysis::Mod:
 261         PrintModRefResults("     Mod", PrintMod, I, *V, M);
 262         ++Mod; break;
 263       case AliasAnalysis::Ref:
 264         PrintModRefResults("     Ref", PrintRef, I, *V, M);
 265         ++Ref; break;
 266       case AliasAnalysis::ModRef:
 267         PrintModRefResults("  ModRef", PrintModRef, I, *V, M);
 268         ++ModRef; break;
 269       default:
 270         errs() << "Unknown alias query result!\n";
 271       }
 272     }
 273   }
 274
 275   Pointers.clear();
 276   CallSites.clear();
 277 }
 278
 279 static void PrintPercent(unsigned Num, unsigned Sum) {
 280   errs() << "(" << Num*100ULL/Sum << "."
 281          << ((Num*1000ULL/Sum) % 10) << "%)\n";
 282 }
 283
 284 void AAEval::doFinalization(Module &M) {
 285   unsigned AliasSum = NoAlias + MayAlias + MustAlias;
 286   errs() << "===== Alias Analysis Evaluator Report =====\n";
 287   if (AliasSum == 0) {
 288     errs() << "  Alias Analysis Evaluator Summary: No pointers!\n";
 289   } else {
 290     errs() << "  " << AliasSum << " Total Alias Queries Performed\n";
 291     errs() << "  " << NoAlias << " no alias responses ";
 292     PrintPercent(NoAlias, AliasSum);
 293     errs() << "  " << MayAlias << " may alias responses ";
 294     PrintPercent(MayAlias, AliasSum);
 295     errs() << "  " << MustAlias << " must alias responses ";
 296     PrintPercent(MustAlias, AliasSum);
 297     errs() << "  Alias Analysis Evaluator Pointer Alias Summary: "
 298            << NoAlias*100/AliasSum  << "%/" << MayAlias*100/AliasSum << "%/"
 299            << MustAlias*100/AliasSum << "%\n";
 300   }
 301
 302   // Display the summary for mod/ref analysis
 303   unsigned ModRefSum = NoModRef + Mod + Ref + ModRef;
 304   if (ModRefSum == 0) {
 305     errs() << "  Alias Analysis Mod/Ref Evaluator Summary: no mod/ref!\n";
 306   } else {
 307     errs() << "  " << ModRefSum << " Total ModRef Queries Performed\n";
 308     errs() << "  " << NoModRef << " no mod/ref responses ";
 309     PrintPercent(NoModRef, ModRefSum);
 310     errs() << "  " << Mod << " mod responses ";
 311     PrintPercent(Mod, ModRefSum);
 312     errs() << "  " << Ref << " ref responses ";
 313     PrintPercent(Ref, ModRefSum);
 314     errs() << "  " << ModRef << " mod & ref responses ";
 315     PrintPercent(ModRef, ModRefSum);
 316     errs() << "  Alias Analysis Evaluator Mod/Ref Summary: "
 317            << NoModRef*100/ModRefSum  << "%/" << Mod*100/ModRefSum << "%/"
 318            << Ref*100/ModRefSum << "%/" << ModRef*100/ModRefSum << "%\n";
 319   }
 320 }