161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// BugReporter.cpp - Generate PathDiagnostics for Bugs ------------*- C++ -*--// 261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// The LLVM Compiler Infrastructure 461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// This file is distributed under the University of Illinois Open Source 661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// License. See LICENSE.TXT for details. 761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek//===----------------------------------------------------------------------===// 961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 1061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// This file defines BugReporter, a utility class for generating 116c07bdba93b095b66e2c8c82dd5ed458fa8285eaTed Kremenek// PathDiagnostics. 1261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 1361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek//===----------------------------------------------------------------------===// 1461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 15cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose#define DEBUG_TYPE "BugReporter" 16cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 179b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h" 1861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#include "clang/AST/ASTContext.h" 19c35fb7d67d515659ad2325b4f6ec97c9fe64fb63Benjamin Kramer#include "clang/AST/DeclObjC.h" 2061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#include "clang/AST/Expr.h" 21cff15128c6c089bd6fae841b80680e6f5afbf0bfReid Kleckner#include "clang/AST/ExprCXX.h" 2200605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek#include "clang/AST/ParentMap.h" 2316f0049415ec596504891259e2a83e19871c0d52Chris Lattner#include "clang/AST/StmtObjC.h" 24cff15128c6c089bd6fae841b80680e6f5afbf0bfReid Kleckner#include "clang/AST/StmtCXX.h" 2555fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Analysis/CFG.h" 2661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#include "clang/Analysis/ProgramPoint.h" 2755fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Basic/SourceManager.h" 2855fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" 299b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 3055fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 31331b0ac44b9eb0ffcba66b4f3f3f9adb27c2434fTed Kremenek#include "llvm/ADT/DenseMap.h" 32802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 3355fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/OwningPtr.h" 3455fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/STLExtras.h" 3555fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/SmallString.h" 36cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose#include "llvm/ADT/Statistic.h" 3755fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/Support/raw_ostream.h" 3810aa55410bbecbb658ce14a5f801d50cf06d12dfTed Kremenek#include <queue> 3961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 4061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekusing namespace clang; 419ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 4261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 43cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan RoseSTATISTIC(MaxBugClassSize, 44cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "The maximum number of bug reports in the same equivalence class"); 45cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan RoseSTATISTIC(MaxValidBugClassSize, 46cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "The maximum number of bug reports in the same equivalence class " 47cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "where at least one report is valid (not suppressed)"); 48cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 498966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed KremenekBugReporterVisitor::~BugReporterVisitor() {} 501b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek 5199ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReporterContext::anchor() {} 5299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 53cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 543106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Helper routines for walking the ExplodedGraph and fetching statements. 55cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 5661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 579c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic const Stmt *GetPreviousStmt(const ExplodedNode *N) { 580f8579274a010f360a371b53101859d9d6052314Anna Zaks for (N = N->getFirstPred(); N; N = N->getFirstPred()) 590f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 60b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return S; 611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return 0; 63b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek} 64b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek 655f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenekstatic inline const Stmt* 669c378f705405d37f49795d5e915989de774fe11fTed KremenekGetCurrentOrPreviousStmt(const ExplodedNode *N) { 670f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 68b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return S; 691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return GetPreviousStmt(N); 71b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek} 721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek//===----------------------------------------------------------------------===// 74c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek// Diagnostic cleanup. 75c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek//===----------------------------------------------------------------------===// 76c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 77b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenekstatic PathDiagnosticEventPiece * 78b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted KremenekeventsDescribeSameCondition(PathDiagnosticEventPiece *X, 79b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek PathDiagnosticEventPiece *Y) { 80b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // Prefer diagnostics that come from ConditionBRVisitor over 81b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // those that came from TrackConstraintBRVisitor. 82b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek const void *tagPreferred = ConditionBRVisitor::getTag(); 83b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek const void *tagLesser = TrackConstraintBRVisitor::getTag(); 84b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 85b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (X->getLocation() != Y->getLocation()) 86b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return 0; 87b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 88b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (X->getTag() == tagPreferred && Y->getTag() == tagLesser) 89b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return X; 90b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 91b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (Y->getTag() == tagPreferred && X->getTag() == tagLesser) 92b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return Y; 93b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 94b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return 0; 95b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek} 96b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 973800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// An optimization pass over PathPieces that removes redundant diagnostics 983800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// generated by both ConditionBRVisitor and TrackConstraintBRVisitor. Both 993800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// BugReporterVisitors use different methods to generate diagnostics, with 1003800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// one capable of emitting diagnostics in some cases but not in others. This 1013800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// can lead to redundant diagnostic pieces at the same point in a path. 1023800165e56107df7430520aa98afdf7065db2dd2Ted Kremenekstatic void removeRedundantMsgs(PathPieces &path) { 103b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek unsigned N = path.size(); 104b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (N < 2) 105b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return; 1063800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // NOTE: this loop intentionally is not using an iterator. Instead, we 1073800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // are streaming the path and modifying it in place. This is done by 1083800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // grabbing the front, processing it, and if we decide to keep it append 1093800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // it to the end of the path. The entire path is processed in this way. 110b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek for (unsigned i = 0; i < N; ++i) { 111b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek IntrusiveRefCntPtr<PathDiagnosticPiece> piece(path.front()); 112b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.pop_front(); 113b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 114b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek switch (piece->getKind()) { 115b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Call: 1163800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek removeRedundantMsgs(cast<PathDiagnosticCallPiece>(piece)->path); 117b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 118b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Macro: 1193800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek removeRedundantMsgs(cast<PathDiagnosticMacroPiece>(piece)->subPieces); 120b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 121b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::ControlFlow: 122b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 123b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Event: { 124b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (i == N-1) 125b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 126b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 127b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (PathDiagnosticEventPiece *nextEvent = 128ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek dyn_cast<PathDiagnosticEventPiece>(path.front().getPtr())) { 129b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek PathDiagnosticEventPiece *event = 130b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek cast<PathDiagnosticEventPiece>(piece); 131b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // Check to see if we should keep one of the two pieces. If we 132b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // come up with a preference, record which piece to keep, and consume 133b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // another piece from the path. 134b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (PathDiagnosticEventPiece *pieceToKeep = 135b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek eventsDescribeSameCondition(event, nextEvent)) { 136b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek piece = pieceToKeep; 137b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.pop_front(); 138b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek ++i; 139b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 140b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 141b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 142b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 143b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 144b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.push_back(piece); 145b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 146b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek} 147b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 148d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek/// A map from PathDiagnosticPiece to the LocationContext of the inlined 149d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek/// function call it represents. 150bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenektypedef llvm::DenseMap<const PathPieces *, const LocationContext *> 151d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap; 152d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 153c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek/// Recursively scan through a path and prune out calls and macros pieces 154c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek/// that aren't needed. Return true if afterwards the path contains 155afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// "interesting stuff" which means it shouldn't be pruned from the parent path. 156d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenekstatic bool removeUnneededCalls(PathPieces &pieces, BugReport *R, 157d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM) { 158c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek bool containsSomethingInteresting = false; 159c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek const unsigned N = pieces.size(); 160c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 161c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek for (unsigned i = 0 ; i < N ; ++i) { 162c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek // Remove the front piece from the path. If it is still something we 163c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek // want to keep once we are done, we will push it back on the end. 164c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek IntrusiveRefCntPtr<PathDiagnosticPiece> piece(pieces.front()); 165c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek pieces.pop_front(); 166c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 167725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek switch (piece->getKind()) { 168725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Call: { 169725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticCallPiece *call = cast<PathDiagnosticCallPiece>(piece); 17080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Check if the location context is interesting. 171bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LCM.count(&call->path)); 172bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (R->isInteresting(LCM[&call->path])) { 17380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks containsSomethingInteresting = true; 17480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 17580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 176368f3b070e8cb657a65bfa443d60256676d269e7Jordan Rose 177d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek if (!removeUnneededCalls(call->path, R, LCM)) 178368f3b070e8cb657a65bfa443d60256676d269e7Jordan Rose continue; 179a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 180725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek containsSomethingInteresting = true; 181725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 182725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 183725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Macro: { 184725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticMacroPiece *macro = cast<PathDiagnosticMacroPiece>(piece); 185d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek if (!removeUnneededCalls(macro->subPieces, R, LCM)) 186725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek continue; 187c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek containsSomethingInteresting = true; 188725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 189725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 190725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Event: { 191725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticEventPiece *event = cast<PathDiagnosticEventPiece>(piece); 192a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 193725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek // We never throw away an event, but we do throw it away wholesale 194725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek // as part of a path if we throw the entire path away. 19522505ef15e32db31a4f834a387cf73a913bc8f66Ted Kremenek containsSomethingInteresting |= !event->isPrunable(); 196725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 197725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 198725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::ControlFlow: 199725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 200c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek } 201c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 202c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek pieces.push_back(piece); 203c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek } 204c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 205c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek return containsSomethingInteresting; 206c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek} 207c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 208d474da062565596015558856333423199aed5eb1Jordan Rose/// Returns true if the given decl has been implicitly given a body, either by 209d474da062565596015558856333423199aed5eb1Jordan Rose/// the analyzer or by the compiler proper. 210d474da062565596015558856333423199aed5eb1Jordan Rosestatic bool hasImplicitBody(const Decl *D) { 211d474da062565596015558856333423199aed5eb1Jordan Rose assert(D); 212d474da062565596015558856333423199aed5eb1Jordan Rose return D->isImplicit() || !D->hasBody(); 213d474da062565596015558856333423199aed5eb1Jordan Rose} 214d474da062565596015558856333423199aed5eb1Jordan Rose 215afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// Recursively scan through a path and make sure that all call pieces have 2166838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// valid locations. 217afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rosestatic void adjustCallLocations(PathPieces &Pieces, 218afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose PathDiagnosticLocation *LastCallLocation = 0) { 219afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E; ++I) { 220ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PathDiagnosticCallPiece *Call = dyn_cast<PathDiagnosticCallPiece>(*I); 221afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 222afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose if (!Call) { 223ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek assert((*I)->getLocation().asLocation().isValid()); 224afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose continue; 225afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 226afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 227afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose if (LastCallLocation) { 228d474da062565596015558856333423199aed5eb1Jordan Rose bool CallerIsImplicit = hasImplicitBody(Call->getCaller()); 229d474da062565596015558856333423199aed5eb1Jordan Rose if (CallerIsImplicit || !Call->callEnter.asLocation().isValid()) 230afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose Call->callEnter = *LastCallLocation; 231d474da062565596015558856333423199aed5eb1Jordan Rose if (CallerIsImplicit || !Call->callReturn.asLocation().isValid()) 232afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose Call->callReturn = *LastCallLocation; 233afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 234afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 235afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // Recursively clean out the subclass. Keep this call around if 236afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // it contains any informative diagnostics. 237afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose PathDiagnosticLocation *ThisCallLocation; 238187f8bd88bfc92cf3fea62b7d8db5f92edce410aJordan Rose if (Call->callEnterWithin.asLocation().isValid() && 239d474da062565596015558856333423199aed5eb1Jordan Rose !hasImplicitBody(Call->getCallee())) 240afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose ThisCallLocation = &Call->callEnterWithin; 241afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose else 242afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose ThisCallLocation = &Call->callEnter; 243afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 244afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose assert(ThisCallLocation && "Outermost call has an invalid location"); 245afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose adjustCallLocations(Call->path, ThisCallLocation); 246afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 247afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose} 248afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 2496838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// Remove all pieces with invalid locations as these cannot be serialized. 2506838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// We might have pieces with invalid locations as a result of inlining Body 2516838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// Farm generated functions. 2526838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaksstatic void removePiecesWithInvalidLocations(PathPieces &Pieces) { 25357c8736e7dce5e63b4e1665d2c4fcf6e6ef959d0Anna Zaks for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E;) { 2546838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks if (PathDiagnosticCallPiece *C = dyn_cast<PathDiagnosticCallPiece>(*I)) 2556838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks removePiecesWithInvalidLocations(C->path); 2566838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 2576838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks if (PathDiagnosticMacroPiece *M = dyn_cast<PathDiagnosticMacroPiece>(*I)) 2586838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks removePiecesWithInvalidLocations(M->subPieces); 2596838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 2606838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks if (!(*I)->getLocation().isValid() || 2616838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks !(*I)->getLocation().asLocation().isValid()) { 26257c8736e7dce5e63b4e1665d2c4fcf6e6ef959d0Anna Zaks I = Pieces.erase(I); 2636838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks continue; 2646838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks } 26557c8736e7dce5e63b4e1665d2c4fcf6e6ef959d0Anna Zaks I++; 2666838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks } 2676838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks} 2686838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 269c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek//===----------------------------------------------------------------------===// 2703106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnosticBuilder and its associated routines and helper objects. 271b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek//===----------------------------------------------------------------------===// 272b479dadea93b93d3f0a335c3518b703f140b3f50Ted Kremenek 273babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremeneknamespace { 274ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass NodeMapClosure : public BugReport::NodeResolver { 275c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose InterExplodedGraphMap &M; 2767dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenekpublic: 277c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose NodeMapClosure(InterExplodedGraphMap &m) : M(m) {} 2781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2799c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getOriginalNode(const ExplodedNode *N) { 280c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose return M.lookup(N); 2817dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 2827dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek}; 2831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 284ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass PathDiagnosticBuilder : public BugReporterContext { 2857dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek BugReport *R; 286ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer *PDC; 2877dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek NodeMapClosure NMC; 2881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 28959950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC; 29059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek 2918966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek PathDiagnosticBuilder(GRBugReporter &br, 292c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose BugReport *r, InterExplodedGraphMap &Backmap, 293ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer *pdc) 2948966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek : BugReporterContext(br), 29559950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek R(r), PDC(pdc), NMC(Backmap), LC(r->getErrorNode()->getLocationContext()) 29659950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek {} 2971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2989c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticLocation ExecutionContinues(const ExplodedNode *N); 2991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3009c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticLocation ExecutionContinues(llvm::raw_string_ostream &os, 3019c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N); 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3038e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *getBugReport() { return R; } 3048e6431adab313e283a992698f6fc7afe62420999Anna Zaks 305212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care Decl const &getCodeDecl() { return R->getErrorNode()->getCodeDecl(); } 30659950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek 30759950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek ParentMap& getParentMap() { return LC->getParentMap(); } 3081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 309c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek const Stmt *getParent(const Stmt *S) { 310c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek return getParentMap().getParent(S); 311c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek } 3121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3138966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek virtual NodeMapClosure& getNodeResolver() { return NMC; } 3147297134f128423fce2e88f92421ed135bded7d4eDouglas Gregor 315d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation getEnclosingStmtLocation(const Stmt *S); 3161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 317ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer::PathGenerationScheme getGenerationScheme() const { 318ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie return PDC ? PDC->getGenerationScheme() : PathDiagnosticConsumer::Extensive; 3197dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 3207dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek 321babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek bool supportsLogicalOpControlFlow() const { 322babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek return PDC ? PDC->supportsLogicalOpControlFlow() : true; 3231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 324babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek}; 325babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek} // end anonymous namespace 326babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek 32700605e0f011ed99225a22026344c5fc1b3212cd7Ted KremenekPathDiagnosticLocation 3289c378f705405d37f49795d5e915989de774fe11fTed KremenekPathDiagnosticBuilder::ExecutionContinues(const ExplodedNode *N) { 3290f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getNextStmt(N)) 33059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek return PathDiagnosticLocation(S, getSourceManager(), LC); 33100605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek 3320cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks return PathDiagnosticLocation::createDeclEnd(N->getLocationContext(), 3330cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks getSourceManager()); 334082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek} 3351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33600605e0f011ed99225a22026344c5fc1b3212cd7Ted KremenekPathDiagnosticLocation 3379c378f705405d37f49795d5e915989de774fe11fTed KremenekPathDiagnosticBuilder::ExecutionContinues(llvm::raw_string_ostream &os, 3389c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N) { 339babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek 340143ca222583a4a355fdc89af852deef287499300Ted Kremenek // Slow, but probably doesn't matter. 341b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek if (os.str().empty()) 342b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek os << ' '; 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 34400605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek const PathDiagnosticLocation &Loc = ExecutionContinues(N); 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 34600605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek if (Loc.asStmt()) 347b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek os << "Execution continues on line " 348642116259e8df6286063a17361c20e95b5017a0aChandler Carruth << getSourceManager().getExpansionLineNumber(Loc.asLocation()) 3498966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek << '.'; 3504f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else { 3514f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "Execution jumps to the end of the "; 3524f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek const Decl *D = N->getLocationContext()->getDecl(); 3534f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek if (isa<ObjCMethodDecl>(D)) 3544f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "method"; 3554f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else if (isa<FunctionDecl>(D)) 3564f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "function"; 3574f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else { 3584f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek assert(isa<BlockDecl>(D)); 3594f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "anonymous block"; 3604f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek } 3614f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << '.'; 3624f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek } 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 364082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek return Loc; 365143ca222583a4a355fdc89af852deef287499300Ted Kremenek} 366143ca222583a4a355fdc89af852deef287499300Ted Kremenek 36796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic const Stmt *getEnclosingParent(const Stmt *S, const ParentMap &PM) { 368ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (isa<Expr>(S) && PM.isConsumedExpr(cast<Expr>(S))) 36996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PM.getParentIgnoreParens(S); 3701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 371ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const Stmt *Parent = PM.getParentIgnoreParens(S); 37296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!Parent) 37396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return 0; 3741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose switch (Parent->getStmtClass()) { 37696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::ForStmtClass: 37796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::DoStmtClass: 37896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::WhileStmtClass: 37996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::ObjCForCollectionStmtClass: 38049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: 38196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return Parent; 38296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose default: 38396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 38496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 3851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return 0; 387ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek} 388ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek 38996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic PathDiagnosticLocation 39096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosegetEnclosingStmtLocation(const Stmt *S, SourceManager &SMgr, const ParentMap &P, 3919d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose const LocationContext *LC, bool allowNestedContexts) { 39296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!S) 39396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PathDiagnosticLocation(); 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (const Stmt *Parent = getEnclosingParent(S, P)) { 396af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek switch (Parent->getStmtClass()) { 3975fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek case Stmt::BinaryOperatorClass: { 3985fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const BinaryOperator *B = cast<BinaryOperator>(Parent); 3995fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 4009d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose return PathDiagnosticLocation(allowNestedContexts ? B : S, SMgr, LC); 4015fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek break; 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 403af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::CompoundStmtClass: 404af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::StmtExprClass: 405220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4061d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ChooseExprClass: 4071d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // Similar to '?' if we are referring to condition, just have the edge 4081d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // point to the entire choose expression. 4099d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose if (allowNestedContexts || cast<ChooseExpr>(Parent)->getCond() == S) 410220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 4111d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 412220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 41356ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 4141d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ConditionalOperatorClass: 4151d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // For '?', if we are referring to condition, just have the edge point 4161d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // to the entire '?' expression. 4179d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose if (allowNestedContexts || 4189d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose cast<AbstractConditionalOperator>(Parent)->getCond() == S) 419220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 4201d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 421220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 42249a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: 42349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (cast<CXXForRangeStmt>(Parent)->getBody() == S) 42449a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return PathDiagnosticLocation(S, SMgr, LC); 42549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose break; 426af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::DoStmtClass: 427220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 428af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ForStmtClass: 429af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ForStmt>(Parent)->getBody() == S) 430220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump break; 432af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::IfStmtClass: 433af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<IfStmt>(Parent)->getCond() != S) 434220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4358bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek break; 436af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 437af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ObjCForCollectionStmt>(Parent)->getBody() == S) 438220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 439af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 440af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::WhileStmtClass: 441af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<WhileStmt>(Parent)->getCond() != S) 442220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 443af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 444af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek default: 445af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 446af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek } 447af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek 448d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek S = Parent; 449d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek } 4501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 451d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek assert(S && "Cannot have null Stmt for PathDiagnosticLocation"); 452e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek 453220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 454d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek} 455d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 45696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosePathDiagnosticLocation 45796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosePathDiagnosticBuilder::getEnclosingStmtLocation(const Stmt *S) { 45896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose assert(S && "Null Stmt passed to getEnclosingStmtLocation"); 4599d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose return ::getEnclosingStmtLocation(S, getSourceManager(), getParentMap(), LC, 4609d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose /*allowNestedContexts=*/false); 46196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 46296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 463cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 464d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose// "Visitors only" path diagnostic generation algorithm. 465d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 466d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rosestatic bool GenerateVisitorsOnlyPathDiagnostic(PathDiagnostic &PD, 467d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PathDiagnosticBuilder &PDB, 468d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose const ExplodedNode *N, 469d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose ArrayRef<BugReporterVisitor *> visitors) { 470d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // All path generation skips the very first node (the error node). 471d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // This is because there is special handling for the end-of-path note. 472d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = N->getFirstPred(); 473d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!N) 474d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return true; 475d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 476d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose BugReport *R = PDB.getBugReport(); 477d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose while (const ExplodedNode *Pred = N->getFirstPred()) { 478d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 479d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose E = visitors.end(); 480d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose I != E; ++I) { 481d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // Visit all the node pairs, but throw the path pieces away. 482d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PathDiagnosticPiece *Piece = (*I)->VisitNode(N, Pred, PDB, *R); 483d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose delete Piece; 484d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 485d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 486d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = Pred; 487d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 488d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 489d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return R->isValid(); 490d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose} 491d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 492d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 4933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// "Minimal" path diagnostic generation algorithm. 494cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 49556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef std::pair<PathDiagnosticCallPiece*, const ExplodedNode*> StackDiagPair; 49656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef SmallVector<StackDiagPair, 6> StackDiagVector; 49756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 498368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaksstatic void updateStackPiecesWithMessage(PathDiagnosticPiece *P, 49956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector &CallStack) { 500368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // If the piece contains a special message, add it to all the call 501368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // pieces on the active stack. 502368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticEventPiece *ep = 503368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks dyn_cast<PathDiagnosticEventPiece>(P)) { 504368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 50556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (ep->hasCallStackHint()) 50656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks for (StackDiagVector::iterator I = CallStack.begin(), 50756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks E = CallStack.end(); I != E; ++I) { 50856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks PathDiagnosticCallPiece *CP = I->first; 50956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks const ExplodedNode *N = I->second; 5108fe4525680ce72e90cee3e58b5654e3ae955447fNAKAMURA Takumi std::string stackMsg = ep->getCallStackMessage(N); 51156a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 512368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // The last message on the path to final bug is the most important 513368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // one. Since we traverse the path backwards, do not add the message 514368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // if one has been previously added. 51556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (!CP->hasCallStackMessage()) 51656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks CP->setCallStackMessage(stackMsg); 51756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks } 518368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 519368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks} 520cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 52177d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM); 52214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 5238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosestatic bool GenerateMinimalPathDiagnostic(PathDiagnostic& PD, 5243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticBuilder &PDB, 5253bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose const ExplodedNode *N, 526d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM, 5273bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ArrayRef<BugReporterVisitor *> visitors) { 5288966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 5293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceManager& SMgr = PDB.getSourceManager(); 53059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC = PDB.LC; 5319c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() 5323106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek ? NULL : *(N->pred_begin()); 533368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 53456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 535368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 5363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (NextNode) { 5371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = NextNode; 53859950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC = N->getLocationContext(); 5390f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 5401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek ProgramPoint P = N->getLocation(); 54280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 54380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks do { 5447a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 54580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C = 54680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece::construct(N, *CE, SMgr); 547d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 548bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 54980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(C); 55080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.pushActivePath(&C->path); 55180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.push_back(StackDiagPair(C, N)); 55280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5539373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 554183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 5557a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 55680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Flush all locations, and pop the active path. 55780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool VisitedEntireCall = PD.isWithinCall(); 55880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.popActivePath(); 55980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 56080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Either we just added a bunch of stuff to the top-level path, or 56180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // we have a previous CallExitEnd. If the former, it means that the 56280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // path terminated within a function call. We must then take the 56380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // current contents of the active path and place it within 56480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // a new PathDiagnosticCallPiece. 56580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C; 56680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (VisitedEntireCall) { 56780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 56880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } else { 56980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Decl *Caller = CE->getLocationContext()->getDecl(); 57080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 571d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 572bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 57380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 57480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 57580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C->setCallee(*CE, SMgr); 57680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!CallStack.empty()) { 57780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks assert(CallStack.back().first == C); 57880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.pop_back(); 57980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 58080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 581368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 5821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5837a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 58480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Src = BE->getSrc(); 58580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Dst = BE->getDst(); 58680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Stmt *T = Src->getTerminator(); 5871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 58880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!T) 58980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation Start = 59280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createBegin(T, SMgr, 59380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks N->getLocationContext()); 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks switch (T->getStmtClass()) { 59661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek default: 59761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 5981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek case Stmt::GotoStmtClass: 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::IndirectGotoStmtClass: { 6010f8579274a010f360a371b53101859d9d6052314Anna Zaks const Stmt *S = PathDiagnosticLocation::getNextStmt(N); 6021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek if (!S) 60480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 6051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 606297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 6071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump llvm::raw_string_ostream os(sbuf); 608d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek const PathDiagnosticLocation &End = PDB.getEnclosingStmtLocation(S); 6091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 61000605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek os << "Control jumps to line " 61180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 61280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 61380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 61461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 61561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 6161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::SwitchStmtClass: { 61861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek // Figure out what case arm we took. 619297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 620297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6229c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Stmt *S = Dst->getLabel()) { 623220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(S, SMgr, LC); 6241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6255a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek switch (S->getStmtClass()) { 62680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks default: 62780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "No cases match in the switch statement. " 62880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks "Control jumps to line " 62980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 63080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 63180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::DefaultStmtClass: 63280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to the 'default' case at line " 63380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 63480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 63580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 63680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::CaseStmtClass: { 63780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to 'case "; 63880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CaseStmt *Case = cast<CaseStmt>(S); 63980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Expr *LHS = Case->getLHS()->IgnoreParenCasts(); 64080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 64180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine if it is an enum. 64280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool GetRawInt = true; 64380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 64480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(LHS)) { 64580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // FIXME: Maybe this should be an assertion. Are there cases 64680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // were it is not an EnumConstantDecl? 64780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const EnumConstantDecl *D = 64803509aea098772644bf4662dc1c88634818ceeccZhongxing Xu dyn_cast<EnumConstantDecl>(DR->getDecl()); 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 65080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (D) { 65180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks GetRawInt = false; 65280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << *D; 6535a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek } 65480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 6559ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 65680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (GetRawInt) 65780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << LHS->EvaluateKnownConstInt(PDB.getASTContext()); 6589ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 65980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << ":' at line " 66080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 66180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 66261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 66380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 66480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 66580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 66661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 667567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek else { 668c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "'Default' branch taken. "; 6691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const PathDiagnosticLocation &End = PDB.ExecutionContinues(os, N); 67080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 67180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 672567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek } 6731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 67461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 67561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 6761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6772673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::BreakStmtClass: 6782673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::ContinueStmtClass: { 679297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 680297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 68100605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 68280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 68380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 6842673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek break; 6852673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek } 6861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for ternary '?'. 68856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 689706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek case Stmt::ConditionalOperatorClass: { 690297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 691297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6921d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek os << "'?' condition is "; 6931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 694706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()+1) == Dst) 695082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "false"; 696706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek else 697082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "true"; 6981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69900605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7011d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek if (const Stmt *S = End.asStmt()) 7021d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 70580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 706babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 707babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for short-circuited '&&' and '||'. 710babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek case Stmt::BinaryOperatorClass: { 711babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek if (!PDB.supportsLogicalOpControlFlow()) 712babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 7131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71403509aea098772644bf4662dc1c88634818ceeccZhongxing Xu const BinaryOperator *B = cast<BinaryOperator>(T); 715babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek std::string sbuf; 716babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek llvm::raw_string_ostream os(sbuf); 717babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek os << "Left side of '"; 7181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7192de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall if (B->getOpcode() == BO_LAnd) { 720f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "&&" << "' is "; 7211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 722f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 723f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 724220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7250cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 72680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 72780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 72880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 730f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 731f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 732220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 733f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 73480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 73580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 737babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 738babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek else { 7392de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall assert(B->getOpcode() == BO_LOr); 740f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "||" << "' is "; 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 742f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 743f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 744220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 745f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 74680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 74780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 748f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 749f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 750f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 751220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7520cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 75380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 75480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 75580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 756f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 757babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 759706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek break; 760706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek } 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::DoStmtClass: { 763706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()) == Dst) { 764297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 765297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 7661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 767c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "Loop condition is true. "; 768d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 7691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 770d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 771d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 7721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 77480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 775082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek } 776082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek else { 77700605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 779d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 780d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 7811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 78380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is false. Exiting loop")); 7843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 7873106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7893106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::WhileStmtClass: 7901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::ForStmtClass: { 7913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) { 7923106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek std::string sbuf; 7933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek llvm::raw_string_ostream os(sbuf); 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek os << "Loop condition is false. "; 7963106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 7973106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 7983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 8023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8033106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 8043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8063106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is true. Entering loop body")); 8103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8123106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8133106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::IfStmtClass: { 8163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8193106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) 82280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 82380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking false branch")); 8241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 82580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 82680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking true branch")); 8271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 83080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 8313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 83280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } while(0); 8331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 834dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (NextNode) { 8358e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add diagnostic pieces from custom visitors. 8368e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 8373bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 8383bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose E = visitors.end(); 8393bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose I != E; ++I) { 840368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 8412042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 842368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 843368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 844dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 8458966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 8463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8488347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose if (!PDB.getBugReport()->isValid()) 8498347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return false; 8508347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 85114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // After constructing the full PathDiagnostic, do a pass over it to compact 85214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // PathDiagnosticPieces that occur within a macro. 85377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(PD.getMutablePieces(), PDB.getSourceManager()); 8548347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return true; 8553106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 8563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 8573106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 8585fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek// "Extensive" PathDiagnostic generation. 8595fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 8605fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 8615fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenekstatic bool IsControlFlowExpr(const Stmt *S) { 8625fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const Expr *E = dyn_cast<Expr>(S); 8631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8645fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (!E) 8655fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return false; 8661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump E = E->IgnoreParenCasts(); 8681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 86956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall if (isa<AbstractConditionalOperator>(E)) 8705fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 8711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8725fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (const BinaryOperator *B = dyn_cast<BinaryOperator>(E)) 8735fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 8745fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 8751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return false; 8775fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek} 8785fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 87914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremeneknamespace { 880ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ContextLocation : public PathDiagnosticLocation { 8818f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsDead; 8828f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekpublic: 8838f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation(const PathDiagnosticLocation &L, bool isdead = false) 8848f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek : PathDiagnosticLocation(L), IsDead(isdead) {} 8851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void markDead() { IsDead = true; } 8878f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool isDead() const { return IsDead; } 8888f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek}; 8891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 890e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenekstatic PathDiagnosticLocation cleanUpLocation(PathDiagnosticLocation L, 891e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const LocationContext *LC, 892e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek bool firstCharOnly = false) { 893e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (const Stmt *S = L.asStmt()) { 894e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const Stmt *Original = S; 895e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek while (1) { 896e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // Adjust the location for some expressions that are best referenced 897e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // by one of their subexpressions. 898e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek switch (S->getStmtClass()) { 899e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek default: 900e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 901e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ParenExprClass: 902e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::GenericSelectionExprClass: 903e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<Expr>(S)->IgnoreParens(); 904e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 905e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 906e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryConditionalOperatorClass: 907e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ConditionalOperatorClass: 908e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<AbstractConditionalOperator>(S)->getCond(); 909e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 910e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 911e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ChooseExprClass: 912e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<ChooseExpr>(S)->getCond(); 913e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 914e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 915e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryOperatorClass: 916e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<BinaryOperator>(S)->getLHS(); 917e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 918e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 919e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 920e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 921e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 922e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 923e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 924e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (S != Original) 925e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation(S, L.getManager(), LC); 926e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 927e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 928e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (firstCharOnly) 929e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation::createSingleLocation(L); 930e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 931e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek return L; 932e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek} 933e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 934ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass EdgeBuilder { 9358f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek std::vector<ContextLocation> CLocs; 9368f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek typedef std::vector<ContextLocation>::iterator iterator; 93714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnostic &PD; 93814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB; 93914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation PrevLoc; 9401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9418f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsConsumedExpr(const PathDiagnosticLocation &L); 9421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 94314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek bool containsLocation(const PathDiagnosticLocation &Container, 94414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee); 9451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 94614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation getContextLocation(const PathDiagnosticLocation &L); 9471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 95014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void popLocation() { 9518f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (!CLocs.back().isDead() && CLocs.back().asLocation().isFileID()) { 9525c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // For contexts, we only one the first character as the range. 953e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek rawAddEdge(cleanUpLocation(CLocs.back(), PDB.LC, true)); 9545c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek } 95514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.pop_back(); 95614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 9571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 95814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekpublic: 95914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder(PathDiagnostic &pd, PathDiagnosticBuilder &pdb) 96014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek : PD(pd), PDB(pdb) { 9611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 962a301a6773db085575ac51e3c966858180390c25bTed Kremenek // If the PathDiagnostic already has pieces, add the enclosing statement 963a301a6773db085575ac51e3c966858180390c25bTed Kremenek // of the first piece as a context as well. 964802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (!PD.path.empty()) { 965ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PrevLoc = (*PD.path.begin())->getLocation(); 9661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 96714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = PrevLoc.asStmt()) 968e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 96914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 97014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 97114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 97214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ~EdgeBuilder() { 97314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) popLocation(); 9740cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks 975a301a6773db085575ac51e3c966858180390c25bTed Kremenek // Finally, add an initial edge from the start location of the first 976a301a6773db085575ac51e3c966858180390c25bTed Kremenek // statement (if it doesn't already exist). 9770cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createDeclBegin( 97859950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC, 9790cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PDB.getSourceManager()); 9800cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks if (L.isValid()) 9810cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks rawAddEdge(L); 98214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 98314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 9845de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek void flushLocations() { 9855de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek while (!CLocs.empty()) 9865de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek popLocation(); 9875de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek PrevLoc = PathDiagnosticLocation(); 9885de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 9895de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 9903ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose void addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd = false, 9913ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump = false); 9921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9938bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek void rawAddEdge(PathDiagnosticLocation NewLoc); 9941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void addContext(const Stmt *S); 996183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose void addContext(const PathDiagnosticLocation &L); 997e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek void addExtendedContext(const Stmt *S); 9981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 99914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} // end anonymous namespace 100014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 100114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 100214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekPathDiagnosticLocation 100314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekEdgeBuilder::getContextLocation(const PathDiagnosticLocation &L) { 100414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = L.asStmt()) { 100514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (IsControlFlowExpr(S)) 100614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 10071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return PDB.getEnclosingStmtLocation(S); 100914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 101114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 101214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 101314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 101414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekbool EdgeBuilder::containsLocation(const PathDiagnosticLocation &Container, 101514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee) { 101614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 101714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container == Containee) 101814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container.asDecl()) 102114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = Containee.asStmt()) 102414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *ContainerS = Container.asStmt()) { 102514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (S) { 102614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (S == ContainerS) 102714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 102814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek S = PDB.getParent(S); 102914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 103014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return false; 103114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 103214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 103314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Less accurate: compare using source ranges. 103414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContainerR = Container.asRange(); 103514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContaineeR = Containee.asRange(); 10361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceManager &SM = PDB.getSourceManager(); 1038402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerRBeg = SM.getExpansionLoc(ContainerR.getBegin()); 1039402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerREnd = SM.getExpansionLoc(ContainerR.getEnd()); 1040402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeRBeg = SM.getExpansionLoc(ContaineeR.getBegin()); 1041402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeREnd = SM.getExpansionLoc(ContaineeR.getEnd()); 10421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1043642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerBegLine = SM.getExpansionLineNumber(ContainerRBeg); 1044642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerEndLine = SM.getExpansionLineNumber(ContainerREnd); 1045642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeBegLine = SM.getExpansionLineNumber(ContaineeRBeg); 1046642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeEndLine = SM.getExpansionLineNumber(ContaineeREnd); 10471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 104814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek assert(ContainerBegLine <= ContainerEndLine); 10491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ContaineeBegLine <= ContaineeEndLine); 10501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return (ContainerBegLine <= ContaineeBegLine && 105214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ContainerEndLine >= ContaineeEndLine && 105314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerBegLine != ContaineeBegLine || 1054a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerRBeg) <= 1055a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContaineeRBeg)) && 105614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerEndLine != ContaineeEndLine || 1057a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerREnd) >= 10586488dc31153be6f98b404c7860be6c66bb4ec917Ted Kremenek SM.getExpansionColumnNumber(ContaineeREnd))); 105914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 106014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 106114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::rawAddEdge(PathDiagnosticLocation NewLoc) { 106214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!PrevLoc.isValid()) { 106314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PrevLoc = NewLoc; 106414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 106514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1067e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &NewLocClean = cleanUpLocation(NewLoc, PDB.LC); 1068e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &PrevLocClean = cleanUpLocation(PrevLoc, PDB.LC); 10691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1070a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (PrevLocClean.asLocation().isInvalid()) { 1071a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek PrevLoc = NewLoc; 1072a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek return; 1073a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek } 1074a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 10758c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek if (NewLocClean.asLocation() == PrevLocClean.asLocation()) 107614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // FIXME: Ignore intra-macro edges for now. 1079402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth if (NewLocClean.asLocation().getExpansionLoc() == 1080402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth PrevLocClean.asLocation().getExpansionLoc()) 108114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 108214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10832042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece(NewLocClean, PrevLocClean)); 10848c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek PrevLoc = NewLoc; 108514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 108614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10873ea09a802f973c2726b2a489ae08a4bded93410bJordan Rosevoid EdgeBuilder::addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd, 10883ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump) { 10891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1090a301a6773db085575ac51e3c966858180390c25bTed Kremenek if (!alwaysAdd && NewLoc.asLocation().isMacroID()) 1091a301a6773db085575ac51e3c966858180390c25bTed Kremenek return; 10921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &CLoc = getContextLocation(NewLoc); 109414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 109514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 10968f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation &TopContextLoc = CLocs.back(); 10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 109914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == CLoc) { 11008f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 11013ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(TopContextLoc)) 11023ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 11038f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek 110414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 11058f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 110614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11073ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsPostJump) 11083ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 110914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 111014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 111114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 111214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, CLoc)) { 11138f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 111414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 11151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11163ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(CLoc)) { 11173ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/true)); 11188f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return; 11198f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11208f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11223ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/IsPostJump)); 11231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 112414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 112514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 112614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 112714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 112814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 11291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11305c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // If we reach here, there is no enclosing context. Just add the edge. 11315c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek rawAddEdge(NewLoc); 113214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 113314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11348f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekbool EdgeBuilder::IsConsumedExpr(const PathDiagnosticLocation &L) { 11358f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (const Expr *X = dyn_cast_or_null<Expr>(L.asStmt())) 11368f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return PDB.getParentMap().isConsumedExpr(X) && !IsControlFlowExpr(X); 11371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11388f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return false; 11398f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek} 11401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1141e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenekvoid EdgeBuilder::addExtendedContext(const Stmt *S) { 1142e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (!S) 1143e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek return; 11441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Stmt *Parent = PDB.getParent(S); 1146e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek while (Parent) { 1147e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (isa<CompoundStmt>(Parent)) 1148e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek Parent = PDB.getParent(Parent); 1149e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek else 1150e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1151e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1152e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek 1153e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (Parent) { 1154e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek switch (Parent->getStmtClass()) { 1155e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::DoStmtClass: 1156e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::ObjCAtSynchronizedStmtClass: 1157e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(Parent); 1158e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek default: 1159e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1160e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1161e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 11621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1163e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(S); 1164e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek} 11651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 116614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::addContext(const Stmt *S) { 116714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!S) 116814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 116914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 117059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(S, PDB.getSourceManager(), PDB.LC); 1171183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose addContext(L); 1172183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose} 11731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1174183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rosevoid EdgeBuilder::addContext(const PathDiagnosticLocation &L) { 117514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 117614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &TopContextLoc = CLocs.back(); 117714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 117814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 117914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == L) 118014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 118114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 118214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, L)) { 118314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 11841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 118514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 118614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 118714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 118814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 118914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 119014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 119114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 119214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 119314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 119411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// Cone-of-influence: support the reverse propagation of "interesting" symbols 119511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// and values by tracing interesting calculations backwards through evaluated 119611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions along a path. This is probably overly complicated, but the idea 119711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is that if an expression computed an "interesting" value, the child 119811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions are are also likely to be "interesting" as well (which then 119911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// propagates to the values they in turn compute). This reverse propagation 120011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is needed to track interesting correlations across function call boundaries, 120111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// where formal arguments bind to actual arguments, etc. This is also needed 120211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// because the constraint solver sometimes simplifies certain symbolic values 120311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// into constants when appropriate, and this complicates reasoning about 120411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// interesting values. 120511abcecc8c919673237cf37384290a1ef1943976Ted Kremenektypedef llvm::DenseSet<const Expr *> InterestingExprs; 120611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 120711abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateIntererstingSymbols(BugReport &R, 120811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 120911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 121011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Expr *Ex, 121111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *LCtx) { 121211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal V = State->getSVal(Ex, LCtx); 121311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!(R.isInteresting(V) || IE.count(Ex))) 121411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek return; 121511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 121611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek switch (Ex->getStmtClass()) { 121711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek default: 121811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!isa<CastExpr>(Ex)) 121911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 122011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Fall through. 122111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::BinaryOperatorClass: 122211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::UnaryOperatorClass: { 122311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (Stmt::const_child_iterator CI = Ex->child_begin(), 122411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CE = Ex->child_end(); 122511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CI != CE; ++CI) { 122611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *child = dyn_cast_or_null<Expr>(*CI)) { 122711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(child); 122811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal ChildV = State->getSVal(child, LCtx); 122911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(ChildV); 123011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 123211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 123611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(V); 123711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 123811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 123911abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateInterestingSymbols(BugReport &R, 124011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 124111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 124211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx, 124311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx) 124411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek{ 1245852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: Handle non-CallExpr-based CallEvents. 124611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const StackFrameContext *Callee = CalleeCtx->getCurrentStackFrame(); 124711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Stmt *CallSite = Callee->getCallSite(); 1248852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CallExpr *CE = dyn_cast_or_null<CallExpr>(CallSite)) { 124911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeCtx->getDecl())) { 125011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek FunctionDecl::param_const_iterator PI = FD->param_begin(), 125111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek PE = FD->param_end(); 125211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CallExpr::const_arg_iterator AI = CE->arg_begin(), AE = CE->arg_end(); 125311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (; AI != AE && PI != PE; ++AI, ++PI) { 125411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *ArgE = *AI) { 125511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const ParmVarDecl *PD = *PI) { 125611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek Loc LV = State->getLValue(PD, CalleeCtx); 125711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (R.isInteresting(LV) || R.isInteresting(State->getRawSVal(LV))) 125811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(ArgE); 125911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 12658185674528423e2504a1fae35c28c24104846510Ted Kremenek 1266b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1267b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Functions for determining if a loop was executed 0 times. 1268b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1269b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1270b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoop(const Stmt *Term) { 12718185674528423e2504a1fae35c28c24104846510Ted Kremenek switch (Term->getStmtClass()) { 12728185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::ForStmtClass: 12738185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::WhileStmtClass: 1274c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 127549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: 1276b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return true; 12778185674528423e2504a1fae35c28c24104846510Ted Kremenek default: 12788185674528423e2504a1fae35c28c24104846510Ted Kremenek // Note that we intentionally do not include do..while here. 12798185674528423e2504a1fae35c28c24104846510Ted Kremenek return false; 12808185674528423e2504a1fae35c28c24104846510Ted Kremenek } 1281b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 12828185674528423e2504a1fae35c28c24104846510Ted Kremenek 1283b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isJumpToFalseBranch(const BlockEdge *BE) { 12848185674528423e2504a1fae35c28c24104846510Ted Kremenek const CFGBlock *Src = BE->getSrc(); 12858185674528423e2504a1fae35c28c24104846510Ted Kremenek assert(Src->succ_size() == 2); 12868185674528423e2504a1fae35c28c24104846510Ted Kremenek return (*(Src->succ_begin()+1) == BE->getDst()); 12878185674528423e2504a1fae35c28c24104846510Ted Kremenek} 12888185674528423e2504a1fae35c28c24104846510Ted Kremenek 1289b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// Return true if the terminator is a loop and the destination is the 1290b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// false branch. 1291b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoopJumpPastBody(const Stmt *Term, const BlockEdge *BE) { 1292b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!isLoop(Term)) 1293b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return false; 1294b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1295b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek // Did we take the false branch? 1296b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return isJumpToFalseBranch(BE); 1297b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 1298b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1299b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isContainedByStmt(ParentMap &PM, const Stmt *S, const Stmt *SubS) { 1300b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (SubS) { 1301b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SubS == S) 1302b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1303b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek SubS = PM.getParent(SubS); 1304b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1305b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1306b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1307b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1308b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic const Stmt *getStmtBeforeCond(ParentMap &PM, const Stmt *Term, 1309b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ExplodedNode *N) { 1310b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (N) { 1311b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Optional<StmtPoint> SP = N->getLocation().getAs<StmtPoint>(); 1312b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SP) { 1313b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *S = SP->getStmt(); 1314b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (!isContainedByStmt(PM, Term, S)) 1315b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return S; 1316b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 13170f8579274a010f360a371b53101859d9d6052314Anna Zaks N = N->getFirstPred(); 1318b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1319b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return 0; 1320b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1321b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1322b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isInLoopBody(ParentMap &PM, const Stmt *S, const Stmt *Term) { 1323b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *LoopBody = 0; 1324b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek switch (Term->getStmtClass()) { 132549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: { 132649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose const CXXForRangeStmt *FR = cast<CXXForRangeStmt>(Term); 132749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (isContainedByStmt(PM, FR->getInc(), S)) 132849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return true; 132949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (isContainedByStmt(PM, FR->getLoopVarStmt(), S)) 133049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return true; 133149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose LoopBody = FR->getBody(); 133249a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose break; 133349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose } 1334b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::ForStmtClass: { 1335b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ForStmt *FS = cast<ForStmt>(Term); 1336b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (isContainedByStmt(PM, FS->getInc(), S)) 1337b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1338b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = FS->getBody(); 1339b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1340b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1341c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: { 1342c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek const ObjCForCollectionStmt *FC = cast<ObjCForCollectionStmt>(Term); 1343c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek LoopBody = FC->getBody(); 1344c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek break; 1345c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek } 1346b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::WhileStmtClass: 1347b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = cast<WhileStmt>(Term)->getBody(); 1348b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1349b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek default: 1350b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1351b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1352b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return isContainedByStmt(PM, LoopBody, S); 1353b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1354b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1355b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1356b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Top-level logic for generating extensive path diagnostics. 1357b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1358b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 13598347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosestatic bool GenerateExtensivePathDiagnostic(PathDiagnostic& PD, 136014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB, 13613bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose const ExplodedNode *N, 1362d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM, 13633bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ArrayRef<BugReporterVisitor *> visitors) { 136414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder EB(PD, PDB); 13650cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks const SourceManager& SM = PDB.getSourceManager(); 136656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 136711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs IE; 136814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 13699c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() ? NULL : *(N->pred_begin()); 137014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (NextNode) { 137114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek N = NextNode; 13720f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 137314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ProgramPoint P = N->getLocation(); 137414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1375dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek do { 13767a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 137711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 137811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 137911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getState().getPtr(), Ex, 138011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getLocationContext()); 138111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 138211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 13837a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1384183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Stmt *S = CE->getCalleeContext()->getCallSite(); 1385183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1386852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1387852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getState().getPtr(), Ex, 1388852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getLocationContext()); 1389852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 1390183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1391183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C = 1392183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece::construct(N, *CE, SM); 1393bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1394183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 13953ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose EB.addEdge(C->callReturn, /*AlwaysAdd=*/true, /*IsPostJump=*/true); 1396183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.flushLocations(); 1397183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1398183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.getActivePath().push_front(C); 1399183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.pushActivePath(&C->path); 1400183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose CallStack.push_back(StackDiagPair(C, N)); 14015de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek break; 14025de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 14034ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek 14042042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // Pop the call hierarchy if we are done walking the contents 14052042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // of a function call. 14067a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1407097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Add an edge to the start of the function. 1408097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek const Decl *D = CE->getCalleeContext()->getDecl(); 1409097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation pos = 1410097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation::createBegin(D, SM); 1411097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek EB.addEdge(pos); 1412097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1413097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Flush all locations, and pop the active path. 1414183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose bool VisitedEntireCall = PD.isWithinCall(); 14154ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek EB.flushLocations(); 14162042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.popActivePath(); 14174ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 1418097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1419183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // Either we just added a bunch of stuff to the top-level path, or 1420183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // we have a previous CallExitEnd. If the former, it means that the 14212042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // path terminated within a function call. We must then take the 14222042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // current contents of the active path and place it within 14232042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // a new PathDiagnosticCallPiece. 1424183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C; 1425183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (VisitedEntireCall) { 1426183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 1427183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose } else { 1428183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Decl *Caller = CE->getLocationContext()->getDecl(); 14299373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1430bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 14319373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 1432852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose 1433183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C->setCallee(*CE, SM); 1434183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.addContext(C->getLocation()); 1435368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 1436368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (!CallStack.empty()) { 143756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks assert(CallStack.back().first == C); 1438368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks CallStack.pop_back(); 1439368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 14402042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek break; 14412042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek } 14424ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek 14434ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // Note that is important that we update the LocationContext 14444ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // after looking at CallExits. CallExit basically adds an 14454ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // edge in the *caller*, so we don't want to update the LocationContext 14464ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // too soon. 14474ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 14485de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1449dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Block edges. 14507a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 145111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Does this represent entering a call? If so, look at propagating 145211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // interesting symbols across call boundaries. 145311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (NextNode) { 145411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 145511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 145611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (CallerCtx != CalleeCtx) { 145711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 145811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getState().getPtr(), 145911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CalleeCtx, CallerCtx); 146011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 146111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 146211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 1463dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1464f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 146559950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 1466ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const CompoundStmt *CS = NULL; 14671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1468f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1469f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(FS->getBody()); 1470f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1471f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(WS->getBody()); 14721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1473dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek PathDiagnosticEventPiece *p = 1474dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek new PathDiagnosticEventPiece(L, 147507c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek "Looping back to the head of the loop"); 14762dd17abf11ae64339fa6bfaa57d76e13a5fbe5b8Ted Kremenek p->setPrunable(true); 14771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1478dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek EB.addEdge(p->getLocation(), true); 14792042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 14801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1481ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (CS) { 14820cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation BL = 14830cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation::createEndBrace(CS, SM); 148407c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek EB.addEdge(BL); 1485dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 14868bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 14878185674528423e2504a1fae35c28c24104846510Ted Kremenek 1488b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1489b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1490b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1491b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 14928185674528423e2504a1fae35c28c24104846510Ted Kremenek // Are we jumping past the loop body without ever executing the 14938185674528423e2504a1fae35c28c24104846510Ted Kremenek // loop (because the condition was false)? 14947a95de68c093991047ed8d339479ccad51b88663David Blaikie if (isLoopJumpPastBody(Term, &*BE) && 1495b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek !isInLoopBody(PM, 1496b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek getStmtBeforeCond(PM, 1497b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek BSrc->getTerminatorCondition(), 1498b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek N), 1499b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Term)) { 15008185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 15018185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticEventPiece *PE = 1502b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek new PathDiagnosticEventPiece(L, "Loop body executed 0 times"); 15038185674528423e2504a1fae35c28c24104846510Ted Kremenek PE->setPrunable(true); 15048185674528423e2504a1fae35c28c24104846510Ted Kremenek 15058185674528423e2504a1fae35c28c24104846510Ted Kremenek EB.addEdge(PE->getLocation(), true); 15068185674528423e2504a1fae35c28c24104846510Ted Kremenek PD.getActivePath().push_front(PE); 15078185674528423e2504a1fae35c28c24104846510Ted Kremenek } 15088185674528423e2504a1fae35c28c24104846510Ted Kremenek 1509b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // In any case, add the terminator as the current statement 1510b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // context for control edges. 1511ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek EB.addContext(Term); 15128185674528423e2504a1fae35c28c24104846510Ted Kremenek } 15131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1514dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 15158bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 151614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 15177a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = P.getAs<BlockEntrance>()) { 1518b07805485c603be3d8011f72611465324c9e664bDavid Blaikie Optional<CFGElement> First = BE->getFirstElement(); 1519b07805485c603be3d8011f72611465324c9e664bDavid Blaikie if (Optional<CFGStmt> S = First ? First->getAs<CFGStmt>() : None) { 1520b07805485c603be3d8011f72611465324c9e664bDavid Blaikie const Stmt *stmt = S->getStmt(); 15213c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek if (IsControlFlowExpr(stmt)) { 1522b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu // Add the proper context for '&&', '||', and '?'. 15233c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addContext(stmt); 1524b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 1525b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu else 15263c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addExtendedContext(PDB.getEnclosingStmtLocation(stmt).asStmt()); 1527dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 1528b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1529dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 1530dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 15315de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 15325de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1533dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } while (0); 15341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1535dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (!NextNode) 153614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek continue; 15371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15388e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add pieces from custom visitors. 15398e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 15403bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 15413bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose E = visitors.end(); 15423bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose I != E; ++I) { 15438e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 15448966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek const PathDiagnosticLocation &Loc = p->getLocation(); 15458966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek EB.addEdge(Loc, true); 15462042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 1547368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 1548368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 15498966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek if (const Stmt *S = Loc.asStmt()) 15501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump EB.addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 15518966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 15521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 155314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 15548347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 15558347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return PDB.getBugReport()->isValid(); 155614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 155714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1558af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek/// \brief Adds a sanitized control-flow diagnostic edge to a path. 1559af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic void addEdgeToPath(PathPieces &path, 1560af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation &PrevLoc, 1561af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation NewLoc, 1562af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *LC) { 1563bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!NewLoc.isValid()) 1564af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1565af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1566bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek SourceLocation NewLocL = NewLoc.asLocation(); 1567a3f5a5afefca7653349a88472d5ce01ba7226e27Anna Zaks if (NewLocL.isInvalid()) 1568af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1569af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1570904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose if (!PrevLoc.isValid() || !PrevLoc.asLocation().isValid()) { 1571af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1572af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1573af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1574af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1575574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // Ignore self-edges, which occur when there are multiple nodes at the same 1576574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // statement. 1577574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose if (NewLoc.asStmt() && NewLoc.asStmt() == PrevLoc.asStmt()) 1578af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1579af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1580bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.push_front(new PathDiagnosticControlFlowPiece(NewLoc, 1581bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PrevLoc)); 1582af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1583af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1584af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1585e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// A customized wrapper for CFGBlock::getTerminatorCondition() 1586e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// which returns the element for ObjCForCollectionStmts. 1587e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenekstatic const Stmt *getTerminatorCondition(const CFGBlock *B) { 1588e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *S = B->getTerminatorCondition(); 1589e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (const ObjCForCollectionStmt *FS = 1590e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(S)) 1591e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return FS->getElement(); 1592e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return S; 1593e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek} 1594e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 15950a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topperstatic const char StrEnteringLoop[] = "Entering loop body"; 15960a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topperstatic const char StrLoopBodyZero[] = "Loop body executed 0 times"; 1597f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek 1598af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic bool 1599af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted KremenekGenerateAlternateExtensivePathDiagnostic(PathDiagnostic& PD, 1600af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticBuilder &PDB, 1601af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *N, 1602af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek LocationContextMap &LCM, 1603af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ArrayRef<BugReporterVisitor *> visitors) { 1604af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1605af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek BugReport *report = PDB.getBugReport(); 1606af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const SourceManager& SM = PDB.getSourceManager(); 1607af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek StackDiagVector CallStack; 1608af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek InterestingExprs IE; 1609af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 16105a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PathDiagnosticLocation PrevLoc = PD.getLocation(); 1611af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1612af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *NextNode = N->getFirstPred(); 1613af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek while (NextNode) { 1614af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N = NextNode; 1615af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek NextNode = N->getFirstPred(); 1616af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ProgramPoint P = N->getLocation(); 1617af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1618af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek do { 1619be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Have we encountered an entrance to a call? It may be 1620be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the case that we have not encountered a matching 1621be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // call exit before this point. This means that the path 1622be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // terminated within the call itself. 1623be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1624904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose // Add an edge to the start of the function. 1625904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose const StackFrameContext *CalleeLC = CE->getCalleeContext(); 1626904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose const Decl *D = CalleeLC->getDecl(); 1627904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose addEdgeToPath(PD.getActivePath(), PrevLoc, 1628904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose PathDiagnosticLocation::createBegin(D, SM), 1629904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose CalleeLC); 1630904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose 1631be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Did we visit an entire call? 1632be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek bool VisitedEntireCall = PD.isWithinCall(); 1633be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.popActivePath(); 1634be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1635be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticCallPiece *C; 1636be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (VisitedEntireCall) { 1637be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticPiece *P = PD.getActivePath().front().getPtr(); 1638be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = cast<PathDiagnosticCallPiece>(P); 1639be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } else { 1640be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const Decl *Caller = CE->getLocationContext()->getDecl(); 1641be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1642be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1643be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Since we just transferred the path over to the call piece, 1644be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // reset the mapping from active to location context. 1645be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(PD.getActivePath().size() == 1 && 1646be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().front() == C); 1647be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = 0; 1648be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1649be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the location context mapping for the path within 1650be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the call. 1651be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(LCM[&C->path] == 0 || 1652be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] == CE->getCalleeContext()); 1653be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1654be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1655be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // If this is the first item in the active path, record 1656be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the new mapping from active path to location context. 1657be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const LocationContext *&NewLC = LCM[&PD.getActivePath()]; 16585a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose if (!NewLC) 1659be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek NewLC = N->getLocationContext(); 1660be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16615a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PDB.LC = NewLC; 1662be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1663be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C->setCallee(*CE, SM); 1664be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16655a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose // Update the previous location in the active path. 16665a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc = C->getLocation(); 16675a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose 1668be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (!CallStack.empty()) { 1669be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(CallStack.back().first == C); 1670be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek CallStack.pop_back(); 1671be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1672af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1673af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1674af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1675be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Query the location context here and the previous location 1676be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // as processing CallEnter may change the active path. 1677be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PDB.LC = N->getLocationContext(); 1678be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1679be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the mapping from the active path to the location 1680be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // context. 1681be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(!LCM[&PD.getActivePath()] || 1682be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] == PDB.LC); 1683be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = PDB.LC; 1684be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1685af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Have we encountered an exit from a function call? 1686af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1687af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const Stmt *S = CE->getCalleeContext()->getCallSite(); 1688af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Propagate the interesting symbols accordingly. 1689af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1690af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1691af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getState().getPtr(), Ex, 1692af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getLocationContext()); 1693af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1694af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1695af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // We are descending into a call (backwards). Construct 1696af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // a new call piece to contain the path pieces for that call. 1697af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece *C = 1698af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece::construct(N, *CE, SM); 1699af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1700af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Record the location context for this call piece. 1701bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1702af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1703af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add the edge to the return site. 1704be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, C->callReturn, PDB.LC); 1705be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().push_front(C); 17065a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc.invalidate(); 1707af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1708af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Make the contents of the call the active path for now. 1709af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PD.pushActivePath(&C->path); 1710af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CallStack.push_back(StackDiagPair(C, N)); 1711af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1712af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1713af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1714be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 1715be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // For expressions, make sure we propagate the 1716be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // interesting symbols correctly. 1717be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 1718be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1719be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getState().getPtr(), Ex, 1720be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getLocationContext()); 1721af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1722e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Add an edge. If this is an ObjCForCollectionStmt do 1723e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // not add an edge here as it appears in the CFG both 1724e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // as a terminator and as a terminator condition. 1725e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (!isa<ObjCForCollectionStmt>(PS->getStmt())) { 1726e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation L = 1727e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation(PS->getStmt(), SM, PDB.LC); 1728e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1729e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 1730af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1731af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1732af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1733af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Block edges. 1734af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 1735af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Does this represent entering a call? If so, look at propagating 1736af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // interesting symbols across call boundaries. 1737af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (NextNode) { 1738af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 1739af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 1740af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (CallerCtx != CalleeCtx) { 1741af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1742af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getState().getPtr(), 1743af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CalleeCtx, CallerCtx); 1744af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1745af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1746af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1747af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1748af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 1749af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 175049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose const Stmt *Body = NULL; 1751afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 1752afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 175349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = FS->getBody(); 1754afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 175549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = WS->getBody(); 1756e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek else if (const ObjCForCollectionStmt *OFS = 175749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose dyn_cast<ObjCForCollectionStmt>(Loop)) { 175849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = OFS->getBody(); 175949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose } else if (const CXXForRangeStmt *FRS = 176049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose dyn_cast<CXXForRangeStmt>(Loop)) { 176149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = FRS->getBody(); 1762e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 176349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose // do-while statements are explicitly excluded here 1764af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1765af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticEventPiece *p = 1766af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek new PathDiagnosticEventPiece(L, "Looping back to the head " 1767af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek "of the loop"); 1768af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek p->setPrunable(true); 1769af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1770be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1771cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1772afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 177349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (const CompoundStmt *CS = dyn_cast_or_null<CompoundStmt>(Body)) { 1774afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1775afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PathDiagnosticLocation::createEndBrace(CS, SM), 1776afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PDB.LC); 1777afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek } 1778af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1779b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1780af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1781af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1782af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1783af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 1784af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping past the loop body without ever executing the 1785af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // loop (because the condition was false)? 1786b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isLoop(Term)) { 1787e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *TermCond = getTerminatorCondition(BSrc); 1788b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek bool IsInLoopBody = 1789b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek isInLoopBody(PM, getStmtBeforeCond(PM, TermCond, N), Term); 1790b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1791b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek const char *str = 0; 1792b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1793b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isJumpToFalseBranch(&*BE)) { 1794b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!IsInLoopBody) { 1795f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek str = StrLoopBodyZero; 1796b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 17970a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topper } else { 1798f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek str = StrEnteringLoop; 1799b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1800b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1801b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (str) { 18023e8a85fcfc3d264e4c5b21fbdd741bbc0c24a266Jordan Rose PathDiagnosticLocation L(TermCond ? TermCond : Term, SM, PDB.LC); 1803b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PathDiagnosticEventPiece *PE = 1804b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek new PathDiagnosticEventPiece(L, str); 1805b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PE->setPrunable(true); 1806b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1807be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PE->getLocation(), PDB.LC); 1808b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PD.getActivePath().push_front(PE); 1809b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 18100a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topper } else if (isa<BreakStmt>(Term) || isa<ContinueStmt>(Term) || 18110a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topper isa<GotoStmt>(Term)) { 1812bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 1813be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1814bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek } 1815af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1816af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1817af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1818af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } while (0); 1819af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1820af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (!NextNode) 1821af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek continue; 1822af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1823af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add pieces from custom visitors. 1824af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 1825af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek E = visitors.end(); 1826af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek I != E; ++I) { 1827cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *report)) { 1828be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1829cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1830af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek updateStackPiecesWithMessage(p, CallStack); 1831af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1832af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1833af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1834af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 183501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // Add an edge to the start of the function. 183601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // We'll prune it out later, but it helps make diagnostics more uniform. 183701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const StackFrameContext *CalleeLC = PDB.LC->getCurrentStackFrame(); 183801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const Decl *D = CalleeLC->getDecl(); 183901f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose addEdgeToPath(PD.getActivePath(), PrevLoc, 184001f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose PathDiagnosticLocation::createBegin(D, SM), 184101f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose CalleeLC); 184201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 1843af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return report->isValid(); 1844af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1845af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1846b1a4d37c0549501fe12907bc6ffa81bc5d04b98aBenjamin Kramerstatic const Stmt *getLocStmt(PathDiagnosticLocation L) { 1847bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!L.isValid()) 1848bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return 0; 1849f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek return L.asStmt(); 1850f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek} 1851f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 185296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic const Stmt *getStmtParent(const Stmt *S, const ParentMap &PM) { 1853bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!S) 1854bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return 0; 1855a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1856a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek while (true) { 1857a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek S = PM.getParentIgnoreParens(S); 1858a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1859a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (!S) 1860a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1861a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1862a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek if (isa<ExprWithCleanups>(S) || 1863a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<CXXBindTemporaryExpr>(S) || 1864a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<SubstNonTypeTemplateParmExpr>(S)) 1865a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek continue; 1866a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1867a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1868a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek } 1869a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1870a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek return S; 1871bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 1872bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 187315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool isConditionForTerminator(const Stmt *S, const Stmt *Cond) { 187415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek switch (S->getStmtClass()) { 187503194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek case Stmt::BinaryOperatorClass: { 187603194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek const BinaryOperator *BO = cast<BinaryOperator>(S); 187703194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek if (!BO->isLogicalOp()) 187803194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return false; 187903194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return BO->getLHS() == Cond || BO->getRHS() == Cond; 188003194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek } 1881a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek case Stmt::IfStmtClass: 1882a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek return cast<IfStmt>(S)->getCond() == Cond; 188315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ForStmtClass: 188415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ForStmt>(S)->getCond() == Cond; 188515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::WhileStmtClass: 188615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<WhileStmt>(S)->getCond() == Cond; 188715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::DoStmtClass: 188815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<DoStmt>(S)->getCond() == Cond; 188915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ChooseExprClass: 189015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ChooseExpr>(S)->getCond() == Cond; 189115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::IndirectGotoStmtClass: 189215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<IndirectGotoStmt>(S)->getTarget() == Cond; 189315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::SwitchStmtClass: 189415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<SwitchStmt>(S)->getCond() == Cond; 189515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::BinaryConditionalOperatorClass: 189615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<BinaryConditionalOperator>(S)->getCond() == Cond; 18978484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek case Stmt::ConditionalOperatorClass: { 18988484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek const ConditionalOperator *CO = cast<ConditionalOperator>(S); 18998484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek return CO->getCond() == Cond || 19008484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getLHS() == Cond || 19018484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getRHS() == Cond; 19028484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek } 190315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ObjCForCollectionStmtClass: 190415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ObjCForCollectionStmt>(S)->getElement() == Cond; 190549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: { 190649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose const CXXForRangeStmt *FRS = cast<CXXForRangeStmt>(S); 190749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return FRS->getCond() == Cond || FRS->getRangeInit() == Cond; 190849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose } 190915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek default: 191015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return false; 191115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 191215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek} 191315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 191496b8134337883908fcc45484486fe200d6b3e32fTed Kremenekstatic bool isIncrementOrInitInForLoop(const Stmt *S, const Stmt *FL) { 191549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (const ForStmt *FS = dyn_cast<ForStmt>(FL)) 191649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return FS->getInc() == S || FS->getInit() == S; 191749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (const CXXForRangeStmt *FRS = dyn_cast<CXXForRangeStmt>(FL)) 191849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return FRS->getInc() == S || FRS->getRangeStmt() == S || 191949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose FRS->getLoopVarStmt() || FRS->getRangeInit() == S; 192049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return false; 1921e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek} 1922e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek 192315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenektypedef llvm::DenseSet<const PathDiagnosticCallPiece *> 192415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet; 192515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 192696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// Adds synthetic edges from top-level statements to their subexpressions. 192796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 192896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// This avoids a "swoosh" effect, where an edge from a top-level statement A 192996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// points to a sub-expression B.1 that's not at the start of B. In these cases, 193096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// we'd like to see an edge from A to B, then another one from B to B.1. 193196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic void addContextEdges(PathPieces &pieces, SourceManager &SM, 193296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const ParentMap &PM, const LocationContext *LCtx) { 193396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathPieces::iterator Prev = pieces.end(); 193496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose for (PathPieces::iterator I = pieces.begin(), E = Prev; I != E; 193596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Prev = I, ++I) { 193696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *Piece = 193796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 193896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 193996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!Piece) 194096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 194196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 194296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation SrcLoc = Piece->getStartLocation(); 19439d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose SmallVector<PathDiagnosticLocation, 4> SrcContexts; 19449d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose 194549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose PathDiagnosticLocation NextSrcContext = SrcLoc; 194649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose const Stmt *InnerStmt = 0; 19479d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose while (NextSrcContext.isValid() && NextSrcContext.asStmt() != InnerStmt) { 19489d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose SrcContexts.push_back(NextSrcContext); 19499d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose InnerStmt = NextSrcContext.asStmt(); 195049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose NextSrcContext = getEnclosingStmtLocation(InnerStmt, SM, PM, LCtx, 195149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose /*allowNested=*/true); 19529d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose } 195396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 195496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Repeatedly split the edge as necessary. 195596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // This is important for nested logical expressions (||, &&, ?:) where we 195696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // want to show all the levels of context. 195796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (true) { 195896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *Dst = getLocStmt(Piece->getEndLocation()); 195996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 196096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We are looking at an edge. Is the destination within a larger 196196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // expression? 196296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation DstContext = 19639d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose getEnclosingStmtLocation(Dst, SM, PM, LCtx, /*allowNested=*/true); 196496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!DstContext.isValid() || DstContext.asStmt() == Dst) 196596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 196696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 196796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // If the source is in the same context, we're already good. 19689d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose if (std::find(SrcContexts.begin(), SrcContexts.end(), DstContext) != 19699d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose SrcContexts.end()) 197096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 197196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 197296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Update the subexpression node to point to the context edge. 197396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Piece->setStartLocation(DstContext); 197496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 197596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Try to extend the previous edge if it's at the same level as the source 197696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // context. 197796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (Prev != E) { 197896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PrevPiece = 197996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*Prev); 198096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 198196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (PrevPiece) { 198296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (const Stmt *PrevSrc = getLocStmt(PrevPiece->getStartLocation())) { 198396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *PrevSrcParent = getStmtParent(PrevSrc, PM); 198496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (PrevSrcParent == getStmtParent(getLocStmt(DstContext), PM)) { 198596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PrevPiece->setEndLocation(DstContext); 198696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 198796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 198896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 198996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 199296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Otherwise, split the current edge into a context edge and a 199396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // subexpression edge. Note that the context statement may itself have 199496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // context. 199596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Piece = new PathDiagnosticControlFlowPiece(SrcLoc, DstContext); 199696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose I = pieces.insert(I, Piece); 199796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 200096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 200196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// \brief Move edges from a branch condition to a branch target 200296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// when the condition is simple. 200396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 200496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// This restructures some of the work of addContextEdges. That function 200596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// creates edges this may destroy, but they work together to create a more 200696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// aesthetically set of edges around branches. After the call to 200796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// addContextEdges, we may have (1) an edge to the branch, (2) an edge from 200896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// the branch to the branch condition, and (3) an edge from the branch 200996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// condition to the branch target. We keep (1), but may wish to remove (2) 201096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// and move the source of (3) to the branch if the branch condition is simple. 201196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 201296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic void simplifySimpleBranches(PathPieces &pieces) { 201396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose for (PathPieces::iterator I = pieces.begin(), E = pieces.end(); I != E; ++I) { 201496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 201596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PieceI = 201696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 201796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 201896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!PieceI) 201996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 202096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 202296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 202396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!s1Start || !s1End) 202596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 202696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathPieces::iterator NextI = I; ++NextI; 202896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (NextI == E) 202996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 203096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PieceNextI = 0; 203296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (true) { 203496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (NextI == E) 203596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 203696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticEventPiece *EV = dyn_cast<PathDiagnosticEventPiece>(*NextI); 203896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (EV) { 203996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose StringRef S = EV->getString(); 204096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (S == StrEnteringLoop || S == StrLoopBodyZero) { 204196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose ++NextI; 204296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 204396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 204496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 204596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 204696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 204796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PieceNextI = dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 204896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 204996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 205096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!PieceNextI) 205296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 205396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 205596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 205696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!s2Start || !s2End || s1End != s2Start) 205896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 205996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We only perform this transformation for specific branch kinds. 206196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We don't want to do this for do..while, for example. 206296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!(isa<ForStmt>(s1Start) || isa<WhileStmt>(s1Start) || 206349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose isa<IfStmt>(s1Start) || isa<ObjCForCollectionStmt>(s1Start) || 206449a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose isa<CXXForRangeStmt>(s1Start))) 206596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 206696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Is s1End the branch condition? 206896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!isConditionForTerminator(s1Start, s1End)) 206996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 207096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 207196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Perform the hoisting by eliminating (2) and changing the start 207296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // location of (3). 207396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PieceNextI->setStartLocation(PieceI->getStartLocation()); 207496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose I = pieces.erase(I); 207596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 207696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 207796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 2078e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose/// Returns the number of bytes in the given (character-based) SourceRange. 207922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 208022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// If the locations in the range are not on the same line, returns None. 208122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 208222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// Note that this does not do a precise user-visible character or column count. 208322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rosestatic Optional<size_t> getLengthOnSingleLine(SourceManager &SM, 208422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceRange Range) { 208522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceRange ExpansionRange(SM.getExpansionLoc(Range.getBegin()), 208622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SM.getExpansionRange(Range.getEnd()).second); 208722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 208822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose FileID FID = SM.getFileID(ExpansionRange.getBegin()); 208922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (FID != SM.getFileID(ExpansionRange.getEnd())) 209022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return None; 209122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 209222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose bool Invalid; 209322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const llvm::MemoryBuffer *Buffer = SM.getBuffer(FID, &Invalid); 209422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (Invalid) 209522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return None; 209622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 209722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose unsigned BeginOffset = SM.getFileOffset(ExpansionRange.getBegin()); 209822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose unsigned EndOffset = SM.getFileOffset(ExpansionRange.getEnd()); 209922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose StringRef Snippet = Buffer->getBuffer().slice(BeginOffset, EndOffset); 210022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 210122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // We're searching the raw bytes of the buffer here, which might include 210222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // escaped newlines and such. That's okay; we're trying to decide whether the 210322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // SourceRange is covering a large or small amount of space in the user's 210422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // editor. 210522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (Snippet.find_first_of("\r\n") != StringRef::npos) 210622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return None; 210722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 210822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // This isn't Unicode-aware, but it doesn't need to be. 210922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return Snippet.size(); 211022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose} 211122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 211222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// \sa getLengthOnSingleLine(SourceManager, SourceRange) 211322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rosestatic Optional<size_t> getLengthOnSingleLine(SourceManager &SM, 211422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const Stmt *S) { 211522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return getLengthOnSingleLine(SM, S->getSourceRange()); 211622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose} 211722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 211822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// Eliminate two-edge cycles created by addContextEdges(). 211922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 212022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// Once all the context edges are in place, there are plenty of cases where 212122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// there's a single edge from a top-level statement to a subexpression, 212222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// followed by a single path note, and then a reverse edge to get back out to 212322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// the top level. If the statement is simple enough, the subexpression edges 212422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// just add noise and make it harder to understand what's going on. 212522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 212622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// This function only removes edges in pairs, because removing only one edge 212722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// might leave other edges dangling. 212822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 212922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// This will not remove edges in more complicated situations: 213022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// - if there is more than one "hop" leading to or from a subexpression. 213122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// - if there is an inlined call between the edges instead of a single event. 213222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// - if the whole statement is large enough that having subexpression arrows 213322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// might be helpful. 213422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rosestatic void removeContextCycles(PathPieces &Path, SourceManager &SM, 213522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose ParentMap &PM) { 21363b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose for (PathPieces::iterator I = Path.begin(), E = Path.end(); I != E; ) { 21373b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose // Pattern match the current piece and its successor. 21383b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PathDiagnosticControlFlowPiece *PieceI = 21393b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 21403b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21413b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (!PieceI) { 21423b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++I; 21433b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose continue; 21443b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21453b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21463b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 21473b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 21483b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21493b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PathPieces::iterator NextI = I; ++NextI; 21503b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (NextI == E) 21513b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose break; 21523b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21533b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PathDiagnosticControlFlowPiece *PieceNextI = 21543b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 21553b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21563b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (!PieceNextI) { 21573b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (isa<PathDiagnosticEventPiece>(*NextI)) { 21583b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++NextI; 21593b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (NextI == E) 21603b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose break; 21613b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PieceNextI = dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 21623b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21633b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21643b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (!PieceNextI) { 21653b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++I; 21663b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose continue; 21673b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21683b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21693b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21703b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 21713b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 21723b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21733b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (s1Start && s2Start && s1Start == s2End && s2Start == s1End) { 217422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const size_t MAX_SHORT_LINE_LENGTH = 80; 217522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Optional<size_t> s1Length = getLengthOnSingleLine(SM, s1Start); 217622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (s1Length && *s1Length <= MAX_SHORT_LINE_LENGTH) { 217722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Optional<size_t> s2Length = getLengthOnSingleLine(SM, s2Start); 217822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (s2Length && *s2Length <= MAX_SHORT_LINE_LENGTH) { 217922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Path.erase(I); 218022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose I = Path.erase(NextI); 218122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose continue; 218222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose } 218322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose } 21843b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21853b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21863b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++I; 21873b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21883b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose} 21893b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 219052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek/// \brief Return true if X is contained by Y. 219152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenekstatic bool lexicalContains(ParentMap &PM, 219252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *X, 219352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *Y) { 219452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek while (X) { 219552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (X == Y) 219652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return true; 219752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek X = PM.getParent(X); 219852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 219952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return false; 220052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek} 220152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 2202de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek// Remove short edges on the same line less than 3 columns in difference. 2203de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenekstatic void removePunyEdges(PathPieces &path, 2204de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek SourceManager &SM, 2205de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM) { 2206de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2207de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek bool erased = false; 2208de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2209de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; 2210de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased ? I : ++I) { 2211de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2212de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = false; 2213de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2214de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2215de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2216de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2217de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!PieceI) 2218de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2219de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2220de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *start = getLocStmt(PieceI->getStartLocation()); 2221de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *end = getLocStmt(PieceI->getEndLocation()); 2222de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2223de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!start || !end) 2224de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2225de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2226de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *endParent = PM.getParent(end); 2227de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!endParent) 2228de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2229de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2230de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (isConditionForTerminator(end, endParent)) 2231de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2232de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 223322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceLocation FirstLoc = start->getLocStart(); 223422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceLocation SecondLoc = end->getLocStart(); 2235de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 223622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (!SM.isFromSameFile(FirstLoc, SecondLoc)) 2237de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 223822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (SM.isBeforeInTranslationUnit(SecondLoc, FirstLoc)) 223922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose std::swap(SecondLoc, FirstLoc); 2240de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 224122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceRange EdgeRange(FirstLoc, SecondLoc); 224222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Optional<size_t> ByteWidth = getLengthOnSingleLine(SM, EdgeRange); 2243de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 224422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // If the statements are on different lines, continue. 224522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (!ByteWidth) 2246de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2247de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 224822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const size_t MAX_PUNY_EDGE_LENGTH = 2; 224922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (*ByteWidth <= MAX_PUNY_EDGE_LENGTH) { 225022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // FIXME: There are enough /bytes/ between the endpoints of the edge, but 225122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // there might not be enough /columns/. A proper user-visible column count 225222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // is probably too expensive, though. 2253a705980a7c3315b7c72d99ce675342ad91b50642Ted Kremenek I = path.erase(I); 2254de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = true; 2255de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2256de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2257de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2258de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek} 2259de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 22601d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenekstatic void removeIdenticalEvents(PathPieces &path) { 22611d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ++I) { 22621d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceI = 22631d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek dyn_cast<PathDiagnosticEventPiece>(*I); 22641d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 22651d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceI) 22661d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 22671d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 22681d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathPieces::iterator NextI = I; ++NextI; 22691d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (NextI == E) 22701d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek return; 22711d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 22721d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceNextI = 22730fa3504acfc7c20a87973c58ad3474adc94dd97dTed Kremenek dyn_cast<PathDiagnosticEventPiece>(*NextI); 22741d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 22751d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceNextI) 22761d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 22771d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 22781d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Erase the second piece if it has the same exact message text. 22791d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (PieceI->getString() == PieceNextI->getString()) { 22801d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek path.erase(NextI); 22811d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 22821d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 22831d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek} 22841d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 228515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool optimizeEdges(PathPieces &path, SourceManager &SM, 228615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet &OCS, 2287bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose LocationContextMap &LCM) { 2288bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek bool hasChanges = false; 2289bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek const LocationContext *LC = LCM[&path]; 2290bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LC); 2291de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM = LC->getParentMap(); 2292bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2293481da5554d03271b0d87b695449963f7728c5895Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ) { 2294bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Optimize subpaths. 2295bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (PathDiagnosticCallPiece *CallI = dyn_cast<PathDiagnosticCallPiece>(*I)){ 2296481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // Record the fact that a call has been optimized so we only do the 2297481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // effort once. 229815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (!OCS.count(CallI)) { 2299bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(CallI->path, SM, OCS, LCM)) {} 230015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OCS.insert(CallI); 230115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 2302481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2303bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2304bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2305bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2306bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Pattern match the current piece and its successor. 2307bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2308bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2309bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2310481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceI) { 2311481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2312bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2313481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2314bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2315f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 2316f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 2317f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level1 = getStmtParent(s1Start, PM); 2318f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level2 = getStmtParent(s1End, PM); 2319f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 232015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek PathPieces::iterator NextI = I; ++NextI; 232115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (NextI == E) 232215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek break; 232315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 2324bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceNextI = 2325bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 2326bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2327481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceNextI) { 2328481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2329bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2330481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2331bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2332f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 2333f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 2334f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level3 = getStmtParent(s2Start, PM); 2335f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level4 = getStmtParent(s2End, PM); 2336bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2337bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Rule I. 2338bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2339bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // If we have two consecutive control edges whose end/begin locations 2340481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // are at the same level (e.g. statements or top-level expressions within 2341481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // a compound statement, or siblings share a single ancestor expression), 2342481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // then merge them if they have no interesting intermediate event. 2343bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2344bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // For example: 2345bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2346bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // (1.1 -> 1.2) -> (1.2 -> 1.3) becomes (1.1 -> 1.3) because the common 2347481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // parent is '1'. Here 'x.y.z' represents the hierarchy of statements. 2348bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2349bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2350bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // to prevent this optimization. 2351f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2352481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (level1 && level1 == level2 && level1 == level3 && level1 == level4) { 2353bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2354bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.erase(NextI); 2355bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek hasChanges = true; 2356bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2357bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2358b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek 2359b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // Rule II. 2360b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // 2361a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // Eliminate edges between subexpressions and parent expressions 2362a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // when the subexpression is consumed. 2363f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2364f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2365f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // to prevent this optimization. 2366f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 236796b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (s1End && s1End == s2Start && level2) { 236852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek bool removeEdge = false; 236952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Remove edges into the increment or initialization of a 237052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // loop that have no interleaving event. This means that 237152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // they aren't interesting. 237252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isIncrementOrInitInForLoop(s1End, level2)) 237352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 237452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Next only consider edges that are not anchored on 237552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the condition of a terminator. This are intermediate edges 237652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // that we might want to trim. 237752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (!isConditionForTerminator(level2, s1End)) { 237852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges on expressions that are consumed by 237952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the parent expression. 238052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isa<Expr>(s1End) && PM.isConsumedExpr(cast<Expr>(s1End))) { 238152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 238252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 238352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges where a lexical containment doesn't exist. 238452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // For example: 238552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 238652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // X -> Y -> Z 238752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 238852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // If 'Z' lexically contains Y (it is an ancestor) and 238952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 'X' does not lexically contain Y (it is a descendant OR 239052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // it has no lexical relationship at all) then trim. 239152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 239252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // This can eliminate edges where we dive into a subexpression 239352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // and then pop back out, etc. 239452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (s1Start && s2End && 239552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek lexicalContains(PM, s2Start, s2End) && 239652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek !lexicalContains(PM, s1End, s1Start)) { 239752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 239852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 2399e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // Trim edges from a subexpression back to the top level if the 2400e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // subexpression is on a different line. 2401e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // 2402e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // A.1 -> A -> B 2403e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // becomes 2404e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // A.1 -> B 2405e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // 2406e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // These edges just look ugly and don't usually add anything. 2407e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose else if (s1Start && s2End && 2408e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose lexicalContains(PM, s1Start, s1End)) { 2409e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose SourceRange EdgeRange(PieceI->getEndLocation().asLocation(), 2410e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose PieceI->getStartLocation().asLocation()); 2411e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose if (!getLengthOnSingleLine(SM, EdgeRange).hasValue()) 2412e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose removeEdge = true; 2413e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose } 241452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 241552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 241652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (removeEdge) { 241796b8134337883908fcc45484486fe200d6b3e32fTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 241896b8134337883908fcc45484486fe200d6b3e32fTed Kremenek path.erase(NextI); 241996b8134337883908fcc45484486fe200d6b3e32fTed Kremenek hasChanges = true; 242096b8134337883908fcc45484486fe200d6b3e32fTed Kremenek continue; 242196b8134337883908fcc45484486fe200d6b3e32fTed Kremenek } 2422f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek } 2423481da5554d03271b0d87b695449963f7728c5895Ted Kremenek 2424e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Optimize edges for ObjC fast-enumeration loops. 2425e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2426e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> collection) -> (collection -> element) 2427e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2428e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // becomes: 2429e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2430e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> element) 2431e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (s1End == s2Start) { 2432e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const ObjCForCollectionStmt *FS = 2433e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(level3); 2434e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (FS && FS->getCollection()->IgnoreParens() == s2Start && 2435e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek s2End == FS->getElement()) { 2436e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2437e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek path.erase(NextI); 2438e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek hasChanges = true; 2439e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek continue; 2440e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2441e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2442e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 2443481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // No changes at this index? Move to the next one. 2444481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2445bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2446bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2447de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!hasChanges) { 244896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Adjust edges into subexpressions to make them more uniform 244996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // and aesthetically pleasing. 245096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose addContextEdges(path, SM, PM, LC); 24513b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose // Remove "cyclical" edges that include one or more context edges. 245222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose removeContextCycles(path, SM, PM); 245396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Hoist edges originating from branch conditions to branches 245496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // for simple branches. 245596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose simplifySimpleBranches(path); 2456de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek // Remove any puny edges left over after primary optimization pass. 2457de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek removePunyEdges(path, SM, PM); 24581d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Remove identical events. 24591d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek removeIdenticalEvents(path); 2460de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2461de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2462bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return hasChanges; 2463bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 2464bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 246501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose/// Drop the very first edge in a path, which should be a function entry edge. 24661089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose/// 24671089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose/// If the first edge is not a function entry edge (say, because the first 24681089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose/// statement had an invalid source location), this function does nothing. 24691089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose// FIXME: We should just generate invalid edges anyway and have the optimizer 24701089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose// deal with them. 247101f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rosestatic void dropFunctionEntryEdge(PathPieces &Path, 247201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose LocationContextMap &LCM, 247301f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose SourceManager &SM) { 247401f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const PathDiagnosticControlFlowPiece *FirstEdge = 24751089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(Path.front()); 24761089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose if (!FirstEdge) 24771089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose return; 24781089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose 24791089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose const Decl *D = LCM[&Path]->getDecl(); 24801089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose PathDiagnosticLocation EntryLoc = PathDiagnosticLocation::createBegin(D, SM); 24811089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose if (FirstEdge->getStartLocation() != EntryLoc) 24821089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose return; 248301f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 248401f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose Path.pop_front(); 248501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose} 248601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 248701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 24885fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 24893106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugType and subclasses. 24903106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2491404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios KyrtzidisBugType::~BugType() { } 2492404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 24933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugType::FlushReports(BugReporter &BR) {} 24943106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 249599ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BuiltinBug::anchor() {} 249699ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 24973106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 24983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReport and subclasses. 24993106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2500e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 250199ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReport::NodeResolver::anchor() {} 250299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 25038e6431adab313e283a992698f6fc7afe62420999Anna Zaksvoid BugReport::addVisitor(BugReporterVisitor* visitor) { 25048e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (!visitor) 25058e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 25068e6431adab313e283a992698f6fc7afe62420999Anna Zaks 25078e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSetNodeID ID; 25088e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor->Profile(ID); 25098e6431adab313e283a992698f6fc7afe62420999Anna Zaks void *InsertPos; 25108e6431adab313e283a992698f6fc7afe62420999Anna Zaks 25118e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) { 25128e6431adab313e283a992698f6fc7afe62420999Anna Zaks delete visitor; 25138e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 25148e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 25158e6431adab313e283a992698f6fc7afe62420999Anna Zaks 25168e6431adab313e283a992698f6fc7afe62420999Anna Zaks CallbacksSet.InsertNode(visitor, InsertPos); 25173bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose Callbacks.push_back(visitor); 25183bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 25198e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 25208e6431adab313e283a992698f6fc7afe62420999Anna Zaks 25218e6431adab313e283a992698f6fc7afe62420999Anna ZaksBugReport::~BugReport() { 25228e6431adab313e283a992698f6fc7afe62420999Anna Zaks for (visitor_iterator I = visitor_begin(), E = visitor_end(); I != E; ++I) { 2523dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks delete *I; 25248e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 2525c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek while (!interestingSymbols.empty()) { 2526c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek popInterestingSymbolsAndRegions(); 2527c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 25288e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 2529e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 253007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekconst Decl *BugReport::getDeclWithIssue() const { 253107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (DeclWithIssue) 253207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return DeclWithIssue; 253307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 253407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const ExplodedNode *N = getErrorNode(); 253507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (!N) 253607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return 0; 253707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 253807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const LocationContext *LC = N->getLocationContext(); 253907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return LC->getCurrentStackFrame()->getDecl(); 254007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek} 254107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 2542e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaksvoid BugReport::Profile(llvm::FoldingSetNodeID& hash) const { 2543e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddPointer(&BT); 2544e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddString(Description); 254597bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation UL = getUniqueingLocation(); 254697bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks if (UL.isValid()) { 254797bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks UL.Profile(hash); 2548ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks } else if (Location.isValid()) { 2549590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location.Profile(hash); 2550590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } else { 2551590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(ErrorNode); 2552590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks hash.AddPointer(GetCurrentOrPreviousStmt(ErrorNode)); 2553590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 2554e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2555e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks for (SmallVectorImpl<SourceRange>::const_iterator I = 2556e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.begin(), E = Ranges.end(); I != E; ++I) { 2557e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks const SourceRange range = *I; 2558e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!range.isValid()) 2559e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks continue; 2560e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getBegin().getRawEncoding()); 2561e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getEnd().getRawEncoding()); 2562e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2563e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks} 25643106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 256576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SymbolRef sym) { 256676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 256776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 25683bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 25693bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the symbol wasn't already in our set, note a configuration change. 2570c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingSymbols().insert(sym).second) 25713bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 25728ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 25738ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose if (const SymbolMetadata *meta = dyn_cast<SymbolMetadata>(sym)) 2574c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingRegions().insert(meta->getRegion()); 257576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 257676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 257776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(const MemRegion *R) { 257876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 257976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 25803bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 25813bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the base region wasn't already in our set, note a configuration change. 258276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2583c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingRegions().insert(R).second) 25843bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 25858ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 258676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2587c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingSymbols().insert(SR->getSymbol()); 258876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 258976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 259076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SVal V) { 259176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsRegion()); 259276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsSymbol()); 259376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 259476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 259580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksvoid BugReport::markInteresting(const LocationContext *LC) { 259680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 259780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return; 259880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks InterestingLocationContexts.insert(LC); 259980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 260080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2601c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SVal V) { 260276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return isInteresting(V.getAsRegion()) || isInteresting(V.getAsSymbol()); 260376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 260476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2605c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SymbolRef sym) { 260676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 260776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 26088ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // We don't currently consider metadata symbols to be interesting 26098ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // even if we know their region is interesting. Is that correct behavior? 2610c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(sym); 261176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 261276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2613c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(const MemRegion *R) { 261476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 261576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 261676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2617c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool b = getInterestingRegions().count(R); 261876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (b) 261976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return true; 262076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2621c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(SR->getSymbol()); 262276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 262376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 2624c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 262580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksbool BugReport::isInteresting(const LocationContext *LC) { 262680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 262780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return false; 262880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return InterestingLocationContexts.count(LC); 262980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 263080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2631c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::lazyInitializeInterestingSets() { 2632c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (interestingSymbols.empty()) { 2633c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols()); 2634c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions()); 2635c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 2636c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2637c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2638c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Symbols &BugReport::getInterestingSymbols() { 2639c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2640c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingSymbols.back(); 2641c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2642c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2643c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Regions &BugReport::getInterestingRegions() { 2644c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2645c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingRegions.back(); 2646c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2647c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2648c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::pushInterestingSymbolsAndRegions() { 2649c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols(getInterestingSymbols())); 2650c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions(getInterestingRegions())); 2651c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2652c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2653c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::popInterestingSymbolsAndRegions() { 2654c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek delete interestingSymbols.back(); 2655c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.pop_back(); 2656c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek delete interestingRegions.back(); 2657c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.pop_back(); 2658c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 265976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 26609c378f705405d37f49795d5e915989de774fe11fTed Kremenekconst Stmt *BugReport::getStmt() const { 2661e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!ErrorNode) 2662e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return 0; 2663e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2664212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care ProgramPoint ProgP = ErrorNode->getLocation(); 26655f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek const Stmt *S = NULL; 26661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26677a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = ProgP.getAs<BlockEntrance>()) { 2668fafd3834754d2093e0ad7a1c005860fd527ecb7fZhongxing Xu CFGBlock &Exit = ProgP.getLocationContext()->getCFG()->getExit(); 266950d5bc4e3b53eb8bb4ebf198f1213348a3fa0f38Zhongxing Xu if (BE->getBlock() == &Exit) 2670212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care S = GetPreviousStmt(ErrorNode); 26713106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 26725f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (!S) 26730f8579274a010f360a371b53101859d9d6052314Anna Zaks S = PathDiagnosticLocation::getStmt(ErrorNode); 26741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 26763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 26773106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2678640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidisstd::pair<BugReport::ranges_iterator, BugReport::ranges_iterator> 2679e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna ZaksBugReport::getRanges() { 2680e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks // If no custom ranges, add the range of the statement corresponding to 2681e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks // the error node. 2682e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (Ranges.empty()) { 2683e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (const Expr *E = dyn_cast_or_null<Expr>(getStmt())) 2684e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks addRange(E->getSourceRange()); 2685e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks else 2686e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return std::make_pair(ranges_iterator(), ranges_iterator()); 2687e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2688e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 268914924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks // User-specified absence of range info. 269014924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks if (Ranges.size() == 1 && !Ranges.begin()->isValid()) 269114924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks return std::make_pair(ranges_iterator(), ranges_iterator()); 269214924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks 2693e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return std::make_pair(Ranges.begin(), Ranges.end()); 26943106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 26953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2696590dd8e0959d8df5621827768987c4792b74fc06Anna ZaksPathDiagnosticLocation BugReport::getLocation(const SourceManager &SM) const { 2697b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks if (ErrorNode) { 2698590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(!Location.isValid() && 2699b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks "Either Location or ErrorNode should be specified but not both."); 27000f8579274a010f360a371b53101859d9d6052314Anna Zaks return PathDiagnosticLocation::createEndOfPath(ErrorNode, SM); 2701b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } else { 2702b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks assert(Location.isValid()); 2703b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks return Location; 2704b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } 2705b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 2706590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return PathDiagnosticLocation(); 27073106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 27083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27093106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReporter and subclasses. 27113106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27123106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27134a5f724538cbc275370c9504e8169ce92503256cBenjamin KramerBugReportEquivClass::~BugReportEquivClass() { } 2714a2f4ec0df645fc249d2945beef9653f03b175417Zhongxing XuGRBugReporter::~GRBugReporter() { } 27153106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekBugReporterData::~BugReporterData() {} 27163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 271738b02b912e1a55c912f603c4369431264d36a381Zhongxing XuExplodedGraph &GRBugReporter::getGraph() { return Eng.getGraph(); } 27183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 271918c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekProgramStateManager& 27203106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekGRBugReporter::getStateManager() { return Eng.getStateManager(); } 27213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27223b030a28cda2b953758507769c1d436bec5ec45eAnna ZaksBugReporter::~BugReporter() { 27233b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks FlushReports(); 27243b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks 27253b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks // Free the bug reports we are tracking. 27263b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks typedef std::vector<BugReportEquivClass *> ContTy; 27273b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks for (ContTy::iterator I = EQClassesVector.begin(), E = EQClassesVector.end(); 27283b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks I != E; ++I) { 27293b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks delete *I; 27303b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks } 27313b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks} 27323106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27333106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugReporter::FlushReports() { 27343106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (BugTypes.isEmpty()) 27353106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek return; 27363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27373106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // First flush the warnings for each BugType. This may end up creating new 2738404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // warnings and new BugTypes. 2739404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: Only NSErrorChecker needs BugType's FlushReports. 2740404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // Turn NSErrorChecker into a proper checker and remove this. 27415f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const BugType*, 16> bugTypes; 27423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek for (BugTypesTy::iterator I=BugTypes.begin(), E=BugTypes.end(); I!=E; ++I) 2743404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis bugTypes.push_back(*I); 274409d19efaa147762f84aed55efa7930bb3616a4e5Craig Topper for (SmallVectorImpl<const BugType *>::iterator 2745404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = bugTypes.begin(), E = bugTypes.end(); I != E; ++I) 27463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek const_cast<BugType*>(*I)->FlushReports(*this); 27473106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2748d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // We need to flush reports in deterministic order to ensure the order 2749d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // of the reports is consistent between runs. 27500eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks typedef std::vector<BugReportEquivClass *> ContVecTy; 27510eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks for (ContVecTy::iterator EI=EQClassesVector.begin(), EE=EQClassesVector.end(); 27520eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks EI != EE; ++EI){ 27530eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks BugReportEquivClass& EQ = **EI; 2754404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis FlushReport(EQ); 27553106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 27563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2757404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // BugReporter owns and deletes only BugTypes created implicitly through 2758404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // EmitBasicReport. 2759404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: There are leaks from checkers that assume that the BugTypes they 2760404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // create will be destroyed by the BugReporter. 2761404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis for (llvm::StringMap<BugType*>::iterator 2762404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = StrBugTypes.begin(), E = StrBugTypes.end(); I != E; ++I) 2763404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis delete I->second; 2764404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 27653106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Remove all references to the BugType objects. 27663baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.getEmptySet(); 27673106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 27683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27693106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27703106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnostics generation. 27713106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27723106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27731efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosenamespace { 27741efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a report graph, which contains only a single path, and its 27751efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// node maps. 27761efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass ReportGraph { 27771efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 27781efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap BackMap; 2779228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OwningPtr<ExplodedGraph> Graph; 2780228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *ErrorNode; 27811efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose size_t Index; 27821efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 27831efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 27841efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a trimmed graph and its node maps. 27851efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass TrimmedGraph { 27861efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap InverseMap; 27872110350909701fcd6b55c636e24a675f0a905feaJordan Rose 27882110350909701fcd6b55c636e24a675f0a905feaJordan Rose typedef llvm::DenseMap<const ExplodedNode *, unsigned> PriorityMapTy; 27892110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy PriorityMap; 27902110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2791228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose typedef std::pair<const ExplodedNode *, size_t> NodeIndexPair; 2792228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose SmallVector<NodeIndexPair, 32> ReportNodes; 2793228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 27941efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose OwningPtr<ExplodedGraph> G; 2795228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2796228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose /// A helper class for sorting ExplodedNodes by priority. 2797228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose template <bool Descending> 2798228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose class PriorityCompare { 2799228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const PriorityMapTy &PriorityMap; 2800228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2801228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose public: 2802228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare(const PriorityMapTy &M) : PriorityMap(M) {} 2803228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2804228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const ExplodedNode *LHS, const ExplodedNode *RHS) const { 2805228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator LI = PriorityMap.find(LHS); 2806228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator RI = PriorityMap.find(RHS); 2807228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator E = PriorityMap.end(); 2808228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2809228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (LI == E) 2810228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending; 2811228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RI == E) 2812228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return !Descending; 2813228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2814228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending ? LI->second > RI->second 2815228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose : LI->second < RI->second; 2816228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2817228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2818228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const NodeIndexPair &LHS, const NodeIndexPair &RHS) const { 2819228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return (*this)(LHS.first, RHS.first); 2820228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2821228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose }; 2822228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 28231efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 28241efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph(const ExplodedGraph *OriginalGraph, 28252110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes); 28261efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 2827228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool popNextReportGraph(ReportGraph &GraphWrapper); 28281efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 28291efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose} 28301efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 28312110350909701fcd6b55c636e24a675f0a905feaJordan RoseTrimmedGraph::TrimmedGraph(const ExplodedGraph *OriginalGraph, 28322110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes) { 28332110350909701fcd6b55c636e24a675f0a905feaJordan Rose // The trimmed graph is created in the body of the constructor to ensure 28342110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that the DenseMaps have been initialized already. 2835228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap ForwardMap; 28360f3a34fb7fea37ebfbcba8b400ccb697b9559b49Jordan Rose G.reset(OriginalGraph->trim(Nodes, &ForwardMap, &InverseMap)); 28371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28383106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Find the (first) error node in the trimmed graph. We just need to consult 28391efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose // the node map which maps from nodes in the original graph to nodes 28403106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // in the new graph. 2841228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::SmallPtrSet<const ExplodedNode *, 32> RemainingNodes; 28423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 28431efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose for (unsigned i = 0, count = Nodes.size(); i < count; ++i) { 2844228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (const ExplodedNode *NewNode = ForwardMap.lookup(Nodes[i])) { 2845228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportNodes.push_back(std::make_pair(NewNode, i)); 2846228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose RemainingNodes.insert(NewNode); 28473106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 284840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 28491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2850228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!RemainingNodes.empty() && "No error node found in the trimmed graph"); 2851228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2852228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Perform a forward BFS to find all the shortest paths. 2853228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::queue<const ExplodedNode *> WS; 2854228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2855228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(G->num_roots() == 1); 2856228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*G->roots_begin()); 2857228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose unsigned Priority = 0; 28583106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 28593106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!WS.empty()) { 2860228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *Node = WS.front(); 28613106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek WS.pop(); 28621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28632110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy::iterator PriorityEntry; 28642110350909701fcd6b55c636e24a675f0a905feaJordan Rose bool IsNew; 28652110350909701fcd6b55c636e24a675f0a905feaJordan Rose llvm::tie(PriorityEntry, IsNew) = 28662110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMap.insert(std::make_pair(Node, Priority)); 2867228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ++Priority; 28681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28692110350909701fcd6b55c636e24a675f0a905feaJordan Rose if (!IsNew) { 28702110350909701fcd6b55c636e24a675f0a905feaJordan Rose assert(PriorityEntry->second <= Priority); 28712110350909701fcd6b55c636e24a675f0a905feaJordan Rose continue; 28722110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 28731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2874228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.erase(Node)) 2875228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.empty()) 2876228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose break; 2877a5f80b2ea6d30c5055c067530d63bb0dcaf937d0Jordan Rose 2878228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose for (ExplodedNode::const_pred_iterator I = Node->succ_begin(), 2879228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose E = Node->succ_end(); 28802110350909701fcd6b55c636e24a675f0a905feaJordan Rose I != E; ++I) 2881228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*I); 2882239b6e47d282bd66c8b559ac47b8b42b34da619eJordan Rose } 28832110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2884228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Sort the error paths from longest to shortest. 2885228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::sort(ReportNodes.begin(), ReportNodes.end(), 2886228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<true>(PriorityMap)); 2887228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose} 28882110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2889228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rosebool TrimmedGraph::popNextReportGraph(ReportGraph &GraphWrapper) { 2890228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (ReportNodes.empty()) 2891228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return false; 28922110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2893228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *OrigN; 2894228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::tie(OrigN, GraphWrapper.Index) = ReportNodes.pop_back_val(); 2895228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(PriorityMap.find(OrigN) != PriorityMap.end() && 2896228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose "error node not accessible from root"); 28972110350909701fcd6b55c636e24a675f0a905feaJordan Rose 28982110350909701fcd6b55c636e24a675f0a905feaJordan Rose // Create a new graph with a single path. This is the graph 28992110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that will be returned to the caller. 29002110350909701fcd6b55c636e24a675f0a905feaJordan Rose ExplodedGraph *GNew = new ExplodedGraph(); 29012110350909701fcd6b55c636e24a675f0a905feaJordan Rose GraphWrapper.Graph.reset(GNew); 2902228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.BackMap.clear(); 29031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2904228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Now walk from the error node up the BFS path, always taking the 2905228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // predeccessor with the lowest number. 2906228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ExplodedNode *Succ = 0; 2907228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (true) { 29083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create the equivalent node in the new graph with the same state 29093106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // and location. 29103e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose ExplodedNode *NewN = GNew->getNode(OrigN->getLocation(), OrigN->getState(), 29113e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose OrigN->isSink()); 29121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29133106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Store the mapping to the original node. 2914228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap::const_iterator IMitr = InverseMap.find(OrigN); 29153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(IMitr != InverseMap.end() && "No mapping to original node."); 29161efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose GraphWrapper.BackMap[NewN] = IMitr->second; 29171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Link up the new node with the previous node. 2919228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (Succ) 2920228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ->addPredecessor(NewN, *GNew); 2921228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose else 2922228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.ErrorNode = NewN; 29231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2924228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ = NewN; 29251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29263106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Are we at the final node? 2927228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (OrigN->pred_empty()) { 2928228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GNew->addRoot(NewN); 29293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 29303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 29311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2932228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Find the next predeccessor node. We choose the node that is marked 29332110350909701fcd6b55c636e24a675f0a905feaJordan Rose // with the lowest BFS number. 2934228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OrigN = *std::min_element(OrigN->pred_begin(), OrigN->pred_end(), 2935228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<false>(PriorityMap)); 29362110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 29372110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2938228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return true; 29392110350909701fcd6b55c636e24a675f0a905feaJordan Rose} 29402110350909701fcd6b55c636e24a675f0a905feaJordan Rose 29412110350909701fcd6b55c636e24a675f0a905feaJordan Rose 29423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// CompactPathDiagnostic - This function postprocesses a PathDiagnostic object 29433106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// and collapses PathDiagosticPieces that are expanded by macros. 294477d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM) { 29452042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek typedef std::vector<std::pair<IntrusiveRefCntPtr<PathDiagnosticMacroPiece>, 29462042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek SourceLocation> > MacroStackTy; 29471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2948c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith typedef std::vector<IntrusiveRefCntPtr<PathDiagnosticPiece> > 29493106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy; 29501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29513106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStackTy MacroStack; 29523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy Pieces; 29531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2954ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek for (PathPieces::const_iterator I = path.begin(), E = path.end(); 29552042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek I!=E; ++I) { 295677d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 2957ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PathDiagnosticPiece *piece = I->getPtr(); 295877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 295977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek // Recursively compact calls. 296077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek if (PathDiagnosticCallPiece *call=dyn_cast<PathDiagnosticCallPiece>(piece)){ 296177d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(call->path, SM); 296277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek } 296377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 29643106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Get the location of the PathDiagnosticPiece. 296577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek const FullSourceLoc Loc = piece->getLocation().asLocation(); 29661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29673106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Determine the instantiation location, which is the location we group 29683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // related PathDiagnosticPieces. 29691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation InstantiationLoc = Loc.isMacroID() ? 2970402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 29713106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 29721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29733106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (Loc.isFileID()) { 29743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.clear(); 297577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek Pieces.push_back(piece); 29763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 29773106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2978706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek 29793106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(Loc.isMacroID()); 29801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29813106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Is the PathDiagnosticPiece within the same macro group? 29823106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroStack.empty() && InstantiationLoc == MacroStack.back().second) { 298377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroStack.back().first->subPieces.push_back(piece); 29843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 29853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2986d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 29873106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // We aren't in the same group. Are we descending into a new macro 29883106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // or are part of an old one? 2989c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<PathDiagnosticMacroPiece> MacroGroup; 2990d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 29913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation ParentInstantiationLoc = InstantiationLoc.isMacroID() ? 2992402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 29933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 29941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Walk the entire macro stack. 29963106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!MacroStack.empty()) { 29973106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (InstantiationLoc == MacroStack.back().second) { 29983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 29993106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 30003106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 30011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (ParentInstantiationLoc == MacroStack.back().second) { 30033106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 30043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 300561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 30061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30073106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.pop_back(); 30086837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek } 30091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroGroup || ParentInstantiationLoc == MacroStack.back().second) { 30113106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create a new macro group and add it to the stack. 3012590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticMacroPiece *NewGroup = 3013590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks new PathDiagnosticMacroPiece( 301477d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek PathDiagnosticLocation::createSingleLocation(piece->getLocation())); 30155a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek 30163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (MacroGroup) 3017802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek MacroGroup->subPieces.push_back(NewGroup); 30183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 30193106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(InstantiationLoc.isFileID()); 30203106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek Pieces.push_back(NewGroup); 30213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 30221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30233106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = NewGroup; 30243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.push_back(std::make_pair(MacroGroup, InstantiationLoc)); 30257dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 30263106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 30273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Finally, add the PathDiagnosticPiece to the group. 302877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroGroup->subPieces.push_back(piece); 30293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 30301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Now take the pieces and construct a new PathDiagnostic. 303277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.clear(); 30331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 303477d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek for (PiecesTy::iterator I=Pieces.begin(), E=Pieces.end(); I!=E; ++I) 303577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.push_back(*I); 303661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 303761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 30388347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosebool GRBugReporter::generatePathDiagnostic(PathDiagnostic& PD, 3039c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 3040c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport *> &bugReports) { 304140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek assert(!bugReports.empty()); 30428347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 30439a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose bool HasValid = false; 3044228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool HasInvalid = false; 30452f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose SmallVector<const ExplodedNode *, 32> errorNodes; 3046c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (ArrayRef<BugReport*>::iterator I = bugReports.begin(), 30479a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose E = bugReports.end(); I != E; ++I) { 30489a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if ((*I)->isValid()) { 30499a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose HasValid = true; 30509a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back((*I)->getErrorNode()); 30519a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } else { 3052228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Keep the errorNodes list in sync with the bugReports list. 3053228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose HasInvalid = true; 30549a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back(0); 30559a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } 305640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 30571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30589a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // If all the reports have been marked invalid by a previous path generation, 30599a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // we're done. 30609a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if (!HasValid) 30619a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose return false; 30629a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose 30632f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose typedef PathDiagnosticConsumer::PathGenerationScheme PathGenerationScheme; 30642f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathGenerationScheme ActiveScheme = PC.getGenerationScheme(); 30652f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 3066af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::Extensive) { 3067d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions &options = getAnalyzerOptions(); 3068048eeea6852043990c87e52938b53b5337bd098eJordan Rose if (options.getBooleanOption("path-diagnostics-alternate", true)) { 3069af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ActiveScheme = PathDiagnosticConsumer::AlternateExtensive; 3070af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 3071af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 3072af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 30731efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph TrimG(&getGraph(), errorNodes); 3074228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportGraph ErrorGraph; 30751efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 3076228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (TrimG.popNextReportGraph(ErrorGraph)) { 30772f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Find the BugReport with the original location. 30781efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose assert(ErrorGraph.Index < bugReports.size()); 30791efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose BugReport *R = bugReports[ErrorGraph.Index]; 30802f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R && "No original report found for sliced graph."); 30812f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R->isValid() && "Report selected by trimmed graph marked invalid."); 30822f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30832f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Start building the path diagnostic... 30841efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose PathDiagnosticBuilder PDB(*this, R, ErrorGraph.BackMap, &PC); 30851efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose const ExplodedNode *N = ErrorGraph.ErrorNode; 30862f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30872f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Register additional node visitors. 30882f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new NilReceiverBRVisitor()); 30892f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new ConditionBRVisitor()); 30902f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new LikelyFalsePositiveSuppressionBRVisitor()); 30912f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30922f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose BugReport::VisitorList visitors; 30932f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose unsigned origReportConfigToken, finalReportConfigToken; 3094d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap LCM; 30952f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30962f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // While generating diagnostics, it's possible the visitors will decide 30972f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // new symbols and regions are interesting, or add other visitors based on 30982f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the information they find. If they do, we need to regenerate the path 30992f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // based on our new report configuration. 31002f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose do { 31012f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Get a clean copy of all the visitors. 31022f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = R->visitor_begin(), 31032f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose E = R->visitor_end(); I != E; ++I) 31042f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose visitors.push_back((*I)->clone()); 31052f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31062f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clear out the active path from any previous work. 31072f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PD.resetPath(); 31082f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose origReportConfigToken = R->getConfigurationChangeToken(); 31092f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31102f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Generate the very last diagnostic piece - the piece is visible before 31112f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the trace is expanded. 31122f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathDiagnosticPiece *LastPiece = 0; 31132f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = visitors.begin(), E = visitors.end(); 31142f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose I != E; ++I) { 31152f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (PathDiagnosticPiece *Piece = (*I)->getEndPath(PDB, N, *R)) { 31162f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert (!LastPiece && 31172f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose "There can only be one final piece in a diagnostic."); 31182f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose LastPiece = Piece; 31192f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 31203bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 312186ff12c8a8a356ca284ca7687749216fbfd74519Anna Zaks 31222f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (ActiveScheme != PathDiagnosticConsumer::None) { 31232f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!LastPiece) 31242f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose LastPiece = BugReporterVisitor::getDefaultEndPath(PDB, N, *R); 31252f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(LastPiece); 3126d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PD.setEndOfPath(LastPiece); 31278347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 31282f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 3129d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Make sure we get a clean location context map so we don't 3130d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // hold onto old mappings. 3131d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LCM.clear(); 3132d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 31332f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose switch (ActiveScheme) { 3134af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek case PathDiagnosticConsumer::AlternateExtensive: 3135af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek GenerateAlternateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 3136af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 31372f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Extensive: 3138d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 31392f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 31402f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Minimal: 3141d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateMinimalPathDiagnostic(PD, PDB, N, LCM, visitors); 31422f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 31432f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::None: 31442f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose GenerateVisitorsOnlyPathDiagnostic(PD, PDB, N, visitors); 31452f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 3146d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 31473bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 31482f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clean up the visitors we used. 31492f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose llvm::DeleteContainerPointers(visitors); 31503bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 31512f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Did anything change while generating this path? 31522f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose finalReportConfigToken = R->getConfigurationChangeToken(); 31532f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } while (finalReportConfigToken != origReportConfigToken); 31543bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 3155228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (!R->isValid()) 31562f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose continue; 3157b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 31582f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Finally, prune the diagnostic path of uninteresting stuff. 31592f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!PD.path.empty()) { 3160d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (R->shouldPrunePath() && getAnalyzerOptions().shouldPrunePaths()) { 3161d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek bool stillHasNotes = removeUnneededCalls(PD.getMutablePieces(), R, LCM); 31622f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(stillHasNotes); 31632f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose (void)stillHasNotes; 31642f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 31652f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31666838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks // Redirect all call pieces to have valid locations. 31672f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose adjustCallLocations(PD.getMutablePieces()); 3168bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 31696838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks removePiecesWithInvalidLocations(PD.getMutablePieces()); 31706838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 3171bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::AlternateExtensive) { 3172aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek SourceManager &SM = getSourceManager(); 3173aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 3174aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Reduce the number of edges from a very conservative set 3175aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // to an aesthetically pleasing subset that conveys the 3176aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // necessary information. 317715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet OCS; 3178bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(PD.getMutablePieces(), SM, OCS, LCM)) {} 3179aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 318001f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // Drop the very first function-entry edge. It's not really necessary 318101f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // for top-level functions. 318201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose dropFunctionEntryEdge(PD.getMutablePieces(), LCM, SM); 3183bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 3184574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose 3185574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // Remove messages that are basically the same. 3186574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // We have to do this after edge optimization in the Extensive mode. 3187574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose removeRedundantMsgs(PD.getMutablePieces()); 3188b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 3189afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 31902f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We found a report and didn't suppress it. 31912f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return true; 3192ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek } 31938347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 31942f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We suppressed all the reports in this equivalence class. 3195228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!HasInvalid && "Inconsistent suppression"); 3196228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose (void)HasInvalid; 31972f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return false; 31983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 31991aa44c7c9198796085b77c6bdd7c90030845a688Ted Kremenek 3200cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::Register(BugType *BT) { 32013baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.add(BugTypes, BT); 320276d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek} 320376d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek 3204785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rosevoid BugReporter::emitReport(BugReport* R) { 3205cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // Defensive checking: throw the bug away if it comes from a BodyFarm- 3206cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // generated body. We do this very early because report processing relies 3207cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // on the report's location being valid. 3208edc45d5a91f83d1135bc218f3c377e347ab0251fJordan Rose // FIXME: Valid bugs can occur in BodyFarm-generated bodies, so really we 3209edc45d5a91f83d1135bc218f3c377e347ab0251fJordan Rose // need to just find a reasonable location like we do later on with the path 3210edc45d5a91f83d1135bc218f3c377e347ab0251fJordan Rose // pieces. 3211cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose if (const ExplodedNode *E = R->getErrorNode()) { 3212cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose const LocationContext *LCtx = E->getLocationContext(); 3213cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose if (LCtx->getAnalysisDeclContext()->isBodyAutosynthesized()) 3214cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose return; 3215cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose } 3216cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose 3217cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose bool ValidSourceLoc = R->getLocation(getSourceManager()).isValid(); 3218cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose assert(ValidSourceLoc); 3219cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // If we mess up in a release build, we'd still prefer to just drop the bug 3220cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // instead of trying to go on. 3221cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose if (!ValidSourceLoc) 3222cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose return; 3223cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose 3224cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // Compute the bug report's hash to determine its equivalence class. 3225cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek llvm::FoldingSetNodeID ID; 3226cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek R->Profile(ID); 32271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Lookup the equivance class. If there isn't one, create it. 3229cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT = R->getBugType(); 3230cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek Register(&BT); 3231cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void *InsertPos; 3232404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugReportEquivClass* EQ = EQClasses.FindNodeOrInsertPos(ID, InsertPos); 32331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3234cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek if (!EQ) { 3235cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek EQ = new BugReportEquivClass(R); 3236404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses.InsertNode(EQ, InsertPos); 32373b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks EQClassesVector.push_back(EQ); 3238cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 3239cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek else 3240cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek EQ->AddReport(R); 324161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 324261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 324306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 324406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 324506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek// Emitting reports in equivalence classes. 324606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 324706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 324806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremeneknamespace { 3249ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamstruct FRIEC_WLItem { 325006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *N; 325106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek ExplodedNode::const_succ_iterator I, E; 325206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 325306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek FRIEC_WLItem(const ExplodedNode *n) 325406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek : N(n), I(N->succ_begin()), E(N->succ_end()) {} 325506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek}; 325606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek} 325706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 325861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenekstatic BugReport * 325961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted KremenekFindReportInEquivalenceClass(BugReportEquivClass& EQ, 32605f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVectorImpl<BugReport*> &bugReports) { 326161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 326206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek BugReportEquivClass::iterator I = EQ.begin(), E = EQ.end(); 326306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(I != E); 32644a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugType& BT = I->getBugType(); 326561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 326640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // If we don't need to suppress any of the nodes because they are 326740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // post-dominated by a sink, simply add all the nodes in the equivalence class 326840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // to 'Nodes'. Any of the reports will serve as a "representative" report. 326961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!BT.isSuppressOnSink()) { 32704a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugReport *R = I; 327161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek for (BugReportEquivClass::iterator I=EQ.begin(), E=EQ.end(); I!=E; ++I) { 32729c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N = I->getErrorNode(); 327361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (N) { 32744a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer R = I; 327540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek bugReports.push_back(R); 327661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 327761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 327806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek return R; 327961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 328061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 328106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // For bug reports that should be suppressed when all paths are post-dominated 328206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // by a sink node, iterate through the reports in the equivalence class 328306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // until we find one that isn't post-dominated (if one exists). We use a 328406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // DFS traversal of the ExplodedGraph to find a non-sink node. We could write 328506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // this as a recursive function, but we don't want to risk blowing out the 328606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // stack for very long paths. 328740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = 0; 328861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 328906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; I != E; ++I) { 32904a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const ExplodedNode *errorNode = I->getErrorNode(); 329106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 329240406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!errorNode) 329306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 329440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->isSink()) { 3295b219cfc4d75f0a03630b7c4509ef791b7e97b2c8David Blaikie llvm_unreachable( 329606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek "BugType::isSuppressSink() should not be 'true' for sink end nodes"); 329706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 329861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // No successors? By definition this nodes isn't post-dominated by a sink. 329940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->succ_empty()) { 33004a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer bugReports.push_back(I); 330140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 33024a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer exampleReport = I; 330361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek continue; 330461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 330561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 330606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // At this point we know that 'N' is not a sink and it has at least one 330706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // successor. Use a DFS worklist to find a non-sink end-of-path node. 330806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek typedef FRIEC_WLItem WLItem; 33095f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner typedef SmallVector<WLItem, 10> DFSWorkList; 331006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek llvm::DenseMap<const ExplodedNode *, unsigned> Visited; 331106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 331206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek DFSWorkList WL; 331340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek WL.push_back(errorNode); 331440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek Visited[errorNode] = 1; 331506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 331606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek while (!WL.empty()) { 331706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WLItem &WI = WL.back(); 331806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(!WI.N->succ_empty()); 331906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 332006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; WI.I != WI.E; ++WI.I) { 332106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *Succ = *WI.I; 332206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // End-of-path node? 332306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (Succ->succ_empty()) { 332461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // If we found an end-of-path node that is not a sink. 332561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!Succ->isSink()) { 33264a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer bugReports.push_back(I); 332740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 33284a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer exampleReport = I; 332961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek WL.clear(); 333061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek break; 333161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 333206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Found a sink? Continue on to the next successor. 333306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 333406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 333506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Mark the successor as visited. If it hasn't been explored, 333606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // enqueue it to the DFS worklist. 333706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek unsigned &mark = Visited[Succ]; 333806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (!mark) { 333906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek mark = 1; 334006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.push_back(Succ); 334106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek break; 334206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 334306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 334461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 334561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // The worklist may have been cleared at this point. First 334661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // check if it is empty before checking the last item. 334761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!WL.empty() && &WL.back() == &WI) 334806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.pop_back(); 334906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 335006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 335106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 335261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // ExampleReport will be NULL if all the nodes in the equivalence class 335361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // were post-dominated by sinks. 335440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek return exampleReport; 335561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek} 3356e0a58073b76fc016325a35152533b8468df2bf4aTed Kremenek 3357cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::FlushReport(BugReportEquivClass& EQ) { 33585f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<BugReport*, 10> bugReports; 335940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = FindReportInEquivalenceClass(EQ, bugReports); 3360c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (exampleReport) { 3361c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const PathDiagnosticConsumers &C = getPathDiagnosticConsumers(); 3362c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (PathDiagnosticConsumers::const_iterator I=C.begin(), 3363c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek E=C.end(); I != E; ++I) { 3364c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek FlushReport(exampleReport, **I, bugReports); 3365c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3366c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3367c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 3368c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3369c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReporter::FlushReport(BugReport *exampleReport, 3370c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 3371c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> bugReports) { 33721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3373cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // FIXME: Make sure we use the 'R' for the path that was actually used. 33741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Probably doesn't make a difference in practice. 337540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugType& BT = exampleReport->getBugType(); 33761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33776f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PathDiagnostic> 337807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek D(new PathDiagnostic(exampleReport->getDeclWithIssue(), 337907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek exampleReport->getBugType().getName(), 33803a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose exampleReport->getDescription(), 33813a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose exampleReport->getShortDescription(/*Fallback=*/false), 338297bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks BT.getCategory(), 338397bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks exampleReport->getUniqueingLocation(), 338497bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks exampleReport->getUniqueingDecl())); 3385d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 3386cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxBugClassSize = std::max(bugReports.size(), 3387cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxBugClassSize)); 3388cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3389c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Generate the full path diagnostic, using the generation scheme 3390d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // specified by the PathDiagnosticConsumer. Note that we have to generate 3391d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // path diagnostics even for consumers which do not support paths, because 3392d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // the BugReporterVisitors may mark this bug as a false positive. 3393d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!bugReports.empty()) 3394d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!generatePathDiagnostic(*D.get(), PD, bugReports)) 3395d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return; 33963148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek 3397cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxValidBugClassSize = std::max(bugReports.size(), 3398cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxValidBugClassSize)); 3399cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3400d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // Examine the report and see if the last piece is in a header. Reset the 3401d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // report location to the last piece in the main source file. 3402d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions& Opts = getAnalyzerOptions(); 3403d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll) 3404d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks D->resetDiagnosticLocationToMainFile(); 3405d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks 3406c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // If the path is empty, generate a single step path with the location 3407c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // of the issue. 3408802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (D->path.empty()) { 3409c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticLocation L = exampleReport->getLocation(getSourceManager()); 3410c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticPiece *piece = 3411c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek new PathDiagnosticEventPiece(L, exampleReport->getDescription()); 3412c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek BugReport::ranges_iterator Beg, End; 3413c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::tie(Beg, End) = exampleReport->getRanges(); 341407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek for ( ; Beg != End; ++Beg) 341507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek piece->addRange(*Beg); 34163a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose D->setEndOfPath(piece); 34173148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek } 34181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3419c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Get the meta data. 3420c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const BugReport::ExtraTextList &Meta = exampleReport->getExtraText(); 3421c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (BugReport::ExtraTextList::const_iterator i = Meta.begin(), 3422c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek e = Meta.end(); i != e; ++i) { 3423c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek D->addMeta(*i); 3424c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3425c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3426c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PD.HandlePathDiagnostic(D.take()); 342761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 342857202071e477530e9348bc76671ee369b2399b92Ted Kremenek 342907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekvoid BugReporter::EmitBasicReport(const Decl *DeclWithIssue, 343007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef name, 34315f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category, 3432590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef str, PathDiagnosticLocation Loc, 34338c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RBeg, unsigned NumRanges) { 34341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3435404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // 'BT' is owned by BugReporter. 3436404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugType *BT = getBugTypeForName(name, category); 3437590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport *R = new BugReport(*BT, str, Loc); 343807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek R->setDeclWithIssue(DeclWithIssue); 3439cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek for ( ; NumRanges > 0 ; --NumRanges, ++RBeg) R->addRange(*RBeg); 3440785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose emitReport(R); 3441cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek} 3442404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 34435f9e272e632e951b1efe824cd16acb4d96077930Chris LattnerBugType *BugReporter::getBugTypeForName(StringRef name, 34445f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category) { 3445f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<136> fullDesc; 3446404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::raw_svector_ostream(fullDesc) << name << ":" << category; 3447404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMapEntry<BugType *> & 3448404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis entry = StrBugTypes.GetOrCreateValue(fullDesc); 3449404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugType *BT = entry.getValue(); 3450404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis if (!BT) { 3451404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BT = new BugType(name, category); 3452404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis entry.setValue(BT); 3453404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis } 3454404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis return BT; 3455404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis} 3456632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3457632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3458632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rosevoid PathPieces::dump() const { 3459632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose unsigned index = 0; 3460632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose for (PathPieces::const_iterator I = begin(), E = end(); I != E; ++I) { 3461632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "[" << index++ << "] "; 3462632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose (*I)->dump(); 3463632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "\n"; 3464632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose } 3465632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3466632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3467632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rosevoid PathDiagnosticCallPiece::dump() const { 3468632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "CALL\n--------------\n"; 3469632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3470632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (const Stmt *SLoc = getLocStmt(getLocation())) 3471632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose SLoc->dump(); 3472632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else if (const NamedDecl *ND = dyn_cast<NamedDecl>(getCallee())) 3473632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << *ND << "\n"; 3474632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else 3475632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getLocation().dump(); 3476632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3477632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3478632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rosevoid PathDiagnosticEventPiece::dump() const { 3479632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "EVENT\n--------------\n"; 3480632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << getString() << "\n"; 3481632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << " ---- at ----\n"; 3482632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getLocation().dump(); 3483632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3484632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3485632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rosevoid PathDiagnosticControlFlowPiece::dump() const { 3486632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "CONTROL\n--------------\n"; 3487632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getStartLocation().dump(); 3488632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << " ---- to ----\n"; 3489632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getEndLocation().dump(); 3490632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3491632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3492632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rosevoid PathDiagnosticMacroPiece::dump() const { 3493632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "MACRO\n--------------\n"; 3494632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose // FIXME: Print which macro is being invoked. 3495632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3496632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3497632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rosevoid PathDiagnosticLocation::dump() const { 3498632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (!isValid()) { 3499632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<INVALID>\n"; 3500632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose return; 3501632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose } 3502632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3503632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose switch (K) { 3504632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case RangeK: 3505632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose // FIXME: actually print the range. 3506632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<range>\n"; 3507632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3508632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case SingleLocK: 3509632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose asLocation().dump(); 3510632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "\n"; 3511632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3512632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case StmtK: 3513632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (S) 3514632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose S->dump(); 3515632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else 3516632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<NULL STMT>\n"; 3517632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3518632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case DeclK: 3519632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D)) 3520632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << *ND << "\n"; 3521632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else if (isa<BlockDecl>(D)) 3522632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose // FIXME: Make this nicer. 3523632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<block>\n"; 3524632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else if (D) 3525632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<unknown decl>\n"; 3526632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else 3527632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<NULL DECL>\n"; 3528632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3529632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose } 3530632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3531