blob: f388b1bbd76d6949a864191018768b586a1ce89d [file] [log] [blame]
Tom Care52d861c2010-09-10 00:44:44 +00001//==--AnalyzerStatsChecker.cpp - Analyzer visitation statistics --*- C++ -*-==//
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// This file reports various statistics about analyzer visitation.
10//===----------------------------------------------------------------------===//
11
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000012#include "ClangSACheckers.h"
Argyrios Kyrtzidisec8605f2011-03-01 01:16:21 +000013#include "clang/StaticAnalyzer/Core/Checker.h"
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000014#include "clang/StaticAnalyzer/Core/CheckerManager.h"
Ted Kremenek9b663712011-02-10 01:03:03 +000015#include "clang/StaticAnalyzer/Core/PathSensitive/ExplodedGraph.h"
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000016#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
Ted Kremenek9b663712011-02-10 01:03:03 +000017#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h"
Argyrios Kyrtzidisa7af5ea2010-12-22 18:52:56 +000018
Benjamin Kramerc35fb7d2012-01-28 12:06:22 +000019#include "clang/AST/DeclObjC.h"
Tom Care52d861c2010-09-10 00:44:44 +000020#include "clang/Basic/SourceManager.h"
21#include "llvm/ADT/SmallPtrSet.h"
22
23using namespace clang;
Ted Kremenek9ef65372010-12-23 07:20:52 +000024using namespace ento;
Tom Care52d861c2010-09-10 00:44:44 +000025
26namespace {
Argyrios Kyrtzidisec8605f2011-03-01 01:16:21 +000027class AnalyzerStatsChecker : public Checker<check::EndAnalysis> {
Tom Care52d861c2010-09-10 00:44:44 +000028public:
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000029 void checkEndAnalysis(ExplodedGraph &G, BugReporter &B,ExprEngine &Eng) const;
Tom Care52d861c2010-09-10 00:44:44 +000030};
31}
32
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000033void AnalyzerStatsChecker::checkEndAnalysis(ExplodedGraph &G,
Tom Care52d861c2010-09-10 00:44:44 +000034 BugReporter &B,
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000035 ExprEngine &Eng) const {
Tom Care52d861c2010-09-10 00:44:44 +000036 const CFG *C = 0;
37 const Decl *D = 0;
38 const LocationContext *LC = 0;
39 const SourceManager &SM = B.getSourceManager();
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +000040 llvm::SmallPtrSet<const CFGBlock*, 256> reachable;
Tom Care52d861c2010-09-10 00:44:44 +000041
42 // Iterate over explodedgraph
43 for (ExplodedGraph::node_iterator I = G.nodes_begin();
44 I != G.nodes_end(); ++I) {
45 const ProgramPoint &P = I->getLocation();
46 // Save the LocationContext if we don't have it already
47 if (!LC)
48 LC = P.getLocationContext();
49
Tom Care2cb55202010-09-29 23:48:34 +000050 if (const BlockEntrance *BE = dyn_cast<BlockEntrance>(&P)) {
51 const CFGBlock *CB = BE->getBlock();
Tom Care52d861c2010-09-10 00:44:44 +000052 reachable.insert(CB);
53 }
54 }
55
56 // Get the CFG and the Decl of this block
57 C = LC->getCFG();
Ted Kremenek1d26f482011-10-24 01:32:45 +000058 D = LC->getAnalysisDeclContext()->getDecl();
Tom Care52d861c2010-09-10 00:44:44 +000059
60 unsigned total = 0, unreachable = 0;
61
62 // Find CFGBlocks that were not covered by any node
63 for (CFG::const_iterator I = C->begin(); I != C->end(); ++I) {
64 const CFGBlock *CB = *I;
65 ++total;
66 // Check if the block is unreachable
67 if (!reachable.count(CB)) {
68 ++unreachable;
69 }
70 }
71
72 // We never 'reach' the entry block, so correct the unreachable count
73 unreachable--;
74
75 // Generate the warning string
76 llvm::SmallString<128> buf;
77 llvm::raw_svector_ostream output(buf);
78 PresumedLoc Loc = SM.getPresumedLoc(D->getLocation());
Douglas Gregorcb7b1e12010-11-12 07:15:47 +000079 if (Loc.isValid()) {
80 output << Loc.getFilename() << " : ";
Tom Care52d861c2010-09-10 00:44:44 +000081
Douglas Gregorcb7b1e12010-11-12 07:15:47 +000082 if (isa<FunctionDecl>(D) || isa<ObjCMethodDecl>(D)) {
83 const NamedDecl *ND = cast<NamedDecl>(D);
Benjamin Kramerb8989f22011-10-14 18:45:37 +000084 output << *ND;
Douglas Gregorcb7b1e12010-11-12 07:15:47 +000085 }
86 else if (isa<BlockDecl>(D)) {
87 output << "block(line:" << Loc.getLine() << ":col:" << Loc.getColumn();
88 }
Tom Care52d861c2010-09-10 00:44:44 +000089 }
Douglas Gregorcb7b1e12010-11-12 07:15:47 +000090
Tom Care52d861c2010-09-10 00:44:44 +000091 output << " -> Total CFGBlocks: " << total << " | Unreachable CFGBlocks: "
Ted Kremenek422ab7a2011-04-02 02:56:23 +000092 << unreachable << " | Exhausted Block: "
93 << (Eng.wasBlocksExhausted() ? "yes" : "no")
Tom Care52d861c2010-09-10 00:44:44 +000094 << " | Empty WorkList: "
Tom Care0e1cd942010-09-22 21:07:51 +000095 << (Eng.hasEmptyWorkList() ? "yes" : "no");
Tom Care52d861c2010-09-10 00:44:44 +000096
97 B.EmitBasicReport("Analyzer Statistics", "Internal Statistics", output.str(),
Anna Zaks590dd8e2011-09-20 21:38:35 +000098 PathDiagnosticLocation(D, SM));
Tom Care2cb55202010-09-29 23:48:34 +000099
100 // Emit warning for each block we bailed out on
Ted Kremenek422ab7a2011-04-02 02:56:23 +0000101 typedef CoreEngine::BlocksExhausted::const_iterator ExhaustedIterator;
Argyrios Kyrtzidisd2592a32010-12-22 18:53:44 +0000102 const CoreEngine &CE = Eng.getCoreEngine();
Ted Kremenek422ab7a2011-04-02 02:56:23 +0000103 for (ExhaustedIterator I = CE.blocks_exhausted_begin(),
104 E = CE.blocks_exhausted_end(); I != E; ++I) {
Tom Care2cb55202010-09-29 23:48:34 +0000105 const BlockEdge &BE = I->first;
106 const CFGBlock *Exit = BE.getDst();
107 const CFGElement &CE = Exit->front();
108 if (const CFGStmt *CS = dyn_cast<CFGStmt>(&CE))
109 B.EmitBasicReport("Bailout Point", "Internal Statistics", "The analyzer "
Anna Zaks590dd8e2011-09-20 21:38:35 +0000110 "stopped analyzing at this point",
111 PathDiagnosticLocation::createBegin(CS->getStmt(), SM, LC));
Tom Care2cb55202010-09-29 23:48:34 +0000112 }
Tom Care52d861c2010-09-10 00:44:44 +0000113}
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000114
115void ento::registerAnalyzerStatsChecker(CheckerManager &mgr) {
116 mgr.registerChecker<AnalyzerStatsChecker>();
117}