Static Analyzer Diagnostics: Move custom diagnostic visitors from BugReporterContext to BugReport.
One API change: I added BugReporter as an additional parameter to the BugReporterVisitor::VisitNode() method to allow visitors register other visitors with the report on the fly (while processing a node). This functionality is used by NilReceiverVisitor, which registers TrackNullOrUndefValue when the receiver is null.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@138001 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/lib/StaticAnalyzer/Core/BugReporter.cpp b/lib/StaticAnalyzer/Core/BugReporter.cpp
index 95303a0..6624b93 100644
--- a/lib/StaticAnalyzer/Core/BugReporter.cpp
+++ b/lib/StaticAnalyzer/Core/BugReporter.cpp
@@ -33,27 +33,6 @@
using namespace ento;
BugReporterVisitor::~BugReporterVisitor() {}
-BugReporterContext::~BugReporterContext() {
- for (visitor_iterator I = visitor_begin(), E = visitor_end(); I != E; ++I)
- if ((*I)->isOwnedByReporterContext()) delete *I;
-}
-
-void BugReporterContext::addVisitor(BugReporterVisitor* visitor) {
- if (!visitor)
- return;
-
- llvm::FoldingSetNodeID ID;
- visitor->Profile(ID);
- void *InsertPos;
-
- if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) {
- delete visitor;
- return;
- }
-
- CallbacksSet.InsertNode(visitor, InsertPos);
- Callbacks = F.add(visitor, Callbacks);
-}
//===----------------------------------------------------------------------===//
// Helper routines for walking the ExplodedGraph and fetching statements.
@@ -161,15 +140,15 @@
BugReport *r, NodeBackMap *Backmap,
PathDiagnosticClient *pdc)
: BugReporterContext(br),
- R(r), PDC(pdc), NMC(Backmap) {
- addVisitor(R);
- }
+ R(r), PDC(pdc), NMC(Backmap) {}
PathDiagnosticLocation ExecutionContinues(const ExplodedNode *N);
PathDiagnosticLocation ExecutionContinues(llvm::raw_string_ostream &os,
const ExplodedNode *N);
+ BugReport *getBugReport() { return R; }
+
Decl const &getCodeDecl() { return R->getErrorNode()->getCodeDecl(); }
ParentMap& getParentMap() { return R->getErrorNode()->getParentMap(); }
@@ -791,9 +770,11 @@
}
if (NextNode) {
- for (BugReporterContext::visitor_iterator I = PDB.visitor_begin(),
- E = PDB.visitor_end(); I!=E; ++I) {
- if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB))
+ // Add diagnostic pieces from custom visitors.
+ BugReport *R = PDB.getBugReport();
+ for (BugReport::visitor_iterator I = R->visitor_begin(),
+ E = R->visitor_end(); I!=E; ++I) {
+ if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R))
PD.push_front(p);
}
}
@@ -1198,9 +1179,11 @@
if (!NextNode)
continue;
- for (BugReporterContext::visitor_iterator I = PDB.visitor_begin(),
- E = PDB.visitor_end(); I!=E; ++I) {
- if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB)) {
+ // Add pieces from custom visitors.
+ BugReport *R = PDB.getBugReport();
+ for (BugReport::visitor_iterator I = R->visitor_begin(),
+ E = R->visitor_end(); I!=E; ++I) {
+ if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) {
const PathDiagnosticLocation &Loc = p->getLocation();
EB.addEdge(Loc, true);
PD.push_front(p);
@@ -1222,7 +1205,30 @@
// Methods for BugReport and subclasses.
//===----------------------------------------------------------------------===//
-BugReport::~BugReport() {}
+void BugReport::addVisitor(BugReporterVisitor* visitor) {
+ if (!visitor)
+ return;
+
+ llvm::FoldingSetNodeID ID;
+ visitor->Profile(ID);
+ void *InsertPos;
+
+ if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) {
+ delete visitor;
+ return;
+ }
+
+ CallbacksSet.InsertNode(visitor, InsertPos);
+ Callbacks = F.add(visitor, Callbacks);
+}
+
+BugReport::~BugReport() {
+ for (visitor_iterator I = visitor_begin(), E = visitor_end(); I != E; ++I) {
+ // TODO: Remove the isOwned method; use reference counting to track visitors?.
+ assert((*I)->isOwnedByReporterContext());
+ delete *I;
+ }
+}
void BugReport::Profile(llvm::FoldingSetNodeID& hash) const {
hash.AddPointer(&BT);
@@ -1336,7 +1342,8 @@
PathDiagnosticPiece *BugReport::VisitNode(const ExplodedNode *N,
const ExplodedNode *PrevN,
- BugReporterContext &BRC) {
+ BugReporterContext &BRC,
+ BugReport &BR) {
return NULL;
}
@@ -1655,10 +1662,9 @@
else
return;
- // Register node visitors.
- R->registerInitialVisitors(PDB, N);
- bugreporter::registerNilReceiverVisitor(PDB);
- bugreporter::registerConditionVisitor(PDB);
+ // Register additional node visitors.
+ bugreporter::registerNilReceiverVisitor(*R);
+ bugreporter::registerConditionVisitor(*R);
switch (PDB.getGenerationScheme()) {
case PathDiagnosticClient::Extensive:
diff --git a/lib/StaticAnalyzer/Core/BugReporterVisitors.cpp b/lib/StaticAnalyzer/Core/BugReporterVisitors.cpp
index 5cd9e4d..b6e726f 100644
--- a/lib/StaticAnalyzer/Core/BugReporterVisitors.cpp
+++ b/lib/StaticAnalyzer/Core/BugReporterVisitors.cpp
@@ -91,7 +91,8 @@
PathDiagnosticPiece *VisitNode(const ExplodedNode *N,
const ExplodedNode *PrevN,
- BugReporterContext &BRC) {
+ BugReporterContext &BRC,
+ BugReport &BR) {
if (satisfied)
return NULL;
@@ -221,9 +222,9 @@
};
-static void registerFindLastStore(BugReporterContext &BRC, const MemRegion *R,
+static void registerFindLastStore(BugReport &BR, const MemRegion *R,
SVal V) {
- BRC.addVisitor(new FindLastStoreBRVisitor(V, R));
+ BR.addVisitor(new FindLastStoreBRVisitor(V, R));
}
class TrackConstraintBRVisitor : public BugReporterVisitor {
@@ -243,7 +244,8 @@
PathDiagnosticPiece *VisitNode(const ExplodedNode *N,
const ExplodedNode *PrevN,
- BugReporterContext &BRC) {
+ BugReporterContext &BRC,
+ BugReport &BR) {
if (isSatisfied)
return NULL;
@@ -297,23 +299,23 @@
};
} // end anonymous namespace
-static void registerTrackConstraint(BugReporterContext &BRC,
+static void registerTrackConstraint(BugReport &BR,
DefinedSVal Constraint,
bool Assumption) {
- BRC.addVisitor(new TrackConstraintBRVisitor(Constraint, Assumption));
+ BR.addVisitor(new TrackConstraintBRVisitor(Constraint, Assumption));
}
-void bugreporter::registerTrackNullOrUndefValue(BugReporterContext &BRC,
- const void *data,
- const ExplodedNode *N) {
+void bugreporter::registerTrackNullOrUndefValue(BugReport &BR,
+ const void *data) {
const Stmt *S = static_cast<const Stmt*>(data);
+ const ExplodedNode *N = BR.getErrorNode();
if (!S)
return;
-
- ProgramStateManager &StateMgr = BRC.getStateManager();
+ ProgramStateManager &StateMgr = N->getState()->getStateManager();
+
// Walk through nodes until we get one that matches the statement
// exactly.
while (N) {
@@ -341,7 +343,7 @@
if (isa<loc::ConcreteInt>(V) || isa<nonloc::ConcreteInt>(V)
|| V.isUndef()) {
- ::registerFindLastStore(BRC, R, V);
+ ::registerFindLastStore(BR, R, V);
}
}
}
@@ -361,16 +363,16 @@
if (R) {
assert(isa<SymbolicRegion>(R));
- registerTrackConstraint(BRC, loc::MemRegionVal(R), false);
+ registerTrackConstraint(BR, loc::MemRegionVal(R), false);
}
}
}
-void bugreporter::registerFindLastStore(BugReporterContext &BRC,
- const void *data,
- const ExplodedNode *N) {
+void bugreporter::registerFindLastStore(BugReport &BR,
+ const void *data) {
const MemRegion *R = static_cast<const MemRegion*>(data);
+ const ExplodedNode *N = BR.getErrorNode();
if (!R)
return;
@@ -381,7 +383,7 @@
if (V.isUnknown())
return;
- BRC.addVisitor(new FindLastStoreBRVisitor(V, R));
+ BR.addVisitor(new FindLastStoreBRVisitor(V, R));
}
@@ -397,7 +399,8 @@
PathDiagnosticPiece *VisitNode(const ExplodedNode *N,
const ExplodedNode *PrevN,
- BugReporterContext &BRC) {
+ BugReporterContext &BRC,
+ BugReport &BR) {
const PostStmt *P = N->getLocationAs<PostStmt>();
if (!P)
@@ -420,7 +423,7 @@
// The receiver was nil, and hence the method was skipped.
// Register a BugReporterVisitor to issue a message telling us how
// the receiver was null.
- bugreporter::registerTrackNullOrUndefValue(BRC, Receiver, N);
+ bugreporter::registerTrackNullOrUndefValue(BR, Receiver);
// Issue a message saying that the method was skipped.
PathDiagnosticLocation L(Receiver, BRC.getSourceManager());
return new PathDiagnosticEventPiece(L, "No method actually called "
@@ -429,15 +432,15 @@
};
} // end anonymous namespace
-void bugreporter::registerNilReceiverVisitor(BugReporterContext &BRC) {
- BRC.addVisitor(new NilReceiverVisitor());
+void bugreporter::registerNilReceiverVisitor(BugReport &BR) {
+ BR.addVisitor(new NilReceiverVisitor());
}
-// Registers every VarDecl inside a Stmt with a last store vistor.
-void bugreporter::registerVarDeclsLastStore(BugReporterContext &BRC,
- const void *stmt,
- const ExplodedNode *N) {
+// Registers every VarDecl inside a Stmt with a last store visitor.
+void bugreporter::registerVarDeclsLastStore(BugReport &BR,
+ const void *stmt) {
const Stmt *S = static_cast<const Stmt *>(stmt);
+ const ExplodedNode *N = BR.getErrorNode();
std::deque<const Stmt *> WorkList;
@@ -447,8 +450,8 @@
const Stmt *Head = WorkList.front();
WorkList.pop_front();
- ProgramStateManager &StateMgr = BRC.getStateManager();
const ProgramState *state = N->getState();
+ ProgramStateManager &StateMgr = state->getStateManager();
if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(Head)) {
if (const VarDecl *VD = dyn_cast<VarDecl>(DR->getDecl())) {
@@ -459,7 +462,7 @@
SVal V = state->getSVal(S);
if (isa<loc::ConcreteInt>(V) || isa<nonloc::ConcreteInt>(V)) {
- ::registerFindLastStore(BRC, R, V);
+ ::registerFindLastStore(BR, R, V);
}
}
}
@@ -484,7 +487,8 @@
virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N,
const ExplodedNode *Prev,
- BugReporterContext &BRC);
+ BugReporterContext &BRC,
+ BugReport &BR);
PathDiagnosticPiece *VisitTerminator(const Stmt *Term,
const ProgramState *CurrentState,
@@ -515,7 +519,8 @@
PathDiagnosticPiece *ConditionVisitor::VisitNode(const ExplodedNode *N,
const ExplodedNode *Prev,
- BugReporterContext &BRC) {
+ BugReporterContext &BRC,
+ BugReport &BR) {
const ProgramPoint &progPoint = N->getLocation();
@@ -752,7 +757,7 @@
return new PathDiagnosticEventPiece(Loc, Out.str());
}
-void bugreporter::registerConditionVisitor(BugReporterContext &BRC) {
- BRC.addVisitor(new ConditionVisitor());
+void bugreporter::registerConditionVisitor(BugReport &BR) {
+ BR.addVisitor(new ConditionVisitor());
}
diff --git a/lib/StaticAnalyzer/Core/CFRefCount.cpp b/lib/StaticAnalyzer/Core/CFRefCount.cpp
index 3c395fe..78325f3 100644
--- a/lib/StaticAnalyzer/Core/CFRefCount.cpp
+++ b/lib/StaticAnalyzer/Core/CFRefCount.cpp
@@ -1994,7 +1994,8 @@
PathDiagnosticPiece *VisitNode(const ExplodedNode *N,
const ExplodedNode *PrevN,
- BugReporterContext &BRC);
+ BugReporterContext &BRC,
+ BugReport &BR);
};
class CFRefLeakReport : public CFRefReport {
@@ -2061,7 +2062,8 @@
PathDiagnosticPiece *CFRefReport::VisitNode(const ExplodedNode *N,
const ExplodedNode *PrevN,
- BugReporterContext &BRC) {
+ BugReporterContext &BRC,
+ BugReport &BR) {
if (!isa<PostStmt>(N->getLocation()))
return NULL;