LLVM API Documentation

AliasAnalysisEvaluator.cpp

Go to the documentation of this file.
00001 //===- AliasAnalysisEvaluator.cpp - Alias Analysis Accuracy Evaluator -----===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file is distributed under the University of Illinois Open Source
00006 // License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This file implements a simple N^2 alias analysis accuracy evaluator.
00011 // Basically, for each function in the program, it simply queries to see how the
00012 // alias analysis implementation answers alias queries between each pair of
00013 // pointers in the function.
00014 //
00015 // This is inspired and adapted from code by: Naveen Neelakantam, Francesco
00016 // Spadini, and Wojciech Stryjewski.
00017 //
00018 //===----------------------------------------------------------------------===//
00019 
00020 #include "llvm/Constants.h"
00021 #include "llvm/DerivedTypes.h"
00022 #include "llvm/Function.h"
00023 #include "llvm/Instructions.h"
00024 #include "llvm/Pass.h"
00025 #include "llvm/Analysis/Passes.h"
00026 #include "llvm/Analysis/AliasAnalysis.h"
00027 #include "llvm/Assembly/Writer.h"
00028 #include "llvm/Target/TargetData.h"
00029 #include "llvm/Support/InstIterator.h"
00030 #include "llvm/Support/CommandLine.h"
00031 #include "llvm/Support/Compiler.h"
00032 #include "llvm/Support/raw_ostream.h"
00033 #include <set>
00034 #include <sstream>
00035 using namespace llvm;
00036 
00037 static cl::opt<bool> PrintAll("print-all-alias-modref-info", cl::ReallyHidden);
00038 
00039 static cl::opt<bool> PrintNoAlias("print-no-aliases", cl::ReallyHidden);
00040 static cl::opt<bool> PrintMayAlias("print-may-aliases", cl::ReallyHidden);
00041 static cl::opt<bool> PrintMustAlias("print-must-aliases", cl::ReallyHidden);
00042 
00043 static cl::opt<bool> PrintNoModRef("print-no-modref", cl::ReallyHidden);
00044 static cl::opt<bool> PrintMod("print-mod", cl::ReallyHidden);
00045 static cl::opt<bool> PrintRef("print-ref", cl::ReallyHidden);
00046 static cl::opt<bool> PrintModRef("print-modref", cl::ReallyHidden);
00047 
00048 namespace {
00049   class VISIBILITY_HIDDEN AAEval : public FunctionPass {
00050     unsigned NoAlias, MayAlias, MustAlias;
00051     unsigned NoModRef, Mod, Ref, ModRef;
00052 
00053   public:
00054     static char ID; // Pass identification, replacement for typeid
00055     AAEval() : FunctionPass(&ID) {}
00056 
00057     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
00058       AU.addRequired<AliasAnalysis>();
00059       AU.setPreservesAll();
00060     }
00061 
00062     bool doInitialization(Module &M) {
00063       NoAlias = MayAlias = MustAlias = 0;
00064       NoModRef = Mod = Ref = ModRef = 0;
00065 
00066       if (PrintAll) {
00067         PrintNoAlias = PrintMayAlias = PrintMustAlias = true;
00068         PrintNoModRef = PrintMod = PrintRef = PrintModRef = true;
00069       }
00070       return false;
00071     }
00072 
00073     bool runOnFunction(Function &F);
00074     bool doFinalization(Module &M);
00075   };
00076 }
00077 
00078 char AAEval::ID = 0;
00079 static RegisterPass<AAEval>
00080 X("aa-eval", "Exhaustive Alias Analysis Precision Evaluator", false, true);
00081 
00082 FunctionPass *llvm::createAAEvalPass() { return new AAEval(); }
00083 
00084 static void PrintResults(const char *Msg, bool P, const Value *V1, const Value *V2,
00085                          const Module *M) {
00086   if (P) {
00087     std::stringstream s1, s2;
00088     WriteAsOperand(s1, V1, true, M);
00089     WriteAsOperand(s2, V2, true, M);
00090     std::string o1(s1.str()), o2(s2.str());
00091     if (o2 < o1)
00092       std::swap(o1, o2);
00093     errs() << "  " << Msg << ":\t"
00094            << o1 << ", "
00095            << o2 << "\n";
00096   }
00097 }
00098 
00099 static inline void
00100 PrintModRefResults(const char *Msg, bool P, Instruction *I, Value *Ptr,
00101                    Module *M) {
00102   if (P) {
00103     errs() << "  " << Msg << ":  Ptr: ";
00104     WriteAsOperand(errs(), Ptr, true, M);
00105     errs() << "\t<->" << *I;
00106   }
00107 }
00108 
00109 bool AAEval::runOnFunction(Function &F) {
00110   AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
00111 
00112   std::set<Value *> Pointers;
00113   std::set<CallSite> CallSites;
00114 
00115   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
00116     if (isa<PointerType>(I->getType()))    // Add all pointer arguments
00117       Pointers.insert(I);
00118 
00119   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
00120     if (isa<PointerType>(I->getType())) // Add all pointer instructions
00121       Pointers.insert(&*I);
00122     Instruction &Inst = *I;
00123     User::op_iterator OI = Inst.op_begin();
00124     CallSite CS = CallSite::get(&Inst);
00125     if (CS.getInstruction() &&
00126         isa<Function>(CS.getCalledValue()))
00127       ++OI;  // Skip actual functions for direct function calls.
00128     for (; OI != Inst.op_end(); ++OI)
00129       if (isa<PointerType>((*OI)->getType()) && !isa<ConstantPointerNull>(*OI))
00130         Pointers.insert(*OI);
00131 
00132     if (CS.getInstruction()) CallSites.insert(CS);
00133   }
00134 
00135   if (PrintNoAlias || PrintMayAlias || PrintMustAlias ||
00136       PrintNoModRef || PrintMod || PrintRef || PrintModRef)
00137     errs() << "Function: " << F.getName() << ": " << Pointers.size()
00138            << " pointers, " << CallSites.size() << " call sites\n";
00139 
00140   // iterate over the worklist, and run the full (n^2)/2 disambiguations
00141   for (std::set<Value *>::iterator I1 = Pointers.begin(), E = Pointers.end();
00142        I1 != E; ++I1) {
00143     unsigned I1Size = ~0u;
00144     const Type *I1ElTy = cast<PointerType>((*I1)->getType())->getElementType();
00145     if (I1ElTy->isSized()) I1Size = AA.getTypeStoreSize(I1ElTy);
00146 
00147     for (std::set<Value *>::iterator I2 = Pointers.begin(); I2 != I1; ++I2) {
00148       unsigned I2Size = ~0u;
00149       const Type *I2ElTy =cast<PointerType>((*I2)->getType())->getElementType();
00150       if (I2ElTy->isSized()) I2Size = AA.getTypeStoreSize(I2ElTy);
00151 
00152       switch (AA.alias(*I1, I1Size, *I2, I2Size)) {
00153       case AliasAnalysis::NoAlias:
00154         PrintResults("NoAlias", PrintNoAlias, *I1, *I2, F.getParent());
00155         ++NoAlias; break;
00156       case AliasAnalysis::MayAlias:
00157         PrintResults("MayAlias", PrintMayAlias, *I1, *I2, F.getParent());
00158         ++MayAlias; break;
00159       case AliasAnalysis::MustAlias:
00160         PrintResults("MustAlias", PrintMustAlias, *I1, *I2, F.getParent());
00161         ++MustAlias; break;
00162       default:
00163         errs() << "Unknown alias query result!\n";
00164       }
00165     }
00166   }
00167 
00168   // Mod/ref alias analysis: compare all pairs of calls and values
00169   for (std::set<CallSite>::iterator C = CallSites.begin(),
00170          Ce = CallSites.end(); C != Ce; ++C) {
00171     Instruction *I = C->getInstruction();
00172 
00173     for (std::set<Value *>::iterator V = Pointers.begin(), Ve = Pointers.end();
00174          V != Ve; ++V) {
00175       unsigned Size = ~0u;
00176       const Type *ElTy = cast<PointerType>((*V)->getType())->getElementType();
00177       if (ElTy->isSized()) Size = AA.getTypeStoreSize(ElTy);
00178 
00179       switch (AA.getModRefInfo(*C, *V, Size)) {
00180       case AliasAnalysis::NoModRef:
00181         PrintModRefResults("NoModRef", PrintNoModRef, I, *V, F.getParent());
00182         ++NoModRef; break;
00183       case AliasAnalysis::Mod:
00184         PrintModRefResults("     Mod", PrintMod, I, *V, F.getParent());
00185         ++Mod; break;
00186       case AliasAnalysis::Ref:
00187         PrintModRefResults("     Ref", PrintRef, I, *V, F.getParent());
00188         ++Ref; break;
00189       case AliasAnalysis::ModRef:
00190         PrintModRefResults("  ModRef", PrintModRef, I, *V, F.getParent());
00191         ++ModRef; break;
00192       default:
00193         errs() << "Unknown alias query result!\n";
00194       }
00195     }
00196   }
00197 
00198   return false;
00199 }
00200 
00201 static void PrintPercent(unsigned Num, unsigned Sum) {
00202   errs() << "(" << Num*100ULL/Sum << "."
00203          << ((Num*1000ULL/Sum) % 10) << "%)\n";
00204 }
00205 
00206 bool AAEval::doFinalization(Module &M) {
00207   unsigned AliasSum = NoAlias + MayAlias + MustAlias;
00208   errs() << "===== Alias Analysis Evaluator Report =====\n";
00209   if (AliasSum == 0) {
00210     errs() << "  Alias Analysis Evaluator Summary: No pointers!\n";
00211   } else {
00212     errs() << "  " << AliasSum << " Total Alias Queries Performed\n";
00213     errs() << "  " << NoAlias << " no alias responses ";
00214     PrintPercent(NoAlias, AliasSum);
00215     errs() << "  " << MayAlias << " may alias responses ";
00216     PrintPercent(MayAlias, AliasSum);
00217     errs() << "  " << MustAlias << " must alias responses ";
00218     PrintPercent(MustAlias, AliasSum);
00219     errs() << "  Alias Analysis Evaluator Pointer Alias Summary: "
00220            << NoAlias*100/AliasSum  << "%/" << MayAlias*100/AliasSum << "%/"
00221            << MustAlias*100/AliasSum << "%\n";
00222   }
00223 
00224   // Display the summary for mod/ref analysis
00225   unsigned ModRefSum = NoModRef + Mod + Ref + ModRef;
00226   if (ModRefSum == 0) {
00227     errs() << "  Alias Analysis Mod/Ref Evaluator Summary: no mod/ref!\n";
00228   } else {
00229     errs() << "  " << ModRefSum << " Total ModRef Queries Performed\n";
00230     errs() << "  " << NoModRef << " no mod/ref responses ";
00231     PrintPercent(NoModRef, ModRefSum);
00232     errs() << "  " << Mod << " mod responses ";
00233     PrintPercent(Mod, ModRefSum);
00234     errs() << "  " << Ref << " ref responses ";
00235     PrintPercent(Ref, ModRefSum);
00236     errs() << "  " << ModRef << " mod & ref responses ";
00237     PrintPercent(ModRef, ModRefSum);
00238     errs() << "  Alias Analysis Evaluator Mod/Ref Summary: "
00239            << NoModRef*100/ModRefSum  << "%/" << Mod*100/ModRefSum << "%/"
00240            << Ref*100/ModRefSum << "%/" << ModRef*100/ModRefSum << "%\n";
00241   }
00242 
00243   return false;
00244 }