lib/Analysis/AliasAnalysisEvaluator.cpp

   1 //===- AliasAnalysisEvaluator.cpp - Alias Analysis Accuracy Evaluator -----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   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/Function.h"
  21 #include "llvm/Instructions.h"
  22 #include "llvm/Pass.h"
  23 #include "llvm/DerivedTypes.h"
  24 #include "llvm/Analysis/Passes.h"
  25 #include "llvm/Analysis/AliasAnalysis.h"
  26 #include "llvm/Assembly/Writer.h"
  27 #include "llvm/Target/TargetData.h"
  28 #include "llvm/Support/InstIterator.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include <iostream>
  31 #include <set>
  32
  33 using namespace llvm;
  34
  35 namespace {
  36   cl::opt<bool> PrintAll("print-all-alias-modref-info", cl::ReallyHidden);
  37
  38   cl::opt<bool> PrintNoAlias("print-no-aliases", cl::ReallyHidden);
  39   cl::opt<bool> PrintMayAlias("print-may-aliases", cl::ReallyHidden);
  40   cl::opt<bool> PrintMustAlias("print-must-aliases", cl::ReallyHidden);
  41
  42   cl::opt<bool> PrintNoModRef("print-no-modref", cl::ReallyHidden);
  43   cl::opt<bool> PrintMod("print-mod", cl::ReallyHidden);
  44   cl::opt<bool> PrintRef("print-ref", cl::ReallyHidden);
  45   cl::opt<bool> PrintModRef("print-modref", cl::ReallyHidden);
  46
  47   class AAEval : public FunctionPass {
  48     unsigned NoAlias, MayAlias, MustAlias;
  49     unsigned NoModRef, Mod, Ref, ModRef;
  50
  51   public:
  52     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  53       AU.addRequired<AliasAnalysis>();
  54       AU.setPreservesAll();
  55     }
  56
  57     bool doInitialization(Module &M) {
  58       NoAlias = MayAlias = MustAlias = 0;
  59       NoModRef = Mod = Ref = ModRef = 0;
  60
  61       if (PrintAll) {
  62         PrintNoAlias = PrintMayAlias = PrintMustAlias = true;
  63         PrintNoModRef = PrintMod = PrintRef = PrintModRef = true;
  64       }
  65       return false;
  66     }
  67
  68     bool runOnFunction(Function &F);
  69     bool doFinalization(Module &M);
  70   };
  71
  72   RegisterOpt<AAEval>
  73   X("aa-eval", "Exhaustive Alias Analysis Precision Evaluator");
  74 }
  75
  76 FunctionPass *llvm::createAAEvalPass() { return new AAEval(); }
  77
  78 static inline void PrintResults(const char *Msg, bool P, Value *V1, Value *V2,
  79                                 Module *M) {
  80   if (P) {
  81     std::cerr << "  " << Msg << ":\t";
  82     WriteAsOperand(std::cerr, V1, true, true, M) << ", ";
  83     WriteAsOperand(std::cerr, V2, true, true, M) << "\n";
  84   }
  85 }
  86
  87 static inline void
  88 PrintModRefResults(const char *Msg, bool P, Instruction *I, Value *Ptr,
  89                    Module *M) {
  90   if (P) {
  91     std::cerr << "  " << Msg << ":  Ptr: ";
  92     WriteAsOperand(std::cerr, Ptr, true, true, M);
  93     std::cerr << "\t<->" << *I;
  94   }
  95 }
  96
  97 bool AAEval::runOnFunction(Function &F) {
  98   AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
  99
 100   const TargetData &TD = AA.getTargetData();
 101
 102   std::set<Value *> Pointers;
 103   std::set<CallSite> CallSites;
 104
 105   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
 106     if (isa<PointerType>(I->getType()))    // Add all pointer arguments
 107       Pointers.insert(I);
 108
 109   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
 110     if (isa<PointerType>(I->getType())) // Add all pointer instructions
 111       Pointers.insert(&*I);
 112     Instruction &Inst = *I;
 113     User::op_iterator OI = Inst.op_begin();
 114     if ((isa<InvokeInst>(Inst) || isa<CallInst>(Inst)) &&
 115         isa<Function>(Inst.getOperand(0)))
 116       ++OI;  // Skip actual functions for direct function calls.
 117     for (; OI != Inst.op_end(); ++OI)
 118       if (isa<PointerType>((*OI)->getType()))
 119         Pointers.insert(*OI);
 120
 121     CallSite CS = CallSite::get(&*I);
 122     if (CS.getInstruction()) CallSites.insert(CS);
 123   }
 124
 125   if (PrintNoAlias || PrintMayAlias || PrintMustAlias ||
 126       PrintNoModRef || PrintMod || PrintRef || PrintModRef)
 127     std::cerr << "Function: " << F.getName() << ": " << Pointers.size()
 128               << " pointers, " << CallSites.size() << " call sites\n";
 129
 130   // iterate over the worklist, and run the full (n^2)/2 disambiguations
 131   for (std::set<Value *>::iterator I1 = Pointers.begin(), E = Pointers.end();
 132        I1 != E; ++I1) {
 133     unsigned I1Size = 0;
 134     const Type *I1ElTy = cast<PointerType>((*I1)->getType())->getElementType();
 135     if (I1ElTy->isSized()) I1Size = TD.getTypeSize(I1ElTy);
 136
 137     for (std::set<Value *>::iterator I2 = Pointers.begin(); I2 != I1; ++I2) {
 138       unsigned I2Size = 0;
 139       const Type *I2ElTy =cast<PointerType>((*I2)->getType())->getElementType();
 140       if (I2ElTy->isSized()) I2Size = TD.getTypeSize(I2ElTy);
 141
 142       switch (AA.alias(*I1, I1Size, *I2, I2Size)) {
 143       case AliasAnalysis::NoAlias:
 144         PrintResults("NoAlias", PrintNoAlias, *I1, *I2, F.getParent());
 145         ++NoAlias; break;
 146       case AliasAnalysis::MayAlias:
 147         PrintResults("MayAlias", PrintMayAlias, *I1, *I2, F.getParent());
 148         ++MayAlias; break;
 149       case AliasAnalysis::MustAlias:
 150         PrintResults("MustAlias", PrintMustAlias, *I1, *I2, F.getParent());
 151         ++MustAlias; break;
 152       default:
 153         std::cerr << "Unknown alias query result!\n";
 154       }
 155     }
 156   }
 157
 158   // Mod/ref alias analysis: compare all pairs of calls and values
 159   for (std::set<Value *>::iterator V = Pointers.begin(), Ve = Pointers.end();
 160        V != Ve; ++V) {
 161     unsigned Size = 0;
 162     const Type *ElTy = cast<PointerType>((*V)->getType())->getElementType();
 163     if (ElTy->isSized()) Size = TD.getTypeSize(ElTy);
 164
 165     for (std::set<CallSite>::iterator C = CallSites.begin(),
 166            Ce = CallSites.end(); C != Ce; ++C) {
 167       Instruction *I = C->getInstruction();
 168       switch (AA.getModRefInfo(*C, *V, Size)) {
 169       case AliasAnalysis::NoModRef:
 170         PrintModRefResults("NoModRef", PrintNoModRef, I, *V, F.getParent());
 171         ++NoModRef; break;
 172       case AliasAnalysis::Mod:
 173         PrintModRefResults("     Mod", PrintMod, I, *V, F.getParent());
 174         ++Mod; break;
 175       case AliasAnalysis::Ref:
 176         PrintModRefResults("     Ref", PrintRef, I, *V, F.getParent());
 177         ++Ref; break;
 178       case AliasAnalysis::ModRef:
 179         PrintModRefResults("  ModRef", PrintModRef, I, *V, F.getParent());
 180         ++ModRef; break;
 181       default:
 182         std::cerr << "Unknown alias query result!\n";
 183       }
 184     }
 185   }
 186
 187   return false;
 188 }
 189
 190 bool AAEval::doFinalization(Module &M) {
 191   unsigned AliasSum = NoAlias + MayAlias + MustAlias;
 192   std::cerr << "===== Alias Analysis Evaluator Report =====\n";
 193   if (AliasSum == 0) {
 194     std::cerr << "  Alias Analysis Evaluator Summary: No pointers!\n";
 195   } else {
 196     std::cerr << "  " << AliasSum << " Total Alias Queries Performed\n";
 197     std::cerr << "  " << NoAlias << " no alias responses ("
 198               << NoAlias*100/AliasSum << "%)\n";
 199     std::cerr << "  " << MayAlias << " may alias responses ("
 200               << MayAlias*100/AliasSum << "%)\n";
 201     std::cerr << "  " << MustAlias << " must alias responses ("
 202               << MustAlias*100/AliasSum <<"%)\n";
 203     std::cerr << "  Alias Analysis Evaluator Pointer Alias Summary: "
 204               << NoAlias*100/AliasSum  << "%/" << MayAlias*100/AliasSum << "%/"
 205               << MustAlias*100/AliasSum << "%\n";
 206   }
 207
 208   // Display the summary for mod/ref analysis
 209   unsigned ModRefSum = NoModRef + Mod + Ref + ModRef;
 210   if (ModRefSum == 0) {
 211     std::cerr << "  Alias Analysis Mod/Ref Evaluator Summary: no mod/ref!\n";
 212   } else {
 213     std::cerr << "  " << ModRefSum << " Total ModRef Queries Performed\n";
 214     std::cerr << "  " << NoModRef << " no mod/ref responses ("
 215               << NoModRef*100/ModRefSum << "%)\n";
 216     std::cerr << "  " << Mod << " mod responses ("
 217               << Mod*100/ModRefSum << "%)\n";
 218     std::cerr << "  " << Ref << " ref responses ("
 219               << Ref*100/ModRefSum <<"%)\n";
 220     std::cerr << "  " << ModRef << " mod & ref responses ("
 221               << ModRef*100/ModRefSum <<"%)\n";
 222     std::cerr << "  Alias Analysis Evaluator Mod/Ref Summary: "
 223               << NoModRef*100/ModRefSum  << "%/" << Mod*100/ModRefSum << "%/"
 224               << Ref*100/ModRefSum << "%/" << ModRef*100/ModRefSum << "%\n";
 225   }
 226
 227   return false;
 228 }