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/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"
  33 using namespace llvm;
  34
  35 static cl::opt<bool> PrintAll("print-all-alias-modref-info", cl::ReallyHidden);
  36
  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);
  40
  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);
  45
  46 namespace {
  47   class AAEval : public FunctionPass {
  48     unsigned NoAlias, MayAlias, MustAlias;
  49     unsigned NoModRef, Mod, Ref, ModRef;
  50
  51   public:
  52     static char ID; // Pass identification, replacement for typeid
  53     AAEval() : FunctionPass(ID) {
  54       initializeAAEvalPass(*PassRegistry::getPassRegistry());
  55     }
  56
  57     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  58       AU.addRequired<AliasAnalysis>();
  59       AU.setPreservesAll();
  60     }
  61
  62     bool 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       return false;
  71     }
  72
  73     bool runOnFunction(Function &F);
  74     bool doFinalization(Module &M);
  75   };
  76 }
  77
  78 char AAEval::ID = 0;
  79 INITIALIZE_PASS_BEGIN(AAEval, "aa-eval",
  80                 "Exhaustive Alias Analysis Precision Evaluator", false, true)
  81 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
  82 INITIALIZE_PASS_END(AAEval, "aa-eval",
  83                 "Exhaustive Alias Analysis Precision Evaluator", false, true)
  84
  85 FunctionPass *llvm::createAAEvalPass() { return new AAEval(); }
  86
  87 static void PrintResults(const char *Msg, bool P, const Value *V1,
  88                          const Value *V2, const Module *M) {
  89   if (P) {
  90     std::string o1, o2;
  91     {
  92       raw_string_ostream os1(o1), os2(o2);
  93       WriteAsOperand(os1, V1, true, M);
  94       WriteAsOperand(os2, V2, true, M);
  95     }
  96
  97     if (o2 < o1)
  98       std::swap(o1, o2);
  99     errs() << "  " << Msg << ":\t"
 100            << o1 << ", "
 101            << o2 << "\n";
 102   }
 103 }
 104
 105 static inline void
 106 PrintModRefResults(const char *Msg, bool P, Instruction *I, Value *Ptr,
 107                    Module *M) {
 108   if (P) {
 109     errs() << "  " << Msg << ":  Ptr: ";
 110     WriteAsOperand(errs(), Ptr, true, M);
 111     errs() << "\t<->" << *I << '\n';
 112   }
 113 }
 114
 115 static inline void
 116 PrintModRefResults(const char *Msg, bool P, CallSite CSA, CallSite CSB,
 117                    Module *M) {
 118   if (P) {
 119     errs() << "  " << Msg << ": " << *CSA.getInstruction()
 120            << " <-> " << *CSB.getInstruction() << '\n';
 121   }
 122 }
 123
 124 static inline bool isInterestingPointer(Value *V) {
 125   return V->getType()->isPointerTy()
 126       && !isa<ConstantPointerNull>(V);
 127 }
 128
 129 bool AAEval::runOnFunction(Function &F) {
 130   AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
 131
 132   SetVector<Value *> Pointers;
 133   SetVector<CallSite> CallSites;
 134
 135   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
 136     if (I->getType()->isPointerTy())    // Add all pointer arguments.
 137       Pointers.insert(I);
 138
 139   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
 140     if (I->getType()->isPointerTy()) // Add all pointer instructions.
 141       Pointers.insert(&*I);
 142     Instruction &Inst = *I;
 143     if (CallSite CS = cast<Value>(&Inst)) {
 144       Value *Callee = CS.getCalledValue();
 145       // Skip actual functions for direct function calls.
 146       if (!isa<Function>(Callee) && isInterestingPointer(Callee))
 147         Pointers.insert(Callee);
 148       // Consider formals.
 149       for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 150            AI != AE; ++AI)
 151         if (isInterestingPointer(*AI))
 152           Pointers.insert(*AI);
 153       CallSites.insert(CS);
 154     } else {
 155       // Consider all operands.
 156       for (Instruction::op_iterator OI = Inst.op_begin(), OE = Inst.op_end();
 157            OI != OE; ++OI)
 158         if (isInterestingPointer(*OI))
 159           Pointers.insert(*OI);
 160     }
 161   }
 162
 163   if (PrintNoAlias || PrintMayAlias || PrintMustAlias ||
 164       PrintNoModRef || PrintMod || PrintRef || PrintModRef)
 165     errs() << "Function: " << F.getName() << ": " << Pointers.size()
 166            << " pointers, " << CallSites.size() << " call sites\n";
 167
 168   // iterate over the worklist, and run the full (n^2)/2 disambiguations
 169   for (SetVector<Value *>::iterator I1 = Pointers.begin(), E = Pointers.end();
 170        I1 != E; ++I1) {
 171     unsigned I1Size = AliasAnalysis::UnknownSize;
 172     const Type *I1ElTy = cast<PointerType>((*I1)->getType())->getElementType();
 173     if (I1ElTy->isSized()) I1Size = AA.getTypeStoreSize(I1ElTy);
 174
 175     for (SetVector<Value *>::iterator I2 = Pointers.begin(); I2 != I1; ++I2) {
 176       unsigned I2Size = AliasAnalysis::UnknownSize;
 177       const Type *I2ElTy =cast<PointerType>((*I2)->getType())->getElementType();
 178       if (I2ElTy->isSized()) I2Size = AA.getTypeStoreSize(I2ElTy);
 179
 180       switch (AA.alias(*I1, I1Size, *I2, I2Size)) {
 181       case AliasAnalysis::NoAlias:
 182         PrintResults("NoAlias", PrintNoAlias, *I1, *I2, F.getParent());
 183         ++NoAlias; break;
 184       case AliasAnalysis::MayAlias:
 185         PrintResults("MayAlias", PrintMayAlias, *I1, *I2, F.getParent());
 186         ++MayAlias; break;
 187       case AliasAnalysis::MustAlias:
 188         PrintResults("MustAlias", PrintMustAlias, *I1, *I2, F.getParent());
 189         ++MustAlias; break;
 190       default:
 191         errs() << "Unknown alias query result!\n";
 192       }
 193     }
 194   }
 195
 196   // Mod/ref alias analysis: compare all pairs of calls and values
 197   for (SetVector<CallSite>::iterator C = CallSites.begin(),
 198          Ce = CallSites.end(); C != Ce; ++C) {
 199     Instruction *I = C->getInstruction();
 200
 201     for (SetVector<Value *>::iterator V = Pointers.begin(), Ve = Pointers.end();
 202          V != Ve; ++V) {
 203       unsigned Size = AliasAnalysis::UnknownSize;
 204       const Type *ElTy = cast<PointerType>((*V)->getType())->getElementType();
 205       if (ElTy->isSized()) Size = AA.getTypeStoreSize(ElTy);
 206
 207       switch (AA.getModRefInfo(*C, *V, Size)) {
 208       case AliasAnalysis::NoModRef:
 209         PrintModRefResults("NoModRef", PrintNoModRef, I, *V, F.getParent());
 210         ++NoModRef; break;
 211       case AliasAnalysis::Mod:
 212         PrintModRefResults("Just Mod", PrintMod, I, *V, F.getParent());
 213         ++Mod; break;
 214       case AliasAnalysis::Ref:
 215         PrintModRefResults("Just Ref", PrintRef, I, *V, F.getParent());
 216         ++Ref; break;
 217       case AliasAnalysis::ModRef:
 218         PrintModRefResults("Both ModRef", PrintModRef, I, *V, F.getParent());
 219         ++ModRef; break;
 220       default:
 221         errs() << "Unknown alias query result!\n";
 222       }
 223     }
 224   }
 225
 226   // Mod/ref alias analysis: compare all pairs of calls
 227   for (SetVector<CallSite>::iterator C = CallSites.begin(),
 228          Ce = CallSites.end(); C != Ce; ++C) {
 229     for (SetVector<CallSite>::iterator D = CallSites.begin(); D != Ce; ++D) {
 230       if (D == C)
 231         continue;
 232       switch (AA.getModRefInfo(*C, *D)) {
 233       case AliasAnalysis::NoModRef:
 234         PrintModRefResults("NoModRef", PrintNoModRef, *C, *D, F.getParent());
 235         ++NoModRef; break;
 236       case AliasAnalysis::Mod:
 237         PrintModRefResults("Just Mod", PrintMod, *C, *D, F.getParent());
 238         ++Mod; break;
 239       case AliasAnalysis::Ref:
 240         PrintModRefResults("Just Ref", PrintRef, *C, *D, F.getParent());
 241         ++Ref; break;
 242       case AliasAnalysis::ModRef:
 243         PrintModRefResults("Both ModRef", PrintModRef, *C, *D, F.getParent());
 244         ++ModRef; break;
 245       }
 246     }
 247   }
 248
 249   return false;
 250 }
 251
 252 static void PrintPercent(unsigned Num, unsigned Sum) {
 253   errs() << "(" << Num*100ULL/Sum << "."
 254          << ((Num*1000ULL/Sum) % 10) << "%)\n";
 255 }
 256
 257 bool AAEval::doFinalization(Module &M) {
 258   unsigned AliasSum = NoAlias + MayAlias + MustAlias;
 259   errs() << "===== Alias Analysis Evaluator Report =====\n";
 260   if (AliasSum == 0) {
 261     errs() << "  Alias Analysis Evaluator Summary: No pointers!\n";
 262   } else {
 263     errs() << "  " << AliasSum << " Total Alias Queries Performed\n";
 264     errs() << "  " << NoAlias << " no alias responses ";
 265     PrintPercent(NoAlias, AliasSum);
 266     errs() << "  " << MayAlias << " may alias responses ";
 267     PrintPercent(MayAlias, AliasSum);
 268     errs() << "  " << MustAlias << " must alias responses ";
 269     PrintPercent(MustAlias, AliasSum);
 270     errs() << "  Alias Analysis Evaluator Pointer Alias Summary: "
 271            << NoAlias*100/AliasSum  << "%/" << MayAlias*100/AliasSum << "%/"
 272            << MustAlias*100/AliasSum << "%\n";
 273   }
 274
 275   // Display the summary for mod/ref analysis
 276   unsigned ModRefSum = NoModRef + Mod + Ref + ModRef;
 277   if (ModRefSum == 0) {
 278     errs() << "  Alias Analysis Mod/Ref Evaluator Summary: no mod/ref!\n";
 279   } else {
 280     errs() << "  " << ModRefSum << " Total ModRef Queries Performed\n";
 281     errs() << "  " << NoModRef << " no mod/ref responses ";
 282     PrintPercent(NoModRef, ModRefSum);
 283     errs() << "  " << Mod << " mod responses ";
 284     PrintPercent(Mod, ModRefSum);
 285     errs() << "  " << Ref << " ref responses ";
 286     PrintPercent(Ref, ModRefSum);
 287     errs() << "  " << ModRef << " mod & ref responses ";
 288     PrintPercent(ModRef, ModRefSum);
 289     errs() << "  Alias Analysis Evaluator Mod/Ref Summary: "
 290            << NoModRef*100/ModRefSum  << "%/" << Mod*100/ModRefSum << "%/"
 291            << Ref*100/ModRefSum << "%/" << ModRef*100/ModRefSum << "%\n";
 292   }
 293
 294   return false;
 295 }