//===- AliasAnalysisCounter.cpp - Alias Analysis Query Counter ------------===//
-//
+//
// The LLVM Compiler Infrastructure
//
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
//===----------------------------------------------------------------------===//
//
// This file implements a pass which can be used to count how many alias queries
//
//===----------------------------------------------------------------------===//
+#include "llvm/Analysis/AliasAnalysisCounter.h"
#include "llvm/Analysis/AliasAnalysis.h"
+#include "llvm/IR/Module.h"
#include "llvm/Pass.h"
-#include <iostream>
-
-namespace {
- class AliasAnalysisCounter : public Pass, public AliasAnalysis {
- unsigned No, May, Must;
- unsigned NoMR, JustRef, JustMod, MR;
- const char *Name;
- public:
- AliasAnalysisCounter() {
- No = May = Must = 0;
- NoMR = JustRef = JustMod = MR = 0;
- }
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/Debug.h"
+#include "llvm/Support/ErrorHandling.h"
+#include "llvm/Support/raw_ostream.h"
+using namespace llvm;
- void printLine(const char *Desc, unsigned Val, unsigned Sum) {
- std::cerr << " " << Val << " " << Desc << " responses ("
- << Val*100/Sum << "%)\n";
- }
- ~AliasAnalysisCounter() {
- unsigned AASum = No+May+Must;
- unsigned MRSum = NoMR+JustRef+JustMod+MR;
- if (AASum + MRSum) { // Print a report if any counted queries occurred...
- std::cerr
- << "\n===== Alias Analysis Counter Report =====\n"
- << " Analysis counted: " << Name << "\n"
- << " " << AASum << " Total Alias Queries Performed\n";
- if (AASum) {
- printLine("no alias", No, AASum);
- printLine("may alias", May, AASum);
- printLine("must alias", Must, AASum);
- std::cerr
- << " Alias Analysis Counter Summary: " << No*100/AASum << "%/"
- << May*100/AASum << "%/" << Must*100/AASum<<"%\n\n";
- }
-
- std::cerr
- << " " << MRSum << " Total Mod/Ref Queries Performed\n";
- if (MRSum) {
- printLine("no mod/ref", NoMR, MRSum);
- printLine("ref", JustRef, MRSum);
- printLine("mod", JustMod, MRSum);
- printLine("mod/ref", MR, MRSum);
- std::cerr
- << " Mod/Ref Analysis Counter Summary: " << NoMR*100/MRSum<< "%/"
- << JustRef*100/MRSum << "%/" << JustMod*100/MRSum << "%/"
- << MR*100/MRSum <<"%\n\n";
- }
- }
- }
+static cl::opt<bool> PrintAll("count-aa-print-all-queries", cl::ReallyHidden,
+ cl::init(true));
+static cl::opt<bool> PrintAllFailures("count-aa-print-all-failed-queries",
+ cl::ReallyHidden);
- bool run(Module &M) {
- InitializeAliasAnalysis(this);
- Name = dynamic_cast<Pass*>(&getAnalysis<AliasAnalysis>())->getPassName();
- return false;
- }
+char AliasAnalysisCounter::ID = 0;
+INITIALIZE_AG_PASS(AliasAnalysisCounter, AliasAnalysis, "count-aa",
+ "Count Alias Analysis Query Responses", false, true, false)
- virtual void getAnalysisUsage(AnalysisUsage &AU) const {
- AliasAnalysis::getAnalysisUsage(AU);
- AU.addRequired<AliasAnalysis>();
- AU.setPreservesAll();
- }
+ModulePass *llvm::createAliasAnalysisCounterPass() {
+ return new AliasAnalysisCounter();
+}
- AliasResult count(AliasResult R) {
- switch (R) {
- default: assert(0 && "Unknown alias type!");
- case NoAlias: No++; return NoAlias;
- case MayAlias: May++; return MayAlias;
- case MustAlias: Must++; return MustAlias;
- }
- }
- ModRefResult count(ModRefResult R) {
- switch (R) {
- default: assert(0 && "Unknown mod/ref type!");
- case NoModRef: NoMR++; return NoModRef;
- case Ref: JustRef++; return Ref;
- case Mod: JustMod++; return Mod;
- case ModRef: MR++; return ModRef;
- }
- }
-
- // Forwarding functions: just delegate to a real AA implementation, counting
- // the number of responses...
- AliasResult alias(const Value *V1, unsigned V1Size,
- const Value *V2, unsigned V2Size) {
- return count(getAnalysis<AliasAnalysis>().alias(V1, V1Size, V2, V2Size));
+AliasAnalysisCounter::AliasAnalysisCounter() : ModulePass(ID) {
+ initializeAliasAnalysisCounterPass(*PassRegistry::getPassRegistry());
+ No = May = Partial = Must = 0;
+ NoMR = JustRef = JustMod = MR = 0;
+}
+
+static void printLine(const char *Desc, unsigned Val, unsigned Sum) {
+ errs() << " " << Val << " " << Desc << " responses (" << Val * 100 / Sum
+ << "%)\n";
+}
+
+AliasAnalysisCounter::~AliasAnalysisCounter() {
+ unsigned AASum = No + May + Partial + Must;
+ unsigned MRSum = NoMR + JustRef + JustMod + MR;
+ if (AASum + MRSum) { // Print a report if any counted queries occurred...
+ errs() << "\n===== Alias Analysis Counter Report =====\n"
+ << " Analysis counted:\n"
+ << " " << AASum << " Total Alias Queries Performed\n";
+ if (AASum) {
+ printLine("no alias", No, AASum);
+ printLine("may alias", May, AASum);
+ printLine("partial alias", Partial, AASum);
+ printLine("must alias", Must, AASum);
+ errs() << " Alias Analysis Counter Summary: " << No * 100 / AASum << "%/"
+ << May * 100 / AASum << "%/" << Partial * 100 / AASum << "%/"
+ << Must * 100 / AASum << "%\n\n";
}
- ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
- return count(getAnalysis<AliasAnalysis>().getModRefInfo(CS, P, Size));
+
+ errs() << " " << MRSum << " Total MRI_Mod/MRI_Ref Queries Performed\n";
+ if (MRSum) {
+ printLine("no mod/ref", NoMR, MRSum);
+ printLine("ref", JustRef, MRSum);
+ printLine("mod", JustMod, MRSum);
+ printLine("mod/ref", MR, MRSum);
+ errs() << " MRI_Mod/MRI_Ref Analysis Counter Summary: "
+ << NoMR * 100 / MRSum << "%/" << JustRef * 100 / MRSum << "%/"
+ << JustMod * 100 / MRSum << "%/" << MR * 100 / MRSum << "%\n\n";
}
- };
+ }
+}
+
+bool AliasAnalysisCounter::runOnModule(Module &M) {
+ this->M = &M;
+ InitializeAliasAnalysis(this, &M.getDataLayout());
+ return false;
+}
+
+void AliasAnalysisCounter::getAnalysisUsage(AnalysisUsage &AU) const {
+ AliasAnalysis::getAnalysisUsage(AU);
+ AU.addRequired<AliasAnalysis>();
+ AU.setPreservesAll();
+}
+
+void *AliasAnalysisCounter::getAdjustedAnalysisPointer(AnalysisID PI) {
+ if (PI == &AliasAnalysis::ID)
+ return (AliasAnalysis *)this;
+ return this;
+}
+
+AliasResult AliasAnalysisCounter::alias(const MemoryLocation &LocA,
+ const MemoryLocation &LocB) {
+ AliasResult R = getAnalysis<AliasAnalysis>().alias(LocA, LocB);
+
+ const char *AliasString = nullptr;
+ switch (R) {
+ case NoAlias:
+ No++;
+ AliasString = "No alias";
+ break;
+ case MayAlias:
+ May++;
+ AliasString = "May alias";
+ break;
+ case PartialAlias:
+ Partial++;
+ AliasString = "Partial alias";
+ break;
+ case MustAlias:
+ Must++;
+ AliasString = "Must alias";
+ break;
+ }
+
+ if (PrintAll || (PrintAllFailures && R == MayAlias)) {
+ errs() << AliasString << ":\t";
+ errs() << "[" << LocA.Size << "B] ";
+ LocA.Ptr->printAsOperand(errs(), true, M);
+ errs() << ", ";
+ errs() << "[" << LocB.Size << "B] ";
+ LocB.Ptr->printAsOperand(errs(), true, M);
+ errs() << "\n";
+ }
+
+ return R;
+}
+
+ModRefInfo AliasAnalysisCounter::getModRefInfo(ImmutableCallSite CS,
+ const MemoryLocation &Loc) {
+ ModRefInfo R = getAnalysis<AliasAnalysis>().getModRefInfo(CS, Loc);
+
+ const char *MRString = nullptr;
+ switch (R) {
+ case MRI_NoModRef:
+ NoMR++;
+ MRString = "MRI_NoModRef";
+ break;
+ case MRI_Ref:
+ JustRef++;
+ MRString = "JustRef";
+ break;
+ case MRI_Mod:
+ JustMod++;
+ MRString = "JustMod";
+ break;
+ case MRI_ModRef:
+ MR++;
+ MRString = "MRI_ModRef";
+ break;
+ }
- RegisterOpt<AliasAnalysisCounter>
- X("count-aa", "Count Alias Analysis Query Responses");
- RegisterAnalysisGroup<AliasAnalysis, AliasAnalysisCounter> Y;
+ if (PrintAll || (PrintAllFailures && R == MRI_ModRef)) {
+ errs() << MRString << ": Ptr: ";
+ errs() << "[" << Loc.Size << "B] ";
+ Loc.Ptr->printAsOperand(errs(), true, M);
+ errs() << "\t<->" << *CS.getInstruction() << '\n';
+ }
+ return R;
}