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